BootVolume¶

class oci.core.models.BootVolume(**kwargs)¶

Bases: object

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.

Attributes

`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a BootVolume.
`LIFECYCLE_STATE_FAULTY`	A constant which can be used with the lifecycle_state property of a BootVolume.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a BootVolume.
`LIFECYCLE_STATE_RESTORING`	A constant which can be used with the lifecycle_state property of a BootVolume.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a BootVolume.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a BootVolume.
`auto_tuned_vpus_per_gb`	Gets the auto_tuned_vpus_per_gb of this BootVolume.
`autotune_policies`	Gets the autotune_policies of this BootVolume.
`availability_domain`	[Required] Gets the availability_domain of this BootVolume.
`boot_volume_replicas`	Gets the boot_volume_replicas of this BootVolume.
`compartment_id`	[Required] Gets the compartment_id of this BootVolume.
`defined_tags`	Gets the defined_tags of this BootVolume.
`display_name`	Gets the display_name of this BootVolume.
`freeform_tags`	Gets the freeform_tags of this BootVolume.
`id`	[Required] Gets the id of this BootVolume.
`image_id`	Gets the image_id of this BootVolume.
`is_auto_tune_enabled`	Gets the is_auto_tune_enabled of this BootVolume.
`is_hydrated`	Gets the is_hydrated of this BootVolume.
`kms_key_id`	Gets the kms_key_id of this BootVolume.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BootVolume.
`size_in_gbs`	Gets the size_in_gbs of this BootVolume.
`size_in_mbs`	[Required] Gets the size_in_mbs of this BootVolume.
`source_details`	Gets the source_details of this BootVolume.
`system_tags`	Gets the system_tags of this BootVolume.
`time_created`	[Required] Gets the time_created of this BootVolume.
`volume_group_id`	Gets the volume_group_id of this BootVolume.
`vpus_per_gb`	Gets the vpus_per_gb of this BootVolume.

Methods

__init__(**kwargs) Initializes a new BootVolume object with values from keyword arguments.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a BootVolume. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_FAULTY = 'FAULTY'¶: A constant which can be used with the lifecycle_state property of a BootVolume. This constant has a value of “FAULTY”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a BootVolume. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_RESTORING = 'RESTORING'¶: A constant which can be used with the lifecycle_state property of a BootVolume. This constant has a value of “RESTORING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a BootVolume. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a BootVolume. This constant has a value of “TERMINATING”

__init__(**kwargs)¶

Initializes a new BootVolume object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

availability_domain (str) – The value to assign to the availability_domain property of this BootVolume.
compartment_id (str) – The value to assign to the compartment_id property of this BootVolume.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BootVolume.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BootVolume.
display_name (str) – The value to assign to the display_name property of this BootVolume.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BootVolume.
id (str) – The value to assign to the id property of this BootVolume.
image_id (str) – The value to assign to the image_id property of this BootVolume.
is_hydrated (bool) – The value to assign to the is_hydrated property of this BootVolume.
vpus_per_gb (int) – The value to assign to the vpus_per_gb property of this BootVolume.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BootVolume. Allowed values for this property are: “PROVISIONING”, “RESTORING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “FAULTY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
size_in_gbs (int) – The value to assign to the size_in_gbs property of this BootVolume.
size_in_mbs (int) – The value to assign to the size_in_mbs property of this BootVolume.
source_details (oci.core.models.BootVolumeSourceDetails) – The value to assign to the source_details property of this BootVolume.
time_created (datetime) – The value to assign to the time_created property of this BootVolume.
volume_group_id (str) – The value to assign to the volume_group_id property of this BootVolume.
kms_key_id (str) – The value to assign to the kms_key_id property of this BootVolume.
is_auto_tune_enabled (bool) – The value to assign to the is_auto_tune_enabled property of this BootVolume.
auto_tuned_vpus_per_gb (int) – The value to assign to the auto_tuned_vpus_per_gb property of this BootVolume.
boot_volume_replicas (list[oci.core.models.BootVolumeReplicaInfo]) – The value to assign to the boot_volume_replicas property of this BootVolume.
autotune_policies (list[oci.core.models.AutotunePolicy]) – The value to assign to the autotune_policies property of this BootVolume.

auto_tuned_vpus_per_gb¶

Gets the auto_tuned_vpus_per_gb of this BootVolume. The number of Volume Performance Units per GB that this boot volume is effectively tuned to.

Returns:	The auto_tuned_vpus_per_gb of this BootVolume.
Return type:	int

autotune_policies¶

Gets the autotune_policies of this BootVolume. The list of autotune policies enabled for this volume.

Returns:	The autotune_policies of this BootVolume.
Return type:	list[oci.core.models.AutotunePolicy]

availability_domain¶

[Required] Gets the availability_domain of this BootVolume. The availability domain of the boot volume.

Example: Uocm:PHX-AD-1

Returns:	The availability_domain of this BootVolume.
Return type:	str

boot_volume_replicas¶

Gets the boot_volume_replicas of this BootVolume. The list of boot volume replicas of this boot volume

Returns:	The boot_volume_replicas of this BootVolume.
Return type:	list[oci.core.models.BootVolumeReplicaInfo]

compartment_id¶

[Required] Gets the compartment_id of this BootVolume. The OCID of the compartment that contains the boot volume.

Returns:	The compartment_id of this BootVolume.
Return type:	str

defined_tags¶

Gets the defined_tags of this BootVolume. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this BootVolume.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this BootVolume. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this BootVolume.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this BootVolume. 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”}

Returns:	The freeform_tags of this BootVolume.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this BootVolume. The boot volume’s Oracle ID (OCID).

Returns:	The id of this BootVolume.
Return type:	str

image_id¶

Gets the image_id of this BootVolume. The image OCID used to create the boot volume.

Returns:	The image_id of this BootVolume.
Return type:	str

is_auto_tune_enabled¶

Gets the is_auto_tune_enabled of this BootVolume. 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.

Returns:	The is_auto_tune_enabled of this BootVolume.
Return type:	bool

is_hydrated¶

Gets the is_hydrated of this BootVolume. Specifies whether the boot volume’s data has finished copying from the source boot volume or boot volume backup.

Returns:	The is_hydrated of this BootVolume.
Return type:	bool

kms_key_id¶

Gets the kms_key_id of this BootVolume. The OCID of the Vault service master encryption key assigned to the boot volume.

Returns:	The kms_key_id of this BootVolume.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this BootVolume. The current state of a boot volume.

Allowed values for this property are: “PROVISIONING”, “RESTORING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “FAULTY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this BootVolume.
Return type:	str

size_in_gbs¶

Gets the size_in_gbs of this BootVolume. The size of the boot volume in GBs.

Returns:	The size_in_gbs of this BootVolume.
Return type:	int

size_in_mbs¶

[Required] Gets the size_in_mbs of this BootVolume. The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.

Returns:	The size_in_mbs of this BootVolume.
Return type:	int

source_details¶

Gets the source_details of this BootVolume.

Returns:	The source_details of this BootVolume.
Return type:	oci.core.models.BootVolumeSourceDetails

system_tags¶

Gets the system_tags of this BootVolume. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The system_tags of this BootVolume.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this BootVolume. The date and time the boot volume was created. Format defined by RFC3339.

Returns:	The time_created of this BootVolume.
Return type:	datetime

volume_group_id¶

Gets the volume_group_id of this BootVolume. The OCID of the source volume group.

Returns:	The volume_group_id of this BootVolume.
Return type:	str

vpus_per_gb¶

Gets the vpus_per_gb of this BootVolume. 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 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.

Returns:	The vpus_per_gb of this BootVolume.
Return type:	int