Chapter 37. group

This chapter describes the commands under the group command.

37.1. group add user

Add user to group

Usage:

openstack group add user [-h] [--group-domain <group-domain>]
                                [--user-domain <user-domain>]
                                <group> <user> [<user> ...]

Table 37.1. Positional Arguments

ValueSummary

<group>

Group to contain <user> (name or id)

<user>

User(s) to add to <group> (name or id) (repeat option to add multiple users)

Table 37.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--group-domain <group-domain>

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

--user-domain <user-domain>

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

37.2. group contains user

Check user membership in group

Usage:

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

Table 37.3. Positional Arguments

ValueSummary

<group>

Group to check (name or id)

<user>

User to check (name or id)

Table 37.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--group-domain <group-domain>

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

--user-domain <user-domain>

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

37.3. group create

Create new group

Usage:

openstack group create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--domain <domain>]
                              [--description <description>] [--or-show]
                              <group-name>

Table 37.5. Positional Arguments

ValueSummary

<group-name>

New group name

Table 37.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain to contain new group (name or id)

--description <description>

New group description

--or-show

Return existing group

Table 37.7. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 37.8. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 37.9. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 37.10. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

37.4. group delete

Delete group(s)

Usage:

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

Table 37.11. Positional Arguments

ValueSummary

<group>

Group(s) to delete (name or id)

Table 37.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain containing group(s) (name or id)

37.5. group list

List groups

Usage:

openstack group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--domain <domain>] [--user <user>]
                            [--user-domain <user-domain>] [--long]

Table 37.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--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.

--long

List additional fields in output

Table 37.14. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 37.15. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 37.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 37.17. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

37.6. group remove user

Remove user from group

Usage:

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

Table 37.18. Positional Arguments

ValueSummary

<group>

Group containing <user> (name or id)

<user>

User(s) to remove from <group> (name or id) (repeat option to remove multiple users)

Table 37.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--group-domain <group-domain>

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

--user-domain <user-domain>

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

37.7. group set

Set group properties

Usage:

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

Table 37.20. Positional Arguments

ValueSummary

<group>

Group to modify (name or id)

Table 37.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain containing <group> (name or id)

--name <name>

New group name

--description <description>

New group description

37.8. group show

Display group details

Usage:

openstack group show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--domain <domain>]
                            <group>

Table 37.22. Positional Arguments

ValueSummary

<group>

Group to display (name or id)

Table 37.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain containing <group> (name or id)

Table 37.24. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 37.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 37.26. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 37.27. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.