Loading...

REST API - POST Configure Tape Library

This operation configures tape libraries.

Request

Syntax

POST <webservice>/Library?Action=configureTape HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml

<configure_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 configure_tape_library_template.xml file required for this request. The following table displays the parameters for the configure_tape_library_template.xml file.

The information required for this xml should be gathered from the Response Parameters provided by the POST Detect Tape Library API.

Add the following line to configure the library:

Name

Description

Element

Parent Element

driveId

0

drivesList

CVGui_EZConfigureTapeLibraryDrivesReq

iconId

The system-generated  icon ID for the library

drivesList

CVGui_EZConfigureTapeLibraryDrivesReq

objectAddress

The system-generated object address assigned to the library.

drivesList

CVGui_EZConfigureTapeLibraryDrivesReq

Repeat the following lines for each drive in the library:

Name

Description

Element

Parent Element

 

Header tag. Valid value is 0.

hdr

EZConfigureTapeLibraryDrivesReq

description

The system generated description for the drive.

 

 

driveId

The system generated object address assigned to the drive.

drivesList

CVGui_EZConfigureTapeLibraryDrivesReq

driveName

The  system generated name of the drive.

drivesList

CVGui_EZConfigureTapeLibraryDrivesReq

iconId

The system-generated  icon ID for the drive.

drivesList

CVGui_EZConfigureTapeLibraryDrivesReq

objectAddress

The system-generated object address assigned to the drive.

drivesList

CVGui_EZConfigureTapeLibraryDrivesReq

Response

Response Parameters

Parameter

Description

Element

errorCode

  • 0, successful completion.
  • 1, failure.

CVGui_GenericResp

errorMessage

The description of the error code. Not all error codes have an error message.

CVGui_GenericResp

Examples

Sample Request

A library with 2 drives:

POST <webservice>/Library?Action=configureTape HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<CVGui_EZConfigureTapeLibraryDrivesReq><hdr tag="0"/>
    <driveList description="" driveId="0" driveName="" iconId="6" objectAddress="188815710176"/>
    <drivesList description="(1) Quantum Drive (virtual:0,0,0)(Not configured, Detected)(MediaAgent01)" driveId="-1" driveName=" Quantum Drive" iconId="8" objectAddress="188815700448"/>
    <drivesList description="(2) Quantum Drive (virtual:0,0,0)(Not configured, Detected)(MediaAgent01)" driveId="-1" driveName=" Quantum Drive" iconId="8" objectAddress="188815706592"/>
</CVGui_EZConfigureTapeLibraryDrivesReq>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?><CVGui_GenericResp errorCode="0" errorMessage="User can use Expert Storage Configuration."/>

Last modified: 1/10/2018 7:56:03 PM