boot_volumes

Creates, updates, deletes, gets or lists a boot_volumes resource.

Overview

Name	`boot_volumes`
Type	Resource
Id	`oci.block_storage.boot_volumes`

Fields

The following fields are returned by SELECT queries:

get
list

The boot volume's information has been retrieved.

Name	Datatype	Description
`id`	`string`	The boot volume's Oracle ID (OCID).
`autoTunedVpusPerGB`	`integer (int64)`	The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
`autotunePolicies`	`array`	The list of autotune policies enabled for this volume.
`availabilityDomain`	`string`	The availability domain of the boot volume. Example: `Uocm:PHX-AD-1`
`bootVolumeReplicas`	`array`	The list of boot volume replicas of this boot volume
`clusterPlacementGroupId`	`string`	The clusterPlacementGroup Id of the volume for volume placement.
`compartmentId`	`string`	The OCID of the compartment that contains the boot volume.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`displayName`	`string`	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
`freeformTags`	`object`	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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`imageId`	`string`	The image OCID used to create the boot volume.
`isAutoTuneEnabled`	`boolean`	Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.
`isHydrated`	`boolean`	Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
`kmsKeyId`	`string`	The OCID of the Vault service master encryption key assigned to the boot volume.
`lifecycleState`	`string`	The current state of a boot volume. (PROVISIONING, RESTORING, AVAILABLE, TERMINATING, TERMINATED, FAULTY)
`sizeInGBs`	`integer (int64)`	The size of the boot volume in GBs.
`sizeInMBs`	`integer (int64)`	The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.
`sourceDetails`	`object`
`timeCreated`	`string (date-time)`	The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
`volumeGroupId`	`string`	The OCID of the source volume group.
`vpusPerGB`	`integer (int64)`	The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information. Allowed values: * `10`: Represents Balanced option. * `20`: Represents Higher Performance option. * `30`-`120`: Represents the Ultra High Performance option. For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.

A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see [Overview of Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm). 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](/iaas/Content/Identity/Concepts/policygetstarted.htm). Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Name	Datatype	Description
`id`	`string`	The boot volume's Oracle ID (OCID).
`autoTunedVpusPerGB`	`integer (int64)`	The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
`autotunePolicies`	`array`	The list of autotune policies enabled for this volume.
`availabilityDomain`	`string`	The availability domain of the boot volume. Example: `Uocm:PHX-AD-1`
`bootVolumeReplicas`	`array`	The list of boot volume replicas of this boot volume
`clusterPlacementGroupId`	`string`	The clusterPlacementGroup Id of the volume for volume placement.
`compartmentId`	`string`	The OCID of the compartment that contains the boot volume.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`displayName`	`string`	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
`freeformTags`	`object`	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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`imageId`	`string`	The image OCID used to create the boot volume.
`isAutoTuneEnabled`	`boolean`	Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.
`isHydrated`	`boolean`	Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
`kmsKeyId`	`string`	The OCID of the Vault service master encryption key assigned to the boot volume.
`lifecycleState`	`string`	The current state of a boot volume. (PROVISIONING, RESTORING, AVAILABLE, TERMINATING, TERMINATED, FAULTY)
`sizeInGBs`	`integer (int64)`	The size of the boot volume in GBs.
`sizeInMBs`	`integer (int64)`	The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.
`sourceDetails`	`object`
`timeCreated`	`string (date-time)`	The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
`volumeGroupId`	`string`	The OCID of the source volume group.
`vpusPerGB`	`integer (int64)`	The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information. Allowed values: * `10`: Represents Balanced option. * `20`: Represents Higher Performance option. * `30`-`120`: Represents the Ultra High Performance option. For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`bootVolumeId`, `region`		Gets information for the specified boot volume.
`list`	`select`	`availabilityDomain`, `compartmentId`, `region`	`limit`, `page`, `volumeGroupId`	Lists the boot volumes in the specified compartment and availability domain.<br />
`create`	`insert`	`region`, `compartmentId`, `sourceDetails`	`opc-retry-token`	Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup.<br />For general information about boot volumes, see [Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm).<br />You may optionally specify a display name for the volume, which is simply a friendly name or<br />description. It does not have to be unique, and you can change it. Avoid entering confidential information.<br />
`update`	`update`	`bootVolumeId`, `region`	`if-match`	Updates the specified boot volume's display name, defined tags, and free-form tags.
`delete`	`delete`	`bootVolumeId`, `region`	`if-match`	Deletes the specified boot volume. The volume cannot have an active connection to an instance.<br />To disconnect the boot volume from a connected instance, see<br />[Disconnecting From a Boot Volume](/iaas/Content/Block/Tasks/deletingbootvolume.htm).<br />Warning: All data on the boot volume will be permanently lost when the boot volume is deleted.<br />
`change_compartment`	`exec`	`bootVolumeId`, `region`, `compartmentId`	`opc-request-id`	Moves a boot volume into a different compartment within the same tenancy.<br />For information about moving resources between compartments,<br />see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`availabilityDomain`	`string`	The name of the availability domain. Example: `Uocm:PHX-AD-1`
`bootVolumeId`	`string`	The OCID of the boot volume.
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`limit`	`integer`	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50`
`opc-request-id`	`string`	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`page`	`string`	For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
`volumeGroupId`	`string`	The OCID of the volume group.

`SELECT` examples

get
list

Gets information for the specified boot volume.

SELECT
id,
autoTunedVpusPerGB,
autotunePolicies,
availabilityDomain,
bootVolumeReplicas,
clusterPlacementGroupId,
compartmentId,
definedTags,
displayName,
freeformTags,
imageId,
isAutoTuneEnabled,
isHydrated,
kmsKeyId,
lifecycleState,
sizeInGBs,
sizeInMBs,
sourceDetails,
timeCreated,
volumeGroupId,
vpusPerGB
FROM oci.block_storage.boot_volumes
WHERE bootVolumeId = '{{ bootVolumeId }}' -- required
AND region = '{{ region }}' -- required
;

Lists the boot volumes in the specified compartment and availability domain.

SELECT
id,
autoTunedVpusPerGB,
autotunePolicies,
availabilityDomain,
bootVolumeReplicas,
clusterPlacementGroupId,
compartmentId,
definedTags,
displayName,
freeformTags,
imageId,
isAutoTuneEnabled,
isHydrated,
kmsKeyId,
lifecycleState,
sizeInGBs,
sizeInMBs,
sourceDetails,
timeCreated,
volumeGroupId,
vpusPerGB
FROM oci.block_storage.boot_volumes
WHERE availabilityDomain = '{{ availabilityDomain }}' -- required
AND compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND volumeGroupId = '{{ volumeGroupId }}'
;

`INSERT` examples

create
Manifest

Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. For general information about boot volumes, see [Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm). You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

INSERT INTO oci.block_storage.boot_volumes (
autotunePolicies,
availabilityDomain,
bootVolumeReplicas,
clusterPlacementGroupId,
compartmentId,
definedTags,
displayName,
freeformTags,
isAutoTuneEnabled,
kmsKeyId,
sizeInGBs,
sourceDetails,
vpusPerGB,
region,
opc-retry-token
)
SELECT 
'{{ autotunePolicies }}',
'{{ availabilityDomain }}',
'{{ bootVolumeReplicas }}',
'{{ clusterPlacementGroupId }}',
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
{{ isAutoTuneEnabled }},
'{{ kmsKeyId }}',
{{ sizeInGBs }},
'{{ sourceDetails }}' /* required */,
{{ vpusPerGB }},
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
autoTunedVpusPerGB,
autotunePolicies,
availabilityDomain,
bootVolumeReplicas,
clusterPlacementGroupId,
compartmentId,
definedTags,
displayName,
freeformTags,
imageId,
isAutoTuneEnabled,
isHydrated,
kmsKeyId,
lifecycleState,
sizeInGBs,
sizeInMBs,
sourceDetails,
timeCreated,
volumeGroupId,
vpusPerGB
;

# Description fields are for documentation purposes
- name: boot_volumes
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the boot_volumes resource.
  - name: autotunePolicies
    description: |
      The list of autotune policies to be enabled for this volume.
    value:
      - autotuneType: "{{ autotuneType }}"
  - name: availabilityDomain
    value: "{{ availabilityDomain }}"
    description: |
      The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume.
      Example: `Uocm:PHX-AD-1`
  - name: bootVolumeReplicas
    description: |
      The list of boot volume replicas to be enabled for this boot volume
      in the specified destination availability domains.
    value:
      - availabilityDomain: "{{ availabilityDomain }}"
        displayName: "{{ displayName }}"
  - name: clusterPlacementGroupId
    value: "{{ clusterPlacementGroupId }}"
    description: |
      The clusterPlacementGroup Id of the volume for volume placement.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The OCID of the compartment that contains the boot volume.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a
      namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly name. Does not have to be unique, and it's changeable.
      Avoid entering confidential information.
  - name: freeformTags
    value: "{{ freeformTags }}"
    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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: isAutoTuneEnabled
    value: {{ isAutoTuneEnabled }}
    description: |
      Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated.
      Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.
  - name: kmsKeyId
    value: "{{ kmsKeyId }}"
    description: |
      The OCID of the Vault service key to assign as the master encryption key
      for the boot volume.
  - name: sizeInGBs
    value: {{ sizeInGBs }}
    description: |
      The size of the volume in GBs.
  - name: sourceDetails
    value:
      type: "{{ type }}"
  - name: vpusPerGB
    value: {{ vpusPerGB }}
    description: |
      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 Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.
      Allowed values:
      * `10`: Represents the Balanced option.
      * `20`: Represents the Higher Performance option.
      * `30`-`120`: Represents the Ultra High Performance option.
      For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

`UPDATE` examples

update

Updates the specified boot volume's display name, defined tags, and free-form tags.

UPDATE oci.block_storage.boot_volumes
SET 
autotunePolicies = '{{ autotunePolicies }}',
bootVolumeReplicas = '{{ bootVolumeReplicas }}',
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
isAutoTuneEnabled = {{ isAutoTuneEnabled }},
sizeInGBs = {{ sizeInGBs }},
vpusPerGB = {{ vpusPerGB }}
WHERE 
bootVolumeId = '{{ bootVolumeId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
autoTunedVpusPerGB,
autotunePolicies,
availabilityDomain,
bootVolumeReplicas,
clusterPlacementGroupId,
compartmentId,
definedTags,
displayName,
freeformTags,
imageId,
isAutoTuneEnabled,
isHydrated,
kmsKeyId,
lifecycleState,
sizeInGBs,
sizeInMBs,
sourceDetails,
timeCreated,
volumeGroupId,
vpusPerGB;

`DELETE` examples

delete

Deletes the specified boot volume. The volume cannot have an active connection to an instance. To disconnect the boot volume from a connected instance, see [Disconnecting From a Boot Volume](/iaas/Content/Block/Tasks/deletingbootvolume.htm). Warning: All data on the boot volume will be permanently lost when the boot volume is deleted.

DELETE FROM oci.block_storage.boot_volumes
WHERE bootVolumeId = '{{ bootVolumeId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

change_compartment

Moves a boot volume into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

EXEC oci.block_storage.boot_volumes.change_compartment 
@bootVolumeId='{{ bootVolumeId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​