Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace IScsiVolumeAttachment

An ISCSI volume attachment.

Enumerations

Properties

Methods

Properties

Const attachmentType

attachmentType: string = "iscsi"

availabilityDomain

availabilityDomain: string

The availability domain of an instance.

Example: {@code Uocm:PHX-AD-1}

Optional chapSecret

chapSecret: undefined | string

The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)

Optional chapUsername

chapUsername: undefined | string

The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP.

Example: {@code ocid1.volume.oc1.phx.}

compartmentId

compartmentId: string

The OCID of the compartment.

Optional device

device: undefined | string

The device name.

Optional displayName

displayName: undefined | string

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

Optional encryptionInTransitType

encryptionInTransitType: model.EncryptionInTransitType

Refer the top-level definition of encryptionInTransitType. The default value is NONE.

id

id: string

The OCID of the volume attachment.

instanceId

instanceId: string

The OCID of the instance the volume is attached to.

ipv4

ipv4: string

The volume's iSCSI IP address.

Example: {@code 169.254.0.2}

iqn

iqn: string

The target volume's iSCSI Qualified Name in the format defined by RFC 3720.

Example: {@code iqn.2015-12.us.oracle.com:}

Optional isAgentAutoIscsiLoginEnabled

isAgentAutoIscsiLoginEnabled: undefined | false | true

Whether Oracle Cloud Agent is enabled perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.

Optional isMultipath

isMultipath: undefined | false | true

Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.

Optional isPvEncryptionInTransitEnabled

isPvEncryptionInTransitEnabled: undefined | false | true

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

Optional isReadOnly

isReadOnly: undefined | false | true

Whether the attachment was created in read-only mode.

Optional isShareable

isShareable: undefined | false | true

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.

Optional isVolumeCreatedDuringLaunch

isVolumeCreatedDuringLaunch: undefined | false | true

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.

Optional iscsiLoginState

iscsiLoginState: IscsiLoginState

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

lifecycleState: LifecycleState

The current state of the volume attachment.

Optional multipathDevices

multipathDevices: Array<MultipathDevice>

A list of secondary multipath devices

port

port: number

The volume's iSCSI port, usually port 860 or 3260.

Example: {@code 3260} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

timeCreated

timeCreated: Date

The date and time the volume was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

volumeId

volumeId: string

The OCID of the volume.

Methods

getDeserializedJsonObj

getJsonObj