oracle.oci.oci_object_storage_replication_policy – Manage a ReplicationPolicy resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create and delete a ReplicationPolicy resource in Oracle Cloud Infrastructure

  • For state=present, creates a replication policy for the specified bucket.

Requirements

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

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
    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.
bucket_name
string / required
The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1`
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.
destination_bucket_name
string
The bucket to replicate to in the destination region. Replication policy creation does not automatically create a destination bucket. Create the destination bucket before creating the policy.
Required for create using state=present.
destination_region_name
string
The destination region to replicate to, for example "us-ashburn-1".
Required for create using state=present.
force_create
boolean
    Choices:
  • no ←
  • yes
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.
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.
name
string
The name of the policy. Avoid entering confidential information.
Required for create using state=present.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
namespace_name
string / required
The Object Storage namespace used for the request.
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.
replication_id
string
The ID of the replication policy.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
state
string
    Choices:
  • present ←
  • absent
The state of the ReplicationPolicy.
Use state=present to create a ReplicationPolicy.
Use state=absent to delete a ReplicationPolicy.
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

Examples

- name: Create replication_policy
  oci_object_storage_replication_policy:
    # required
    name: name_example
    destination_region_name: us-phoenix-1
    destination_bucket_name: destination_bucket_name_example
    namespace_name: namespace_name_example
    bucket_name: bucket_name_example

- name: Delete replication_policy
  oci_object_storage_replication_policy:
    # required
    namespace_name: namespace_name_example
    bucket_name: bucket_name_example
    replication_id: "ocid1.replication.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete replication_policy using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_object_storage_replication_policy:
    # required
    name: name_example
    namespace_name: namespace_name_example
    bucket_name: bucket_name_example
    state: absent

Return Values

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

Key Returned Description
replication_policy
complex
on success
Details of the ReplicationPolicy resource acted upon by the current operation

Sample:
{'destination_bucket_name': 'destination_bucket_name_example', 'destination_region_name': 'us-phoenix-1', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'status': 'ACTIVE', 'status_message': 'status_message_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_sync': '2013-10-20T19:20:30+01:00'}
 
destination_bucket_name
string
on success
The bucket to replicate to in the destination region. Replication policy creation does not automatically create a destination bucket. Create the destination bucket before creating the policy.

Sample:
destination_bucket_name_example
 
destination_region_name
string
on success
The destination region to replicate to, for example "us-ashburn-1".

Sample:
us-phoenix-1
 
id
string
on success
The id of the replication policy.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
name
string
on success
The name of the policy.

Sample:
name_example
 
status
string
on success
The replication status of the policy. If the status is CLIENT_ERROR, once the user fixes the issue described in the status message, the status will become ACTIVE.

Sample:
ACTIVE
 
status_message
string
on success
A human-readable description of the status.

Sample:
status_message_example
 
time_created
string
on success
The date when the replication policy was created as per RFC 3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_last_sync
string
on success
Changes made to the source bucket before this time has been replicated.

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


Authors

  • Oracle (@oracle)