openafs/doc/xml/AdminReference/sect1/pts_setmax.xml

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="pts_setmax1">
  <refmeta>
    <refentrytitle>pts setmax</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>pts setmax</refname>
    <refpurpose>Sets the value of the max group id or max user id counter</refpurpose>
  </refnamediv>
  <refsect1>
    <title>Synopsis</title>
    <para><emphasis role="bold">pts setmax</emphasis> [<emphasis role="bold">-group</emphasis> &lt;<emphasis>group max</emphasis>&gt;] [<emphasis role="bold">-user</emphasis> &lt;<emphasis>user max</emphasis>&gt;]
        [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-force</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>

    <para><emphasis role="bold">pts setm</emphasis> [<emphasis role="bold">-g</emphasis> <emphasis>group max</emphasis>&gt;] [<emphasis role="bold">-u</emphasis> &lt;<emphasis>user max</emphasis>&gt;]
        [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-f</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>

  </refsect1>
  <refsect1>
    <title>Description</title>
    <para>The <emphasis role="bold">pts setmax</emphasis> command sets the value of one or both counters that
    track the IDs the Protection Server allocates to new users, machines, or
    groups: the <computeroutput>max user id</computeroutput> counter for the AFS user IDs (AFS UIDs)
    assigned to users and machines, and the <computeroutput>max group id</computeroutput> counter for the
    AFS group IDs (AFS GIDs) assigned to groups.</para>

    <para>Use the <emphasis role="bold">pts listmax</emphasis> command to display the current value of both
    counters.</para>

  </refsect1>
  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
        <term><emphasis role="bold">-group</emphasis> &lt;<emphasis>group max</emphasis>&gt;</term>
        <listitem>
          <para>Sets the <computeroutput>max group id</computeroutput> counter. Precede the value with a hyphen to
          indicate that it is negative. When an administrator next uses the <emphasis role="bold">pts
          creategroup</emphasis> command to create a group entry and does not include that
          command's <emphasis role="bold">-id</emphasis> argument, the Protection Server assigns the group an AFS
          GID one less (more negative) than this value.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-user</emphasis> &lt;<emphasis>user max</emphasis>&gt;</term>
        <listitem>
          <para>Sets the <computeroutput>max user id</computeroutput> counter. When an administrator next uses the <emphasis role="bold">pts
          createuser</emphasis> command to create a user or machine entry and does not include
          that command's <emphasis role="bold">-id</emphasis> argument, the Protection Server assigns the group an
          AFS UID one greater than this value.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
        <listitem>
          <para>Names the cell in which to run the command. For more details, see
          <link linkend="pts1">pts(1)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-noauth</emphasis></term>
        <listitem>
          <para>Assigns the unprivileged identity anonymous to the issuer. For more
          details, see <link linkend="pts1">pts(1)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-force</emphasis></term>
        <listitem>
          <para>Enables the command to continue executing as far as possible when errors
          or other problems occur, rather than halting execution at the first error.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-help</emphasis></term>
        <listitem>
          <para>Prints the online help for this command. All other valid options are
          ignored.</para>

        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>Examples</title>
    <para>The following command sets the <computeroutput>max group id</computeroutput> counter to -500 and the
    <computeroutput>max user id</computeroutput> counter to 1000.</para>

<programlisting>
   % pts setmax -group -500 -user 1000

</programlisting>
    </refsect1>
    <refsect1>
      <title>Privilege Required</title>
      <para>The issuer must belong to the system:administrators group.</para>

    </refsect1>
    <refsect1>
      <title>See Also</title>
      <para><link linkend="pts1">pts(1)</link>,
      <link linkend="pts_creategroup1">pts_creategroup(1)</link>,
      <link linkend="pts_createuser1">pts_createuser(1)</link>,
      <link linkend="pts_listmax1">pts_listmax(1)</link></para>

    </refsect1>
    <refsect1>
      <title>Copyright</title>
      <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>

      <para>This documentation is covered by the IBM Public License Version 1.0.  It was
      converted from HTML to POD by software written by Chas Williams and Russ
      Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>

    </refsect1>
  </refentry>