Class VolumeAttachment

A base object for all types of attachments between a storage volume and an instance. For specific details about iSCSI attachments, see {@link IScsiVolumeAttachment}.
For general information about volume attachments, see Overview of Block Volume Storage.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Inheritance

object

VolumeAttachment

EmulatedVolumeAttachment

IScsiVolumeAttachment

ParavirtualizedVolumeAttachment

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

[JsonConverter(typeof(VolumeAttachmentModelConverter))]
public class VolumeAttachment

Properties

AvailabilityDomain

Declaration

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

Property Value

Type	Description
string	The availability domain of an instance. Example: Uocm:PHX-AD-1

Remarks

Required

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.

Remarks

Required

Device

Declaration

[JsonProperty(PropertyName = "device")]
public string Device { get; set; }

Property Value

Type	Description
string	The device name.

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.

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the volume attachment.

Remarks

Required

InstanceId

Declaration

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

Property Value

Type	Description
string	The OCID of the instance the volume is attached to.

Remarks

Required

IsMultipath

Declaration

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

Property Value

Type	Description
bool?	Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.

IsPvEncryptionInTransitEnabled

Declaration

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

Property Value

Type	Description
bool?	Whether in-transit encryption for the data volume's paravirtualized attachment is enabled or not.

IsReadOnly

Declaration

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

Property Value

Type	Description
bool?	Whether the attachment was created in read-only mode.

IsShareable

Declaration

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

Property Value

Type	Description
bool?	Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.

IsVolumeCreatedDuringLaunch

Declaration

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

Property Value

Type	Description
bool?	Flag indicating if this volume was created for the customer as part of a simplified launch. Used to determine whether the volume requires deletion on instance termination.

IscsiLoginState

Declaration

[JsonProperty(PropertyName = "iscsiLoginState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VolumeAttachment.IscsiLoginStateEnum? IscsiLoginState { get; set; }

Property Value

Type	Description
VolumeAttachment.IscsiLoginStateEnum?	The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.

LifecycleState

Declaration

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

Property Value

Type	Description
VolumeAttachment.LifecycleStateEnum?	The current state of the volume attachment.

Remarks

Required

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 volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

VolumeId

Declaration

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

Property Value

Type	Description
string	The OCID of the volume.

Remarks

Required