SupportConsoleDevelopersStart a trialContact

Chapter 28. domain

This chapter describes the commands under the domain command.

28.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]
                               [--immutable | --no-immutable]
                               <domain-name>

Table 28.1. Positional arguments
ValueSummary

<domain-name>

New domain name

Table 28.2. Command 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

--immutable

Make resource immutable. an immutable project may not be deleted or modified except to remove the immutable flag

--no-immutable

Make resource mutable (default)

Table 28.3. Output formatter options
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 to show multiple columns

Table 28.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 28.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 28.6. Table formatter options
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.

28.2. domain delete

Delete domain(s)

Usage:

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

Table 28.7. Positional arguments
ValueSummary

<domain>

Domain(s) to delete (name or id)

Table 28.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

28.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]
                             [--sort-ascending | --sort-descending]
                             [--name <name>] [--enabled]

Table 28.9. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

The domain name

--enabled

The domains that are enabled will be returned

Table 28.10. Output formatter options
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 to show multiple columns

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 28.11. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 28.12. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 28.13. Table formatter options
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.

28.4. domain set

Set domain properties

Usage:

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

Table 28.14. Positional arguments
ValueSummary

<domain>

Domain to modify (name or id)

Table 28.15. Command 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

--immutable

Make resource immutable. an immutable project may not be deleted or modified except to remove the immutable flag

--no-immutable

Make resource mutable (default)

28.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 28.16. Positional arguments
ValueSummary

<domain>

Domain to display (name or id)

Table 28.17. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 28.18. Output formatter options
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 to show multiple columns

Table 28.19. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 28.20. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 28.21. Table formatter options
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.

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.