List of released CLI commands available in openstack client. These commands
can be referenced by doing openstack help loadbalancer
.
Create a load balancer
openstack loadbalancer create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
[--name <name>]
[--description <description>]
[--vip-address <vip_address>]
[--vip-port-id <vip_port_id>]
[--vip-subnet-id <vip_subnet_id>]
[--vip-network-id <vip_network_id>]
[--vip-qos-policy-id <vip_qos_policy_id>]
[--project <project>]
[--enable | --disable]
-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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
--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).
--enable
¶Enable load balancer (default).
--disable
¶Disable load balancer.
Delete a load balancer
openstack loadbalancer delete [--cascade] [--force] <load_balancer>
--cascade
¶Cascade the delete to all child elements of the load balancer.
--force
¶Force the delete of the load balancer.
load_balancer
¶Load balancers to delete (name or ID)
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]
[--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>]
-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.
--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.
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.
Show the details for a single load balancer
openstack loadbalancer show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
load_balancer
¶Name or UUID of the load balancer.
Shows the current statistics for a load balancer
openstack loadbalancer stats show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
load_balancer
¶Name or UUID of the load balancer.
Create a listener
openstack loadbalancer listener create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
[--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
-p
ort
<port>
[--timeout-client-data <timeout>]
[--timeout-member-connect <timeout>]
[--timeout-member-data <timeout>]
[--timeout-tcp-inspect <timeout>]
[--enable | --disable]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
--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.
loadbalancer
¶Load balancer for the listener (name or ID).
Delete a listener
openstack loadbalancer listener delete <listener>
listener
¶Listener to delete (name or ID)
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]
[--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.
--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.
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]
<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.
listener
¶Listener to modify (name or ID).
Show the details of a single listener
openstack loadbalancer listener show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
listener
¶Name or UUID of the listener
Shows the current statistics for a listener.
openstack loadbalancer listener stats show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
listener
¶Name or UUID of the listener
Create a pool
openstack loadbalancer pool create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
[--name <name>]
[--description <description>]
--protocol
{TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP}
(--listener <listener> | --loadbalancer <load_balancer>)
[--session-persistence <session persistence>]
--lb
-a
lgorithm
{SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}
[--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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
--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.
Delete a pool
openstack loadbalancer pool delete <pool>
pool
¶Pool to delete (name or ID).
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]
[--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.
--loadbalancer
<loadbalancer>
¶Filter by load balancer (name or ID).
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]
<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.
pool
¶Pool to update (name or ID).
Show the details of a single pool
openstack loadbalancer pool show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
pool
¶Name or UUID of the pool.
Creating a member in a pool
openstack loadbalancer member create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
[--name <name>]
[--disable-backup | --enable-backup]
[--weight <weight>]
--address <ip_address>
[--subnet-id <subnet_id>]
--protocol
-p
ort
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
--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.
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.
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]
<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.
pool
¶Pool name or ID to list the members of.
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
Shows details of a single Member
openstack loadbalancer member show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
pool
¶Pool name or ID to show the members of.
member
¶Name or ID of the member to show.
Create a health monitor
openstack loadbalancer healthmonitor create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
[--name <name>]
--delay <delay>
[--expected-codes <codes>]
[--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
--timeout <timeout>
--max
-r
etries
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
--name
<name>
¶Set the health monitor name.
--delay
<delay>
¶Set the time in seconds, between sending probes to members.
--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.
--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).
Delete a health monitor
openstack loadbalancer healthmonitor delete <health_monitor>
health_monitor
¶Health monitor to delete (name or ID).
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]
-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.
Update a health monitor
openstack loadbalancer healthmonitor set
[--name <name>]
[--delay <delay>]
[--expected-codes <codes>]
[--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
[--timeout <timeout>]
[--max-retries <max_retries>]
[--max-retries-down <max_retries_down>]
[--url-path <url_path>]
[--enable | --disable]
<health_monitor>
--name
<name>
¶Set health monitor name.
--delay
<delay>
¶Set the time in seconds, between sending probes to members.
--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.
--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).
Show the details of a single health monitor
openstack loadbalancer healthmonitor show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
health_monitor
¶Name or UUID of the health monitor.
Create a l7policy
openstack loadbalancer l7policy create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
[--name <name>]
[--description <description>]
--action
{REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}
[--redirect-pool <pool> | --redirect-url <url>]
[--position <position>]
[--enable | --disable]
<listener>
-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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
--name
<name>
¶Set the l7policy name.
--description
<description>
¶Set l7policy description.
--action
{REDIRECT_TO_URL,REDIRECT_TO_POOL,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.
--position
<position>
¶Sequence number of this L7 Policy.
--enable
¶Enable l7policy (default).
--disable
¶Disable l7policy.
listener
¶Listener to add l7policy to (name or ID).
Delete a l7policy
openstack loadbalancer l7policy delete <policy>
policy
¶l7policy to delete (name or ID).
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]
-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.
Update a l7policy
openstack loadbalancer l7policy set
[--name <name>]
[--description <description>]
[--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}]
[--redirect-pool <pool> | --redirect-url <url>]
[--position <position>]
[--enable | --disable]
<policy>
--name
<name>
¶Set l7policy name.
--description
<description>
¶Set l7policy description.
--action
{REDIRECT_TO_URL,REDIRECT_TO_POOL,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.
--position
<position>
¶Set sequence number of this L7 Policy.
--enable
¶Enable l7policy.
--disable
¶Disable l7policy.
policy
¶L7policy to update (name or ID).
Show the details of a single l7policy
openstack loadbalancer l7policy show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
policy
¶Name or UUID of the l7policy.
Create a l7rule
openstack loadbalancer l7rule create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
--compare
-t
ype
{REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}
[--invert]
--value <value>
[--key <key>]
--type
{FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER}
[--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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
--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}
¶Set the type for the l7rule.
--enable
¶Enable l7rule (default).
--disable
¶Disable l7rule.
l7policy
¶l7policy to add l7rule to (name or ID).
Delete a l7rule
openstack loadbalancer l7rule delete <l7policy> <rule_id>
l7policy
¶l7policy to delete rule from (name or ID).
rule_id
¶l7rule to delete.
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]
<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.
l7policy
¶l7policy to list rules for (name or ID).
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}]
[--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}
¶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.
Show the details of a single l7rule
openstack loadbalancer l7rule show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
l7policy
¶l7policy to show rule from (name or ID).
l7rule_id
¶l7rule to show.
Show quota defaults
openstack loadbalancer quota defaults show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
-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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
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]
[--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.
--project
<project-id>
¶Name or UUID of the project.
Resets quotas to default quotas
openstack loadbalancer quota reset <project>
project
¶Project to reset quotas (name or ID)
Update a quota
openstack loadbalancer quota set
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
[--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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
--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.
Show the quota details for a project
openstack loadbalancer quota show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
project
¶Name or UUID of the project.
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]
[--loadbalancer <loadbalancer>]
[--compute-id <compute-id>]
[--role {STANDALONE,BACKUP,MASTER}]
[--status {PENDING_CREATE,BOOTING,ERROR,READY,PENDING_DELETE,ALLOCATED,DELETED}]
-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.
--loadbalancer
<loadbalancer>
¶Filter by load balancer (name or ID).
--compute-id
<compute-id>
¶Filter by compute ID.
--role
{STANDALONE,BACKUP,MASTER}
¶Filter by role.
--status
{PENDING_CREATE,BOOTING,ERROR,READY,PENDING_DELETE,ALLOCATED,DELETED}
,
--provisioning-status
{PENDING_CREATE,BOOTING,ERROR,READY,PENDING_DELETE,ALLOCATED,DELETED}
¶Filter by amphora provisioning status.
Show the details of a single amphora
openstack loadbalancer amphora show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--prefix PREFIX]
<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
--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.
--prefix
<PREFIX>
¶add a prefix to all variable names
amphora-id
¶UUID of the amphora.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.