IScsiVolumeAttachment¶

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

Bases: VolumeAttachment

An ISCSI volume attachment.

Attributes:

`ENCRYPTION_IN_TRANSIT_TYPE_BM_ENCRYPTION_IN_TRANSIT`	A constant which can be used with the encryption_in_transit_type property of a IScsiVolumeAttachment.
`ENCRYPTION_IN_TRANSIT_TYPE_NONE`	A constant which can be used with the encryption_in_transit_type property of a IScsiVolumeAttachment.
`ISCSI_LOGIN_STATE_LOGGING_IN`	A constant which can be used with the iscsi_login_state property of a VolumeAttachment.
`ISCSI_LOGIN_STATE_LOGGING_OUT`	A constant which can be used with the iscsi_login_state property of a VolumeAttachment.
`ISCSI_LOGIN_STATE_LOGIN_FAILED`	A constant which can be used with the iscsi_login_state property of a VolumeAttachment.
`ISCSI_LOGIN_STATE_LOGIN_SUCCEEDED`	A constant which can be used with the iscsi_login_state property of a VolumeAttachment.
`ISCSI_LOGIN_STATE_LOGOUT_FAILED`	A constant which can be used with the iscsi_login_state property of a VolumeAttachment.
`ISCSI_LOGIN_STATE_LOGOUT_SUCCEEDED`	A constant which can be used with the iscsi_login_state property of a VolumeAttachment.
`ISCSI_LOGIN_STATE_UNKNOWN`	A constant which can be used with the iscsi_login_state property of a VolumeAttachment.
`LIFECYCLE_STATE_ATTACHED`	A constant which can be used with the lifecycle_state property of a VolumeAttachment.
`LIFECYCLE_STATE_ATTACHING`	A constant which can be used with the lifecycle_state property of a VolumeAttachment.
`LIFECYCLE_STATE_DETACHED`	A constant which can be used with the lifecycle_state property of a VolumeAttachment.
`LIFECYCLE_STATE_DETACHING`	A constant which can be used with the lifecycle_state property of a VolumeAttachment.
`attachment_type`	[Required] Gets the attachment_type of this VolumeAttachment.
`availability_domain`	[Required] Gets the availability_domain of this VolumeAttachment.
`chap_secret`	Gets the chap_secret of this IScsiVolumeAttachment.
`chap_username`	Gets the chap_username of this IScsiVolumeAttachment.
`compartment_id`	[Required] Gets the compartment_id of this VolumeAttachment.
`device`	Gets the device of this VolumeAttachment.
`display_name`	Gets the display_name of this VolumeAttachment.
`encryption_in_transit_type`	Gets the encryption_in_transit_type of this IScsiVolumeAttachment.
`id`	[Required] Gets the id of this VolumeAttachment.
`instance_id`	[Required] Gets the instance_id of this VolumeAttachment.
`ipv4`	[Required] Gets the ipv4 of this IScsiVolumeAttachment.
`ipv6`	Gets the ipv6 of this IScsiVolumeAttachment.
`iqn`	[Required] Gets the iqn of this IScsiVolumeAttachment.
`is_agent_auto_iscsi_login_enabled`	Gets the is_agent_auto_iscsi_login_enabled of this IScsiVolumeAttachment.
`is_encryption_in_transit_enabled`	Gets the is_encryption_in_transit_enabled of this VolumeAttachment.
`is_multipath`	Gets the is_multipath of this VolumeAttachment.
`is_pv_encryption_in_transit_enabled`	Gets the is_pv_encryption_in_transit_enabled of this VolumeAttachment.
`is_read_only`	Gets the is_read_only of this VolumeAttachment.
`is_shareable`	Gets the is_shareable of this VolumeAttachment.
`is_volume_created_during_launch`	Gets the is_volume_created_during_launch of this VolumeAttachment.
`iscsi_login_state`	Gets the iscsi_login_state of this VolumeAttachment.
`lifecycle_state`	[Required] Gets the lifecycle_state of this VolumeAttachment.
`multipath_devices`	Gets the multipath_devices of this IScsiVolumeAttachment.
`port`	[Required] Gets the port of this IScsiVolumeAttachment.
`time_created`	[Required] Gets the time_created of this VolumeAttachment.
`volume_id`	[Required] Gets the volume_id of this VolumeAttachment.

Methods:

`__init__`(**kwargs)	Initializes a new IScsiVolumeAttachment object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ENCRYPTION_IN_TRANSIT_TYPE_BM_ENCRYPTION_IN_TRANSIT = 'BM_ENCRYPTION_IN_TRANSIT'¶: A constant which can be used with the encryption_in_transit_type property of a IScsiVolumeAttachment. This constant has a value of “BM_ENCRYPTION_IN_TRANSIT”

ENCRYPTION_IN_TRANSIT_TYPE_NONE = 'NONE'¶: A constant which can be used with the encryption_in_transit_type property of a IScsiVolumeAttachment. This constant has a value of “NONE”

ISCSI_LOGIN_STATE_LOGGING_IN = 'LOGGING_IN'¶: A constant which can be used with the iscsi_login_state property of a VolumeAttachment. This constant has a value of “LOGGING_IN”

ISCSI_LOGIN_STATE_LOGGING_OUT = 'LOGGING_OUT'¶: A constant which can be used with the iscsi_login_state property of a VolumeAttachment. This constant has a value of “LOGGING_OUT”

ISCSI_LOGIN_STATE_LOGIN_FAILED = 'LOGIN_FAILED'¶: A constant which can be used with the iscsi_login_state property of a VolumeAttachment. This constant has a value of “LOGIN_FAILED”

ISCSI_LOGIN_STATE_LOGIN_SUCCEEDED = 'LOGIN_SUCCEEDED'¶: A constant which can be used with the iscsi_login_state property of a VolumeAttachment. This constant has a value of “LOGIN_SUCCEEDED”

ISCSI_LOGIN_STATE_LOGOUT_FAILED = 'LOGOUT_FAILED'¶: A constant which can be used with the iscsi_login_state property of a VolumeAttachment. This constant has a value of “LOGOUT_FAILED”

ISCSI_LOGIN_STATE_LOGOUT_SUCCEEDED = 'LOGOUT_SUCCEEDED'¶: A constant which can be used with the iscsi_login_state property of a VolumeAttachment. This constant has a value of “LOGOUT_SUCCEEDED”

ISCSI_LOGIN_STATE_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the iscsi_login_state property of a VolumeAttachment. This constant has a value of “UNKNOWN”

LIFECYCLE_STATE_ATTACHED = 'ATTACHED'¶: A constant which can be used with the lifecycle_state property of a VolumeAttachment. This constant has a value of “ATTACHED”

LIFECYCLE_STATE_ATTACHING = 'ATTACHING'¶: A constant which can be used with the lifecycle_state property of a VolumeAttachment. This constant has a value of “ATTACHING”

LIFECYCLE_STATE_DETACHED = 'DETACHED'¶: A constant which can be used with the lifecycle_state property of a VolumeAttachment. This constant has a value of “DETACHED”

LIFECYCLE_STATE_DETACHING = 'DETACHING'¶: A constant which can be used with the lifecycle_state property of a VolumeAttachment. This constant has a value of “DETACHING”

__init__(**kwargs)¶

Initializes a new IScsiVolumeAttachment object with values from keyword arguments. The default value of the attachment_type attribute of this class is iscsi and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

attachment_type (str) – The value to assign to the attachment_type property of this IScsiVolumeAttachment.
availability_domain (str) – The value to assign to the availability_domain property of this IScsiVolumeAttachment.
compartment_id (str) – The value to assign to the compartment_id property of this IScsiVolumeAttachment.
device (str) – The value to assign to the device property of this IScsiVolumeAttachment.
display_name (str) – The value to assign to the display_name property of this IScsiVolumeAttachment.
id (str) – The value to assign to the id property of this IScsiVolumeAttachment.
instance_id (str) – The value to assign to the instance_id property of this IScsiVolumeAttachment.
is_read_only (bool) – The value to assign to the is_read_only property of this IScsiVolumeAttachment.
is_shareable (bool) – The value to assign to the is_shareable property of this IScsiVolumeAttachment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this IScsiVolumeAttachment. Allowed values for this property are: “ATTACHING”, “ATTACHED”, “DETACHING”, “DETACHED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this IScsiVolumeAttachment.
volume_id (str) – The value to assign to the volume_id property of this IScsiVolumeAttachment.
is_pv_encryption_in_transit_enabled (bool) – The value to assign to the is_pv_encryption_in_transit_enabled property of this IScsiVolumeAttachment.
is_encryption_in_transit_enabled (bool) – The value to assign to the is_encryption_in_transit_enabled property of this IScsiVolumeAttachment.
is_multipath (bool) – The value to assign to the is_multipath property of this IScsiVolumeAttachment.
iscsi_login_state (str) – The value to assign to the iscsi_login_state property of this IScsiVolumeAttachment. Allowed values for this property are: “UNKNOWN”, “LOGGING_IN”, “LOGIN_SUCCEEDED”, “LOGIN_FAILED”, “LOGGING_OUT”, “LOGOUT_SUCCEEDED”, “LOGOUT_FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_volume_created_during_launch (bool) – The value to assign to the is_volume_created_during_launch property of this IScsiVolumeAttachment.
chap_secret (str) – The value to assign to the chap_secret property of this IScsiVolumeAttachment.
chap_username (str) – The value to assign to the chap_username property of this IScsiVolumeAttachment.
ipv4 (str) – The value to assign to the ipv4 property of this IScsiVolumeAttachment.
ipv6 (str) – The value to assign to the ipv6 property of this IScsiVolumeAttachment.
iqn (str) – The value to assign to the iqn property of this IScsiVolumeAttachment.
port (int) – The value to assign to the port property of this IScsiVolumeAttachment.
multipath_devices (list[oci.core.models.MultipathDevice]) – The value to assign to the multipath_devices property of this IScsiVolumeAttachment.
encryption_in_transit_type (str) – The value to assign to the encryption_in_transit_type property of this IScsiVolumeAttachment. Allowed values for this property are: “NONE”, “BM_ENCRYPTION_IN_TRANSIT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_agent_auto_iscsi_login_enabled (bool) – The value to assign to the is_agent_auto_iscsi_login_enabled property of this IScsiVolumeAttachment.

property attachment_type¶

[Required] Gets the attachment_type of this VolumeAttachment. The type of volume attachment.

Returns: The attachment_type of this VolumeAttachment.
Return type: str

property availability_domain¶

[Required] Gets the availability_domain of this VolumeAttachment. The availability domain of an instance.

Example: Uocm:PHX-AD-1

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

property chap_secret¶

Gets the chap_secret of this IScsiVolumeAttachment. The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the “CHAP password”.)

Returns: The chap_secret of this IScsiVolumeAttachment.
Return type: str

property chap_username¶

Gets the chap_username of this IScsiVolumeAttachment. The volume’s system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP.

Example: ocid1.volume.oc1.phx.<unique_ID>

Returns: The chap_username of this IScsiVolumeAttachment.
Return type: str

property compartment_id¶

[Required] Gets the compartment_id of this VolumeAttachment. The OCID of the compartment.

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

property device¶

Gets the device of this VolumeAttachment. The device name.

Returns: The device of this VolumeAttachment.
Return type: str

property display_name¶

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

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

property encryption_in_transit_type¶

Gets the encryption_in_transit_type of this IScsiVolumeAttachment. Deprecated. Use isEncryptionInTransitEnabled instead.

Allowed values for this property are: “NONE”, “BM_ENCRYPTION_IN_TRANSIT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The encryption_in_transit_type of this IScsiVolumeAttachment.
Return type: str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property id¶

[Required] Gets the id of this VolumeAttachment. The OCID of the volume attachment.

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

property instance_id¶

[Required] Gets the instance_id of this VolumeAttachment. The OCID of the instance the volume is attached to.

Returns: The instance_id of this VolumeAttachment.
Return type: str

property ipv4¶

[Required] Gets the ipv4 of this IScsiVolumeAttachment. The volume’s iSCSI IP address.

Example: 169.254.0.2

Returns: The ipv4 of this IScsiVolumeAttachment.
Return type: str

property ipv6¶

Gets the ipv6 of this IScsiVolumeAttachment. The volume’s iSCSI IPv6 address.

Example: 2001:db8::1/64

Returns: The ipv6 of this IScsiVolumeAttachment.
Return type: str

property iqn¶

[Required] Gets the iqn of this IScsiVolumeAttachment. The target volume’s iSCSI Qualified Name in the format defined by RFC 3720.

Example: iqn.2015-12.us.oracle.com:<CHAP_username>

Returns: The iqn of this IScsiVolumeAttachment.
Return type: str

property is_agent_auto_iscsi_login_enabled¶

Gets the is_agent_auto_iscsi_login_enabled of this IScsiVolumeAttachment. 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.

Returns: The is_agent_auto_iscsi_login_enabled of this IScsiVolumeAttachment.
Return type: bool

property is_encryption_in_transit_enabled¶

Gets the is_encryption_in_transit_enabled of this VolumeAttachment. Whether in-transit encryption for the data volume’s attachment is enabled or not.

Returns: The is_encryption_in_transit_enabled of this VolumeAttachment.
Return type: bool

property is_multipath¶

Gets the is_multipath of this VolumeAttachment. Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.

Returns: The is_multipath of this VolumeAttachment.
Return type: bool

property is_pv_encryption_in_transit_enabled¶

Gets the is_pv_encryption_in_transit_enabled of this VolumeAttachment. Deprecated. Use isEncryptionInTransitEnabled instead.

Returns: The is_pv_encryption_in_transit_enabled of this VolumeAttachment.
Return type: bool

property is_read_only¶

Gets the is_read_only of this VolumeAttachment. Whether the attachment was created in read-only mode.

Returns: The is_read_only of this VolumeAttachment.
Return type: bool

property is_shareable¶

Gets the is_shareable of this VolumeAttachment. 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.

Returns: The is_shareable of this VolumeAttachment.
Return type: bool

property is_volume_created_during_launch¶

Gets the is_volume_created_during_launch of this VolumeAttachment. 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.

Returns: The is_volume_created_during_launch of this VolumeAttachment.
Return type: bool

property iscsi_login_state¶

Gets the iscsi_login_state of this VolumeAttachment. 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.

Allowed values for this property are: “UNKNOWN”, “LOGGING_IN”, “LOGIN_SUCCEEDED”, “LOGIN_FAILED”, “LOGGING_OUT”, “LOGOUT_SUCCEEDED”, “LOGOUT_FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The iscsi_login_state of this VolumeAttachment.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this VolumeAttachment. The current state of the volume attachment.

Allowed values for this property are: “ATTACHING”, “ATTACHED”, “DETACHING”, “DETACHED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

property multipath_devices¶

Gets the multipath_devices of this IScsiVolumeAttachment. A list of secondary multipath devices

Returns: The multipath_devices of this IScsiVolumeAttachment.
Return type: list[oci.core.models.MultipathDevice]

property port¶

[Required] Gets the port of this IScsiVolumeAttachment. The volume’s iSCSI port, usually port 860 or 3260.

Example: 3260

Returns: The port of this IScsiVolumeAttachment.
Return type: int

property time_created¶

[Required] Gets the time_created of this VolumeAttachment. The date and time the volume was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

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

property volume_id¶

[Required] Gets the volume_id of this VolumeAttachment. The OCID of the volume.

Returns: The volume_id of this VolumeAttachment.
Return type: str