VolumeGroup

class oci.core.models.VolumeGroup(**kwargs)

Bases: object

Specifies a volume group which is a collection of volumes. For more information, see Volume Groups.

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

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'

A constant which can be used with the lifecycle_state property of a VolumeGroup. This constant has a value of "AVAILABLE"

LIFECYCLE_STATE_FAULTY = 'FAULTY'

A constant which can be used with the lifecycle_state property of a VolumeGroup. This constant has a value of "FAULTY"

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

A constant which can be used with the lifecycle_state property of a VolumeGroup. This constant has a value of "PROVISIONING"

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a VolumeGroup. This constant has a value of "TERMINATED"

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a VolumeGroup. This constant has a value of "TERMINATING"

__init__(**kwargs)

Initializes a new VolumeGroup object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • availability_domain (str) -- The value to assign to the availability_domain property of this VolumeGroup.
  • compartment_id (str) -- The value to assign to the compartment_id property of this VolumeGroup.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this VolumeGroup.
  • display_name (str) -- The value to assign to the display_name property of this VolumeGroup.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this VolumeGroup.
  • id (str) -- The value to assign to the id property of this VolumeGroup.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this VolumeGroup. Allowed values for this property are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • size_in_mbs (int) -- The value to assign to the size_in_mbs property of this VolumeGroup.
  • size_in_gbs (int) -- The value to assign to the size_in_gbs property of this VolumeGroup.
  • source_details (VolumeGroupSourceDetails) -- The value to assign to the source_details property of this VolumeGroup.
  • time_created (datetime) -- The value to assign to the time_created property of this VolumeGroup.
  • volume_ids (list[str]) -- The value to assign to the volume_ids property of this VolumeGroup.
  • is_hydrated (bool) -- The value to assign to the is_hydrated property of this VolumeGroup.
availability_domain

[Required] Gets the availability_domain of this VolumeGroup. The availability domain of the volume group.

Returns:The availability_domain of this VolumeGroup.
Return type:str
compartment_id

[Required] Gets the compartment_id of this VolumeGroup. The OCID of the compartment that contains the volume group.

Returns:The compartment_id of this VolumeGroup.
Return type:str
defined_tags

Gets the defined_tags of this VolumeGroup. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Returns:The defined_tags of this VolumeGroup.
Return type:dict(str, dict(str, object))
display_name

[Required] Gets the display_name of this VolumeGroup. A user-friendly name for the volume group. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:The display_name of this VolumeGroup.
Return type:str
freeform_tags

Gets the freeform_tags of this VolumeGroup. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

Returns:The freeform_tags of this VolumeGroup.
Return type:dict(str, str)
id

[Required] Gets the id of this VolumeGroup. The OCID for the volume group.

Returns:The id of this VolumeGroup.
Return type:str
is_hydrated

Gets the is_hydrated of this VolumeGroup. Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.

Returns:The is_hydrated of this VolumeGroup.
Return type:bool
lifecycle_state

Gets the lifecycle_state of this VolumeGroup. The current state of a volume group.

Allowed values for this property are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this VolumeGroup.
Return type:str
size_in_gbs

Gets the size_in_gbs of this VolumeGroup. The aggregate size of the volume group in GBs.

Returns:The size_in_gbs of this VolumeGroup.
Return type:int
size_in_mbs

[Required] Gets the size_in_mbs of this VolumeGroup. The aggregate size of the volume group in MBs.

Returns:The size_in_mbs of this VolumeGroup.
Return type:int
source_details

Gets the source_details of this VolumeGroup. The volume group source. The source is either another a list of volume IDs in the same availability domain, another volume group, or a volume group backup.

Returns:The source_details of this VolumeGroup.
Return type:VolumeGroupSourceDetails
time_created

[Required] Gets the time_created of this VolumeGroup. The date and time the volume group was created. Format defined by RFC3339.

Returns:The time_created of this VolumeGroup.
Return type:datetime
volume_ids

[Required] Gets the volume_ids of this VolumeGroup. OCIDs for the volumes in this volume group.

Returns:The volume_ids of this VolumeGroup.
Return type:list[str]