oracle / oracle.oci / 5.0.0 / module / oci_blockstorage_boot_volume_backup Manage a BootVolumeBackup resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_blockstorage_boot_volume_backup (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
This module allows the user to create, update and delete a BootVolumeBackup resource in Oracle Cloud Infrastructure
For I(state=present), creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, see L(Overview of Boot Volume Backups,https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/bootvolumebackups.htm)
When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.
This resource has the following action operations in the M(oracle.oci.oci_blockstorage_boot_volume_backup_actions) module: change_compartment, copy.
- name: Create boot_volume_backup oci_blockstorage_boot_volume_backup: # required boot_volume_id: "ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx" # optional type: FULL defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example freeform_tags: {'Department': 'Finance'} kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update boot_volume_backup oci_blockstorage_boot_volume_backup: # required boot_volume_backup_id: "ocid1.bootvolumebackup.oc1..xxxxxxEXAMPLExxxxxx" # optional defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example freeform_tags: {'Department': 'Finance'} kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update boot_volume_backup using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_blockstorage_boot_volume_backup: # required display_name: display_name_example compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" # optional defined_tags: {'Operations': {'CostCenter': 'US'}} freeform_tags: {'Department': 'Finance'} kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
- name: Delete boot_volume_backup oci_blockstorage_boot_volume_backup: # required boot_volume_backup_id: "ocid1.bootvolumebackup.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete boot_volume_backup using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_blockstorage_boot_volume_backup: # required display_name: display_name_example compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" state: absent
type: choices: - FULL - INCREMENTAL description: - The type of backup to create. If omitted, defaults to incremental. type: str wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the BootVolumeBackup. - Use I(state=present) to create or update a BootVolumeBackup. - Use I(state=absent) to delete a BootVolumeBackup. 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 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). - This parameter is updatable. 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 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 wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int 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 boot_volume_id: description: - The OCID of the boot volume that needs to be backed up. - Required for create using I(state=present). type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. 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 boot_volume_backup_id: aliases: - id description: - The OCID of the boot volume backup. - 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 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
boot_volume_backup: contains: boot_volume_id: description: - The OCID of the boot volume. returned: on success sample: ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx type: str compartment_id: description: - The OCID of the compartment that contains the boot 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 boot volume backup. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str image_id: description: - The image OCID used to create the boot volume the backup is taken from. returned: on success sample: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx type: str kms_key_id: description: - The OCID of the Vault service master encryption assigned to the boot 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 boot volume backup. returned: on success sample: CREATING type: str size_in_gbs: description: - The size of the boot volume, in GBs. returned: on success sample: 56 type: int source_boot_volume_backup_id: description: - The OCID of the source boot volume backup. returned: on success sample: ocid1.sourcebootvolumebackup.oc1..xxxxxxEXAMPLExxxxxx type: str source_type: description: - Specifies whether the backup was created manually, or via scheduled backup policy. returned: on success sample: MANUAL 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 boot 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 boot volume backup was received. Format defined by L(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 boot volume and whether the backup is full or incremental. returned: on success sample: 56 type: int description: - Details of the BootVolumeBackup resource acted upon by the current operation returned: on success sample: boot_volume_id: ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx 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 image_id: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx kms_key_id: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx lifecycle_state: CREATING size_in_gbs: 56 source_boot_volume_backup_id: ocid1.sourcebootvolumebackup.oc1..xxxxxxEXAMPLExxxxxx source_type: MANUAL 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 type: complex