oracle / oracle.oci / 5.0.0 / module / oci_blockstorage_volume_backup_facts Fetches details about one or multiple VolumeBackup resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_blockstorage_volume_backup_facts (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
Fetches details about one or multiple VolumeBackup resources in Oracle Cloud Infrastructure
Lists the volume backups in the specified compartment. You can filter the results by volume.
If I(volume_backup_id) is specified, the details of a single VolumeBackup will be returned.
- name: Get a specific volume_backup oci_blockstorage_volume_backup_facts: # required volume_backup_id: "ocid1.volumebackup.oc1..xxxxxxEXAMPLExxxxxx"
- name: List volume_backups oci_blockstorage_volume_backup_facts: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" # optional volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example source_volume_backup_id: "ocid1.sourcevolumebackup.oc1..xxxxxxEXAMPLExxxxxx" sort_by: TIMECREATED sort_order: ASC lifecycle_state: CREATING
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 sort_by: choices: - TIMECREATED - DISPLAYNAME description: - The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. - '**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.' 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 volume_id: description: - The OCID of the volume. type: str sort_order: choices: - ASC - DESC description: - The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. type: str 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 display_name: aliases: - name description: - A filter to return only resources that match the given display name exactly. type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. - Required to list multiple volume_backups. type: str lifecycle_state: choices: - CREATING - AVAILABLE - TERMINATING - TERMINATED - FAULTY - REQUEST_RECEIVED description: - A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. type: str volume_backup_id: aliases: - id description: - The OCID of the volume backup. - Required to get a specific volume_backup. 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 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 source_volume_backup_id: description: - A filter to return only resources that originated from the given source volume backup. 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_backups: 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 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 expiration_time: description: - The date and time the volume backup will expire and be automatically deleted. Format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339). This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted. returned: on success sample: '2013-10-20T19:20:30+01:00' 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. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str kms_key_id: description: - The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see L(Overview of Vault service,https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and L(Using Keys,https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm). returned: on success sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_state: description: - The current state of a volume backup. returned: on success sample: CREATING type: str size_in_gbs: description: - The size of the volume, in GBs. returned: on success sample: 56 type: int size_in_mbs: description: - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs. returned: on success sample: 56 type: int source_type: description: - Specifies whether the backup was created manually, or via scheduled backup policy. returned: on success sample: MANUAL type: str source_volume_backup_id: description: - The OCID of the source volume backup. returned: on success sample: ocid1.sourcevolumebackup.oc1..xxxxxxEXAMPLExxxxxx type: str system_tags: description: - 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`' returned: on success sample: {} type: dict time_created: description: - 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 L(RFC3339,https://tools.ietf.org/html/rfc3339). returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_request_received: description: - The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str type: description: - The type of a volume backup. returned: on success sample: FULL type: str unique_size_in_gbs: description: - 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. returned: on success sample: 56 type: int unique_size_in_mbs: description: - 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. This field is deprecated. Please use uniqueSizeInGBs. returned: on success sample: 56 type: int volume_id: description: - The OCID of the volume. returned: on success sample: ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx type: str description: - List of VolumeBackup resources returned: on success sample: - compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx defined_tags: Operations: CostCenter: US display_name: display_name_example expiration_time: '2013-10-20T19:20:30+01:00' freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx kms_key_id: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx lifecycle_state: CREATING size_in_gbs: 56 size_in_mbs: 56 source_type: MANUAL source_volume_backup_id: ocid1.sourcevolumebackup.oc1..xxxxxxEXAMPLExxxxxx system_tags: {} time_created: '2013-10-20T19:20:30+01:00' time_request_received: '2013-10-20T19:20:30+01:00' type: FULL unique_size_in_gbs: 56 unique_size_in_mbs: 56 volume_id: ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx type: complex