doc/man-pages/pod/pts_membership.pod

   1 =head1 NAME
   2
   3 pts membership - Displays the membership list for a user or group
   4
   5 =head1 SYNOPSIS
   6
   7 pts membership B<-nameorid> I<user or group name or id>
   8 [I<user or group name or id> ...]
   9 [B<-cell> I<cell name>]
  10 [B<-noauth>]  [B<-force>]  [B<-help>]
  11
  12 pts m B<-na> I<user or group name or id>
  13 [I<user or group name or id> ...]
  14 [B<-c> I<cell name>]  [B<-no>]  [B<-f>]  [B<-h>]
  15
  16 pts groups B<-na> I<user or group name or id>
  17 [I<user or group name or id> ...]
  18 [B<-c> I<cell name>]
  19 [B<-no>] [B<-f>]  [B<-h>]
  20
  21 pts g B<-na> I<user or group name or id>
  22 [I<user or group name or id> ...]
  23 [B<-c> I<cell name>]  [B<-no>]  [B<-f>]  [B<-h>]
  24
  25 =head1 DESCRIPTION
  26
  27 The C<pts membership> command lists the groups to which each user or
  28 machine specified by the B<-nameorid> argument belongs, or lists the
  29 users and machines that belong to each group specified by the
  30 B<-nameorid> argument.
  31 It is not possible to list the members of the system:anyuser or
  32 system:authuser groups, and they do not appear in the list of groups
  33 to which a user belongs.
  34 To add users or machine to groups, use the pts adduser command; to
  35 remove them, use the pts removeuser command.
  36
  37 =head1 OPTIONS
  38
  39 =over 4
  40
  41 =item B<-nameorid> I<user or group name or id> [I<user or group name or id> ...]
  42
  43 Specifies the name or AFS UID of each user entry, the IP
  44 address (complete or wildcard-style) or AFS UID of each machine
  45 entry, or the name or AFS GID of each group, for which to list
  46 group membership. It is acceptable to mix users, machines, and
  47 groups on the same command line, as well as names and IDs.
  48 Precede the GID of each group with a hyphen to indicate that it
  49 is negative.
  50
  51 =item B<-cell> I<cell name>
  52
  53 Names the cell in which to run the command. For more details,
  54 see the introductory L<pts(1)> reference page.
  55
  56 =item B<-noauth>
  57
  58 Assigns the unprivileged identity anonymous to the issuer. For
  59 more details, see the introductory L<pts(1)> reference page.
  60
  61 =item B<-force>
  62
  63 Enables the command to continue executing as far as possible
  64 when errors or other problems occur, rather than halting
  65 execution at the first error.
  66
  67 =item B<-help>
  68
  69 Prints the online help for this command. All other valid
  70 options are ignored.
  71
  72 ==back
  73
  74 =head1 OUTPUT
  75
  76 For each user and machine, the output begins with the following header
  77 line, followed by a list of the groups to which the user or machine
  78 belongs:
  79
  80 Groups name (id: AFS UID) is a member of:
  81
  82 For each group, the output begins with the following header line,
  83 followed by a list of the users and machines who belong to the group:
  84
  85 Members of group_name (id: AFS GID) are:
  86
  87 =head1 EXAMPLES
  88
  89 The following example lists the groups to which the user pat belongs
  90 and the members of the group smith:friends. Note that third privacy
  91 flag for the pat entry was changed from the default hyphen to enable a
  92 non-administrative user to obtain this listing.
  93
  94     pts membership pat smith:friends
  95
  96     Groups pat (id: 1144) is a member of:
  97     smith:friends
  98     staff
  99     johnson:project-team
 100     Members of smith:friends (id: -562) are:
 101     pat
 102     terry
 103     jones
 104     richard
 105     thompson
 106
 107 =head1 PRIVILEGE REQUIRED
 108
 109 The required privilege depends on the setting of the third privacy
 110 flag in the Protection Database entry of each user or group indicated
 111 by the B<-nameorid> argument (use the pts examine command to display the
 112 flags):
 113
 114 =over 4
 115
 116 =item *
 117
 118 If it is the hyphen and the B<-nameorid> argument specifies a user,
 119 only the associated user and members of the system:administrators
 120 group can list the groups to which the user belongs.
 121
 122 =item *
 123
 124 If it is the hyphen and the B<-nameorid> argument specifies a
 125 machine, only the members of the system:administrators group can
 126 list the groups to which the machine belongs.
 127
 128 =item *
 129
 130 If it is the hyphen and the B<-nameorid> argument specifies a group,
 131 only the owner of the group and members of the
 132 system:administrators group can list the members of the group.
 133
 134 =item *
 135
 136 If it is lowercase m and the B<-nameorid> argument specifies a user
 137 or machine entry, the meaning is equivalent to the hyphen.
 138
 139 =item *
 140
 141 If it is lowercase m and the B<-nameorid> argument specifies a group,
 142 members of the group can also list the other members.
 143
 144 =item *
 145
 146 If it is uppercase M, anyone who can access the cell's database
 147 server machines can list group memberships.
 148
 149 =back
 150
 151 =head1 COPYRIGHT
 152
 153 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 154
 155 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
 156 Stanford Linear Accelerator Center, a department of Stanford University.
 157
 158 =head1 SEE ALSO
 159
 160 L<pts(1)>,
 161 L<pts_adduser(1)>,
 162 L<pts_examine(1)>,
 163 L<pts_removeuser(1)>,
 164 L<pts_setfields(1)>
 165
 166 =cut