IScsiVolumeAttachment¶

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

Bases: oci.core.models.volume_attachment.VolumeAttachment

An ISCSI volume attachment.

LIFECYCLE_STATE_ATTACHED = 'ATTACHED'¶

LIFECYCLE_STATE_ATTACHING = 'ATTACHING'¶

LIFECYCLE_STATE_DETACHED = 'DETACHED'¶

LIFECYCLE_STATE_DETACHING = '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.
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"
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.
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.
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.

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

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

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".)

Example: d6866c0d-298b-48ba-95af-309b4faux45e

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

chap_username¶

Gets the chap_username of this IScsiVolumeAttachment. The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name.

Example: ocid1.volume.oc1.phx.abyhqljrgvttnlx73nmrwfaux7kcvzfs3s66izvxf2h4lgvyndsdsnoiwr5q

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

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

device¶

Gets the device of this VolumeAttachment. The device name.

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

display_name¶

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

Example: My volume attachment

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

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.

id¶

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

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

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

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

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:456b0391-17b8-4122-bbf1-f85fc0bb97d9

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

is_pv_encryption_in_transit_enabled¶

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

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

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

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

port¶

[Required] Gets the port of this IScsiVolumeAttachment. The volume's iSCSI port.

Example: 3260

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

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

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