oracle.oci.oci_blockstorage_volume_backup_policy – Manage a VolumeBackupPolicy 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_blockstorage_volume_backup_policy.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new user defined backup policy.

  • For more information about Oracle defined backup policies and user defined backup policies, see Policy-Based Backups.

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.
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 for create using state=present.
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.
destination_region
string
The paired destination region for copying scheduled backups to. Example: `us-ashburn-1`. See Region Pairs for details about paired regions.
This parameter is updatable.
display_name
string
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 OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
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.
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.
policy_id
string
The OCID of the volume backup policy.
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
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.
schedules
list / elements=dictionary
The collection of schedules for the volume backup policy. See see Schedules in Policy-Based Backups for more information.
This parameter is updatable.
backup_type
string / required
    Choices:
  • FULL
  • INCREMENTAL
The type of volume backup to create.
day_of_month
integer
The day of the month to schedule the volume backup.
day_of_week
string
    Choices:
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY
The day of the week to schedule the volume backup.
hour_of_day
integer
The hour of the day to schedule the volume backup.
month
string
    Choices:
  • JANUARY
  • FEBRUARY
  • MARCH
  • APRIL
  • MAY
  • JUNE
  • JULY
  • AUGUST
  • SEPTEMBER
  • OCTOBER
  • NOVEMBER
  • DECEMBER
The month of the year to schedule the volume backup.
offset_seconds
integer
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.
offset_type
string
    Choices:
  • STRUCTURED
  • NUMERIC_SECONDS
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`.
period
string / required
    Choices:
  • ONE_HOUR
  • ONE_DAY
  • ONE_WEEK
  • ONE_MONTH
  • ONE_YEAR
The volume backup frequency.
retention_seconds
integer / required
How long, in seconds, to keep the volume backups created by this schedule.
time_zone
string
    Choices:
  • UTC
  • REGIONAL_DATA_CENTER_TIME
Specifies what time zone is the schedule in
state
string
    Choices:
  • present ←
  • absent
The state of the VolumeBackupPolicy.
Use state=present to create or update a VolumeBackupPolicy.
Use state=absent to delete a VolumeBackupPolicy.
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 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

Return Values

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

Key Returned Description
volume_backup_policy
complex
on success
Details of the VolumeBackupPolicy resource acted upon by the current operation

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'}
 
compartment_id
string
on success
The OCID of the compartment that contains the volume backup.

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'}}
 
destination_region
string
on success
The paired destination region for copying scheduled backups to. Example `us-ashburn-1`. See Region Pairs for details about paired regions.

Sample:
us-phoenix-1
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

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 volume backup policy.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
schedules
complex
on success
The collection of schedules that this policy will apply.

   
backup_type
string
on success
The type of volume backup to create.

Sample:
FULL
   
day_of_month
integer
on success
The day of the month to schedule the volume backup.

Sample:
56
   
day_of_week
string
on success
The day of the week to schedule the volume backup.

Sample:
MONDAY
   
hour_of_day
integer
on success
The hour of the day to schedule the volume backup.

Sample:
56
   
month
string
on success
The month of the year to schedule the volume backup.

Sample:
JANUARY
   
offset_seconds
integer
on success
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.

Sample:
56
   
offset_type
string
on success
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`.

Sample:
STRUCTURED
   
period
string
on success
The volume backup frequency.

Sample:
ONE_HOUR
   
retention_seconds
integer
on success
How long, in seconds, to keep the volume backups created by this schedule.

Sample:
56
   
time_zone
string
on success
Specifies what time zone is the schedule in

Sample:
UTC
 
time_created
string
on success
The date and time the volume backup policy was created. Format defined by RFC3339.

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


Authors

  • Oracle (@oracle)