Chapter 47. loadbalancer
This chapter describes the commands under the loadbalancer
command.
47.1. loadbalancer amphora configure
Update the amphora agent configuration
Usage:
openstack loadbalancer amphora configure [-h] <amphora-id>
Value | Summary |
---|---|
<amphora-id> | Uuid of the amphora to configure. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
47.2. loadbalancer amphora failover
Force failover an amphora
Usage:
openstack loadbalancer amphora failover [-h] <amphora-id>
Value | Summary |
---|---|
<amphora-id> | Uuid of the amphora. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
47.3. loadbalancer amphora list
List amphorae
Usage:
openstack loadbalancer amphora list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--loadbalancer <loadbalancer>] [--compute-id <compute-id>] [--role {BACKUP,MASTER,STANDALONE}] [--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}]
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. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.4. loadbalancer amphora show
Show the details of a single amphora
Usage:
openstack loadbalancer amphora show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <amphora-id>
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 |
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. |
47.5. loadbalancer create
Create a load balancer
Usage:
openstack loadbalancer create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] [--vip-address <vip_address>] [--vip-port-id <vip_port_id>] [--vip-subnet-id <vip_subnet_id>] [--vip-network-id <vip_network_id>] [--vip-qos-policy-id <vip_qos_policy_id>] [--project <project>] [--provider <provider>] [--enable | --disable] [--flavor <flavor>]
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. |
--enable | Enable load balancer (default). |
--disable | Disable load balancer. |
--flavor <flavor> | The name or id of the flavor for 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 |
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). |
47.6. loadbalancer delete
Delete a load balancer
Usage:
openstack loadbalancer delete [-h] [--cascade] <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. |
47.7. loadbalancer failover
Trigger load balancer failover
Usage:
openstack loadbalancer failover [-h] <load_balancer>
Value | Summary |
---|---|
<load_balancer> | Name or uuid of the load balancer. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
47.8. loadbalancer flavor create
Create a octavia flavor
Usage:
openstack loadbalancer flavor create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --name <name> --flavorprofile <flavor_profile> [--description <description>] [--enable | --disable]
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 |
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. |
47.9. loadbalancer flavor delete
Delete a flavor
Usage:
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 |
47.10. loadbalancer flavor list
List flavor
Usage:
openstack loadbalancer flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] [--flavorprofile <flavor_profile>] [--enable | --disable]
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 |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.11. loadbalancer flavor set
Update a flavor
Usage:
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. |
47.12. loadbalancer flavor show
Show the details for a single flavor
Usage:
openstack loadbalancer flavor show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flavor>
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 |
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. |
47.13. loadbalancer flavor unset
Clear health monitor settings
Usage:
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. |
47.14. loadbalancer flavorprofile create
Create a octavia flavor profile
Usage:
openstack loadbalancer flavorprofile 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> --flavor-data <flavor_data>
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 |
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. |
47.15. loadbalancer flavorprofile delete
Delete a flavor profile
Usage:
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 |
47.16. loadbalancer flavorprofile list
List flavor profile
Usage:
openstack loadbalancer flavorprofile list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] [--provider <provider_name>]
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 |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.17. loadbalancer flavorprofile set
Update a flavor profile
Usage:
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. |
47.18. loadbalancer flavorprofile show
Show the details for a single flavor profile
Usage:
openstack loadbalancer flavorprofile show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flavor_profile>
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 |
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. |
47.19. loadbalancer healthmonitor create
Create a health monitor
Usage:
openstack loadbalancer healthmonitor create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] --delay <delay> [--domain-name <domain_name>] [--expected-codes <codes>] [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}] [--http-version <http_version>] --timeout <timeout> --max-retries <max_retries> [--url-path <url_path>] --type {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT} [--max-retries-down <max_retries_down>] [--enable | --disable] <pool>
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} | 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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--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. |
47.20. loadbalancer healthmonitor delete
Delete a health monitor
Usage:
openstack loadbalancer healthmonitor delete [-h] <health_monitor>
Value | Summary |
---|---|
<health_monitor> | Health monitor to delete (name or id). |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
47.21. loadbalancer healthmonitor list
List health monitors
Usage:
openstack loadbalancer healthmonitor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.22. loadbalancer healthmonitor set
Update a health monitor
Usage:
openstack loadbalancer healthmonitor set [-h] [--name <name>] [--delay <delay>] [--domain-name <domain_name>] [--expected-codes <codes>] [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}] [--http-version <http_version>] [--timeout <timeout>] [--max-retries <max_retries>] [--max-retries-down <max_retries_down>] [--url-path <url_path>] [--enable | --disable] <health_monitor>
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. |
47.23. loadbalancer healthmonitor show
Show the details of a single health monitor
Usage:
openstack loadbalancer healthmonitor show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <health_monitor>
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 |
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. |
47.24. loadbalancer healthmonitor unset
Clear health monitor settings
Usage:
openstack loadbalancer healthmonitor unset [-h] [--domain-name] [--expected-codes] [--http-method] [--http-version] [--max-retries-down] [--name] [--url-path] <health_monitor>
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. |
47.25. loadbalancer l7policy create
Create a l7policy
Usage:
openstack loadbalancer l7policy create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] --action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT} [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>] [--redirect-http-code <redirect_http_code>] [--position <position>] [--enable | --disable] <listener>
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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--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. |
47.26. loadbalancer l7policy delete
Delete a l7policy
Usage:
openstack loadbalancer l7policy delete [-h] <policy>
Value | Summary |
---|---|
<policy> | L7policy to delete (name or id). |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
47.27. loadbalancer l7policy list
List l7policies
Usage:
openstack loadbalancer l7policy list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.28. loadbalancer l7policy set
Update a l7policy
Usage:
openstack loadbalancer l7policy set [-h] [--name <name>] [--description <description>] [--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}] [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>] [--redirect-http-code <redirect_http_code>] [--position <position>] [--enable | --disable] <policy>
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. |
47.29. loadbalancer l7policy show
Show the details of a single l7policy
Usage:
openstack loadbalancer l7policy show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <policy>
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 |
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. |
47.30. loadbalancer l7policy unset
Clear l7policy settings
Usage:
openstack loadbalancer l7policy unset [-h] [--description] [--name] [--redirect-http-code] <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. |
47.31. loadbalancer l7rule create
Create a l7rule
Usage:
openstack loadbalancer l7rule create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH} [--invert] --value <value> [--key <key>] --type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD} [--enable | --disable] <l7policy>
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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--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. |
47.32. loadbalancer l7rule delete
Delete a l7rule
Usage:
openstack loadbalancer l7rule delete [-h] <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 |
47.33. loadbalancer l7rule list
List l7rules for l7policy
Usage:
openstack loadbalancer l7rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <l7policy>
Value | Summary |
---|---|
<l7policy> | L7policy to list rules for (name or id). |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.34. loadbalancer l7rule set
Update a l7rule
Usage:
openstack loadbalancer l7rule set [-h] [--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}] [--invert] [--value <value>] [--key <key>] [--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}] [--enable | --disable] <l7policy> <l7rule_id>
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. |
47.35. loadbalancer l7rule show
Show the details of a single l7rule
Usage:
openstack loadbalancer l7rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <l7policy> <l7rule_id>
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 |
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. |
47.36. loadbalancer l7rule unset
Clear l7rule settings
Usage:
openstack loadbalancer l7rule unset [-h] [--invert] [--key] <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. |
47.37. loadbalancer list
List load balancers
Usage:
openstack loadbalancer list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] [--enable | --disable] [--project <project-id>] [--vip-network-id <vip_network_id>] [--vip-subnet-id <vip_subnet_id>] [--vip-qos-policy-id <vip_qos_policy_id>] [--vip-port-id <vip_port_id>] [--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}] [--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}] [--provider <provider>] [--flavor <flavor>]
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. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.38. loadbalancer listener create
Create a listener
Usage:
openstack loadbalancer listener create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] --protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP} [--connection-limit <limit>] [--default-pool <pool>] [--default-tls-container-ref <container_ref>] [--sni-container-refs [<container_ref> [<container_ref> ...]]] [--insert-headers <header=value,...>] --protocol-port <port> [--timeout-client-data <timeout>] [--timeout-member-connect <timeout>] [--timeout-member-data <timeout>] [--timeout-tcp-inspect <timeout>] [--enable | --disable] [--client-ca-tls-container-ref <container_ref>] [--client-authentication {NONE,OPTIONAL,MANDATORY}] [--client-crl-container-ref <client_crl_container_ref>] [--allowed-cidr [<allowed_cidr>]] <loadbalancer>
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} | 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> [<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). |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--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. |
47.39. loadbalancer listener delete
Delete a listener
Usage:
openstack loadbalancer listener delete [-h] <listener>
Value | Summary |
---|---|
<listener> | Listener to delete (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
47.40. loadbalancer listener list
List listeners
Usage:
openstack loadbalancer listener list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] [--loadbalancer <loadbalancer>] [--enable | --disable] [--project <project>]
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. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.41. loadbalancer listener set
Update a listener
Usage:
openstack loadbalancer listener set [-h] [--name <name>] [--description <description>] [--connection-limit <limit>] [--default-pool <pool>] [--default-tls-container-ref <container-ref>] [--sni-container-refs [<container-ref> [<container-ref> ...]]] [--insert-headers <header=value>] [--timeout-client-data <timeout>] [--timeout-member-connect <timeout>] [--timeout-member-data <timeout>] [--timeout-tcp-inspect <timeout>] [--enable | --disable] [--client-ca-tls-container-ref <container_ref>] [--client-authentication {NONE,OPTIONAL,MANDATORY}] [--client-crl-container-ref <client_crl_container_ref>] [--allowed-cidr [<allowed_cidr>]] <listener>
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> [<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). |
47.42. loadbalancer listener show
Show the details of a single listener
Usage:
openstack loadbalancer listener show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <listener>
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 |
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. |
47.43. loadbalancer listener stats show
Shows the current statistics for a listener.
Usage:
openstack loadbalancer listener stats show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <listener>
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 |
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. |
47.44. loadbalancer listener unset
Clear listener settings
Usage:
openstack loadbalancer listener unset [-h] [--name] [--description] [--connection-limit] [--default-pool] [--default-tls-container-ref] [--sni-container-refs] [--insert-headers] [--timeout-client-data] [--timeout-member-connect] [--timeout-member-data] [--timeout-tcp-inspect] [--client-ca-tls-container-ref] [--client-authentication] [--client-crl-container-ref] [--allowed-cidrs] <listener>
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. |
47.45. loadbalancer member create
Creating a member in a pool
Usage:
openstack loadbalancer member create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--disable-backup | --enable-backup] [--weight <weight>] --address <ip_address> [--subnet-id <subnet_id>] --protocol-port <protocol_port> [--monitor-port <monitor_port>] [--monitor-address <monitor_address>] [--enable | --disable] <pool>
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 |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--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. |
47.46. loadbalancer member delete
Delete a member from a pool
Usage:
openstack loadbalancer member delete [-h] <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 |
47.47. loadbalancer member list
List members in a pool
Usage:
openstack loadbalancer member list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <pool>
Value | Summary |
---|---|
<pool> | Pool name or id to list the members of. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.48. loadbalancer member set
Update a member
Usage:
openstack loadbalancer member set [-h] [--name <name>] [--disable-backup | --enable-backup] [--weight <weight>] [--monitor-port <monitor_port>] [--monitor-address <monitor_address>] [--enable | --disable] <pool> <member>
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 |
47.49. loadbalancer member show
Shows details of a single Member
Usage:
openstack loadbalancer member show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <pool> <member>
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 |
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. |
47.50. loadbalancer member unset
Clear member settings
Usage:
openstack loadbalancer member unset [-h] [--backup] [--monitor-address] [--monitor-port] [--name] [--weight] <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. |
47.51. loadbalancer pool create
Create a pool
Usage:
openstack loadbalancer pool create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] --protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP} (--listener <listener> | --loadbalancer <load_balancer>) [--session-persistence <session persistence>] --lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT} [--enable | --disable] [--tls-container-ref <container-ref>] [--ca-tls-container-ref <ca_tls_container_ref>] [--crl-container-ref <crl_container_ref>] [--enable-tls | --disable-tls]
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,UDP} | 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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--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. |
47.52. loadbalancer pool delete
Delete a pool
Usage:
openstack loadbalancer pool delete [-h] <pool>
Value | Summary |
---|---|
<pool> | Pool to delete (name or id). |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
47.53. loadbalancer pool list
List pools
Usage:
openstack loadbalancer pool list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--loadbalancer <loadbalancer>]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--loadbalancer <loadbalancer> | Filter by load balancer (name or id). |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.54. loadbalancer pool set
Update a pool
Usage:
openstack loadbalancer pool set [-h] [--name <name>] [--description <description>] [--session-persistence <session_persistence>] [--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}] [--enable | --disable] [--tls-container-ref <container-ref>] [--ca-tls-container-ref <ca_tls_container_ref>] [--crl-container-ref <crl_container_ref>] [--enable-tls | --disable-tls] <pool>
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. |
47.55. loadbalancer pool show
Show the details of a single pool
Usage:
openstack loadbalancer pool show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <pool>
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 |
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. |
47.56. loadbalancer pool unset
Clear pool settings
Usage:
openstack loadbalancer pool unset [-h] [--name] [--description] [--ca-tls-container-ref] [--crl-container-ref] [--session-persistence] [--tls-container-ref] <pool>
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. |
47.57. loadbalancer provider capability list
List specified provider driver’s flavor capabilicies.
Usage:
openstack loadbalancer provider capability list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <provider_name>
Value | Summary |
---|---|
<provider_name> | Name of the provider driver. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.58. loadbalancer provider list
List all providers
Usage:
openstack loadbalancer provider list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.59. loadbalancer quota defaults show
Show quota defaults
Usage:
openstack loadbalancer quota defaults show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--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. |
47.60. loadbalancer quota list
List quotas
Usage:
openstack loadbalancer quota list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--project <project-id>]
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 |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--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. |
47.61. loadbalancer quota reset
Resets quotas to default quotas
Usage:
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 |
47.62. loadbalancer quota set
Update a quota
Usage:
openstack loadbalancer quota set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--healthmonitor <health_monitor>] [--listener <listener>] [--loadbalancer <load_balancer>] [--member <member>] [--pool <pool>] <project>
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 |
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. |
47.63. loadbalancer quota show
Show the quota details for a project
Usage:
openstack loadbalancer quota show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <project>
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 |
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. |
47.64. loadbalancer quota unset
Clear quota settings
Usage:
openstack loadbalancer quota unset [-h] [--loadbalancer] [--listener] [--pool] [--member] [--healthmonitor] <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. |
47.65. loadbalancer set
Update a load balancer
Usage:
openstack loadbalancer set [-h] [--name <name>] [--description <description>] [--vip-qos-policy-id <vip_qos_policy_id>] [--enable | --disable] <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 <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. |
47.66. 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>
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 |
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. |
47.67. loadbalancer stats show
Shows the current statistics for a load balancer
Usage:
openstack loadbalancer stats 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 |
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. |
47.68. loadbalancer status show
Display load balancer status tree in json format
Usage:
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 |
47.69. loadbalancer unset
Clear load balancer settings
Usage:
openstack loadbalancer unset [-h] [--name] [--description] [--vip-qos-policy-id] <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. |