Chapter 4. address


This chapter describes the commands under the address command.

4.1. address scope create

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>
Copy to Clipboard Toggle word wrap

Create a new Address Scope

Expand
Table 4.1. Positional Arguments
ValueSummary

<name>

New address scope name

Expand
Table 4.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--ip-version {4,6}

Ip version (default is 4)

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

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

--share

Share the address scope between projects

--no-share

Do not share the address scope between projects (default)

Expand
Table 4.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

Expand
Table 4.4. 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.

Expand
Table 4.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 4.6. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

4.2. address scope delete

Usage:

openstack address scope delete [-h]

                                    <address-scope> [<address-scope> ...]
Copy to Clipboard Toggle word wrap

Delete address scope(s)

Expand
Table 4.7. Positional Arguments
ValueSummary

<address-scope>

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

Expand
Table 4.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

4.3. address scope list

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]
Copy to Clipboard Toggle word wrap

List address scopes

Expand
Table 4.9. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

List only address scopes of given name in output

--ip-version <ip-version>

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

--project <project>

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

--project-domain <project-domain>

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

--share

List address scopes shared between projects

--no-share

List address scopes not shared between projects

Expand
Table 4.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

Expand
Table 4.11. 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.

Expand
Table 4.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 4.13. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

4.4. address scope set

Usage:

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

                                 <address-scope>
Copy to Clipboard Toggle word wrap

Set address scope properties

Expand
Table 4.14. Positional Arguments
ValueSummary

<address-scope>

Address scope to modify (name or id)

Expand
Table 4.15. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set address scope name

--share

Share the address scope between projects

--no-share

Do not share the address scope between projects

4.5. address scope show

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>
Copy to Clipboard Toggle word wrap

Display address scope details

Expand
Table 4.16. Positional Arguments
ValueSummary

<address-scope>

Address scope to display (name or id)

Expand
Table 4.17. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 4.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

Expand
Table 4.19. 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.

Expand
Table 4.20. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 4.21. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Back to top
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. Explore our recent updates.

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.

Theme

© 2025 Red Hat