Using Octavia CLI extensions to OpenStack Client¶

loadbalancer create¶

Create a load balancer

openstack loadbalancer create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--name <name>]
    [--description <description>]
    [--vip-address <vip_address>]
    [--vip-port-id <vip_port_id>]
    [--vip-subnet-id <vip_subnet_id>]
    [--vip-network-id <vip_network_id>]
    [--vip-qos-policy-id <vip_qos_policy_id>]
    [--project <project>]
    [--provider <provider>]
    [--enable | --disable]
    [--flavor <flavor>]

-f <FORMATTER>, --format <FORMATTER>¶

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.

--name <name>¶

New load balancer name.

--description <description>¶

Set load balancer description.

--vip-address <vip_address>¶

Set the VIP IP Address.

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

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

This command is provided by the python-octaviaclient plugin.

loadbalancer delete¶

Delete a load balancer

openstack loadbalancer delete [--cascade] <load_balancer>

--cascade¶

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

load_balancer¶

Load balancers to delete (name or ID)

This command is provided by the python-octaviaclient plugin.

loadbalancer list¶

List load balancers

openstack loadbalancer list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--name <name>]
    [--enable | --disable]
    [--project <project-id>]
    [--vip-network-id <vip_network_id>]
    [--vip-subnet-id <vip_subnet_id>]
    [--vip-qos-policy-id <vip_qos_policy_id>]
    [--vip-port-id <vip_port_id>]
    [--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}]
    [--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}]
    [--provider <provider>]
    [--flavor <flavor>]

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

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

This command is provided by the python-octaviaclient plugin.

loadbalancer set¶

Update a load balancer

openstack loadbalancer set
    [--name <name>]
    [--description <description>]
    [--vip-qos-policy-id <vip_qos_policy_id>]
    [--enable | --disable]
    <load_balancer>

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

This command is provided by the python-octaviaclient plugin.

loadbalancer show¶

Show the details for a single load balancer

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

This command is provided by the python-octaviaclient plugin.

loadbalancer stats show¶

Shows the current statistics for a load balancer

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

This command is provided by the python-octaviaclient plugin.

loadbalancer status show¶

Display load balancer status tree in json format

openstack loadbalancer status show <load_balancer>

load_balancer¶

Name or UUID of the load balancer.

This command is provided by the python-octaviaclient plugin.

loadbalancer failover¶

Trigger load balancer failover

openstack loadbalancer failover <load_balancer>

load_balancer¶

Name or UUID of the load balancer.

This command is provided by the python-octaviaclient plugin.

loadbalancer listener create¶

Create a listener

openstack loadbalancer listener create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--name <name>]
    [--description <description>]
    --protocol
    {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP}
    [--connection-limit <limit>]
    [--default-pool <pool>]
    [--default-tls-container-ref <container_ref>]
    [--sni-container-refs [<container_ref> [<container_ref> ...]]]
    [--insert-headers <header=value,...>]
    --protocol-port <port>
    [--timeout-client-data <timeout>]
    [--timeout-member-connect <timeout>]
    [--timeout-member-data <timeout>]
    [--timeout-tcp-inspect <timeout>]
    [--enable | --disable]
    [--client-ca-tls-container-ref <container_ref>]
    [--client-authentication {NONE,OPTIONAL,MANDATORY}]
    [--client-crl-container-ref <client_crl_container_ref>]
    <loadbalancer>

-f <FORMATTER>, --format <FORMATTER>¶

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.

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

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.

loadbalancer¶

Load balancer for the listener (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer listener delete¶

Delete a listener

openstack loadbalancer listener delete <listener>

listener¶

Listener to delete (name or ID)

This command is provided by the python-octaviaclient plugin.

loadbalancer listener list¶

List listeners

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

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

This command is provided by the python-octaviaclient plugin.

loadbalancer listener set¶

Update a listener

openstack loadbalancer listener set
    [--name <name>]
    [--description <description>]
    [--connection-limit <limit>]
    [--default-pool <pool>]
    [--default-tls-container-ref <container-ref>]
    [--sni-container-refs [<container-ref> [<container-ref> ...]]]
    [--insert-headers <header=value>]
    [--timeout-client-data <timeout>]
    [--timeout-member-connect <timeout>]
    [--timeout-member-data <timeout>]
    [--timeout-tcp-inspect <timeout>]
    [--enable | --disable]
    [--client-ca-tls-container-ref <container_ref>]
    [--client-authentication {NONE,OPTIONAL,MANDATORY}]
    [--client-crl-container-ref <client_crl_container_ref>]
    <listener>

--name <name>¶

Set the listener name.

--description <description>¶

Set the description of this listener.

--connection-limit <limit>¶

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

--default-pool <pool>¶

The ID of the pool used by the listener if no L7 policies match.

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

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

--sni-container-refs <container-ref>¶

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

--insert-headers <header=value>¶

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

--timeout-client-data <timeout>¶

Frontend client inactivity timeout in milliseconds. Default: 50000.

--timeout-member-connect <timeout>¶

Backend member connection timeout in milliseconds. Default: 5000.

--timeout-member-data <timeout>¶

Backend member inactivity timeout in milliseconds. Default: 50000.

--timeout-tcp-inspect <timeout>¶

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

--enable¶

Enable listener.

--disable¶

Disable listener.

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

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

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

The TLS client authentication verify options for TERMINATED_TLS listeners.

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

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

listener¶

Listener to modify (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer listener show¶

Show the details of a single listener

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

-f <FORMATTER>, --format <FORMATTER>¶

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

This command is provided by the python-octaviaclient plugin.

loadbalancer listener stats show¶

Shows the current statistics for a listener.

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

-f <FORMATTER>, --format <FORMATTER>¶

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

This command is provided by the python-octaviaclient plugin.

loadbalancer pool create¶

Create a pool

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

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

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.

This command is provided by the python-octaviaclient plugin.

loadbalancer pool delete¶

Delete a pool

openstack loadbalancer pool delete <pool>

pool¶

Pool to delete (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer pool list¶

List pools

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

--loadbalancer <loadbalancer>¶

Filter by load balancer (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer pool set¶

Update a pool

openstack loadbalancer pool set
    [--name <name>]
    [--description <description>]
    [--session-persistence <session_persistence>]
    [--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}]
    [--enable | --disable]
    [--tls-container-ref <container-ref>]
    [--ca-tls-container-ref <ca_tls_container_ref>]
    [--crl-container-ref <crl_container_ref>]
    [--enable-tls | --disable-tls]
    <pool>

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

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¶

Pool to update (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer pool show¶

Show the details of a single pool

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

-f <FORMATTER>, --format <FORMATTER>¶

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¶

Name or UUID of the pool.

This command is provided by the python-octaviaclient plugin.

loadbalancer member create¶

Creating a member in a pool

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

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

pool¶

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

This command is provided by the python-octaviaclient plugin.

loadbalancer member delete¶

Delete a member from a pool

openstack loadbalancer member delete <pool> <member>

pool¶

Pool name or ID to delete the member from.

member¶

Name or ID of the member to be deleted.

This command is provided by the python-octaviaclient plugin.

loadbalancer member list¶

List members in a pool

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

pool¶

Pool name or ID to list the members of.

This command is provided by the python-octaviaclient plugin.

loadbalancer member set¶

Update a member

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

--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 that the member to update belongs to (name or ID).

member¶

Name or ID of the member to update

This command is provided by the python-octaviaclient plugin.

loadbalancer member show¶

Shows details of a single Member

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

-f <FORMATTER>, --format <FORMATTER>¶

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 show the members of.

member¶

Name or ID of the member to show.

This command is provided by the python-octaviaclient plugin.

loadbalancer healthmonitor create¶

Create a health monitor

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

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

pool¶

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

This command is provided by the python-octaviaclient plugin.

loadbalancer healthmonitor delete¶

Delete a health monitor

openstack loadbalancer healthmonitor delete <health_monitor>

health_monitor¶

Health monitor to delete (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer healthmonitor list¶

List health monitors

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

This command is provided by the python-octaviaclient plugin.

loadbalancer healthmonitor set¶

Update a health monitor

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

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

Health monitor to update (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer healthmonitor show¶

Show the details of a single health monitor

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

-f <FORMATTER>, --format <FORMATTER>¶

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¶

Name or UUID of the health monitor.

This command is provided by the python-octaviaclient plugin.

loadbalancer l7policy create¶

Create a l7policy

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

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

listener¶

Listener to add l7policy to (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer l7policy delete¶

Delete a l7policy

openstack loadbalancer l7policy delete <policy>

policy¶

l7policy to delete (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer l7policy list¶

List l7policies

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

This command is provided by the python-octaviaclient plugin.

loadbalancer l7policy set¶

Update a l7policy

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

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

L7policy to update (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer l7policy show¶

Show the details of a single l7policy

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

-f <FORMATTER>, --format <FORMATTER>¶

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¶

Name or UUID of the l7policy.

This command is provided by the python-octaviaclient plugin.

loadbalancer l7rule create¶

Create a l7rule

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

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

l7policy¶

l7policy to add l7rule to (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer l7rule delete¶

Delete a l7rule

openstack loadbalancer l7rule delete <l7policy> <rule_id>

l7policy¶

l7policy to delete rule from (name or ID).

rule_id¶

l7rule to delete.

This command is provided by the python-octaviaclient plugin.

loadbalancer l7rule list¶

List l7rules for l7policy

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

l7policy¶

l7policy to list rules for (name or ID).

This command is provided by the python-octaviaclient plugin.

loadbalancer l7rule set¶

Update a l7rule

openstack loadbalancer l7rule set
    [--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}]
    [--invert]
    [--value <value>]
    [--key <key>]
    [--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}]
    [--enable | --disable]
    <l7policy>
    <l7rule_id>

--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 update l7rule on (name or ID).

l7rule_id¶

l7rule to update.

This command is provided by the python-octaviaclient plugin.

loadbalancer l7rule show¶

Show the details of a single l7rule

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

-f <FORMATTER>, --format <FORMATTER>¶

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 show rule from (name or ID).

l7rule_id¶

l7rule to show.

This command is provided by the python-octaviaclient plugin.

loadbalancer quota defaults show¶

Show quota defaults

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

This command is provided by the python-octaviaclient plugin.

loadbalancer quota list¶

List quotas

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

--project <project-id>¶

Name or UUID of the project.

This command is provided by the python-octaviaclient plugin.

loadbalancer quota reset¶

Resets quotas to default quotas

openstack loadbalancer quota reset <project>

project¶

Project to reset quotas (name or ID)

This command is provided by the python-octaviaclient plugin.

loadbalancer quota set¶

Update a quota

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

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

This command is provided by the python-octaviaclient plugin.

loadbalancer quota show¶

Show the quota details for a project

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

This command is provided by the python-octaviaclient plugin.

loadbalancer amphora configure¶

Update the amphora agent configuration

openstack loadbalancer amphora configure <amphora-id>

amphora-id¶

UUID of the amphora to configure.

This command is provided by the python-octaviaclient plugin.

loadbalancer amphora failover¶

Force failover an amphora

openstack loadbalancer amphora failover <amphora-id>

amphora-id¶

UUID of the amphora.

This command is provided by the python-octaviaclient plugin.

loadbalancer amphora list¶

List amphorae

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

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

This command is provided by the python-octaviaclient plugin.

loadbalancer amphora show¶

Show the details of a single amphora

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

-f <FORMATTER>, --format <FORMATTER>¶

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.

amphora-id¶

UUID of the amphora.

This command is provided by the python-octaviaclient plugin.

loadbalancer provider capability list¶

List specified provider driver’s flavor capabilicies.

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

provider_name¶

Name of the provider driver.

This command is provided by the python-octaviaclient plugin.

loadbalancer provider list¶

List all providers

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

This command is provided by the python-octaviaclient plugin.

loadbalancer flavor create¶

Create a octavia flavor

openstack loadbalancer flavor create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    --name <name>
    --flavorprofile <flavor_profile>
    [--description <description>]
    [--enable | --disable]

-f <FORMATTER>, --format <FORMATTER>¶

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.

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

This command is provided by the python-octaviaclient plugin.

loadbalancer flavor delete¶

Delete a flavor

openstack loadbalancer flavor delete <flavor>

flavor¶

Flavor to delete (name or ID)

This command is provided by the python-octaviaclient plugin.

loadbalancer flavor list¶

List flavor

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

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

This command is provided by the python-octaviaclient plugin.

loadbalancer flavor set¶

Update a flavor

openstack loadbalancer flavor set
    [--name <name>]
    [--enable | --disable]
    <flavor>

--name <name>¶

Set the name of the flavor.

--enable¶

Enable flavor.

--disable¶

Disable flavor.

flavor¶

Name or UUID of the flavor to update.

This command is provided by the python-octaviaclient plugin.

loadbalancer flavor show¶

Show the details for a single flavor

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

-f <FORMATTER>, --format <FORMATTER>¶

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¶

Name or UUID of the flavor.

This command is provided by the python-octaviaclient plugin.

loadbalancer flavorprofile create¶

Create a octavia flavor profile

openstack loadbalancer flavorprofile create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    --name <name>
    --provider <provider
    name>
    --flavor-data <flavor_data>

-f <FORMATTER>, --format <FORMATTER>¶

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.

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

This command is provided by the python-octaviaclient plugin.

loadbalancer flavorprofile delete¶

Delete a flavor profile

openstack loadbalancer flavorprofile delete <flavor_profile>

flavor_profile¶

Flavor profiles to delete (name or ID)

This command is provided by the python-octaviaclient plugin.

loadbalancer flavorprofile list¶

List flavor profile

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

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

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.

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

--name <name>¶

List flavor profiles by flavor profile name.

--provider <provider_name>¶

List flavor profiles according to their provider.

This command is provided by the python-octaviaclient plugin.

loadbalancer flavorprofile set¶

Update a flavor profile

openstack loadbalancer flavorprofile set
    [--name <name>]
    [--provider <provider_name>]
    [--flavor-data <flavor_data>]
    <flavor_profile>

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

This command is provided by the python-octaviaclient plugin.

loadbalancer flavorprofile show¶

Show the details for a single flavor profile

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

-f <FORMATTER>, --format <FORMATTER>¶

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¶

Name or UUID of the flavor profile to show.

This command is provided by the python-octaviaclient plugin.