Chapter 64. region

This chapter describes the commands under the region command.

64.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 64.1. Positional Arguments

ValueSummary

<region-id>

New region id

Table 64.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--parent-region <region-id>

Parent region id

--description <description>

New region description

Table 64.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 64.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 64.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

64.2. region delete

Delete region(s)

Usage:

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

Table 64.7. Positional Arguments

ValueSummary

<region-id>

Region id(s) to delete

Table 64.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

64.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 64.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--parent-region <region-id>

Filter by parent region id

Table 64.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 64.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 64.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

64.4. region set

Set region properties

Usage:

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

Table 64.14. Positional Arguments

ValueSummary

<region-id>

Region to modify

Table 64.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--parent-region <region-id>

New parent region id

--description <description>

New region description

64.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 64.16. Positional Arguments

ValueSummary

<region-id>

Region to display

Table 64.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 64.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 64.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 64.20. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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