Menu Close

Chapter 4. address

This chapter describes the commands under the address command.

4.1. address scope create

Create a new Address Scope

Usage:

openstack address scope create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--ip-version {4,6}]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>

Table 4.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 4.2. Positional Arguments

ValueSummary

<name>

New address scope name

Table 4.3. Output Formatters

ValueSummary

output formatter options-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 4.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.5. Optional Arguments

ValueSummary

--share

Share the address scope between projects

--ip-version {4,6}

Ip version (default is 4)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--no-share

Do not share the address scope between projects (default)

-h, --help

Show this help message and exit

--project <project>

Owner’s project (name or id)

Table 4.6. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

4.2. address scope delete

Delete address scope(s)

Usage:

openstack address scope delete [-h]
                                      <address-scope> [<address-scope> ...]

Table 4.7. Positional Arguments

ValueSummary

<address-scope>

Address scope(s) to delete (name or id)

Table 4.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

4.3. address scope list

List address scopes

Usage:

openstack address scope list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--name <name>]
                                    [--ip-version <ip-version>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--share | --no-share]

Table 4.9. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 4.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 4.11. Output Formatters

ValueSummary

output formatter options-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 4.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.13. Optional Arguments

ValueSummary

--share

List address scopes shared between projects

--ip-version <ip-version>

List address scopes of given ip version networks (4 or 6)

--name <name>

List only address scopes of given name in output

--project <project>

List address scopes according to their project (name or ID)

--no-share

List address scopes not shared between projects

-h, --help

Show this help message and exit

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

4.4. address scope set

Set address scope properties

Usage:

openstack address scope set [-h] [--name <name>] [--share | --no-share]
                                   <address-scope>

Table 4.14. Positional Arguments

ValueSummary

<address-scope>

Address scope to modify (name or id)

Table 4.15. Optional Arguments

ValueSummary

--share

Share the address scope between projects

--name <name>

Set address scope name

-h, --help

Show this help message and exit

--no-share

Do not share the address scope between projects

4.5. address scope show

Display address scope details

Usage:

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

Table 4.16. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 4.17. Positional Arguments

ValueSummary

<address-scope>

Address scope to display (name or id)

Table 4.18. Output Formatters

ValueSummary

output formatter options-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 4.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 4.21. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names