openstack.network.v2.listener¶
The Listener Class¶
The Listener
class inherits from Resource
.
-
class
openstack.network.v2.listener.
Listener
(attrs=None, loaded=False)¶ Construct a Resource to interact with a service’s REST API.
The Resource class offers two class methods to construct resource objects, which are preferrable to entering through this initializer. See
Resource.new()
andResource.existing()
.Parameters: -
connection_limit
= None¶ The maximum number of connections permitted for this load balancer. Default is infinite.
-
default_pool_id
= None¶ ID of default pool. Must have compatible protocol with listener.
-
default_tls_container_ref
= None¶ A reference to a container of TLS secrets.
-
description
= None¶ Description for the listener.
-
is_admin_state_up
= None¶ The administrative state of the listener, which is up
True
or downFalse
. Type: bool
-
load_balancer_ids
= None¶ List of load balancers associated with this listener. Type: list of dicts which contain the load balancer IDs
-
name
= None¶ Name of the listener
-
project_id
= None¶ The ID of the project this listener is associated with.
-
protocol
= None¶ The protocol of the listener, which is TCP, HTTP, HTTPS or TERMINATED_HTTPS.
-
protocol_port
= None¶ Port the listener will listen to, e.g. 80.
-
sni_container_refs
= None¶ A list of references to TLS secrets. Type: list
-