This operation returns the details associated with a library.
Request
Syntax
GET <webservice>/Library/{libraryId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
Name | Description | Required |
|---|---|---|
libraryId | The library ID for the library. If the library ID is not known, use the GET Library API to retrieve it. | Yes |
Request Headers
Name | Description |
|---|---|
Host | The host name of the Web Server or Web Console used in the API request. |
Accept | The format of the response. Valid values are: application/xml or application/json. |
Authtoken | The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
Parameter | Description | Element |
|---|---|---|
model | Library model. | libraryInfo |
manufacturer | Library manufacturer. | libraryInfo |
libraryVendorId | Library vendor. | libraryInfo |
libraryType | Library type. 1 - Tape 3 - Disk/Cloud 4 - Stand Alone Library | libraryInfo |
description | Library description. | libraryInfo |
totalNumberOfWriteReservations | Magnetic library number of write reservations. | magLibSummary |
totalFreeSpace | Magnetic library total free space. | magLibSummary |
totalCapacity | Magnetic library capacity. | magLibSummary |
totalAvailableSpace | Magnetic library available space. | magLibSummary |
onlineMountPaths | Magnetic library mount paths that are online. | magLibSummary |
numOfMountPath | Magnetic library total number of mount paths. | magLibSummary |
mountPathUsage | Magnetic library mount path usage details. | magLibSummary |
lastRestoreTime | Magnetic library time of the most recent restore job. | magLibSummary |
lastHourThroughput | Magnetic library throughput in the last 1 hour. | magLibSummary |
lastDayThroughput | Magnetic library throughput in the last 1 day. | magLibSummary |
lastBackupTime | Magnetic library time of the most recent backup job. | magLibSummary |
isOnline | Magnetic library status. | magLibSummary |
bytesBackedupInLast24H | Magnetic library total amount of backup in the last 24 hours. | magLibSummary |
bytesBackedupInLast1H | Magnetic library total amount of backup in the last 1hour. | magLibSummary |
backupReservations | Magnetic library status - current reservation for backup job. | magLibSummary |
auxiliaryCopyWriteReservations | Magnetic library status - current reservations for auxiliary copy job. | magLibSummary |
associatedMediaAgents | Magnetic library MediaAgent associations. | magLibSummary |
status | Tape library current status. | tapeLibSummary |
model | Tape library model. | tapeLibSummary |
totalNumberOfWriteReservations | Tape library total number of current write reservations. | tapeLibSummary |
lastRestoreTime | Tape library time of the most recent restore job. | tapeLibSummary |
lastHourThroughput | Tape library throughput in the last 1 hour. | tapeLibSummary |
lastDayThroughput | Tape library throughput in the last 1 day. | tapeLibSummary |
lastBackupTime | Tape library time of the most recent backup job. | tapeLibSummary |
isOnline | Tape library total amount of backup in the last 24 hours. | tapeLibSummary |
bytesBackedupInLast24H | Tape library total amount of backup in the last 1hour. | tapeLibSummary |
bytesBackedupInLast1H | Tape library status - current reservation for backup job. | tapeLibSummary |
backupReservations | Tape library status - current reservations for auxiliary copy job. | tapeLibSummary |
auxiliaryCopyWriteReservations | Tape library status - current reservations for auxiliary copy job. | tapeLibSummary |
associatedMediaAgents | Tape library MediaAgent associations. | tapeLibSummary |
vendor | Tape library vendor. | tapeLibSummary |
serialNumber | Tape library serial number. | tapeLibSummary |
offlineReason | Tape library offline reason. | tapeLibSummary |
numOfSpareMedia | Tape library total number of spare media. | tapeLibSummary |
numOfSlots | Tape library total number of slots | tapeLibSummary |
numOfRegSlots | Tape library total number of registered slots. | tapeLibSummary |
numOfRegSlotOccupied | Tape library total number of occupied slots. | tapeLibSummary |
numOfMediaExporting | Tape library total number of exported media. | tapeLibSummary |
numOfMedia | Tape library total number of media in the library. | tapeLibSummary |
numOfIESlots | Tape library total number of mail slots. | tapeLibSummary |
numOfIESlotOccupied | Tape library total number of mail slots occupied. | tapeLibSummary |
numOfDrivesOffline | Tape library number of offline drives. | tapeLibSummary |
numOfDrives | Tape library total number of drives. | tapeLibSummary |
numOfCleaningMedia | Tape library total number of cleaning media. | tapeLibSummary |
numOfAppendableMedia | Tape library total number of appendable media. | tapeLibSummary |
numOfAgedMedia | Tape library total number of aged media. | tapeLibSummary |
numOfActiveMedia | Tape library total number of active media. | tapeLibSummary |
isEnabled | Tape library availability. | tapeLibSummary |
firmwareRevision | Tape library firmware version. | tapeLibSummary |
controller | Tape library controller. | tapeLibSummary |
barcodeReader | Tape library - does it have a barcode reader. | tapeLibSummary |
attribute | Tape library attribute. | tapeLibSummary |
status | Drive online/offline status. | DriveList |
mountStatus | Drive mount status. | DriveList |
jobIds | Drive - job IDS of the current job accessing the drive. | DriveList |
driveType | Drive type. | DriveList |
drivePoolName | Drive pool name to which the drive is attached. | DriveList |
drivePoolId | Drive pool ID to which the drive is attached. | DriveList |
driveName | Drive name. | DriveList |
driveId | Drive ID. | DriveList |
barcode | Drive - barcode of the media in the drive. | DriveList |
activeMediaAgent | Drive - MediaAgent associated with the current job accessing the drive. | DriveList |
access | Drive - whether it is currently accessed. | DriveList |
status | Drive status. | driveSummary |
model | Drive model. | driveSummary |
lastHourThroughput | Drive throughput in the last hour. | driveSummary |
lastDayThroughput | Drive throughput in the last day. | driveSummary |
isOnline | Whether the drive is online. | driveSummary |
vendor | Drive vendor. | driveSummary |
serialNumber | Drive serial number. | driveSummary |
offlineReason | Drive offline reason. | driveSummary |
isEnabled | Whether the drive is enabled. | driveSummary |
firmwareRevision | Drive firmware version. | driveSummary |
controller | Name of the drive controller. | driveSummary |
attribute | Drive attribute. | driveSummary |
driveName | Name of the drive. | driveSummary |
readWriteErrosSinceLastClean | Number of read errors after the last drive cleaning operation. | driveSummary |
numberOfRunningJobs | Number of jobs accessing the drive. | driveSummary |
mountUnmountErrosSinceLastClean | Number of mount/unmount errors after the last drive cleaning operation. | driveSummary |
library | Library in which the drive is located. | driveSummary |
lastUseTime | The most recent time that the drive was accessed. | driveSummary |
hoursUsedSinceLastClean | Total number of hours used since the most recent cleaning operation. | driveSummary |
bytesBackedupInLast24Hour | Total amount of backup in the last 24 hours. | driveSummary |
bytesBackedupInLast1Hour | Total amount of backup in the last 1 hour. | driveSummary |
libraryName | Name of the library. | library |
libraryId | System generated ID for the library. | library |
Examples
Sample Request
GET <webservice>/Library/2 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
Note: The GET Library Details operation can not return the mount path information in the response. The mountPathSummary in the response for a cloud library or a disk library displays zero values for all parameters.
Tape Library
<?xml version="1.0" encoding="UTF-8"?>
<EVGui_GetLibraryInfoWCResp>
<libraryInfo status="" model="Scalar i2000" manufacturer="QUANTUM" libraryVendorId="0" libraryType="1" description="">
<magLibSummary totalNumberOfWriteReservations="0" totalFreeSpace="" totalCapacity="" totalAvailableSpace="" onlineMountPaths="" numOfMountPath="0" mountPathUsage="" lastRestoreTime="" lastHourThroughput="" lastDayThroughput="" lastBackupTime="" isOnline="" bytesBackedupInLast24H="" bytesBackedupInLast1H="" backupReservations="0" auxiliaryCopyWriteReservations="0" associatedMediaAgents=""/>
<tapeLibSummary status="0" model="Scalar i2000" totalNumberOfWriteReservations="0" lastRestoreTime="Feb 13 2017 5:06PM" lastHourThroughput="0" lastDayThroughput="0" lastBackupTime="Jan 17 2017 4:35PM" isOnline="No" bytesBackedupInLast24H="" bytesBackedupInLast1H="" backupReservations="0" auxiliaryCopyWriteReservations="0" associatedMediaAgents=" mmtest1" vendor="QUANTUM" serialNumber="QUANTUM203100404_LL1" offlineReason="The SCSI device is not ready. Manual intervention is required. SCSI Error - ASC[0x04], ASCQ[0x03]" numOfSpareMedia="4" numOfSlots="0" numOfRegSlots="48" numOfRegSlotOccupied="4" numOfMediaExporting="0" numOfMedia="5" numOfIESlots="6" numOfIESlotOccupied="0" numOfDrivesOffline="0" numOfDrives="2" numOfCleaningMedia="0" numOfAppendableMedia="0" numOfAgedMedia="1" numOfActiveMedia="0" isEnabled="1" firmwareRevision="653Q" controller="" barcodeReader="Yes" attribute="10"/>
<DriveList status="Ready" mountStatus="" jobIds="" driveType="ULTRIUM-V2" drivePoolName="" drivePoolId="0" driveName="IBM ULTRIUM-TD2_1" driveId="539" barcode="948ADY" activeMediaAgent="" access="Drive Fully Accessible">
<driveSummary status="0" model="" lastHourThroughput="" lastDayThroughput="" isOnline="" vendor="" serialNumber="" offlineReason="" isEnabled="0" firmwareRevision="" controller="" attribute="0" driveName="" readWriteErrosSinceLastClean="0" numberOfRunningJobs="0" mountUnmountErrosSinceLastClean="0" library="" lastUseTime="" hoursUsedSinceLastClean="0" bytesBackedupInLast24Hour="" bytesBackedupInLast1Hour=""/>
</DriveList>
<DriveList status="Ready" mountStatus="" jobIds="" driveType="ULTRIUM-V2" drivePoolName="" drivePoolId="0" driveName="IBM ULTRIUM-TD2_2" driveId="540" barcode="" activeMediaAgent="" access="Drive Fully Accessible">
<driveSummary status="0" model="" lastHourThroughput="" lastDayThroughput="" isOnline="" vendor="" serialNumber="" offlineReason="" isEnabled="0" firmwareRevision="" controller="" attribute="0" driveName="" readWriteErrosSinceLastClean="0" numberOfRunningJobs="0" mountUnmountErrosSinceLastClean="0" library="" lastUseTime="" hoursUsedSinceLastClean="0" bytesBackedupInLast24Hour="" bytesBackedupInLast1Hour=""/>
</DriveList>
<library libraryName="QUANTUM Scalar i2000 234" libraryId="234" _type_="9"/>
</libraryInfo>
</EVGui_GetLibraryInfoWCResp>Disk Library
<?xml version="1.0" encoding="UTF-8"?>
<EVGui_GetLibraryInfoWCResp>
<libraryInfo status="" model="Disk" manufacturer="Disk" libraryVendorId="0" libraryType="3" description="">
<magLibSummary totalNumberOfWriteReservations="0" totalFreeSpace=" 8.70 GB" totalCapacity=" 227.94 GB" totalAvailableSpace=" 6.70 GB" onlineMountPaths="1 out of 1" numOfMountPath="1" mountPathUsage="Fill and Spill" lastRestoreTime="Mar 22 2017 5:17PM" lastHourThroughput="0" lastDayThroughput="0" lastBackupTime="Mar 20 2017 12:09PM" isOnline="Ready" bytesBackedupInLast24H="" bytesBackedupInLast1H="" backupReservations="0" auxiliaryCopyWriteReservations="0" associatedMediaAgents=" mmtest1"/>
<tapeLibSummary status="0" model="" totalNumberOfWriteReservations="0" lastRestoreTime="" lastHourThroughput="" lastDayThroughput="" lastBackupTime="" isOnline="" bytesBackedupInLast24H="" bytesBackedupInLast1H="" backupReservations="0" auxiliaryCopyWriteReservations="0" associatedMediaAgents="" vendor="" serialNumber="" offlineReason="" numOfSpareMedia="0" numOfSlots="0" numOfRegSlots="0" numOfRegSlotOccupied="0" numOfMediaExporting="0" numOfMedia="0" numOfIESlots="0" numOfIESlotOccupied="0" numOfDrivesOffline="0" numOfDrives="0" numOfCleaningMedia="0" numOfAppendableMedia="0" numOfAgedMedia="0" numOfActiveMedia="0" isEnabled="0" firmwareRevision="" controller="" barcodeReader="" attribute="0"/>
<MountPathList status="Ready" mountPathName="[mmtest1] D:\MeGaLib\Adisk" mountPathId="66" mediaAgents="" jobIds="" dataServerType="0">
<deviceInfo name="Device_63" id="63"/>
<mountPathSummary totalFreeSpace="0" attribute="0" warningWaterMark="0" totalValidData="0" totalSpace="0" totalReserveSpaceMB="0" totalDeduplicationDataWritten="0" totalDeduplicationAppSize="0" totalDataWritten="0" totalAppSize="0" numberOfWriters="0" lowWaterMark="0" libraryName="ADisk" libraryId="108" lastNumDays="0" estimatedSpaceRunoutDays="0" avgMediaFreedPerDay="0" avgMediaConsumedPerDay="0" avgDataWrittenPerDayMB="0" avgCapacityFreedMB="0"/>
</MountPathList>
<library libraryName="ADisk" libraryId="108" _type_="9"/>
</libraryInfo>
</EVGui_GetLibraryInfoWCResp>Cloud Library
<?xml version="1.0" encoding="UTF-8"?>
<EVGui_GetLibraryInfoWCResp>
<libraryInfo status="" model="Cloud" manufacturer="Cloud" libraryVendorId="0" libraryType="3" description="">
<magLibSummary totalNumberOfWriteReservations="0" totalFreeSpace="N/A" totalCapacity="N/A" totalAvailableSpace=" 0.00 Bytes" onlineMountPaths="1 out of 1" numOfMountPath="1" mountPathUsage="Fill and Spill" lastRestoreTime="N/A" lastHourThroughput="0" lastDayThroughput="0" lastBackupTime="Mar 17 2017 10:23AM" isOnline="Ready" bytesBackedupInLast24H="" bytesBackedupInLast1H="" backupReservations="0" auxiliaryCopyWriteReservations="0" associatedMediaAgents=" matador12_2,bluejay_2,mmtest1,Orion1"/>
<tapeLibSummary status="0" model="" totalNumberOfWriteReservations="0" lastRestoreTime="" lastHourThroughput="" lastDayThroughput="" lastBackupTime="" isOnline="" bytesBackedupInLast24H="" bytesBackedupInLast1H="" backupReservations="0" auxiliaryCopyWriteReservations="0" associatedMediaAgents="" vendor="" serialNumber="" offlineReason="" numOfSpareMedia="0" numOfSlots="0" numOfRegSlots="0" numOfRegSlotOccupied="0" numOfMediaExporting="0" numOfMedia="0" numOfIESlots="0" numOfIESlotOccupied="0" numOfDrivesOffline="0" numOfDrives="0" numOfCleaningMedia="0" numOfAppendableMedia="0" numOfAgedMedia="0" numOfActiveMedia="0" isEnabled="0" firmwareRevision="" controller="" barcodeReader="" attribute="0"/>
<MountPathList status="Ready" mountPathName="[matador12_2] Manoj" mountPathId="169" mediaAgents="" jobIds="" dataServerType="0">
<deviceInfo name="Device_171" id="171"/>
<mountPathSummary totalFreeSpace="0" attribute="0" warningWaterMark="0" totalValidData="0" totalSpace="0" totalReserveSpaceMB="0" totalDeduplicationDataWritten="0" totalDeduplicationAppSize="0" totalDataWritten="0" totalAppSize="0" numberOfWriters="0" lowWaterMark="0" libraryName="Core_Cloud_Amazon" libraryId="269" lastNumDays="0" estimatedSpaceRunoutDays="0" avgMediaFreedPerDay="0" avgMediaConsumedPerDay="0" avgDataWrittenPerDayMB="0" avgCapacityFreedMB="0"/>
</MountPathList>
<library libraryName="Core_Cloud_Amazon" libraryId="269" _type_="9"/>
</libraryInfo>
</EVGui_GetLibraryInfoWCResp>