otcextensions.sdk.vlb.v3.listener¶
The Listener Class¶
The Listener class inherits from
Resource.
-
class
otcextensions.sdk.vlb.v3.listener.Listener(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()andexisting().connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connectionin Resource code should protect itself with a check for None.
-
allowed_cidrs¶ List of IPv4 or IPv6 CIDRs.
-
client_ca_tls_container_ref¶ Specifies the ID of the CA certificate used by the listener.
-
client_timeout¶ Specifies the timeout duration for waiting for a request from a client, in seconds.
-
connection_limit¶ Specifies the maximum number of connections.
-
created_at¶ Timestamp when the load balancer was created
-
description¶ The listener description
-
default_pool_id¶ Specifies the ID of the default backend server group.
-
default_tls_container_ref¶ Specifies the ID of the server certificate used by the listener.
-
enable_member_retry¶ Specifies whether to enable health check retries for backend servers.
-
enhance_l7policy¶ Specifies whether to enable advanced forwarding.
-
http2_enable¶ Specifies whether to use HTTP/2.
-
insert_headers¶ Dictionary of additional headers insertion into HTTP header.
-
ipgroup¶ Specifies the IP address group associated with the listener.
-
is_admin_state_up¶ The administrative state of the load balancer Type: bool
-
keepalive_timeout¶ Specifies whether to enable health check retries for backend servers.
-
l7_policies¶ List of l7policies associated with this listener.
-
load_balancer_id¶ The ID of the parent load balancer.
-
load_balancers¶ List of load balancers associated with this listener. Type: list of dicts which contain the load balancer IDs
-
member_timeout¶ Specifies the timeout duration for waiting for a request from a backend server, in seconds.
-
operating_status¶ Operating status of the listener.
-
project_id¶ The ID of the project this listener is associated with.
-
protocol¶ The protocol of the listener, which is TCP, HTTP, HTTPS or TERMINATED_HTTPS.
-
protocol_port¶ Port the listener will listen to, e.g. 80.
-
provisioning_status¶ The provisioning status of this listener.
-
sni_container_refs¶ A list of references to TLS secrets. Type: list
Lists the tags.
-
timeout_client_data¶ Frontend client inactivity timeout in milliseconds.
-
timeout_member_connect¶ Backend member connection timeout in milliseconds.
-
timeout_member_data¶ Backend member inactivity timeout in milliseconds.
-
timeout_tcp_inspect¶ Time, in milliseconds, to wait for additional TCP packets for content inspection.
-
tls_ciphers¶ Stores a cipher string in OpenSSL format.
-
tls_ciphers_policy¶ Specifies the security policy that will be used by the listener.
-
tls_versions¶ A lsit of TLS protocols to be used by the listener
-
transparent_ip¶ Specifies whether to pass source IP addresses of the clients to backend servers.
-
updated_at¶ Timestamp when the listener was last updated.