oci core boot volume
Overview
A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see Overview of Boot Volumes.
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.
This documentation is generated from the Ruby OCI SDK.
Attributes
Attribute Name | Short Description |
---|---|
absent_states | The OCI states, puppet will detect as the resource being absent. |
availability_domain | The availability domain of the boot volume. |
backup_policy | The Puppet name of the resource identified by backup_policy_id . |
backup_policy_id | created boot volume. |
boot_volume_name | The name of the boot_volume. |
compartment | The Puppet name of the resource identified by compartment_id . |
compartment_id | The OCID of the compartment that contains the object. |
defined_tags | Defined tags for this resource. |
disable_corrective_change | Disable the modification of a resource when Puppet decides it is a corrective change. |
disable_corrective_ensure | Disable the creation or removal of a resource when Puppet decides is a corrective change. |
ensure | The basic property that the resource should be in. |
freeform_tags | Free-form tags for this resource. |
id | The OCID of the resource. |
image | The Puppet name of the resource identified by image_id . |
image_id | The image OCID used to create the boot volume. |
is_hydrated | Specifies whether the boot volume’s data has finished copying from the source boot volume or boot volume backup. |
kms_key | The Puppet name of the resource identified by kms_key_id . |
kms_key_id | for the boot volume. |
lifecycle_state | The current state of a boot volume. |
name | The full name of the object. |
oci_timeout | The maximum time to wait for the OCI resource to be in the ready state. |
oci_wait_interval | The interval beween calls to OCI to check if a resource is in the ready state. |
present_states | The OCI states, puppet will detect as the resource being present. |
provider | resource. |
size_in_gbs | The size of the volume in GBs. |
source_details | Specifies the boot volume source details for a new boot volume. |
synchronized | Specifies if Puppet waits for OCI actions to be ready before moving on to an other resource. |
system_tags | System tags for this resource. |
tenant | The tenant for this resource. |
time_created | The date and time the boot volume was created. |
volume_group | The Puppet name of the resource identified by volume_group_id . |
volume_group_id | The OCID of the source volume group. |
vpus_per_gb | representing the Block Volume service’s elastic performance options. |
absent_states
The OCI states, puppet will detect as the resource being absent.
Back to overview of oci_core_boot_volume
availability_domain
The availability domain of the boot volume.
Example: Uocm:PHX-AD-1
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
backup_policy
The Puppet name of the resource identified by backup_policy_id
.
See the documentation of backup_policy_id for all details.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
backup_policy_id
If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. Rather use the property backup_policy
instead of a direct OCID reference.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
boot_volume_name
The name of the boot_volume.
Back to overview of oci_core_boot_volume
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_boot_volume
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_boot_volume
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_boot_volume
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_boot_volume
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_boot_volume
ensure
The basic property that the resource should be in.
Valid values are present
, absent
.
Back to overview of oci_core_boot_volume
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_boot_volume
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_boot_volume
image
The Puppet name of the resource identified by image_id
.
See the documentation of image_id for all details.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
image_id
The image OCID used to create the boot volume. Rather use the property image
instead of a direct OCID reference.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
is_hydrated
Specifies whether the boot volume’s data has finished copying from the source boot volume or boot volume backup.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
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_boot_volume
kms_key_id
The OCID of the Key Management key to assign as the master encryption key for the boot volume. 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_boot_volume
lifecycle_state
The current state of a boot volume.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
name
The full name of the object.
Back to overview of oci_core_boot_volume
oci_timeout
The maximum time to wait for the OCI resource to be in the ready state.
Back to overview of oci_core_boot_volume
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_boot_volume
present_states
The OCI states, puppet will detect as the resource being present.
Back to overview of oci_core_boot_volume
provider
The specific backend to use for this oci_core_boot_volume
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_boot_volume
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_boot_volume
source_details
Specifies the boot volume source details for a new boot volume. The volume source is either another boot volume in the same availability domain or a boot volume backup. This is a mandatory field for a boot volume.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
synchronized
Specifies if Puppet waits for OCI actions to be ready before moving on to an other resource.
Back to overview of oci_core_boot_volume
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_boot_volume
tenant
The tenant for this resource.
Back to overview of oci_core_boot_volume
time_created
The date and time the boot volume was created. Format defined by RFC3339.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
volume_group
The Puppet name of the resource identified by volume_group_id
.
See the documentation of volume_group_id for all details.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
volume_group_id
The OCID of the source volume group. Rather use the property volume_group
instead of a direct OCID reference.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_boot_volume
vpus_per_gb
The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service’s elastic performance options. See Block Volume Elastic Performance for more information.
Allowed values:
-
10
: Represents Balanced option. -
20
: Represents Higher Performance option.
This documentation is generated from the Ruby OCI SDK.