source: | cloud/oracle/oci_load_balancer_listener_facts.py |
---|---|
orphan: |
.. versionadded:: 2.5
- Fetch details of all listeners of a load balancer.
The below requirements are needed on the host that executes this module.
- python >= 2.7
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameter | Choices/Defaults | Comments |
---|---|---|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location . If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location . |
|
load_balancer_id
-
/ required
|
Identifier of the Load Balancer to which the listeners belongs.
aliases: id |
|
name
-
|
The name of the listener whose details needs to be fetched.
|
|
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
#Fetch details of all listener of a load balancer
- name: List all Listeners
oci_load_balancer_listener_facts:
load_balancer_id: 'ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx'
#Fetch details of a specific listener in a load balancer
- name: List a specific Listener
oci_load_balancer_listener_facts:
load_balancer_id: 'ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx'
name: 'ansible_listener'
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
listeners
complex
|
success |
Attributes of Listener.
Sample:
[{'path_route_set_name': 'path_route_set_001', 'protocol': 'HTTP', 'name': 'ansible_listener', 'connection_configuration': {'idle_timeout': 1200}, 'ssl_configuration': {'certificate_name': 'certs1', 'verify_depth': 1, 'verify_peer_certificate': True}, 'hostname_names': ['hostname_001'], 'default_backend_set_name': 'ansible_backend', 'port': 87}]
|
|
connection_configuration
dictionary
|
always |
Configuration details for the connection between the client and backend servers.
Sample:
{'idle_timeout': 1200}
|
|
default_backend_set_name
string
|
always |
The name of the associated backend set
Sample:
ansible_backend_set
|
|
hostname_names
list
|
always |
An array of hostname resource names.
Sample:
['hostname_001']
|
|
name
string
|
always |
Name of the Listener
Sample:
ansible_listener
|
|
path_route_set_name
string
|
always |
The name of the set of path-based routing rules, PathRouteSet, applied to this listener's traffic.
Sample:
path_route_set_001
|
|
port
string
|
always |
The communication port for the listener.
Sample:
80
|
|
protocol
string
|
always |
The protocol on which the listener accepts connection requests.
Sample:
HTTP
|
|
ssl_configuration
dictionary
|
always |
The load balancer SSL handling configuration details
Sample:
{'certificate_name': 'certs1', 'verify_depth': 1, 'verify_peer_certificate': True}
|
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is :ref:`maintained by the Ansible Community <modules_support>`. [community]
- Debayan Gupta(@debayan_gupta)
Hint
If you notice any issues in this documentation you can edit this document to improve it.