Class specific additional properties

In addition to the properties defined through included schema, this object includes the following additional class-specific properties:

Table 1. Storage Group object: class specific properties
Name Qualifier Type Description Supported "type" values
cpc-uri String/ URI The canonical URI path of the CPC object associated with this storage group object. All
type String Enum

The type of storage resources managed by the storage group. Values:

  • "fcp" - Fibre Channel Protocol
  • "fc" - Fibre Connection
  • "nvme" - Non-volatile Memory Express

Default value: If a storage template is not specified when creating a storage group, the type property is required; otherwise the value defaults to the value of the template's type property.

All
shared (w)(pc) Boolean

true if this storage group can be attached to more than one partition; false if this storage group is dedicated to a single partition.

This property’s value cannot be changed from true to false if the group is attached to more than one partition.

This property's value must be "false" when the value of the type property is "nvme" or when the value of the max-partitions property is 1.

Default value: If a storage template is not specified when creating a storage group, the shared property defaults to true; otherwise the value defaults to the value of the template’s shared property.

All
fulfillment-state (pc) String Enum The current fulfillment state of the storage group. Values:
  • "complete" – All resources in this storage group have been fulfilled.
  • "pending" – The storage group has been created or modified , but has not yet been completely fulfilled by the SAN administrator. This fulfillment state does not apply if the type property value is "nvme".
  • "pending-with-mismatches" – One or more of the volumes of this storage group have a fulfillment-state property value of "pending-with-mismatches", "configuration-error" or "overprovisioned". This fulfillment state is only applicable if the type property value is "fcp".
  • "checking-migration" – The storage group was created automatically when the dpm-storage-management feature was enabled for the Defined CPC. Volumes that were configured for the virtual storage resources before the feature enablement are being identified. This fulfillment state is only applicable if the type property value is "fcp".
  • "incomplete"For storage groups with a type property value of "fcp", the storage group migration is complete, but at least one of its storage volumes cannot be detected. For storage groups with a type property value of "nvme", an SSD is defective or has been removed from one or more NVMe adapters associated with this storage group. This fulfillment state does not apply if the type property value is "fc".

Default value: "pending"

All
storage-volume-uris (c)(pc) Array of String/ URI

The list of storage volumes in this storage group. Each element in this array is the canonical URI path of a Storage Volume object.

This value will change as storage volumes are added and removed from this storage group through the Modify Storage Group Properties operation.

Default value: If the storage group is created from a template, a set of storage volumes based on the template volumes in the template's storage-template-volume-uris property; otherwise an empty array.

All
virtual-storage-resource-uris (c)(pc) Array of String/ URI

The list of virtual storage resources for this storage group. Each element in this array is the canonical URI path of a Virtual Storage Resource object.

This value will change, and property change notification emitted, when the storage group has fulfilled resources and is attached to or detached from partitions, or when the storage group is already attached to a partition and resources are fulfilled again due to a size change.

Default value: An empty array.

fcp
connectivity (w)(pc) Integer (1-255)

The number of adapters to utilize for this storage group.

When the type value is "fc", the maximum value for the connectivity property is the lesser of 8 or the number of ports on FICON® adapters of type "fc".

When the type value is "fcp", the maximum value is the lesser of 255 or the number of ports on FICON adapters of type "fcp".

Default value: If a storage template is not specified when creating a storage group, the connectivity property defaults to 2 for storage groups of type "fcp"; or to the maximum value for storage groups of type "fc"; otherwise the value defaults to the value of the template’s connectivity property.

fc, fcp
active-connectivity (pc) Integer (1-255)

The value of connectivity that applies when the group is attached to partitions that are currently active or when the partitions are next activated. If the value of the fulfillment-state property is "pending" for newly created storage groups, this property value will be null, indicating it is not applicable.

When the type value is "fc", the maximum value for the active-connectivity property is the lesser of 8 or the number of ports on FICON adapters of type "fc".

When the type value is "fcp", the maximum value is the lesser of 255 or the number of ports on FICON adapters of type "fcp".

This value will change to the value of connectivity, and property change notifications emitted, when the value of the connectivity property decreases, or after the value of the connectivity property increases and the new or modified storage group is fulfilled.

fcp
max-partitions (w)(pc) Integer

The maximum number of partitions to which this storage group can be attached.

The value of max-partitions cannot exceed 1 if the value of the shared field is false. The value of max-partitions must be greater than 1 if the value of the shared field is true.

The value of max-partitions cannot be decreased to a value that is less that the total number of partitions to which this storage group is currently attached.

The minimum value for the max-partitions property is 1; the maximum is the value of the CPC object's maximum-partitions property.

Default value: If a storage template is not specified when creating a storage group, the max-partitions property defaults to 2; otherwise the value defaults to the value of the template's max-partitions property.

fcp
active-max-partitions (pc) Integer

When the value of the max-partitions property changes, the limit on the number of partitions to which the partition can be attached changes immediately. However, if the value increases, the storage resources for the additional partitions require fulfillment. When the storage group is attached to more than the active-max-partitions number of partitions, the most recently attached partitions will not see the storage group's storage resources until that fulfillment occurs. If the value of the fulfillment-state property is "pending" for newly created storage groups, this property value will be null, indicating it is not applicable.

This value will change to the value of max-partitions, and property change notifications emitted, when the value of the max-partitions property decreases, or after the value of the max-partitions property increases and the new or modified storage group is fulfilled.

fcp
candidate-adapter-port-uris (c)(pc) Array of String/ URI

The list of adapter ports that are candidates for use in fulfilling connections to FCP devices. Each element in this array is an instance of the canonical URI path of a storage adapter port.

This value will change, and property change notifications emitted, when candidate adapter port are added and removed through the Add Candidate Adapter Ports to an FCP Storage Group or Remove Candidate Adapter Ports from an FCP Storage Group operations.

fcp
direct-connection-count (w)(pc) Integer (0-1000) The number of additional virtual storage resource connections for the host that can be directly assigned to a guest virtual machine. A value of zero indicates this feature is disabled.

The direct-connection-count property cannot be enabled (greater than zero) when the shared property is true.

Default value: If a storage template is not specified when creating a storage group, the direct-connection-count property defaults to 0; otherwise the value defaults to the value of the template's direct-connection-count property.

fcp
unassigned-world-wide-port-names (c)(pc) Array of world-wide-port-name info

The list of information about the worldwide port names (WWPNs) that have been allocated to support this FCP storage group, but have not yet been assigned to a virtual storage resource. Each element in this array is an instance of a world-wide-port-name-info nested object, defined in Table 2.

This value will change, and property change notifications emitted, when the connectivity or max-partitions properties change, or when virtual storage resources are created or deleted.

Default value: An empty array.

fcp