oracle.oci.oci_golden_gate_deployment_backup_actions – Perform actions on a DeploymentBackup resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a DeploymentBackup resource in Oracle Cloud Infrastructure

  • For action=cancel, cancels a Deployment Backup creation process.

  • For action=change_compartment, moves a DeploymentBackup into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

  • For action=restore_deployment, restores a Deployment from a Deployment Backup created from the same Deployment.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • cancel
  • change_compartment
  • restore_deployment
The action to perform on the DeploymentBackup.
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.
compartment_id
string
The OCID of the compartment being referenced.
Required for action=change_compartment.
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.
deployment_backup_id
string / required
A unique DeploymentBackup identifier.

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
type
string
    Choices:
  • DEFAULT
The type of a deployment backup cancel
Required for action=cancel, action=restore_deployment.
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 cancel on deployment_backup with type = DEFAULT
  oci_golden_gate_deployment_backup_actions:
    # required
    type: DEFAULT

- name: Perform action change_compartment on deployment_backup
  oci_golden_gate_deployment_backup_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    deployment_backup_id: "ocid1.deploymentbackup.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action restore_deployment on deployment_backup with type = DEFAULT
  oci_golden_gate_deployment_backup_actions:
    # required
    type: DEFAULT

Return Values

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

Key Returned Description
deployment_backup
complex
on success
Details of the DeploymentBackup resource acted upon by the current operation

Sample:
{'backup_type': 'INCREMENTAL', 'bucket_name': 'bucket_name_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deployment_id': 'ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_automatic': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'namespace_name': 'namespace_name_example', 'object_name': 'object_name_example', 'ogg_version': 'ogg_version_example', 'size_in_bytes': 10, 'system_tags': {}, 'time_backup_finished': '2013-10-20T19:20:30+01:00', 'time_created': '2013-10-20T19:20:30+01:00', 'time_of_backup': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
backup_type
string
on success
Possible Deployment backup types.

Sample:
INCREMENTAL
 
bucket_name
string
on success
Name of the bucket where the object is to be uploaded in the object storage

Sample:
bucket_name_example
 
compartment_id
string
on success
The OCID of the compartment being referenced.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
deployment_id
string
on success
The OCID of the deployment being referenced.

Sample:
ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx
 
display_name
string
on success
An object's Display Name.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the backup being referenced.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_automatic
boolean
on success
True if this object is automatically created

Sample:
True
 
lifecycle_details
string
on success
Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
Possible lifecycle states.

Sample:
CREATING
 
namespace_name
string
on success
Name of namespace that serves as a container for all of your buckets

Sample:
namespace_name_example
 
object_name
string
on success
Name of the object to be uploaded to object storage

Sample:
object_name_example
 
ogg_version
string
on success
Version of OGG

Sample:
ogg_version_example
 
size_in_bytes
float
on success
The size of the backup stored in object storage (in bytes)

Sample:
10
 
system_tags
dictionary
on success
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.
Example: `{orcl-cloud: {free-tier-retain: true}}`

 
time_backup_finished
string
on success
The time of the resource backup finish. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
time_created
string
on success
The time the resource was created. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
time_of_backup
string
on success
The time of the resource backup. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the resource was last updated. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)