listeners

Creates, updates, deletes, gets or lists a listeners resource.

Overview

Name	listeners
Type	Resource
Id	oci.load_balancer.listeners

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	loadBalancerId, region, defaultBackendSetName, name, port, protocol	opc-request-id, opc-retry-token	Adds a listener to a load balancer.
update	update	loadBalancerId, listenerName, region, defaultBackendSetName, port, protocol	opc-request-id, opc-retry-token	Updates a listener for a given load balancer.
delete	delete	loadBalancerId, listenerName, region	opc-request-id	Deletes a listener from a load balancer.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
listenerName	string	The name of the listener to delete. Example: example_listener
loadBalancerId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener to delete.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
opc-request-id	string	The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

INSERT examples

create

Adds a listener to a load balancer.

INSERT INTO oci.load_balancer.listeners (
connectionConfiguration,
defaultBackendSetName,
hostnameNames,
name,
pathRouteSetName,
port,
protocol,
routingPolicyName,
ruleSetNames,
sslConfiguration,
loadBalancerId,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ connectionConfiguration }}',
'{{ defaultBackendSetName }}' /* required */,
'{{ hostnameNames }}',
'{{ name }}' /* required */,
'{{ pathRouteSetName }}',
{{ port }} /* required */,
'{{ protocol }}' /* required */,
'{{ routingPolicyName }}',
'{{ ruleSetNames }}',
'{{ sslConfiguration }}',
'{{ loadBalancerId }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
;

Manifest

# Description fields are for documentation purposes
- name: listeners
props:
  - name: loadBalancerId
    value: "{{ loadBalancerId }}"
    description: Required parameter for the listeners resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the listeners resource.
  - name: connectionConfiguration
    description: |
      Configuration details for the connection between the client and backend servers.
    value:
      backendTcpProxyProtocolOptions:
        - "{{ backendTcpProxyProtocolOptions }}"
      backendTcpProxyProtocolVersion: {{ backendTcpProxyProtocolVersion }}
      idleTimeout: {{ idleTimeout }}
  - name: defaultBackendSetName
    value: "{{ defaultBackendSetName }}"
    description: |
      The name of the associated backend set.
      Example: `example_backend_set`
  - name: hostnameNames
    value:
      - "{{ hostnameNames }}"
    description: |
      An array of hostname resource names.
  - name: name
    value: "{{ name }}"
    description: |
      A friendly name for the listener. It must be unique and it cannot be changed.
      Avoid entering confidential information.
      Example: `example_listener`
  - name: pathRouteSetName
    value: "{{ pathRouteSetName }}"
    description: |
      Deprecated. Please use `routingPolicies` instead.
      The name of the set of path-based routing rules, [PathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/),
      applied to this listener's traffic.
      Example: `example_path_route_set`
  - name: port
    value: {{ port }}
    description: |
      The communication port for the listener.
      Example: `80`
  - name: protocol
    value: "{{ protocol }}"
    description: |
      The protocol on which the listener accepts connection requests.
      To get a list of valid protocols, use the [ListProtocols](#/en/loadbalancer/20170115/LoadBalancerProtocol/ListProtocols)
      operation.
      Example: `HTTP`
  - name: routingPolicyName
    value: "{{ routingPolicyName }}"
    description: |
      The name of the routing policy applied to this listener's traffic.
      Example: `example_routing_policy`
  - name: ruleSetNames
    value:
      - "{{ ruleSetNames }}"
    description: |
      The names of the [rule sets](#/en/loadbalancer/20170115/RuleSet/) to apply to the listener.
      Example: ["example_rule_set"]
  - name: sslConfiguration
    description: |
      The load balancer's SSL handling configuration details.
      **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
    value:
      certificateIds:
        - "{{ certificateIds }}"
      certificateName: "{{ certificateName }}"
      cipherSuiteName: "{{ cipherSuiteName }}"
      protocols:
        - "{{ protocols }}"
      serverOrderPreference: "{{ serverOrderPreference }}"
      trustedCertificateAuthorityIds:
        - "{{ trustedCertificateAuthorityIds }}"
      verifyDepth: {{ verifyDepth }}
      verifyPeerCertificate: {{ verifyPeerCertificate }}
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

UPDATE examples

update

Updates a listener for a given load balancer.

UPDATE oci.load_balancer.listeners
SET 
connectionConfiguration = '{{ connectionConfiguration }}',
defaultBackendSetName = '{{ defaultBackendSetName }}',
hostnameNames = '{{ hostnameNames }}',
pathRouteSetName = '{{ pathRouteSetName }}',
port = {{ port }},
protocol = '{{ protocol }}',
routingPolicyName = '{{ routingPolicyName }}',
ruleSetNames = '{{ ruleSetNames }}',
sslConfiguration = '{{ sslConfiguration }}'
WHERE 
loadBalancerId = '{{ loadBalancerId }}' --required
AND listenerName = '{{ listenerName }}' --required
AND region = '{{ region }}' --required
AND defaultBackendSetName = '{{ defaultBackendSetName }}' --required
AND port = '{{ port }}' --required
AND protocol = '{{ protocol }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND opc-retry-token = '{{ opc-retry-token}}';

DELETE examples

delete

Deletes a listener from a load balancer.

DELETE FROM oci.load_balancer.listeners
WHERE loadBalancerId = '{{ loadBalancerId }}' --required
AND listenerName = '{{ listenerName }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
;