VolumeAttachment¶

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

Bases: object

A base object for all types of attachments between a storage volume and an instance. For specific details about iSCSI attachments, see IScsiVolumeAttachment.

For general information about volume attachments, see Overview of Block Volume Storage.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`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.
`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.
`id`	[Required] Gets the id of this VolumeAttachment.
`instance_id`	[Required] Gets the instance_id 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.
`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 VolumeAttachment 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.

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 VolumeAttachment object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 VolumeAttachment.
availability_domain (str) – The value to assign to the availability_domain property of this VolumeAttachment.
compartment_id (str) – The value to assign to the compartment_id property of this VolumeAttachment.
device (str) – The value to assign to the device property of this VolumeAttachment.
display_name (str) – The value to assign to the display_name property of this VolumeAttachment.
id (str) – The value to assign to the id property of this VolumeAttachment.
instance_id (str) – The value to assign to the instance_id property of this VolumeAttachment.
is_read_only (bool) – The value to assign to the is_read_only property of this VolumeAttachment.
is_shareable (bool) – The value to assign to the is_shareable property of this VolumeAttachment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VolumeAttachment. 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 VolumeAttachment.
volume_id (str) – The value to assign to the volume_id property of this VolumeAttachment.
is_pv_encryption_in_transit_enabled (bool) – The value to assign to the is_pv_encryption_in_transit_enabled property of this VolumeAttachment.
is_multipath (bool) – The value to assign to the is_multipath property of this VolumeAttachment.
iscsi_login_state (str) – The value to assign to the iscsi_login_state property of this VolumeAttachment. 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 VolumeAttachment.

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

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’s changeable. Avoid entering confidential information.

Returns:	The display_name of this VolumeAttachment.
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.

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

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

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

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

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

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

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

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