Storage Template Volume element object

A Storage Template Volume element object defines the size and usage of a single storage template volume within its parent storage template.

Table 1. Storage Template Volume element object properties
Name Qualifier Type Description Supported adapter "type" values
element-id String (36) Unique identifier for the storage template volume instance All
element-uri String/ URI The canonical URI path for the storage

template volume element object, of the form /api/storage-templates/{storagetemplate-id}/storage-template-volumes/{storage-template-volume-id}, where {storage-template-id} is the object-id of the containing storage template, and {storage-template-volume-id} is the element-id of this storage template volume.

All
parent String/ URI The parent of a storage template volume is its owning storage group, so the parent value is the canonical URI path for the storage template. All
class String (23) The class of a Storage Template Volume element object is "storage-template-volume". All
name (w)(pc) String (1-64) The name of the storage template volume. The character requirements on this property are the same as those of the name property described in the Base managed object properties schema.

Names must be unique to the other storage template volumes associated with the parent storage template. Default value: Currently of the form "# GiB {usage}{index}", where # is the size of the volume, {usage} is the usage, and {index} is a number that may or may not be present to ensure name uniqueness. This form is subject to change in the future.

All
description (w)(pc) String (0-100)

Arbitrary text providing additional descriptive information about the template volume.

This value will be used to initialize the description property of storage volumes that are created using this storage template volume. Default value: An empty string.

All
size (w)(pc) Float

The size in gibibytes (GiB) for this template volume.

For volumes in storage templates of type "fcp", the size property must be between 1.00 and 1,048,576.00.

For volumes in storage templates of type "fc", with a model value other than "EAV", the size property is fixed at the value specified below and cannot be written:

  • Model - Maximum size
  • "1" - 0.88
  • "2" - 1.76
  • "3" - 2.64
  • "9" - 7.92
  • "27" - 25.93
  • "54" - 51.86

For volumes with a model value of "EAV", size is writable and must be between 0.88 and 212489.20. Note however that the maximum is a theoretical size that may not be supported by an operating system.

For volumes in storage templates of type "fc", the size value is related to the cylinders property. Specifying the size in GiB will also define the number of cylinders and vice versa. The size and cylinders properties cannot be specified together as fields in a create or modify operation. The value will be used to initialize the size property of storage volumes that are created using this storage template volume.

All
usage (w)(pc) String Enum The usage of the storage volumes created from this template. Values:
  • "boot" – storage volumes created from this template will contain a bootable image.
  • "data" –storage volumes created from this template will contain data.

This value will be used to initialize the usage property of storage volumes that are created using this storage template volume. Default value: "data".

All
model (w)(pc) String Enum The 3390 model designation for the storage. Values:
  • "1" - Model 1
  • "2" - Model 2
  • "3" - Model 3
  • "9" - Model 9
  • "27" - Model 27
  • "54" - Model 54
  • "EAV" - Extended Address Volume

This value will be used to initialize the model property of storage volumes that are created using this storage template volume.

fc
cylinders (w)(pc) Integer (1113- 268434453)

The size of the volume in cylinders. If the model value is other than "EAV", the cylinders property is fixed at the value specified below and cannot be written:

  • Model - Cylinders
  • "1" - 1113
  • "2" - 2226
  • "3" - 3339
  • "9" - 10017
  • "27" - 32760
  • "54" - 65520

For volumes with a model value of “EAV”, cylinders is writable and has a maximum value of 268434453. Note however that this is a theoretical size that may not be supported by an operating system.

The cylinders value is related to the size property. Specifying the size in cylinders will also define the size and vice versa. The cylinders and size properties cannot be specified together as fields in a create or modify operation. This value will be used to initialize the cylinders property of storage volumes that are created using this storage template volume.

fc
device-number (w)(pc) String (4)

A four-byte lower case hexadecimal string defining the device number that is assigned by default when FICON® storage groups containing storage volumes created from this storage template are attached to partitions. This value may be null, in which case the system auto-assigns a device number.

This value will be used to initialize the device-number property of storage volumes that are created using this storage template volume. Default value: null.

fc