Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 44. local

This chapter describes the commands under the local command.

44.1. local ip association create
Copy link

Create Local IP Association

Usage:

openstack local ip association create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--fixed-ip <fixed-ip>]
                                             [--project-domain <project-domain>]
                                             <local-ip> <fixed-port>
Copy to Clipboard Toggle word wrap

Expand
Table 44.1. Positional arguments
ValueSummary

<local-ip>

Local ip that the port association belongs to (name or ID)

<fixed-port>

The id or name of port to allocate local ip Association

Expand
Table 44.2. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--fixed-ip <fixed-ip>

Fixed ip for local ip association

--project-domain <project-domain>

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

Expand
Table 44.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 to show multiple columns

Expand
Table 44.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 44.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

44.2. local ip association delete
Copy link

Delete Local IP association(s)

Usage:

openstack local ip association delete [-h]
                                             <local-ip> <fixed-port-id>
                                             [<fixed-port-id> ...]
Copy to Clipboard Toggle word wrap

Expand
Table 44.7. Positional arguments
ValueSummary

<local-ip>

Local ip that the port association belongs to (name or id)

<fixed-port-id>

The fixed port id of local ip association

Expand
Table 44.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

44.3. local ip association list
Copy link

List Local IP Associations

Usage:

openstack local ip association 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]
                                           [--fixed-port <fixed-port>]
                                           [--fixed-ip <fixed-ip>]
                                           [--host <host>]
                                           [--project-domain <project-domain>]
                                           <local-ip>
Copy to Clipboard Toggle word wrap

Expand
Table 44.9. Positional arguments
ValueSummary

<local-ip>

Local ip that port associations belongs to

Expand
Table 44.10. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--fixed-port <fixed-port>

Filter the list result by the id or name of the fixed port

--fixed-ip <fixed-ip>

Filter the list result by fixed ip

--host <host>

Filter the list result by given host

--project-domain <project-domain>

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

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

Expand
Table 44.12. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 44.13. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

44.4. local ip create
Copy link

Create Local IP

Usage:

openstack local ip create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--name <name>]
                                 [--description <description>]
                                 [--network <network>]
                                 [--local-port <local-port>]
                                 [--local-ip-address <local-ip-address>]
                                 [--ip-mode <ip-mode>]
                                 [--project-domain <project-domain>]
Copy to Clipboard Toggle word wrap

Expand
Table 44.15. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

New local ip name

--description <description>

New local ip description

--network <network>

Network to allocate local ip (name or id)

--local-port <local-port>

Port to allocate local ip (name or id)

--local-ip-address <local-ip-address>

Ip address or cidr

--ip-mode <ip-mode>

Local ip ip mode

--project-domain <project-domain>

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

Expand
Table 44.16. 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 to show multiple columns

Expand
Table 44.17. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 44.18. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

44.5. local ip delete
Copy link

Delete local IP(s)

Usage:

openstack local ip delete [-h] <local-ip> [<local-ip> ...]
Copy to Clipboard Toggle word wrap

Expand
Table 44.20. Positional arguments
ValueSummary

<local-ip>

Local ip(s) to delete (name or id)

Expand
Table 44.21. Command arguments
ValueSummary

-h, --help

Show this help message and exit

44.6. local ip list
Copy link

List local IPs

Usage:

openstack local ip 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>]
                               [--network <network>]
                               [--local-port <local-port>]
                               [--local-ip-address <local-ip-address>]
                               [--ip-mode <ip_mode>]
                               [--project-domain <project-domain>]
Copy to Clipboard Toggle word wrap

Expand
Table 44.22. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

List only local ips of given name in output

--project <project>

List local ips according to their project (name or id)

--network <network>

List local ip(s) according to given network (name or ID)

--local-port <local-port>

List local ip(s) according to given port (name or id)

--local-ip-address <local-ip-address>

List local ip(s) according to given local ip address

--ip-mode <ip_mode>

List local ip(s) according to given ip mode

--project-domain <project-domain>

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

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

Expand
Table 44.24. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 44.25. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

44.7. local ip set
Copy link

Set local ip properties

Usage:

openstack local ip set [-h] [--name <name>]
                              [--description <description>]
                              <local-ip>
Copy to Clipboard Toggle word wrap

Expand
Table 44.27. Positional arguments
ValueSummary

<local-ip>

Local ip to modify (name or id)

Expand
Table 44.28. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set local ip name

--description <description>

Set local ip description

44.8. local ip show
Copy link

Display local IP details

Usage:

openstack local ip show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <local-ip>
Copy to Clipboard Toggle word wrap

Expand
Table 44.29. Positional arguments
ValueSummary

<local-ip>

Local ip to display (name or id)

Expand
Table 44.30. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 44.31. 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 to show multiple columns

Expand
Table 44.32. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 44.33. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

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