oracle.oci.oci_database_management_external_listener_facts – Fetches details about one or multiple ExternalListener resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_database_management_external_listener_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ExternalListener resources in Oracle Cloud Infrastructure
Lists the listeners in the specified external DB system.
If external_listener_id is specified, the details of a single ExternalListener will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
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_ID 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_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
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. |
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|
compartment_id
string
|
The OCID of the compartment.
|
|
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 . |
|
display_name
string
|
A filter to only return the resources that match the entire display name.
aliases: name |
|
external_db_system_id
string
|
The OCID of the external DB system.
|
|
external_listener_id
string
|
The OCID of the external listener.
Required to get a specific external_listener.
aliases: id |
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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. |
|
sort_by
string
|
|
The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive.
|
sort_order
string
|
|
The option to sort information in ascending ('ASC') or descending ('DESC') order. Ascending order is the default order.
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific external_listener
oci_database_management_external_listener_facts:
# required
external_listener_id: "ocid1.externallistener.oc1..xxxxxxEXAMPLExxxxxx"
- name: List external_listeners
oci_database_management_external_listener_facts:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
external_db_system_id: "ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
sort_by: TIMECREATED
sort_order: ASC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
external_listeners
complex
|
on success |
List of ExternalListener resources
Sample:
[{'additional_details': {}, 'adr_home_directory': 'adr_home_directory_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'component_name': 'component_name_example', 'display_name': 'display_name_example', 'endpoints': [{'host': 'host_example', 'key': 'key_example', 'port': 56, 'protocol': 'IPC', 'services': []}], 'external_connector_id': 'ocid1.externalconnector.oc1..xxxxxxEXAMPLExxxxxx', 'external_db_home_id': 'ocid1.externaldbhome.oc1..xxxxxxEXAMPLExxxxxx', 'external_db_node_id': 'ocid1.externaldbnode.oc1..xxxxxxEXAMPLExxxxxx', 'external_db_system_id': 'ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'host_name': 'host_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'listener_alias': 'listener_alias_example', 'listener_ora_location': 'listener_ora_location_example', 'listener_type': 'ASM', 'log_directory': 'log_directory_example', 'oracle_home': 'oracle_home_example', 'serviced_asms': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}], 'serviced_databases': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_sub_type': 'CDB', 'database_type': 'EXTERNAL_SIDB', 'db_unique_name': 'db_unique_name_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_managed': True}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'trace_directory': 'trace_directory_example', 'version': 'version_example'}]
|
||
additional_details
dictionary
|
on success |
The additional details of the external listener defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}`
Returned for get operation
|
||
adr_home_directory
string
|
on success |
The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
Returned for get operation
Sample:
adr_home_directory_example
|
||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
component_name
string
|
on success |
The name of the external listener.
Sample:
component_name_example
|
||
display_name
string
|
on success |
The user-friendly name for the external listener. The name does not have to be unique.
Sample:
display_name_example
|
||
endpoints
complex
|
on success |
The list of protocol addresses the listener is configured to listen on.
Returned for get operation
|
||
host
string
|
on success |
The host name or IP address.
Sample:
host_example
|
||
key
string
|
on success |
The unique name of the service.
Sample:
key_example
|
||
port
integer
|
on success |
The port number.
Sample:
56
|
||
protocol
string
|
on success |
The listener protocol.
Sample:
IPC
|
||
services
list
/ elements=string
|
on success |
The list of services registered with the listener.
|
||
external_connector_id
string
|
on success |
The OCID of the external connector.
Sample:
ocid1.externalconnector.oc1..xxxxxxEXAMPLExxxxxx
|
||
external_db_home_id
string
|
on success |
The OCID of the external DB home.
Returned for get operation
Sample:
ocid1.externaldbhome.oc1..xxxxxxEXAMPLExxxxxx
|
||
external_db_node_id
string
|
on success |
The OCID of the external DB node.
Sample:
ocid1.externaldbnode.oc1..xxxxxxEXAMPLExxxxxx
|
||
external_db_system_id
string
|
on success |
The OCID of the external DB system that the listener is a part of.
Sample:
ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx
|
||
host_name
string
|
on success |
The name of the host on which the external listener is running.
Returned for get operation
Sample:
host_name_example
|
||
id
string
|
on success |
The OCID of the external listener.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_details
string
|
on success |
Additional information about the current lifecycle state.
Sample:
lifecycle_details_example
|
||
lifecycle_state
string
|
on success |
The current lifecycle state of the external listener.
Sample:
CREATING
|
||
listener_alias
string
|
on success |
The listener alias.
Returned for get operation
Sample:
listener_alias_example
|
||
listener_ora_location
string
|
on success |
The location of the listener configuration file listener.ora.
Returned for get operation
Sample:
listener_ora_location_example
|
||
listener_type
string
|
on success |
The type of listener.
Sample:
ASM
|
||
log_directory
string
|
on success |
The destination directory of the listener log file.
Returned for get operation
Sample:
log_directory_example
|
||
oracle_home
string
|
on success |
The Oracle home location of the listener.
Returned for get operation
Sample:
oracle_home_example
|
||
serviced_asms
complex
|
on success |
The list of ASMs that are serviced by the listener.
Returned for get operation
|
||
compartment_id
string
|
on success |
The OCID of the compartment in which the external ASM resides.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
display_name
string
|
on success |
The user-friendly name for the external ASM. The name does not have to be unique.
Sample:
display_name_example
|
||
id
string
|
on success |
The OCID of the external ASM.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
serviced_databases
complex
|
on success |
The list of databases that are serviced by the listener.
Returned for get operation
|
||
compartment_id
string
|
on success |
The OCID of the compartment in which the external database resides.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
database_sub_type
string
|
on success |
The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
Sample:
CDB
|
||
database_type
string
|
on success |
The type of Oracle Database installation.
Sample:
EXTERNAL_SIDB
|
||
db_unique_name
string
|
on success |
The unique name of the external database.
Sample:
db_unique_name_example
|
||
display_name
string
|
on success |
The user-friendly name for the database. The name does not have to be unique.
Sample:
display_name_example
|
||
id
string
|
on success |
The OCID of the external database.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
is_managed
boolean
|
on success |
Indicates whether the database is a Managed Database or not.
Sample:
True
|
||
time_created
string
|
on success |
The date and time the external listener was created.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The date and time the external listener was last updated.
Sample:
2013-10-20T19:20:30+01:00
|
||
trace_directory
string
|
on success |
The destination directory of the listener trace file.
Returned for get operation
Sample:
trace_directory_example
|
||
version
string
|
on success |
The listener version.
Returned for get operation
Sample:
version_example
|
Authors¶
Oracle (@oracle)