Try SpotterManage an ExternalListener resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0This module allows the user to update an ExternalListener resource in Oracle Cloud Infrastructure
- name: Update external_listener
oci_database_management_external_listener:
# required
external_listener_id: "ocid1.externallistener.oc1..xxxxxxEXAMPLExxxxxx"
# optional
external_connector_id: "ocid1.externalconnector.oc1..xxxxxxEXAMPLExxxxxx"
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
state:
choices:
- present
default: present
description:
- The state of the ExternalListener.
- Use I(state=present) to update an existing an ExternalListener.
required: false
type: str
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
external_listener_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external listener.
required: true
type: str
external_connector_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external connector.
- This parameter is updatable.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
external_listener:
contains:
additional_details:
description:
- 'The additional details of the external listener defined in `{"key": "value"}`
format. Example: `{"bar-key": "value"}`'
returned: on success
sample: {}
type: dict
adr_home_directory:
description:
- The directory that stores tracing and logging incidents when Automatic Diagnostic
Repository (ADR) is enabled.
returned: on success
sample: adr_home_directory_example
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
component_name:
description:
- The name of the external listener.
returned: on success
sample: component_name_example
type: str
display_name:
description:
- The user-friendly name for the external listener. The name does not have to
be unique.
returned: on success
sample: display_name_example
type: str
endpoints:
contains:
host:
description:
- The host name or IP address.
returned: on success
sample: host_example
type: str
key:
description:
- The unique name of the service.
returned: on success
sample: key_example
type: str
port:
description:
- The port number.
returned: on success
sample: 56
type: int
protocol:
description:
- The listener protocol.
returned: on success
sample: IPC
type: str
services:
description:
- The list of services registered with the listener.
returned: on success
sample: []
type: list
description:
- The list of protocol addresses the listener is configured to listen on.
returned: on success
type: complex
external_connector_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external connector.
returned: on success
sample: ocid1.externalconnector.oc1..xxxxxxEXAMPLExxxxxx
type: str
external_db_home_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external DB home.
returned: on success
sample: ocid1.externaldbhome.oc1..xxxxxxEXAMPLExxxxxx
type: str
external_db_node_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external DB node.
returned: on success
sample: ocid1.externaldbnode.oc1..xxxxxxEXAMPLExxxxxx
type: str
external_db_system_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external DB system that the listener is a part of.
returned: on success
sample: ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx
type: str
host_name:
description:
- The name of the host on which the external listener is running.
returned: on success
sample: host_name_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external listener.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_details:
description:
- Additional information about the current lifecycle state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current lifecycle state of the external listener.
returned: on success
sample: CREATING
type: str
listener_alias:
description:
- The listener alias.
returned: on success
sample: listener_alias_example
type: str
listener_ora_location:
description:
- The location of the listener configuration file listener.ora.
returned: on success
sample: listener_ora_location_example
type: str
listener_type:
description:
- The type of listener.
returned: on success
sample: ASM
type: str
log_directory:
description:
- The destination directory of the listener log file.
returned: on success
sample: log_directory_example
type: str
oracle_home:
description:
- The Oracle home location of the listener.
returned: on success
sample: oracle_home_example
type: str
serviced_asms:
contains:
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment in which the external ASM resides.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
display_name:
description:
- The user-friendly name for the external ASM. The name does not have to
be unique.
returned: on success
sample: display_name_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external ASM.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- The list of ASMs that are serviced by the listener.
returned: on success
type: complex
serviced_databases:
contains:
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment in which the external database resides.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
database_sub_type:
description:
- The subtype of Oracle Database. Indicates whether the database is a Container
Database, Pluggable Database, Non-container Database, Autonomous Database,
or Autonomous Container Database.
returned: on success
sample: CDB
type: str
database_type:
description:
- The type of Oracle Database installation.
returned: on success
sample: EXTERNAL_SIDB
type: str
db_unique_name:
description:
- The unique name of the external database.
returned: on success
sample: db_unique_name_example
type: str
display_name:
description:
- The user-friendly name for the database. The name does not have to be
unique.
returned: on success
sample: display_name_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external database.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
is_managed:
description:
- Indicates whether the database is a Managed Database or not.
returned: on success
sample: true
type: bool
description:
- The list of databases that are serviced by the listener.
returned: on success
type: complex
time_created:
description:
- The date and time the external listener was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The date and time the external listener was last updated.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
trace_directory:
description:
- The destination directory of the listener trace file.
returned: on success
sample: trace_directory_example
type: str
version:
description:
- The listener version.
returned: on success
sample: version_example
type: str
description:
- Details of the ExternalListener resource acted upon by the current operation
returned: on success
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
type: complex