Skip to main content
openstack_lb_pool_v2
Last update:

openstack_lb_pool_v2

For your information

This instruction is a copy of the official OpenStack Terraform provider's OpenStack Terraform documentation in the Terraform Registry.

Manages a V2 pool resource within OpenStack.

carefully

This resource has attributes that depend on octavia minor versions. Please ensure your Openstack cloud supports the required minor version.

Example Usage⁠

resource "openstack_lb_pool_v2" "pool_1" {
  protocol    = "HTTP"
  lb_method   = "ROUND_ROBIN"
  listener_id = "d9415786-5f1a-428b-b35f-2f1523e146d2"

  persistence {
    type        = "APP_COOKIE"
    cookie_name = "testCookie"
  }
}

Argument Reference⁠

The following arguments are supported:

  • region — (Optional) The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, theregion argument of the provider is used. Changing this creates a new pool.

  • tenant_id — (Optional) Required for admins. The UUID of the tenant who owns the pool. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new pool.

  • name — (Optional) Human-readable name for the pool.

  • description — (Optional) Human-readable description for the pool.

  • protocol — (Required) The protocol — can either be TCP, HTTP, HTTPS, PROXY, UDP (supported only in Octavia), PROXYV2 (Octavia minor version >= 2.22) or SCTP (Octavia minor version >= 2.23). Changing this creates a new pool.

  • loadbalancer_id — (Optional) The load balancer on which to provision this pool. Changing this creates a new pool. Note: One of LoadbalancerID or ListenerID must be provided.

  • listener_id — (Optional) The Listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: One of LoadbalancerID or ListenerID must be provided.

  • lb_method — (Required) The load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP, or SOURCE_IP_PORT (supported only by in Octavia).

  • persistence — Omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. Changing this creates a new pool.

  • admin_state_up — (Optional) The administrative state of the pool. A valid value is true (UP) or false (DOWN).

The persistence argument supports:

  • type — (Required) The type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.

  • cookie_name — (Optional) The name of the cookie if persistence mode is set appropriately. Required if type = APP_COOKIE.

Attributes Reference⁠

The following attributes are exported:

  • id — The unique ID for the pool.
  • tenant_id — See Argument Reference above.
  • name — See Argument Reference above.
  • description — See Argument Reference above.
  • protocol — See Argument Reference above.
  • lb_method — See Argument Reference above.
  • persistence — See Argument Reference above.
  • admin_state_up — See Argument Reference above.

Import⁠

Load Balancer Pool can be imported using the Pool ID, e.g.:

$ terraform import openstack_lb_pool_v2.pool_1 60ad9ee4-249a-4d60-a45b-aa60e046c513