VolumeGroup#

class VolumeGroup(name=None, description=None, should_load_balance_vm_attachments=False, sharing_status=None, target_prefix=None, target_name=None, enabled_authentications=None, iscsi_features=None, created_by=None, cluster_reference=None, storage_features=None, usage_type=None, attachment_type=None, protocol=None, is_hidden=False, disks=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs)#

Bases: ExternalizableAbstractModel

A model that represents a Volume Group resource.

Parameters:

  • name (max=256 chars) – (name) Volume Group name.

  • description (max=1000 chars) – (description) Volume Group description. This is an optional field.

  • should_load_balance_vm_attachments – (should_load_balance_vm_attachments) Indicates whether to enable Volume Group load balancing for VM attachments. This cannot be enabled if there are iSCSI client attachments already associated with the Volume Group, and vice-versa. This is an optional field. (Default False)

  • sharing_status – (sharing_status)

  • target_prefix (max=512 chars) – (target_prefix) The specifications contain the target prefix for external clients as the value. This is an optional field.

  • target_name (min=12 chars, max=512 chars) – (target_name) Name of the external client target that will be visible and accessible to the client. This is an optional field.

  • enabled_authentications – (enabled_authentications)

  • iscsi_features – (iscsi_features)

  • created_by (max=512 chars) – (created_by) Service/user who created this Volume Group. This is an optional field.

  • cluster_reference – (cluster_reference) The UUID of the cluster that will host the Volume Group. This is a mandatory field for creating a Volume Group on Prism Central.

  • storage_features – (storage_features)

  • usage_type – (usage_type)

  • attachment_type – (attachment_type)

  • protocol – (protocol)

  • is_hidden – (is_hidden) Indicates whether the Volume Group is meant to be hidden or not. This is an optional field. If omitted, the VG will not be hidden. (Default False)

  • disks – (disks) A list of Volume Disks to be attached to the Volume Group.

property attachment_type#
Type:

AttachmentType

property cluster_reference#

The UUID of the cluster that will host the Volume Group. This is a mandatory field for creating a Volume Group on Prism Central.

Type:

str

property created_by#

Service/user who created this Volume Group. This is an optional field.

Type:

str

property description#

Volume Group description. This is an optional field.

Type:

str

property disks#

A list of Volume Disks to be attached to the Volume Group.

Type:

list[ VolumeDisk ]

property enabled_authentications#
Type:

AuthenticationType

property is_hidden#

Indicates whether the Volume Group is meant to be hidden or not. This is an optional field. If omitted, the VG will not be hidden.

Type:

bool

property iscsi_features#
Type:

IscsiFeatures

property name#

Volume Group name.

Type:

str

property protocol#
Type:

Protocol

property sharing_status#
Type:

SharingStatus

property should_load_balance_vm_attachments#

Indicates whether to enable Volume Group load balancing for VM attachments. This cannot be enabled if there are iSCSI client attachments already associated with the Volume Group, and vice-versa. This is an optional field.

Type:

bool

property storage_features#
Type:

StorageFeatures

property target_name#

Name of the external client target that will be visible and accessible to the client. This is an optional field.

Type:

str

property target_prefix#

The specifications contain the target prefix for external clients as the value. This is an optional field.

Type:

str

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model

property usage_type#
Type:

UsageType