Chapter 35. floating
This chapter describes the commands under the floating
command.
35.1. floating ip create Copy linkLink copied to clipboard!
Usage:
Create floating IP
Value | Summary |
---|---|
<network> | Network to allocate floating ip from (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--subnet <subnet> | Subnet on which you want to create the floating ip (name or ID) |
--port <port> | Port to be associated with the floating ip (name or ID) |
--floating-ip-address <ip-address> | Floating IP address |
--fixed-ip-address <ip-address> | Fixed IP address mapped to the floating IP |
--qos-policy <qos-policy> | Attach QoS policy to the floating IP (name or ID) |
--description <description> | Set floating IP description |
--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. |
--tag <tag> | Tag to be added to the floating ip (repeat option to set multiple tags) |
--no-tag | No tags associated with the floating ip |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
35.2. floating ip delete Copy linkLink copied to clipboard!
Usage:
openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]
openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]
Delete floating IP(s)
Value | Summary |
---|---|
<floating-ip> | Floating ip(s) to delete (ip address or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
35.3. floating ip list Copy linkLink copied to clipboard!
Usage:
List floating IP(s)
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--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) |
--fixed-ip-address <ip-address> | List floating IP(s) according to given fixed IP address |
--long | List additional fields in output |
--status <status> | List floating ip(s) according to given status ('ACTIVE', 'DOWN') |
--project <project> | List floating ip(s) according to given 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. |
--router <router> | List floating ip(s) according to given router (name or ID) |
--tags <tag>[,<tag>,…] | List floating IP which have all given tag(s) (Comma- separated list of tags) |
--any-tags <tag>[,<tag>,…] | List floating IP which have any given tag(s) (Comma- separated list of tags) |
--not-tags <tag>[,<tag>,…] | Exclude floating IP which have all given tag(s) (Comma-separated list of tags) |
--not-any-tags <tag>[,<tag>,…] | Exclude floating IP which have any given tag(s) (Comma-separated list of tags) |
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 |
--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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
35.4. floating ip pool list Copy linkLink copied to clipboard!
Usage:
List pools of floating IP addresses
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
--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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
35.5. floating ip set Copy linkLink copied to clipboard!
Usage:
Set floating IP Properties
Value | Summary |
---|---|
<floating-ip> | Floating ip to modify (ip address or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--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) |
--qos-policy <qos-policy> | Attach QoS policy to the floating IP (name or ID) |
--no-qos-policy | Remove the qos policy attached to the floating ip |
--tag <tag> | Tag to be added to the floating ip (repeat option to set multiple tags) |
--no-tag | Clear tags associated with the floating ip. specify both --tag and --no-tag to overwrite current tags |
35.6. floating ip show Copy linkLink copied to clipboard!
Usage:
Display floating IP details
Value | Summary |
---|---|
<floating-ip> | Floating ip to display (ip address or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
35.7. floating ip unset Copy linkLink copied to clipboard!
Usage:
openstack floating ip unset [-h] [--port] [--qos-policy] [--tag <tag> | --all-tag] <floating-ip>
openstack floating ip unset [-h] [--port] [--qos-policy]
[--tag <tag> | --all-tag]
<floating-ip>
Unset floating IP Properties
Value | Summary |
---|---|
<floating-ip> | Floating ip to disassociate (ip address or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--port | Disassociate any port associated with the floating ip |
--qos-policy | Remove the qos policy attached to the floating ip |
--tag <tag> | Tag to be removed from the floating ip (repeat option to remove multiple tags) |
--all-tag | Clear all tags associated with the floating ip |