oracle.oci.oci_file_storage_snapshot – Manage a Snapshot resource 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_snapshot
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Snapshot resource in Oracle Cloud Infrastructure
For state=present, creates a new snapshot of the specified file system. You can access the snapshot at .snapshot/<name>.
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. |
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 . |
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
|
expiration_time
string
|
The time when this snapshot will be deleted.
This parameter is updatable.
|
|
file_system_id
string
|
The OCID of the file system to take a snapshot of.
Required for create using state=present.
|
|
force_create
boolean
|
|
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.
|
freeform_tags
dictionary
|
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"}`
This parameter is updatable.
|
|
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
|
Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.
Avoid entering confidential information.
Example: `Sunday`
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|
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. |
|
snapshot_id
string
|
The OCID of the snapshot.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|
state
string
|
|
The state of the Snapshot.
Use state=present to create or update a Snapshot.
Use state=absent to delete a Snapshot.
|
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
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create snapshot
oci_file_storage_snapshot:
# required
file_system_id: "ocid1.filesystem.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
# optional
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
expiration_time: expiration_time_example
- name: Update snapshot
oci_file_storage_snapshot:
# required
snapshot_id: "ocid1.snapshot.oc1..xxxxxxEXAMPLExxxxxx"
# optional
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
expiration_time: expiration_time_example
- name: Update snapshot using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_file_storage_snapshot:
# required
name: name_example
# optional
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
expiration_time: expiration_time_example
- name: Delete snapshot
oci_file_storage_snapshot:
# required
snapshot_id: "ocid1.snapshot.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete snapshot using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_file_storage_snapshot:
# required
name: name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
snapshot
complex
|
on success |
Details of the Snapshot resource acted upon by the current operation
Sample:
{'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'expiration_time': '2013-10-20T19:20:30+01:00', 'file_system_id': 'ocid1.filesystem.oc1..xxxxxxEXAMPLExxxxxx', 'filesystem_snapshot_policy_id': 'ocid1.filesystemsnapshotpolicy.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_clone_source': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'name': 'name_example', 'provenance_id': 'ocid1.provenance.oc1..xxxxxxEXAMPLExxxxxx', 'snapshot_time': '2013-10-20T19:20:30+01:00', 'snapshot_type': 'USER', 'time_created': '2013-10-20T19:20:30+01:00'}
|
|
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'}}
|
|
expiration_time
string
|
on success |
The time when this snapshot will be deleted.
Sample:
2013-10-20T19:20:30+01:00
|
|
file_system_id
string
|
on success |
The OCID of the file system from which the snapshot was created.
Sample:
ocid1.filesystem.oc1..xxxxxxEXAMPLExxxxxx
|
|
filesystem_snapshot_policy_id
string
|
on success |
The OCID of the file system snapshot policy that created this snapshot.
Sample:
ocid1.filesystemsnapshotpolicy.oc1..xxxxxxEXAMPLExxxxxx
|
|
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 snapshot.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
is_clone_source
boolean
|
on success |
Specifies whether the snapshot has been cloned. See Cloning a File System.
Sample:
True
|
|
lifecycle_details
string
|
on success |
Additional information about the current `lifecycleState`.
Sample:
lifecycle_details_example
|
|
lifecycle_state
string
|
on success |
The current state of the snapshot.
Sample:
CREATING
|
|
name
string
|
on success |
Name of the snapshot. This value is immutable.
Avoid entering confidential information.
Example: `Sunday`
Sample:
name_example
|
|
provenance_id
string
|
on success |
An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value. If this snapshot was cloned, then the `provenanceId` value is the parent's `provenanceId`. See Cloning a File System.
Sample:
ocid1.provenance.oc1..xxxxxxEXAMPLExxxxxx
|
|
snapshot_time
string
|
on success |
The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from `timeCreated` depending on the following factors: - If the snapshot is created in the original file system directory. - If the snapshot is cloned from a file system. - If the snapshot is replicated from a file system.
Example: `2020-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
|
snapshot_type
string
|
on success |
Specifies generation type of the snapshot.
Sample:
USER
|
|
time_created
string
|
on success |
The date and time the snapshot was created, expressed in RFC 3339 timestamp format.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)