Chapter 39. loadbalancer

This chapter describes the commands under the loadbalancer command.

39.1. loadbalancer amphora list

List amphorae

Usage:

openstack loadbalancer amphora list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--loadbalancer <loadbalancer>]
                                           [--compute-id <compute-id>]
                                           [--role {MASTER,BACKUP,STANDALONE}]
                                           [--status {PENDING_DELETE,DELETED,ERROR,PENDING_CREATE,BOOTING,READY,ALLOCATED}]

Table 39.1. Table Formatter

ValueSummary

--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

Table 39.2. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 39.3. Output Formatters

ValueSummary

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

Table 39.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.5. Optional Arguments

ValueSummary

--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

Show the details of a single amphora

Usage:

openstack loadbalancer amphora show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           <amphora-id>

Table 39.6. Table Formatter

ValueSummary

--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

Table 39.7. Positional Arguments

ValueSummary

<amphora-id>

Uuid of the amphora.

Table 39.8. Output Formatters

ValueSummary

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

Table 39.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.11. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.3. loadbalancer create

Create a load balancer

Usage:

openstack loadbalancer create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--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>]
                                     [--enable | --disable]

Table 39.12. Table Formatter

ValueSummary

--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

Table 39.13. VIP Network

ValueSummary

--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).

Table 39.14. Output Formatters

ValueSummary

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

Table 39.15. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.16. Optional Arguments

ValueSummary

--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).

Table 39.17. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.4. loadbalancer delete

Delete a load balancer

Usage:

openstack loadbalancer delete [-h] [--cascade] <load_balancer>

Table 39.18. Positional Arguments

ValueSummary

<load_balancer>

Load balancers to delete (name or id)

Table 39.19. Optional Arguments

ValueSummary

--cascade

Cascade the delete to all child elements of the load balancer.

-h, --help

Show this help message and exit

39.5. loadbalancer failover

Trigger load balancer failover

Usage:

openstack loadbalancer failover [-h] <load_balancer>

Table 39.20. Positional Arguments

ValueSummary

<load_balancer>

Name or uuid of the load balancer.

Table 39.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.6. loadbalancer healthmonitor create

Create a health monitor

Usage:

openstack loadbalancer healthmonitor create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [--name <name>] --delay
                                                   <delay>
                                                   [--expected-codes <codes>]
                                                   [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                   --timeout <timeout>
                                                   --max-retries <max_retries>
                                                   [--url-path <url_path>]
                                                   --type
                                                   {PING,HTTP,TCP,HTTPS,TLS-HELLO}
                                                   [--max-retries-down <max_retries_down>]
                                                   [--enable | --disable]
                                                   <pool>

Table 39.22. Table Formatter

ValueSummary

--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

Table 39.23. Positional Arguments

ValueSummary

<pool>

Set the pool for the health monitor (name or id).

Table 39.24. Output Formatters

ValueSummary

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

Table 39.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.26. Optional Arguments

ValueSummary

--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.

Table 39.27. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.7. loadbalancer healthmonitor delete

Delete a health monitor

Usage:

openstack loadbalancer healthmonitor delete [-h] <health_monitor>

Table 39.28. Positional Arguments

ValueSummary

<health_monitor>

Health monitor to delete (name or id).

Table 39.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.8. loadbalancer healthmonitor list

List health monitors

Usage:

openstack loadbalancer healthmonitor list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]

Table 39.30. Table Formatter

ValueSummary

--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

Table 39.31. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 39.32. Output Formatters

ValueSummary

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

Table 39.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.9. loadbalancer healthmonitor set

Update a health monitor

Usage:

openstack loadbalancer healthmonitor set [-h] [--name <name>]
                                                [--delay <delay>]
                                                [--expected-codes <codes>]
                                                [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                [--timeout <timeout>]
                                                [--max-retries <max_retries>]
                                                [--max-retries-down <max_retries_down>]
                                                [--url-path <url_path>]
                                                [--enable | --disable]
                                                <health_monitor>

Table 39.35. Positional Arguments

ValueSummary

<health_monitor>

Health monitor to update (name or id).

Table 39.36. Optional Arguments

ValueSummary

--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

Show the details of a single health monitor

Usage:

openstack loadbalancer healthmonitor show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 <health_monitor>

Table 39.37. Table Formatter

ValueSummary

--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

Table 39.38. Positional Arguments

ValueSummary

<health_monitor>

Name or uuid of the health monitor.

Table 39.39. Output Formatters

ValueSummary

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

Table 39.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.42. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.11. loadbalancer l7policy create

Create a l7policy

Usage:

openstack loadbalancer l7policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--name <name>]
                                              [--description <description>]
                                              --action
                                              {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}
                                              [--redirect-pool <pool> | --redirect-url <url>]
                                              [--position <position>]
                                              [--enable | --disable]
                                              <listener>

Table 39.43. Table Formatter

ValueSummary

--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

Table 39.44. Positional Arguments

ValueSummary

<listener>

Listener to add l7policy to (name or id).

Table 39.45. Output Formatters

ValueSummary

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

Table 39.46. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.47. Optional Arguments

ValueSummary

--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.

Table 39.48. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.12. loadbalancer l7policy delete

Delete a l7policy

Usage:

openstack loadbalancer l7policy delete [-h] <policy>

Table 39.49. Positional Arguments

ValueSummary

<policy>

L7policy to delete (name or id).

Table 39.50. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.13. loadbalancer l7policy list

List l7policies

Usage:

openstack loadbalancer l7policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]

Table 39.51. Table Formatter

ValueSummary

--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

Table 39.52. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 39.53. Output Formatters

ValueSummary

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

Table 39.54. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.55. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.14. loadbalancer l7policy set

Update a l7policy

Usage:

openstack loadbalancer l7policy set [-h] [--name <name>]
                                           [--description <description>]
                                           [--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}]
                                           [--redirect-pool <pool> | --redirect-url <url>]
                                           [--position <position>]
                                           [--enable | --disable]
                                           <policy>

Table 39.56. Positional Arguments

ValueSummary

<policy>

L7policy to update (name or id).

Table 39.57. Optional Arguments

ValueSummary

--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

Show the details of a single l7policy

Usage:

openstack loadbalancer l7policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <policy>

Table 39.58. Table Formatter

ValueSummary

--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

Table 39.59. Positional Arguments

ValueSummary

<policy>

Name or uuid of the l7policy.

Table 39.60. Output Formatters

ValueSummary

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

Table 39.61. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.62. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.63. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.16. loadbalancer l7rule create

Create a l7rule

Usage:

openstack loadbalancer l7rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            --compare-type
                                            {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}
                                            [--invert] --value <value>
                                            [--key <key>] --type
                                            {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER}
                                            [--enable | --disable]
                                            <l7policy>

Table 39.64. Table Formatter

ValueSummary

--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

Table 39.65. Positional Arguments

ValueSummary

<l7policy>

L7policy to add l7rule to (name or id).

Table 39.66. Output Formatters

ValueSummary

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

Table 39.67. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.68. Optional Arguments

ValueSummary

--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.

Table 39.69. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.17. loadbalancer l7rule delete

Delete a l7rule

Usage:

openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>

Table 39.70. Positional Arguments

ValueSummary

<l7policy>

L7policy to delete rule from (name or id).

<rule_id>

L7rule to delete.

Table 39.71. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.18. loadbalancer l7rule list

List l7rules for l7policy

Usage:

openstack loadbalancer l7rule list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          <l7policy>

Table 39.72. Table Formatter

ValueSummary

--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

Table 39.73. Positional Arguments

ValueSummary

<l7policy>

L7policy to list rules for (name or id).

Table 39.74. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 39.75. Output Formatters

ValueSummary

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

Table 39.76. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.77. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.19. 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}]
                                         [--enable | --disable]
                                         <l7policy> <l7rule_id>

Table 39.78. Positional Arguments

ValueSummary

<l7policy>

L7policy to update l7rule on (name or id).

<l7rule_id>

L7rule to update.

Table 39.79. Optional Arguments

ValueSummary

--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

Show the details of a single l7rule

Usage:

openstack loadbalancer l7rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <l7policy> <l7rule_id>

Table 39.80. Table Formatter

ValueSummary

--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

Table 39.81. Positional Arguments

ValueSummary

<l7policy>

L7policy to show rule from (name or id).

<l7rule_id>

L7rule to show.

Table 39.82. Output Formatters

ValueSummary

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

Table 39.83. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.84. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.85. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.21. loadbalancer list

List load balancers

Usage:

openstack loadbalancer list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN] [--name <name>]
                                   [--enable | --disable]
                                   [--project <project-id>]

Table 39.86. Table Formatter

ValueSummary

--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

Table 39.87. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 39.88. Output Formatters

ValueSummary

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

Table 39.89. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.90. Optional Arguments

ValueSummary

--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

Create a listener

Usage:

openstack loadbalancer listener create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--name <name>]
                                              [--description <description>]
                                              --protocol
                                              {TCP,HTTP,HTTPS,TERMINATED_HTTPS}
                                              [--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>
                                              [--enable | --disable]
                                              <loadbalancer>

Table 39.91. Table Formatter

ValueSummary

--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

Table 39.92. Positional Arguments

ValueSummary

<loadbalancer>

Load balancer for the listener (name or id).

Table 39.93. Output Formatters

ValueSummary

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

Table 39.94. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.95. Optional Arguments

ValueSummary

--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.

Table 39.96. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.23. loadbalancer listener delete

Delete a listener

Usage:

openstack loadbalancer listener delete [-h] <listener>

Table 39.97. Positional Arguments

ValueSummary

<listener>

Listener to delete (name or id)

Table 39.98. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.24. loadbalancer listener list

List listeners

Usage:

openstack loadbalancer listener list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
                                            [--name <name>]
                                            [--loadbalancer <loadbalancer>]
                                            [--enable | --disable]
                                            [--project <project>]

Table 39.99. Table Formatter

ValueSummary

--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

Table 39.100. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 39.101. Output Formatters

ValueSummary

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

Table 39.102. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.103. Optional Arguments

ValueSummary

--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

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>]
                                           [--enable | --disable]
                                           <listener>

Table 39.104. Positional Arguments

ValueSummary

<listener>

Listener to modify (name or id).

Table 39.105. Optional Arguments

ValueSummary

--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

Show the details of a single listener

Usage:

openstack loadbalancer listener show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <listener>

Table 39.106. Table Formatter

ValueSummary

--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

Table 39.107. Positional Arguments

ValueSummary

<listener>

Name or uuid of the listener

Table 39.108. Output Formatters

ValueSummary

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

Table 39.109. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.110. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.111. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.27. 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]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty] [--noindent]
                                                  [--prefix PREFIX]
                                                  <listener>

Table 39.112. Table Formatter

ValueSummary

--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

Table 39.113. Positional Arguments

ValueSummary

<listener>

Name or uuid of the listener

Table 39.114. Output Formatters

ValueSummary

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

Table 39.115. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.116. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.117. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.28. loadbalancer member create

Creating a member in a pool

Usage:

openstack loadbalancer member create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--name <name>]
                                            [--weight <weight>] --address
                                            <ip_address>
                                            [--subnet-id <subnet_id>]
                                            --protocol-port <protocol_port>
                                            [--monitor-port <monitor_port>]
                                            [--monitor-address <monitor_address>]
                                            [--enable | --disable]
                                            <pool>

Table 39.118. Table Formatter

ValueSummary

--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

Table 39.119. Positional Arguments

ValueSummary

<pool>

Id or name of the pool to create the member for.

Table 39.120. Output Formatters

ValueSummary

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

Table 39.121. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.122. Optional Arguments

ValueSummary

--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.

Table 39.123. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.29. loadbalancer member delete

Delete a member from a pool

Usage:

openstack loadbalancer member delete [-h] <pool> <member>

Table 39.124. Positional Arguments

ValueSummary

<member>

Name or id of the member to be deleted.

<pool>

Pool name or id to delete the member from.

Table 39.125. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.30. loadbalancer member list

List members in a pool

Usage:

openstack loadbalancer member list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          <pool>

Table 39.126. Table Formatter

ValueSummary

--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

Table 39.127. Positional Arguments

ValueSummary

<pool>

Pool name or id to list the members of.

Table 39.128. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 39.129. Output Formatters

ValueSummary

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

Table 39.130. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.131. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.31. loadbalancer member set

Update a member

Usage:

openstack loadbalancer member set [-h] [--name <name>]
                                         [--weight <weight>]
                                         [--monitor-port <monitor_port>]
                                         [--monitor-address <monitor_address>]
                                         [--enable | --disable]
                                         <pool> <member>

Table 39.132. Positional Arguments

ValueSummary

<member>

Name or id of the member to update

<pool>

Pool that the member to update belongs to (name or ID).

Table 39.133. Optional Arguments

ValueSummary

--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

Shows details of a single Member

Usage:

openstack loadbalancer member show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <pool> <member>

Table 39.134. Table Formatter

ValueSummary

--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

Table 39.135. Positional Arguments

ValueSummary

<member>

Name or id of the member to show.

<pool>

Pool name or id to show the members of.

Table 39.136. Output Formatters

ValueSummary

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

Table 39.137. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.138. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.139. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.33. loadbalancer pool create

Create a pool

Usage:

openstack loadbalancer pool create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--name <name>]
                                          [--description <description>]
                                          --protocol
                                          {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY}
                                          (--listener <listener> | --loadbalancer <load_balancer>)
                                          [--session-persistence <session persistence>]
                                          --lb-algorithm
                                          {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}
                                          [--enable | --disable]

Table 39.140. Table Formatter

ValueSummary

--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

Table 39.141. Output Formatters

ValueSummary

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

Table 39.142. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.143. Optional Arguments

ValueSummary

--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.

Table 39.144. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.34. loadbalancer pool delete

Delete a pool

Usage:

openstack loadbalancer pool delete [-h] <pool>

Table 39.145. Positional Arguments

ValueSummary

<pool>

Pool to delete (name or id).

Table 39.146. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.35. loadbalancer pool list

List pools

Usage:

openstack loadbalancer pool list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--loadbalancer <loadbalancer>]

Table 39.147. Table Formatter

ValueSummary

--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

Table 39.148. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 39.149. Output Formatters

ValueSummary

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

Table 39.150. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.151. Optional Arguments

ValueSummary

--loadbalancer <loadbalancer>

Filter by load balancer (name or id).

-h, --help

Show this help message and exit

39.36. 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}]
                                       [--enable | --disable]
                                       <pool>

Table 39.152. Positional Arguments

ValueSummary

<pool>

Pool to update (name or id).

Table 39.153. Optional Arguments

ValueSummary

--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

Show the details of a single pool

Usage:

openstack loadbalancer pool show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        <pool>

Table 39.154. Table Formatter

ValueSummary

--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

Table 39.155. Positional Arguments

ValueSummary

<pool>

Name or uuid of the pool.

Table 39.156. Output Formatters

ValueSummary

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

Table 39.157. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.158. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.159. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.38. loadbalancer quota defaults show

Show quota defaults

Usage:

openstack loadbalancer quota defaults show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty] [--noindent]
                                                  [--prefix PREFIX]

Table 39.160. Table Formatter

ValueSummary

--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

Table 39.161. Output Formatters

ValueSummary

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

Table 39.162. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.163. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.164. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.39. loadbalancer quota list

List quotas

Usage:

openstack loadbalancer quota list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--project <project-id>]

Table 39.165. Table Formatter

ValueSummary

--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

Table 39.166. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 39.167. Output Formatters

ValueSummary

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

Table 39.168. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.169. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project-id>

Name or uuid of the project.

39.40. loadbalancer quota reset

Resets quotas to default quotas

Usage:

openstack loadbalancer quota reset [-h] <project>

Table 39.170. Positional Arguments

ValueSummary

<project>

Project to reset quotas (name or id)

Table 39.171. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

39.41. loadbalancer quota set

Update a quota

Usage:

openstack loadbalancer quota set [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--healthmonitor <health_monitor>]
                                        [--listener <listener>]
                                        [--loadbalancer <load_balancer>]
                                        [--member <member>] [--pool <pool>]
                                        <project>

Table 39.172. Table Formatter

ValueSummary

--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

Table 39.173. Positional Arguments

ValueSummary

<project>

Name or uuid of the project.

Table 39.174. Output Formatters

ValueSummary

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

Table 39.175. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.176. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.177. Quota limits

ValueSummary

--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.

Table 39.178. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.42. loadbalancer quota show

Show the quota details for a project

Usage:

openstack loadbalancer quota show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <project>

Table 39.179. Table Formatter

ValueSummary

--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

Table 39.180. Positional Arguments

ValueSummary

<project>

Name or uuid of the project.

Table 39.181. Output Formatters

ValueSummary

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

Table 39.182. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.183. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.184. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.43. 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>

Table 39.185. Positional Arguments

ValueSummary

<load_balancer>

Name or uuid of the load balancer to update.

Table 39.186. Optional Arguments

ValueSummary

--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

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>

Table 39.187. Table Formatter

ValueSummary

--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

Table 39.188. Positional Arguments

ValueSummary

<load_balancer>

Name or uuid of the load balancer.

Table 39.189. Output Formatters

ValueSummary

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

Table 39.190. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.191. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.192. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

39.45. 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] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <load_balancer>

Table 39.193. Table Formatter

ValueSummary

--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

Table 39.194. Positional Arguments

ValueSummary

<load_balancer>

Name or uuid of the load balancer.

Table 39.195. Output Formatters

ValueSummary

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

Table 39.196. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.197. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.198. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names