Loading...

REST API - GET Library Type

This operation returns a list of libraries in a specific library type.

Request

Syntax

GET <webservice>/Library?libraryType={LIBRARYTYPE} 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

LIBRARYTYPE

TAPE, DISK or ALL.

Cloud libraries are included in DISK .

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

description

Description for the library.

libraryList

libraryType

Library type.

0 - Disk
1 - Tape
3 - Cloud
4 - Stand Alone Library

libraryList

libraryVendorId

Library vendor.

libraryList

manufacturer

Library manufacturer.

libraryList

model

Library model.

libraryList

status

Current status of the library.

libraryList

libraryId

System generated ID for the library.

libraryList

library Name

Name of the library.

libraryList

*All other parameters displayed in the output generate null or blank values. Use the REST API - GET Library to extract the information for the blank parameters.

Examples

Sample Request

GET <webservice>/Library HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<EVGui_GetLibraryListWCResp>
 <libraryList description="" libraryType="1" libraryVendorId="0" manufacturer="QUANTUM" model="CargillTR" status="Offline">

 <magLibSummary associatedMediaAgents="" auxiliaryCopyWriteReservations="0" backupReservations="0" bytesBackedupInLast1H="" bytesBackedupInLast24H="" isOnline="" lastBackupTime="" lastDayThroughput="" lastHourThroughput="" lastRestoreTime="" mountPathUsage="" numOfMountPath="0" onlineMountPaths="" totalAvailableSpace="" totalCapacity="" totalFreeSpace="" totalNumberOfWriteReservations="0"/>

 <tapeLibSummary associatedMediaAgents="" attribute="0" auxiliaryCopyWriteReservations="0" backupReservations="0" barcodeReader="" bytesBackedupInLast1H="" bytesBackedupInLast24H="" controller="" firmwareRevision="" isEnabled="0" isOnline="" lastBackupTime="" lastDayThroughput="" lastHourThroughput="" lastRestoreTime="" model="" numOfActiveMedia="0" numOfAgedMedia="0" numOfAppendableMedia="0" numOfCleaningMedia="0" numOfDrives="0" numOfDrivesOffline="0" numOfFullMedia="0" numOfIESlotOccupied="0" numOfIESlots="0" numOfMedia="0" numOfMediaExporting="0" numOfRegSlotOccupied="0" numOfRegSlots="0" numOfSlots="0" numOfSpareMedia="0" offlineReason="" serialNumber="" status="0" totalNumberOfWriteReservations="0" vendor=""/>

 <library _type_="9" libraryId="234" libraryName="QUANTUM Scalar i2000"/></libraryList>
</EVGui_GetLibraryListWCResp>

Last modified: 1/10/2018 7:54:10 PM