Skip to content

Commit e5d7122

Browse files
committed
add doc for group command
Change-Id: Iaaa0aeb42f9f940af63863f5d09011b5f7529281
1 parent a24d6e7 commit e5d7122

2 files changed

Lines changed: 210 additions & 18 deletions

File tree

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
=====
2+
group
3+
=====
4+
5+
Identity v3
6+
7+
group add user
8+
--------------
9+
10+
Add user to group
11+
12+
.. program:: group add user
13+
.. code:: bash
14+
15+
os group add user
16+
<group>
17+
<user>
18+
19+
.. option:: <group>
20+
21+
Group that user will be added to (name or ID)
22+
23+
.. option:: <user>
24+
25+
User to add to group (name or ID)
26+
27+
group contains user
28+
-------------------
29+
30+
Check user in group
31+
32+
.. program:: group contains user
33+
.. code:: bash
34+
35+
os group contains user
36+
<group>
37+
<user>
38+
39+
.. option:: <group>
40+
41+
Group to check if user belongs to (name or ID)
42+
43+
.. option:: <user>
44+
45+
User to check (name or ID)
46+
47+
group create
48+
------------
49+
50+
Create new group
51+
52+
.. program:: group create
53+
.. code:: bash
54+
55+
os group create
56+
[--domain <domain>]
57+
[--description <description>]
58+
[--or-show]
59+
<group-name>
60+
61+
.. option:: --domain <domain>
62+
63+
References the domain ID or name which owns the group
64+
65+
.. option:: --description <description>
66+
67+
New group description
68+
69+
.. option:: --or-show
70+
71+
Return existing group
72+
73+
If the group already exists, return the existing group data and do not fail.
74+
75+
.. option:: <group-name>
76+
77+
New group name
78+
79+
group delete
80+
------------
81+
82+
Delete group
83+
84+
.. program:: group delete
85+
.. code:: bash
86+
87+
os group delete
88+
[--domain <domain>]
89+
<group> [<group> ...]
90+
91+
.. option:: --domain <domain>
92+
93+
Domain where group resides (name or ID)
94+
95+
.. option:: <group>
96+
97+
Group(s) to delete (name or ID)
98+
99+
group list
100+
----------
101+
102+
List groups
103+
104+
.. program:: group list
105+
.. code:: bash
106+
107+
os group list
108+
[--domain <domain>]
109+
[--user <user>]
110+
[--long]
111+
112+
.. option:: --domain <domain>
113+
114+
Filter group list by <domain> (name or ID)
115+
116+
.. option:: --user <user>
117+
118+
List group memberships for <user> (name or ID)
119+
120+
.. option:: --long
121+
122+
List additional fields in output (defaults to false)
123+
124+
group remove user
125+
-----------------
126+
127+
Remove user from group
128+
129+
.. program:: group remove user
130+
.. code:: bash
131+
132+
os group remove user
133+
<group>
134+
<user>
135+
136+
.. option:: <group>
137+
138+
Group that user will be removed from (name or ID)
139+
140+
.. option:: <user>
141+
142+
User to remove from group (name or ID)
143+
144+
group set
145+
---------
146+
147+
Set group properties
148+
149+
.. program:: group set
150+
.. code:: bash
151+
152+
os group set
153+
[--name <name>]
154+
[--domain <domain>]
155+
[--description <description>]
156+
<group>
157+
158+
.. option:: --name <name>
159+
160+
New group name
161+
162+
.. option:: --domain <domain>
163+
164+
New domain that will now own the group (name or ID)
165+
166+
.. option:: --description <description>
167+
168+
New group description
169+
170+
.. option:: <group>
171+
172+
Group to modify (name or ID)
173+
174+
group show
175+
----------
176+
177+
Show group details
178+
179+
.. program:: group show
180+
.. code:: bash
181+
182+
os group show
183+
[--domain <domain>]
184+
<group>
185+
186+
.. option:: --domain <domain>
187+
188+
Domain where group resides (name or ID)
189+
190+
.. option:: <group>
191+
192+
Group to display (name or ID)

‎openstackclient/identity/v3/group.py‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ def get_parser(self, prog_name):
3939
parser.add_argument(
4040
'group',
4141
metavar='<group>',
42-
help='Group name or ID that user will be added to',
42+
help='Group that user will be added to (name or ID)',
4343
)
4444
parser.add_argument(
4545
'user',
4646
metavar='<user>',
47-
help='User name or ID to add to group',
47+
help='User to add to group (name or ID)',
4848
)
4949
return parser
5050

@@ -68,7 +68,7 @@ def take_action(self, parsed_args):
6868

6969

7070
class CheckUserInGroup(command.Command):
71-
"""Checks that user is in a specific group"""
71+
"""Check user in group"""
7272

7373
log = logging.getLogger(__name__ + '.CheckUserInGroup')
7474

@@ -77,12 +77,12 @@ def get_parser(self, prog_name):
7777
parser.add_argument(
7878
'group',
7979
metavar='<group>',
80-
help='Group name or ID that user will be added to',
80+
help='Group to check if user belongs to (name or ID)',
8181
)
8282
parser.add_argument(
8383
'user',
8484
metavar='<user>',
85-
help='User name or ID to add to group',
85+
help='User to check (name or ID)',
8686
)
8787
return parser
8888

@@ -106,7 +106,7 @@ def take_action(self, parsed_args):
106106

107107

108108
class CreateGroup(show.ShowOne):
109-
"""Create group command"""
109+
"""Create new group"""
110110

111111
log = logging.getLogger(__name__ + '.CreateGroup')
112112

@@ -118,11 +118,11 @@ def get_parser(self, prog_name):
118118
help='New group name')
119119
parser.add_argument(
120120
'--description',
121-
metavar='<group-description>',
121+
metavar='<description>',
122122
help='New group description')
123123
parser.add_argument(
124124
'--domain',
125-
metavar='<group-domain>',
125+
metavar='<domain>',
126126
help='References the domain ID or name which owns the group')
127127
parser.add_argument(
128128
'--or-show',
@@ -268,12 +268,12 @@ def get_parser(self, prog_name):
268268
parser.add_argument(
269269
'group',
270270
metavar='<group>',
271-
help='Group name or ID that user will be removed from',
271+
help='Group that user will be removed from (name or ID)',
272272
)
273273
parser.add_argument(
274274
'user',
275275
metavar='<user>',
276-
help='User name or ID to remove from group',
276+
help='User to remove from group (name or ID)',
277277
)
278278
return parser
279279

@@ -297,7 +297,7 @@ def take_action(self, parsed_args):
297297

298298

299299
class SetGroup(command.Command):
300-
"""Set group command"""
300+
"""Set group properties"""
301301

302302
log = logging.getLogger(__name__ + '.SetGroup')
303303

@@ -306,18 +306,18 @@ def get_parser(self, prog_name):
306306
parser.add_argument(
307307
'group',
308308
metavar='<group>',
309-
help='Name or ID of group to change')
309+
help='Group to modify (name or ID)')
310310
parser.add_argument(
311311
'--name',
312-
metavar='<new-group-name>',
312+
metavar='<name>',
313313
help='New group name')
314314
parser.add_argument(
315315
'--domain',
316-
metavar='<group-domain>',
317-
help='New domain name or ID that will now own the group')
316+
metavar='<domain>',
317+
help='New domain that will now own the group (name or ID)')
318318
parser.add_argument(
319319
'--description',
320-
metavar='<group-description>',
320+
metavar='<description>',
321321
help='New group description')
322322
return parser
323323

@@ -341,7 +341,7 @@ def take_action(self, parsed_args):
341341

342342

343343
class ShowGroup(show.ShowOne):
344-
"""Show group command"""
344+
"""Show group details"""
345345

346346
log = logging.getLogger(__name__ + '.ShowGroup')
347347

@@ -350,7 +350,7 @@ def get_parser(self, prog_name):
350350
parser.add_argument(
351351
'group',
352352
metavar='<group>',
353-
help='Name or ID of group to display',
353+
help='Group to display (name or ID)',
354354
)
355355
parser.add_argument(
356356
'--domain',

0 commit comments

Comments
 (0)