openstack.network.v2.listener¶
The Listener Class¶
The Listener
class inherits from Resource
.
-
class
openstack.network.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._connection
in 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.
-
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.
-
is_admin_state_up
¶ The administrative state of the listener, which is up
True
or downFalse
. Type: bool
-
load_balancer_ids
¶ List of load balancers associated with this listener. Type: list of dicts which contain the load balancer IDs
-
load_balancer_id
¶ The ID of the load balancer associated with this listener.
-
name
¶ Name 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.
-
sni_container_refs
¶ A list of references to TLS secrets. Type: list