Language:
Format:

Language:
Format:

Chapter 5. address

This chapter describes the commands under the address command.

5.1. address group create

Create a new Address Group

Usage:

openstack address group create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      [--address <ip-address>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      <name>

Table 5.1. Positional arguments

Value	Summary
<name>	New address group name

Table 5.2. Command arguments

Value	Summary
-h, --help	Show this help message and exit
--description <description>	New address group description
--address <ip-address>	Ip address or cidr (repeat option to set multiple addresses)
--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.

Table 5.3. Output formatter options

Value	Summary
-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 5.4. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 5.5. Shell formatter options

Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 5.6. Table formatter options

Value	Summary
--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.

5.2. address group delete

Delete address group(s)

Usage:

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

Table 5.7. Positional arguments

Value	Summary
<address-group>	Address group(s) to delete (name or id)

Table 5.8. Command arguments

Value	Summary
-h, --help	Show this help message and exit

5.3. address group list

List address groups

Usage:

openstack address group 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>] [--project <project>]
                                    [--project-domain <project-domain>]

Table 5.9. Command arguments

Value	Summary
-h, --help	Show this help message and exit
--name <name>	List only address groups of given name in output
--project <project>	List address groups 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.

Table 5.10. Output formatter options

Value	Summary
-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 5.11. CSV formatter options

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 5.12. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 5.13. Table formatter options

Value	Summary
--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.

5.4. address group set

Set address group properties

Usage:

openstack address group set [-h] [--name <name>]
                                   [--description <description>]
                                   [--address <ip-address>]
                                   <address-group>

Table 5.14. Positional arguments

Value	Summary
<address-group>	Address group to modify (name or id)

Table 5.15. Command arguments

Value	Summary
-h, --help	Show this help message and exit
--name <name>	Set address group name
--description <description>	Set address group description
--address <ip-address>	Ip address or cidr (repeat option to set multiple addresses)

5.5. address group show

Display address group details

Usage:

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

Table 5.16. Positional arguments

Value	Summary
<address-group>	Address group to display (name or id)

Table 5.17. Command arguments

Value	Summary
-h, --help	Show this help message and exit

Table 5.18. Output formatter options

Value	Summary
-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 5.19. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 5.20. Shell formatter options

Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 5.21. Table formatter options

Value	Summary
--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.

5.6. address group unset

Unset address group properties

Usage:

openstack address group unset [-h] [--address <ip-address>]
                                     <address-group>

Table 5.22. Positional arguments

Value	Summary
<address-group>	Address group to modify (name or id)

Table 5.23. Command arguments

Value	Summary
-h, --help	Show this help message and exit
--address <ip-address>	Ip address or cidr (repeat option to unset multiple addresses)

5.7. address scope create

Create a new Address Scope

Usage:

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

Table 5.24. Positional arguments

Value	Summary
<name>	New address scope name

Table 5.25. Command arguments

Value	Summary
-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)

Table 5.26. Output formatter options

Value	Summary
-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 5.27. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 5.28. Shell formatter options

Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 5.29. Table formatter options

Value	Summary
--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.

5.8. address scope delete

Delete address scope(s)

Usage:

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

Table 5.30. Positional arguments

Value	Summary
<address-scope>	Address scope(s) to delete (name or id)

Table 5.31. Command arguments

Value	Summary
-h, --help	Show this help message and exit

5.9. address scope list

List address scopes

Usage:

openstack address scope 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>]
                                    [--ip-version <ip-version>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--share | --no-share]

Table 5.32. Command arguments

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

Table 5.33. Output formatter options

Value	Summary
-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 5.34. CSV formatter options

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 5.35. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 5.36. Table formatter options

Value	Summary
--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.

5.10. address scope set

Set address scope properties

Usage:

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

Table 5.37. Positional arguments

Value	Summary
<address-scope>	Address scope to modify (name or id)

Table 5.38. Command arguments

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

5.11. address scope show

Display address scope details

Usage:

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

Table 5.39. Positional arguments

Value	Summary
<address-scope>	Address scope to display (name or id)

Table 5.40. Command arguments

Value	Summary
-h, --help	Show this help message and exit

Table 5.41. Output formatter options

Value	Summary
-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 5.42. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 5.43. Shell formatter options

Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 5.44. Table formatter options

Value	Summary
--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.

Select Your Language

Chapter 5. address

5.1. address group create

5.2. address group delete

5.3. address group list

5.4. address group set

5.5. address group show

5.6. address group unset

5.7. address scope create

5.8. address scope delete

5.9. address scope list

5.10. address scope set

5.11. address scope show

Quick Links

Help

Site Info

Related Sites

About

Red Hat legal and privacy links

Red Hat legal and privacy links

Language and Page Formatting Options

Chapter 5. address

5.1. address group create

5.2. address group delete

5.3. address group list

5.4. address group set

5.5. address group show

5.6. address group unset

5.7. address scope create

5.8. address scope delete

5.9. address scope list

5.10. address scope set

5.11. address scope show

Quick Links

Help

Site Info

Related Sites

Systems Status

About

Red Hat legal and privacy links

Red Hat legal and privacy links