REST API - POST Enable / Disable Tape Library

Updated

This operation enables or disables a tape library.

Request

Syntax

POST <webservice>/TapeLibraryProperties HTTP/1.1

Host: <host name>

Accept: application/xml

Authtoken: <authentication token>

Content-type: application/xml

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

Name

Description

Element

Parent Element

status

Enable or disable the library.

Valid value are:

  • 0, to disable

  • 1, to enable

tapeProperties

EVGui_SetTapeLibraryPropertiesRequest

attribute

-1 to indicate no change in the attribute.

tapeProperties

EVGui_SetTapeLibraryPropertiesRequest

libraryId

The system generated ID assigned  the library. Use the  GET Library API to retrieve the ID.

libraryEntity

EVGui_SetTapeLibraryPropertiesRequest

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

POST <webservice>/TapeLibraryProperties HTTP/1.1

Host: client.mydomain.com

Accept: application/xml

Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f

8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f

40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7

68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323

3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Content-type: application/xml

<EVGui_SetTapeLibraryPropertiesRequest>

  <tapeProperties status="0" attribute="-1">

    <libraryEntity libraryId="334"/>

  </tapeProperties>

</EVGui_SetTapeLibraryPropertiesRequest>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?><EVGui_GenericResp errorCode="0" errorMessage=""/>