AttachIScsiVolumeDetails¶

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

Bases: oci.core.models.attach_volume_details.AttachVolumeDetails

AttachIScsiVolumeDetails model.

Attributes

`ENCRYPTION_IN_TRANSIT_TYPE_BM_ENCRYPTION_IN_TRANSIT`	A constant which can be used with the encryption_in_transit_type property of a AttachIScsiVolumeDetails.
`ENCRYPTION_IN_TRANSIT_TYPE_NONE`	A constant which can be used with the encryption_in_transit_type property of a AttachIScsiVolumeDetails.
`device`	Gets the device of this AttachVolumeDetails.
`display_name`	Gets the display_name of this AttachVolumeDetails.
`encryption_in_transit_type`	Gets the encryption_in_transit_type of this AttachIScsiVolumeDetails.
`instance_id`	[Required] Gets the instance_id of this AttachVolumeDetails.
`is_agent_auto_iscsi_login_enabled`	Gets the is_agent_auto_iscsi_login_enabled of this AttachIScsiVolumeDetails.
`is_read_only`	Gets the is_read_only of this AttachVolumeDetails.
`is_shareable`	Gets the is_shareable of this AttachVolumeDetails.
`type`	[Required] Gets the type of this AttachVolumeDetails.
`use_chap`	Gets the use_chap of this AttachIScsiVolumeDetails.
`volume_id`	[Required] Gets the volume_id of this AttachVolumeDetails.

Methods

`__init__`(**kwargs)	Initializes a new AttachIScsiVolumeDetails 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 AttachIScsiVolumeDetails. 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 AttachIScsiVolumeDetails. This constant has a value of “NONE”

__init__(**kwargs)¶

Initializes a new AttachIScsiVolumeDetails object with values from keyword arguments. The default value of the 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:

device (str) – The value to assign to the device property of this AttachIScsiVolumeDetails.
display_name (str) – The value to assign to the display_name property of this AttachIScsiVolumeDetails.
instance_id (str) – The value to assign to the instance_id property of this AttachIScsiVolumeDetails.
is_read_only (bool) – The value to assign to the is_read_only property of this AttachIScsiVolumeDetails.
is_shareable (bool) – The value to assign to the is_shareable property of this AttachIScsiVolumeDetails.
type (str) – The value to assign to the type property of this AttachIScsiVolumeDetails.
volume_id (str) – The value to assign to the volume_id property of this AttachIScsiVolumeDetails.
use_chap (bool) – The value to assign to the use_chap property of this AttachIScsiVolumeDetails.
encryption_in_transit_type (str) – The value to assign to the encryption_in_transit_type property of this AttachIScsiVolumeDetails. Allowed values for this property are: “NONE”, “BM_ENCRYPTION_IN_TRANSIT”
is_agent_auto_iscsi_login_enabled (bool) – The value to assign to the is_agent_auto_iscsi_login_enabled property of this AttachIScsiVolumeDetails.

device¶

Gets the device of this AttachVolumeDetails. The device name. To retrieve a list of devices for a given instance, see list_instance_devices().

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

display_name¶

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

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

encryption_in_transit_type¶

Gets the encryption_in_transit_type of this AttachIScsiVolumeDetails. Refer the top-level definition of encryptionInTransitType. The default value is NONE.

Allowed values for this property are: “NONE”, “BM_ENCRYPTION_IN_TRANSIT”

Returns:	The encryption_in_transit_type of this AttachIScsiVolumeDetails.
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.

instance_id¶

[Required] Gets the instance_id of this AttachVolumeDetails. The OCID of the instance. For AttachVolume operation, this is a required field for the request, see attach_volume().

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

is_agent_auto_iscsi_login_enabled¶

Gets the is_agent_auto_iscsi_login_enabled of this AttachIScsiVolumeDetails. Whether to enable Oracle Cloud Agent to 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 AttachIScsiVolumeDetails.
Return type:	bool

is_read_only¶

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

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

is_shareable¶

Gets the is_shareable of this AttachVolumeDetails. 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 AttachVolumeDetails.
Return type:	bool

type¶

[Required] Gets the type of this AttachVolumeDetails. The type of volume. The only supported values are “iscsi” and “paravirtualized”.

Returns:	The type of this AttachVolumeDetails.
Return type:	str

use_chap¶

Gets the use_chap of this AttachIScsiVolumeDetails. Whether to use CHAP authentication for the volume attachment. Defaults to false.

Returns:	The use_chap of this AttachIScsiVolumeDetails.
Return type:	bool

volume_id¶

[Required] Gets the volume_id of this AttachVolumeDetails. The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.

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