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() and existing().

• 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.

resource_key: ty.Optional[str] = 'listener'

Singular form of key for resource.

resources_key: ty.Optional[str] = 'listeners'

Plural form of key for resource.

base_path: str = '/elb/listeners'

The base part of the URI for this resource.

allow_create = True

Allow create operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_commit = True

Allow update operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_list = True

Allow list operation for this resource.

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.

created_at

Timestamp when the load balancer was created

connection_limit

Specifies the maximum number of connections.

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.

is_admin_state_up

Specifies the administrative status of the listener.

load_balancers

List of load balancers associated with this listener. Type: list of dicts which contain the load balancer IDs

loadbalancer_id

Specifies the ID of the load balancer that the listener is added to.

ipgroup

Specifies the IP address group associated with the listener.

name: ty.Union[Body, URI]

Name of the listener.

keepalive_timeout

Specifies whether to enable health check retries for backend servers.

member_timeout

Specifies the timeout duration for waiting for a request from a backend server, in seconds.

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.

project_id

The ID of the project this listener is associated with.

security_policy_id

Specifies the ID of the custom security policy.

sni_container_refs

A list of references to TLS secrets. Type: list

tags

Lists the tags.

tls_ciphers_policy

Specifies the security policy that will be used by the listener.

updated_at

Timestamp when the listener was last updated.

last updated: UTC - commit: