oci_volume_backup_facts - Retrieve facts of volume backups in OCI Block Volume service

New in version 2.5.

Synopsis

  • This module retrieves information of a specified volume backup or all the volume backups in a compartment in OCI Block Volume service.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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
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
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
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
    Choices:
  • api_key ←
  • instance_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.
compartment_id
The OCID of the compartment.
config_file_location
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 Default:
DEFAULT
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
Use display_name along with the other options to return only resources that match the given display name exactly.
region
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
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
volume_backup_id
The OCID of the volume backup.

aliases: id

Examples

- name: Get information of all the volume backups in a compartment
  oci_volume_backup_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx

- name: Get information of a volume backup
  oci_volume_backup_facts:
    id: ocid1.volumebackup.oc1.iad.xxxxxEXAMPLExxxxx

Return Values

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

Key Returned Description
volume_backups
complex
 on success
List of volume backup information

Sample:
[{'lifecycle_state': 'AVAILABLE', 'size_in_gbs': 50, 'display_name': 'ansible_backup', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'size_in_mbs': 51200, 'time_created': '2017-12-22T15:40:53.219000+00:00', 'unique_size_in_gbs': 0, 'volume_id': 'ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx', 'unique_size_in_mbs': 1, 'time_request_received': '2017-12-22T15:40:48.111000+00:00', 'id': 'ocid1.volumebackup.oc1.iad.xxxxxEXAMPLExxxxx'}]
  lifecycle_state
string
 always
The current state of a volume backup. Allowed values for this property are "CREATING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY", "REQUEST_RECEIVED", 'UNKNOWN_ENUM_VALUE'.

Sample:
AVAILABLE
  size_in_gbs
string
 always
The size of the volume, in GBs.

Sample:
50
  display_name
string
 always
A user-friendly name for the volume backup.

Sample:
test_backup
  compartment_id
string
 always
The OCID of the compartment that contains the volume backup.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  size_in_mbs
string
 always
The size of the volume, in MBs.

Sample:
51200
  time_created
string
 always
The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.

Sample:
2017-12-22 15:40:53.219000
  unique_size_in_gbs
string
 always
The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
  volume_id
string
 always
The OCID of the volume.

Sample:
ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx
  unique_size_in_mbs
string
 always
The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental.

Sample:
1
  time_request_received
string
 always
The date and time the request to create the volume backup was received. Format defined by RFC3339.

Sample:
2017-12-22 15:40:48.111000
  id
string
 always
The OCID of the volume backup.

Sample:
ocid1.volumebackup.oc1.iad.xxxxxEXAMPLExxxxx


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Rohit Chaware (@rohitChaware)

Hint

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