Try SpotterManage a VolumeBackupPolicy resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0This module allows the user to create, update and delete a VolumeBackupPolicy resource in Oracle Cloud Infrastructure
For I(state=present), creates a new user defined backup policy.
For more information about Oracle defined backup policies and user defined backup policies, see L(Policy-Based Backups,https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).
- name: Create volume_backup_policy
oci_blockstorage_volume_backup_policy:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
destination_region: us-phoenix-1
schedules:
- # required
backup_type: FULL
period: ONE_HOUR
retention_seconds: 56
# optional
offset_seconds: 56
offset_type: STRUCTURED
hour_of_day: 56
day_of_week: MONDAY
day_of_month: 56
month: JANUARY
time_zone: UTC
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
- name: Update volume_backup_policy
oci_blockstorage_volume_backup_policy:
# required
policy_id: "ocid1.policy.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
destination_region: us-phoenix-1
schedules:
- # required
backup_type: FULL
period: ONE_HOUR
retention_seconds: 56
# optional
offset_seconds: 56
offset_type: STRUCTURED
hour_of_day: 56
day_of_week: MONDAY
day_of_month: 56
month: JANUARY
time_zone: UTC
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
- name: Update volume_backup_policy using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_blockstorage_volume_backup_policy:
# required
display_name: display_name_example
# optional
destination_region: us-phoenix-1
schedules:
- # required
backup_type: FULL
period: ONE_HOUR
retention_seconds: 56
# optional
offset_seconds: 56
offset_type: STRUCTURED
hour_of_day: 56
day_of_week: MONDAY
day_of_month: 56
month: JANUARY
time_zone: UTC
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
- name: Delete volume_backup_policy
oci_blockstorage_volume_backup_policy:
# required
policy_id: "ocid1.policy.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete volume_backup_policy using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_blockstorage_volume_backup_policy:
# required
display_name: display_name_example
state: absent
state:
choices:
- present
- absent
default: present
description:
- The state of the VolumeBackupPolicy.
- Use I(state=present) to create or update a VolumeBackupPolicy.
- Use I(state=absent) to delete a VolumeBackupPolicy.
required: false
type: str
key_by:
description: 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.
elements: str
type: list
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
policy_id:
aliases:
- id
description:
- The OCID of the volume backup policy.
- Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
- Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
type: str
schedules:
description:
- The collection of schedules for the volume backup policy. See see L(Schedules,https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#schedules)
in L(Policy-Based Backups,https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm)
for more information.
- This parameter is updatable.
elements: dict
suboptions:
backup_type:
choices:
- FULL
- INCREMENTAL
description:
- The type of volume backup to create.
required: true
type: str
day_of_month:
description:
- The day of the month to schedule the volume backup.
type: int
day_of_week:
choices:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
description:
- The day of the week to schedule the volume backup.
type: str
hour_of_day:
description:
- The hour of the day to schedule the volume backup.
type: int
month:
choices:
- JANUARY
- FEBRUARY
- MARCH
- APRIL
- MAY
- JUNE
- JULY
- AUGUST
- SEPTEMBER
- OCTOBER
- NOVEMBER
- DECEMBER
description:
- The month of the year to schedule the volume backup.
type: str
offset_seconds:
description:
- The number of seconds that the volume backup start time should be shifted from
the default interval boundaries specified by the period. The volume backup start
time is the frequency start time plus the offset.
type: int
offset_type:
choices:
- STRUCTURED
- NUMERIC_SECONDS
description:
- Indicates how the offset is defined. If value is `STRUCTURED`, then `hourOfDay`,
`dayOfWeek`, `dayOfMonth`, and `month` fields are used and `offsetSeconds` will
be ignored in requests and users should ignore its value from the responses.
- '`hourOfDay` is applicable for periods `ONE_DAY`, `ONE_WEEK`, `ONE_MONTH` and
`ONE_YEAR`.'
- '`dayOfWeek` is applicable for period `ONE_WEEK`.'
- '`dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`.'
- '''month'' is applicable for period ''ONE_YEAR''.'
- They will be ignored in the requests for inapplicable periods.
- If value is `NUMERIC_SECONDS`, then `offsetSeconds` will be used for both requests
and responses and the structured fields will be ignored in the requests and
users should ignore their values from the responses.
- For clients using older versions of Apis and not sending `offsetType` in their
requests, the behaviour is just like `NUMERIC_SECONDS`.
type: str
period:
choices:
- ONE_HOUR
- ONE_DAY
- ONE_WEEK
- ONE_MONTH
- ONE_YEAR
description:
- The volume backup frequency.
required: true
type: str
retention_seconds:
description:
- How long, in seconds, to keep the volume backups created by this schedule.
required: true
type: int
time_zone:
choices:
- UTC
- REGIONAL_DATA_CENTER_TIME
description:
- Specifies what time zone is the schedule in
type: str
type: list
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
- This parameter is updatable.
type: dict
display_name:
aliases:
- name
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering
confidential information.
- Required for create, update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is set.
- This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set.
type: str
force_create:
default: false
description: 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 I(key_by).
type: bool
freeform_tags:
description:
- 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 L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
- This parameter is updatable.
type: dict
compartment_id:
description:
- The OCID of the compartment.
- Required for create using I(state=present).
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
destination_region:
description:
- 'The paired destination region for copying scheduled backups to. Example: `us-ashburn-1`.
See L(Region Pairs,https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#RegionPairs)
for details about paired regions.'
- This parameter is updatable.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
volume_backup_policy:
contains:
compartment_id:
description:
- The OCID of the compartment that contains the volume backup.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
destination_region:
description:
- The paired destination region for copying scheduled backups to. Example `us-ashburn-1`.
See L(Region Pairs,https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#RegionPairs)
for details about paired regions.
returned: on success
sample: us-phoenix-1
type: str
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid
entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The OCID of the volume backup policy.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
schedules:
contains:
backup_type:
description:
- The type of volume backup to create.
returned: on success
sample: FULL
type: str
day_of_month:
description:
- The day of the month to schedule the volume backup.
returned: on success
sample: 56
type: int
day_of_week:
description:
- The day of the week to schedule the volume backup.
returned: on success
sample: MONDAY
type: str
hour_of_day:
description:
- The hour of the day to schedule the volume backup.
returned: on success
sample: 56
type: int
month:
description:
- The month of the year to schedule the volume backup.
returned: on success
sample: JANUARY
type: str
offset_seconds:
description:
- The number of seconds that the volume backup start time should be shifted
from the default interval boundaries specified by the period. The volume
backup start time is the frequency start time plus the offset.
returned: on success
sample: 56
type: int
offset_type:
description:
- Indicates how the offset is defined. If value is `STRUCTURED`, then `hourOfDay`,
`dayOfWeek`, `dayOfMonth`, and `month` fields are used and `offsetSeconds`
will be ignored in requests and users should ignore its value from the
responses.
- '`hourOfDay` is applicable for periods `ONE_DAY`, `ONE_WEEK`, `ONE_MONTH`
and `ONE_YEAR`.'
- '`dayOfWeek` is applicable for period `ONE_WEEK`.'
- '`dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`.'
- '''month'' is applicable for period ''ONE_YEAR''.'
- They will be ignored in the requests for inapplicable periods.
- If value is `NUMERIC_SECONDS`, then `offsetSeconds` will be used for both
requests and responses and the structured fields will be ignored in the
requests and users should ignore their values from the responses.
- For clients using older versions of Apis and not sending `offsetType`
in their requests, the behaviour is just like `NUMERIC_SECONDS`.
returned: on success
sample: STRUCTURED
type: str
period:
description:
- The volume backup frequency.
returned: on success
sample: ONE_HOUR
type: str
retention_seconds:
description:
- How long, in seconds, to keep the volume backups created by this schedule.
returned: on success
sample: 56
type: int
time_zone:
description:
- Specifies what time zone is the schedule in
returned: on success
sample: UTC
type: str
description:
- The collection of schedules that this policy will apply.
returned: on success
type: complex
time_created:
description:
- The date and time the volume backup policy was created. Format defined by
L(RFC3339,https://tools.ietf.org/html/rfc3339).
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- Details of the VolumeBackupPolicy resource acted upon by the current operation
returned: on success
sample:
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
defined_tags:
Operations:
CostCenter: US
destination_region: us-phoenix-1
display_name: display_name_example
freeform_tags:
Department: Finance
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
schedules:
- backup_type: FULL
day_of_month: 56
day_of_week: MONDAY
hour_of_day: 56
month: JANUARY
offset_seconds: 56
offset_type: STRUCTURED
period: ONE_HOUR
retention_seconds: 56
time_zone: UTC
time_created: '2013-10-20T19:20:30+01:00'
type: complex