oracle.oci.oci_database_db_node_actions – Perform actions on a DbNode resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a DbNode resource in Oracle Cloud Infrastructure

  • For action=db_node_action, performs one of the following power actions on the specified DB node: - start - power on - stop - power off - softreset - ACPI shutdown and power on - reset - power off and power on

  • Note: Stopping a node affects billing differently, depending on the type of DB system: Bare metal and Exadata systems - The _stop_ state has no effect on the resources you consume. Billing continues for DB nodes that you stop, and related resources continue to apply against any relevant quotas. You must terminate the DB system (TerminateDbSystem) to remove its resources from billing and quotas. Virtual machine DB systems - Stopping a node stops billing for all OCPUs associated with that node, and billing resumes when you restart the node.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • stop
  • start
  • softreset
  • reset
The action to perform on the DB Node.
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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
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.
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 / required
The database node OCID.

aliases: id
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.
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
    Choices:
  • no
  • yes ←
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.

Examples

- name: Perform action stop on db_node
  oci_database_db_node_actions:
    # required
    db_node_id: "ocid1.dbnode.oc1..xxxxxxEXAMPLExxxxxx"
    action: STOP

- name: Perform action start on db_node
  oci_database_db_node_actions:
    # required
    db_node_id: "ocid1.dbnode.oc1..xxxxxxEXAMPLExxxxxx"
    action: STOP

- name: Perform action softreset on db_node
  oci_database_db_node_actions:
    # required
    db_node_id: "ocid1.dbnode.oc1..xxxxxxEXAMPLExxxxxx"
    action: STOP

- name: Perform action reset on db_node
  oci_database_db_node_actions:
    # required
    db_node_id: "ocid1.dbnode.oc1..xxxxxxEXAMPLExxxxxx"
    action: STOP

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
db_node
complex
on success
Details of the DbNode resource acted upon by the current operation

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, '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
 
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)