Este contenido no está disponible en el idioma seleccionado.
Chapter 39. loadbalancer
This chapter describes the commands under the loadbalancer
command.
39.1. loadbalancer amphora list Copiar enlaceEnlace copiado en el portapapeles!
List amphorae
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--role {MASTER,BACKUP,STANDALONE} | Filter by role. |
--loadbalancer <loadbalancer> | Filter by load balancer (name or id). |
-h, --help | Show this help message and exit |
--status {PENDING_DELETE,DELETED,ERROR,PENDING_CREATE,BOOTING,READY,ALLOCATED}, --provisioning-status {PENDING_DELETE,DELETED,ERROR,PENDING_CREATE,BOOTING,READY,ALLOCATED} | Filter by amphora provisioning status. |
--compute-id <compute-id> | Filter by compute id. |
39.2. loadbalancer amphora show Copiar enlaceEnlace copiado en el portapapeles!
Show the details of a single amphora
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<amphora-id> | Uuid of the amphora. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.3. loadbalancer create Copiar enlaceEnlace copiado en el portapapeles!
Create a load balancer
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
--vip-network-id <vip_network_id> | Set network for the load balancer (name or id). |
--vip-subnet-id <vip_subnet_id> | Set subnet for the load balancer (name or id). |
At least one of the following arguments is required.--vip-port-id <vip_port_id> | Set port for the load balancer (name or id). |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--disable | Disable load balancer. |
--vip-qos-policy-id <vip_qos_policy_id> | Set qos policy id for vip port. unset with none. |
--enable | Enable load balancer (default). |
--name <name> | New load balancer name. |
--vip-address <vip_address> | Set the vip ip address. |
-h, --help | Show this help message and exit |
--description <description> | Set load balancer description. |
--project <project> | Project for the load balancer (name or id). |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.4. loadbalancer delete Copiar enlaceEnlace copiado en el portapapeles!
Delete a load balancer
Usage:
openstack loadbalancer delete [-h] [--cascade] <load_balancer>
openstack loadbalancer delete [-h] [--cascade] <load_balancer>
Value | Summary |
---|---|
<load_balancer> | Load balancers to delete (name or id) |
Value | Summary |
---|---|
--cascade | Cascade the delete to all child elements of the load balancer. |
-h, --help | Show this help message and exit |
39.5. loadbalancer failover Copiar enlaceEnlace copiado en el portapapeles!
Trigger load balancer failover
Usage:
openstack loadbalancer failover [-h] <load_balancer>
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 |
39.6. loadbalancer healthmonitor create Copiar enlaceEnlace copiado en el portapapeles!
Create a health monitor
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<pool> | Set the pool for the health monitor (name or id). |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--disable | Disable health monitor. |
--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. |
--enable | Enable health monitor (default). |
--name <name> | Set the health monitor name. |
--max-retries <max_retries> | The number of successful checks before changing the operating status of the member to ONLINE. |
--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE} | Set the http method that the health monitor uses for requests. |
--expected-codes <codes> | Set the list of http status codes expected in response from the member to declare it healthy. |
--type {PING,HTTP,TCP,HTTPS,TLS-HELLO} | Set the health monitor type. |
--delay <delay> | Set the time in seconds, between sending probes to members. |
--max-retries-down <max_retries_down> | Set the number of allowed check failures before changing the operating status of the member to ERROR. |
-h, --help | Show this help message and exit |
--url-path <url_path> | Set the http url path of the request sent by the monitor to test the health of a backend member. |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.7. loadbalancer healthmonitor delete Copiar enlaceEnlace copiado en el portapapeles!
Delete a health monitor
Usage:
openstack loadbalancer healthmonitor delete [-h] <health_monitor>
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 |
39.8. loadbalancer healthmonitor list Copiar enlaceEnlace copiado en el portapapeles!
List health monitors
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
39.9. loadbalancer healthmonitor set Copiar enlaceEnlace copiado en el portapapeles!
Update a health monitor
Usage:
Value | Summary |
---|---|
<health_monitor> | Health monitor to update (name or id). |
Value | Summary |
---|---|
--disable | Disable health monitor. |
--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. |
--enable | Enable health monitor. |
--name <name> | Set health monitor name. |
--max-retries <max_retries> | Set the number of successful checks before changing the operating status of the member to ONLINE. |
--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE} | Set the http method that the health monitor uses for requests. |
--expected-codes <codes> | Set the list of http status codes expected in response from the member to declare it healthy. |
--delay <delay> | Set the time in seconds, between sending probes to members. |
--max-retries-down <max_retries_down> | Set the number of allowed check failures before changing the operating status of the member to ERROR. |
-h, --help | Show this help message and exit |
--url-path <url_path> | Set the http url path of the request sent by the monitor to test the health of a backend member. |
39.10. loadbalancer healthmonitor show Copiar enlaceEnlace copiado en el portapapeles!
Show the details of a single health monitor
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<health_monitor> | Name or uuid of the health monitor. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.11. loadbalancer l7policy create Copiar enlaceEnlace copiado en el portapapeles!
Create a l7policy
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<listener> | Listener to add l7policy to (name or id). |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--position <position> | Sequence number of this l7 policy. |
--disable | Disable l7policy. |
--enable | Enable l7policy (default). |
--name <name> | Set the l7policy name. |
--redirect-pool <pool> | Set the pool to redirect requests to (name or id). |
--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT} | Set the action of the policy. |
--redirect-url <url> | Set the url to redirect requests to. |
-h, --help | Show this help message and exit |
--description <description> | Set l7policy description. |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.12. loadbalancer l7policy delete Copiar enlaceEnlace copiado en el portapapeles!
Delete a l7policy
Usage:
openstack loadbalancer l7policy delete [-h] <policy>
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 |
39.13. loadbalancer l7policy list Copiar enlaceEnlace copiado en el portapapeles!
List l7policies
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
39.14. loadbalancer l7policy set Copiar enlaceEnlace copiado en el portapapeles!
Update a l7policy
Usage:
Value | Summary |
---|---|
<policy> | L7policy to update (name or id). |
Value | Summary |
---|---|
--position <position> | Set sequence number of this l7 policy. |
--disable | Disable l7policy. |
--enable | Enable l7policy. |
--name <name> | Set l7policy name. |
--redirect-pool <pool> | Set the pool to redirect requests to (name or id). |
--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT} | Set the action of the policy. |
--redirect-url <url> | Set the url to redirect requests to. |
-h, --help | Show this help message and exit |
--description <description> | Set l7policy description. |
39.15. loadbalancer l7policy show Copiar enlaceEnlace copiado en el portapapeles!
Show the details of a single l7policy
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<policy> | Name or uuid of the l7policy. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.16. loadbalancer l7rule create Copiar enlaceEnlace copiado en el portapapeles!
Create a l7rule
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<l7policy> | L7policy to add l7rule to (name or id). |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--value <value> | Set the rule value to match on. |
--enable | Enable l7rule (default). |
--invert | Invert l7rule. |
--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER} | Set the type for the l7rule. |
--key <key> | Set the key for the l7rule’s value to match on. |
-h, --help | Show this help message and exit |
--disable | Disable l7rule. |
--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH} | Set the compare type for the l7rule. |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.17. loadbalancer l7rule delete Copiar enlaceEnlace copiado en el portapapeles!
Delete a l7rule
Usage:
openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>
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 |
39.18. loadbalancer l7rule list Copiar enlaceEnlace copiado en el portapapeles!
List l7rules for l7policy
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<l7policy> | L7policy to list rules for (name or id). |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
39.19. loadbalancer l7rule set Copiar enlaceEnlace copiado en el portapapeles!
Update a l7rule
Usage:
Value | Summary |
---|---|
<l7policy> | L7policy to update l7rule on (name or id). |
<l7rule_id> | L7rule to update. |
Value | Summary |
---|---|
--value <value> | Set the rule value to match on. |
--enable | Enable l7rule. |
--invert | Invert l7rule. |
--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER} | Set the type for the l7rule. |
--key <key> | Set the key for the l7rule’s value to match on. |
-h, --help | Show this help message and exit |
--disable | Disable l7rule. |
--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH} | Set the compare type for the l7rule. |
39.20. loadbalancer l7rule show Copiar enlaceEnlace copiado en el portapapeles!
Show the details of a single l7rule
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<l7policy> | L7policy to show rule from (name or id). |
<l7rule_id> | L7rule to show. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.21. loadbalancer list Copiar enlaceEnlace copiado en el portapapeles!
List load balancers
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--name <name> | List load balancers according to their name. |
-h, --help | Show this help message and exit |
--disable | List disabled load balancers. |
--project <project-id> | List load balancers according to their project (name or ID). |
--enable | List enabled load balancers. |
39.22. loadbalancer listener create Copiar enlaceEnlace copiado en el portapapeles!
Create a listener
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<loadbalancer> | Load balancer for the listener (name or id). |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--protocol-port <port> | Set the protocol port number for the listener. |
--disable | Disable listener. |
--connection-limit <limit> | Set the maximum number of connections permitted for this listener. |
--name <name> | Set the listener name. |
--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS} | The protocol for the listener. |
--enable | Enable listener (default). |
--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. |
--default-pool <pool> | Set the name or id of the pool used by the listener if no L7 policies match. |
-h, --help | Show this help message and exit |
--description <description> | Set the description of this listener. |
--insert-headers <header=value,…> | A dictionary of optional headers to insert into the request before it is sent to the backend member. |
--default-tls-container-ref <container_ref> | The uri to the key manager service secrets container containing the certificate and key for TERMINATED_TLS listeners. |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.23. loadbalancer listener delete Copiar enlaceEnlace copiado en el portapapeles!
Delete a listener
Usage:
openstack loadbalancer listener delete [-h] <listener>
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 |
39.24. loadbalancer listener list Copiar enlaceEnlace copiado en el portapapeles!
List listeners
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--enable | List enabled listeners. |
--name <name> | List listeners by listener name. |
--loadbalancer <loadbalancer> | Filter by load balancer (name or id). |
-h, --help | Show this help message and exit |
--disable | List disabled listeners. |
--project <project> | List listeners by project id. |
39.25. loadbalancer listener set Copiar enlaceEnlace copiado en el portapapeles!
Update a listener
Usage:
Value | Summary |
---|---|
<listener> | Listener to modify (name or id). |
Value | Summary |
---|---|
--disable | Disable 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. |
--enable | Enable listener. |
--insert-headers <header=value> | A dictionary of optional headers to insert into the request before it is sent to the backend member. |
--name <name> | Set the listener name. |
-h, --help | Show this help message and exit |
--description <description> | Set the description of this listener. |
--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. |
39.26. loadbalancer listener show Copiar enlaceEnlace copiado en el portapapeles!
Show the details of a single listener
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<listener> | Name or uuid of the listener |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.27. loadbalancer listener stats show Copiar enlaceEnlace copiado en el portapapeles!
Shows the current statistics for a listener.
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<listener> | Name or uuid of the listener |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.28. loadbalancer member create Copiar enlaceEnlace copiado en el portapapeles!
Creating a member in a pool
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<pool> | Id or name of the pool to create the member for. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--protocol-port <protocol_port> | The protocol port number the backend member server is listening on. |
--enable | Enable member (default) |
--name <name> | Name of the member. |
--monitor-port <monitor_port> | An alternate protocol port used for health monitoring a backend member. |
--subnet-id <subnet_id> | The subnet id the member service is accessible from. |
--monitor-address <monitor_address> | An alternate ip address used for health monitoring a backend member. |
--address <ip_address> | The ip address of the backend member server |
-h, --help | Show this help message and exit |
--disable | Disable member |
--weight <weight> | The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.29. loadbalancer member delete Copiar enlaceEnlace copiado en el portapapeles!
Delete a member from a pool
Usage:
openstack loadbalancer member delete [-h] <pool> <member>
openstack loadbalancer member delete [-h] <pool> <member>
Value | Summary |
---|---|
<member> | Name or id of the member to be deleted. |
<pool> | Pool name or id to delete the member from. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
39.30. loadbalancer member list Copiar enlaceEnlace copiado en el portapapeles!
List members in a pool
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<pool> | Pool name or id to list the members of. |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
39.31. loadbalancer member set Copiar enlaceEnlace copiado en el portapapeles!
Update a member
Usage:
Value | Summary |
---|---|
<member> | Name or id of the member to update |
<pool> | Pool that the member to update belongs to (name or ID). |
Value | Summary |
---|---|
--enable | Set the admin_state_up to true |
--name <name> | Set the name of the member |
--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. |
-h, --help | Show this help message and exit |
--disable | Set the admin_state_up to false |
--weight <weight> | Set the weight of member in the pool |
39.32. loadbalancer member show Copiar enlaceEnlace copiado en el portapapeles!
Shows details of a single Member
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<member> | Name or id of the member to show. |
<pool> | Pool name or id to show the members of. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.33. loadbalancer pool create Copiar enlaceEnlace copiado en el portapapeles!
Create a pool
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--disable | Disable pool. |
--enable | Enable pool (default). |
--name <name> | Set pool name. |
--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). |
--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY} | Set the pool protocol. |
--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS} | Load balancing algorithm to use. |
--listener <listener> | Listener to add the pool to (name or id). |
-h, --help | Show this help message and exit |
--description <description> | Set pool description. |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.34. loadbalancer pool delete Copiar enlaceEnlace copiado en el portapapeles!
Delete a pool
Usage:
openstack loadbalancer pool delete [-h] <pool>
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 |
39.35. loadbalancer pool list Copiar enlaceEnlace copiado en el portapapeles!
List pools
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--loadbalancer <loadbalancer> | Filter by load balancer (name or id). |
-h, --help | Show this help message and exit |
39.36. loadbalancer pool set Copiar enlaceEnlace copiado en el portapapeles!
Update a pool
Usage:
Value | Summary |
---|---|
<pool> | Pool to update (name or id). |
Value | Summary |
---|---|
--disable | Disable pool. |
--enable | Enable pool. |
--name <name> | Set the name of the pool. |
--session-persistence <session_persistence> | Set the session persistence for the listener (key=value). |
--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS} | Set the load balancing algorithm to use. |
-h, --help | Show this help message and exit |
--description <description> | Set the description of the pool. |
39.37. loadbalancer pool show Copiar enlaceEnlace copiado en el portapapeles!
Show the details of a single pool
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<pool> | Name or uuid of the pool. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.38. loadbalancer quota defaults show Copiar enlaceEnlace copiado en el portapapeles!
Show quota defaults
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.39. loadbalancer quota list Copiar enlaceEnlace copiado en el portapapeles!
List quotas
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--project <project-id> | Name or uuid of the project. |
39.40. loadbalancer quota reset Copiar enlaceEnlace copiado en el portapapeles!
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 |
39.41. loadbalancer quota set Copiar enlaceEnlace copiado en el portapapeles!
Update a quota
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<project> | Name or uuid of the project. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
--member <member> | New value for the member quota limit. value -1 means unlimited. |
At least one of the following arguments is required.--healthmonitor <health_monitor> | New value for the health monitor quota. value -1 means unlimited. |
--loadbalancer <load_balancer> | New value for the load balancer quota limit. value -1 means unlimited. |
--pool <pool> | New value for the pool quota limit. value -1 means unlimited. |
--listener <listener> | New value for the listener quota. value -1 means unlimited. |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.42. loadbalancer quota show Copiar enlaceEnlace copiado en el portapapeles!
Show the quota details for a project
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<project> | Name or uuid of the project. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.43. loadbalancer set Copiar enlaceEnlace copiado en el portapapeles!
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>
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 |
---|---|
--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. |
--name <name> | Set load balancer name. |
-h, --help | Show this help message and exit |
--disable | Disable load balancer. |
39.44. loadbalancer show Copiar enlaceEnlace copiado en el portapapeles!
Show the details for a single load balancer
Usage:
openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] <load_balancer>
openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<load_balancer>
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<load_balancer> | Name or uuid of the load balancer. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
39.45. loadbalancer stats show Copiar enlaceEnlace copiado en el portapapeles!
Shows the current statistics for a load balancer
Usage:
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Value | Summary |
---|---|
<load_balancer> | Name or uuid of the load balancer. |
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |