GET /cluster/servicesets/{ssid}/services/vtl/metadata
Optional metadata can be retrieved to assist a user interface in validating user input and providing defaults for the fields. This data is presented in a REST call so that multiple user interfaces can display and validate using a consistent set of data. By interpreting the metadata, user interfaces may not need to be changed when minor additions occur (for example, a new drive type).
The metadata document contains the following sections:
• Properties
• libraryEmulationTypes
• driveEmulationTypes
• protocolTypes
• fcpMetadata Table 94 Properties
New in Version Description
Type Property
1.1 Number of Fibre Channel ports available in this device Integer
numFcPorts
1.1 The remaining size of the drive pool. The drive pool is Integer
numRemainingDrives
the total number of drives which can be configured across the service set.
1.1 The number of remaining libraries that can be Integer
numRemainingLibraries
configured across the service set
1.1 The minimum allowed size of a Physical Storage Quota in Bytes
Long minPhysicalQuotaBytes
1.1 The minimum allowed size of a Logical Storage Quota in Bytes
Long minLogicalQuotaBytes
Table 95 libraryEmulationTypes
New in Version Description
Type Property
1.1 Number to be passed into the Create call or pulled Integer
id
from the Read for this emulation type
1.1 Friendly name of this
protocol – simple enough to String
name
be entered manually by a user (e.g. EML, ESL)
1.1 String which could be
displayed to the user to String
description
describe this emulation type (e.g. EML E Series)
VTL metadata 59
Table 95 libraryEmulationTypes (continued)
New in Version Description
Type Property
1.1 Minimum number of drives supported by this emulation type
Integer minDrives
1.1 Maximum number of drives supported by this emulation type
Integer maxDrives
1.1 Minimum number of slots needed for this emulation type
Integer minSlots
1.1 Default number of slots for this emulation type Integer
defaultNumSlots
1.1 Maximum number of slots supported by this emulation type
Integer maxSlots
1.1 Drives types supported by this emulation. <See availableDriveTypes>
List availableDriveTypes
Table 96 availableDriveTypes
New in Version Column Head
Column Head Column Head
1.1 Identifies a drive emulation type ID supported by this library emulation type Integer
driveTypeId
Table 97 driveEmulationTypes
New in Version Description
Type Property
1.1 Number to be passed into the Create call or pulled Integer
id
from the Read for this emulation type
1.1 String which could be
displayed to the user to String
name
describe this emulation type (for example, LTO4)
1.1 Standard size of cartridges in bytes for this emulation Long
defaultCartridgeSize
type (for example, 800000000000)
Table 98 protocolTypes
New in Version Description
Type Property
1.1 Number to be passed into the Create call or pulled Integer
id
from the Read for this protocol type
1.1 Name of this protocol –
simple enough to be String
name
entered manually by a user (for example, None, FC, or iSCSI)
1.1 String which could be
displayed to the user String
description
describing this protocol type (for example, Fibre Channel)
Table 99 backupApplicationTypes
New in Version Description
Type Property
1.1 Number to be passed into the Create call or pulled Integer
id
from the Read for this backup application
1.1 Name of the backup
application – simple enough String
name
to be entered manually by a user (for example, NetBackup or Veeam
1.1 String which could be
displayed to the user String
description
describing this backup application (for example, Symantec NetBackup)
Table 100 backupDataTypes
New in Version Description
Type Property
1.1 Number to be passed into the Create call or pulled Integer
id
from the Read for this backup data type
1.1 Name of the backup data type – simple enough to be String
name
entered manually by a user (for example, Oracle or File)
1.1 String which could be
displayed to the user String
description
describing this backup data type (for example, Oracle Database)
VTL metadata 61
Table 101 fcpMetadata
New in Version Description
Type Property
1.1 Integer
id
1.1 String
name
1.1 String
description
fcpMetaData
This node contains a single ‘fcpMetadatum’ node, which contains the following nodes:
• properties (currently empty)
• fcpSpeedOptions
• fcpTopologyOptions
• hbaSpecificOptions
A list of all valid Fibre Channel port speeds (which may be supported by, but are not specific to, any Fibre Channel port physically present in the hardware) with the following properties per speed:
Table 102 fcpSpeedOptions
New in Version Description
Type Property
1.1 Number to be passed into the Create/Update call or pulled from the Read Integer
id
1.1 Friendly identifier – simple enough to be entered String
tag
manually by a user or passed as an argument from a user interface (for example, 8Gbs)
1.1 Descriptive string which can be displayed to the user (for example, 8 Gb/s)
String name
A list of all valid Fibre Channel port topologies (which may be supported by, but are not specific to, any Fibre Channel port physically present in the hardware) with the following properties per topology:
Table 103 fcpTopologyOptions
New in Version Description
Type Property
1.1 Number to be passed into the Create / Update call or pulled from the Read Integer
id
1.1 Friendly identifier – simple enough to be entered String
tag
manually by a user or passed as an argument from a user interface (for example, fabric)
1.1 Descriptive string which could be displayed to the user (for example, NPIV) String
name
hbaSpecificOptions
A list of “hba” items, one for each HBA card present (see NOTE below), each hba containing:
• properties
• hbaPorts
NOTE: Extra ports may be present on a card but may not be used. Any such unused ports are represented in the REST response as card ports with an Id equal to -1.
Table 104 Card property
New in Version Description
Type Property
1.1 Identifies each HBA card within the metadata Integer
id
A list, of “hbaPort” items, one for port on the card in use (see NOTE above), each hbaPort containing:
• properties
• hbaPortSpeedOptions
• hbaPortTopologyOptions Table 105 Port properties
New in Version Description
Type Property
1.1 Number to be passed into the Create/Update call or pulled from the Read Integer
id
1.1 String to represent location of port on a HBA
String hbaLabel
A list, of “item” items, one for each speed supported by the port, each item containing:
Table 106 hbaPortSpeedOptions
New in Version Description
Type Property
1.1 Identifies a speed by its ‘id’
property, as defined in Table 102 (page 62) Integer
id
A list, of “item” items, one for each topology supported by the port, each item containing:
Table 107 hbaPortTopologyOptions
New in Version Description
Type Property
1.1 Identifies a topology by its
‘id’ property, as defined in Table 103 (page 62) Integer
id