Class BootVolume

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.

Inheritance

object

BootVolume

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CoreService.Models

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class BootVolume

Properties

AutoTunedVpusPerGB

Declaration

[JsonProperty(PropertyName = "autoTunedVpusPerGB")]
public long? AutoTunedVpusPerGB { get; set; }

Property Value

Type	Description
long?	The number of Volume Performance Units per GB that this boot volume is effectively tuned to.

AutotunePolicies

Declaration

[JsonProperty(PropertyName = "autotunePolicies")]
public List<AutotunePolicy> AutotunePolicies { get; set; }

Property Value

Type	Description
List<AutotunePolicy>	The list of autotune policies enabled for this volume.

AvailabilityDomain

Declaration

[Required(ErrorMessage = "AvailabilityDomain is required.")]
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }

Property Value

Type	Description
string	The availability domain of the boot volume. Example: Uocm:PHX-AD-1

Remarks

Required

BootVolumeReplicas

Declaration

[JsonProperty(PropertyName = "bootVolumeReplicas")]
public List<BootVolumeReplicaInfo> BootVolumeReplicas { get; set; }

Property Value

Type	Description
List<BootVolumeReplicaInfo>	The list of boot volume replicas of this boot volume

ClusterPlacementGroupId

Declaration

[JsonProperty(PropertyName = "clusterPlacementGroupId")]
public string ClusterPlacementGroupId { get; set; }

Property Value

Type	Description
string	The clusterPlacementGroup Id of the volume for volume placement.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment that contains the boot volume.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The boot volume's Oracle ID (OCID).

Remarks

Required

ImageId

Declaration

[JsonProperty(PropertyName = "imageId")]
public string ImageId { get; set; }

Property Value

Type	Description
string	The image OCID used to create the boot volume.

IsAutoTuneEnabled

Declaration

[JsonProperty(PropertyName = "isAutoTuneEnabled")]
public bool? IsAutoTuneEnabled { get; set; }

Property Value

Type	Description
bool?	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

Declaration

[JsonProperty(PropertyName = "isHydrated")]
public bool? IsHydrated { get; set; }

Property Value

Type	Description
bool?	Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.

KmsKeyId

Declaration

[JsonProperty(PropertyName = "kmsKeyId")]
public string KmsKeyId { get; set; }

Property Value

Type	Description
string	The OCID of the Vault service master encryption key assigned to the boot volume.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public BootVolume.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
BootVolume.LifecycleStateEnum?	The current state of a boot volume.

Remarks

Required

SizeInGBs

Declaration

[JsonProperty(PropertyName = "sizeInGBs")]
public long? SizeInGBs { get; set; }

Property Value

Type	Description
long?	The size of the boot volume in GBs.

SizeInMBs

Declaration

[Required(ErrorMessage = "SizeInMBs is required.")]
[JsonProperty(PropertyName = "sizeInMBs")]
public long? SizeInMBs { get; set; }

Property Value

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

Remarks

Required

SourceDetails

Declaration

[JsonProperty(PropertyName = "sourceDetails")]
public BootVolumeSourceDetails SourceDetails { get; set; }

Property Value

Type	Description
BootVolumeSourceDetails

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the boot volume was created. Format defined by RFC3339.

Remarks

Required

VolumeGroupId

Declaration

[JsonProperty(PropertyName = "volumeGroupId")]
public string VolumeGroupId { get; set; }

Property Value

Type	Description
string	The OCID of the source volume group.

VpusPerGB

Declaration

[JsonProperty(PropertyName = "vpusPerGB")]
public long? VpusPerGB { get; set; }

Property Value

Type Description

Type	Description
long?	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.

long?

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.