oracle.oci.oci_file_storage_filesystem_snapshot_policy_actions – Perform actions on a FilesystemSnapshotPolicy resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_filesystem_snapshot_policy_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a FilesystemSnapshotPolicy resource in Oracle Cloud Infrastructure
For action=change_compartment, moves a file system snapshot policy into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
For action=pause, this operation pauses the scheduled snapshot creation and snapshot deletion of the policy and updates the lifecycle state of the file system snapshot policy from ACTIVE to INACTIVE. When a file system snapshot policy is paused, file systems that are associated with the policy will not have scheduled snapshots created or deleted. If the policy is already paused, or in the INACTIVE state, you cannot pause it again. You can’t pause a policy that is in a DELETING, DELETED, FAILED, CREATING or INACTIVE state; attempts to pause a policy in these states result in a 409 conflict error.
For action=unpause, this operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from INACTIVE to ACTIVE. By default, file system snapshot policies are in the ACTIVE state. When a file system snapshot policy is not paused, or in the ACTIVE state, file systems that are associated with the policy will have snapshots created and deleted according to the schedules defined in the policy. If the policy is already in the ACTIVE state, you cannot unpause it. You can’t unpause a policy that is in a DELETING, DELETED, FAILED, CREATING, or ACTIVE state; attempts to unpause a policy in these states result in a 409 conflict error.
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 |
---|---|---|
action
string
/ required
|
|
The action to perform on the FilesystemSnapshotPolicy.
|
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.
|
|
compartment_id
string
|
The OCID of the compartment to move the file system snapshot policy to.
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 . |
|
filesystem_snapshot_policy_id
string
/ required
|
The OCID of the file system snapshot policy.
aliases: id |
|
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. |
|
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: Perform action change_compartment on filesystem_snapshot_policy
oci_file_storage_filesystem_snapshot_policy_actions:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
filesystem_snapshot_policy_id: "ocid1.filesystemsnapshotpolicy.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
- name: Perform action pause on filesystem_snapshot_policy
oci_file_storage_filesystem_snapshot_policy_actions:
# required
filesystem_snapshot_policy_id: "ocid1.filesystemsnapshotpolicy.oc1..xxxxxxEXAMPLExxxxxx"
action: pause
- name: Perform action unpause on filesystem_snapshot_policy
oci_file_storage_filesystem_snapshot_policy_actions:
# required
filesystem_snapshot_policy_id: "ocid1.filesystemsnapshotpolicy.oc1..xxxxxxEXAMPLExxxxxx"
action: unpause
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
filesystem_snapshot_policy
complex
|
on success |
Details of the FilesystemSnapshotPolicy resource acted upon by the current operation
Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'policy_prefix': 'policy_prefix_example', 'schedules': [{'day_of_month': 56, 'day_of_week': 'MONDAY', 'hour_of_day': 56, 'month': 'JANUARY', 'period': 'HOURLY', 'retention_duration_in_seconds': 56, 'schedule_prefix': 'schedule_prefix_example', 'time_schedule_start': '2013-10-20T19:20:30+01:00', 'time_zone': 'UTC'}], 'time_created': '2013-10-20T19:20:30+01:00'}
|
||
availability_domain
string
|
on success |
The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value.
Example: `Uocm:PHX-AD-2`
Sample:
Uocm:PHX-AD-1
|
||
compartment_id
string
|
on success |
The OCID of the compartment that contains the file system snapshot policy.
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'}}
|
||
display_name
string
|
on success |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Example: `policy1`
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 file system snapshot policy.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_state
string
|
on success |
The current state of the file system snapshot policy.
Sample:
CREATING
|
||
policy_prefix
string
|
on success |
The prefix to apply to all snapshots created by this policy.
Example: `acme`
Sample:
policy_prefix_example
|
||
schedules
complex
|
on success |
The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
|
||
day_of_month
integer
|
on success |
The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules.
Sample:
56
|
||
day_of_week
string
|
on success |
The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules.
Sample:
MONDAY
|
||
hour_of_day
integer
|
on success |
The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, a value will be chosen at creation time.
Sample:
56
|
||
month
string
|
on success |
The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules.
Sample:
JANUARY
|
||
period
string
|
on success |
The frequency of scheduled snapshots.
Sample:
HOURLY
|
||
retention_duration_in_seconds
integer
|
on success |
The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty.
Sample:
56
|
||
schedule_prefix
string
|
on success |
A name prefix to be applied to snapshots created by this schedule.
Example: `compliance1`
Sample:
schedule_prefix_example
|
||
time_schedule_start
string
|
on success |
The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format. If no `timeScheduleStart` is provided, the value will be set to the time when the schedule was created.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_zone
string
|
on success |
Time zone used for scheduling the snapshot.
Sample:
UTC
|
||
time_created
string
|
on success |
The date and time the file system snapshot policy 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)