oci_volume_backup_policy_facts – Fetches details about one or multiple VolumeBackupPolicy resources in Oracle Cloud Infrastructure

New in version 2.5.

Synopsis

  • Fetches details about one or multiple VolumeBackupPolicy resources in Oracle Cloud Infrastructure
  • Lists all volume backup policies available to the caller.
  • If policy_id is specified, the details of a single VolumeBackupPolicy will be returned.

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_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
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.
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
Use display_name along with the other options to return only resources that match the given display name exactly.
policy_id
-
The OCID of the volume backup policy.
Required to get a specific volume_backup_policy.

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.
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: List volume_backup_policies
  oci_volume_backup_policy_facts:

- name: Get a specific volume_backup_policy
  oci_volume_backup_policy_facts:
    policy_id: ocid1.policy.oc1..xxxxxxEXAMPLExxxxxx

Return Values

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

Key Returned Description
volume_backup_policies
complex
 on success
List of VolumeBackupPolicy resources

Sample:
[{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'schedules': [{'backup_type': 'FULL', 'offset_seconds': 56, 'period': 'ONE_HOUR', 'retention_seconds': 56}], 'time_created': '2013-10-20T19:20:30+01:00'}]
  display_name
string
 on success
A user-friendly name for the volume backup policy. Does not have to be unique and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
  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 backup to create.

Sample:
FULL
    offset_seconds
integer
 on success
The number of seconds that the backup time should be shifted from the default interval boundaries specified by the period. Backup time = Frequency start time + Offset.

Sample:
56
    period
string
 on success
How often the backup should occur.

Sample:
ONE_HOUR
    retention_seconds
integer
 on success
How long, in seconds, backups created by this schedule should be kept until being automatically deleted.

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

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


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Manoj Meda (@manojmeda)
  • Mike Ross (@mross22)
  • Nabeel Al-Saber (@nalsaber)

Hint

If you notice any issues in this documentation you can edit this document to improve it.