Chapter 47. loadbalancer

<amphora-id>

Uuid of the amphora to configure.

-h, --help

Show this help message and exit

<amphora-id>

Uuid of the amphora.

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--loadbalancer <loadbalancer>

Filter by load balancer (name or id).

--compute-id <compute-id>

Filter by compute id.

--role {BACKUP,MASTER,STANDALONE}

Filter by role.

--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}, --provisioning-status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}

Filter by amphora provisioning status.

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<amphora-id>

Uuid of the amphora.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

-h, --help

Show this help message and exit

--name <name>

New load balancer name.

--description <description>

Set load balancer description.

--vip-address <vip_address>

Set the vip ip address.

--vip-qos-policy-id <vip_qos_policy_id>

Set qos policy id for vip port. unset with none.

--project <project>

Project for the load balancer (name or id).

--provider <provider>

Provider name for the load balancer.

--enable

Enable load balancer (default).

--disable

Disable load balancer.

--flavor <flavor>

The name or id of the flavor for the load balancer.

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

At least one of the following arguments is required.--vip-port-id <vip_port_id>

Set port for the load balancer (name or id).

--vip-subnet-id <vip_subnet_id>

Set subnet for the load balancer (name or id).

--vip-network-id <vip_network_id>

Set network for the load balancer (name or id).

<load_balancer>

Load balancers to delete (name or id)

-h, --help

Show this help message and exit

--cascade

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

<load_balancer>

Name or uuid of the load balancer.

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--name <name>

New flavor name.

--flavorprofile <flavor_profile>

Flavor profile to add the flavor to (name or id).

--description <description>

Set flavor description.

--enable

Enable flavor.

--disable

Disable flavor.

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<flavor>

Flavor to delete (name or id)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--name <name>

List flavors according to their name.

--flavorprofile <flavor_profile>

List flavors according to their flavor profile.

--enable

List enabled flavors.

--disable

List disabled flavors.

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<flavor>

Name or uuid of the flavor to update.

-h, --help

Show this help message and exit

--name <name>

Set the name of the flavor.

--enable

Enable flavor.

--disable

Disable flavor.

<flavor>

Name or uuid of the flavor.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<flavor>

Flavor to update (name or id).

-h, --help

Show this help message and exit

--description

Clear the flavor description.

-h, --help

Show this help message and exit

--name <name>

New octavia flavor profile name.

--provider <provider name>

Provider name for the flavor profile.

--flavor-data <flavor_data>

The json string containing the flavor metadata.

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<flavor_profile>

Flavor profiles to delete (name or id)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--name <name>

List flavor profiles by flavor profile name.

--provider <provider_name>

List flavor profiles according to their provider.

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<flavor_profile>

Name or uuid of the flavor profile to update.

-h, --help

Show this help message and exit

--name <name>

Set the name of the flavor profile.

--provider <provider_name>

Set the provider of the flavor profile.

--flavor-data <flavor_data>

Set the flavor data of the flavor profile.

<flavor_profile>

Name or uuid of the flavor profile to show.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<pool>

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

-h, --help

Show this help message and exit

--name <name>

Set the health monitor name.

--delay <delay>

Set the time in seconds, between sending probes to members.

--domain-name <domain_name>

Set the domain name, which be injected into the http Host Header to the backend server for HTTP health check.

--expected-codes <codes>

Set the list of http status codes expected in response from the member to declare it healthy.

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

Set the http method that the health monitor uses for requests.

--http-version <http_version>

Set the http version.

--timeout <timeout>

Set the maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value.

--max-retries <max_retries>

The number of successful checks before changing the operating status of the member to ONLINE.

--url-path <url_path>

Set the http url path of the request sent by the monitor to test the health of a backend member.

--type {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT}

Set the health monitor type.

--max-retries-down <max_retries_down>

Set the number of allowed check failures before changing the operating status of the member to ERROR.

--enable

Enable health monitor (default).

--disable

Disable health monitor.

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<health_monitor>

Health monitor to delete (name or id).

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<health_monitor>

Health monitor to update (name or id).

-h, --help

Show this help message and exit

--name <name>

Set health monitor name.

--delay <delay>

Set the time in seconds, between sending probes to members.

--domain-name <domain_name>

Set the domain name, which be injected into the http Host Header to the backend server for HTTP health check.

--expected-codes <codes>

Set the list of http status codes expected in response from the member to declare it healthy.

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

Set the http method that the health monitor uses for requests.

--http-version <http_version>

Set the http version.

--timeout <timeout>

Set the maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value.

--max-retries <max_retries>

Set the number of successful checks before changing the operating status of the member to ONLINE.

--max-retries-down <max_retries_down>

Set the number of allowed check failures before changing the operating status of the member to ERROR.

--url-path <url_path>

Set the http url path of the request sent by the monitor to test the health of a backend member.

--enable

Enable health monitor.

--disable

Disable health monitor.

<health_monitor>

Name or uuid of the health monitor.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<health_monitor>

Health monitor to update (name or id).

-h, --help

Show this help message and exit

--domain-name

Clear the health monitor domain name.

--expected-codes

Reset the health monitor expected codes to the api default.

--http-method

Reset the health monitor http method to the api default.

--http-version

Reset the health monitor http version to the api default.

--max-retries-down

Reset the health monitor max retries down to the api default.

--name

Clear the health monitor name.

--url-path

Clear the health monitor url path.

<listener>

Listener to add l7policy to (name or id).

-h, --help

Show this help message and exit

--name <name>

Set the l7policy name.

--description <description>

Set l7policy description.

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

Set the action of the policy.

--redirect-pool <pool>

Set the pool to redirect requests to (name or id).

--redirect-url <url>

Set the url to redirect requests to.

--redirect-prefix <url>

Set the url prefix to redirect requests to.

--redirect-http-code <redirect_http_code>

Set the http response code for redirect_url orREDIRECT_PREFIX action.

--position <position>

Sequence number of this l7 policy.

--enable

Enable l7policy (default).

--disable

Disable l7policy.

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<policy>

L7policy to delete (name or id).

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<policy>

L7policy to update (name or id).

-h, --help

Show this help message and exit

--name <name>

Set l7policy name.

--description <description>

Set l7policy description.

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

Set the action of the policy.

--redirect-pool <pool>

Set the pool to redirect requests to (name or id).

--redirect-url <url>

Set the url to redirect requests to.

--redirect-prefix <url>

Set the url prefix to redirect requests to.

--redirect-http-code <redirect_http_code>

Set the http response code for redirect_url orREDIRECT_PREFIX action.

--position <position>

Set sequence number of this l7 policy.

--enable

Enable l7policy.

--disable

Disable l7policy.

<policy>

Name or uuid of the l7policy.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<policy>

L7policy to update (name or id).

-h, --help

Show this help message and exit

--description

Clear the l7policy description.

--name

Clear the l7policy name.

--redirect-http-code

Clear the l7policy redirect http code.

<l7policy>

L7policy to add l7rule to (name or id).

-h, --help

Show this help message and exit

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

Set the compare type for the l7rule.

--invert

Invert l7rule.

--value <value>

Set the rule value to match on.

--key <key>

Set the key for the l7rule’s value to match on.

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

Set the type for the l7rule.

--enable

Enable l7rule (default).

--disable

Disable l7rule.

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<l7policy>

L7policy to delete rule from (name or id).

<rule_id>

L7rule to delete.

-h, --help

Show this help message and exit

<l7policy>

L7policy to list rules for (name or id).

-h, --help

Show this help message and exit

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<l7policy>

L7policy to update l7rule on (name or id).

<l7rule_id>

L7rule to update.

-h, --help

Show this help message and exit

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

Set the compare type for the l7rule.

--invert

Invert l7rule.

--value <value>

Set the rule value to match on.

--key <key>

Set the key for the l7rule’s value to match on.

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

Set the type for the l7rule.

--enable

Enable l7rule.

--disable

Disable l7rule.

<l7policy>

L7policy to show rule from (name or id).

<l7rule_id>

L7rule to show.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<l7policy>

L7policy to update (name or id).

<l7rule_id>

L7rule to update.

-h, --help

Show this help message and exit

--invert

Reset the l7rule invert to the api default.

--key

Clear the l7rule key.

-h, --help

Show this help message and exit

--name <name>

List load balancers according to their name.

--enable

List enabled load balancers.

--disable

List disabled load balancers.

--project <project-id>

List load balancers according to their project (name or ID).

--vip-network-id <vip_network_id>

List load balancers according to their vip network (name or ID).

--vip-subnet-id <vip_subnet_id>

List load balancers according to their vip subnet (name or ID).

--vip-qos-policy-id <vip_qos_policy_id>

List load balancers according to their vip qos policy (name or ID).

--vip-port-id <vip_port_id>

List load balancers according to their vip port (name or ID).

--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}

List load balancers according to their provisioning status.

--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}

List load balancers according to their operating status.

--provider <provider>

List load balancers according to their provider.

--flavor <flavor>

List load balancers according to their flavor.

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<loadbalancer>

Load balancer for the listener (name or id).

-h, --help

Show this help message and exit

--name <name>

Set the listener name.

--description <description>

Set the description of this listener.

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP}

The protocol for the listener.

--connection-limit <limit>

Set the maximum number of connections permitted for this listener.

--default-pool <pool>

Set the name or id of the pool used by the listener if no L7 policies match.

--default-tls-container-ref <container_ref>

The uri to the key manager service secrets container containing the certificate and key for TERMINATED_TLS listeners.

--sni-container-refs [<container_ref> [<container_ref> …​]]

A list of uris to the key manager service secrets containers containing the certificates and keys for TERMINATED_TLS the listener using Server Name Indication.

--insert-headers <header=value,…​>

A dictionary of optional headers to insert into the request before it is sent to the backend member.

--protocol-port <port>

Set the protocol port number for the listener.

--timeout-client-data <timeout>

Frontend client inactivity timeout in milliseconds. Default: 50000.

--timeout-member-connect <timeout>

Backend member connection timeout in milliseconds. Default: 5000.

--timeout-member-data <timeout>

Backend member inactivity timeout in milliseconds. Default: 50000.

--timeout-tcp-inspect <timeout>

Time, in milliseconds, to wait for additional tcp packets for content inspection. Default: 0.

--enable

Enable listener (default).

--disable

Disable listener.

--client-ca-tls-container-ref <container_ref>

The uri to the key manager service secrets container containing the CA certificate for TERMINATED_TLS listeners.

--client-authentication {NONE,OPTIONAL,MANDATORY}

The tls client authentication verify options for TERMINATED_TLS listeners.

--client-crl-container-ref <client_crl_container_ref>

The uri to the key manager service secrets container containting the CA revocation list file for TERMINATED_TLS listeners.

--allowed-cidr [<allowed_cidr>]

Cidr to allow access to the listener (can be set multiple times).

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<listener>

Listener to delete (name or id)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--name <name>

List listeners by listener name.

--loadbalancer <loadbalancer>

Filter by load balancer (name or id).

--enable

List enabled listeners.

--disable

List disabled listeners.

--project <project>

List listeners by project id.

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<listener>

Listener to modify (name or id).

-h, --help

Show this help message and exit

--name <name>

Set the listener name.

--description <description>

Set the description of this listener.

--connection-limit <limit>

The maximum number of connections permitted for this listener. Default value is -1 which represents infinite connections.

--default-pool <pool>

The id of the pool used by the listener if no l7 policies match.

--default-tls-container-ref <container-ref>

The uri to the key manager service secrets container containing the certificate and key for TERMINATED_TLSlisteners.

--sni-container-refs [<container-ref> [<container-ref> …​]]

A list of uris to the key manager service secrets containers containing the certificates and keys for TERMINATED_TLS the listener using Server Name Indication.

--insert-headers <header=value>

A dictionary of optional headers to insert into the request before it is sent to the backend member.

--timeout-client-data <timeout>

Frontend client inactivity timeout in milliseconds. Default: 50000.

--timeout-member-connect <timeout>

Backend member connection timeout in milliseconds. Default: 5000.

--timeout-member-data <timeout>

Backend member inactivity timeout in milliseconds. Default: 50000.

--timeout-tcp-inspect <timeout>

Time, in milliseconds, to wait for additional tcp packets for content inspection. Default: 0.

--enable

Enable listener.

--disable

Disable listener.

--client-ca-tls-container-ref <container_ref>

The uri to the key manager service secrets container containing the CA certificate for TERMINATED_TLS listeners.

--client-authentication {NONE,OPTIONAL,MANDATORY}

The tls client authentication verify options for TERMINATED_TLS listeners.

--client-crl-container-ref <client_crl_container_ref>

The uri to the key manager service secrets container containting the CA revocation list file for TERMINATED_TLS listeners.

--allowed-cidr [<allowed_cidr>]

Cidr to allow access to the listener (can be set multiple times).

<listener>

Name or uuid of the listener

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<listener>

Name or uuid of the listener

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<listener>

Listener to modify (name or id).

-h, --help

Show this help message and exit

--name

Clear the listener name.

--description

Clear the description of this listener.

--connection-limit

Reset the connection limit to the api default.

--default-pool

Clear the default pool from the listener.

--default-tls-container-ref

Remove the default tls container reference from the listener.

--sni-container-refs

Remove the tls sni container references from the listener.

--insert-headers

Clear the insert headers from the listener.

--timeout-client-data

Reset the client data timeout to the api default.

--timeout-member-connect

Reset the member connect timeout to the api default.

--timeout-member-data

Reset the member data timeout to the api default.

--timeout-tcp-inspect

Reset the tcp inspection timeout to the api default.

--client-ca-tls-container-ref

Clear the client ca tls container reference from the listener.

--client-authentication

Reset the client authentication setting to the api default.

--client-crl-container-ref

Clear the client crl container reference from the listener.

--allowed-cidrs

Clear all allowed cidrs from the listener.

<pool>

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

-h, --help

Show this help message and exit

--name <name>

Name of the member.

--disable-backup

Disable member backup (default)

--enable-backup

Enable member backup

--weight <weight>

The weight of a member determines the portion of requests or connections it services compared to the other members of the pool.

--address <ip_address>

The ip address of the backend member server

--subnet-id <subnet_id>

The subnet id the member service is accessible from.

--protocol-port <protocol_port>

The protocol port number the backend member server is listening on.

--monitor-port <monitor_port>

An alternate protocol port used for health monitoring a backend member.

--monitor-address <monitor_address>

An alternate ip address used for health monitoring a backend member.

--enable

Enable member (default)

--disable

Disable member

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<pool>

Pool name or id to delete the member from.

<member>

Name or id of the member to be deleted.

-h, --help

Show this help message and exit

<pool>

Pool name or id to list the members of.

-h, --help

Show this help message and exit

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<pool>

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

<member>

Name or id of the member to update

-h, --help

Show this help message and exit

--name <name>

Set the name of the member

--disable-backup

Disable member backup (default)

--enable-backup

Enable member backup

--weight <weight>

Set the weight of member in the pool

--monitor-port <monitor_port>

An alternate protocol port used for health monitoring a backend member

--monitor-address <monitor_address>

An alternate ip address used for health monitoring a backend member.

--enable

Set the admin_state_up to true

--disable

Set the admin_state_up to false

<pool>

Pool name or id to show the members of.

<member>

Name or id of the member to show.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<pool>

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

<member>

Member to modify (name or id).

-h, --help

Show this help message and exit

--backup

Clear the backup member flag.

--monitor-address

Clear the member monitor address.

--monitor-port

Clear the member monitor port.

--name

Clear the member name.

--weight

Reset the member weight to the api default.

-h, --help

Show this help message and exit

--name <name>

Set pool name.

--description <description>

Set pool description.

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP}

Set the pool protocol.

--listener <listener>

Listener to add the pool to (name or id).

--loadbalancer <load_balancer>

Load balncer to add the pool to (name or id)

--session-persistence <session persistence>

Set the session persistence for the listener (key=value).

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}

Load balancing algorithm to use.

--enable

Enable pool (default).

--disable

Disable pool.

--tls-container-ref <container-ref>

The reference to the key manager service secrets container containing the certificate and key for ``tls_enabled``pools to re-encrpt the traffic to backend member servers.

--ca-tls-container-ref <ca_tls_container_ref>

The reference to the key manager service secrets container containing the CA certificate for ``tls_enabled`` pools to check the backend member servers certificates

--crl-container-ref <crl_container_ref>

The reference to the key manager service secrets container containting the CA revocation list file for ``tls_enabled`` pools to validate the backend member servers certificates.

--enable-tls

Enable backend member re-encryption.

--disable-tls

Disable backend member re-encryption.

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<pool>

Pool to delete (name or id).

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--loadbalancer <loadbalancer>

Filter by load balancer (name or id).

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<pool>

Pool to update (name or id).

-h, --help

Show this help message and exit

--name <name>

Set the name of the pool.

--description <description>

Set the description of the pool.

--session-persistence <session_persistence>

Set the session persistence for the listener (key=value).

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}

Set the load balancing algorithm to use.

--enable

Enable pool.

--disable

Disable pool.

--tls-container-ref <container-ref>

The uri to the key manager service secrets container containing the certificate and key for TERMINATED_TLS pools to re-encrpt the traffic from TERMINATED_TLS listener to backend servers.

--ca-tls-container-ref <ca_tls_container_ref>

The uri to the key manager service secrets container containing the CA certificate for TERMINATED_TLS listeners to check the backend servers certificates in ssl traffic.

--crl-container-ref <crl_container_ref>

The uri to the key manager service secrets container containting the CA revocation list file for TERMINATED_TLS listeners to valid the backend servers certificates in ssl traffic.

--enable-tls

Enable backend associated members re-encryption.

--disable-tls

Disable backend associated members re-encryption.

<pool>

Name or uuid of the pool.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<pool>

Pool to modify (name or id).

-h, --help

Show this help message and exit

--name

Clear the pool name.

--description

Clear the description of this pool.

--ca-tls-container-ref

Clear the certificate authority certificate reference on this pool.

--crl-container-ref

Clear the certificate revocation list reference on this pool.

--session-persistence

Disables session persistence on the pool.

--tls-container-ref

Clear the certificate reference for this pool.

<provider_name>

Name of the provider driver.

-h, --help

Show this help message and exit

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

-h, --help

Show this help message and exit

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

-h, --help

Show this help message and exit

--project <project-id>

Name or uuid of the project.

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<project>

Project to reset quotas (name or id)

-h, --help

Show this help message and exit

<project>

Name or uuid of the project.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

At least one of the following arguments is required.--healthmonitor <health_monitor>

New value for the health monitor quota. value -1 means unlimited.

--listener <listener>

New value for the listener quota. value -1 means unlimited.

--loadbalancer <load_balancer>

New value for the load balancer quota limit. value -1 means unlimited.

--member <member>

New value for the member quota limit. value -1 means unlimited.

--pool <pool>

New value for the pool quota limit. value -1 means unlimited.

<project>

Name or uuid of the project.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<project>

Name or uuid of the project.

-h, --help

Show this help message and exit

--loadbalancer

Reset the load balancer quota to the default.

--listener

Reset the listener quota to the default.

--pool

Reset the pool quota to the default.

--member

Reset the member quota to the default.

--healthmonitor

Reset the health monitor quota to the default.

<load_balancer>

Name or uuid of the load balancer to update.

-h, --help

Show this help message and exit

--name <name>

Set load balancer name.

--description <description>

Set load balancer description.

--vip-qos-policy-id <vip_qos_policy_id>

Set qos policy id for vip port. unset with none.

--enable

Enable load balancer.

--disable

Disable load balancer.

<load_balancer>

Name or uuid of the load balancer.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<load_balancer>

Name or uuid of the load balancer.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<load_balancer>

Name or uuid of the load balancer.

-h, --help

Show this help message and exit

<load_balancer>

Name or uuid of the load balancer to update.

-h, --help

Show this help message and exit

--name

Clear the load balancer name.

--description

Clear the load balancer description.

--vip-qos-policy-id

Clear the load balancer qos policy.