openstack/python-openstackclient
Code Issues Proposed changes
python-openstackclient/doc/source/command-objects/group.rst
Kevin_Zheng 847da51dea change os in command example to openstack(2) 
In the current doc, the command examples are like
"os server create" but the acutal command should
be started with "openstack" instead of "os", it
is misleading to first time users.

Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00

4.3 KiB
Raw Blame History

group

Identity v3

group add user

Add user to group

group add user

os group add user
    [--group-domain <group-domain>]
    [--user-domain <user-domain>]
    <group>
    <user>

--group-domain <group-domain>

Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.

3

--user-domain <user-domain>

Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3

<group>

Group to contain <user> (name or ID)

<user>

User to add to <group> (name or ID)

group contains user

Check user membership in group

group contains user

openstack group contains user
    [--group-domain <group-domain>]
    [--user-domain <user-domain>]
    <group>
    <user>

--group-domain <group-domain>

Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.

3

--user-domain <user-domain>

Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3

<group>

Group to check (name or ID)

<user>

User to check (name or ID)

group create

Create new group

group create

openstack group create
    [--domain <domain>]
    [--description <description>]
    [--or-show]
    <group-name>

--domain <domain>

Domain to contain new group (name or ID)

--description <description>

New group description

--or-show

Return existing group

If the group already exists, return the existing group data and do not fail.

<group-name>

New group name

group delete

Delete group

group delete

openstack group delete
    [--domain <domain>]
    <group> [<group> ...]

--domain <domain>

Domain containing group(s) (name or ID)

<group>

Group(s) to delete (name or ID)

group list

List groups

group list

openstack group list
    [--domain <domain>]
    [--user <user> [--user-domain <user-domain>]]
    [--long]

--domain <domain>

Filter group list by <domain> (name or ID)

--user <user>

Filter group list by <user> (name or ID)

--user-domain <user-domain>

Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3

--long

List additional fields in output

group remove user

Remove user from group

group remove user

openstack group remove user
    [--group-domain <group-domain>]
    [--user-domain <user-domain>]
    <group>
    <user>

--group-domain <group-domain>

Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.

3

--user-domain <user-domain>

Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3

<group>

Group containing <user> (name or ID)

<user>

User to remove from <group> (name or ID)

group set

Set group properties

group set

openstack group set
    [--domain <domain>]
    [--name <name>]
    [--description <description>]
    <group>

--domain <domain>

Domain containing <group> (name or ID)

--name <name>

New group name

--description <description>

New group description

<group>

Group to modify (name or ID)

group show

Display group details

group show

openstack group show
    [--domain <domain>]
    <group>

--domain <domain>

Domain containing <group> (name or ID)

<group>

Group to display (name or ID)