python-openstackclient/doc/source/command-objects/group.rst

2.7 KiB

group

Identity v3

group add user

Add user to group

group add user

os group add user
    <group>
    <user>

<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

os group contains user
    <group>
    <user>

<group>

Group to check (name or ID)

<user>

User to check (name or ID)

group create

Create new group

group create

os 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

os 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

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

--domain <domain>

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

--user <user>

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

--long

List additional fields in output

group remove user

Remove user from group

group remove user

os group remove user
    <group>
    <user>

<group>

Group containing <user> (name or ID)

<user>

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

group set

Set group properties

group set

os group set
    [--name <name>]
    [--description <description>]
    <group>

--name <name>

New group name

--description <description>

New group description

<group>

Group to modify (name or ID)

group show

Display group details

group show

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

--domain <domain>

Domain containing <group> (name or ID)

<group>

Group to display (name or ID)