oracle.oci.oci_database_management_external_db_system_discovery – Manage an ExternalDbSystemDiscovery resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_db_system_discovery.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update, patch and delete an ExternalDbSystemDiscovery resource in Oracle Cloud Infrastructure
For state=present, creates an external DB system discovery resource and initiates the discovery process.
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 | |
|---|---|---|---|
|
agent_id
string
|
The OCID of the management agent used for the external DB system discovery.
Required for create using state=present.
|
||
|
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 in which the external DB system resides.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||
|
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
|
The user-friendly name for the DB system. The name does not have to be unique.
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||
|
external_db_system_discovery_id
string
|
The OCID of the external DB system discovery.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||
|
force_create
boolean
|
|
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 key_by.
|
|
|
items
list
/ elements=dictionary
|
A sequence of instructions to apply to the resource.
|
||
|
operation
string
/ required
|
|
The type of operation.
|
|
|
selection
string
/ required
|
The set of values to which the operation applies as a JMESPath expression 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.
|
||
|
value
dictionary
|
A value to be merged into the target.
|
||
|
key_by
list
/ elements=string
|
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.
|
||
|
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. |
||
|
state
string
|
|
The state of the ExternalDbSystemDiscovery.
Use state=present to create or update an ExternalDbSystemDiscovery.
Use state=absent to delete an ExternalDbSystemDiscovery.
|
|
|
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 |
||
|
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
|
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
||
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||||||
|---|---|---|---|---|---|---|---|---|
|
external_db_system_discovery
complex
|
on success |
Details of the ExternalDbSystemDiscovery resource acted upon by the current operation
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'}
|
||||||
|
agent_id
string
|
on success |
The OCID of the management agent used for the external DB system discovery.
Sample:
ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
discovered_components
complex
|
on success |
The list of DB system components that were found in the DB system discovery.
|
||||||
|
adr_home_directory
string
|
on success |
The Automatic Diagnostic Repository (ADR) home directory for the ASM instance.
Sample:
adr_home_directory_example
|
||||||
|
asm_instances
complex
|
on success |
|
||||||
|
adr_home_directory
string
|
on success |
The Automatic Diagnostic Repository (ADR) home directory for the ASM instance.
Sample:
adr_home_directory_example
|
||||||
|
associated_components
complex
|
on success |
The list of associated components.
|
||||||
|
association_type
string
|
on success |
The association type.
Sample:
CONTAINS
|
||||||
|
component_id
string
|
on success |
The identifier of the associated component.
Sample:
ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_type
string
|
on success |
The type of associated component.
Sample:
ASM
|
||||||
|
component_id
string
|
on success |
The identifier of the discovered DB system component.
Sample:
ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_name
string
|
on success |
The name of the discovered DB system component.
Sample:
component_name_example
|
||||||
|
component_type
string
|
on success |
The external DB system component type.
Sample:
ASM
|
||||||
|
display_name
string
|
on success |
The user-friendly name for the discovered DB system component. The name does not have to be unique.
Sample:
display_name_example
|
||||||
|
host_name
string
|
on success |
The name of the host on which the ASM instance is running.
Sample:
host_name_example
|
||||||
|
instance_name
string
|
on success |
The name of the ASM instance.
Sample:
instance_name_example
|
||||||
|
is_selected_for_monitoring
boolean
|
on success |
Indicates whether the DB system component should be provisioned as an OCI resource or not.
Sample:
True
|
||||||
|
resource_id
string
|
on success |
The OCID of the existing OCI resource matching the discovered DB system component.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
status
string
|
on success |
The state of the discovered DB system component.
Sample:
NEW
|
||||||
|
associated_components
complex
|
on success |
The list of associated components.
|
||||||
|
association_type
string
|
on success |
The association type.
Sample:
CONTAINS
|
||||||
|
component_id
string
|
on success |
The identifier of the associated component.
Sample:
ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_type
string
|
on success |
The type of associated component.
Sample:
ASM
|
||||||
|
cluster_id
string
|
on success |
The unique identifier of the Oracle cluster.
Sample:
ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
cluster_instances
complex
|
on success |
|
||||||
|
adr_home_directory
string
|
on success |
The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
Sample:
adr_home_directory_example
|
||||||
|
associated_components
complex
|
on success |
The list of associated components.
|
||||||
|
association_type
string
|
on success |
The association type.
Sample:
CONTAINS
|
||||||
|
component_id
string
|
on success |
The identifier of the associated component.
Sample:
ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_type
string
|
on success |
The type of associated component.
Sample:
ASM
|
||||||
|
cluster_id
string
|
on success |
The unique identifier of the Oracle cluster.
Sample:
ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_id
string
|
on success |
The identifier of the discovered DB system component.
Sample:
ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_name
string
|
on success |
The name of the discovered DB system component.
Sample:
component_name_example
|
||||||
|
component_type
string
|
on success |
The external DB system component type.
Sample:
ASM
|
||||||
|
connector
complex
|
on success |
|
||||||
|
agent_id
string
|
on success |
The OCID of the management agent used for the external DB system connector.
Sample:
ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
connection_failure_message
string
|
on success |
The error message indicating the reason for connection failure or `null` if the connection was successful.
Sample:
connection_failure_message_example
|
||||||
|
connection_info
complex
|
on success |
|
||||||
|
component_type
string
|
on success |
The component type.
Sample:
DATABASE
|
||||||
|
connection_credentials
complex
|
on success |
|
||||||
|
credential_name
string
|
on success |
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
Sample:
credential_name_example
|
||||||
|
credential_type
string
|
on success |
The type of credential used to connect to the ASM instance.
Sample:
NAME_REFERENCE
|
||||||
|
password_secret_id
string
|
on success |
The OCID of the secret containing the user password.
Sample:
ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
role
string
|
on success |
The role of the user connecting to the ASM instance.
Sample:
SYSASM
|
||||||
|
ssl_secret_id
string
|
on success |
The OCID of the secret containing the SSL keystore and truststore details.
Sample:
ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
user_name
string
|
on success |
The user name used to connect to the ASM instance.
Sample:
user_name_example
|
||||||
|
connection_string
complex
|
on success |
|
||||||
|
host_name
string
|
on success |
The host name of the database or the SCAN name in case of a RAC database.
Sample:
host_name_example
|
||||||
|
hosts
list
/ elements=string
|
on success |
The list of host names of the ASM instances.
|
||||||
|
port
integer
|
on success |
The port used to connect to the ASM instance.
Sample:
56
|
||||||
|
protocol
string
|
on success |
The protocol used to connect to the ASM instance.
Sample:
TCP
|
||||||
|
service
string
|
on success |
The service name of the ASM instance.
Sample:
service_example
|
||||||
|
connection_status
string
|
on success |
The status of connectivity to the external DB system component.
Sample:
connection_status_example
|
||||||
|
connector_type
string
|
on success |
The type of connector.
Sample:
MACS
|
||||||
|
display_name
string
|
on success |
The user-friendly name for the external connector. The name does not have to be unique.
Sample:
display_name_example
|
||||||
|
time_connection_status_last_updated
string
|
on success |
The date and time the connectionStatus of the external DB system connector was last updated.
Sample:
2013-10-20T19:20:30+01:00
|
||||||
|
crs_base_directory
string
|
on success |
The Oracle base location of Cluster Ready Services (CRS).
Sample:
crs_base_directory_example
|
||||||
|
display_name
string
|
on success |
The user-friendly name for the discovered DB system component. The name does not have to be unique.
Sample:
display_name_example
|
||||||
|
host_name
string
|
on success |
The name of the host on which the cluster instance is running.
Sample:
host_name_example
|
||||||
|
is_selected_for_monitoring
boolean
|
on success |
Indicates whether the DB system component should be provisioned as an OCI resource or not.
Sample:
True
|
||||||
|
node_role
string
|
on success |
The role of the cluster node.
Sample:
HUB
|
||||||
|
resource_id
string
|
on success |
The OCID of the existing OCI resource matching the discovered DB system component.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
status
string
|
on success |
The state of the discovered DB system component.
Sample:
NEW
|
||||||
|
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_id
string
|
on success |
The identifier of the discovered DB system component.
Sample:
ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_name
string
|
on success |
The name of the discovered DB system component.
Sample:
component_name_example
|
||||||
|
component_type
string
|
on success |
The external DB system component type.
Sample:
ASM
|
||||||
|
connector
complex
|
on success |
|
||||||
|
agent_id
string
|
on success |
The OCID of the management agent used for the external DB system connector.
Sample:
ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
connection_failure_message
string
|
on success |
The error message indicating the reason for connection failure or `null` if the connection was successful.
Sample:
connection_failure_message_example
|
||||||
|
connection_info
complex
|
on success |
|
||||||
|
component_type
string
|
on success |
The component type.
Sample:
DATABASE
|
||||||
|
connection_credentials
complex
|
on success |
|
||||||
|
credential_name
string
|
on success |
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
Sample:
credential_name_example
|
||||||
|
credential_type
string
|
on success |
The type of credential used to connect to the ASM instance.
Sample:
NAME_REFERENCE
|
||||||
|
password_secret_id
string
|
on success |
The OCID of the secret containing the user password.
Sample:
ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
role
string
|
on success |
The role of the user connecting to the ASM instance.
Sample:
SYSASM
|
||||||
|
ssl_secret_id
string
|
on success |
The OCID of the secret containing the SSL keystore and truststore details.
Sample:
ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
user_name
string
|
on success |
The user name used to connect to the ASM instance.
Sample:
user_name_example
|
||||||
|
connection_string
complex
|
on success |
|
||||||
|
host_name
string
|
on success |
The host name of the database or the SCAN name in case of a RAC database.
Sample:
host_name_example
|
||||||
|
hosts
list
/ elements=string
|
on success |
The list of host names of the ASM instances.
|
||||||
|
port
integer
|
on success |
The port used to connect to the ASM instance.
Sample:
56
|
||||||
|
protocol
string
|
on success |
The protocol used to connect to the ASM instance.
Sample:
TCP
|
||||||
|
service
string
|
on success |
The service name of the ASM instance.
Sample:
service_example
|
||||||
|
connection_status
string
|
on success |
The status of connectivity to the external DB system component.
Sample:
connection_status_example
|
||||||
|
connector_type
string
|
on success |
The type of connector.
Sample:
MACS
|
||||||
|
display_name
string
|
on success |
The user-friendly name for the external connector. The name does not have to be unique.
Sample:
display_name_example
|
||||||
|
time_connection_status_last_updated
string
|
on success |
The date and time the connectionStatus of the external DB system connector was last updated.
Sample:
2013-10-20T19:20:30+01:00
|
||||||
|
container_database_id
string
|
on success |
The unique identifier of the parent Container Database (CDB).
Sample:
ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
cpu_core_count
float
|
on success |
The number of CPU cores available on the DB node.
Sample:
3.4
|
||||||
|
crs_base_directory
string
|
on success |
The Oracle base location of Cluster Ready Services (CRS).
Sample:
crs_base_directory_example
|
||||||
|
db_edition
string
|
on success |
The Oracle Database edition.
Sample:
db_edition_example
|
||||||
|
db_id
string
|
on success |
The Oracle Database ID.
Sample:
ocid1.db.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
db_node_name
string
|
on success |
The name of the DB node.
Sample:
db_node_name_example
|
||||||
|
db_packs
string
|
on success |
The database packs licensed for the external Oracle Database.
Sample:
db_packs_example
|
||||||
|
db_role
string
|
on success |
The role of the Oracle Database in Oracle Data Guard configuration.
Sample:
LOGICAL_STANDBY
|
||||||
|
db_type
string
|
on success |
The type of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database.
Sample:
CDB
|
||||||
|
db_unique_name
string
|
on success |
The `DB_UNIQUE_NAME` of the external database.
Sample:
db_unique_name_example
|
||||||
|
db_version
string
|
on success |
The Oracle Database version.
Sample:
db_version_example
|
||||||
|
display_name
string
|
on success |
The user-friendly name for the discovered DB system component. 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.
|
||||||
|
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.
|
||||||
|
grid_home
string
|
on success |
The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
Sample:
grid_home_example
|
||||||
|
guid
string
|
on success |
The unique identifier of the PDB.
Sample:
guid_example
|
||||||
|
home_directory
string
|
on success |
The location of the DB home.
Sample:
home_directory_example
|
||||||
|
host_name
string
|
on success |
The name of the host on which the ASM instance is running.
Sample:
host_name_example
|
||||||
|
instance_name
string
|
on success |
The name of the ASM instance.
Sample:
instance_name_example
|
||||||
|
is_cluster
boolean
|
on success |
Indicates whether the Oracle Database is part of a cluster.
Sample:
True
|
||||||
|
is_flex_cluster
boolean
|
on success |
Indicates whether the cluster is an Oracle Flex Cluster or not.
Sample:
True
|
||||||
|
is_flex_enabled
boolean
|
on success |
Indicates whether Oracle Flex ASM is enabled or not.
Sample:
True
|
||||||
|
is_selected_for_monitoring
boolean
|
on success |
Indicates whether the DB system component should be provisioned as an OCI resource or not.
Sample:
True
|
||||||
|
listener_alias
string
|
on success |
The listener alias.
Sample:
listener_alias_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.
Sample:
log_directory_example
|
||||||
|
memory_size_in_gbs
float
|
on success |
The total memory in gigabytes (GB) on the DB node.
Sample:
3.4
|
||||||
|
network_configurations
complex
|
on success |
The list of network address configurations of the external cluster.
|
||||||
|
network_number
integer
|
on success |
The network number.
Sample:
56
|
||||||
|
network_type
string
|
on success |
The network type.
Sample:
AUTOCONFIG
|
||||||
|
subnet
string
|
on success |
The subnet for the network.
Sample:
subnet_example
|
||||||
|
node_role
string
|
on success |
The role of the cluster node.
Sample:
HUB
|
||||||
|
ocr_file_location
string
|
on success |
The location of the Oracle Cluster Registry (OCR) file.
Sample:
ocr_file_location_example
|
||||||
|
oracle_home
string
|
on success |
The Oracle home location of the listener.
Sample:
oracle_home_example
|
||||||
|
pluggable_databases
complex
|
on success |
The list of Pluggable Databases.
|
||||||
|
associated_components
complex
|
on success |
The list of associated components.
|
||||||
|
association_type
string
|
on success |
The association type.
Sample:
CONTAINS
|
||||||
|
component_id
string
|
on success |
The identifier of the associated component.
Sample:
ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_type
string
|
on success |
The type of associated component.
Sample:
ASM
|
||||||
|
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_id
string
|
on success |
The identifier of the discovered DB system component.
Sample:
ocid1.component.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
component_name
string
|
on success |
The name of the discovered DB system component.
Sample:
component_name_example
|
||||||
|
component_type
string
|
on success |
The external DB system component type.
Sample:
ASM
|
||||||
|
connector
complex
|
on success |
|
||||||
|
agent_id
string
|
on success |
The OCID of the management agent used for the external DB system connector.
Sample:
ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
connection_failure_message
string
|
on success |
The error message indicating the reason for connection failure or `null` if the connection was successful.
Sample:
connection_failure_message_example
|
||||||
|
connection_info
complex
|
on success |
|
||||||
|
component_type
string
|
on success |
The component type.
Sample:
DATABASE
|
||||||
|
connection_credentials
complex
|
on success |
|
||||||
|
credential_name
string
|
on success |
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
Sample:
credential_name_example
|
||||||
|
credential_type
string
|
on success |
The type of credential used to connect to the ASM instance.
Sample:
NAME_REFERENCE
|
||||||
|
password_secret_id
string
|
on success |
The OCID of the secret containing the user password.
Sample:
ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
role
string
|
on success |
The role of the user connecting to the ASM instance.
Sample:
SYSASM
|
||||||
|
ssl_secret_id
string
|
on success |
The OCID of the secret containing the SSL keystore and truststore details.
Sample:
ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
user_name
string
|
on success |
The user name used to connect to the ASM instance.
Sample:
user_name_example
|
||||||
|
connection_string
complex
|
on success |
|
||||||
|
host_name
string
|
on success |
The host name of the database or the SCAN name in case of a RAC database.
Sample:
host_name_example
|
||||||
|
hosts
list
/ elements=string
|
on success |
The list of host names of the ASM instances.
|
||||||
|
port
integer
|
on success |
The port used to connect to the ASM instance.
Sample:
56
|
||||||
|
protocol
string
|
on success |
The protocol used to connect to the ASM instance.
Sample:
TCP
|
||||||
|
service
string
|
on success |
The service name of the ASM instance.
Sample:
service_example
|
||||||
|
connection_status
string
|
on success |
The status of connectivity to the external DB system component.
Sample:
connection_status_example
|
||||||
|
connector_type
string
|
on success |
The type of connector.
Sample:
MACS
|
||||||
|
display_name
string
|
on success |
The user-friendly name for the external connector. The name does not have to be unique.
Sample:
display_name_example
|
||||||
|
time_connection_status_last_updated
string
|
on success |
The date and time the connectionStatus of the external DB system connector was last updated.
Sample:
2013-10-20T19:20:30+01:00
|
||||||
|
container_database_id
string
|
on success |
The unique identifier of the parent Container Database (CDB).
Sample:
ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
display_name
string
|
on success |
The user-friendly name for the discovered DB system component. The name does not have to be unique.
Sample:
display_name_example
|
||||||
|
guid
string
|
on success |
The unique identifier of the PDB.
Sample:
guid_example
|
||||||
|
is_selected_for_monitoring
boolean
|
on success |
Indicates whether the DB system component should be provisioned as an OCI resource or not.
Sample:
True
|
||||||
|
resource_id
string
|
on success |
The OCID of the existing OCI resource matching the discovered DB system component.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
status
string
|
on success |
The state of the discovered DB system component.
Sample:
NEW
|
||||||
|
resource_id
string
|
on success |
The OCID of the existing OCI resource matching the discovered DB system component.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
scan_configurations
complex
|
on success |
The list of Single Client Access Name (SCAN) configurations of the external cluster.
|
||||||
|
network_number
integer
|
on success |
The network number from which SCAN VIPs are obtained.
Sample:
56
|
||||||
|
scan_name
string
|
on success |
The name of the SCAN listener.
Sample:
scan_name_example
|
||||||
|
scan_port
integer
|
on success |
The port number of the SCAN listener.
Sample:
56
|
||||||
|
scan_protocol
string
|
on success |
The protocol of the SCAN listener.
Sample:
TCP
|
||||||
|
status
string
|
on success |
The state of the discovered DB system component.
Sample:
NEW
|
||||||
|
trace_directory
string
|
on success |
The destination directory of the listener trace file.
Sample:
trace_directory_example
|
||||||
|
version
string
|
on success |
The ASM version.
Sample:
version_example
|
||||||
|
vip_configurations
complex
|
on success |
The list of Virtual IP (VIP) configurations of the external cluster.
|
||||||
|
address
string
|
on success |
The VIP name or IP address.
Sample:
address_example
|
||||||
|
network_number
integer
|
on success |
The network number from which VIPs are obtained.
Sample:
56
|
||||||
|
node_name
string
|
on success |
The name of the node with the VIP.
Sample:
node_name_example
|
||||||
|
display_name
string
|
on success |
The user-friendly name for the DB system. The name does not have to be unique.
Sample:
display_name_example
|
||||||
|
grid_home
string
|
on success |
The directory in which Oracle Grid Infrastructure is installed.
Sample:
grid_home_example
|
||||||
|
id
string
|
on success |
The OCID of the external DB system discovery.
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 DB system discovery resource.
Sample:
CREATING
|
||||||
|
resource_id
string
|
on success |
The OCID of the existing OCI resource matching the discovered DB system.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||||
|
time_created
string
|
on success |
The date and time the external DB system discovery was created.
Sample:
2013-10-20T19:20:30+01:00
|
||||||
|
time_updated
string
|
on success |
The date and time the external DB system discovery was last updated.
Sample:
2013-10-20T19:20:30+01:00
|
||||||
Authors¶
Oracle (@oracle)