loadbalancer¶

loadbalancer list¶

List load balancers

openstack loadbalancer list
    [--name <name>]
    [--enable | --disable]
    [--project <project-id>]

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

loadbalancer show¶

Show the details for a single load balancer

openstack loadbalancer show
    <loadbalancer>

<load_balancer>: Name or UUID of the load balancer.

loadbalancer create¶

Create a load balancer

openstack loadbalancer create
    [--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>]
    [--project <project>]
    [--enable | --disable]

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

--project <project>¶: Project for the load balancer (name or ID).

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

--disable¶: Disable load balancer.

loadbalancer set¶

Update a load balancer

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

<load_balancer>: Name or UUID of the load balancer to update.

--enable¶: Enable load balancer.

--disable¶: Disable load balancer.

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

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

loadbalancer delete¶

Delete a load balancer

openstack loadbalancer delete
    [--cascade]
    <load_balancer>

<loadbalancer>: Load balancers to delete (name or ID).

--cascade¶: Cascade the delete to all child elements of the load balancer.

listener¶

loadbalancer listener list¶

List listeners

openstack loadbalancer listener list
    [--name <name>]
    [--enable | --disable]
    [--project <project>]

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

--enable¶: List enabled listeners.

--disable¶: List disabled listeners.

--project <project>¶: List listeners by project ID.

loadbalancer listener show¶

Show the details of a single listener

openstack loadbalancer listener show
    <listener>

<listener>: Name or UUID of the listener

loadbalancer listener create¶

Create a listener

openstack loadbalancer listener create
    [--description <description>]
    --protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS}
    [--connection-limit <limit>]
    [--default-pool <pool>]
    [--default-tls-container-ref <container-ref>]
    [--sni-container-refs [<container-ref> [<container-ref> ...]]]
    [--insert-headers <header=value,...>]
    --protocol-port <port>
    [--enable | --disable]
    <load_balancer>

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

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

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS}¶: The protocol for the listener.

--connection-limit <limit>¶: The maximum number of connections permitted for this listener.

--default-pool <pool>¶: The name or ID of the pool used by the listener if no L7 policies match.

--default-tls-container-ref <container-ref>¶: The URI to the key manager service secrets container containing the certificate and key for TERMINATED_TLS listeners.

--sni-container-refs [<container-ref> [<container-ref> …]]¶: A list of URIs to the key manager service secrets containers containing the certificates and keys for TERMINATED_TLS the listener using Server Name Indication.

--insert-headers <header=value,…>¶: A dictionary of optional headers to insert into the request before it is sent to the backend member.

--protocol-port <port>¶: Set the protocol port number for the listener.

--enable¶: Enable listener (default).

--disable¶: Disable listener.

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

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

<listener>: Listener to modify (name or ID).

--name <name>¶: Set 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-id>¶: 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_TLS listeners.

---sni-container-refs [<container-ref> [<container-ref> …]]¶: A list of URIs to the key manager service secrets containers containing the certificates and keys for TERMINATED_TLS the listener using Server Name Indication.

--insert-headers <header=value>¶: A dictionary of optional headers to insert into the request before it is sent to the backend member.

--enable¶: Enable listener.

--disable¶: Disable listener.

loadbalancer listener delete¶

Delete a listener

openstack loadbalancer listener delete
    <listener>

<listener>: Listener to delete (name or ID).

pool¶

loadbalancer pool list¶

List pools

openstack loadbalancer pool list

loadbalancer pool show¶

Show the details of a single pool

openstack loadbalancer pool show
    <pool>

<pool>: Name or UUID of the pool.

loadbalancer pool create¶

Create a pool

openstack loadbalancer pool create
    [--name <name>]
    [--description <description>]
    --protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY}
    [--listener <listener>]
    [--loadbalancer <load_balancer>]
    [--session-persistence <session persistence>]
    --lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}
    [--project <project>]
    [--enable | --disable]

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

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

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY}¶: Set the pool protocol.

--listener <listener>¶: Listener to add the pool to (name or ID).

--loadbalancer <load_balancer>¶: Load balancer 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.

--project <project>¶: Set the project owning this pool (name or ID).

--enable¶: Enable pool (default).

--disable¶: Disable pool.

loadbalancer pool set¶

Update a pool

openstack loadbalancer pool set
    [--name <name>]
    [--description <description>]
    [--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY}]
    [--loadbalancer <load_balancer>]
    [--listener <listener>]
    [--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.

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY}¶: Set protocol for the pool.

--loadbalancer <load_balancer>¶: Load balncer to add the pool to (name or ID).

--listener <listener>¶: Listener 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}¶: Set the load balancing algorithm to use.

--enable¶: Enable pool.

--disable¶: Disable pool.

<pool>: Pool to update (name or ID).

loadbalancer pool delete¶

Delete a pool

openstack loadbalancer pool delete
    <pool>

<pool>: Pool to delete (name or ID).

member¶

loadbalancer member list¶

List members in a pool

openstack loadbalancer member list
    <pool>

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

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.

loadbalancer member create¶

Creating a member in a pool

openstack loadbalancer member create
    [--name <name>]
    [--weight <weight>]
    --address <ip_address>
    [--subnet-id <subnet_id>]
    --protocol-port <protocol_port>
    [--monitor-port <monitor_port>]
    [--monitor-address <monitor_address>]
    [--enable | --disable]
    <pool>

--name <name>¶: Set the 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 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.

loadbalancer member set¶

Update a member

openstack loadbalancer member set
    [--name <name>]
    [--weight <weight>]
    [--address <ip_address>]
    [--subnet-id <subnet_id>]
    [--protocol-port <protocol_port>]
    [--monitor-port <monitor_port>]
    [--monitor-address <monitor_address>]
    [--enable | --disable]
    <pool>
    <member>

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

--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¶: Enable the member.

--disable¶: Disbale the member.

<pool>: Pool that the member to update belongs to (name or ID).

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

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>: ID or name of the member to update.

l7policy¶

loadbalancer l7policy list¶

List l7policies

openstack loadbalancer l7policy list

loadbalancer l7policy show¶

Show the details of a single l7policy

openstack loadbalancer l7policy show
    <policy>

<policy>: Name or UUID of the l7policy.

loadbalancer l7policy create¶

Create a l7policy

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

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

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

--redirect-pool <pool>¶: Set the pool to redirect requests to (name or ID).

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}¶: Set the action of the policy.

--redirect-url <url>¶: Set the URL to redirect requests to.

--position <position>¶: Sequence number of this L7 Policy.

--enable¶: Enable l7policy (default).

--disable¶: Disable l7policy.

<listener>: Listener to add l7policy to (name or ID).

loadbalancer l7policy set¶

Update a l7policy

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

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

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

--redirect-pool <pool>¶: Set the pool to redirect requests to (name or ID).

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}¶: Set the action of the policy.

--redirect-url <url>¶: Set the URL to redirect requests to.

--position <position>¶: Set sequence number of this L7 Policy.

--enable¶: Enable l7policy.

--disable¶: Disable l7policy.

<policy>: L7policy to update (name or ID).

loadbalancer l7policy delete¶

Delete a l7policy

openstack loadbalancer l7policy delete
    <policy>

<policy>: L7policy to delete (name or ID).

l7rule¶

loadbalancer l7rule list¶

List l7rules for l7policy

openstack loadbalancer l7rule list
    --l7policy <l7policy>

<l7policy>: l7policy to list rules for (name or ID).

loadbalancer l7rule show¶

Show the details of a single l7rule

openstack loadbalancer l7rule show
    <l7policy>
    <rule-id>

<l7policy>: l7policy to show rule from (name or ID)

<l7rule_id>: l7rule to show

loadbalancer l7rule create¶

Create a l7rule

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

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

--project <project>¶: Project for the l7rule (name or ID).

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

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}]
    [--enable | --disable]
    --l7policy <policy>
    <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

loadbalancer l7rule delete¶

openstack loadbalancer l7rule delete
    <l7policy>
    <rule_id>

<l7policy>: l7policy to delete rule from (name or ID).

<l7rule_id>: l7rule to delete.

healthmonitor¶

loadbalancer healthmonitor list¶

List health monitors

openstack loadbalancer healthmonitor list

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.

loadbalancer healthmonitor create¶

Create a health monitor

openstack loadbalancer healthmonitor create
    [--name <name>]
    --delay <delay>
    [--expected-codes <codes>]
    [--http_method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
    --timeout <timeout>
    --max-retries <max_retries>
    [--url-path <url_path>]
    --type {PING,HTTP,TCP,HTTPS}
    [--max-retries-down <max_retries_down>]
    [--project <project>]
    [--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>¶: 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}¶: Set the type of health monitor.

--max-retries-down <max_retries_down>¶: Set the number of allowed check failures before changing the operating status of the member to ERROR.

--project <project>¶: Project to use for the health monitor (name or ID).

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

--disable¶: Disable health monitor.

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

loadbalancer healthmonitor set¶

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>]
    [--type {PING,HTTP,TCP,HTTPS}]
    [--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>¶: 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.

--type {PING,HTTP,TCP,HTTPS}¶: Set the type of health monitor.

--enable¶: Enable health monitor.

--disable¶: Disable health monitor.

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

loadbalancer healthmonitor delete¶

Delete a health monitor

openstack loadbalancer healthmonitor delete
    <health_monitor>

<health_monitor>: Health monitor to delete (name or ID).

OpenStack