openstack.load_balancer.v2.listener¶
The Listener Class¶
The Listener class inherits from Resource.
-
class
openstack.load_balancer.v2.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.
-
connection_limit¶ The maximum number of connections permitted for this load balancer. Default is infinite.
-
created_at¶ Timestamp when the listener was created.
-
default_pool¶ Default pool to which the requests will be routed.
-
default_pool_id¶ ID of default pool. Must have compatible protocol with listener.
-
default_tls_container_ref¶ A reference to a container of TLS secrets.
-
description¶ Description for the listener.
-
insert_headers¶ Dictionary of additional headers insertion into HTTP header.
-
is_admin_state_up¶ The administrative state of the listener, which is up
Trueor downFalse. Type: bool
-
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
-
name¶ Name of the listener
-
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
-
updated_at¶ Timestamp when the listener was last updated.
-
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.
- _synchronized (bool) – This is not intended to be used directly. See
The ListenerStats Class¶
The ListenerStats class inherits from
Resource.
-
class
openstack.load_balancer.v2.listener.ListenerStats(_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.
-
listener_id¶ The ID of the listener.
-
active_connections¶ The currently active connections.
-
bytes_in¶ The total bytes received.
-
bytes_out¶ The total bytes sent.
-
request_errors¶ The total requests that were unable to be fulfilled.
-
total_connections¶ The total connections handled.
- _synchronized (bool) – This is not intended to be used directly. See
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.