Chapter 36. floating
Chapter 36. floating This chapter describes the commands under the floating command. 36.1. floating ip create Create floating IP Usage: Table 36.1. Positional Arguments Value Summary <network> Network to allocate floating ip from (name or id) Table 36.2. Optional Arguments 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) --dns-domain <dns-domain> Set dns domain for this floating ip --dns-name <dns-name> Set dns name for this floating ip --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 Table 36.3. Output Formatters 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 Table 36.4. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 36.5. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 36.6. Table Formatter 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. 36.2. floating ip delete Delete floating IP(s) Usage: Table 36.7. Positional Arguments Value Summary <floating-ip> Floating ip(s) to delete (ip address or id) Table 36.8. Optional Arguments Value Summary -h, --help Show this help message and exit 36.3. floating ip list List floating IP(s) Usage: Table 36.9. Optional Arguments 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 --floating-ip-address <ip-address> List floating ip(s) according to given floating 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) Table 36.10. Output Formatters 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 Table 36.11. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 36.12. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 36.13. Table Formatter 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. 36.4. floating ip pool list List pools of floating IP addresses Usage: Table 36.14. Optional Arguments Value Summary -h, --help Show this help message and exit Table 36.15. Output Formatters 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 Table 36.16. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 36.17. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 36.18. Table Formatter 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. 36.5. floating ip port forwarding create Create floating IP port forwarding Usage: Table 36.19. Positional Arguments Value Summary <floating-ip> Floating ip that the port forwarding belongs to (ip address or ID) Table 36.20. Optional Arguments Value Summary -h, --help Show this help message and exit --internal-ip-address <internal-ip-address> The fixed ipv4 address of the network port associated to the floating IP port forwarding --port <port> The name or id of the network port associated to the floating IP port forwarding --internal-protocol-port <port-number> The protocol port number of the network port fixed IPv4 address associated to the floating IP port forwarding --external-protocol-port <port-number> The protocol port number of the port forwarding's floating IP address --protocol <protocol> The protocol used in the floating ip port forwarding, for instance: TCP, UDP Table 36.21. Output Formatters 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 Table 36.22. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 36.23. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 36.24. Table Formatter 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. 36.6. floating ip port forwarding delete Delete floating IP port forwarding Usage: Table 36.25. Positional Arguments Value Summary <floating-ip> Floating ip that the port forwarding belongs to (ip address or ID) <port-forwarding-id> The id of the floating ip port forwarding(s) to delete Table 36.26. Optional Arguments Value Summary -h, --help Show this help message and exit 36.7. floating ip port forwarding list List floating IP port forwarding Usage: Table 36.27. Positional Arguments Value Summary <floating-ip> Floating ip that the port forwarding belongs to (ip address or ID) Table 36.28. Optional Arguments Value Summary -h, --help Show this help message and exit --port <port> Filter the list result by the id or name of the internal network port --external-protocol-port <port-number> Filter the list result by the protocol port number of the floating IP --protocol protocol Filter the list result by the port protocol Table 36.29. Output Formatters 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 Table 36.30. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 36.31. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 36.32. Table Formatter 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. 36.8. floating ip port forwarding set Set floating IP Port Forwarding Properties Usage: Table 36.33. Positional Arguments Value Summary <floating-ip> Floating ip that the port forwarding belongs to (ip address or ID) <port-forwarding-id> The id of the floating ip port forwarding Table 36.34. Optional Arguments Value Summary -h, --help Show this help message and exit --port <port> The id of the network port associated to the floating IP port forwarding --internal-ip-address <internal-ip-address> The fixed ipv4 address of the network port associated to the floating IP port forwarding --internal-protocol-port <port-number> The tcp/udp/other protocol port number of the network port fixed IPv4 address associated to the floating IP port forwarding --external-protocol-port <port-number> The tcp/udp/other protocol port number of the port forwarding's floating IP address --protocol <protocol> The ip protocol used in the floating ip port forwarding 36.9. floating ip port forwarding show Display floating IP Port Forwarding details Usage: Table 36.35. Positional Arguments Value Summary <floating-ip> Floating ip that the port forwarding belongs to (ip address or ID) <port-forwarding-id> The id of the floating ip port forwarding Table 36.36. Optional Arguments Value Summary -h, --help Show this help message and exit Table 36.37. Output Formatters 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 Table 36.38. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 36.39. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 36.40. Table Formatter 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. 36.10. floating ip set Set floating IP Properties Usage: Table 36.41. Positional Arguments Value Summary <floating-ip> Floating ip to modify (ip address or id) Table 36.42. Optional Arguments 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 36.11. floating ip show Display floating IP details Usage: Table 36.43. Positional Arguments Value Summary <floating-ip> Floating ip to display (ip address or id) Table 36.44. Optional Arguments Value Summary -h, --help Show this help message and exit Table 36.45. Output Formatters 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 Table 36.46. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 36.47. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 36.48. Table Formatter 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. 36.12. floating ip unset Unset floating IP Properties Usage: Table 36.49. Positional Arguments Value Summary <floating-ip> Floating ip to disassociate (ip address or id) Table 36.50. Optional Arguments 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
openstack floating ip create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--subnet <subnet>] [--port <port>] [--floating-ip-address <ip-address>] [--fixed-ip-address <ip-address>] [--qos-policy <qos-policy>] [--description <description>] [--project <project>] [--dns-domain <dns-domain>] [--dns-name <dns-name>] [--project-domain <project-domain>] [--tag <tag> | --no-tag] <network> openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...] openstack floating 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] [--network <network>] [--port <port>] [--fixed-ip-address <ip-address>] [--floating-ip-address <ip-address>] [--long] [--status <status>] [--project <project>] [--project-domain <project-domain>] [--router <router>] [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]] openstack floating ip pool 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] openstack floating ip port forwarding create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --internal-ip-address <internal-ip-address> --port <port> --internal-protocol-port <port-number> --external-protocol-port <port-number> --protocol <protocol> <floating-ip> openstack floating ip port forwarding delete [-h] <floating-ip> <port-forwarding-id> [<port-forwarding-id> ...] openstack floating ip port forwarding 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] [--port <port>] [--external-protocol-port <port-number>] [--protocol protocol] <floating-ip> openstack floating ip port forwarding set [-h] [--port <port>] [--internal-ip-address <internal-ip-address>] [--internal-protocol-port <port-number>] [--external-protocol-port <port-number>] [--protocol <protocol>] <floating-ip> <port-forwarding-id> openstack floating ip port forwarding show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <floating-ip> <port-forwarding-id> openstack floating ip set [-h] [--port <port>] [--fixed-ip-address <ip-address>] [--qos-policy <qos-policy> | --no-qos-policy] [--tag <tag>] [--no-tag] <floating-ip> openstack floating ip show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <floating-ip> openstack floating ip unset [-h] [--port] [--qos-policy] [--tag <tag> | --all-tag] <floating-ip>