Chapter 27. domain
This chapter describes the commands under the domain command.
27.1. domain create
Create new domain
Usage:
openstack domain create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty] [--description <description>]
[--enable | --disable] [--or-show]
<domain-name>
Table 27.1. Positional arguments
| Value | Summary |
|---|---|
| <domain-name> | New domain name |
Table 27.2. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --description <description> | New domain description |
| --enable | Enable domain (default) |
| --disable | Disable domain |
| --or-show | Return existing domain |
Table 27.3. 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 27.4. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 27.5. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 27.6. 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. |
27.2. domain delete
Delete domain(s)
Usage:
openstack domain delete [-h] <domain> [<domain> ...]
Table 27.7. Positional arguments
| Value | Summary |
|---|---|
| <domain> | Domain(s) to delete (name or id) |
Table 27.8. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
27.3. domain list
List domains
Usage:
openstack domain 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]
Table 27.9. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 27.10. 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 27.11. CSV formatter options
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 27.12. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 27.13. 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. |
27.4. domain set
Set domain properties
Usage:
openstack domain set [-h] [--name <name>] [--description <description>]
[--enable | --disable]
<domain>
Table 27.14. Positional arguments
| Value | Summary |
|---|---|
| <domain> | Domain to modify (name or id) |
Table 27.15. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | New domain name |
| --description <description> | New domain description |
| --enable | Enable domain |
| --disable | Disable domain |
27.5. domain show
Display domain details
Usage:
openstack domain show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<domain>
Table 27.16. Positional arguments
| Value | Summary |
|---|---|
| <domain> | Domain to display (name or id) |
Table 27.17. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 27.18. 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 27.19. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 27.20. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 27.21. 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. |