Read (all VTL replication mappings)
GET
/cluster/servicesets/{ssid}/services/rep/libraries/{libraryid}/mappings All VTL replication mappings assigned to the VTL library can be retrieved as a list. All content available in a Read call for an individual library mapping is returned.
Note that the {ssid} and the {libraryId} URI parameters can identify the mapping, as seen from the perspective of EITHER the source library OR the target library.
Read (individual VTL replication mapping)
GET
/cluster/servicesets/{ssid}/services/rep/libraries/{libraryid}/mappings/
{mappingid}
An individual VTL mapping in the specified VTL library can be retrieved based on its ID. Content is returned from a GET call with the following properties.
NOTE: Whether Source or Target attributes are returned will depend on the role of the local library.
Table 220 VTL repliaction mapping properties
New in Version Description
Type Property
1.0 Unique ID for this mapping within the current library
Integer id
1.0 String which could be displayed to the user (e.g. “Library Mapping 1”) String
name
1.0 String representation of the replication status of the mapping.
String repStatus
VTL replication mappings 161
Table 220 VTL repliaction mapping properties (continued)
New in Version Description
Type Property
1.0 Enumeration value corresponding to the replication role of the local library. See Table 201 (page 150).
Integer repRole
1.0 String representation of the replication role of the local library. SeeTable 201 (page 150).
String repRoleString
1.0 The number of replicating slots in the mapping.
Integer numMappedSlots
1.0 The number of mapped slots that are currently out of sync in the mapping.
Integer numMappedSlotsOutOfSync
1.0 The number of mapped slots that are currently out of sync in the mapping for which there are warnings.
Integer numMappedSlotsOutOfSyncWarning
1.0 The number of mapped slots that are currently out of sync in the mapping for which there are critical errors.
Integer numMappedSlotsOutOfSyncCritical
1.0 The number of hours that the mapping has been out of sync.
Integer hoursOutOfSync
1.0 String stating the collection of slots that are mapped.
String mappedSlots
1.0 The current throughput of the slot data job (in bytes)
Long averageThroughput
1.0 The bandwidth used by the slot data job (in bytes)
Long averageBandwidthUse
1.0 The current bandwidth saving of the job (as a %)
Integer averageBandwidthSave
1.0 Flag stating whether the local library is visible from other hosts or not.
Boolean visibleFromHosts
1.0 Flag stating whether the there is an active recovery job in the mapping or not
Boolean recoveryActive
1.0 Id of the source/target appliance.
Integer (source|target)ApplianceId
1.0 Flag stating whether or not the
source/target appliance is currently online.
Boolean (source|target)ApplianceOnline
1.0 The name of the source/target
appliance.
String (source|target)ApplianceName
1.0 The IP or hostname string of the
source/target appliance.
String (source|target)ApplianceAddress
1.0 The serial number of the source/target appliance.
String (source|target)ApplianceSerialNumber
1.0 The product class of the source/target appliance.
String (source|target)ApplianceProductClass
1.0 Id of the source/target library.
Integer (source|target)LibraryId
1.0 The source/target library name.
String (source|target)LibraryName
Table 220 VTL repliaction mapping properties (continued)
New in Version Description
Type Property
1.0 Id of the mapping as seen by the
source/target.
Integer (source|target)MappingId
1.0 Replication Version of the source/target library
String (source|target)RepVersion
1.0 Replication Role of the source/target library
Integer (source|target)RepRole
1.0 Number of mappings on the
source/target library Integer
(source|target)NumMappings
1.0 Number of slots in the source/target library
Integer (source|target)NumSlots
1.0 Number of mapped slots in the
source/target library Integer
(source|target)NumMappedSlots
1.0 Health Status Level of the source/target library
Integer (source|target)HealthStatusLevel
1.0 String detailing the status of the share -e.g. ‘Online’
String (source|target)HealthStatus
1.0 String detailing the share status - eg.
‘Offline’
String (source|target)Status
1.0 The total size of the user data that has been stored in the library (before Long
(source|target)UserBytes
deduplication) -in Bytes. (Note that although for consistency purposes the unit used here is Bytes, the actual precision is GB)
1.0 The actual size data in the library (post deduplication) - in Bytes. (Note that Long
(source|target)DiskBytes
although for consistency purposes the unit used here is Bytes, the actual precision is GB)
Note that the {ssid}, the {libraryId} and {mappingId} URI parameters can identify the mapping, as seen from the perspective of EITHER the source library OR the target library.
If the partner appliance is offline, some fields in the output will not have relevant information, and will be informed with default values (0 or empty string). Please, be aware of the fact that, if requesting xml, when a field contains an empty string, it won’t even be part of the output.
The status of the partner appliance will be reported as unknown.
• If the information of the mapping is requested from the source, and the target is offline, the following fields will have default values:
◦
targetApplianceName = empty string◦
targetApplianceProductClass = empty stringVTL replication mappings 163
And the health status and the status will be unknown:
◦
targetHealthStatusLevel = 0 (Enum value for Unknown)◦
targetHealthStatus = Unknown◦
targetStatus = Unknown• If the information of the mapping is requested from the source, and the target is offline, the following information will be affected:
◦
sourceApplianceId = 0◦
sourceApplianceName = empty string◦
sourceApplianceAddress = empty string◦
sourceApplianceProductClass = empty string And the health status will be unknown:◦
sourceHealthStatusLevel = 0◦
sourceHealthStatus = Unknown◦
sourceStatus = UnknownError messages are returned in the following cases:
• Invalid data (strings where integers are expected) – 400 Bad Request
• The mapping/library/appliance does not exist – 404 Not Found
• All other errors (returned by the subsystem) – Unexpected error – 500 Internal Error