Menu Close

Chapter 31. floating

This chapter describes the commands under the floating command.

31.1. floating ip create

Create floating IP

Usage:

openstack floating ip create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] [--subnet <subnet>]
                                    [--port <port>]
                                    [--floating-ip-address <ip-address>]
                                    [--fixed-ip-address <ip-address>]
                                    [--qos-policy <qos-policy>]
                                    [--description <description>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    <network>

Table 31.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 31.2. Positional Arguments

ValueSummary

<network>

Network to allocate floating ip from (name or id)

Table 31.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 31.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 31.5. Optional Arguments

ValueSummary

--fixed-ip-address <ip-address>

Fixed ip address mapped to the floating ip

--description <description>

Set floating ip description

--project-domain <project-domain>

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

--project <project>

Owner’s project (name or id)

--port <port>

Port to be associated with the floating ip (name or ID)

--qos-policy <qos-policy>

Attach qos policy to the floating ip (name or id)

-h, --help

Show this help message and exit

--floating-ip-address <ip-address>

Floating ip address

--subnet <subnet>

Subnet on which you want to create the floating ip (name or ID)

Table 31.6. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

31.2. floating ip delete

Delete floating IP(s)

Usage:

openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]

Table 31.7. Positional Arguments

ValueSummary

<floating-ip>

Floating ip(s) to delete (ip address or id)

Table 31.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

31.3. floating ip list

List floating IP(s)

Usage:

openstack floating ip 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]
                                  [--network <network>] [--port <port>]
                                  [--fixed-ip-address <ip-address>] [--long]
                                  [--status <status>] [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--router <router>]

Table 31.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 31.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 31.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 31.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 31.13. Optional Arguments

ValueSummary

--fixed-ip-address <ip-address>

List floating ip(s) according to given fixed ip address

--router <router>

List floating ip(s) according to given router (name or ID)

--long

List additional fields in output

--project-domain <project-domain>

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

--status <status>

List floating ip(s) according to given status (ACTIVE, DOWN)

--network <network>

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

--port <port>

List floating ip(s) according to given port (name or ID)

-h, --help

Show this help message and exit

--project <project>

List floating ip(s) according to given project (name or ID)

31.4. floating ip pool list

List pools of floating IP addresses

Usage:

openstack floating ip pool 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]

Table 31.14. 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 31.15. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 31.16. 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 31.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 31.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

31.5. floating ip set

Set floating IP Properties

Usage:

openstack floating ip set [-h] [--port <port>]
                                 [--fixed-ip-address <ip-address>]
                                 [--qos-policy <qos-policy> | --no-qos-policy]
                                 <floating-ip>

Table 31.19. Positional Arguments

ValueSummary

<floating-ip>

Floating ip to modify (ip address or id)

Table 31.20. Optional Arguments

ValueSummary

--qos-policy <qos-policy>

Attach qos policy to the floating ip (name or id)

-h, --help

Show this help message and exit

--no-qos-policy

Remove the qos policy attached to the floating ip

--port <port>

Associate the floating ip with port (name or id)

--fixed-ip-address <ip-address>

Fixed ip of the port (required only if port has multiple IPs)

31.6. floating ip show

Display floating IP details

Usage:

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

Table 31.21. 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 31.22. Positional Arguments

ValueSummary

<floating-ip>

Floating ip to display (ip address or id)

Table 31.23. 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 31.24. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 31.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 31.26. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

31.7. floating ip unset

Unset floating IP Properties

Usage:

openstack floating ip unset [-h] [--port] [--qos-policy] <floating-ip>

Table 31.27. Positional Arguments

ValueSummary

<floating-ip>

Floating ip to disassociate (ip address or id)

Table 31.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--qos-policy

Remove the qos policy attached to the floating ip

--port

Disassociate any port associated with the floating ip