Hp StoreEver ESL G3 Tape Libraries User Manual

HP StoreEver Enterprise Systems Library (ESL)G3 Tape Library Web ServicesUser GuideAbstractThis guide provides information about the HP ESL G3 Web Ser

<role>0</role> <activeCount>2</activeCount> <ldap>false</ldap></ns2:user>For requests that perform creation

<status>N/A</status><value>0</value><unit>W</unit><location>Library PS #2 [Frame:#1, PS:#2]</location>

<firmware> <component>Current</component> <version>665H.GS12501</version> </firmware> <firmware>

<description>OK</description> <summary>Operation Completed Successfully</summary> <action>Update Firmware</action

URI: aml/usersMethod GETXML Response Data<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:userList

XML Response Data<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:WSResultCode xmlns:ns2="http:

B Regulatory informationFor important safety, environmental, and regulatory information, see Safety and ComplianceInformation for Server, Storage, Pow

IndexAaml, 14aml/XML Response Data, 58aml/access/devices, 14XML Response Data, 58aml/access/group/{name}, 14XML Response Data, 60aml/access/group/{nam

XML Response Data, 94aml/system/operations/shutdown, 47XML Response Data, 94aml/system/rasXML Response Data, 94aml/system/ras/ticket/{id}, 48XML Respo

Table 1 HTTP status code description (continued)DescriptionHTTP status codeThe server is refusing to service the request because theentity of the requ

For example, using the curl utility, where –b specifies the file where the original cookie is stored,and –X specifies the type of HTTP command to issu

• Date and time: “URI: aml/system/dateTime” (page 87)• Network information: “URI: aml/system/network/interfaces” (page 45)• Partition information: “UR

3 ResourceThe following lists the available resources for the HP ESL G3 Web Service interface. The informationprovides the URI to a particular resourc

Response: application/xml and application/jsonParameters N/AResponse Code 200, 401, and 500Method POSTDescription Create a new Access Group with the n

Response: application/xml and application/jsonParameters N/AResponse Code 200, 401, 404, and 500XML Request Data<?xml version="1.0" encod

Media Type Request: application/xml and application/jsonResponse: application/xml and application/jsonParameters N/AResponse Code 200, 401, 404, and 5

<WWPN>1234ABCD:1234ABCD</WWPN></ns2:ping>XML Response See “URI: aml/access/hosts” (page 65) for the XML Response code.URI: aml/acc

Media Type Request: N/AResponse: application/xml and application/jsonParameters N/AResponse Code 200, 401, 403, 404, and 500XML Response See “URI: aml

© Copyright 2014 Hewlett-Packard Development Company, L.P.The information contained herein is subject to change without notice. The only warranties fo

Parameters N/AResponse Code 200, 400, 401, 403, 404, and 500XML Response See “URI: aml/drive/{serialNumber}” (page 66) for the XML Response code.URI:

On the ESL G3 the ‘requested’ setting can only be modified, the ‘actual’ canNOT be modified. Only port id 1 can be modified.Media Type Request: applic

To take a drive with serial number HU1041D06V offline you woulduse the following URI: aml/drive/HU1041D06V/mode, with theTEXT REQUEST DATA below.Media

Media Type Request: N/AResponse: application/xml and application/jsonParameters N/AResponse Code 200, 401, and 500Method POSTDescription Upload a driv

URI: aml/drives/portsMethod GETDescription Retrieve all drive port resource instances.Media Type Request: N/AResponse: application/xml and application

Parameters N/AResponse Code 200, 401, 404, and 500XML Response See “URI: aml/enum/{component}/element}” (page 74) for the XML Responsecode.URI: aml/me

Media Type Request: application/xml and application/jsonResponse: application/xml and application/jsonParameters N/AResponse Code 200, 401, 403, 404,

Description Modify the partition whose name is given by the URI path template “name”.The following URI aml/partition/LL2 and XML request data will mod

Response: application/xml and application/jsonParameters N/AResponse Code 200, 401, 403, 404, and 500Example: Text Request Data30XML Response See “URI

Response: application/xml and application/jsonParameters N/AResponse Code 200, 401, 404, and 500Method PUTDescription Update the control path settings

Contents1 Introduction...7HTTP methods...

</drive></ns2:driveList>XML Request Data (Example 2)<?xml version="1.0" encoding="UTF-8" standalone="yes&quo

</controlPath> </settings> </drive></ns2:driveList>XML Request Data (Example 5)<?xml version="1.0" enco

<primary>false</primary> <type>4</type> </controlPath> </settings> </drive></ns2:

URI: aml/partition/{name}/modeMethod GETDescription Retrieve the current mode (Online/Offline) of the partitionwhose name is provided by the URI path

Response: application/xml and application/jsonParameters N/AResponse Code 200, 401, 403, 404, and 500Example: Text Request DataNew Partition NameXML R

XML Response See “URI: aml/partition/{name}/policy/driveCleaning” (page 81) forthe XML Response code.URI: aml/partition/{name}/policy/driveLevelingMet

<vendor>HP</vendor> <type>LTO6</type> </firmwareFile> <firmwareFile> <name>LTO6_J2AW.frm</nam

available, use the following URI: “URI:aml/physicalLibrary/segments” (page 42).Example 1. To add a drive to a partition you would sendthe request show

<row>1</row> <type>3</type> </coordinate> </segment></ns2:segmentList>XML Request Data (Examp

xmlns:ns2="http://automatedMediaLibrary/"> <segment> <coordinate> <frame>1</frame> <rack>1<

URI: aml/physicalLibrary...41URI: aml/physicalLi

<section>2</section> <column>4</column> <row>1</row> <type>2</type> </coord

Parameters N/AResponse Code 200, 401, 403, and 500XML Request Data<?xml version="1.0" encoding="UTF-8" standalone="yes&quo

Range parameters:• start—0-n• length—1-n or -1 for all media.• frame—0- maximum number of frames• rack—1 or 2So to retrieve all elements in one call,a

URI: aml/system/CVTLStationMethod GETDescription Report the HP CommandView TL Management Station registered with thelibrary.Media Type Request: N/ARes

URI: aml/system/dateTime/timeZoneIDsMethod GETDescription Retrieve the available list of time zone IDs. When you are setting the timezone use the stri

URI: aml/system/network/interfacesMethod GETDescription Retrieve the all network interfaces resources, eth0, eth1...Media Type Request: N/AResponse: a

Parameters N/AResponse Code 200, 401, and 500XML Response See “URI: aml/system/network/configurations” (page 92) for the XMLResponse code.URI: aml/sys

<type>2</type></ns2:netConfiguration>XML Request Data (Example 3)<ns2:netConfiguration xmlns:ns2="http://automatedMediaLib

Media Type Request: N/AResponse: application/xml and application/jsonParameters N/AResponse Code 200, 401, 404, and 500XML Response See “URI: aml/syst

XML Response See “URI: aml/system/ras/ticket/{id}/reports” (page 96) for the XMLResponse code.URI: aml/system/ras/ticketsMethod GETDescription Retriev

URI: aml/drive/{serialNumber}...66URI: aml/drive/{serialN

Response Code 200, 401, 403, 404, and 500Method POSTDescription Restore a saved configuration.Media Type Request: multipart/form-dataResponse: applica

Media Type Request: N/AResponse: application/xml and application/jsonParameters N/AResponse Code 200, 401, and 500Method POSTDescription Upload firmwa

Description Update a user resource instance with the username represented by theparameter name.Media Type Request: application/xml and application/jso

XML Request Data<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:user xmlns:ns2="http://automat

XML Request Data<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:user xmlns:ns2="http://automat

4 Support and other resourcesContacting HPFor worldwide technical support information, see the HP support website:http://www.hp.com/supportBefore cont

Typographic conventionsTable 2 Document conventionsElementConventionCross-reference linksBlue text: Table 2 (page 56)email addressesBlue, bold, underl

5 Documentation feedbackHP is committed to providing documentation that meets your needs. To help us improve thedocumentation, send any errors, sugges

A XML responses for URIsURI: aml/Method GETXML Response Data<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<name>unknown</name> <type>0</type> <mode>1</mode> <WWPN>21FD0005:1EF52A81</

URI: aml/user...102URI: aml/users..

<accessGroupName>AG1</accessGroupName> <serialNumber>273190048_LL0</serialNumber> <type>2</type

Method POSTXML Response Data<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:accessGroup xmlns:ns2=

<WWPN>AAAABBBB:AAAABBBB</WWPN> </host> </hostList> <accessDeviceList> <accessDevice> <serial

<hostList> <host> <name>dummy</name> <type>2</type> <mode>0</mode> <WWPN&g

URI: aml/access/group/{name}/hostsMethod POSTXML Response Data<?xml version="1.0" encoding="UTF-8" standalone="yes"?&

<logicalSerialNumber>F001396025 </logicalSerialNumber> <type>1</type> <port> <id>1<

<host> <name>Test</name> <type>2</type> <mode>0</mode> <WWPN>12345678:ABCDABCD</WWPN&

<logicalSerialNumber>F001396019 </logicalSerialNumber> <address>50010ab2:400012aa</address> <coordinate> <fra

xmlns:ns2="http://automatedMediaLibrary/"> <physicalSerialNumber>GB120401FD </physicalSerialNumber> <logicalSerialNum

Resource code See “URI: aml/drive/{serialNumber}/operations/powerCycle”(page 20) for the Resource code description.URI: aml/drive/{serialNumber}/ports

1 IntroductionWeb Services provides a scriptable interface for users who want to programmatically monitor orconfigure their ESL G3 tape libraries. Web

Resource code See “URI: aml/drive/{serialNumber}/mode” (page 21) for the Resourcecode description.URI: aml/drive/{serialNumber}/logMethod GETXML Respo

<bladeAttachedType>2</bladeAttachedType> </settings> <barcode>B00002LTO5</barcode> <sledSerialNumber>CMM010

Method POSTXML Response Data<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:WSResultCode xmlns:ns2

<port> <id>2</id> <type>2</type> <address>500308c00139601b</address> <t

<entry key="3" value="LTO2"/> <entry key="4" value="LTO3"/> <entry key="5"

<entry key="4" value="LTO3"/> <entry key="5" value="LTO4"/> <entry key="55

<media> <barcode>100000L6</barcode> <mediaType>5</mediaType> <cartridgeType></cartridgeType> &

xmlns:ns2="http://automatedMediaLibrary/"> <code>200</code> <description>OK</description> <summary>Opera

<controlPath> <primary>true</primary> <type>2</type> <subType>2</subType> &l

<portCount>2</portCount> </drive> ...</ns2:driveList>Method PUTXML Response Data<?xml version="1.0" encod

2 Interface descriptionAs described in the introduction, HTTP is used as the application protocol for clients to makerequests to the Web Server (WS) a

Resource code See “URI: aml/partition/{name}/controlPath” (page 28) for theResource code description.aml/partition/{name}/driveSerialNumbersMethod GET

URI: aml/partition/{name}/policy/driveCleaningMethod PUTXML Response Data<?xml version="1.0" encoding="UTF-8" standalone="

</firmwareFile></ns2:driveCleaningPolicy>Method PUTXML Response Data — Example 1<?xml version="1.0" encoding="UTF-8&qu

</segment> <segment> <coordinate> <frame>3</frame> <rack>1</rack> <section>5</

<vendor>HP</vendor></ns2:ping>Resource code See “URI: aml/partition/{name}/segments” (page 36) for the Resourcecode description.UR

<mode>1</mode> <state>1</state> <mediaInStorageCount>108</mediaInStorageCount> <mediaInDriveCount>1<

... ...</ns2:elementList>Resource code See “URI: aml/physicalLibrary/elements” (page 41) for the Resourcecode description.URI: aml/physic

<segment> <coordinate> <frame>0</frame> <rack>1</rack> <section>1</section> &

<timezone>America/Denver</timezone> <itime>1345001642141</itime></ns2:dateTime>JSON Response Data{ "date":

<description>1 License</description> <expiration>Permanent</expiration> <installed>true</installed> <

<barcodeReporting>4</barcodeReporting> <vendorId>1</vendorId> </partition></ns2:partitionList>The respons

<installed>true</installed> </license> <license> <feature>Capacity On Demand</feature> <quantity>

</netInterface> </netInterfaceList> <netConfigurationList> <netConfiguration> <name>eth0</name>

<location>N/A</location> <duplexMode>Full</duplexMode> <autoNegotiate>false</autoNegotiate> <speed>1<

</netConfiguration></ns2:netConfigurationList>Resource code See “URI: aml/system/network/configurations” (page 45) for theResource code

<netGateway>10.20.168.1</netGateway> <ipAddress>10.20.171.17</ipAddress></ns2:netConfiguration>Resource code See “URI

<status>1</status> </RASGroupStatus> <RASGroupStatus> <group>6</group> <status>1</status>

<eventCode>0</eventCode> <groupStatus> <group>4</group> <status>4</status> </groupStatus> &

<postedDate>2013-05-29 13:17:36 +0000 </postedDate> <duplicates>7100</duplicates> <groupStatus>

Resource code See “URI: aml/system/ras/ticket/{id}/reports” (page 48) for theResource code description.URI: aml/system/ras/ticketsMethod GETXML Respon

<group>4</group> <status>2</status> </groupStatus> <RASTicketState> <state>2</state