oracle.oci.oci_file_storage_replication_target_facts – Fetches details about one or multiple ReplicationTarget resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_file_storage_replication_target_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ReplicationTarget resources in Oracle Cloud Infrastructure
Lists the replication target resources in the specified compartment.
If replication_target_id is specified, the details of a single ReplicationTarget 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. |
availability_domain
string
|
The name of the availability domain.
Example: `Uocm:PHX-AD-1`
Required to list multiple replication_targets.
|
|
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.
Required to list multiple replication_targets.
|
|
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 . |
|
display_name
string
|
A user-friendly name. It does not have to be unique, and it is changeable.
Example: `My resource`
aliases: name |
|
lifecycle_state
string
|
|
Filter results by the specified lifecycle state. Must be a valid state for the resource type.
|
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. |
|
replication_target_id
string
|
The OCID of the replication target.
Required to get a specific replication_target.
aliases: id |
|
sort_by
string
|
|
The field to sort by. You can choose either value, but not both. By default, when you sort by `timeCreated`, results are shown in descending order. When you sort by `displayName`, results are shown in ascending order.
|
sort_order
string
|
|
The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values.
|
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 |
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 replication_target
oci_file_storage_replication_target_facts:
# required
replication_target_id: "ocid1.replicationtarget.oc1..xxxxxxEXAMPLExxxxxx"
- name: List replication_targets
oci_file_storage_replication_target_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
availability_domain: Uocm:PHX-AD-1
# optional
lifecycle_state: CREATING
display_name: display_name_example
sort_by: timeCreated
sort_order: ASC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
replication_targets
complex
|
on success |
List of ReplicationTarget resources
Sample:
[{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'delta_progress': 56, 'delta_status': 'IDLE', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'last_snapshot_id': 'ocid1.lastsnapshot.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'recovery_point_time': '2013-10-20T19:20:30+01:00', 'replication_id': 'ocid1.replication.oc1..xxxxxxEXAMPLExxxxxx', 'source_id': 'ocid1.source.oc1..xxxxxxEXAMPLExxxxxx', 'target_id': 'ocid1.target.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00'}]
|
|
availability_domain
string
|
on success |
The availability domain the replication resource is in. May be unset as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
Sample:
Uocm:PHX-AD-1
|
|
compartment_id
string
|
on success |
The OCID of the compartment that contains the replication.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
delta_progress
integer
|
on success |
Percentage progress of the current replication cycle.
Returned for get operation
Sample:
56
|
|
delta_status
string
|
on success |
The current state of the snapshot during replication operations.
Returned for get operation
Sample:
IDLE
|
|
display_name
string
|
on success |
A user-friendly name. This name is same as the replication display name for the associated resource. Example: `My Replication`
Sample:
display_name_example
|
|
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
|
id
string
|
on success |
The OCID of the replication.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
last_snapshot_id
string
|
on success |
The OCID of the last snapshot snapshot which was completely applied to the target file system. Empty while the initial snapshot is being applied.
Returned for get operation
Sample:
ocid1.lastsnapshot.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_details
string
|
on success |
Additional information about the current `lifecycleState`.
Sample:
lifecycle_details_example
|
|
lifecycle_state
string
|
on success |
The current state of this replication.
Sample:
CREATING
|
|
recovery_point_time
string
|
on success |
The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: `2021-04-04T20:01:29.100Z`
Sample:
2013-10-20T19:20:30+01:00
|
|
replication_id
string
|
on success |
The OCID of replication.
Returned for get operation
Sample:
ocid1.replication.oc1..xxxxxxEXAMPLExxxxxx
|
|
source_id
string
|
on success |
The OCID of source filesystem.
Returned for get operation
Sample:
ocid1.source.oc1..xxxxxxEXAMPLExxxxxx
|
|
target_id
string
|
on success |
The OCID of target filesystem.
Returned for get operation
Sample:
ocid1.target.oc1..xxxxxxEXAMPLExxxxxx
|
|
time_created
string
|
on success |
The date and time the replication target was created in target region. in RFC 3339 timestamp format. Example: `2021-01-04T20:01:29.100Z`
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)