Red Hat SummitChapter 49. loadbalancer
This chapter describes the commands under the loadbalancer command.
49.1. loadbalancer amphora configure
Update the amphora agent configuration
Usage:
openstack loadbalancer amphora configure [-h] [--wait] <amphora-id>
openstack loadbalancer amphora configure [-h] [--wait] <amphora-id>| Value | Summary |
|---|---|
| <amphora-id> | Uuid of the amphora to configure. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --wait | Wait for action to complete |
49.2. loadbalancer amphora delete
Delete a amphora
Usage:
openstack loadbalancer amphora delete [-h] [--wait] <amphora-id>
openstack loadbalancer amphora delete [-h] [--wait] <amphora-id>| Value | Summary |
|---|---|
| <amphora-id> | Uuid of the amphora to delete. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --wait | Wait for action to complete |
49.3. loadbalancer amphora failover
Force failover an amphora
Usage:
openstack loadbalancer amphora failover [-h] [--wait] <amphora-id>
openstack loadbalancer amphora failover [-h] [--wait] <amphora-id>| Value | Summary |
|---|---|
| <amphora-id> | Uuid of the amphora. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --wait | Wait for action to complete |
49.4. loadbalancer amphora list
List amphorae
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --loadbalancer <loadbalancer> | Filter by load balancer (name or id). |
| --compute-id <compute-id> | Filter by compute id. |
| --role {BACKUP,MASTER,STANDALONE} | Filter by role. |
| --status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}, --provisioning-status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY} | Filter by amphora provisioning status. |
| --long | Show additional fields. |
| 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.5. loadbalancer amphora show
Show the details of a single amphora
Usage:
| Value | Summary |
|---|---|
| <amphora-id> | Uuid of the amphora. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.6. loadbalancer amphora stats show
Shows the current statistics for an amphora.
Usage:
| Value | Summary |
|---|---|
| <amphora-id> | Uuid of the amphora |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --listener <listener> | Filter by listener (name or id) |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.7. loadbalancer availabilityzone create
Create an octavia availability zone
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | New availability zone name. |
| --availabilityzoneprofile <availabilityzone_profile> | Availability zone profile to add the az to (name or ID). |
| --description <description> | Set the availability zone description. |
| --enable | Enable the availability zone. |
| --disable | Disable the availability zone. |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.8. loadbalancer availabilityzone delete
Delete an availability zone
Usage:
openstack loadbalancer availabilityzone delete [-h] <availabilityzone>
openstack loadbalancer availabilityzone delete [-h] <availabilityzone>| Value | Summary |
|---|---|
| <availabilityzone> | Name of the availability zone to delete. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
49.9. loadbalancer availabilityzone list
List availability zones
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | List availability zones according to their name. |
| --availabilityzoneprofile <availabilityzone_profile> | List availability zones according to their az profile. |
| --enable | List enabled availability zones. |
| --disable | List disabled availability zones. |
| 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.10. loadbalancer availabilityzone set
Update an availability zone
Usage:
openstack loadbalancer availabilityzone set [-h]
[--description <description>]
[--enable | --disable]
<availabilityzone>
openstack loadbalancer availabilityzone set [-h]
[--description <description>]
[--enable | --disable]
<availabilityzone>| Value | Summary |
|---|---|
| <availabilityzone> | Name of the availability zone to update. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --description <description> | Set the description of the availability zone. |
| --enable | Enable the availability zone. |
| --disable | Disable the availability zone. |
49.11. loadbalancer availabilityzone show
Show the details for a single availability zone
Usage:
| Value | Summary |
|---|---|
| <availabilityzone> | Name of the availability zone. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.12. loadbalancer availabilityzone unset
Clear availability zone settings
Usage:
openstack loadbalancer availabilityzone unset [-h] [--description]
<availabilityzone>
openstack loadbalancer availabilityzone unset [-h] [--description]
<availabilityzone>| Value | Summary |
|---|---|
| <availabilityzone> | Name of the availability zone to update. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --description | Clear the availability zone description. |
49.13. loadbalancer availabilityzoneprofile create
Create an octavia availability zone profile
Usage:
openstack loadbalancer availabilityzoneprofile create
[-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent]
[--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
--name <name> --provider <provider name> --availability-zone-data
<availability_zone_data>
openstack loadbalancer availabilityzoneprofile create
[-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent]
[--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
--name <name> --provider <provider name> --availability-zone-data
<availability_zone_data>| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | New octavia availability zone profile name. |
| --provider <provider name> | Provider name for the availability zone profile. |
| --availability-zone-data <availability_zone_data> | The json string containing the availability zone metadata. |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.14. loadbalancer availabilityzoneprofile delete
Delete an availability zone profile
Usage:
openstack loadbalancer availabilityzoneprofile delete
[-h] <availabilityzone_profile>
openstack loadbalancer availabilityzoneprofile delete
[-h] <availabilityzone_profile>| Value | Summary |
|---|---|
| <availabilityzone_profile> | Availability zone profile to delete (name or id) |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
49.15. loadbalancer availabilityzoneprofile list
List availability zone profiles
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | List availabilityzone profiles by profile name. |
| --provider <provider_name> | List availability zone profiles according to their provider. |
| 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.16. loadbalancer availabilityzoneprofile set
Update an availability zone profile
Usage:
openstack loadbalancer availabilityzoneprofile set [-h] [--name <name>]
[--provider <provider_name>]
[--availabilityzone-data <availabilityzone_data>]
<availabilityzone_profile>
openstack loadbalancer availabilityzoneprofile set [-h] [--name <name>]
[--provider <provider_name>]
[--availabilityzone-data <availabilityzone_data>]
<availabilityzone_profile>| Value | Summary |
|---|---|
| <availabilityzone_profile> | Name or uuid of the availability zone profile to update. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set the name of the availability zone profile. |
| --provider <provider_name> | Set the provider of the availability zone profile. |
| --availabilityzone-data <availabilityzone_data> | Set the availability zone data of the profile. |
49.17. loadbalancer availabilityzoneprofile show
Show the details of a single availability zone profile
Usage:
| Value | Summary |
|---|---|
| <availabilityzone_profile> | Name or uuid of the availability zone profile to show. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.18. loadbalancer create
Create a load balancer
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | New load balancer name. |
| --description <description> | Set load balancer description. |
| --vip-address <vip_address> | Set the vip ip address. |
| --vip-qos-policy-id <vip_qos_policy_id> | Set qos policy id for vip port. unset with none. |
| --project <project> | Project for the load balancer (name or id). |
| --provider <provider> | Provider name for the load balancer. |
| --availability-zone <availability_zone> | Availability zone for the load balancer. |
| --enable | Enable load balancer (default). |
| --disable | Disable load balancer. |
| --flavor <flavor> | The name or id of the flavor for the load balancer. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be added to the load balancer (repeat option to set multiple tags) |
| --no-tag | No tags associated with the load balancer |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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 |
|---|---|
| At least one of the following arguments is required.--vip-port-id <vip_port_id> | Set port for the load balancer (name or id). |
| --vip-subnet-id <vip_subnet_id> | Set subnet for the load balancer (name or id). |
| --vip-network-id <vip_network_id> | Set network for the load balancer (name or id). |
49.19. loadbalancer delete
Delete a load balancer
Usage:
openstack loadbalancer delete [-h] [--cascade] [--wait] <load_balancer>
openstack loadbalancer delete [-h] [--cascade] [--wait] <load_balancer>| Value | Summary |
|---|---|
| <load_balancer> | Load balancers to delete (name or id) |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --cascade | Cascade the delete to all child elements of the load balancer. |
| --wait | Wait for action to complete |
49.20. loadbalancer failover
Trigger load balancer failover
Usage:
openstack loadbalancer failover [-h] [--wait] <load_balancer>
openstack loadbalancer failover [-h] [--wait] <load_balancer>| Value | Summary |
|---|---|
| <load_balancer> | Name or uuid of the load balancer. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --wait | Wait for action to complete |
49.21. loadbalancer flavor create
Create a octavia flavor
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | New flavor name. |
| --flavorprofile <flavor_profile> | Flavor profile to add the flavor to (name or id). |
| --description <description> | Set flavor description. |
| --enable | Enable flavor. |
| --disable | Disable flavor. |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.22. loadbalancer flavor delete
Delete a flavor
Usage:
openstack loadbalancer flavor delete [-h] <flavor>
openstack loadbalancer flavor delete [-h] <flavor>| Value | Summary |
|---|---|
| <flavor> | Flavor to delete (name or id) |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
49.23. loadbalancer flavor list
List flavor
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | List flavors according to their name. |
| --flavorprofile <flavor_profile> | List flavors according to their flavor profile. |
| --enable | List enabled flavors. |
| --disable | List disabled flavors. |
| 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.24. loadbalancer flavor set
Update a flavor
Usage:
openstack loadbalancer flavor set [-h] [--name <name>]
[--enable | --disable]
<flavor>
openstack loadbalancer flavor set [-h] [--name <name>]
[--enable | --disable]
<flavor>| Value | Summary |
|---|---|
| <flavor> | Name or uuid of the flavor to update. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set the name of the flavor. |
| --enable | Enable flavor. |
| --disable | Disable flavor. |
49.25. loadbalancer flavor show
Show the details for a single flavor
Usage:
| Value | Summary |
|---|---|
| <flavor> | Name or uuid of the flavor. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.26. loadbalancer flavor unset
Clear flavor settings
Usage:
openstack loadbalancer flavor unset [-h] [--description] <flavor>
openstack loadbalancer flavor unset [-h] [--description] <flavor>| Value | Summary |
|---|---|
| <flavor> | Flavor to update (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --description | Clear the flavor description. |
49.27. loadbalancer flavorprofile create
Create a octavia flavor profile
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | New octavia flavor profile name. |
| --provider <provider name> | Provider name for the flavor profile. |
| --flavor-data <flavor_data> | The json string containing the flavor metadata. |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.28. loadbalancer flavorprofile delete
Delete a flavor profile
Usage:
openstack loadbalancer flavorprofile delete [-h] <flavor_profile>
openstack loadbalancer flavorprofile delete [-h] <flavor_profile>| Value | Summary |
|---|---|
| <flavor_profile> | Flavor profiles to delete (name or id) |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
49.29. loadbalancer flavorprofile list
List flavor profile
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | List flavor profiles by flavor profile name. |
| --provider <provider_name> | List flavor profiles according to their provider. |
| 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.30. loadbalancer flavorprofile set
Update a flavor profile
Usage:
openstack loadbalancer flavorprofile set [-h] [--name <name>]
[--provider <provider_name>]
[--flavor-data <flavor_data>]
<flavor_profile>
openstack loadbalancer flavorprofile set [-h] [--name <name>]
[--provider <provider_name>]
[--flavor-data <flavor_data>]
<flavor_profile>| Value | Summary |
|---|---|
| <flavor_profile> | Name or uuid of the flavor profile to update. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set the name of the flavor profile. |
| --provider <provider_name> | Set the provider of the flavor profile. |
| --flavor-data <flavor_data> | Set the flavor data of the flavor profile. |
49.31. loadbalancer flavorprofile show
Show the details for a single flavor profile
Usage:
| Value | Summary |
|---|---|
| <flavor_profile> | Name or uuid of the flavor profile to show. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.32. loadbalancer healthmonitor create
Create a health monitor
Usage:
| Value | Summary |
|---|---|
| <pool> | Set the pool for the health monitor (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set the health monitor name. |
| --delay <delay> | Set the time in seconds, between sending probes to members. |
| --domain-name <domain_name> | Set the domain name, which be injected into the http Host Header to the backend server for HTTP health check. |
| --expected-codes <codes> | Set the list of http status codes expected in response from the member to declare it healthy. |
| --http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE} | Set the http method that the health monitor uses for requests. |
| --http-version <http_version> | Set the http version. |
| --timeout <timeout> | Set the maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value. |
| --max-retries <max_retries> | The number of successful checks before changing the operating status of the member to ONLINE. |
| --url-path <url_path> | Set the http url path of the request sent by the monitor to test the health of a backend member. |
| --type {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT,SCTP} | Set the health monitor type. |
| --max-retries-down <max_retries_down> | Set the number of allowed check failures before changing the operating status of the member to ERROR. |
| --enable | Enable health monitor (default). |
| --disable | Disable health monitor. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be added to the health monitor (repeat option to set multiple tags) |
| --no-tag | No tags associated with the health monitor |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.33. loadbalancer healthmonitor delete
Delete a health monitor
Usage:
openstack loadbalancer healthmonitor delete [-h] [--wait]
<health_monitor>
openstack loadbalancer healthmonitor delete [-h] [--wait]
<health_monitor>| Value | Summary |
|---|---|
| <health_monitor> | Health monitor to delete (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --wait | Wait for action to complete |
49.34. loadbalancer healthmonitor list
List health monitors
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --tags <tag>[,<tag>,…] | List health monitor which have all given tag(s) (Comma-separated list of tags) |
| --any-tags <tag>[,<tag>,…] | List health monitor which have any given tag(s) (Comma-separated list of tags) |
| --not-tags <tag>[,<tag>,…] | Exclude health monitor which have all given tag(s) (Comma-separated list of tags) |
| --not-any-tags <tag>[,<tag>,…] | Exclude health monitor 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 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.35. loadbalancer healthmonitor set
Update a health monitor
Usage:
| Value | Summary |
|---|---|
| <health_monitor> | Health monitor to update (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set health monitor name. |
| --delay <delay> | Set the time in seconds, between sending probes to members. |
| --domain-name <domain_name> | Set the domain name, which be injected into the http Host Header to the backend server for HTTP health check. |
| --expected-codes <codes> | Set the list of http status codes expected in response from the member to declare it healthy. |
| --http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE} | Set the http method that the health monitor uses for requests. |
| --http-version <http_version> | Set the http version. |
| --timeout <timeout> | Set the maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value. |
| --max-retries <max_retries> | Set the number of successful checks before changing the operating status of the member to ONLINE. |
| --max-retries-down <max_retries_down> | Set the number of allowed check failures before changing the operating status of the member to ERROR. |
| --url-path <url_path> | Set the http url path of the request sent by the monitor to test the health of a backend member. |
| --enable | Enable health monitor. |
| --disable | Disable health monitor. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be added to the health monitor (repeat option to set multiple tags) |
| --no-tag | Clear tags associated with the health monitor. specify both --tag and --no-tag to overwrite current tags |
49.36. loadbalancer healthmonitor show
Show the details of a single health monitor
Usage:
| Value | Summary |
|---|---|
| <health_monitor> | Name or uuid of the health monitor. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.37. loadbalancer healthmonitor unset
Clear health monitor settings
Usage:
| Value | Summary |
|---|---|
| <health_monitor> | Health monitor to update (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --domain-name | Clear the health monitor domain name. |
| --expected-codes | Reset the health monitor expected codes to the api default. |
| --http-method | Reset the health monitor http method to the api default. |
| --http-version | Reset the health monitor http version to the api default. |
| --max-retries-down | Reset the health monitor max retries down to the api default. |
| --name | Clear the health monitor name. |
| --url-path | Clear the health monitor url path. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be removed from the health monitor (repeat option to remove multiple tags) |
| --all-tag | Clear all tags associated with the health monitor |
49.38. loadbalancer l7policy create
Create a l7policy
Usage:
| Value | Summary |
|---|---|
| <listener> | Listener to add l7policy to (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set the l7policy name. |
| --description <description> | Set l7policy description. |
| --action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT} | Set the action of the policy. |
| --redirect-pool <pool> | Set the pool to redirect requests to (name or id). |
| --redirect-url <url> | Set the url to redirect requests to. |
| --redirect-prefix <url> | Set the url prefix to redirect requests to. |
| --redirect-http-code <redirect_http_code> | Set the http response code for redirect_url orREDIRECT_PREFIX action. |
| --position <position> | Sequence number of this l7 policy. |
| --enable | Enable l7policy (default). |
| --disable | Disable l7policy. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be added to the l7policy (repeat option to set multiple tags) |
| --no-tag | No tags associated with the l7policy |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.39. loadbalancer l7policy delete
Delete a l7policy
Usage:
openstack loadbalancer l7policy delete [-h] [--wait] <policy>
openstack loadbalancer l7policy delete [-h] [--wait] <policy>| Value | Summary |
|---|---|
| <policy> | L7policy to delete (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --wait | Wait for action to complete |
49.40. loadbalancer l7policy list
List l7policies
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --listener LISTENER | List l7policies that applied to the given listener (name or ID). |
| --tags <tag>[,<tag>,…] | List l7policy which have all given tag(s) (comma- separated list of tags) |
| --any-tags <tag>[,<tag>,…] | List l7policy which have any given tag(s) (comma- separated list of tags) |
| --not-tags <tag>[,<tag>,…] | Exclude l7policy which have all given tag(s) (comma- separated list of tags) |
| --not-any-tags <tag>[,<tag>,…] | Exclude l7policy 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 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.41. loadbalancer l7policy set
Update a l7policy
Usage:
| Value | Summary |
|---|---|
| <policy> | L7policy to update (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set l7policy name. |
| --description <description> | Set l7policy description. |
| --action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT} | Set the action of the policy. |
| --redirect-pool <pool> | Set the pool to redirect requests to (name or id). |
| --redirect-url <url> | Set the url to redirect requests to. |
| --redirect-prefix <url> | Set the url prefix to redirect requests to. |
| --redirect-http-code <redirect_http_code> | Set the http response code for redirect_url orREDIRECT_PREFIX action. |
| --position <position> | Set sequence number of this l7 policy. |
| --enable | Enable l7policy. |
| --disable | Disable l7policy. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be added to the l7policy (repeat option to set multiple tags) |
| --no-tag | Clear tags associated with the l7policy. specify both --tag and --no-tag to overwrite current tags |
49.42. loadbalancer l7policy show
Show the details of a single l7policy
Usage:
| Value | Summary |
|---|---|
| <policy> | Name or uuid of the l7policy. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.43. loadbalancer l7policy unset
Clear l7policy settings
Usage:
openstack loadbalancer l7policy unset [-h] [--description] [--name]
[--redirect-http-code] [--wait]
[--tag <tag> | --all-tag]
<policy>
openstack loadbalancer l7policy unset [-h] [--description] [--name]
[--redirect-http-code] [--wait]
[--tag <tag> | --all-tag]
<policy>| Value | Summary |
|---|---|
| <policy> | L7policy to update (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --description | Clear the l7policy description. |
| --name | Clear the l7policy name. |
| --redirect-http-code | Clear the l7policy redirect http code. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be removed from the l7policy (repeat option to remove multiple tags) |
| --all-tag | Clear all tags associated with the l7policy |
49.44. loadbalancer l7rule create
Create a l7rule
Usage:
| Value | Summary |
|---|---|
| <l7policy> | L7policy to add l7rule to (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH} | Set the compare type for the l7rule. |
| --invert | Invert l7rule. |
| --value <value> | Set the rule value to match on. |
| --key <key> | Set the key for the l7rule’s value to match on. |
| --type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD} | Set the type for the l7rule. |
| --enable | Enable l7rule (default). |
| --disable | Disable l7rule. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be added to the l7rule (repeat option to set multiple tags) |
| --no-tag | No tags associated with the l7rule |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.45. loadbalancer l7rule delete
Delete a l7rule
Usage:
openstack loadbalancer l7rule delete [-h] [--wait] <l7policy> <rule_id>
openstack loadbalancer l7rule delete [-h] [--wait] <l7policy> <rule_id>| Value | Summary |
|---|---|
| <l7policy> | L7policy to delete rule from (name or id). |
| <rule_id> | L7rule to delete. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --wait | Wait for action to complete |
49.46. loadbalancer l7rule list
List l7rules for l7policy
Usage:
| Value | Summary |
|---|---|
| <l7policy> | L7policy to list rules for (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --tags <tag>[,<tag>,…] | List l7rule which have all given tag(s) (comma- separated list of tags) |
| --any-tags <tag>[,<tag>,…] | List l7rule which have any given tag(s) (comma- separated list of tags) |
| --not-tags <tag>[,<tag>,…] | Exclude l7rule which have all given tag(s) (comma- separated list of tags) |
| --not-any-tags <tag>[,<tag>,…] | Exclude l7rule 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 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.47. loadbalancer l7rule set
Update a l7rule
Usage:
| Value | Summary |
|---|---|
| <l7policy> | L7policy to update l7rule on (name or id). |
| <l7rule_id> | L7rule to update. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH} | Set the compare type for the l7rule. |
| --invert | Invert l7rule. |
| --value <value> | Set the rule value to match on. |
| --key <key> | Set the key for the l7rule’s value to match on. |
| --type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD} | Set the type for the l7rule. |
| --enable | Enable l7rule. |
| --disable | Disable l7rule. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be added to the l7rule (repeat option to set multiple tags) |
| --no-tag | Clear tags associated with the l7rule. specify both --tag and --no-tag to overwrite current tags |
49.48. loadbalancer l7rule show
Show the details of a single l7rule
Usage:
| Value | Summary |
|---|---|
| <l7policy> | L7policy to show rule from (name or id). |
| <l7rule_id> | L7rule to show. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.49. loadbalancer l7rule unset
Clear l7rule settings
Usage:
openstack loadbalancer l7rule unset [-h] [--invert] [--key] [--wait]
[--tag <tag> | --all-tag]
<l7policy> <l7rule_id>
openstack loadbalancer l7rule unset [-h] [--invert] [--key] [--wait]
[--tag <tag> | --all-tag]
<l7policy> <l7rule_id>| Value | Summary |
|---|---|
| <l7policy> | L7policy to update (name or id). |
| <l7rule_id> | L7rule to update. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --invert | Reset the l7rule invert to the api default. |
| --key | Clear the l7rule key. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be removed from the l7rule (repeat option to remove multiple tags) |
| --all-tag | Clear all tags associated with the l7rule |
49.50. loadbalancer list
List load balancers
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | List load balancers according to their name. |
| --enable | List enabled load balancers. |
| --disable | List disabled load balancers. |
| --project <project-id> | List load balancers according to their project (name or ID). |
| --vip-network-id <vip_network_id> | List load balancers according to their vip network (name or ID). |
| --vip-subnet-id <vip_subnet_id> | List load balancers according to their vip subnet (name or ID). |
| --vip-qos-policy-id <vip_qos_policy_id> | List load balancers according to their vip qos policy (name or ID). |
| --vip-port-id <vip_port_id> | List load balancers according to their vip port (name or ID). |
| --provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE} | List load balancers according to their provisioning status. |
| --operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR} | List load balancers according to their operating status. |
| --provider <provider> | List load balancers according to their provider. |
| --flavor <flavor> | List load balancers according to their flavor. |
| --availability-zone <availability_zone> | List load balancers according to their availability zone. |
| --tags <tag>[,<tag>,…] | List load balancer which have all given tag(s) (comma- separated list of tags) |
| --any-tags <tag>[,<tag>,…] | List load balancer which have any given tag(s) (comma- separated list of tags) |
| --not-tags <tag>[,<tag>,…] | Exclude load balancer which have all given tag(s) (Comma-separated list of tags) |
| --not-any-tags <tag>[,<tag>,…] | Exclude load balancer 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 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.51. loadbalancer listener create
Create a listener
Usage:
| Value | Summary |
|---|---|
| <loadbalancer> | Load balancer for the listener (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set the listener name. |
| --description <description> | Set the description of this listener. |
| --protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP,SCTP} | The protocol for the listener. |
| --connection-limit <limit> | Set the maximum number of connections permitted for this listener. |
| --default-pool <pool> | Set the name or id of the pool used by the listener if no L7 policies match. |
| --default-tls-container-ref <container_ref> | The uri to the key manager service secrets container containing the certificate and key for TERMINATED_TLS listeners. |
| --sni-container-refs [<container_ref> …] | A list of uris to the key manager service secrets containers containing the certificates and keys for TERMINATED_TLS the listener using Server Name Indication. |
| --insert-headers <header=value,…> | A dictionary of optional headers to insert into the request before it is sent to the backend member. |
| --protocol-port <port> | Set the protocol port number for the listener. |
| --timeout-client-data <timeout> | Frontend client inactivity timeout in milliseconds. Default: 50000. |
| --timeout-member-connect <timeout> | Backend member connection timeout in milliseconds. Default: 5000. |
| --timeout-member-data <timeout> | Backend member inactivity timeout in milliseconds. Default: 50000. |
| --timeout-tcp-inspect <timeout> | Time, in milliseconds, to wait for additional tcp packets for content inspection. Default: 0. |
| --enable | Enable listener (default). |
| --disable | Disable listener. |
| --client-ca-tls-container-ref <container_ref> | The uri to the key manager service secrets container containing the CA certificate for TERMINATED_TLS listeners. |
| --client-authentication {NONE,OPTIONAL,MANDATORY} | The tls client authentication verify options for TERMINATED_TLS listeners. |
| --client-crl-container-ref <client_crl_container_ref> | The uri to the key manager service secrets container containting the CA revocation list file for TERMINATED_TLS listeners. |
| --allowed-cidr [<allowed_cidr>] | Cidr to allow access to the listener (can be set multiple times). |
| --wait | Wait for action to complete |
| --tls-ciphers <tls_ciphers> | Set the tls ciphers to be used by the listener in OpenSSL format. |
| --tls-version [<tls_versions>] | Set the tls protocol version to be used by the listener (can be set multiple times). |
| --alpn-protocol [<alpn_protocols>] | Set the alpn protocol to be used by the listener (can be set multiple times). |
| --tag <tag> | Tag to be added to the listener (repeat option to set multiple tags) |
| --no-tag | No tags associated with the listener |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.52. loadbalancer listener delete
Delete a listener
Usage:
openstack loadbalancer listener delete [-h] [--wait] <listener>
openstack loadbalancer listener delete [-h] [--wait] <listener>| Value | Summary |
|---|---|
| <listener> | Listener to delete (name or id) |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --wait | Wait for action to complete |
49.53. loadbalancer listener list
List listeners
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | List listeners by listener name. |
| --loadbalancer <loadbalancer> | Filter by load balancer (name or id). |
| --enable | List enabled listeners. |
| --disable | List disabled listeners. |
| --project <project> | List listeners by project id. |
| --tags <tag>[,<tag>,…] | List listener which have all given tag(s) (comma- separated list of tags) |
| --any-tags <tag>[,<tag>,…] | List listener which have any given tag(s) (comma- separated list of tags) |
| --not-tags <tag>[,<tag>,…] | Exclude listener which have all given tag(s) (comma- separated list of tags) |
| --not-any-tags <tag>[,<tag>,…] | Exclude listener 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 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.54. loadbalancer listener set
Update a listener
Usage:
| Value | Summary |
|---|---|
| <listener> | Listener to modify (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set the listener name. |
| --description <description> | Set the description of this listener. |
| --connection-limit <limit> | The maximum number of connections permitted for this listener. Default value is -1 which represents infinite connections. |
| --default-pool <pool> | The id of the pool used by the listener if no l7 policies match. |
| --default-tls-container-ref <container-ref> | The uri to the key manager service secrets container containing the certificate and key for TERMINATED_TLSlisteners. |
| --sni-container-refs [<container-ref> …] | A list of uris to the key manager service secrets containers containing the certificates and keys for TERMINATED_TLS the listener using Server Name Indication. |
| --insert-headers <header=value> | A dictionary of optional headers to insert into the request before it is sent to the backend member. |
| --timeout-client-data <timeout> | Frontend client inactivity timeout in milliseconds. Default: 50000. |
| --timeout-member-connect <timeout> | Backend member connection timeout in milliseconds. Default: 5000. |
| --timeout-member-data <timeout> | Backend member inactivity timeout in milliseconds. Default: 50000. |
| --timeout-tcp-inspect <timeout> | Time, in milliseconds, to wait for additional tcp packets for content inspection. Default: 0. |
| --enable | Enable listener. |
| --disable | Disable listener. |
| --client-ca-tls-container-ref <container_ref> | The uri to the key manager service secrets container containing the CA certificate for TERMINATED_TLS listeners. |
| --client-authentication {NONE,OPTIONAL,MANDATORY} | The tls client authentication verify options for TERMINATED_TLS listeners. |
| --client-crl-container-ref <client_crl_container_ref> | The uri to the key manager service secrets container containting the CA revocation list file for TERMINATED_TLS listeners. |
| --allowed-cidr [<allowed_cidr>] | Cidr to allow access to the listener (can be set multiple times). |
| --wait | Wait for action to complete |
| --tls-ciphers <tls_ciphers> | Set the tls ciphers to be used by the listener in OpenSSL format. |
| --tls-version [<tls_versions>] | Set the tls protocol version to be used by the listener (can be set multiple times). |
| --alpn-protocol [<alpn_protocols>] | Set the alpn protocol to be used by the listener (can be set multiple times). |
| --tag <tag> | Tag to be added to the listener (repeat option to set multiple tags) |
| --no-tag | Clear tags associated with the listener. specify both --tag and --no-tag to overwrite current tags |
49.55. loadbalancer listener show
Show the details of a single listener
Usage:
| Value | Summary |
|---|---|
| <listener> | Name or uuid of the listener |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.56. loadbalancer listener stats show
Shows the current statistics for a listener.
Usage:
| Value | Summary |
|---|---|
| <listener> | Name or uuid of the listener |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.57. loadbalancer listener unset
Clear listener settings
Usage:
| Value | Summary |
|---|---|
| <listener> | Listener to modify (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name | Clear the listener name. |
| --description | Clear the description of this listener. |
| --connection-limit | Reset the connection limit to the api default. |
| --default-pool | Clear the default pool from the listener. |
| --default-tls-container-ref | Remove the default tls container reference from the listener. |
| --sni-container-refs | Remove the tls sni container references from the listener. |
| --insert-headers | Clear the insert headers from the listener. |
| --timeout-client-data | Reset the client data timeout to the api default. |
| --timeout-member-connect | Reset the member connect timeout to the api default. |
| --timeout-member-data | Reset the member data timeout to the api default. |
| --timeout-tcp-inspect | Reset the tcp inspection timeout to the api default. |
| --client-ca-tls-container-ref | Clear the client ca tls container reference from the listener. |
| --client-authentication | Reset the client authentication setting to the api default. |
| --client-crl-container-ref | Clear the client crl container reference from the listener. |
| --allowed-cidrs | Clear all allowed cidrs from the listener. |
| --tls-versions | Clear all tls versions from the listener. |
| --tls-ciphers | Clear all tls ciphers from the listener. |
| --wait | Wait for action to complete. |
| --alpn-protocols | Clear all alpn protocols from the listener. |
| --tag <tag> | Tag to be removed from the listener (repeat option to remove multiple tags) |
| --all-tag | Clear all tags associated with the listener |
49.58. loadbalancer member create
Creating a member in a pool
Usage:
| Value | Summary |
|---|---|
| <pool> | Id or name of the pool to create the member for. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Name of the member. |
| --disable-backup | Disable member backup (default) |
| --enable-backup | Enable member backup |
| --weight <weight> | The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. |
| --address <ip_address> | The ip address of the backend member server |
| --subnet-id <subnet_id> | The subnet id the member service is accessible from. |
| --protocol-port <protocol_port> | The protocol port number the backend member server is listening on. |
| --monitor-port <monitor_port> | An alternate protocol port used for health monitoring a backend member. |
| --monitor-address <monitor_address> | An alternate ip address used for health monitoring a backend member. |
| --enable | Enable member (default) |
| --disable | Disable member |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be added to the member (repeat option to set multiple tags) |
| --no-tag | No tags associated with the member |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.59. loadbalancer member delete
Delete a member from a pool
Usage:
openstack loadbalancer member delete [-h] [--wait] <pool> <member>
openstack loadbalancer member delete [-h] [--wait] <pool> <member>| Value | Summary |
|---|---|
| <pool> | Pool name or id to delete the member from. |
| <member> | Name or id of the member to be deleted. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --wait | Wait for action to complete |
49.60. loadbalancer member list
List members in a pool
Usage:
| Value | Summary |
|---|---|
| <pool> | Pool name or id to list the members of. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --tags <tag>[,<tag>,…] | List member which have all given tag(s) (comma- separated list of tags) |
| --any-tags <tag>[,<tag>,…] | List member which have any given tag(s) (comma- separated list of tags) |
| --not-tags <tag>[,<tag>,…] | Exclude member which have all given tag(s) (comma- separated list of tags) |
| --not-any-tags <tag>[,<tag>,…] | Exclude member 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 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.61. loadbalancer member set
Update a member
Usage:
| Value | Summary |
|---|---|
| <pool> | Pool that the member to update belongs to (name or ID). |
| <member> | Name or id of the member to update |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set the name of the member |
| --disable-backup | Disable member backup (default) |
| --enable-backup | Enable member backup |
| --weight <weight> | Set the weight of member in the pool |
| --monitor-port <monitor_port> | An alternate protocol port used for health monitoring a backend member |
| --monitor-address <monitor_address> | An alternate ip address used for health monitoring a backend member. |
| --enable | Set the admin_state_up to true |
| --disable | Set the admin_state_up to false |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be added to the member (repeat option to set multiple tags) |
| --no-tag | Clear tags associated with the member. specify both --tag and --no-tag to overwrite current tags |
49.62. loadbalancer member show
Shows details of a single Member
Usage:
| Value | Summary |
|---|---|
| <pool> | Pool name or id to show the members of. |
| <member> | Name or id of the member to show. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.63. loadbalancer member unset
Clear member settings
Usage:
openstack loadbalancer member unset [-h] [--backup] [--monitor-address]
[--monitor-port] [--name]
[--weight] [--wait]
[--tag <tag> | --all-tag]
<pool> <member>
openstack loadbalancer member unset [-h] [--backup] [--monitor-address]
[--monitor-port] [--name]
[--weight] [--wait]
[--tag <tag> | --all-tag]
<pool> <member>| Value | Summary |
|---|---|
| <pool> | Pool that the member to update belongs to (name or id). |
| <member> | Member to modify (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --backup | Clear the backup member flag. |
| --monitor-address | Clear the member monitor address. |
| --monitor-port | Clear the member monitor port. |
| --name | Clear the member name. |
| --weight | Reset the member weight to the api default. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be removed from the member (repeat option to remove multiple tags) |
| --all-tag | Clear all tags associated with the member |
49.64. loadbalancer pool create
Create a pool
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set pool name. |
| --description <description> | Set pool description. |
| --protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,PROXYV2,UDP,SCTP} | Set the pool protocol. |
| --listener <listener> | Listener to add the pool to (name or id). |
| --loadbalancer <load_balancer> | Load balncer to add the pool to (name or id) |
| --session-persistence <session persistence> | Set the session persistence for the listener (key=value). |
| --lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT} | Load balancing algorithm to use. |
| --enable | Enable pool (default). |
| --disable | Disable pool. |
| --tls-container-ref <container-ref> | The reference to the key manager service secrets container containing the certificate and key for ``tls_enabled`` pools to re-encrpt the traffic to backend member servers. |
| --ca-tls-container-ref <ca_tls_container_ref> | The reference to the key manager service secrets container containing the CA certificate for ``tls_enabled`` pools to check the backend member servers certificates |
| --crl-container-ref <crl_container_ref> | The reference to the key manager service secrets container containting the CA revocation list file for ``tls_enabled`` pools to validate the backend member servers certificates. |
| --enable-tls | Enable backend member re-encryption. |
| --disable-tls | Disable backend member re-encryption. |
| --wait | Wait for action to complete |
| --tls-ciphers <tls_ciphers> | Set the tls ciphers to be used by the pool in openssl cipher string format. |
| --tls-version [<tls_versions>] | Set the tls protocol version to be used by the pool (can be set multiple times). |
| --alpn-protocol [<alpn_protocols>] | Set the alpn protocol to be used by the pool (can be set multiple times). |
| --tag <tag> | Tag to be added to the pool (repeat option to set multiple tags) |
| --no-tag | No tags associated with the pool |
| 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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.65. loadbalancer pool delete
Delete a pool
Usage:
openstack loadbalancer pool delete [-h] [--wait] <pool>
openstack loadbalancer pool delete [-h] [--wait] <pool>| Value | Summary |
|---|---|
| <pool> | Pool to delete (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --wait | Wait for action to complete |
49.66. loadbalancer pool list
List pools
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --loadbalancer <loadbalancer> | Filter by load balancer (name or id). |
| --tags <tag>[,<tag>,…] | List pool which have all given tag(s) (comma-separated list of tags) |
| --any-tags <tag>[,<tag>,…] | List pool which have any given tag(s) (comma-separated list of tags) |
| --not-tags <tag>[,<tag>,…] | Exclude pool which have all given tag(s) (comma- separated list of tags) |
| --not-any-tags <tag>[,<tag>,…] | Exclude pool 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 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.67. loadbalancer pool set
Update a pool
Usage:
| Value | Summary |
|---|---|
| <pool> | Pool to update (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set the name of the pool. |
| --description <description> | Set the description of the pool. |
| --session-persistence <session_persistence> | Set the session persistence for the listener (key=value). |
| --lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT} | Set the load balancing algorithm to use. |
| --enable | Enable pool. |
| --disable | Disable pool. |
| --tls-container-ref <container-ref> | The uri to the key manager service secrets container containing the certificate and key for TERMINATED_TLS pools to re-encrpt the traffic from TERMINATED_TLS listener to backend servers. |
| --ca-tls-container-ref <ca_tls_container_ref> | The uri to the key manager service secrets container containing the CA certificate for TERMINATED_TLS listeners to check the backend servers certificates in ssl traffic. |
| --crl-container-ref <crl_container_ref> | The uri to the key manager service secrets container containting the CA revocation list file for TERMINATED_TLS listeners to valid the backend servers certificates in ssl traffic. |
| --enable-tls | Enable backend associated members re-encryption. |
| --disable-tls | Disable backend associated members re-encryption. |
| --wait | Wait for action to complete |
| --tls-ciphers <tls_ciphers> | Set the tls ciphers to be used by the pool in openssl cipher string format. |
| --tls-version [<tls_versions>] | Set the tls protocol version to be used by the pool (can be set multiple times). |
| --alpn-protocol [<alpn_protocols>] | Set the alpn protocol to be used by the pool (can be set multiple times). |
| --tag <tag> | Tag to be added to the pool (repeat option to set multiple tags) |
| --no-tag | Clear tags associated with the pool. specify both --tag and --no-tag to overwrite current tags |
49.68. loadbalancer pool show
Show the details of a single pool
Usage:
| Value | Summary |
|---|---|
| <pool> | Name or uuid of the pool. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.69. loadbalancer pool unset
Clear pool settings
Usage:
| Value | Summary |
|---|---|
| <pool> | Pool to modify (name or id). |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name | Clear the pool name. |
| --description | Clear the description of this pool. |
| --ca-tls-container-ref | Clear the certificate authority certificate reference on this pool. |
| --crl-container-ref | Clear the certificate revocation list reference on this pool. |
| --session-persistence | Disables session persistence on the pool. |
| --tls-container-ref | Clear the certificate reference for this pool. |
| --tls-versions | Clear all tls versions from the pool. |
| --tls-ciphers | Clear all tls ciphers from the pool. |
| --wait | Wait for action to complete |
| --alpn-protocols | Clear all alpn protocols from the pool. |
| --tag <tag> | Tag to be removed from the pool (repeat option to remove multiple tags) |
| --all-tag | Clear all tags associated with the pool |
49.70. loadbalancer provider capability list
List specified provider driver’s capabilities.
Usage:
| Value | Summary |
|---|---|
| <provider_name> | Name of the provider driver. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --flavor | Get capabilities for flavor only. |
| --availability-zone | Get capabilities for availability zone only. |
| 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.71. loadbalancer provider list
List all providers
Usage:
| 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 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.72. loadbalancer quota defaults show
Show quota defaults
Usage:
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.73. loadbalancer quota list
List quotas
Usage:
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --project <project-id> | Name or uuid of the project. |
| 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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| 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. |
49.74. loadbalancer quota reset
Resets quotas to default quotas
Usage:
openstack loadbalancer quota reset [-h] <project>
openstack loadbalancer quota reset [-h] <project>| Value | Summary |
|---|---|
| <project> | Project to reset quotas (name or id) |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
49.75. loadbalancer quota set
Update a quota
Usage:
| Value | Summary |
|---|---|
| <project> | Name or uuid of the project. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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 |
|---|---|
| At least one of the following arguments is required.--healthmonitor <health_monitor> | New value for the health monitor quota. value -1 means unlimited. |
| --listener <listener> | New value for the listener quota. value -1 means unlimited. |
| --loadbalancer <load_balancer> | New value for the load balancer quota limit. value -1 means unlimited. |
| --member <member> | New value for the member quota limit. value -1 means unlimited. |
| --pool <pool> | New value for the pool quota limit. value -1 means unlimited. |
| --l7policy <l7policy> | New value for the l7policy quota limit. value -1 means unlimited. |
| --l7rule <l7rule> | New value for the l7rule quota limit. value -1 means unlimited. |
49.76. loadbalancer quota show
Show the quota details for a project
Usage:
| Value | Summary |
|---|---|
| <project> | Name or uuid of the project. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.77. loadbalancer quota unset
Clear quota settings
Usage:
openstack loadbalancer quota unset [-h] [--loadbalancer] [--listener]
[--pool] [--member]
[--healthmonitor] [--l7policy]
[--l7rule]
<project>
openstack loadbalancer quota unset [-h] [--loadbalancer] [--listener]
[--pool] [--member]
[--healthmonitor] [--l7policy]
[--l7rule]
<project>| Value | Summary |
|---|---|
| <project> | Name or uuid of the project. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --loadbalancer | Reset the load balancer quota to the default. |
| --listener | Reset the listener quota to the default. |
| --pool | Reset the pool quota to the default. |
| --member | Reset the member quota to the default. |
| --healthmonitor | Reset the health monitor quota to the default. |
| --l7policy | Reset the l7policy quota to the default. |
| --l7rule | Reset the l7rule quota to the default. |
49.78. loadbalancer set
Update a load balancer
Usage:
| Value | Summary |
|---|---|
| <load_balancer> | Name or uuid of the load balancer to update. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | Set load balancer name. |
| --description <description> | Set load balancer description. |
| --vip-qos-policy-id <vip_qos_policy_id> | Set qos policy id for vip port. unset with none. |
| --enable | Enable load balancer. |
| --disable | Disable load balancer. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be added to the load balancer (repeat option to set multiple tags) |
| --no-tag | Clear tags associated with the load balancer. specify both --tag and --no-tag to overwrite current tags |
49.79. loadbalancer show
Show the details for a single load balancer
Usage:
openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<load_balancer>
openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<load_balancer>| Value | Summary |
|---|---|
| <load_balancer> | Name or uuid of the load balancer. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.80. loadbalancer stats show
Shows the current statistics for a load balancer
Usage:
| Value | Summary |
|---|---|
| <load_balancer> | Name or uuid of the load balancer. |
| 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 to show multiple columns |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| 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. |
49.81. loadbalancer status show
Display load balancer status tree in json format
Usage:
openstack loadbalancer status show [-h] <load_balancer>
openstack loadbalancer status show [-h] <load_balancer>| Value | Summary |
|---|---|
| <load_balancer> | Name or uuid of the load balancer. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
49.82. loadbalancer unset
Clear load balancer settings
Usage:
openstack loadbalancer unset [-h] [--name] [--description]
[--vip-qos-policy-id] [--wait]
[--tag <tag> | --all-tag]
<load_balancer>
openstack loadbalancer unset [-h] [--name] [--description]
[--vip-qos-policy-id] [--wait]
[--tag <tag> | --all-tag]
<load_balancer>| Value | Summary |
|---|---|
| <load_balancer> | Name or uuid of the load balancer to update. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name | Clear the load balancer name. |
| --description | Clear the load balancer description. |
| --vip-qos-policy-id | Clear the load balancer qos policy. |
| --wait | Wait for action to complete |
| --tag <tag> | Tag to be removed from the load balancer (repeat option to remove multiple tags) |
| --all-tag | Clear all tags associated with the load balancer |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}