Supported volume type extra-specs

Edit online

The extra_specs that PowerVC supports when you are creating or updating volume types by using OpenStack APIs for supported storage providers. PowerVC uses the term storage template instead of volume type.

Volume type options when creating a Hitachi provider
Volume type options when creating an IBM System Storage DS8000 provider
Volume type options when creating an IBM Storwize provider
Volume type options when creating an EMC PowerMax provider

Volume type options when creating a Hitachi provider

Table 1. Options for volume type to be used to create a Hitachi volume
Option	Key name	Description	Values
Host name	capabilities:volume_ backend_name	Name of the host where volume is created.	The user-defined name for the host.
Storage Pool	drivers:storage_pool	Storage pool where volume is created.	Name of the storage pool.
Display Name	drivers:display_name	The display name for the volume type.
Target ports	hbsd:target_ports	The ports on the array that should be used to connect volumes to virtual machines.	Comma separated list of port names. For example, CL5-B,CL6-B.

Volume type options when creating an IBM® System Storage DS8000 provider

Table 2. Options for volume type to be used to create a DS8000 volume
Option	Key name	Description	Values
Host name	capabilities:volume_ backend_name	Name of the host where volume is created.	The user-defined name for the host.
Port Group	drivers:port_group:<`port_group_name`>	The port group and list of ports to include in the port group.	Comma separated list of storage port WWPNs to include in this port group. This list overrides any existing whitelists or blacklists. The values specified for `port-group-name` can be obtained from the values specified for `drivers:target_port_groups`.
Target Port Groups	drivers:target_port_groups	The list of port groups for the volume type.	Comma separated list of port group keys defined in `drivers:port_group`.
Storage Pool	drivers:storage_pool	Storage pool where volume is created.	Name of the storage pool.
Display Name	drivers:display_name	The display name for the volume type.
Storage Pool IDs	drivers:storage_pool_ids	Optional. Comma separated list of DS8000 pool IDs in which to create a volume. The volume is created in the storage pool that has the most free space and an available slot in an LSS. If this value is present in the extra spec, it takes precedence during volume creation.	A list of existing DS8000 pool IDs. For example: P0,P1,P2,P3
Storage Logical Subsystems	drivers:storage_lss_ids	Optional. Comma separated list of DS8000 logical subsystem IDs.	A list of DS8000 logical subsystem IDs. For example: 00,01,0A,0B
Target Whitelist	drivers:target_whitelist	Optional. Comma separated list of target WWPNs used for zoning during NPIV deploy.	A list of target WWPNs. For example, 5005076802232abc,5005076802232abd

Volume type options when creating an IBM Storwize provider

Table 3. Options for volume type to be used to create a Storwize volume
Option	Key name	Description	Values
Host name	capabilities:volume_ backend_name	Name of the host where volume is created.	The user-defined name for the host.
Port Group	drivers:port_group:<`port_group_name`>	The port group and list of ports to include in the port group.	Comma separated list of storage port WWPNs to include in this port group. This list overrides any existing whitelists or blacklists. The values specified for `port-group-name` can be obtained from the values specified for `drivers:target_port_groups`.
Target Port Groups	drivers:target_port_groups	The list of port groups for the volume type.	Comma separated list of port group keys defined in `drivers:port_group`.
Storage Pool	drivers:storage_pool	Storage pool where volume is created.	Name of the storage pool.
Display Name	drivers:display_name	The display name for the volume type.
I/O group	drivers:iogrp	Optional. The I/O group in which to allocate a volume.	A string that lists the name.
Mirror Pool	drivers:mirror_pool	Specifies the name of the pool to establish a mirror copy in. The value of `mirror_pool` can be either a local mirror or the stretch cluster mirror. When this property is set, volumes are created with a mirror copy in the pool specified by `mirror_pool`.	A string that lists the name.
Real	drivers:rsize	The capacity that is allocated to the volume copy.	For a thin-provisioned volume: Percent of virtual capacity for thin provisioning. For all other volumes, specify `-1`. This tells PowerVC to create the volume without thin-provisioning.
Replication	No longer used.	No longer used.	No longer used.
Multipath	drivers:multipath	Specifies whether to enable multipath zoning. When enabled, the Storwize® volume driver uses all available WWPNs from all of the I/O groups in the storage controller to attach the volume to the virtual machine. Enabling multipath causes each WWPN that is visible on the fabric to be zoned to the virtual machine.	`1:` Enable multipath. `0:` Do not enable multipath. This is the default setting.
Automatically expand	drivers:autoexpand	Supported only when creating a thin provisioned provider. Specifies whether to automatically increase the real capacity of the volume.	`1:` Automatically expand. `0:` Do not automatically expand.
Grain size	drivers:grainsize	Optional. Supported only when creating a thin provisioned provider. Volume grain size.	Volume grain size, in KB.
Warning Threshold	drivers:warning	Supported only when creating a thin provisioned provider. Generate volume capacity warnings for this volume when the specified threshold is met.	Percent of virtual capacity.
Compression	drivers:compression	Supported only when creating a thin provisioned provider. Specifies whether to create a compressed volume.	`1:` Compress the volume. `0:` Do not compress the volume.
Target Whitelist	drivers:target_whitelist	Optional. Comma separated list of target WWPNs used for zoning during NPIV deploy.	A list of target WWPNs. For example, 5005076802232abc,5005076802232abd
I/O throttle	qos:IOThrottling	When SVC volume_type or storage template is configured with this extra_specs, then I/O rate is configured on volumes that are created based on this template. Optional. Positive integer value for I/O rate. Note: For on boarded volumes, PowerVC does not auto detect the QoS value.	For example, qos:IOThrottling= `50`, to set the I/O rate.
I/O throttle	qos:IOThrottling_unit	When SVC volume_type or storage template is configured with this extra_specs, then I/O rate is configured with the unit as specified on the volume. Optional. Values can be iops, mbps, iops_per_gb. iops_per_gb allows user to set the iops value based on the volume size. For example, if the values of iops_per_gb is 50, and user creates volume of size 100 GB, the iops throughput for the volume will be 5000. Default value is iops.	For example, qos:IOThrottling_unit=`iops`, `mbps`, or `iops_per_gb` to set the I/O rate as I/Os or MBps, or I/O rate per GB respectively.
FlashCopy® rate	drivers:flashcopy_rate	To configure the Storwize FlashCopy rate, default value is set to 50. Valid rates are 1-150.	For example, drivers:flashcopy_rate=50. You can set this rate from 1 to 150.
Fast formatting	drivers:nofmtdisk	To enable or disable fast format. Default value is `Enable`.	For example, drivers:nofmtdisk=Enable.

Volume type options when creating an EMC PowerMax provider

Table 4. Options for EMC VMAX providers
Option	Key name	Description	Values
Striped member count	storagetype:stripecount	The number of storage blocks to stripe data across. This option applies to VMAX2 devices only. VMAX2 support is deprecated and will be removed in a later release.	Integers 1 and higher. The default is 1, which means that volumes are made of concatenated members, beginning with a single member. A value of 2 or higher results in striped composite volumes being created. Note: If the volume size might be increased later, specify `1`. You cannot increase the size of striped composite volumes.
FAST policy name	drivers:fastpolicy	Optional. The Fully Automated Storage Tiering (FAST) policy name to associate with the template, if any. Volumes created with a FAST policy are controlled by that policy and their data might be moved between storage tiers for better performance. This option applies to VMAX2 devices only. VMAX2 support is deprecated and will be removed in a later release.	String containing the name of the pre-defined FAST policy on the PowerMax array.
Service Level Objective	drivers:slo	Optional. Only available on SMI-S managed VMAX3 series arrays that support Service Level. It is not supported for REST-based VMAX providers. Volumes will be created with the specified service level. Service levels are associated with maximal and average response times that can be expected for various workload storage I/O operations.	Valid values are: 'Bronze', 'Silver', 'Gold', 'Platinum', 'Diamond', and 'Optimized.'
Target Whitelist	drivers:target_whitelist	Optional. Comma separated list of target WWPNs used for zoning during NPIV deploy.	A list of target WWPNs. For example, 5005076802232abc,5005076802232abd
Workload type	drivers:workload	Optional. Only available on SMI-S managed VMAX3 series arrays, and only applicable if drivers:slo is also specified. It is not supported for REST-based VMAX providers. This workload type string further qualifies the workload to specify the type of I/O expected for it and whether it is replicated (mirrored).	Valid values are: 'DSS_REP', 'DSS', 'OLTP', 'OLTP_REP', and 'NONE'.
PowerMAX storage template	drivers:powermax_target_port_groups	Comma separated list of pre-created PowerMax port groups	Takes attributes for volume_type.

Example: update a volume type so that volumes are not automatically expanded

This operation updates a volume type so that volumes are not auto-expanded.

Request URI and body

PUT 
/v3/{tenant_id}/types/{volume_type_id}/extra_specs/drivers:autoexpand

{
 "drivers:autoexpand":"0"
}

Example: PowerMax port group load balancing

This operation allows to select a set of pre-created port groups and specify the same on the storage template.

Request URI and body

POST/PUT  https://jupiter-vm1020.pok.stglabs.ibm.com/powervc/openstack/volume/v3/e992da80f0974769937c9fe035ed0a55/types
{ 
"volume_type":{
      "name":"svl_pmax-load-balancing-template",
      "extra_specs":{
         "drivers:display_name":"svl_pmax-load-balancing-template",
         "drivers:description":null,
         "capabilities:volume_backend_name":"000197800962",
         "drivers:storage_pool":"SRP_1",
         "drivers:provision_type":"thin",
         "drivers:storage_array":"000197800962",
         "drivers:pool_name":"None+None+SRP_1+000197800962",
         "drivers:powermax_target_port_groups":"sjx64p6g_PG,ASP_TEST_SG_PG,ASP_SMSL_PG,AUTOPI_KILO_SG_PG,sjpwra64_PG,ASP_TEST_PG"
      }
   }
}