Synnefo » snf-ganeti

    <refsect2>

      <title>LOCKS</title>

      <cmdsynopsis>

        <command>locks</command>

        <arg>--no-headers</arg>

        <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>

        <sbr>

        <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>

        <arg>--interval=<replaceable>SECONDS</replaceable></arg>

        <sbr>

      </cmdsynopsis>

      <para>

        Shows a list of locks in the master daemon.

      </para>

      <para>

        The <option>--no-headers</option> option will skip the initial

        header line. The <option>--separator</option> option takes an

        argument which denotes what will be used between the output

        fields. Both these options are to help scripting.

      </para>

      <para>

        The <option>-o</option> option takes a comma-separated list of

        output fields. The available fields and their meaning are:

        <variablelist>

          <varlistentry>

            <term>name</term>

            <listitem>

              <simpara>Lock name</simpara>

            </listitem>

          </varlistentry>

          <varlistentry>

            <term>mode</term>

            <listitem>

              <simpara>

                Mode in which the lock is currently acquired (exclusive or

                shared)

              </simpara>

            </listitem>

          </varlistentry>

          <varlistentry>

            <term>owner</term>

            <listitem>

              <simpara>Current lock owner(s)</simpara>

            </listitem>

          </varlistentry>

        </variablelist>

      </para>

      <para>

        If the value of the option starts with the character

        <constant>+</constant>, the new fields will be added to the default

        list. This allows to quickly see the default list plus a few other

        fields, instead of retyping the entire list of fields.

      </para>

      <para>

        Use <option>--interval</option> to repeat the listing. A delay

        specified by the option value in seconds is inserted.

      </para>

    </refsect2>