Chapter 62. region

This chapter describes the commands under the region command.

62.1. region create

Create new region

Usage:

openstack region create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--parent-region <region-id>]
                               [--description <description>]
                               <region-id>

Table 62.1. Positional arguments

ValueSummary

<region-id>

New region id

Table 62.2. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--parent-region <region-id>

Parent region id

--description <description>

New region description

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

Table 62.4. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.5. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

62.2. region delete

Delete region(s)

Usage:

openstack region delete [-h] <region-id> [<region-id> ...]

Table 62.7. Positional arguments

ValueSummary

<region-id>

Region id(s) to delete

Table 62.8. Command arguments

ValueSummary

-h, --help

Show this help message and exit

62.3. region list

List regions

Usage:

openstack region 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]
                             [--parent-region <region-id>]

Table 62.9. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--parent-region <region-id>

Filter by parent region id

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

--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 62.11. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.12. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

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

62.4. region set

Set region properties

Usage:

openstack region set [-h] [--parent-region <region-id>]
                            [--description <description>]
                            <region-id>

Table 62.14. Positional arguments

ValueSummary

<region-id>

Region to modify

Table 62.15. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--parent-region <region-id>

New parent region id

--description <description>

New region description

62.5. region show

Display region details

Usage:

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

Table 62.16. Positional arguments

ValueSummary

<region-id>

Region to display

Table 62.17. Command arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 62.19. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.20. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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