openstack_lb_listener_v2
These instructions are a copy of the official OpenStack Terraform provider documentation in the Terraform Registry.
Manages a V2 listener resource within OpenStack.
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_listener_v2" "listener_1" {
protocol = "HTTP"
protocol_port = 8080
loadbalancer_id = "d9415786-5f1a-428b-b35f-2f1523e146d2"
insert_headers = {
X-Forwarded-For = "true"
}
}
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 a . If omitted, theregion
argument of the provider is used. Changing this creates a newListener. -
protocol
— (Required) The protocol — can either be TCP, HTTP, HTTPS,TERMINATED_HTTPS, UDP (supported only in Octavia), SCTP (supported only in Octavia), SCTP (supported only in Octavia minor version). **Octavia minor version >= 2.23 **) or PROMETHEUS (supported only in **Octavia minor version >=2.25 **). Changing this creates a new Listener. -
protocol_port
— (Required) The port on which to listen for client traffic.Changing this creates a new Listener. -
tenant_id
— (Optional) Required for admins. The UUID of the tenant who ownssthe Listener.Only administrative users can specify a tenant UUIDother than their own. Changing this creates a new Listener. -
loadbalancer_id
— (Required) The load balancer on which to provision thisListener. Changing this creates a new Listener. -
name
— (Optional) Human-readable name for the Listener. Does not haveto be unique. -
default_pool_id
— (Optional) The ID of the default pool with which theListener is associated. -
description
— (Optional) Human-readable description for the Listener. -
connection_limit
— (Optional) The maximum number of connections allowedfor the Listener. -
timeout_client_data
— (Optional) The client inactivity timeout in milliseconds. -
timeout_member_connect
— (Optional) The member connection timeout in milliseconds. -
timeout_member_data
— (Optional) The member inactivity timeout in milliseconds. -
timeout_tcp_inspect
— (Optional) The time in milliseconds to wait for additionalTCP packets for content inspection. -
default_tls_container_ref
— (Optional) A reference to a Barbican Secretscontainer which stores TLS information. This is required if the protocolisTERMINATED_HTTPS
. See here for more information. -
sni_container_refs
— (Optional) A list of references to Barbican Secretscontainers which store SNI information. See here for more information. -
admin_state_up
— (Optional) The administrative state of the Listener.A valid value is true (UP) or false (DOWN). -
insert_headers
— (Optional) The list of key value pairs representing headers to insert the request before it is sent to the backend members. Changing this updates the headers of theexisting listener. -
allowed_cidrs
— (Optional) A list of CIDR blocks that are allowed to connect to this listener, denyingall other source addresses. If not present, defaults to allow all.
Attributes Reference
The following attributes are exported:
id
— The unique ID for the Listener.protocol
— See Argument Reference above.protocol_port
— See Argument Reference above.tenant_id
— See Argument Reference above.name
— See Argument Reference above.default_port_id
— See Argument Reference above.description
— See Argument Reference above.connection_limit
— See Argument Reference above.timeout_client_data
— See Argument Reference above.timeout_member_connect
— See Argument Reference above.timeout_member_data
— See Argument Reference above.timeout_tcp_inspect
— See Argument Reference above.default_tls_container_ref
— See Argument Reference above.sni_container_refs
— See Argument Reference above.admin_state_up
— See Argument Reference above.insert_headers
— See Argument Reference above.allowed_cidrs
— See Argument Reference above.
Import
Load Balancer Listener can be imported using the Listener ID, e.g.:
$ terraform import openstack_lb_listener_v2.listener_1 b67ce64e-8b26-405d-afeb-4a078901f15a