oracle.oci.oci_database_db_node_facts – Fetches details about one or multiple DbNode resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_db_node_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple DbNode resources in Oracle Cloud Infrastructure
Lists the database nodes in the specified DB system and compartment. A database node is a server running database software.
If db_node_id is specified, the details of a single DbNode will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
|
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|
compartment_id
string
|
The compartment OCID.
Required to list multiple db_nodes.
|
|
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 . |
|
db_node_id
string
|
The database node OCID.
Required to get a specific db_node.
aliases: id |
|
db_server_id
string
|
The OCID of the Exacc Db server.
|
|
db_system_id
string
|
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
|
|
lifecycle_state
string
|
|
A filter to return only resources that match the given lifecycle state exactly.
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|
sort_by
string
|
|
Sort by TIMECREATED. Default order for TIMECREATED is descending.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
|
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 |
|
vm_cluster_id
string
|
The OCID of the VM cluster.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific db_node
oci_database_db_node_facts:
# required
db_node_id: "ocid1.dbnode.oc1..xxxxxxEXAMPLExxxxxx"
- name: List db_nodes
oci_database_db_node_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
vm_cluster_id: "ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx"
sort_by: TIMECREATED
sort_order: ASC
lifecycle_state: PROVISIONING
db_server_id: "ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
db_nodes
complex
|
on success |
List of DbNode resources
Sample:
[{'additional_details': 'additional_details_example', 'backup_ip_id': 'ocid1.backupip.oc1..xxxxxxEXAMPLExxxxxx', 'backup_vnic2_id': 'ocid1.backupvnic2.oc1..xxxxxxEXAMPLExxxxxx', 'backup_vnic_id': 'ocid1.backupvnic.oc1..xxxxxxEXAMPLExxxxxx', 'cpu_core_count': 56, 'db_node_storage_size_in_gbs': 56, 'db_server_id': 'ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'fault_domain': 'FAULT-DOMAIN-1', 'host_ip_id': 'ocid1.hostip.oc1..xxxxxxEXAMPLExxxxxx', 'hostname': 'hostname_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'PROVISIONING', 'maintenance_type': 'VMDB_REBOOT_MIGRATION', 'memory_size_in_gbs': 56, 'primary_private_ip': '10.0.0.10', 'primary_public_ip': '140.34.93.209', 'software_storage_size_in_gb': 56, 'time_created': '2013-10-20T19:20:30+01:00', 'time_maintenance_window_end': '2013-10-20T19:20:30+01:00', 'time_maintenance_window_start': '2013-10-20T19:20:30+01:00', 'vnic2_id': 'ocid1.vnic2.oc1..xxxxxxEXAMPLExxxxxx', 'vnic_id': 'ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx'}]
|
|
additional_details
string
|
on success |
Additional information about the planned maintenance.
Sample:
additional_details_example
|
|
backup_ip_id
string
|
on success |
The OCID of the backup IP address associated with the database node. Use this OCID with either the GetPrivateIp or the GetPublicIpByPrivateIpId API to get the IP address needed to make a database connection.
**Note:** Applies only to Exadata Cloud Service.
Sample:
ocid1.backupip.oc1..xxxxxxEXAMPLExxxxxx
|
|
backup_vnic2_id
string
|
on success |
The OCID of the second backup VNIC.
**Note:** Applies only to Exadata Cloud Service.
Sample:
ocid1.backupvnic2.oc1..xxxxxxEXAMPLExxxxxx
|
|
backup_vnic_id
string
|
on success |
The OCID of the backup VNIC.
Sample:
ocid1.backupvnic.oc1..xxxxxxEXAMPLExxxxxx
|
|
cpu_core_count
integer
|
on success |
The number of CPU cores enabled on the Db node.
Sample:
56
|
|
db_node_storage_size_in_gbs
integer
|
on success |
The allocated local node storage in GBs on the Db node.
Sample:
56
|
|
db_server_id
string
|
on success |
The OCID of the Exacc Db server associated with the database node.
Sample:
ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx
|
|
db_system_id
string
|
on success |
The OCID of the DB system.
Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
|
|
fault_domain
string
|
on success |
The name of the Fault Domain the instance is contained in.
Sample:
FAULT-DOMAIN-1
|
|
host_ip_id
string
|
on success |
The OCID of the host IP address associated with the database node. Use this OCID with either the GetPrivateIp or the GetPublicIpByPrivateIpId API to get the IP address needed to make a database connection.
**Note:** Applies only to Exadata Cloud Service.
Sample:
ocid1.hostip.oc1..xxxxxxEXAMPLExxxxxx
|
|
hostname
string
|
on success |
The host name for the database node.
Sample:
hostname_example
|
|
id
string
|
on success |
The OCID of the database node.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_state
string
|
on success |
The current state of the database node.
Sample:
PROVISIONING
|
|
maintenance_type
string
|
on success |
The type of database node maintenance.
Sample:
VMDB_REBOOT_MIGRATION
|
|
memory_size_in_gbs
integer
|
on success |
The allocated memory in GBs on the Db node.
Sample:
56
|
|
primary_private_ip
string
|
on success |
The private IP of the primary VNIC attached to this db node
Sample:
10.0.0.10
|
|
primary_public_ip
string
|
on success |
The public IP of the primary VNIC attached to this db node
Sample:
140.34.93.209
|
|
software_storage_size_in_gb
integer
|
on success |
The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.
Sample:
56
|
|
time_created
string
|
on success |
The date and time that the database node was created.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_maintenance_window_end
string
|
on success |
End date and time of maintenance window.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_maintenance_window_start
string
|
on success |
Start date and time of maintenance window.
Sample:
2013-10-20T19:20:30+01:00
|
|
vnic2_id
string
|
on success |
The OCID of the second VNIC.
**Note:** Applies only to Exadata Cloud Service.
Sample:
ocid1.vnic2.oc1..xxxxxxEXAMPLExxxxxx
|
|
vnic_id
string
|
on success |
The OCID of the VNIC.
Sample:
ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)