LaunchAttachIScsiVolumeDetails¶

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

Bases: oci.core.models.launch_attach_volume_details.LaunchAttachVolumeDetails

Details specific to ISCSI type volume attachments.

Attributes

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

Methods

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

__init__(**kwargs)¶

Initializes a new LaunchAttachIScsiVolumeDetails 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 LaunchAttachIScsiVolumeDetails.
display_name (str) – The value to assign to the display_name property of this LaunchAttachIScsiVolumeDetails.
is_read_only (bool) – The value to assign to the is_read_only property of this LaunchAttachIScsiVolumeDetails.
is_shareable (bool) – The value to assign to the is_shareable property of this LaunchAttachIScsiVolumeDetails.
type (str) – The value to assign to the type property of this LaunchAttachIScsiVolumeDetails.
volume_id (str) – The value to assign to the volume_id property of this LaunchAttachIScsiVolumeDetails.
launch_create_volume_details (oci.core.models.LaunchCreateVolumeDetails) – The value to assign to the launch_create_volume_details property of this LaunchAttachIScsiVolumeDetails.
use_chap (bool) – The value to assign to the use_chap property of this LaunchAttachIScsiVolumeDetails.
encryption_in_transit_type (str) – The value to assign to the encryption_in_transit_type property of this LaunchAttachIScsiVolumeDetails. 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 LaunchAttachIScsiVolumeDetails.

device¶

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

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

display_name¶

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

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

encryption_in_transit_type¶

Gets the encryption_in_transit_type of this LaunchAttachIScsiVolumeDetails. 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 LaunchAttachIScsiVolumeDetails.
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.

is_agent_auto_iscsi_login_enabled¶

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

is_read_only¶

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

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

is_shareable¶

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

launch_create_volume_details¶

Gets the launch_create_volume_details of this LaunchAttachVolumeDetails.

Returns:	The launch_create_volume_details of this LaunchAttachVolumeDetails.
Return type:	oci.core.models.LaunchCreateVolumeDetails

type¶

[Required] Gets the type of this LaunchAttachVolumeDetails. The type of volume. Currently, the only supported value is “iscsi”.

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

use_chap¶

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

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

volume_id¶

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

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