Language:
Format:

Language:
Format:

Chapter 35. group

This chapter describes the commands under the group command.

35.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 35.1. Positional arguments

Value	Summary
<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 35.2. Command arguments

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

35.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 35.3. Positional arguments

Value	Summary
<group>	Group to check (name or id)
<user>	User to check (name or id)

Table 35.4. Command arguments

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

35.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 35.5. Positional arguments

Value	Summary
<group-name>	New group name

Table 35.6. Command arguments

Value	Summary
-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 35.7. Output formatter options

Value	Summary
-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 35.8. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 35.9. Shell formatter options

Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 35.10. Table formatter options

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

35.4. group delete

Delete group(s)

Usage:

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

Table 35.11. Positional arguments

Value	Summary
<group>	Group(s) to delete (name or id)

Table 35.12. Command arguments

Value	Summary
-h, --help	Show this help message and exit
--domain <domain>	Domain containing group(s) (name or id)

35.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 35.13. Command arguments

Value	Summary
-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 35.14. Output formatter options

Value	Summary
-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 35.15. CSV formatter options

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 35.16. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 35.17. Table formatter options

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

35.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 35.18. Positional arguments

Value	Summary
<group>	Group containing <user> (name or id)
<user>	User(s) to remove from <group> (name or id) (repeat option to remove multiple users)

Table 35.19. Command arguments

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

35.7. group set

Set group properties

Usage:

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

Table 35.20. Positional arguments

Value	Summary
<group>	Group to modify (name or id)

Table 35.21. Command arguments

Value	Summary
-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

35.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 35.22. Positional arguments

Value	Summary
<group>	Group to display (name or id)

Table 35.23. Command arguments

Value	Summary
-h, --help	Show this help message and exit
--domain <domain>	Domain containing <group> (name or id)

Table 35.24. Output formatter options

Value	Summary
-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 35.25. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 35.26. Shell formatter options

Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 35.27. Table formatter options

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

Select Your Language

Infrastructure and Management

Cloud Computing

Storage

Runtimes

Integration and Automation

Chapter 35. group

35.1. group add user

35.2. group contains user

35.3. group create

35.4. group delete

35.5. group list

35.6. group remove user

35.7. group set

35.8. group show

Language and Page Formatting Options

Chapter 35. group

35.1. group add user

35.2. group contains user

35.3. group create

35.4. group delete

35.5. group list

35.6. group remove user

35.7. group set

35.8. group show