Try SpotterManage an ExternalDbSystemDiscovery 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 create, update, patch and delete an ExternalDbSystemDiscovery resource in Oracle Cloud Infrastructure
For I(state=present), creates an external DB system discovery resource and initiates the discovery process.
- name: Create external_db_system_discovery
oci_database_management_external_db_system_discovery:
# required
agent_id: "ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
- name: Update external_db_system_discovery
oci_database_management_external_db_system_discovery:
# required
external_db_system_discovery_id: "ocid1.externaldbsystemdiscovery.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
- name: Update external_db_system_discovery using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_management_external_db_system_discovery:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
- name: Delete external_db_system_discovery
oci_database_management_external_db_system_discovery:
# required
external_db_system_discovery_id: "ocid1.externaldbsystemdiscovery.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete external_db_system_discovery using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_management_external_db_system_discovery:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
items:
description:
- A sequence of instructions to apply to the resource.
elements: dict
suboptions:
operation:
choices:
- MERGE
description:
- The type of operation.
required: true
type: str
selection:
description:
- The set of values to which the operation applies as a L(JMESPath expression,https://jmespath.org/specification.html)
for evaluation against the context resource. An operation fails if the selection
yields an exception, except as otherwise specified. Note that comparisons involving
non-primitive values (objects or arrays) are not supported and will always evaluate
to false.
required: true
type: str
value:
description:
- A value to be merged into the target.
type: dict
type: list
state:
choices:
- present
- absent
default: present
description:
- The state of the ExternalDbSystemDiscovery.
- Use I(state=present) to create or update an ExternalDbSystemDiscovery.
- Use I(state=absent) to delete an ExternalDbSystemDiscovery.
required: false
type: str
key_by:
description: The list of attributes of this resource which should be used to uniquely
identify an instance of the resource. By default, all the attributes of a resource
are used to uniquely identify a resource.
elements: str
type: list
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
agent_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the management agent used for the external DB system discovery.
- Required for create using I(state=present).
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
display_name:
aliases:
- name
description:
- The user-friendly name for the DB system. The name does not have to be unique.
- Required for create, update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is set.
- This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set.
type: str
force_create:
default: false
description: Whether to attempt non-idempotent creation of a resource. By default,
create resource is an idempotent operation, and doesn't create the resource if it
already exists. Setting this option to true, forcefully creates a copy of the resource,
even if it already exists.This option is mutually exclusive with I(key_by).
type: bool
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
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment in which the external DB system resides.
- Required for create using I(state=present).
- Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
- Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
type: str
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
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
external_db_system_discovery_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external DB system discovery.
- Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
- Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
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_db_system_discovery:
contains:
agent_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the management agent used for the external DB system discovery.
returned: on success
sample: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
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
discovered_components:
contains:
adr_home_directory:
description:
- The Automatic Diagnostic Repository (ADR) home directory for the ASM instance.
returned: on success
sample: adr_home_directory_example
type: str
asm_instances:
contains:
adr_home_directory:
description:
- The Automatic Diagnostic Repository (ADR) home directory for the ASM
instance.
returned: on success
sample: adr_home_directory_example
type: str
associated_components:
contains:
association_type:
description:
- The association type.
returned: on success
sample: CONTAINS
type: str
component_id:
description:
- The identifier of the associated component.
returned: on success
sample: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
type: str
component_type:
description:
- The type of associated component.
returned: on success
sample: ASM
type: str
description:
- The list of associated components.
returned: on success
type: complex
component_id:
description:
- The identifier of the discovered DB system component.
returned: on success
sample: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
type: str
component_name:
description:
- The name of the discovered DB system component.
returned: on success
sample: component_name_example
type: str
component_type:
description:
- The external DB system component type.
returned: on success
sample: ASM
type: str
display_name:
description:
- The user-friendly name for the discovered DB system component. The
name does not have to be unique.
returned: on success
sample: display_name_example
type: str
host_name:
description:
- The name of the host on which the ASM instance is running.
returned: on success
sample: host_name_example
type: str
instance_name:
description:
- The name of the ASM instance.
returned: on success
sample: instance_name_example
type: str
is_selected_for_monitoring:
description:
- Indicates whether the DB system component should be provisioned as
an OCI resource or not.
returned: on success
sample: true
type: bool
resource_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the existing OCI resource matching the discovered DB system component.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
status:
description:
- The state of the discovered DB system component.
returned: on success
sample: NEW
type: str
description:
- ''
returned: on success
type: complex
associated_components:
contains:
association_type:
description:
- The association type.
returned: on success
sample: CONTAINS
type: str
component_id:
description:
- The identifier of the associated component.
returned: on success
sample: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
type: str
component_type:
description:
- The type of associated component.
returned: on success
sample: ASM
type: str
description:
- The list of associated components.
returned: on success
type: complex
cluster_id:
description:
- The unique identifier of the Oracle cluster.
returned: on success
sample: ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx
type: str
cluster_instances:
contains:
adr_home_directory:
description:
- The Automatic Diagnostic Repository (ADR) home directory for the cluster
instance.
returned: on success
sample: adr_home_directory_example
type: str
associated_components:
contains:
association_type:
description:
- The association type.
returned: on success
sample: CONTAINS
type: str
component_id:
description:
- The identifier of the associated component.
returned: on success
sample: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
type: str
component_type:
description:
- The type of associated component.
returned: on success
sample: ASM
type: str
description:
- The list of associated components.
returned: on success
type: complex
cluster_id:
description:
- The unique identifier of the Oracle cluster.
returned: on success
sample: ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx
type: str
component_id:
description:
- The identifier of the discovered DB system component.
returned: on success
sample: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
type: str
component_name:
description:
- The name of the discovered DB system component.
returned: on success
sample: component_name_example
type: str
component_type:
description:
- The external DB system component type.
returned: on success
sample: ASM
type: str
connector:
contains:
agent_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the management agent used for the external DB system connector.
returned: on success
sample: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
type: str
connection_failure_message:
description:
- The error message indicating the reason for connection failure
or `null` if the connection was successful.
returned: on success
sample: connection_failure_message_example
type: str
connection_info:
contains:
component_type:
description:
- The component type.
returned: on success
sample: DATABASE
type: str
connection_credentials:
contains:
credential_name:
description:
- The name of the credential information that used to connect
to the DB system resource. The name should be in "x.y"
format, where the length of "x" has a maximum of 64 characters,
and length of "y" has a maximum of 199 characters. The
name strings can contain letters, numbers and the underscore
character only. Other characters are not valid, except
for the "." character that separates the "x" and "y" portions
of the name. *IMPORTANT* - The name must be unique within
the OCI region the credential is being created in. If
you specify a name that duplicates the name of another
credential within the same OCI region, you may overwrite
or corrupt the credential that is already using the name.
- 'For example: inventorydb.abc112233445566778899'
returned: on success
sample: credential_name_example
type: str
credential_type:
description:
- The type of credential used to connect to the ASM instance.
returned: on success
sample: NAME_REFERENCE
type: str
password_secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the user password.
returned: on success
sample: ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
type: str
role:
description:
- The role of the user connecting to the ASM instance.
returned: on success
sample: SYSASM
type: str
ssl_secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the SSL keystore and truststore
details.
returned: on success
sample: ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
type: str
user_name:
description:
- The user name used to connect to the ASM instance.
returned: on success
sample: user_name_example
type: str
description:
- ''
returned: on success
type: complex
connection_string:
contains:
host_name:
description:
- The host name of the database or the SCAN name in case
of a RAC database.
returned: on success
sample: host_name_example
type: str
hosts:
description:
- The list of host names of the ASM instances.
returned: on success
sample: []
type: list
port:
description:
- The port used to connect to the ASM instance.
returned: on success
sample: 56
type: int
protocol:
description:
- The protocol used to connect to the ASM instance.
returned: on success
sample: TCP
type: str
service:
description:
- The service name of the ASM instance.
returned: on success
sample: service_example
type: str
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
connection_status:
description:
- The status of connectivity to the external DB system component.
returned: on success
sample: connection_status_example
type: str
connector_type:
description:
- The type of connector.
returned: on success
sample: MACS
type: str
display_name:
description:
- The user-friendly name for the external connector. The name does
not have to be unique.
returned: on success
sample: display_name_example
type: str
time_connection_status_last_updated:
description:
- The date and time the connectionStatus of the external DB system
connector was last updated.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- ''
returned: on success
type: complex
crs_base_directory:
description:
- The Oracle base location of Cluster Ready Services (CRS).
returned: on success
sample: crs_base_directory_example
type: str
display_name:
description:
- The user-friendly name for the discovered DB system component. The
name does not have to be unique.
returned: on success
sample: display_name_example
type: str
host_name:
description:
- The name of the host on which the cluster instance is running.
returned: on success
sample: host_name_example
type: str
is_selected_for_monitoring:
description:
- Indicates whether the DB system component should be provisioned as
an OCI resource or not.
returned: on success
sample: true
type: bool
node_role:
description:
- The role of the cluster node.
returned: on success
sample: HUB
type: str
resource_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the existing OCI resource matching the discovered DB system component.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
status:
description:
- The state of the discovered DB system component.
returned: on success
sample: NEW
type: str
description:
- ''
returned: on success
type: complex
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_id:
description:
- The identifier of the discovered DB system component.
returned: on success
sample: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
type: str
component_name:
description:
- The name of the discovered DB system component.
returned: on success
sample: component_name_example
type: str
component_type:
description:
- The external DB system component type.
returned: on success
sample: ASM
type: str
connector:
contains:
agent_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the management agent used for the external DB system connector.
returned: on success
sample: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
type: str
connection_failure_message:
description:
- The error message indicating the reason for connection failure or
`null` if the connection was successful.
returned: on success
sample: connection_failure_message_example
type: str
connection_info:
contains:
component_type:
description:
- The component type.
returned: on success
sample: DATABASE
type: str
connection_credentials:
contains:
credential_name:
description:
- The name of the credential information that used to connect
to the DB system resource. The name should be in "x.y" format,
where the length of "x" has a maximum of 64 characters, and
length of "y" has a maximum of 199 characters. The name strings
can contain letters, numbers and the underscore character
only. Other characters are not valid, except for the "." character
that separates the "x" and "y" portions of the name. *IMPORTANT*
- The name must be unique within the OCI region the credential
is being created in. If you specify a name that duplicates
the name of another credential within the same OCI region,
you may overwrite or corrupt the credential that is already
using the name.
- 'For example: inventorydb.abc112233445566778899'
returned: on success
sample: credential_name_example
type: str
credential_type:
description:
- The type of credential used to connect to the ASM instance.
returned: on success
sample: NAME_REFERENCE
type: str
password_secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the user password.
returned: on success
sample: ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
type: str
role:
description:
- The role of the user connecting to the ASM instance.
returned: on success
sample: SYSASM
type: str
ssl_secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the SSL keystore and truststore details.
returned: on success
sample: ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
type: str
user_name:
description:
- The user name used to connect to the ASM instance.
returned: on success
sample: user_name_example
type: str
description:
- ''
returned: on success
type: complex
connection_string:
contains:
host_name:
description:
- The host name of the database or the SCAN name in case of
a RAC database.
returned: on success
sample: host_name_example
type: str
hosts:
description:
- The list of host names of the ASM instances.
returned: on success
sample: []
type: list
port:
description:
- The port used to connect to the ASM instance.
returned: on success
sample: 56
type: int
protocol:
description:
- The protocol used to connect to the ASM instance.
returned: on success
sample: TCP
type: str
service:
description:
- The service name of the ASM instance.
returned: on success
sample: service_example
type: str
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
connection_status:
description:
- The status of connectivity to the external DB system component.
returned: on success
sample: connection_status_example
type: str
connector_type:
description:
- The type of connector.
returned: on success
sample: MACS
type: str
display_name:
description:
- The user-friendly name for the external connector. The name does not
have to be unique.
returned: on success
sample: display_name_example
type: str
time_connection_status_last_updated:
description:
- The date and time the connectionStatus of the external DB system connector
was last updated.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- ''
returned: on success
type: complex
container_database_id:
description:
- The unique identifier of the parent Container Database (CDB).
returned: on success
sample: ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx
type: str
cpu_core_count:
description:
- The number of CPU cores available on the DB node.
returned: on success
sample: 3.4
type: float
crs_base_directory:
description:
- The Oracle base location of Cluster Ready Services (CRS).
returned: on success
sample: crs_base_directory_example
type: str
db_edition:
description:
- The Oracle Database edition.
returned: on success
sample: db_edition_example
type: str
db_id:
description:
- The Oracle Database ID.
returned: on success
sample: ocid1.db.oc1..xxxxxxEXAMPLExxxxxx
type: str
db_node_name:
description:
- The name of the DB node.
returned: on success
sample: db_node_name_example
type: str
db_packs:
description:
- The database packs licensed for the external Oracle Database.
returned: on success
sample: db_packs_example
type: str
db_role:
description:
- The role of the Oracle Database in Oracle Data Guard configuration.
returned: on success
sample: LOGICAL_STANDBY
type: str
db_type:
description:
- The type of Oracle Database. Indicates whether the database is a Container
Database, Pluggable Database, or a Non-container Database.
returned: on success
sample: CDB
type: str
db_unique_name:
description:
- The `DB_UNIQUE_NAME` of the external database.
returned: on success
sample: db_unique_name_example
type: str
db_version:
description:
- The Oracle Database version.
returned: on success
sample: db_version_example
type: str
display_name:
description:
- The user-friendly name for the discovered DB system component. 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
grid_home:
description:
- The directory in which ASM is installed. This is the same directory in
which Oracle Grid Infrastructure is installed.
returned: on success
sample: grid_home_example
type: str
guid:
description:
- The unique identifier of the PDB.
returned: on success
sample: guid_example
type: str
home_directory:
description:
- The location of the DB home.
returned: on success
sample: home_directory_example
type: str
host_name:
description:
- The name of the host on which the ASM instance is running.
returned: on success
sample: host_name_example
type: str
instance_name:
description:
- The name of the ASM instance.
returned: on success
sample: instance_name_example
type: str
is_cluster:
description:
- Indicates whether the Oracle Database is part of a cluster.
returned: on success
sample: true
type: bool
is_flex_cluster:
description:
- Indicates whether the cluster is an Oracle Flex Cluster or not.
returned: on success
sample: true
type: bool
is_flex_enabled:
description:
- Indicates whether Oracle Flex ASM is enabled or not.
returned: on success
sample: true
type: bool
is_selected_for_monitoring:
description:
- Indicates whether the DB system component should be provisioned as an
OCI resource or not.
returned: on success
sample: true
type: bool
listener_alias:
description:
- The listener alias.
returned: on success
sample: listener_alias_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
memory_size_in_gbs:
description:
- The total memory in gigabytes (GB) on the DB node.
returned: on success
sample: 3.4
type: float
network_configurations:
contains:
network_number:
description:
- The network number.
returned: on success
sample: 56
type: int
network_type:
description:
- The network type.
returned: on success
sample: AUTOCONFIG
type: str
subnet:
description:
- The subnet for the network.
returned: on success
sample: subnet_example
type: str
description:
- The list of network address configurations of the external cluster.
returned: on success
type: complex
node_role:
description:
- The role of the cluster node.
returned: on success
sample: HUB
type: str
ocr_file_location:
description:
- The location of the Oracle Cluster Registry (OCR) file.
returned: on success
sample: ocr_file_location_example
type: str
oracle_home:
description:
- The Oracle home location of the listener.
returned: on success
sample: oracle_home_example
type: str
pluggable_databases:
contains:
associated_components:
contains:
association_type:
description:
- The association type.
returned: on success
sample: CONTAINS
type: str
component_id:
description:
- The identifier of the associated component.
returned: on success
sample: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
type: str
component_type:
description:
- The type of associated component.
returned: on success
sample: ASM
type: str
description:
- The list of associated components.
returned: on success
type: complex
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_id:
description:
- The identifier of the discovered DB system component.
returned: on success
sample: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
type: str
component_name:
description:
- The name of the discovered DB system component.
returned: on success
sample: component_name_example
type: str
component_type:
description:
- The external DB system component type.
returned: on success
sample: ASM
type: str
connector:
contains:
agent_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the management agent used for the external DB system connector.
returned: on success
sample: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
type: str
connection_failure_message:
description:
- The error message indicating the reason for connection failure
or `null` if the connection was successful.
returned: on success
sample: connection_failure_message_example
type: str
connection_info:
contains:
component_type:
description:
- The component type.
returned: on success
sample: DATABASE
type: str
connection_credentials:
contains:
credential_name:
description:
- The name of the credential information that used to connect
to the DB system resource. The name should be in "x.y"
format, where the length of "x" has a maximum of 64 characters,
and length of "y" has a maximum of 199 characters. The
name strings can contain letters, numbers and the underscore
character only. Other characters are not valid, except
for the "." character that separates the "x" and "y" portions
of the name. *IMPORTANT* - The name must be unique within
the OCI region the credential is being created in. If
you specify a name that duplicates the name of another
credential within the same OCI region, you may overwrite
or corrupt the credential that is already using the name.
- 'For example: inventorydb.abc112233445566778899'
returned: on success
sample: credential_name_example
type: str
credential_type:
description:
- The type of credential used to connect to the ASM instance.
returned: on success
sample: NAME_REFERENCE
type: str
password_secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the user password.
returned: on success
sample: ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
type: str
role:
description:
- The role of the user connecting to the ASM instance.
returned: on success
sample: SYSASM
type: str
ssl_secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the SSL keystore and truststore
details.
returned: on success
sample: ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
type: str
user_name:
description:
- The user name used to connect to the ASM instance.
returned: on success
sample: user_name_example
type: str
description:
- ''
returned: on success
type: complex
connection_string:
contains:
host_name:
description:
- The host name of the database or the SCAN name in case
of a RAC database.
returned: on success
sample: host_name_example
type: str
hosts:
description:
- The list of host names of the ASM instances.
returned: on success
sample: []
type: list
port:
description:
- The port used to connect to the ASM instance.
returned: on success
sample: 56
type: int
protocol:
description:
- The protocol used to connect to the ASM instance.
returned: on success
sample: TCP
type: str
service:
description:
- The service name of the ASM instance.
returned: on success
sample: service_example
type: str
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
connection_status:
description:
- The status of connectivity to the external DB system component.
returned: on success
sample: connection_status_example
type: str
connector_type:
description:
- The type of connector.
returned: on success
sample: MACS
type: str
display_name:
description:
- The user-friendly name for the external connector. The name does
not have to be unique.
returned: on success
sample: display_name_example
type: str
time_connection_status_last_updated:
description:
- The date and time the connectionStatus of the external DB system
connector was last updated.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- ''
returned: on success
type: complex
container_database_id:
description:
- The unique identifier of the parent Container Database (CDB).
returned: on success
sample: ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx
type: str
display_name:
description:
- The user-friendly name for the discovered DB system component. The
name does not have to be unique.
returned: on success
sample: display_name_example
type: str
guid:
description:
- The unique identifier of the PDB.
returned: on success
sample: guid_example
type: str
is_selected_for_monitoring:
description:
- Indicates whether the DB system component should be provisioned as
an OCI resource or not.
returned: on success
sample: true
type: bool
resource_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the existing OCI resource matching the discovered DB system component.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
status:
description:
- The state of the discovered DB system component.
returned: on success
sample: NEW
type: str
description:
- The list of Pluggable Databases.
returned: on success
type: complex
resource_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the existing OCI resource matching the discovered DB system component.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
scan_configurations:
contains:
network_number:
description:
- The network number from which SCAN VIPs are obtained.
returned: on success
sample: 56
type: int
scan_name:
description:
- The name of the SCAN listener.
returned: on success
sample: scan_name_example
type: str
scan_port:
description:
- The port number of the SCAN listener.
returned: on success
sample: 56
type: int
scan_protocol:
description:
- The protocol of the SCAN listener.
returned: on success
sample: TCP
type: str
description:
- The list of Single Client Access Name (SCAN) configurations of the external
cluster.
returned: on success
type: complex
status:
description:
- The state of the discovered DB system component.
returned: on success
sample: NEW
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 ASM version.
returned: on success
sample: version_example
type: str
vip_configurations:
contains:
address:
description:
- The VIP name or IP address.
returned: on success
sample: address_example
type: str
network_number:
description:
- The network number from which VIPs are obtained.
returned: on success
sample: 56
type: int
node_name:
description:
- The name of the node with the VIP.
returned: on success
sample: node_name_example
type: str
description:
- The list of Virtual IP (VIP) configurations of the external cluster.
returned: on success
type: complex
description:
- The list of DB system components that were found in the DB system discovery.
returned: on success
type: complex
display_name:
description:
- The user-friendly name for the DB system. The name does not have to be unique.
returned: on success
sample: display_name_example
type: str
grid_home:
description:
- The directory in which Oracle Grid Infrastructure is installed.
returned: on success
sample: grid_home_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the external DB system discovery.
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 DB system discovery resource.
returned: on success
sample: CREATING
type: str
resource_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the existing OCI resource matching the discovered DB system.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- The date and time the external DB system discovery was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The date and time the external DB system discovery was last updated.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- Details of the ExternalDbSystemDiscovery resource acted upon by the current operation
returned: on success
sample:
agent_id: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
discovered_components:
- adr_home_directory: adr_home_directory_example
asm_instances:
- adr_home_directory: adr_home_directory_example
associated_components:
- association_type: CONTAINS
component_id: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
component_type: ASM
component_id: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
component_name: component_name_example
component_type: ASM
display_name: display_name_example
host_name: host_name_example
instance_name: instance_name_example
is_selected_for_monitoring: true
resource_id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
status: NEW
associated_components:
- association_type: CONTAINS
component_id: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
component_type: ASM
cluster_id: ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx
cluster_instances:
- adr_home_directory: adr_home_directory_example
associated_components:
- association_type: CONTAINS
component_id: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
component_type: ASM
cluster_id: ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx
component_id: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
component_name: component_name_example
component_type: ASM
connector:
agent_id: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
connection_failure_message: connection_failure_message_example
connection_info:
component_type: DATABASE
connection_credentials:
credential_name: credential_name_example
credential_type: NAME_REFERENCE
password_secret_id: ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
role: SYSASM
ssl_secret_id: ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
user_name: user_name_example
connection_string:
host_name: host_name_example
hosts: []
port: 56
protocol: TCP
service: service_example
connection_status: connection_status_example
connector_type: MACS
display_name: display_name_example
time_connection_status_last_updated: '2013-10-20T19:20:30+01:00'
crs_base_directory: crs_base_directory_example
display_name: display_name_example
host_name: host_name_example
is_selected_for_monitoring: true
node_role: HUB
resource_id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
status: NEW
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
component_id: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
component_name: component_name_example
component_type: ASM
connector:
agent_id: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
connection_failure_message: connection_failure_message_example
connection_info:
component_type: DATABASE
connection_credentials:
credential_name: credential_name_example
credential_type: NAME_REFERENCE
password_secret_id: ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
role: SYSASM
ssl_secret_id: ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
user_name: user_name_example
connection_string:
host_name: host_name_example
hosts: []
port: 56
protocol: TCP
service: service_example
connection_status: connection_status_example
connector_type: MACS
display_name: display_name_example
time_connection_status_last_updated: '2013-10-20T19:20:30+01:00'
container_database_id: ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx
cpu_core_count: 3.4
crs_base_directory: crs_base_directory_example
db_edition: db_edition_example
db_id: ocid1.db.oc1..xxxxxxEXAMPLExxxxxx
db_node_name: db_node_name_example
db_packs: db_packs_example
db_role: LOGICAL_STANDBY
db_type: CDB
db_unique_name: db_unique_name_example
db_version: db_version_example
display_name: display_name_example
endpoints:
- host: host_example
key: key_example
port: 56
protocol: IPC
services: []
grid_home: grid_home_example
guid: guid_example
home_directory: home_directory_example
host_name: host_name_example
instance_name: instance_name_example
is_cluster: true
is_flex_cluster: true
is_flex_enabled: true
is_selected_for_monitoring: true
listener_alias: listener_alias_example
listener_type: ASM
log_directory: log_directory_example
memory_size_in_gbs: 3.4
network_configurations:
- network_number: 56
network_type: AUTOCONFIG
subnet: subnet_example
node_role: HUB
ocr_file_location: ocr_file_location_example
oracle_home: oracle_home_example
pluggable_databases:
- associated_components:
- association_type: CONTAINS
component_id: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
component_type: ASM
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
component_id: ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
component_name: component_name_example
component_type: ASM
connector:
agent_id: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
connection_failure_message: connection_failure_message_example
connection_info:
component_type: DATABASE
connection_credentials:
credential_name: credential_name_example
credential_type: NAME_REFERENCE
password_secret_id: ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
role: SYSASM
ssl_secret_id: ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
user_name: user_name_example
connection_string:
host_name: host_name_example
hosts: []
port: 56
protocol: TCP
service: service_example
connection_status: connection_status_example
connector_type: MACS
display_name: display_name_example
time_connection_status_last_updated: '2013-10-20T19:20:30+01:00'
container_database_id: ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx
display_name: display_name_example
guid: guid_example
is_selected_for_monitoring: true
resource_id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
status: NEW
resource_id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
scan_configurations:
- network_number: 56
scan_name: scan_name_example
scan_port: 56
scan_protocol: TCP
status: NEW
trace_directory: trace_directory_example
version: version_example
vip_configurations:
- address: address_example
network_number: 56
node_name: node_name_example
display_name: display_name_example
grid_home: grid_home_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
lifecycle_details: lifecycle_details_example
lifecycle_state: CREATING
resource_id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
time_created: '2013-10-20T19:20:30+01:00'
time_updated: '2013-10-20T19:20:30+01:00'
type: complex