Chapter 29. domain

This chapter describes the commands under the domain command.

29.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 29.1. Positional Arguments

ValueSummary

<domain-name>

New domain name

Table 29.2. Optional Arguments

ValueSummary

-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 29.3. 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 29.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 29.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

29.2. domain delete

Delete domain(s)

Usage:

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

Table 29.7. Positional Arguments

ValueSummary

<domain>

Domain(s) to delete (name or id)

Table 29.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

29.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 29.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 29.10. 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 29.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 29.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

29.4. domain set

Set domain properties

Usage:

openstack domain set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            <domain>

Table 29.14. Positional Arguments

ValueSummary

<domain>

Domain to modify (name or id)

Table 29.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New domain name

--description <description>

New domain description

--enable

Enable domain

--disable

Disable domain

29.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 29.16. Positional Arguments

ValueSummary

<domain>

Domain to display (name or id)

Table 29.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 29.18. 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 29.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 29.20. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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