doc/xml/AdminReference/sect1/pts_adduser.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="pts_adduser1">
   3   <refmeta>
   4     <refentrytitle>pts adduser</refentrytitle>
   5     <manvolnum>1</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>pts adduser</refname>
   9     <refpurpose>Adds a user or machine to a Protection Database group</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">pts adduser</emphasis> <emphasis role="bold">-user</emphasis> &lt;<emphasis>user name</emphasis>&gt;+ <emphasis role="bold">-group</emphasis> &lt;<emphasis>group name</emphasis>&gt;+
  14         [<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>
  15
  16     <para><emphasis role="bold">pts ad</emphasis> <emphasis role="bold">-u</emphasis> &lt;<emphasis>user name</emphasis>&gt;+ <emphasis role="bold">-g</emphasis> &lt;<emphasis>group name</emphasis>&gt;+
  17         [<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>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">pts adduser</emphasis> command adds each user or machine entry named by the
  23     <emphasis role="bold">-user</emphasis> argument as a member of each group named by the <emphasis role="bold">-group</emphasis>
  24     argument.</para>
  25
  26     <para>To remove members of a group, use the <emphasis role="bold">pts removeuser</emphasis> command. To list
  27     the groups to which a user or machine belongs, or the members of a
  28     specified group, use the <emphasis role="bold">pts membership</emphasis> command.</para>
  29
  30   </refsect1>
  31   <refsect1>
  32     <title>Cautions</title>
  33     <para>After being added as a group member, a currently authenticated user must
  34     reauthenticate (for example, by issuing the <emphasis role="bold">klog</emphasis> command) to obtain
  35     permissions granted to the group on an access control list (ACL).</para>
  36
  37   </refsect1>
  38   <refsect1>
  39     <title>Options</title>
  40     <variablelist>
  41       <varlistentry>
  42         <term><emphasis role="bold">-user</emphasis> &lt;<emphasis>user name</emphasis>&gt;+</term>
  43         <listitem>
  44           <para>Specifies the name of each user or machine entry to add to each group
  45           named by the <emphasis role="bold">-group</emphasis> argument. The name of a machine entry resembles an
  46           IP address and can use the wildcard notation described on the <emphasis role="bold">pts
  47           createuser</emphasis> reference page. The user or machine entry must already exist
  48           in the Protection Database.</para>
  49
  50         </listitem>
  51       </varlistentry>
  52       <varlistentry>
  53         <term><emphasis role="bold">-group</emphasis> &lt;<emphasis>group name</emphasis>&gt;+</term>
  54         <listitem>
  55           <para>Specifies the complete name (including the owner prefix if applicable) of
  56           each group to which to add members. The group entry must already exist in
  57           the Protection Database.</para>
  58
  59         </listitem>
  60       </varlistentry>
  61       <varlistentry>
  62         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  63         <listitem>
  64           <para>Names the cell in which to run the command. For more details, see
  65           <link linkend="pts1">pts(1)</link>.</para>
  66
  67         </listitem>
  68       </varlistentry>
  69       <varlistentry>
  70         <term><emphasis role="bold">-noauth</emphasis></term>
  71         <listitem>
  72           <para>Assigns the unprivileged identity anonymous to the issuer. For more
  73           details, see <link linkend="pts1">pts(1)</link>.</para>
  74
  75         </listitem>
  76       </varlistentry>
  77       <varlistentry>
  78         <term><emphasis role="bold">-force</emphasis></term>
  79         <listitem>
  80           <para>Enables the command to continue executing as far as possible when errors
  81           or other problems occur, rather than halting execution at the first error.</para>
  82
  83         </listitem>
  84       </varlistentry>
  85       <varlistentry>
  86         <term><emphasis role="bold">-help</emphasis></term>
  87         <listitem>
  88           <para>Prints the online help for this command. All other valid options are
  89           ignored.</para>
  90
  91         </listitem>
  92       </varlistentry>
  93     </variablelist>
  94   </refsect1>
  95   <refsect1>
  96     <title>Examples</title>
  97     <para>The following example adds user smith to the group system:administrators.</para>
  98
  99 <programlisting>
 100    % pts adduser -user smith -group system:administrators
 101
 102 </programlisting>
 103       <para>The following example adds users <computeroutput>jones</computeroutput>, <computeroutput>terry</computeroutput>, and <emphasis role="bold">pat</emphasis> to the
 104       smith:colleagues group.</para>
 105
 106 <programlisting>
 107    % pts adduser -user jones terry pat -group smith:colleagues
 108
 109 </programlisting>
 110         <para>The following example adds the machine entries in the ABC Corporation
 111         subnet to the group <computeroutput>bin-prot</computeroutput>. Because of the IP address range of the
 112         ABC Corporation subnet, the system administrator was able to group the
 113         machines into three machine entries (using the wildcard notation discussed
 114         on the <emphasis role="bold">pts createuser</emphasis> reference page).</para>
 115
 116 <programlisting>
 117    % pts adduser -user 138.255.0.0 192.12.105.0 192.12.106.0 -group bin-prot
 118
 119 </programlisting>
 120         </refsect1>
 121         <refsect1>
 122           <title>Privilege Required</title>
 123           <para>The required privilege depends on the setting of the fourth privacy flag
 124           in the Protection Database entry for each group named by the <emphasis role="bold">-group</emphasis>
 125           argument (use the <emphasis role="bold">pts examine</emphasis> command to display the flags):</para>
 126
 127           <itemizedlist>
 128             <listitem>
 129               <para>If it is the hyphen, only the group's owner and members of the
 130               system:administrators group can add members.</para>
 131
 132             </listitem>
 133             <listitem>
 134               <para>If it is lowercase <computeroutput>a</computeroutput>, current members of the group can add new members.</para>
 135
 136             </listitem>
 137             <listitem>
 138               <para>If it is uppercase <computeroutput>A</computeroutput>, anyone who can access the cell's database server
 139               machines can add new members.</para>
 140
 141             </listitem>
 142           </itemizedlist>
 143         </refsect1>
 144         <refsect1>
 145           <title>See Also</title>
 146           <para><link linkend="pts1">pts(1)</link>,
 147           <link linkend="pts_createuser1">pts_createuser(1)</link>,
 148           <link linkend="pts_examine1">pts_examine(1)</link>,
 149           <link linkend="pts_membership1">pts_membership(1)</link>,
 150           <link linkend="pts_removeuser1">pts_removeuser(1)</link>,
 151           <link linkend="pts_setfields1">pts_setfields(1)</link></para>
 152
 153         </refsect1>
 154         <refsect1>
 155           <title>Copyright</title>
 156           <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 157
 158           <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 159           converted from HTML to POD by software written by Chas Williams and Russ
 160           Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 161
 162         </refsect1>
 163       </refentry>