oci_db_node - Control the lifecycle of a DB Node in OCI’s Database Cloud Service.

New in version 2.5.

Synopsis

  • Stop/start a DB Node
  • Reset a DB Node
  • Soft-reset a DB Node
  • All operations of this module returns after triggering the lifecycle operation. Use oci_db_node_facts to check the status of the operation.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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
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
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
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_type
    Choices:
  • api_key ←
  • instance_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.
config_file_location
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
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
required
Identifier of the DB Node whose lifecycle state is to be controlled.

aliases: id
region
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
required
    Choices:
  • stop
  • start ←
  • reset
  • softreset
The state of the DB Node that must be asserted to. When state=stop, specified DB Node is powered off. When state=start, the specified DB Node is powered on. When state=softreset, an ACPI shutdown is initiated and specified DB Node is powered on. When state=reset, specified DB Node is powered off and then powered on. Note that state=softreset and state=reset states are not idempotent. Every time a play is executed with these state options, a shutdown and a power-on sequence is executed against the DB node.
tenancy
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
bool
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

# Note: These examples do not set authentication details.
# Assert that the database node is stopped
- name: Stop a Database Node
  oci_db_node:
    db_node_id: "ocid1.dbnode.aaaa"
    state: 'stop'

Return Values

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

Key Returned Description
db_node
complex
success
Attributes of the Db Node.

Sample:
{'lifecycle_state': 'AVAILABLE', 'hostname': 'db-system-one', 'time_created': '2018-02-17T07:59:04.715000+00:00', 'vnic_id': 'ocid1.vnic.oc1.iad.xxxxxEXAMPLExxxxx', 'db_system_id': 'ocid1.dbsystem.oc1.ia', 'backup_vnic_id': 'ocid1.vnic.oc1.iad.xxxxxEXAMPLExxxxx', 'id': 'ocid1.dbnode.oc1.iad.xxxxxEXAMPLExxxxx', 'software_storage_size_in_gb': '1024'}
  lifecycle_state
string
always
The current state of the DB Node.

Sample:
AVAILABLE
  hostname
string
always
The host name for the DB Node.

Sample:
ansible-db-node
  time_created
datetime
always
Date and time when the DB Node was created, in the format defined by RFC3339

Sample:
2016-08-25 21:10:29.600000
  vnic_id
string
always
The OCID of the VNIC of this DB Node

Sample:
ocid1.vnic.oc1.iad.xxxxxEXAMPLExxxxx
  db_system_id
string
always
Identifier of the DB System under which the DB Node exists.

Sample:
ocid1.dbsystem.oc1.iad.xxxxxEXAMPLExxxxx
  backup_vnic_id
string
always
The OCID of the backup VNIC of this DB Node

Sample:
ocid1.vnic.oc1.iad.xxxxxEXAMPLExxxxx
  id
string
always
Identifier of the DB Node.

Sample:
ocid1.dbnode.oc1.iad.xxxxxEXAMPLExxxxx
  software_storage_size_in_gb
string
always
Storage size, in GBs, of the software volume that is allocated to the DB system. This is applicable only for VM-based DBs.

Sample:
1024


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.