Elastic LoadBalancer (ELB)¶

The load_balancer client is the command-line interface (CLI) for the native Neutron/Octavia LoadBalancer service (load_balancer) API.

For help on a specific loadbalancer command, enter:

$ openstack loadbalancer help SUBCOMMAND

Load Balancer operations¶

loadbalancer list¶

List load balancers

openstack loadbalancer list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

loadbalancer show¶

Show the details for a single load balancer

openstack loadbalancer show <load_balancer>

load_balancer¶: The Name or ID of the Load balancer to show.

This command is provided by the otcextensions plugin.

loadbalancer create¶

Create a load balancer

openstack loadbalancer create
    [--name <name>]
    [--description <description>]
    [--vip_address <vip_address>]
    (--vip_network_id <vip_network_id> | --vip_port_id <vip_port_id> | --vip_subnet_id <vip_subnet_id>)
    [--vip_qos_policy_id <vip_qos_policy_id>]
    [--enable | --disable]

--name <name>¶: New load balancer name.

--description <description>¶: Set load balancer description.

--vip_address <vip_address>¶: Set the VIP IP Address.

--vip_network_id <vip_network_id>¶: Set network for the load balancer (name or ID).

--vip_port_id <vip_port_id>¶: Set Port for the load balancer (name or ID).

--vip_subnet_id <vip_subnet_id>¶: The ID of the network for the Virtual IP (VIP). One of vip_network_id, vip_port_id, or vip_subnet_id must be specified.

--vip_qos_policy_id <vip_qos_policy_id>¶: Set QoS policy ID for VIP port. Unset with None.

--enable¶: Enable load balancer (default).

--disable¶: Disable load balancer.

This command is provided by the otcextensions plugin.

loadbalancer set¶

Update a load balancer

openstack loadbalancer set
    [--enable | --disable]
    [--description <description>]
    [--name <name>]
    [--vip_qos_policy_id <vip_qos_policy_id>]
    <load_balancer>

--enable¶: Enable load balancer.

--disable¶: Disable load balancer.

--description <description>¶: A human-readable description for the resource.

--name <name>¶: Human-readable name of the resource.

--vip_qos_policy_id <vip_qos_policy_id>¶: The ID of the QoS Policy which will apply to the Virtual IP (VIP).

load_balancer¶: The ID for the load balancer.

This command is provided by the otcextensions plugin.

loadbalancer delete¶

Delete a load balancer

openstack loadbalancer delete <load_balancer> [<load_balancer> ...]

load_balancer¶: The ID for the load balancer.

This command is provided by the otcextensions plugin.

Listeners operations¶

loadbalancer listener create¶

Create LoadBalancer Listener

openstack loadbalancer listener create
    [--name <name>]
    [--description <description>]
    --protocol
    {TCP,HTTP,HTTPS,UDP}
    --protocol_port <port>
    [--connection_limit <limit>]
    [--default_pool <pool>]
    [--default_tls_container_ref <default_tls_container_ref>]
    [--enable | --disable]
    <load_balancer>

--name <name>¶: Set the listener name.

--description <description>¶: Set the description of this listener.

--protocol {TCP,HTTP,HTTPS,UDP}¶: The protocol for the listener. One of [TCP, HTTP, HTTPS, UDP]

--protocol_port <port>¶: Set the protocol port number for the 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 <default_tls_container_ref>¶: The URI of the key manager service secret containing a PKCS12 format certificate/key bundle for TERMINATED_TLS listeners. DEPRECATED: A secret container of type “certificate” containing the certificate and key for TERMINATED_TLS listeners.

--enable¶: Enable listener (default).

--disable¶: Disable listener.

load_balancer¶: Load balancer for the listener (name or ID).

This command is provided by the otcextensions plugin.

loadbalancer listener delete¶

Delete a listener

openstack loadbalancer listener delete <listener> [<listener> ...]

listener¶: The ID of the listener to delete.

This command is provided by the otcextensions plugin.

loadbalancer listener list¶

List listeners

openstack loadbalancer listener list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--name <name>]
    [--load_balancer <load_balancer>]
    [--protocol {TCP,HTTP,HTTPS,UDP}]
    [--protocol_port <protocol_port>]

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--name <name>¶: List listeners by listener name.

--load_balancer <load_balancer>¶: Filter by load balancer (name or ID).

--protocol {TCP,HTTP,HTTPS,UDP}¶: Load balancer listener protocol to query One of [TCP, HTTP, HTTPS, UDP]

--protocol_port <protocol_port>¶: Load balancer listener protocol port to query

This command is provided by the otcextensions plugin.

loadbalancer listener set¶

Update a listener

openstack loadbalancer listener set
    [--name <name>]
    [--description <description>]
    [--connection_limit <connection_limit>]
    [--default_pool <pool>]
    [--default_tls_container_ref <default_tls_container_ref>]
    [--enable | --disable]
    <listener>

--name <name>¶: Set the listener name.

--description <description>¶: Set the description of this listener.

--connection_limit <connection_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 <default_tls_container_ref>¶: The URI of the key manager service secret containing a PKCS12 format certificate/key bundle for TERMINATED_TLS listeners. DEPRECATED: A secret container of type “certificate” containing the certificate and key for TERMINATED_TLS listeners.

--enable¶: Enable load balancer (default).

--disable¶: Disable load balancer.

listener¶: Listener to modify (ID).

This command is provided by the otcextensions plugin.

loadbalancer listener show¶

Show the details of a single listener

openstack loadbalancer listener show <listener>

listener¶: Name or UUID of the listener.

This command is provided by the otcextensions plugin.

Pools operations¶

loadbalancer pool list¶

List LoadBalancer pools

openstack loadbalancer pool list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--description <description>]
    [--lb_algorithm {LEAST_CONNECTIONS,ROUND_ROBIN,SOURCE_IP}]
    [--name <name>]
    [--protocol {HTTP,HTTPS,PROXY,TCP,UDP}]
    [--load_balancer <load_balancer>]

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--description <description>¶: Load balancer pool description to query

--lb_algorithm {LEAST_CONNECTIONS,ROUND_ROBIN,SOURCE_IP}¶: Load balancer pool algorithm to queryone of [LEAST_CONNECTIONS, ROUND_ROBIN, SOURCE_IP]

--name <name>¶: Load balancer pool name to query

--protocol {HTTP,HTTPS,PROXY,TCP,UDP}¶: Load balancer pool protocol to queryone of [HTTP, HTTPS, PROXY, TCP, UDP]

--load_balancer <load_balancer>¶: Filter by load balancer (name or ID).

This command is provided by the otcextensions plugin.

loadbalancer pool show¶

Show LoadBalancer pool details

openstack loadbalancer pool show <pool>

pool¶: Load balancer pool id to show.

This command is provided by the otcextensions plugin.

loadbalancer pool create¶

Create a pool

openstack loadbalancer pool create
    [--name <name>]
    [--description <description>]
    --protocol
    {HTTP,HTTPS,PROXY,TCP,UDP}
    --lb_algorithm
    {LEAST_CONNECTIONS,ROUND_ROBIN,SOURCE_IP}
    [--listener_id <listener> | --loadbalancer_id <loadbalancer>]
    [--session_persistence <session_persistence>]
    [--enable | --disable]

--name <name>¶: Set pool name.

--description <description>¶: Set pool description.

--protocol {HTTP,HTTPS,PROXY,TCP,UDP}¶: The protocol for the pool. One of [HTTP, HTTPS, PROXY, TCP, UDP].

--lb_algorithm {LEAST_CONNECTIONS,ROUND_ROBIN,SOURCE_IP}¶: The load balancing algorithm for the pool. One of [LEAST_CONNECTIONS, ROUND_ROBIN, SOURCE_IP].

--listener_id <listener>¶: The ID of the listener for the pool. Either listener_id or loadbalancer_id must be specified.

--loadbalancer_id <loadbalancer>¶: The ID of the loadbalancer for the pool. Either listener_id or loadbalancer_id must be specified.

--session_persistence <session_persistence>¶: A JSON object specifying the session persistence for the pool or null for no session persistence. See Pool Session Persistence. Default is null.

--enable¶: Enable pool (default).

--disable¶: Disable pool.

This command is provided by the otcextensions plugin.

loadbalancer pool set¶

Update a pool

openstack loadbalancer pool set
    [--name <name>]
    [--description <description>]
    [--session_persistence <session_persistence>]
    [--lb_algorithm {LEAST_CONNECTIONS,ROUND_ROBIN,SOURCE_IP}]
    [--enable | --disable]
    <pool>

--name <name>¶: Human-readable name of the resource.

--description <description>¶: A human-readable description for the resource.

--session_persistence <session_persistence>¶: A JSON object specifying the session persistence for the pool or null for no session persistence. See Pool Session Persistence. Default is null.

--lb_algorithm {LEAST_CONNECTIONS,ROUND_ROBIN,SOURCE_IP}¶: The load balancing algorithm for the pool. One of [LEAST_CONNECTIONS, ROUND_ROBIN, SOURCE_IP].

--enable¶: Enable pool (default).

--disable¶: Disable pool.

pool¶: The ID of the pool to update.

This command is provided by the otcextensions plugin.

loadbalancer pool delete¶

Delete a pool

openstack loadbalancer pool delete <pool> [<pool> ...]

pool¶: The ID of the pool to delete.

This command is provided by the otcextensions plugin.

Pool Members operations¶

loadbalancer member create¶

Creating a member in a pool

openstack loadbalancer member create
    [--name <name>]
    [--weight <weight>]
    [--address <ip_address>]
    [--protocol_port <protocol_port>]
    [--subnet_id <subnet_id>]
    [--enable | --disable]
    <pool>

--name <name>¶: Name of the member.

--weight <weight>¶: The weight of a member determines the portion of requests or connections it services compared to the other members of the pool.

--address <ip_address>¶: The IP address of the backend member to receive traffic from the load balancer.

--protocol_port <protocol_port>¶: The port on which the backend member listens for traffic.

--subnet_id <subnet_id>¶: The subnet ID the member service is accessible from.

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

loadbalancer member delete¶

Delete a member from a pool

openstack loadbalancer member delete <pool> <member> [<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 otcextensions plugin.

loadbalancer member list¶

List members in a pool

openstack loadbalancer member list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--name <name>]
    [--address <address>]
    [--protocol_port <protocol_port>]
    [--weight <weight>]
    <pool>

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--name <name>¶: Load balancer pool member name to query

--address <address>¶: Load balancer pool member address to query

--protocol_port <protocol_port>¶: Load balancer pool member port number to query

--weight <weight>¶: Load balancer pool member weight to query

pool¶: Pool name or ID to list the members of.

This command is provided by the otcextensions plugin.

loadbalancer member set¶

Update a member

openstack loadbalancer member set
    [--name <name>]
    [--weight <weight>]
    [--enable | --disable]
    <pool>
    <member>

--name <name>¶: Name or ID of the member to update.

--weight <weight>¶: The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. For example, a member with a weight of 10 receives five times as many requests as a member with a weight of 2. A value of 0 means the member does not receive new connections but continues to service existing connections. A valid value is from 0 to 256. Default is 1.

--enable¶: Enable member (default).

--disable¶: Disable member.

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

loadbalancer member show¶

Shows details of a single Member

openstack loadbalancer member show <pool> <member>

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

Health Monitor operations¶

loadbalancer healthmonitor create¶

Create a health monitor

openstack loadbalancer healthmonitor create
    [--name <name>]
    --delay <delay>
    [--expected_codes <codes>]
    [--http_method {GET,HEAD,POST,PUT,DELETE,TRACE,OPTIONS,CONNECT,PATCH}]
    [--timeout <timeout>]
    --max_retries <max_retries>
    [--url_path <url_path>]
    --type
    {HTTP,HTTPS,PING,TCP,TLS-HELLO,UDP_CONNECT}
    [--enable | --disable]
    <pool>

--name <name>¶: Set the health monitor name.

--delay <delay>¶: Set the time in seconds, between sending probes to members.

--expected_codes <codes>¶: The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values: * A single value, such as 200 * A list, such as 200, 202 * A range, such as 200-204 The default is 200.

--http_method {GET,HEAD,POST,PUT,DELETE,TRACE,OPTIONS,CONNECT,PATCH}¶: The HTTP method that the health monitor uses for requests.One of [GET, HEAD, POST, PUT, DELETE,`TRACE`, OPTIONS, CONNECT, PATCH] Default is GET

--timeout <timeout>¶: 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. A valid value is from 1 to 10.

--url_path <url_path>¶: The HTTP URL path of the request sent by the monitor to test the health of a backend member. Must be a string that begins with a forward slash (/).The default URL path is /.

--type {HTTP,HTTPS,PING,TCP,TLS-HELLO,UDP_CONNECT}¶: The type of health monitor. one of [HTTP, HTTPS, PING, TCP, TLS-HELLO, UDP_CONNECT]

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

loadbalancer healthmonitor delete¶

Delete a health monitor

openstack loadbalancer healthmonitor delete
    <health_monitor>
    [<health_monitor> ...]

health_monitor¶: The ID of the health monitor to delete

This command is provided by the otcextensions plugin.

loadbalancer healthmonitor list¶

List health monitors

openstack loadbalancer healthmonitor list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--type {HTTP,HTTPS,PING,TCP,TLS-HELLO,UDP_CONNECT}]

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--type {HTTP,HTTPS,PING,TCP,TLS-HELLO,UDP_CONNECT}¶: Health monitor type to use as a filter one of [HTTP, HTTPS, PING, TCP, TLS-HELLO, UDP_CONNECT]

This command is provided by the otcextensions plugin.

loadbalancer healthmonitor set¶

Update a health monitor

openstack loadbalancer healthmonitor set
    [--name <name>]
    [--delay <delay>]
    [--expected_codes <expected_codes>]
    [--http_method {GET,HEAD,POST,PUT,DELETE,TRACE,OPTIONS,CONNECT,PATCH}]
    [--timeout <timeout>]
    --max_retries <max_retries>
    [--url_path <url_path>]
    [--enable | --disable]
    <health_monitor>

--name <name>¶: Human-readable name of the resource.

--delay <delay>¶: The time, in seconds, between sending probes to members.

--expected_codes <expected_codes>¶: The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values: * A single value, such as 200 * A list, such as 200, 202 * A range, such as 200-204 The default is 200.

--http_method {GET,HEAD,POST,PUT,DELETE,TRACE,OPTIONS,CONNECT,PATCH}¶: The HTTP method that the health monitor uses for requests.One of [GET, HEAD, POST, PUT, DELETE,`TRACE`, OPTIONS, CONNECT, PATCH] Default is GET

--timeout <timeout>¶: 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. A valid value is from 1 to 10.

--url_path <url_path>¶: The HTTP URL path of the request sent by the monitor to test the health of a backend member. Must be a string that begins with a forward slash (/).The default URL path is /.

--enable¶: Enable health monitor (default).

--disable¶: Disable health monitor.

health_monitor¶: Health monitor to update (name or ID).

This command is provided by the otcextensions plugin.

loadbalancer healthmonitor show¶

Show the details of a single health monitor

openstack loadbalancer healthmonitor show <health_monitor>

health_monitor¶: Name or UUID of the health monitor.

This command is provided by the otcextensions plugin.

last updated: 2023-08-18 10:18