This operation detects tape libraries.
Request
Syntax
POST <webservice>/Library?Action=detect HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml
<detect_tape_library_template.xml>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 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. |
Content-type | The media type contained in the request body. |
XML
Download the detect_tape_library_template.xml file required for this request. The following table displays the parameters for the detect_tape_library_template.xml file.
Name | Description | Element |
autoDetect | Automatic detection type. Valid value is 1. | CVGui_EZGetTapeLibrariesReq |
hdr tag | Header tag. Valid value is 0. | CVGui_EZGetTapeLibrariesReq |
mediaAgentIdList val | The system-generated ID assigned to the MediaAgent used for detecting the library. This can be gathered from the information provided by the GET MediaAgent API. | CVGui_EZGetTapeLibrariesReq |
Response
Response Parameters
Parameter | Description | Element |
objectAddress | The system-generated object address assigned to the library. | libraries |
libraryName | The system-generated name of the library. | libraries |
isSupportsDriveSerialization | Does the library support drive serialization. Valid values are:
| libraries |
isStandAlone | Is the library a standalone drive. Valid values are:
| libraries |
isDetected | Whether the library is detected in the operating system. Valid values are:
| libraries |
isCurrentlyConfigured | Whether the library is currently configured. Valid values are:
| libraries |
description | The description for the library. | libraries |
objectAddress | The system-generated object address assigned to the drive. | drives |
description | The description for the drive. | drives |
driveName | The name of the drive. | drives |
driveId | The system generated ID for the drive | drives |
Examples
Sample Request
POST <webservice>/Library?Action=detect HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<CVGui_EZGetTapeLibrariesReq autoDetect="1">
<hdr tag="0"/>
<mediaAgentIdList val=""/>
</CVGui_EZGetTapeLibrariesReq>Sample Response
<CVGui_EZGetTapeLibrariesResp>
<libraries objectAddress="188815011760" libraryName="Tape Lib 197" libraryId="197" isSupportsDriveSerialization="1" isStandAlone="0" isDetected="1" isCurrentlyConfigured="1" iconId="1" description="Tape Lib 197(Configured)" backupRetentionDays="0" archGroupName="" archGroupId="0">
<drives objectAddress="188779257280" iconId="6" description="(1) DriveX1_1(virtual:0,0,0)(Configured, Detected)(SFOMediaAgent)" driveName="DriveX1_1" driveId="352"/>
<drives objectAddress="188779256768" iconId="6" description="(2) DriveX1_2(virtual:0,0,0)(Configured, Detected)(SFOMediaAgent)" driveName="DriveX1_2" driveId="353"/>
<drives objectAddress="188779262400" iconId="6" description="(3) DriveX1_3(virtual:0,0,0)(Configured, Detected)(SFOMediaAgent)" driveName="DriveX1_3" driveId="354"/>
<drives objectAddress="188779259328" iconId="6" description="(4) DriveX1_4(virtual:0,0,0)(Configured, Detected)(SFOMediaAgent)" driveName="DriveX1_4" driveId="355"/>
</libraries>
<libraries objectAddress="188815009680" libraryName="VirtualLib 201" libraryId="201" isSupportsDriveSerialization="1" isStandAlone="0" isDetected="1" isCurrentlyConfigured="1" iconId="1" description="CommVault SFO_VirtualLib 201(Configured)" backupRetentionDays="15" archGroupName="SFO_Virtual_library" archGroupId="312">
<drives objectAddress="188779255232" iconId="6" description="(1) Drive_1(virtual:0,0,0)(Configured, Detected)(SFOMediaAgent)" driveName="Drive_1" driveId="360"/>
<drives objectAddress="188779267520" iconId="6" description="(2) Drive_2(virtual:0,0,0)(Configured, Detected)(SFOMediaAgent)" driveName="Drive_2" driveId="361"/>
<drives objectAddress="188779264960" iconId="6" description="(3) Drive_3(virtual:0,0,0)(Configured, Detected)(SFOMediaAgent)" driveName="Drive_3" driveId="362"/>
<drives objectAddress="188779268544" iconId="6" description="(4) Drive_4(virtual:0,0,0)(Configured, Detected)(SFOMediaAgent)" driveName="Drive_4" driveId="363"/>
</libraries>
</CVGui_EZGetTapeLibrariesResp>