V11 SP8

REST API - POST Mark / Unmark Tape Library Offline For Maintenance


This operation marks or unmarks a tape library offline for maintenance.



POST <webservice>/TapeLibraryProperties HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/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.


Download the mark_offline_tape_library_template.xml file required for this request. The following table displays the parameters for the mark_offline_tape_library_template.xml file.

Name Description Element Parent Element
status -1 to indicate no change in the status. tapeProperties EVGui_SetTapeLibraryPropertiesRequest
attribute Mark or unmark library offline for maintenance.

Valid value are:

  • Any value above 512, to mark the library offline for maintenance
  • 0 to unmark the library offline for maintenance.
tapeProperties EVGui_SetTapeLibraryPropertiesRequest
libraryId The system generated ID assigned  the library. Use the  GET Library API to retrieve the ID. libraryEntity EVGui_SetTapeLibraryPropertiesRequest


Response Parameters

Parameter Description Element
  • 0, successful completion.
  • 1, failure.
  • CVGui_GenericResp
    errorMessage The description of the error code. Not all error codes have an error message. CVGui_GenericResp


    Sample Request

    POST <webservice>/TapeLibraryProperties HTTP/1.1
    Host: client.mydomain.com
    Accept: application/xml
    Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
    Content-type: application/xml

     <tapeProperties status="-1" attribute="522">
      <libraryEntity libraryId="184"/>

    Sample Response

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