oci core volume backup

Overview

A point-in-time copy of a volume that can then be used to create a new block volume or recover a block volume. For more information, see Overview of Cloud Volume Storage.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Here is an example on how to use this:

oci_core_volume_backup { 'tenant (root)/my_backup':
    ensure              => 'present',
    volume              => 'my_compartment/my_volume',
  }

This documentation is generated from the Ruby OCI SDK.

Attributes

absent_states

The OCI states, puppet will detect as the resource being absent.

Back to overview of oci_core_volume_backup

compartment

The Puppet name of the resource identified by compartment_id.

See the documentation of compartment_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

compartment_id

The OCID of the compartment that contains the object.

Rather use the property compartment instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

defined_tags

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 documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

disable_corrective_change

Disable the modification of a resource when Puppet decides it is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet Server, Puppet knows about adaptive and corrective changes. A corrective change is when Puppet notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet is managing. The normal Puppet process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_change parameter, you can disable corrective changes on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ...
  disable_corrective_change => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not modify the resource and signal an error:

    Error: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/parameter: change from '10' to '20' failed: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change. (corrective)

Back to overview of oci_core_volume_backup

disable_corrective_ensure

Disable the creation or removal of a resource when Puppet decides is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet Server, Puppet knows about adaptive and corrective changes. A corrective change is when Puppet notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet is managing. The normal Puppet process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_ensure parameter, you can disable corrective ensure present or ensure absent actions on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ensure                    => 'present',
  ...
  disable_corrective_ensure => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not create or remove the resource and signal an error:

    Error: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure.
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/ensure: change from 'absent' to 'present' failed: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure. (corrective)

Back to overview of oci_core_volume_backup

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of oci_core_volume_backup

expiration_time

The date and time the volume backup will expire and be automatically deleted. Format defined by 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.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

freeform_tags

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 documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

id

The OCID of the resource. This is a read-only property.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

kms_key

The Puppet name of the resource identified by kms_key_id.

See the documentation of kms_key_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

kms_key_id

The OCID of the KMS key which is the master encryption key for the volume backup. For more information about the Key Management service and encryption keys, see Overview of Key Management and Using Keys. Rather use the property kms_key instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

lifecycle_state

The current state of a volume backup.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

name

The full name of the object.

Back to overview of oci_core_volume_backup

oci_timeout

The maximum time to wait for the OCI resource to be in the ready state.

Back to overview of oci_core_volume_backup

oci_wait_interval

The interval beween calls to OCI to check if a resource is in the ready state.

Back to overview of oci_core_volume_backup

present_states

The OCI states, puppet will detect as the resource being present.

Back to overview of oci_core_volume_backup

provider

The specific backend to use for this oci_core_volume_backup resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.Available providers are:

sdk

This provider uses the Oracle Ruby OCI SDK to do its work.

Back to overview of oci_core_volume_backup

size_in_gbs

The size of the volume, in GBs.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

size_in_mbs

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

source_type

Specifies whether the backup was created manually, or via scheduled backup policy.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

source_volume_backup

The Puppet name of the resource identified by source_volume_backup_id.

See the documentation of source_volume_backup_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

source_volume_backup_id

The OCID of the source volume backup. Rather use the property source_volume_backup instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

synchronized

Specifies if Puppet waits for OCI actions to be ready before moving on to an other resource.

Back to overview of oci_core_volume_backup

system_tags

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

tenant

The tenant for this resource.

Back to overview of oci_core_volume_backup

time_created

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.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

time_request_received

The date and time the request to create the volume backup was received. Format defined by RFC3339.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

type

The type of backup to create. If omitted, defaults to INCREMENTAL.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

unique_size_in_gbs

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.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

unique_size_in_mbs

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.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

volume

The Puppet name of the resource identified by volume_id.

See the documentation of volume_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup

volume_backup_name

The name of the volume_backup.

Back to overview of oci_core_volume_backup

volume_id

The OCID of the volume that needs to be backed up. Rather use the property volume instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_volume_backup