Home

Spectra Tape Libraries XML Command Reference

Contents

1. Users assigned to the Operator group can move import and export media but cannot access the more sensitive library operations such as configuration diagnostics and security password The password associated with the username This parameter is optional or can be left blank if no password has been set Use the following XML command to log out of the library IP Address gf logout xml where IP Address specifies the IP address of the library Progress for Asynchronous Commands When using the BlueScale user interface certain commands bring the user to a progress page while the command completes asynchronously Once the command is complete the BlueScale page refreshes to show the results This type of behavior is not possible with an XML interface To view the progress of an asynchronous action initiated through the XML command interface send the base URL command again using the progress parameter The client that issued the original command must request the progress for the command at least one time in order to see the command response A Important Any time there is an asynchronous action active the XML command interface is locked out other than to report progress until the action completes regardless of whether the action was initiated from the front panel through the BlueScale web interface RLC or by an XML command Notes Commands that are not processed asynchronously return any data associate
2. message description The error message posted by the web server Any additional details included in the message USING THIS COMMAND REFERENCE The following chapters describe each of the available XML commands supported by the Tape Series libraries Each XML command has a unique base URL that includes the library IP address and the command In addition each base URL command may include parameters that configure specific actions to be performed April 2015 16 XML Command Reference Spectra Tape Libraries Chapter 1 Overview Using this Command Reference To simplify locating information this reference is organized alphabetically first by the base URL for the command and then by the command variant as determined by the first parameter that follows the base URL Both the base URL and each of the variants are referred to as commands Ifa base URL can be used without any parameters this command variant is described in the first section of the chapter for the base URL and is the identified by no parameters in the command reference heading For example the driveList xml base URL can be used without parameters as shown in no parameters or list on page 25 If the first parameter following the base URL is action the value of the action parameter is used to identify the command variant For example the driveList xml base URL can be used with an action parameter as shown in prepareTo ReplaceDriv
3. where the value for This parameter Indicates ID The component identifier ID assigned to the drive by the library The component identifier uses the form FRx DBAx linterfacelltechnologyl DRVx where FRx The number of the frame Only used when the drive is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the drive Not used with the T120 library interface The interface used by the drive Values f Fibre Channel s Serial Attached SCSI SAS blank SCSI technology The technology used by the drive Values LTO TS11x0 SDLT SAIT DRVx The number of the drive bay in the DBA as viewed from the back of the library For all libraries except the T120 the value of x can be 1 through 4 For the T120 library the value of x can be 1 through 6 for full height drives and 1b through 6a for half height drives Notes The ID values returned by the driveList xml command without any parameters are the component identifiers for the drives currently installed in the library see driveList xml on page 24 Only the T120 library supports SAS drives Only the T380 T950 and TFinity libraries support TS11x0 technology drives The SDLT and SAIT drives are only supported in libraries that contained these drives when purchased These drives are no longer available for purchase EXAMPLE In the example command response on page 29
4. ACCurrentInAmps This is no longer used It will always show a value of 0 primaryACVoltage The measured primary AC voltage input secondaryAC Voltage The measured secondary AC voltage input twelveVoltVoltage The measured 12 volt supply voltage fiveVoltVoltage The measured 5 volt supply voltage onBoardTemperatureInCelsius The temperature in Celsius measured at the circuit board in the PCM remoteTemperatureInCelsius This is no longer used It will always show a value of 0 powerSupplyInPCM Information for each power supply in the module position The power supply location in the PCM Values 1 2 3 4 5 6 7 8 faulted Whether the power supply is faulted Values yes no 62 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus This parameter Indicates controller Environmentinfo continued fanControlModule Controls the fan power and fan speed for the fans in each frame that provide airflow to keep the frame at a consistent operating temperature The FCM also controls the lights in the frame This is only applicable to T200 T280 T680 and T950 not including T950B libraries ID The component identifier for the module using the form FRx FCM where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames FCM Fan Control M
5. The partition name is case sensitive The partition name is set when the partition is created Use the partitionList xml command to retrieve a list of all the partitions currently configured in the library see partitionList xml on page 126 saveLibrary Where you want to save the configuration backup file that the library generates Configuration after the partition is deleted Values USB Saves the file to a USB device that is connected to the LCM emailRecipient The email address of an already configured mail recipient to whom the library will email the configuration backup file Notes Do not send the configuration backup file to autosupport spectralogic com Spectra Logic does not save emailed configuration files unless they are specifically requested for troubleshooting If you want to save the configuration backup file that the library generates after the partition is deleted to a USB device make sure that the USB device is connected to the LCM before running the command See Configure Mail Users in you library s User Guide for information about configuring mail users Command Response The command returns the following XML formatted data lt library gt lt status gt OK lt status gt lt message gt Started delete partition action Set progress in your query for status lt message gt lt library gt Progress Use the partition xml progress command to determine when the operation is co
6. emailAddress YourNamek company com April 2015 32 XML Command Reference Spectra Tape Libraries Chapter 4 driveList prepareTo ReplaceDrive Description Prepares the specified drive for replacement by taking it offline The drive sled LED flashes orange and DLM marks the drive as impaired After the command completes successfully the drive can be safely removed from the library and a replacement drive installed Syntax driveList xml action prepareToReplaceDrive driveName drive to replace where the value for This parameter Specifies driveName The component identifier of the drive you want to replace using the form FRx DBAx interface technology DRVx where FRx The number of the frame Only used when the drive is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the drive Not used with the T120 library interface The interface used by the drive Values f Fibre Channel s Serial Attached SCSI SAS blank SCSI technology The technology used by the drive Values LTO TS11x0 SDLT SAIT DRVx The number of the drive bay in the DBA as viewed from the back of the library For all libraries except the T120 the value of x can be 1 through 4 For the T120 library the value of x can be 1 through 6 for full height drives and 1b through 6a for half height drives Notes The
7. lt line gt QIPExporter QIPID A loop fabric auto hardAddress111 B loop fabric auto hardAddress lt line gt lt line gt QIPList QIP ID A loop fabric auto hardAddress B loop fabric auto hardAddress lt line gt lt line gt driveExporter Drive ID address lt line gt lt line gt drives Drive ID Drive ID A B AB Hard Addressing Fibre ID l 1 lt line gt lt line gt globalSpares lt Drive ID Drive ID gt optional lt line gt lt line gt numStorageSlots n lt line gt lt line gt numEESlots m lt line gt lt line gt eeType standard queued shared lt line gt lt line gt saveLibraryConfiguration USB emailRecipient optional lt line gt lt line gt enablePrescan optional lt line gt lt line gt enableFullscan optional lt line gt lt line gt enableQuickscan inlineDrives globalSpareDrives optional lt line gt lt line gt scanAfter time N write read optional lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt 124 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition Example Command and Response The following command creates a partition in a T950 library The partition uses Fibre Channel LTO 5 drives and a RIM to provide the robotic control path for the partition partition xml action new partition Partition l
8. robotUtilization The section of the XML data that contains a single usage data set DataPoint hourStartingAt The hour for which the usage data set was stored using a 24 hour clock Values 1 through 24 Note After 24 hours has elapsed the data sets are deleted from the stored data on a First In First Out FIFO basis percentUtilization The integer value for the percentage of the hour during which the robot was active Values 0 through 100 where 0 indicates that the robot was idle and 100 indicates that the robot was continuously performing moves during the hour Syntax Error Response None Example Command and Response The following command robotUtilization xml returns the following XML formatted data for the 24 hour period beginning at 4 PM 16 00 hours and ending at 3 PM 15 00 hours the following day lt robotUtilization gt lt robotUtilizationDataPoint gt lt hourStartingAt gt 15 lt hourStartingAt gt lt percentUtilization gt 30 lt percentUtilization gt lt robotUtilizationDataPoint gt lt robotUtilizationDataPoint gt lt hourStartingAt gt 16 lt hourStartingAt gt lt percentUtilization gt 45 lt percentUtilization gt lt robotUtilizationDataPoint gt lt robotUtilization 139 April 2015 XML Command Reference Spectra Tape Libraries CHAPTER 21 systemMessages systemMessages xml no parameters The systemMessages xml command retrieves all system messages currently
9. The numEESlots parameter is not supported for the T120 library eeType The E E Entry Exit port operation mode Values standard queued shared A Important If a T120 library has multiple partitions configured the value for the eeType parameter must be either queued or shared All partitions must use the same value for the eeType parameter Notes The eeType parameter is omitted when configuring a cleaning partition The eeType parameter is optional when configuring a storage partition If it is not present the default value of standard is used The queued and shared parameter values are only supported by the T120 library See Allocate Slots and Tape Drives in the Spectra T120 Library User Guide for a detailed explanation of how queued eject mode and shared mode operate 18 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies drives The name and addressing for the drives to be assigned to the partition The command can contain a comma separated list of parameters for multiple drives A Important Do not use the drive specified in the driveExporter parameter or any of the drives listed in the globalSpares parameter or the command will fail Values Drive ID The component identifier for the drive using the form FRx DBAx DRVa See DriveID on page 116 for a description of the parameters in the component identifi
10. lt name gt Partition 1 lt name gt lt storage gt lt magazine gt lt offset gt 1 lt offset gt lt barcode gt LU83567 lt barcode gt lt frameNumber gt 1 lt frameNumber gt lt tapeBayNumber gt 1 lt tapeBayNumber gt lt drawerNumber gt 1 lt drawerNumber gt lt magazine gt lt magazine gt lt offset gt 6 lt offset gt lt barcode gt LU57356 lt barcode gt lt frameNumber gt 1 lt frameNumber gt lt tapeBayNumber gt 1 lt tapeBayNumber gt lt drawerNumber gt 2 lt drawerNumber gt lt slot gt lt number gt 1 lt number gt lt barcode gt 000380L5 lt barcode gt lt slot gt lt slot gt lt number gt 3 lt number gt lt barcode gt 000862L4 lt barcode gt lt slot gt lt slot gt lt slot gt lt magazine gt lt magazine gt lt magazine gt lt storage gt lt entryExit gt lt magazine gt lt offset gt 60 lt offset gt lt barcode gt LU0591L4 lt barcode gt lt frameNumber gt 1 lt frameNumber gt lt tapeBayNumber gt 1 lt tapeBayNumber gt lt drawerNumber gt 3 lt drawerNumber gt lt magazine gt lt magazine gt lt offset gt 71 lt offset gt lt barcode gt LU6847L4 lt barcode gt lt frameNumber gt 1 lt frameNumber gt lt tapeBayNumber gt 1 lt tapeBayNumber gt lt drawerNumber gt 4 lt drawerNumber gt lt magazine gt lt entryExit gt lt partition gt lt physInventory gt 131 April 2015 XML Command Reference Spectra Tape Libraries Chapter 17
11. lt usage gt lt line gt HHMData xml lt line gt lt line gt Query string lt line gt lt line gt action resetCounterData lt line gt lt line gt type Horizontal Axis Vertical Axis Picker Axis Rotational Axis Magazine Axis Toggle Axis Side Axis General Status Drive to Drive Move Drive to Slot Move Slot to Slot Move Slot to Drive Move TAP In Move TAP Out Move lt line gt lt line gt subType Tripl1 Trip2 lt line gt lt line gt robot Robot 1 Robot 2 lt line gt lt usage gt lt syntaxError gt Example Command and Response The following command resets the Trip1 subType counter for the Horizontal Axis counter HHMData xml action resetCounterDatattype Horizontal Axis subType Tripl and returns the following lt HHMData gt lt resetCounterData gt lt status gt OK lt status gt lt message gt Successfully set Horizontal Axis Tripl counter to 0 lt message gt lt resetCounterData gt lt HHMData gt 45 April 2015 XML Command Reference Spectra Tape Libraries Chapter 6 HHMData setThreshold Data A Caution Description Changes the reminder threshold for those HHM counters that have a Trip 1 or Trip 2 subType counter associated with them When the Trip1 or Trip2 counter reaches the specified threshold the library adds a reminder to the HHM data returned by the HHMData xml command see typeName on page 41 and turns on the HHM icon in the st
12. value lt barcode gt lt frameNumber gt value lt frameNumber gt lt tapeBayNumber gt value lt tapeBayNumber gt lt drawerNumber gt value lt drawerNumber gt lt slot gt lt number gt value lt number gt lt barcode gt value lt barcode gt lt barcodeValid gt Yes lt barcodeValid gt lt slot gt lt magazine gt lt entryExit gt lt partition gt lt physInventory gt 128 April 2015 XML Command Reference Spectra Tape Libraries Chapter 17 physinventory where the value for This parameter Indicates name The name of the partition EXAMPLE In the example command response on page 130 the name of the partition is Partition 1 storage The section of the XML data that contains all chambers in the storage pool of the partition entryExit The section of the XML data that contains all chambers in the entry exit pool of the partition magazine The section of the XML data that contains a single magazine offset The logical address of the magazine in the library The logical addresses for magazines are sequential beginning with 1 Note Use the gaps in the values returned for the magazine offsets to identify the values that can be used for the TeraPackOffset parameter in the mediaExchange xml action importExport command to import magazines see importExport on page 80 EXAMPLE The example command response on page 13
13. April 2015 XML Command Reference Spectra Tape Libraries inventory xml CHAPTER 7 inventory The inventory xml command retrieves information about the inventory status of all the slots and drives assigned to a specified partition partition Lists all storage slots entry exit slots and drives in the specified partition For each slot and drive the list indicates whether or not it is full For each occupied slot or drive the list also indicates the barcode information of the cartridge and whether or not the cartridge is queued for eject Syntax inventory xml partition partition name where the value for This parameter Specifies partition The exact name of the partition for which you want a logical inventory list Notes The partition name is case sensitive Use the partitionList xml command to retrieve a list of all the partitions The partition name is set when the partition is created See partition xml on currently configured in the library see partitionList xml on page 126 page 101 for information about using the XML command interface to configure partitions in the library Refer to your library s User Guide for detailed information about configuring and using partitions in the library 49 Chapter 7 inventory Command Respon se The command immediately returns the following XML formatted data lt inventory gt lt partition gt lt name gt value lt name g
14. Description Update the engineering change level information in the webserver cache with the current hardware settings Syntax libraryStatus xml action refreshECInfo Command Response The command immediately returns the following XML formatted data lt libraryStatus gt lt message gt Started Refresh EC Info Action Set progress in your query for status lt message gt lt status gt OK lt status gt lt libraryStatus gt Progress Use the libraryStatus xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt libraryStatus xml lt line gt lt line gt Query string lt line gt lt line gt action refreshECInfo refreshEnvironment lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt 70 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus refresh Environment Description Update the environment information in the webserver cache with the current hardware settings Syntax libraryStatus xml action refreshEnvironment Command Response The command immediately returns the following XML formatted data lt libraryStatus gt lt message gt Started Refresh Env
15. In order to protect the library security you must log into the library before you can issue any additional commands just as you would when using the BlueScale software from the operator panel or the web interface RLC A Important The connection to the library is automatically closed after the idle time specified through the BlueScale user interface System Setup screen see Auto Logout Timeout in your library s User Guide or can be closed by issuing a logout command A Important Connections to the library through the XML command interface are included in the maximum of eight simultaneous remote sessions supported by the library Notes The library must complete its initialization process before it will accept a login command For full syntax information on the login command see login xml on page 72 For full syntax information on the logout command see logout xml on page 74 14 April 2015 XML Command Reference Spectra Tape Libraries Chapter 1 Overview Using the XML Command Interface Use the following XML command to log into the library IP Address gf login xml username username amp password password where IP Address specifies the IP address of the library and This parameter Specifies username A valid username assigned to the library Notes The specified user must have either superuser or administrative privileges in order to perform configuration operations
16. None Notes The Life subType counter cannot be reset Most of the counters have associated Trip1 or Trip2 subType counters that can be reset For the TFinity library many of the HHM counters contain two sets of Trip1 and Trip2 subType counters one set for Robot 1 and the other for Robot2 TeraPorter 1 and TeraPorter 2 respectively Each of the counters must be reset independently Specifying an invalid sub Type counter causes the command to fail EXAMPLE In the example command on page 45 the Trip1 subType counter for the Horizontal Axis counter is reset robot TFinity library only For which robot the Trip1 or Trip2 counter is being reset Values Robot 1 or Robot 2 Note The two robot counters correspond to TeraPorter 1 and TeraPorter 2 respectively Command Response The command immediately returns the following XML formatted data lt HHMData gt lt resetCounterData gt lt status gt OK FAILURE lt status gt lt message gt Successfully set Unable to set type subType to 0 lt message gt lt resetCounterData gt lt HHMData gt 44 April 2015 XML Command Reference Spectra Tape Libraries Chapter 6 HHMData Syntax Error Response Note The following syntax error response is for a TFinity library The response for other libraries does not include the robot parameter lt syntaxError gt lt message gt error message text lt message gt
17. Requirement Use a standard programming language such as Java Perl or Python to create the necessary program to transfer the BlueScale package to the library using the packageUpload xml command Using Python requires the MultipartPostHandler software library which can be downloaded free of charge from pipe scs fsu edu PostHandler MultipartPostHandler py Command Response The command returns the following XML formatted data lt packageUpload gt lt status gt OK lt status gt lt packageUpload gt 99 Chapter 14 packageUpload Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt packageupload xml lt line gt lt line gt POST data encoded in the following way lt line gt lt line gt user defined boundary lt line gt lt line gt Content Disposition form data name BlueScalePkg filename packageFile line gt line gt Content Type application octet stream lt line gt ine gt lt line gt line gt packageFile Data lt line gt ne gt lt line gt lt line gt user defined boundary lt line gt lt usage gt lt syntaxError gt NAAN A H 100 April 2015 XML Command Reference Spectra Tape Libraries partition xml autoCreate CHAPTER 15 partition The partition xml command is used to configure one or more data or cleaning partitions in the library See the Configur
18. The new key replaces previously entered keys of the same type EXAMPLE In the following example command response the Capacity License key includes the total licensed capacity rather than incremental capacity and Overwrites previously entered Capacity License keys The number of days remaining before the key expires if applicable Syntax Error Response None Example Command and Response The following command optionKeys xml action 1list retrieves a list of activation keys entered into the library lt optionkeys gt lt optionKey gt lt keyValue gt GKM9VWS4C4HDDSC lt keyValue gt lt description gt BlueScale Software Support License Package Update Enabled lt description gt lt action gt OVERWRITE lt action gt lt daysRemaining gt 310 lt daysRemaining gt lt optionKey gt lt optionKey gt lt keyValue gt H86JVXE5OGWLGPD lt keyValue gt lt description gt Capacity License 1000 Chambers lt description gt lt action gt OVERWRITE lt action gt lt optionKey gt lt optionkeys gt 88 April 2015 XML Command Reference Spectra Tape Libraries package xml no parameters or list CHAPTER 13 package The package xml command is used to update the library using a BlueScale package previously uploaded to the memory card in the LCM using the packageUpload xml command see packageUpload xml on page 99 and to check the results of the update operation You ca
19. This parameter is only valid when Media Lifecycle Management MLM is enabled for the library see Enabling MLM and Configuring Global Settings in your library s User Guide Values Time n Where n gt 0 add the cartridges in the partition to the automatic PostScan queue when n days have passed since the last scan write Add a cartridge to the automatic PostScan queue each time data is written to it read Add a cartridge to the automatic PostScan queue each time data is read from it Notes The scanAfter parameter is omitted when configuring a cleaning partition The scanAfter parameter is omitted if the command does not include either the enableFullscan or enableQuickscan parameter The command can contain a comma separated list of multiple triggers See Using PostScan in your library s User Guide for information about this parameter 121 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies QIPList The name and addressing for each F QIP that provides Fibre Channel connectivity for SCSI tape drives installed in the library The command can contain a comma separated list of parameters for multiple QIPs Values QIP ID The component identifier for the F QIP using the form FRx DBAx F QIPx See QIP ID on page 114 for a description of the parameters in the component identifier drive visibility The
20. and export the same changer interface over the drives to provide redundancy as long as your storage management software can support this These multiple paths cannot be used at the same time as long as your host software can support multiple exporting devices Values Drive ID The component identifier for the exporting drive using the form FRx DBAx DRVx where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the controller Not used with the T120 library DRVx The number of the drive bay in the DBA as viewed from the back of the library For all libraries except the T120 the value of x can be 1 through 4 For the T120 library the value of x can be 1 through 6 for full height drives and 1b through 6a for half height drives address The Fibre Channel address or SCSI ID for the drive Values Fibre Channel drives 0 through 125 for a fixed address or None to specify that the drive uses soft addressing Direct attached SCSI drives 0 through 15 for a wide SCSI bus Notes The ID values returned by the driveList xml command without any parameters are the component identifiers for the drives currently installed in the library see driveList xml on page 24 The driveExporter parameter is omitted when configuring a cleaning partition If the drive has two Fibre C
21. electronic documentation SOFTWARE are protected by copyright laws and international copyright treaties as well as other intellectual property laws and treaties If you do not agree to this end user license agreement EULA do not use the Spectra product instead promptly contact Spectra Logic for instructions on return of the Spectra product for a refund Any use of the Software including but not limited to use on the Spectra product will constitute your agreement to this EULA or ratification of any previous consent Grant of License The Software is licensed on a non exclusive basis not sold This EULA grants you the following rights to the Software You may use the Software only on the Spectra product Not Fault Tolerant The Software is not fault tolerant Spectra Logic has independently determined how to use the Software in the Spectra product and suppliers have relied upon Spectra Logic to conduct sufficient testing to determine that the Software is suitable for such use No Warranties for the SOFTWARE The Software is provided AS IS and with all faults The entire risk as to satisfactory quality performance accuracy and effort including lack of negligence is with you Also there is no warranty against interference with your enjoyment of the Software or against infringement If you have received any warranties regarding the SOFTWARE those warranties do not originate from and are not binding on Software s
22. lt exportedDrive gt lt QIP gt lt affectedQIPs gt lt cleaningPartition gt partition name lt cleaningPartition gt lt encryption gt lt type gt QIPBasedBlueScale DriveBasedBlueScale SpectraTKLM lt type gt lt encryptionkey gt moniker lt encryptionkKey gt lt decryptionKeys gt lt moniker gt moniker lt moniker gt lt decryptionKeys gt lt encryption gt lt moveOptionType gt default virtual lt moveOpt ionType gt lt partitionData gt lt partition gt where the value for This parameter Specifies partitionData The beginning of data for one partition 107 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies name The name of the partition The partition name is case sensitive type The type of partition Values LTO LTO Cleaning TS11x0 TS11x0 Cleaning Super DLT Super AIT Note The only partitionData which will show for cleaning partitions are name type slotsPerChamber and numStorageSlots emulation The emulation type if any that is applied to the partition Note Emulation will only appear if it is not the default SPECTRA PYTHON includeDriveAnd MediaGenerationIn RES Whether the response to the SCSI Read Element Status command will include drive and media generation data Values yes no exporters The name type and addressing for
23. lt usage gt lt line gt driveList xml lt ine gt lt line gt Query string lt line gt lt line gt action resetDrive lt line gt lt line gt driveName name lt usage gt lt syntaxError gt of drive to reset lt line gt lt line gt progress while running lt line gt Example Command The following command resets drive 1 in DBA1 of frame 1 driveList xml action resetDrive amp driveName FR1 DBA1 f LTO DRV1 36 April 2015 XML Com mand Reference Spectra Tape Libraries CHAPTER 5 encryption encryption xml login A Important The encryption xml command is used to log into the library s encryption feature Description Logs into the encryption feature using the specified encryption user password Refer to the Spectra Encryption User Guide for detailed information about configuring and using either Spectra TKLM or BlueScale Encryption key management You must first log into the library as a user with superuser privileges using the login xml command see login xml on page 72 before you can log into the BlueScale Encryption application Note Before you can use encryption with a storage partition encryption must be enabled for the partition using the BlueScale user interface You remain logged into the encryption feature until you terminate the current connection to the library or log in again Syntax encryption xml action login amp e
24. lt usage gt lt line gt partition xml lt line gt line gt Query string lt line gt Line gt action autoCreate lt line gt line gt partition partition name lt line gt Line gt saveLibraryConfiguration USB emailRecipient optional lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt lt lt lt lt Example Command and Response The following command partition xml action autocreate amp partition Partition 1 amp saveLibraryConfiguration JaneSuperuser YourCompany com creates a single storage partition named Partition 1 and emails the configuration backup file to the mail user JaneSuperuser YourCompany com 103 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition delete A Important Description Deletes the specified partition from the library When you delete a partition the drives and chambers previously assigned to that partition can be reassigned to an existing partition or used to create a new partition Preparation Before deleting an existing partition make sure you address the following Spectra Logic strongly recommends backing up the library configuration either to a USB device or as an attachment to an email sent to a previously configured mail recipient before you delete a partition To ensure that you do not inadvertently mix cartridges from one storage partition with those f
25. secondaryACVoltage gt lt twelveVoltVoltage gt value lt twelveVoltVoltage gt lt fiveVoltVoltage gt value lt fiveVoltVoltage gt 55 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus lt onBoardTemperatureInCelsius gt value lt onBoardTemperatureInCelsius gt lt remoteTemperaturelnCelsius gt value lt remoteTemperatureInCelsius gt lt powerSupplyInPCM gt lt position gt value lt position gt lt faulted gt yes no lt faulted gt lt powerSupplyInPCM gt lt powerControlModule gt lt fanControlModule gt lt ID gt value lt ID gt lt frameNumber gt value lt frameNumber gt lt temperaturelnCelsius gt value lt temperaturelnCelsius gt lt backPanelSwitch gt open closed lt backPanelSwitch gt lt fanPanelSwitch gt open closed lt fanPanelSwitch gt lt filterPanelSwitch gt open closed lt filterPanelSwitch gt lt frontTAPFramePanelSwitch gt open closed lt frontTAPFramePanelSwitch gt lt boardVoltage gt value lt boardVoltage gt lt fanInputVoltage gt value lt fanInputVoltage gt lt fanSpeedVoltage gt value lt fanSpeedVoltage gt lt fanSpeedSetting gt value lt fanSpeedSetting gt lt newFansCalibrated gt yes no lt newFansCalibrated gt lt newFilterCalibrated gt yes no lt newFilterCalibrated gt lt fanInFCM gt lt number gt 1 2 3 4 51 617 8 9 10 lt number gt lt on gt yes no lt on g
26. the ID for the first drive is FR1 DBA1 fLTO DRV1 indicating that it is a Fibre Channel LTO drive installed in drive bay 1 of DBA1 in Frame 1 See Drive Identifiers in your library s User Guide for additional information about drive component identifiers driveStatus The status of the drive as reported by the library The status can be OK impaired missing or unknown partition The name of the partition to which the drive is currently assigned Note This parameter is not included if the drive is not assigned to a partition EXAMPLE In the example command response on page 29 the first drive is assigned to a partition named LTO Partition driveType The drive technology generation and connection type for the drive Values IBM Ultrium TDn where n is the generation LTO drives IBM 3592E07 Fibre TS11x0 technology drives T380 T950 and TFinity libraries EXAMPLE In the command response on page 29 the value for the driveType parameter of the first drive listed is IBM Ultrium TD3 Fibre 26 April 2015 XML Command Reference Spectra Tape Libraries Chapter 4 driveList This parameter Indicates connection T120 only The connection type Values hostID The hostID of the host to which the direct attached drive is connected portID The portID of the F QIP port through which the drive is connected to the host connectionStatus The status of t
27. 1 through 6 for full height drives and 1b through 6a for half height drives Notes The ID values returned by the driveList xml command without any parameters are the component identifiers for the drives currently installed in the library see no parameters or list on page 25 See Drive Identifiers in your library s User Guide for additional information about drive component identifiers Only the T120 library supports SAS drives Only the T380 T950 and TFinity libraries support TS11x0 technology drives The SDLT and SAIT drives are only supported in libraries that contained these drives when purchased These drives are no longer available for purchase Command Response The command returns the following XML formatted data lt resetDrive gt lt status gt OK lt status gt lt resetDrive gt Progress Use the driveList xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 The drive is then ready to resume operation If desired use the systemMessages xml command see systemMessages xml on page 140 to retrieve any system messages generated as a result of the reset 35 April 2015 XML Command Reference Spectra Tape Libraries Chapter 4 driveList Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt
28. 12 000 lt twelveVoltVoltage gt lt fiveVoltVoltage gt 5 011 lt fiveVoltVoltage gt lt fanCurrentInAmps gt 0 142 lt fanCurrentInAmps gt lt temperaturelnCelsius gt 27 lt temperaturelnCelsius gt lt driveControlModule gt lt powerSupplyFRU gt lt ID gt FR1 PCM PowerSupplyl lt ID gt lt inputPowerOkay gt yes lt inputPowerOkay gt lt output PowerOkay gt yes lt output PowerOkay gt lt temperatureWarning gt no lt temperatureWarning gt lt temperatureAlarm gt no lt temperatureAlarm gt lt modelNumber gt SP525 Y01A lt modelNumber gt lt manufacturerPartNumber gt SP525 Y01A lt manufacturerPartNumber gt lt serialNumber gt TE30546 lt serialNumber gt lt modLevel gt A lt modLevel gt lt manufacturer gt CHEROKEE INTL lt manufacturer gt lt countryOfManufacturer gt USA lt countryOfManufacturer gt lt temperaturelnCelsius gt 29 lt temperaturelnCelsius gt lt communicatingWithPCM gt yes lt communicatingWithPCM gt T lt fanInPowerSupplyFRU gt lt number gt 1 lt number gt lt okay gt yes lt okay gt lt fanInPowerSupplyFRU gt lt powerSupplyInPowerSupplyFRU gt lt nominalVoltage gt 12 000 lt nominalVoltage gt lt actualVoltage gt 12 069 lt actualVoltage gt lt actualCurrentInAmps gt 4 976 lt actualCurrent InAmps gt lt powerSupplyInPowerSupplyFRU gt lt powerSupplyFRU gt 67 April 2015 XML Command Reference Spectra Tape Libraries Cha
29. 2 Pause PostScan if it is running see Pause the PostScan Process in your library s User Guide Any tapes currently being scanned are returned to their storage locations Syntax powerOff xml numSecondsToRemainOf f seconds where the value for This parameter Specifies numSecondsTo RemainOff The number of seconds to wait after the powerOff xml command completes before powering the library back on again Values 0 zero The library remains off until powered on again from the operator panel n gt 0 The library will power on again after the specified number of seconds A Important There is no upper limit to the value for numSecondsToRemainOff For example if you enter 10000 the library will remain off for approximately 2 8 hours The only way to override the wait once started is to remove all power from the library set all breakers to the off down position wait 20 seconds return power set all breakers to the on up position and press the front power button Command Response The command immediately returns the following XML formatted data lt powerOff gt lt status gt OK lt status gt lt powerOff gt 133 Chapter 18 powerOff Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt powerOff xml lt line gt lt line gt Query string lt line gt lt line gt numSecondsToRemainOff numb
30. 2015 XML Command Reference Spectra Tape Libraries Chapter 7 inventory where the value for This parameter Indicates name The name of the partition EXAMPLE In the command response on page 53 the partition name is Partition 1 storageSlot That the following block of information is for a slot in the partition storage pool EXAMPLE In the command response on page 53 the first block of information following the storageSlot parameter contains the data for the cartridge slots assigned to the Partition 1 storage pool entryExitSlot That the following block of information is for a slot in the partition entry exit pool Notes For the T120 library the number of entry exit slots reported depends on the Eject Mode configured for the library Refer to the Spectra 1120 Library User Guide for information about eject modes For all other libraries This parameter is not returned if the partition does not have one or more chambers assigned to the entry exit pool Nor is returned if the entry exit pool does not contain one or more magazines EXAMPLE In the command response on page 53 the block of information following the entryExitSlot section contains the data for the cartridge slots assigned to the Partition 1 entry exit pool drive That the following block of information is for a drive assigned to the partition EXAMPLE In the command response on page 53 the last block of information
31. 94 magazines importing during PreScan or PostScan 94 mailing address Spectra Logic 4 main frame TAP status 77 to 80 use for import export Operation 82 media import or export command example 83 determined by TeraPackOffsets full empty status 80 operational sequence 84 to 86 requirements 80 select partition 81 select pool 82 select storage locations 82 select TAP 82 mediaExchange xml base URL overview 75 clean 75 to 77 example command sequence 84 to 86 getTAPState 77 to 80 importExport 80 to 84 O optionKeys xml add 87 base URL overview 87 list 87 P package xml no parameters or list 89 to 90 base URL overview 89 example command sequence 97 to 98 getResults 91 to 93 update 93 to 96 packageUpload xml 99 to 100 base URL overview 99 no parameters partition xml autoCreate 101 to 103 base URL overview 101 delete 104 to 106 list 106 to 111 new 112to 125 partitionList xml no parameters 126 base URL overview 126 partitions cartridge inventory 49 to 53 127 to 131 partitions configuring assign type 108 114 automatic 101 to 103 deleting 104 to 106 naming supported characters 114 precautions before deleting 104 prepare to delete a partition 104 restrictions for automatic creation 101 to 102 phone numbers Spectra Logic offices 4 physInventory xml bas URL overview 127 example command sequence 132 partition 127 to 131 PostScan export or exchange
32. ID values returned by the driveList xml command without any parameters are the component identifiers for the drives currently installed in the library see no parameters or list on page 25 See Drive Identifiers in your library s User Guide for additional information about drive component identifiers Only the T120 library supports SAS drives Only the T380 T950 and TFinity libraries support TS11x0 technology drives The SDLT and SAIT drives are no longer available for purchase 33 April 2015 XML Command Reference Spectra Tape Libraries Chapter 4 driveList Command Response The command returns the following XML formatted data lt prepareToReplaceDrive gt lt status gt OK lt status gt lt prepareToReplaceDrive gt Progress Use the driveList xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt driveList xml lt line gt lt line gt Query string lt line gt lt line gt action prepareToReplaceDrive lt line gt lt line gt driveName name of drive to prepare lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt Example Command The following co
33. The library is not able to determine the firmware version powered off The drive is powered off and cannot return its firmware information EXAMPLE In the example command response on page 29 the drive firmware version is 93G0 dcmFirmware The firmware version being used by the drive sled that houses the drive EXAMPLE In the example command response on page 29 the DCM firmware version is 4 7 0 27 April 2015 XML Command Reference Spectra Tape Libraries Chapter 4 driveList This parameter Indicates wwn The World Wide Name WWN for the drive See Drive Connectivity in your library s User Guide for detailed information about the WWNs for drives Notes This data is only returned for Fibre Channel or Serial Attached SCSI SAS drives SAS drives are only supported in the T120 library The WWN is actually the WWPN for port A on the drive sled The WWPN for port B is the same as the one for port A except that the second digit from the left is 2 instead of 1 EXAMPLE In the example command response on page 29 the WWN for the first drive is 21 11 00 90 A5 00 OE C2 sparedWith The library assigned component identifier of the Global Spare drive used to replace the drive See Drive Identifiers and Using a Global Spare Drive in your library s User Guide for more information Note This parameter is only returned if the drive has been replaced by
34. Values none full quickWithGlobalSpareDrives quickWithInlineDrives scanAfterDays whether or not a cartridge is added to the PostScan queue based on the number of days since the last scan Values yes no scanAfterRead whether or not a cartridge is added to the PostScan queue each time data is read from it Values yes no scanAfterWrite whether or not a cartridge is added to the PostScan queue each time data is written to it Values yes no daysToScanAfter the number of days to use for determining when to add a cartridge to the PostScan queue if scanAfterDays yes allowUsers Whether all users or a specific list of users are allowed to access the partition Values all listOnly userList Names of users allowed to access the partition if allowUsers listOnly 109 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies affectedQIPs The name and addressing for each F QIP that provides Fibre Channel connectivity for SCSI tape drives installed in the library ID is the component identifier for the QIP using the form FRx DBAx F QIPx See exporters on page 108 for a description of the parameters in the component identifier Port is the port of the QIP used to provide Fibre Channel connectivity Values A B AB cleaningPartition The name of the cleaning partition assigned to the storage partition This parameter will not display if no cleanin
35. WWN Fibre Channel or SAS 28 drives general information related documentation 11 email Spectra Logic offices 4 encryption xml base URL overview 37 login 37 entry exit port configure operating mode 109 118 H HHMData xml no parameters or list 40 to 43 base URL overview 39 resetCounterData 44 to 45 setThresholdData 46 to 48 inventory xml base URL overview 49 partition 49 to 53 Index L L library software BlueScale end user license 3 complete update automatically 95 current version 90 example update command sequence 97 to 98 finish update process 91 to 93 91 to 93 monitor update progress 95 get update results packages in library 90 prepare for update 94 select update package 95 update package upload to library 99 to 100 library troubleshooting generate an ASL file 18 to 19 retrieve an ASL file 20 146 to 147 148 to 149 retrieve CAN logs retrieve QIP logs retrieve system messages 140 to 142 149 to 151 library type determine using libraryStatus xml 21 54 library power off using powerOffxml 133 to 134 retrieve traces libraryStatus xml no parameters 21 54 base URL overview 21 54 refreshECInfo 70 refreshEnvironment 71 use to determine library type 21 54 login xml base URL overview 72 use to log into library 14 72 to 73 username 72 to 73 logout xml base URL overview 74 M magazines exporting or exchanging during PreScan or PostScan
36. XML Command Reference Spectra Tape Libraries Chapter 13 package Syntax package xml action update package package name tautoFinish where the value for This parameter Specifies package The version name of the BlueScale package to which you want to update the library The package name format is BlueScale n n n YYYYMMDDlrelease type where 1 n n the version number YYYYMMDD the date of the BlueScale package release type either an F for Full release or an I for Incremental release autoFinish Optional When included the library automatically completes the update instead of waiting to receive an update xml getResults command If the update package included updates to the LCM or RCM firmware the library will reboot the LCM and RCM when the update is complete The remote connection to the library is lost when the LCM reboots Allow sufficient time for the LCM to complete its initialization then reconnect to the library A Important If the package includes updates to the LCM or RCM firmware and you do not include the autoFinish parameter you must run the update xml getResults command to reboot the LCM and RCM to complete the update Update Process After the library receives and validates the command it begins applying the updates in the specified package file The update command returns a status indicating that the update has started Once the update process starts
37. a Global Spare drive spareFor The library assigned component identifier of the drive that the Global Spare drive is replacing See Drive Identifiers and Using a Global Spare in your library s User Guide for more information Note This parameter is only returned if the drive is a Global Spare being used to replace another drive sparePotential Whether the drive is configured for use as a Global Spare drive for a partition and is available for use See Assign Global Spare Drives in your library s User Guide for information about configuring a drive as a Global Spare for a partition Value defined The drive is configured as a Global Spare but is not currently in use as a spare Note This parameter is only returned if the drive is configured as a Global Spare but is not currently being used to replace another drive health The drive health The health can be one of the following Green Yellow Red or Unknown See Monitoring Drive Health Using DLM in your library s User Guide for detailed information about Drive Lifecycle Management DLM and drive health Note This parameter is only returned if the drive is assigned to a partition EXAMPLE In the example command response on page 29 the health for the first drive is Green firmwareStaging The status of the firmware staging process Note Firmware staging is only available for LTO 5 and later generation and TS1140 technology and
38. access the partition modify the partition after it is created using the BlueScale interface See your User Guide for details Requirements and Guidelines When preparing to use this command keep the following requirements and guidelines in mind Refer to the Configuring and Managing Partitions chapter in your library s User Guide for detailed requirements and guidelines for configuring both data and cleaning partitions Only one partition can be configured with each command The library requires at a minimum one storage partition to be configured before you can use the library Each storage partition must have a minimum of one storage location assigned to the storage pool and at least one drive assigned to it When configuring a storage partition all drives and controllers RIM or F QIP specified in the command must already be installed in the library and must be functioning properly If you specify a device that is not present or that is impaired the command will fail For libraries using a direct attached drive to provide the robotic control path for a storage partition the exporting drive counts as one drive You can only create a single storage partition if the library does not have a Shared Library Services SLS activation key stored in the library If you attempt to create additional storage partitions without an SLS activation the command fails and returns an error message indicating that the command receive
39. address of an already configured mail recipient to whom the library emails the drive trace file Notes Do not send the drive trace to autosupport spectralogic com Spectra Logic does not save emailed drive trace files unless they are specifically requested for troubleshooting See Configure Mail Users in you library s User Guide for information about configuring mail recipients April 2015 XML Command Reference Spectra Tape Libraries Chapter 4 driveList Command Response If you specify driveTracesGetType download the command immediately returns a ZIP file containing the drive trace Otherwise the command returns the following XML formatted data lt driveList gt lt status gt OK lt status gt lt message gt success message text lt message gt lt driveList gt Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt driveList xml lt line gt lt line gt Query string lt line gt lt line gt action getDriveTraces lt line gt lt line gt driveTracesGetType email download saveToUSB lt line gt lt line gt emailAddress Mail Recipient lt line gt lt usage gt lt syntaxError gt Example Command The following command emails the drive trace ZIP file to the already configured mail recipient YourName company com driveList xml action getDriveTracestdriveTracesGetType email
40. command always fails if it contains the main parameter value The leftBulk and rightBulk parameter values are not supported by libraries that do not include a bulk TAP In addition the command fails if the library does not have a bulk TAP installed on the side specified by the parameter value Command Response The command returns the following XML formatted data lt mediaExchange gt lt message gt message text lt message gt lt status gt OK lt status gt lt mediaExchange gt Progress Use the following command to determine when the clean operation is complete see Progress for Asynchronous Commands on page 15 mediaExchange xml progress amp TAPDevice main leftBulk rightBulk 76 April 2015 XML Command Reference Spectra Tape Libraries Chapter 11 mediaExchange where the value for This parameter Specifies TAPDevice The TAP for which import or export operation is being requested Values main The TAP in the main frame leftBulk The bulk TAP on the left end of the library rightBulk The bulk TAP on the right end of the library Notes The main parameter value is not currently supported The command always fails if it contains the main parameter value The leftBulk and rightBulk parameter values are not supported by libraries that do not include a bulk TAP In addition the command fails if the library do
41. empty and that the TAP door is locked Notes This command is only supported by libraries that have a bulk TAP If the bulk TAP contains one or more magazines the magazines are moved to the storage chambers assigned to the partition specified in the command If the magazines belong to multiple partitions you need to use importExport on page 80 to import the magazines into the correct partitions The clean command does not set the door release button LED to green nor does it open the bulk TAP door Both the button and the door only operate during an import or export operation 75 Chapter 11 mediaExchange Syntax mediaExchange xml action clean amp partition partition name amp TAPDevice main leftBulk rightBulk where the value for This parameter Specifies partition TAPDevice The exact name of the partition for which you want to clean the bulk TAP Use the partitionList xml command to retrieve a list of all the partitions currently configured in the library see partitionList xml on page 126 Notes The partition name is case sensitive The partition name is set when the partition is created The TAP for which cleaning is being requested Values main The TAP in the main frame leftBulk The bulk TAP on the left end of the library rightBulk The bulk TAP on the right end of the library Notes The main parameter value is not currently supported The
42. gt OK FAILURE lt status gt lt message gt Successfully set Unable to set event threshold to default valuel lt message gt lt setThresholdData gt lt HHMData gt Syntax Error Response Note The following syntax error response is for a TFinity library The syntax error response from other libraries will list different events lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt HHMData xml lt line gt lt line gt Query string lt line gt lt line gt action setThresholdData lt line gt lt line gt event Service HAX Check Contact Brushes Service VAX Service VAX Belt Service Transporter Service Required lt line gt lt line gt default true false must provid ither default tru or a value lt line gt lt line gt value value to set the threshold 1 thru 4294967295 lt line gt lt usage gt lt syntaxError gt April 2015 47 XML Command Reference Spectra Tape Libraries Chapter 6 HHMData Example Command and Response The following command HHMData xml action setThresholdData amp event Service HAX Belt default false amp value 46300000 returns the following lt HHMData gt lt setThresholdData gt lt status gt OK lt status gt lt message gt Successfully set Service HAX Belt to 46300000 lt message gt lt setThresholdData gt lt HHMData gt 48
43. gt 4 8 0 59 lt updatedVersion gt lt updateStatus gt OK lt updateStatus gt lt component gt lt component gt lt component gt lt rebootInProcess gt false lt rebootInProcess gt lt updateResults gt lt package gt Description Updates the library to the specified BlueScale package The specified BlueScale package must already be stored on the library memory card If the desired package is not already present you must first upload the necessary BlueScale package see packageUpload xml on page 99 If you receive an error message stating that your disk is full when the library attempts to unzip an update package see Manage Update Packages in your library s User Guide for information about deleting packages from the memory card 93 April 2015 XML Command Reference Spectra Tape Libraries Chapter 13 package Preparation Before you begin the package update process make sure that you review and address the following requirements Make sure your BlueScale Software Support key is current Updating the BlueScale software and the firmware for library components requires a current service contract with Spectra Logic Technical Support The update will fail if the library does not have a valid BlueScale Software Support key installed If your service contract has expired renew it as described in Renewing the BlueScale Software Support Key in your library s User Guide for instruction
44. later generation drives Values firmware The drive firmware being staged or committed complete The status of the staging process Values Yes Staging is complete No Staging is in process percentStaged The percentage of the firmware already staged committing The status of updating the drive using the staged firmware Values Yes Committing is in process No Committing has not started 28 April 2015 XML Command Reference Spectra Tape Libraries Chapter 4 driveList Syntax Error Response None Example Command and Response The following command driveList xml retrieves the following information for a T950 library that has two Fibre Channel LTO 3 drives installed both of which are in a partition named LTO Partition lt driveList gt lt drive gt lt ID gt FR1 DBA1 fLTO DRV1 lt 1D gt lt driveStatus gt OK lt driveStatus gt lt partition gt LTO Partition lt partition gt lt driveType gt IBM Ultrium TD3 Fibre lt driveType gt lt serialNumber gt 1011000EC2 lt serialNumber gt lt manufacturerSerialNumber gt 10380861 lt manufacturerSerialNumber gt lt driveFirmware gt 93G0 lt driveFirmware gt lt dcmFirmware gt 4 7 0 lt dcmFirmware gt lt wwn gt 21 11 00 90 A5 00 OE C2 lt wwn gt lt health gt Green lt health gt lt drive gt lt drive gt lt ID gt FR1 DBA1 fLTO DRV2 lt 1D gt lt driveStatus gt OK lt driveStatus gt lt partition gt LTO Partition lt partit
45. line gt Query string lt line gt lt line gt action lockTensionRods removeAllLibraryPartitions resetLCM resetRobot resetInventory selectiveSnowplow verifyMagazineBarcodes lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt Description Reinitializes the cartridge inventory stored by the library During the reset the library discards all previous inventory data and rescans all of the magazines and cartridges in the library to establish a new inventory Notes Do not run this command unless specifically instructed to do so by Spectra Logic Technical Support The reinitialization process also resets the RCM in libraries that use an RCM a This command is not useful for T120 libraries After a Reset Inventory it can take up to 45 minutes per frame to re inventory a T950 library or 20 minutes per frame to re inventory a TFinity library with both robots active Syntax utils xml action reset Inventory Command Response The command returns the following XML formatted data lt utils gt lt resetInventory gt lt status gt OK lt status gt lt message gt resetInventory started Set progress in your query for status lt message gt lt resetInventory gt lt utils gt Progress Use the utils xml progress command to determine when the reset operation is complete The operation is complete when the command response is No Pending Actions see Progress for
46. lt emulation gt lt includeDriveAndMediaGenerationInRES gt yes no lt includeDriveAndMediaGenerationInRES gt lt exporters gt lt exporter gt lt ID gt ID lt ID gt lt type gt drive QIP unknown lt type gt lt port gt A B AB lt port gt lt exporter gt lt exporters gt lt slotsPerChamber gt value lt slotsPerChamber gt lt numStorageSlots gt value lt numStorageSlots gt lt numEESlots gt value lt numEESlots gt lt eeType gt standard queued shared lt eeType gt 106 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition lt drives gt lt ID gt ID lt ID gt lt drives gt lt globalSpares gt lt ID gt ID lt ID gt lt globalSpares gt lt MLMMediaVerification gt lt preScan gt yes no lt preScan gt lt postScan gt none full quickWithGlobalSpareDrives quickWithInlineDrives lt postScan gt lt scanAfterDays gt yes no lt scanAfterDays gt lt scanAfterWrite gt yes no lt scanAfterWrite gt lt scanAfterRead gt yes no lt scanAfterRead gt lt daysToScanAfter gt value lt daysToScanAfter gt lt MLMMediaVerification gt lt allowUsers gt all listOnly lt allowUsers gt lt userList gt lt name gt user name lt name gt lt userList gt lt affectedQIPs gt lt QIP gt lt ID gt ID lt ID gt lt exportedDrive gt lt ID gt ID lt ID gt lt port gt A B AB lt port gt
47. lt typeName gt reminder name lt typeName gt lt severity gt low medium high lt severity gt lt defaultThreshold gt value lt defaultThreshold gt lt currentThreshold gt value lt currentThreshold gt lt postedDate gt date lt postedDate gt lt reminder gt lt subtype gt lt counter gt lt HHMData gt where the value for This parameter Indicates typeName HHM counter The name of the HHM counter for which data is being returned Values Horizontal Axis Vertical Axis Picker Axis Toggle Axis Rotational Axis Side Axis General Maintenance Drive to Drive Move Drive to Slot Move Slot to Slot Move Slot to Drive Move TAP In Move TAP Out Move Notes The XML data returned in the command response contains sections for each HHM counter and its associated subType counters and reminders The number of the HHM counters and their names depend on the library type EXAMPLE In the example command response on page 42 the name of the first counter returned is Horizontal Axis April 2015 40 XML Command Reference Spectra Tape Libraries Chapter 6 HHMData This parameter Indicates typename subType The name of the subType counter for which data is being returned All of the HHM counters have one or more associated subType counters Values Life Tracks the counter data over the lifetime of the library Trip
48. messages posted during the update process see systemMessages xml on page 140 and traces xml on page 145 for descriptions of the commands If the update did not require a reboot of the LCM use systemMessages xml If the update required a reboot of the LCM use traces xml traceType Messag 97 April 2015 XML Command Reference Spectra Tape Libraries Chapter 13 package Updating the Library BlueScale Software 7 Run the following command to confirm that the library is using the BlueScale package you uploaded package xml The package you uploaded should be listed in the current section of the XML data returned in the command response 98 April 2015 XML Command Reference Spectra Tape Libraries CHAPTER 14 packageUpload packageUpload xml A Important no parameters The packageUpload xml command is used within a script to upload a BlueScale package file to the library s memory card After the package file is uploaded it can be used to update the BlueScale software that the library is running see package xml on page 89 The packageUpload xml command uses an HTTP POST action to transfer the package file to the library This cannot be accomplished through a browser You must use a script to preform the upload The packageUpload xml command is used to upload the specified BlueScale package file to the library using the Ethernet connection to the LCM Syntax packageUpload xml
49. physInventory physInventory xml partition USING THE PHYSINVENTORY XML COMMAND The following steps illustrate using the physInventory xml command to retrieve the physical inventory of a partition named Partition 1 The data can then be used as parameter values for other XML commands for example in the mediaExchange xml command described beginning on page 75 1 Run the following command to retrieve a list of all occupied magazine and cartridge locations in the specified partition physInventory xml partition Partition 1 Depending on whether the magazine locations are in the partition s storage pool or entry exit pool locate the desired section of the physical inventory data The magazine locations in the storage pool are in the section of the data between lt storage gt and lt storage gt The magazine locations in the entry exit pool are in the section of the data between lt IE gt and lt IE gt EXAMPLE See the command response data page 130 for an example of the output from physInventory xml command Identify the offset values for each magazine location you want to use If you plan to import magazines identify gaps in the offset values in either the storage or IE sections of the physical inventory data Each missing value corresponds to an empty location into which a magazine can be imported Ifyou plan to export or exchange magazines identify the magazines by examining the barcode data in the maga
50. present Values yes no fanInFMM Information for each fan in the fan pair number The number for the fan Values 1 2 3 4 5 6 7 8 9 10 on Whether the fan is powered on Values yes no speedInRPM The measured speed of the fan controller serviceBayControlModule The service bay control module located in each Environmentinfo TFinity service frame controls the service frame interlocks and provides bulk continued TAP status This is only applicable for TFinity libraries ID The component identifier for the module using the form FRx SCM where FRx The number of the frame SCM Service Control Module framelDInfo Frame numbers start with 80 for the main frame and are numbered in hexadecimal counting down to the left with the next frame being 7f and counting up to the right with the next frame being 81 safetyDoorState The state of the service frame safety door The manually operated service bay safety door slides closed to isolate the TeraPorter in the service bay making it possible to continue library operations while you service the TeraPorter Values open closed overrideSwitch The state of the service frame override switch Values active inactive rearAccessPanel The state of the rear access panel interlock switch Values closed open sideAccessPanel The state of the side access panel interlock switch Values closed open sidePanel The state of the side panel inte
51. spare and all users allowed to access it lt partition gt lt partitionData gt lt name gt Partition 1 lt name gt lt type gt LTO lt type gt lt numStorageSlots gt 100 lt numStorageSlots gt lt numEESlots gt 8 lt numEESlots gt lt eeType gt standard lt eeType gt lt includeDriveAndMediaGenerationInRES gt no lt includeDriveAndMediaGenerationInRES gt lt exporters gt lt exporter gt lt type gt drive lt type gt lt ID gt sLTO DRV5A lt ID gt lt exporter gt lt exporters gt lt drives gt lt drives gt lt globalSpares gt lt globalSpares gt lt MLMMediaVerification gt lt preScan gt no lt preScan gt lt postScan gt quickWithInlineDrives lt postScan gt lt scanAfterDays gt no lt scanAfterDays gt lt scanAfterWrite gt no lt scanAfterWrite gt lt scanAfterRead gt no lt scanAfterRead gt lt daysToScanAfter gt 0 lt daysToScanAfter gt lt MLMMediaVerification gt lt allowUsers gt all lt allowUsers gt lt partitionData gt lt partition gt T 111 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition new Description Creates a storage partition or cleaning partition that uses a specified number of slots and drives The command also sets all of the other configuration parameters required for the partition The partition is configured to allow access by all users If you want to limit the users allowed to
52. stored on the library See Check and Respond to Messages in your library s User Guide for a detailed description of the library s messaging system Description Returns the list of system messages that are currently stored on the library The messages are listed in the order they were posted beginning with the most recent Syntax systemMessages xml Command Response The command immediately returns the following XML formatted data lt systemMessages gt lt message gt lt number gt message number lt number gt lt severity gt Info Warning Error Fatal Error lt severity gt lt date gt lt month gt mm lt month gt lt day gt dd lt day gt lt year gt yyyy lt year gt lt date gt lt time gt lt hour gt hh lt hour gt lt minute gt mm lt minute gt lt second gt ss lt second gt lt time gt lt notification gt message text lt notification gt lt remedy gt suggested remedy text lt remedy gt lt message gt lt systemMessages gt 140 Chapter 21 systemMessages where the value for This parameter Indicates number The message number assigned by the library severity The severity classification for the message Values Info The library is working as intended An event occurred that generated information about an operation or a system component No action is required Warning The library is working as intended An event occurred
53. that may require attention to keep the library running at 100 If the event was unexpected determine the cause of the event and take remedial steps Error The library operation is impaired and requires user intervention Examine any additional information in the message and take any required remedial steps Fatal Error The library has experienced an event that prevents it from continuing operations Examine any additional information in the message and take any required remedial steps EXAMPLE In the command response below the first message has a severity value of Info the second message has a severity value of Warning date The month day and year mm dd yyyy that the system message was posted time The hour minute and second hh mm ss using a 24 hour clock that the system message was posted notification The text displayed in the system message remedy Any suggested remedy if the message indicates an error Syntax Error Response None 141 April 2015 XML Command Reference Spectra Tape Libraries Chapter 21 systemMessages Example Command and Response The following command systemMessages xml retrieves the current system messages for the library For example lt systemMessages gt lt message gt lt number gt 32 lt number gt lt severity gt Info lt severity gt lt date gt lt month gt 6 lt month gt lt day gt 24 lt day gt lt year gt 2011 lt
54. year gt lt date gt lt time gt lt hour gt 7 lt hour gt lt minute gt 36 lt minute gt lt second gt 40 lt second gt lt time gt lt notification gt MLM Media discovery completed in partition Partition 1 lt notification gt lt remedy gt None lt remedy gt lt message gt lt message gt lt number gt 31 lt number gt lt severity gt Warning lt severity gt lt date gt lt month gt 6 lt month gt lt day gt 23 lt day gt lt year gt 2011 lt year gt lt date gt lt time gt lt hour gt 16 lt hour gt lt minute gt 19 lt minute gt lt second gt 08 lt second gt lt time gt lt notification gt AutoSupport is not configured to automatically email data about critical events and errors though this functionality is supported lt notification gt lt remedy gt Using the library interface select AutoSupport gt Manage Events and enable critical AutoSupport events lt remedy gt lt message gt lt systemMessages gt 142 April 2015 XML Command Reference Spectra Tape Libraries CHAPTER 22 taskList taskList xml The taskList XML command returns a list of the operations currently being processed by the library no Description Returns a list of the asynchronous actions and background parameters Operations currently being processed by the library See Progress for Asynchronous Commands on page 15 for additional information about how the library handles asynchronou
55. 0 provides the following offset information The offset for the first magazine listed is 1 There are no slot parameters associated with this magazine indicating that the magazine is empty The offset for the second magazine listed is 6 This magazine has two sets of slot data indicating that there are cartridges in slots 1 and 3 of the magazine and that the remaining slots in the magazine are empty Offset values 2 3 4 and 5 are not included in the data indicating the these locations are empty barcode The barcode label information magazine or cartridge Note Ifa storage slot does not contain a cartridge or a chamber does not contain a magazine the barcode information field is not returned EXAMPLE In the example command response on page 130 the barcode label information for the first magazine listed is LU83567 The barcode label information for the cartridge in slot 1 of the second magazine listed is 000380L5 frameNumber The number of the frame where the magazine is located Note For libraries that do not support multiple frames the value for the frameNumber parameter is always 1 EXAMPLE In the example command response on page 130 the first magazine listed is located in frame 1 tapeBayNumber The number of the shelving bay within the specified frame where the magazine is located EXAMPLE In the example command response on page 130 the first magazine listed is located in shelving bay
56. 1 129 April 2015 XML Command Reference Spectra Tape Libraries Chapter 17 physinventory This parameter Indicates drawerNumber The component identifier for the chamber drawer where the magazine is located Note This parameter is not supported by the T120 library EXAMPLE In the example command response on page 130 the first magazine listed is located in drawer chamber 1 slot The section of the XML data that contains a single slot in a magazine number The magazine slot number where the cartridge is located Notes If the slot does not contain a cartridge the slot number field is not returned This parameter is not returned for the T120 library EXAMPLE In the example command response on page 130 the first cartridge in the second magazine listed is located in magazine slot 1 Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt physInventory xml lt line gt lt line gt Query string lt line gt lt line gt partition partition name lt line gt lt usage gt lt syntaxError gt Example Command and Response The following command physInventory xml partition Partition 1 returns the following information about Partition 1 April 2015 130 XML Command Reference Spectra Tape Libraries Chapter 17 physinventory lt physInventory gt lt partition gt
57. 1 and Trip2 Track specific aspects of the HHM counter These counters may or may not be present None The HHM counter does not have any of the other subType counters associated with it Note For the TFinity library many of the HHM counters contain two sets of Life Trip1 and Trip2 subType counters one set for Robot 1 and the other for Robot2 TeraPorter 1 and TeraPorter 2 respectively EXAMPLE In the example command response on page 42 the Life subType counter for the Horizontal Axis has a value of 25172883 inches the Trip1 subType counter has a value of 49513396 inches value The current value of the counter EXAMPLE In the example command response on page 42 the Life subType counter for the Horizontal Axis has a value of 25172883 inches unit The unit of measure for that data Values inches degrees steps hours moves EXAMPLE In the example command response on page 42 the Trip1 subType counter has a value of 49513396 inches typeName reminder The reminders system messages that have been posted for the Trip1 and Trip2 subType counters associated with the current HHM counter When one of these counters reaches the threshold value set for the counter the library adds a reminder to the HHM data returned by the HHMData xml command and turns on the HHM icon in the status bar on the BlueScale user interface Each reminder includes the following parameters typeName The name of the remi
58. 3 Chapter 23 traces 145 PER AMOS Names AA aoa E aN 145 petCanLog usina lea E E 146 getQIPLoS AAPP p ik aE AE a AEE e AEEA 147 POROTOS rar 148 trace Type ceu rans nenet nis aKa iE IE 149 April 2015 XML Command Reference Spectra Tape Libraries Contents Chapter 24 utils Index lock Tension Rods 10 cuccts sra eds rs as removeAll Library Partitions escri POSEE INVEMOLY es tii ERARIO 1 AA eea org ewe hee nee hehe eto a a PEEP CE OM earst Gh cea dale dans canteen es selective Snowplow 4 3 244 iia bien sou Biba RARA verify Magazine Barcodes si ironed nee tase ceed a ead April 2015 XML Command Reference Spectra Tape Libraries ABOUT THIS GUIDE This reference describes using the XML command interface which provides automation support for operating and monitoring of Spectra Tape Series libraries referred to as the library using a set of XML commands instead of the BlueScale user interface Note The Spectra T50e library does not support the XML command interface INTENDED AUDIENCE This command reference is intended for system administrators who are responsible for writing a programmatic interface for monitoring and operating the library without using the BlueScale user interface The reference assumes a working knowledge of using a standard programming language such as Java Perl or Python as well as an understanding of standard XML command structure RELATED INFORMATION For additional in
59. 4 Gb second F QIP 2 Gbps Fibre Channel 2 Gb second F QIP 1 Gbps Ethernet 1 Gb second E QIP failoverFrom The component identifier of the primary controller configured in a failover pair using the form FRx DBAx F QIPx see ID above Only displays for the secondary controller in a failover pair failoverTo The component identifier of the secondary controller configured in a failover pair using the form FRx DBAx F QIPx see ID above Only displays for the primary controller in a failover pair port Information about how the controller port is configured name The designator for the port Values A B useSoftAddress Whether or not the port is configured to use soft addressing Values yes no loopId The configured fixed loop ID Only displayed if useSoftAddress is no initiatorEnabled Whether initiator mode in enabled or not Values yes no fibreConnectionMode The configured Fibre connection mode Values Loop Fabric Automatic auto negotiated Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt controllers xml lt line gt lt line gt Query string lt line gt lt line gt action lt list gt lt line gt lt usage gt lt syntaxError gt 22 April 2015 XML Command Reference Spectra Tape Libraries Chapter 3 controllers Example Command and Response The following command co
60. A SPEC TRAY DEEP STORAGE EXPERTS Spectra Tape Libraries XML Command Reference SPECTRALOGIC COM Copyright Notices Trademarks Part Number Revision History Copyright O 2012 2015 Spectra Logic Corporation All rights reserved This item and the information contained herein are the property of Spectra Logic Corporation Except as expressly stated herein Spectra Logic Corporation makes its products and associated documentation on an AS IS BASIS WITHOUT WARRANTY OF ANY KIND EITHER EXPRESSED OR IMPLIED INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE BOTH OF WHICH ARE EXPRESSLY DISCLAIMED In no event shall Spectra Logic be liable for any loss of profits loss of business loss of use or data interruption of business or for indirect special incidental or consequential damages of any kind even if Spectra Logic has been advised of the possibility of such damages arising from any defect or error Information furnished in this manual is believed to be accurate and reliable However no responsibility is assumed by Spectra Logic for its use Due to continuing research and development Spectra Logic may revise this publication from time to time without notice and reserves the right to change any product specification at any time without notice BlueScale CC Spectra SpectraGuard Spectra Logic TeraPack and TranScale are registered trademarks of Spectra
61. Asynchronous Commands on page 15 154 April 2015 XML Command Reference Spectra Tape Libraries Chapter 24 utils resetLCM resetRobot Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt utils xml lt line gt lt line gt POST data lt line gt lt line gt action lockTensionRods removeAllLibraryPartitions resetLCM resetRobot resetInventory selectiveSnowplow verifyMagazineBarcodes lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt Description Resets the LCM which resets the front panel and the web server Syntax utils xml action resetLCM Command Response The command resets the LCM immediately Any connections to the library through the BlueScale web interface or XML interface are lost Wait five to fifteen minutes for the reset to complete and then reconnect Backup operations are not affected Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt utils xml lt line gt lt line gt Query string lt line gt lt line gt action lockTensionRods removeAllLibraryPartitions resetLCM resetRobot resetInventory selectiveSnowplow verifyMagazineBarcodes lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt Description Rese
62. F QIP port that provides the host connection to the drive Values A B A Important At least one port must be specified for each QIP listed The first port is separated from the QIP ID by a semicolon If both ports of the QIP are used the second port is separated from the first by a semicolon For each port optionally include the addressing mode and the hard address if required If more than one QIP is included the QIPs are in a comma separated list addressing mode Optionally configures the addressing for each port Values loop Specifies the arbitrated loop addressing mode The loop ID is set by the value of the hardAddress parameter if specified If no hard address is specified soft addressing is used fabric Specifies the fabric addressing mode auto Specifies that the addressing mode is auto negotiated by the controller When the negotiated mode is loop the loop ID is set by the value of the hardAddress parameter if specified If no hard address is specified soft addressing is used hardAddress The optional fixed address assigned to the port when the addressing mode is either loop or auto Values 0 through 125 Notes The QIPList parameter is omitted when configuring a cleaning partition The QIPList is omitted if there are no additional F QIPs or if there are no SCSI drives in the library Ifthe ports have previously been configured for another partition that uses the same controller it is on
63. IP log file yy is the last two digits of the year mm is the two digit month and dd is the two digit day Command Response The command immediately returns the requested QIP log files in a binary zip file 148 April 2015 XML Command Reference Spectra Tape Libraries Chapter 23 traces traceType This parameter Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt traces xml lt line gt lt line gt Query string lt line gt lt line gt action getQIPLog lt line gt lt line gt name lt qipLogName gt lt line gt lt usage gt lt syntaxError gt Example Command The following command traces xml action getQIPLog name QIP_12_03_20 zip returns a zip file containing the QIP logs that were generated on March 20 2012 Description Returns the data for the type of trace specified by the command Syntax traces xml traceType trace name see list below where the value for Specifies traceType The name of the trace to be retrieved by the command See Capturing Traces in your library s User Guide for additional information about traces Values Action GPIO MotionInventory AutoDriveClean HHM MotionOptions AutoSupport HydraExit MotionRestart1 BackgroundClient Initialization MotionRestart2 CAN Inventory PackageUpdate Connection Kernel Pools Encryp
64. LevelAssemblyEC The EC level of the top level assembly For example the EC level of the printed circuit board in the RCM topLevelAssemblySerialNumber The serial number of the top level assembly if relevant date The date of manufacture Syntax Error Response None Example Command and Response The following command libraryStatus xml immediately returns the following XML formatted data when issued to a T950 library lt libraryStatus gt lt libraryType gt T950 lt libraryType gt lt serialNumber gt 1137402 lt serialNumber gt lt excessiveMoveFailures gt lt move gt lt partition gt Partition 1 lt partition gt lt source gt Slot 28 lt source gt lt destination gt Slot 361 lt destination gt lt numberOfFailures gt 5 lt numberOfFailures gt lt lastSenseInfo gt 0x04 0x85 0x02 lt lastSenseInfo gt lt lastFailedMoveTime gt 2015 01 07 18 04 27 lt lastFailedMoveTime gt lt move gt lt excessiveMoveFailures gt lt controllerEnvironmentInfo gt lt controller gt lt ID gt FR1 DBA6 F QIP1 lt ID gt lt temperaturelnCelsius gt 33 lt temperaturelnCelsius gt lt portALoopUp gt yes lt portALoopUp gt lt portBLoopUp gt yes lt port BLoopUp gt lt controller gt 66 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus lt driveControlModule gt lt ID gt FR1 DBA6 fTS11x0 DRV1 lt ID gt lt twelveVoltVoltage gt
65. Logic Corporation ArchiveGrade BlackPearl IntraCloud nTier Verde and Verde are trademarks of Spectra Logic Corporation All rights reserved worldwide All other trademarks and registered trademarks are the property of their respective owners 90940114 Revision E Revision Date Description A June 2012 Initial release B January 2013 Added new actions for driveList xml C May 2013 Added logout xml and new action for partition xml D December 2013 Updated for BlueScale 12 6 3 Added robot status to libraryStatus xml E April 2015 Added multi drive exporter to partition creation option keys command robot service command new library status information and several new utility commands Note To make sure you have the most current version of this guide check the Spectra Logic support portal at support spectralogic com documentation To make sure you have the release notes for the most current version of the BlueScale software log into the Spectra Logic Technical Support portal at http support spectralogic com The release notes contain updates to the this guide since the last time it was revised April 2015 XML Command Reference Spectra Tape Libraries End User License Agreement You have acquired a Spectra product that includes software owned or licensed by Spectra Logic from one or more software licensors Software Suppliers Such software products as well as associated media printed materials and online or
66. REESE e EER GRE 70 refresh Environment id ORE AD UE REN EHOW ROR AAA RA A eM 71 login 72 USCINAME aaa 72 logout 74 mediaExchange 75 CCA EE ee eee Reed ceed 75 Beata aida ada 77 POr EXPONE nana rinda 80 Importing Exporting or Exchanging Cartridges oooo oooo 84 optionKeys 87 add O psa esc a aaa id ie eee 87 WEE Seige ide acy sd 87 package 89 no parameters r list dre eews se 89 getResu lts o wand HS TREKS A AGREE NAGREREE dag Is 91 UDS ya da DARE AAA Ree RON HOA HE awd AA eR 93 Updating the Library BlueScale Software oooooooomommm o 97 packageUpload 99 no parameters iia es naeia oN ARA AAA 99 6 XML Command Reference Spectra Tape Libraries Contents Chapter 15 partition 101 autoGre te pondre ro rro dee hie oc 101 delete cin tias e iia dai 104 E A Day dhe Gia qoeka pied 106 NEW Wheel Ie ea a ese eo e id 112 Chapter 16 partitionList 126 no p ramet rs sica dd AR A RAR AAA 126 Chapter 17 physinventory 127 DARIO sa a cias DIR INCA AREAS fa a 127 Using the physInventory xml Command 05 132 Chapter 18 powerOff 133 no parameter aaa di 133 Chapter 19 robotService 135 return TOM SERVICE raro aia 135 Send Lo Ser vicario daa ened 136 Chapter 20 robotUtilization 138 ii A es cote en eundah oR pee ay De peas G 139 Chapter 21 systemMessages 140 MO parameters ra ad cd A AAA AAA ade ead 140 Chapter 22 taskList 143 Ho parametros iienaa iee a ata a e nad 14
67. SAS blank SCSI technologyl The technology used by the drive Values LTO TS11x0 SDLT SAIT DRVx The number of the drive bay in the DBA as viewed from the back of the library For all libraries except the T120 the value of x can be 1 through 4 For the T120 library the value of x can be 1 through 6 for full height drives and 1b through 6a for half height drives Notes This command can only be used for LTO 5 and later generation drives and TS1140 and later generation drives The ID values returned by the driveList xml command without any parameters are the component identifiers for the drives currently installed in the library see driveList xml on page 24 See Drive Identifiers in your library s User Guide for additional information about drive component identifiers Command Response The command returns the following XML formatted data lt driveList gt lt status gt OK lt status gt lt message gt Started drive traces creation Set progress in your query for status lt message gt lt driveList gt 30 April 2015 XML Command Reference Spectra Tape Libraries Chapter 4 driveList getDrive Traces This parameter driveTracesGetType Progress Use the driveList xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 driveList xm
68. Spectra Logic Website www spectralogic com United States Headquarters European Office Spectra Logic Corporation Spectra Logic Europe Ltd 6285 Lookout Road Venture House Boulder CO 80301 Arlington Square Downshire Way USA Bracknell RG12 1WA Phone 1 800 833 1132 or 1 303 449 6400 United Kingdom International 1 303 449 6400 Phone 44 0 870 112 2150 Fax 1 303 939 8844 Fax 44 0 870 112 2175 Spectra Logic Technical Support Technical Support Portal support spectralogic com United States and Canada Europe Middle East Africa Phone Phone 44 0 870 112 2185 Toll free US and Canada 1 800 227 4637 Deutsch Sprechende Kunden International 1 303 449 0160 Phone 49 0 6028 9796 507 Email spectralogic stortrec de Mexico Central and South America Asia Australia and New Zealand Phone 1 303 449 0160 Spectra Logic Sales Website www spectralogic com shop United States and Canada Europe Phone 1 800 833 1132 or 1 303 449 6400 Phone 44 0 870 112 2150 Fax 1 303 939 8844 Fax 44 0 870 112 2175 Email sales spectralogic com Email eurosales spectralogic com To Obtain Documentation Spectra Logic Website support spectralogic com documentation April 2015 XML Command Reference Spectra Tape Libraries Contents Contents About This Guide 9 Intended Audience 0 cece ccc cece cee e eee e teens 9 Related Information 9 Chapter 1 Overview 12 Using the XML Comm
69. Timeout in your library s User Guide or can be closed by issuing a logout command see logout xml on page 74 Connections to the library through the XML command interface are included in the maximum of eight simultaneous remote sessions supported by the library Syntax login xml username username amp password password amp forceFrontPanel where the value for This parameter Specifies username A valid username assigned to the library Notes The specified user must have either superuser or administrative privileges in order to perform configuration operations Users assigned to the Operator group can move import and export media but cannot access the more sensitive library operations such as configuration diagnostics and security The username is case sensitive password optional The password associated with the username Notes If no password is set this parameter can be left blank or not included The password is case sensitive 72 Chapter 9 login This parameter Specifies forceFrontPanel optional Any future use of the BlueScale web interface not the XML interface using this created session will have access to all functions including those usually only available on the front panel Command Response The command immediately returns the following XML formatted data lt login gt lt status gt OK lt s
70. User Guide for detailed information about preparing and using cartridges and magazines in the library and for detailed instructions for loading cartridges into the bulk TAP carousel Preparation 1 Run the following command to retrieve a list of all occupied magazines and cartridge locations in the partition named Partition 1 Use this data to determine the offset values for the magazines you want to use for your import export or exchange operation See physInventory xml on page 127 for details physI nventory xml partition Partition 1 2 Run the following command to make sure that the left bulk TAP is empty and that the door is locked mediaExchange xml action clean amp partition Partition 1 amp TA PDevice leftBulk 3 Run the following command to determine when the clean command is complete mediaExchange xml progress amp TAPDevice leftBulk Repeat the progress command as often as desired until the response is No Pending actions April 2015 84 XML Command Reference Spectra Tape Libraries Chapter 11 mediaExchange mediaExchange xml importExport A Important Import Magazines Example 1 After performing the steps in Preparation on page 84 run the following command to import six magazines into the entry exit pool for Partition 1 Note This example uses the data from the example command response for the physInventory xml partition Partition 1 command beginning on page 130 m
71. able lt traces gt lt canLogNames gt lt logName gt latest zip lt logName gt lt logName gt 12_03_25 zip lt logName gt lt logName gt 11_11_20 zip lt logName gt lt canLogNames gt lt traces gt Description Retrieves the specified zip file containing CAN logs from the LCM Use the traces xml act ion getCanLogNames command to determine names of the zip files containing CAN logs that are currently stored on the hard drive in the LCM The getCanLog action parameter is only supported for libraries that are using the Spectra LS module as the LCM Issuing this command to a library that uses a Spectra PC as the LCM returns an empty list April 2015 146 XML Command Reference Spectra Tape Libraries Chapter 23 traces Syntax traces xml action getCanLog amp name value where the value for This parameter Indicates name getQIPLog Names A Important The name of the zipped set of log files being requested Values latest zip The CAN log files for the current date The zip file is created at the time it is requested yy_mm_dd zip The name of the zip file containing the CAN logs for a specific date where yy is the last two digits of the year mm is the two digit month and dd is the two digit day Command Response The command immediately returns the requested CAN log files in a binary zip file Syntax Error Response lt syntaxError gt lt m
72. about the background tasks the library is currently processing Notes The library can process multiple background tasks most of them in parallel If the library is not currently processing any background tasks this section will appear with empty parameter tags task The section of the currentBackgroundTask section of the command response that contains information about each background task that is currently being processed name The name of the asynchronous action or background task currently being processed status The current status of the asynchronous action Values QUEUE The asynchronous action is queued for processing SUBMITTED The asynchronous action has been submitted for processing ACTIVE The asynchronous action is being processed WAITINGFORUSER The asynchronous action is waiting for the operator to respond to the feedback string DETACHED The asynchronous action was started by a user other than the one who issued the current taskList xml command The library is waiting for that action to complete before beginning the action indicated by the name parameter feedbackString The text string that displays feedback is required from the operator before processing of the asynchronous task can continue Note The feedbackString parameter is only included if the status is WAITINGFORUSER thread The description of each background client involved in processing the back
73. al The Spectra BlueScale Vision Camera User Guide provides detailed information about installing and using the white BlueScale Vision Camera and software The Vivotek FD8361 Fixed Dome Network Camera User s Manual provides detailed information about installing and using the black BlueScale Vision Camera and software The Spectra Encryption User Guide provides detailed information about using BlueScale Encryption Standard and Professional Edition and the Spectra TKLM Encryption key management system It also provides useful information about encryption best practices and recycling encrypted media The Spectra Tape Libraries SCSI Developer s Guide provides detailed information about the SCSI and Fibre Channel commands used in the library The Spectra Tape Libraries Warnings document provides all of the warnings found in Spectra Tape Series libraries documentation in English and 27 other languages Spectra TKLM Server For additional information that can assist you during the installation and configuration of your server see the following websites IBM Tivoli Key Lifecycle Manager Information Center Tivoli Key Lifecycle Manager Installation and Configuration Guide 10 April 2015 XML Command Reference Spectra Tape Series Libraries About This Guide Related Information A Important A Caution A WARNING LTO Ultrium Tape Drives The following documents provide information that is applicable to all IBM LTO ta
74. and Interface uvcccionrsriinnbrcha dra 12 Connectivity Requirements estirar ais als 12 Command Categories sa dida id a a 13 Iss ing Commands os nro pa be 13 Command Syntax ets ERE e 13 Library Login and Logout cin Sule ide 2 Bee 14 Progress for Asynchronous Commands 00 2 008 15 Systemi ETrOLS sx dice ih ah ENG dd oe GR RAR ONG Pi Hen ew i 16 Using this Command Referente yiiereniscnsrra evens een ees 16 Chapter 2 autosupport 18 BENET A CR A AA RA LRG R 18 BELA SLINAINES ta EA ae a Pea 19 SEAS aeee aE orig deh eo Wand on weg tw han Oe Saws Beane eee we 20 Chapter 3 controllers 21 A 21 Chapter 4 driveList 24 no parameters or list sevcrsnrssa cee tease Ga Esa ana 25 generateDriyve Paces s os eet Ad SEER RA 30 petDrive Traces A E 31 prepare lO ReplaceDrive 0er AAA rnnr 33 TESCEDLIVE oh 2 avd Gave abe odds dane da eden dee deeeiedcadanes 35 Chapter 5 encryption 37 A quk Gh nae Gok oa nen Guk oan eigisadound 37 April 2015 XML Command Reference Spectra Tape Libraries Contents Chapter 6 Chapter 7 Chapter 8 Chapter 9 Chapter 10 Chapter 11 Chapter 12 Chapter 13 Chapter 14 April 2015 HHMData 39 no parameters r list stare parb paris ads da oe 40 resetCounterData RES AR a a OR 44 setThresholdData iia dd Ad 46 inventory 49 DALIA aire Ea 49 libraryStatus 54 pet csp epee canoe y nate nn hens PREG a BP ORE EO OR Od 54 r freshECIN O 9 4 e RAR ERG
75. ar gt Engaged Not Engaged lt topHAXGear gt lt bottomHAXSolenoid gt Engaged Not Engaged lt bottomHAXSolenoid gt lt robot gt lt serialNumber gt value lt serialNumber gt lt excessiveMoveFailures gt lt move gt lt partition gt value lt partition gt lt source gt value lt source gt lt destination gt value lt destination gt lt numberOfFailures gt value lt numberOfFailures gt lt lt lastSenselnfo gt value lt lastSenselnfo gt lastFailedMoveTime gt value lt lastFailedMoveTime gt lt move gt lt excessiveMoveFailures gt 54 Chapter 8 libraryStatus lt controllerEnvironmentinfo gt lt controller gt lt ID gt value lt ID gt lt temperaturelnCelsius gt value lt temperaturelnCelsius gt lt portALinkUp gt yes no lt portALoopUp gt lt portBLinkUp gt yes no lt portBLoopUp gt lt controller gt lt driveControlModule gt lt ID gt value lt ID gt lt twelveVoltVoltage gt value lt twelveVoltVoltage gt lt fiveVoltVoltage gt value lt fiveVoltVoltage gt lt fanCurrentInAmps gt value lt fanCurrent InAmps gt lt temperaturelnCelsius gt value lt temperaturelnCelsius gt lt driveControlModule gt lt powerSupplyFRU gt lt ID gt value lt ID gt lt inputPowerOkay gt yes no lt inputPowerOkay gt lt output PowerOkay gt yes no lt outputPowerOkay gt lt temperatureWarning gt yes no lt tempe
76. arameter Indicates robot The number of the robot in the library Numbering is from left to right as viewed from the front of the library Values 1 The left robot as viewed from the front of the library 2 The right robot as viewed from the front of the library Command Response The command immediately returns the following XML formatted data lt robotService gt lt message gt Started Robot Service Action Set progress in your query for status lt message gt lt status gt OK lt status gt lt robotService gt Progress Use the robotService xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 April 2015 136 XML Command Reference Spectra Tape Libraries Chapter 19 robotService Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt robotService xml lt line gt lt line gt Query string lt line gt lt line gt action sendToService lt line gt lt line gt robot lt robot number gt lt lt usage gt lt syntaxError gt line gt lt line gt progress while running lt line gt April 2015 XML Command Reference Spectra Tape Libraries 137 CHAPTER 20 robotUtilization robotUtilization xml The robotUtilization
77. arted Robot Service Action Set progress in your query for status lt message gt lt status gt OK lt status gt lt robotService gt Progress Use the robotService xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 135 Chapter 19 robotService sendTo Service Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt robotService xml lt line gt lt line gt Query string lt line gt lt line gt action returnFromService lt line gt lt line gt robot robot number lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt Description Move a TFinity robot to the service bay The service safety door must be open or the command will fail Notes The command does not close the service safety door or instruct the operator to close the service safety door after the robot moves to service Power to the robot remains on because the door is not closed Ifatany time a motion restart occurs on the library the robot will reinitialize If the robot has been sent to the service bay it will attempt to return to the library return from service on its own Syntax robotService xml action sendToService amp robot 1 2 where the value for This p
78. artition This parameter Specifies QIPExporter continued addressing mode Optionally configures the addressing for each port Only one mode can be specified in the command If no mode is specified the partition uses soft addressing Values loop fabric auto where loop Specifies the arbitrated loop addressing mode The loop ID is set by the value of the hardAddress parameter if specified If no hard address is specified soft addressing is used fabric Specifies the fabric addressing mode auto Specifies that the addressing mode is auto negotiated by the controller hardAddress The optional fixed address assigned to the port when the addressing mode is either loop or auto Values 0 through 125 Notes The QIPExporter parameter is omitted when configuring a cleaning partition Ifthe ports have previously been configured for another partition that uses the same controller it is only necessary to indicate whether the partition will use Port A Port B or both entered as A B or A B respectively Do not include the colon or the addressing parameters in the command See the Architecture and the Configuring and Managing Partitions chapters in your library s User Guide for detailed information about controller component identifiers and port addressing For libraries that support the controller failover feature these chapters also include information about additional requiremen
79. ateResults gt lt package gt April 2015 XML Command Reference Spectra Tape Libraries Chapter 13 package where the value for This parameter Indicates packageName The full name of the BlueScale package that was used to update the library EXAMPLE In the command response on page 93 the package name is BlueScale12 1 0 20120423F name The name of the BlueScale component that was updated EXAMPLE In the command response on page 93 the name of the first component that was updated is LC OS previousVersion The version number of the BlueScale component before the update EXAMPLE In the command response on page 93 the version number for the LC OS component before the update was 100 4 0 0 updatedVersion The version number of the BlueScale component following the update EXAMPLE In the command response on page 93 the new version number for the LC OS component is 100 5 0 0 updateStatus The status of the update Values OK The update completed successfully failure message An error message indicating why the update did not complete successfully EXAMPLE In the command response on page 93 the status of the update for the LC OS component is OK rebootinProcess Whether the library requires a reboot of the LCM and RCM to complete the update Values true The library will reboot components to complete the update false No components were updated that requ
80. ated April 2015 XML Command Reference Spectra Tape Libraries Chapter 11 mediaExchange This parameter Specifies slotType The pool to be used for the import or export operation Values storage IE entry exit Note Refer to Media Pools in your library s User Guide for detailed information about the storage and entry exit pools and their use TAPDevice The TAP that will be used for the import or export operation Values main The TAP in the main frame leftBulk The bulk TAP on the left end of the library rightBulk The bulk TAP on the right end of the library Notes The main parameter value is not currently supported The command always fails if it contains the main parameter value The leftBulk and rightBulk parameter values are not supported by libraries that do not include a bulk TAP In addition the command fails if the library does not have a bulk TAP installed on the side specified by the parameter value timeoutinMinutes The time in minutes that the library will wait for the door release button on the bulk TAP to be pushed opening the bulk TAP door Value 1 through 10080 minutes 7 days default 10 minutes A Important If you do not open the door within the number of minutes specified by the timeoutInMinutes parameter the operation is aborted The LED turns off and the carousel rotates to face the interior of the library If magazines were left i
81. ating BlueScale in your library s User Guide for detailed information about BlueScale update packages 1 Run the program you created to transfer the BlueScale package to the library using the packageUpload xml command see packageUpload xml on page 99 2 Run the following command to confirm that the BlueScale package you uploaded is on the library memory card package xml The package you uploaded will be listed in the list section of the XML data returned in the command response 3 Run the following command to update the library to use the BlueScale package you uploaded and automatically reboot the LCM if the package included updates to the LCM or RCM firmware package xml action update amp package package namel tautoFinish 4 Run the following command to check the progress of the update package xml progress 5 When you receive a No Pending actions response complete the update If you included the autoFinish parameter in Step 3 the library automatically completes the update and posts the results as a system message If you did not include the autoFinish parameter in Step 3 run the following command to complete the update and retrieve the results package xml action getResults Note The remote connection to the library is lost when the LCM reboots Allow sufficient time for the LCM to complete its initialization then reconnect to the library 6 Run one of the following commands to retrieve any system
82. atus bar on the BlueScale user interface Do not run this command unless you are specifically directed to do so by Spectra Logic Support Changing the threshold values can result in components not receiving regularly scheduled maintenance at the appropriate intervals Syntax HHMData xml action setThresholdData amp event Servic HAX Check Contact Brushes Service HAX Belt Service VAX Service VAX Belt Service VAX Cable Service Transporter Service Required amp default true false amp value value Notes Only HHM counters that have a Trip 1 or Trip 2 subType counter have configurable reminder thresholds Only one reminder threshold value can be set with each command To reset multiple thresholds you must issue separate commands For the TFinity library the reminder threshold for the Trip 1 or Trip 2 subType counter is set to the same value for both robots where the value for This parameter Specifies event The name of the reminder for which the threshold is being set Values Service HAX Check Contact Brushes TFinity library only Service HAX Belt all except T120 and TFinity libraries Service VAX Service VAX Belt Service VAX Cable T120 only Service Transporter all except T120 Service Required default Whether the reminder threshold uses the factory default value or the threshold set by the value parameter Values true use the factory default threshold fal
83. ber of the robot in the library Numbering is from left to right as viewed from the front of the library Values 1 left robot or 2 right robot state The status of the robot Values inService impaired good or unknown serviceFrame The service frame containing an in service robot Values left right none uncommon or unknown uncommon Note The serviceFrame tag is only shown if state inService topHAXGear The state of the HAX gear at the top of the TeraPorter Values Engaged Not Engaged bottomHAXSolenoid The state of the HAX solenoid Values Engaged Not Engaged serialNumber The library serial number hardware ID 58 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus This parameter Indicates exsessiveMove Failures controller Environmentinfo Lists information for the last unique moves up to ten that failed five consecutive times move Information for one unique move partition The name of the partition in which the move was attempted source The element type and BlueScale number assigned to the source of the move This number appears as the number for each slot or drive in the BlueScale Inventory screen destination The element type and BlueScale number assigned to the destination of the move This number appears as the number for each slot or drive in the BlueScale Inventory screen num
84. berOfFailures The number of consecutive failures recorded for this move lastSenseInfo The most recent Sense Key Additional Sense Code ASC Additional Sense Code Qualifiers ASQC lastFailedMoveTime Timestamp of the last failed move in the format YYYY MM DD HH MM SS The status of different components in the library The information provided for each component is described below controller QIPs and RIMs ID The component identifier for the exporting RIM or F QIP using the form FRx DBAx F QIPx where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the controller Not used with the T120 library F QIPx The number of the controller bay where the QIP is installed For all libraries except the T120 the value of x is always 1 For the T120 library the value of x is either 1 or 2 temperatureInCelsius The measured temperature in Celsius portALinkUp Whether or not there is an active fibre connection on port A Values yes no portBLinkUp Whether or not there is an active fibre connection on port B Values yes no 59 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus This parameter Indicates controller Environmentinfo continued driveControlModule The drive sled tha
85. by the Warning icon for information you must know to avoid personal injury April 2015 XML Command Reference Spectra Tape Series Libraries CHAPTER 1 Overview This chapter provides an overview of the XML command interface for the Spectra Tape Series libraries and a description of how this reference is organized Topic Using the XML Command Interface this page Comnectivity Requirements this page Command Categories page 13 Issuing Commands page 13 Library Login and Logout page 14 Progress for Asynchronous Commands page 15 System Errors page 16 Using this Command Reference page 16 USING THE XML COMMAND INTERFACE The XML command interface provides automation support for operating and monitoring the library using a set of XML commands instead of the BlueScale user interface The following sections describe the general requirements and process for using the XML command interface Connectivity Requirements The XML command interface requires an active Ethernet connection to the library s Library Control Module LCM This connection is the same one used to access the BlueScale web interface See Configure Network Settings in your library s User Guide for information and instructions 12 Chapter 1 Overview Using the XML Command Interface Command Categories The XML commands fall into the following categories and address different aspects of the library s operatio
86. contains the data for the drives assigned to Partition 1 offset The SCSI element address of the slot or drive that the library reports to the host EXAMPLE In the example command response on page 53 the element address for the first storage slot listed is 4096 The BlueScale number assigned to the slot or drive in the specified pool This number appears as the number for each slot or drive in the BlueScale Inventory screen Refer to your library s User Guide for information about the Inventory screen Note When creating a move queue file to be uploaded to the library you can use the offset parameter values returned by the inventory xml command as the source_num and destination_num parameters See Create a Move Queue File in your library s User Guide for detailed information about creating a move queue EXAMPLE In the example command response on page 53 the offset value for the first slot listed for the storage pool is 1 The empty slot in the storage pool has an offset value of 47 The second drive in the partition has an offset value of 2 April 2015 XML Command Reference Spectra Tape Libraries Chapter 7 inventory This parameter Indicates barcode The cartridge barcode label information of the cartridge in the slot or drive in the specified pool Note This parameter is only returned when the value for the full parameter for the slot or drive is yes EXAMPLE In the exam
87. ct and only if the recipient agrees to this EULA If the Software is an upgrade any transfer must also include all prior versions of the Software Export Restrictions Export of the Software from the United States is regulated by the Export Administration Regulations EAR 15 CER 730 744 of the U S Commerce Department Bureau of Export Administration You agree to comply with the EAR in the export or re export of the Software i to any country to which the U S has embargoed or restricted the export of goods or services which as May 1999 include but are not necessarily limited to Cuba Iran Iraq Libya North Korea Sudan Syria and the Federal Republic of Yugoslavia including Serbia but not Montenegro or to any national or any such country wherever located who intends to transit or transport the Software back to such country ii to any person or entity who you know or have reason to know will utilize the Software or portion thereof in the design development or production of nuclear chemical or biological weapons or iii to any person or entity who has been prohibited from participating in U S export transactions by any federal agency of the U S government You warrant and represent that neither the BXA nor any other U S federal agency has suspended revoked or denied your export privileges April 2015 XML Command Reference Spectra Tape Libraries Contacting Spectra Logic To Obtain General Information
88. d to determine the offset values for empty chambers in a partition and the mediaExchange xml action clean command to make sure that the bulk TAP is empty use the following command to import magazines into the empty storage chambers in a partition named Partition 1 mediaExchange xml action importExport partition Partition 1 amp slotType storage amp TAPDevice leftBulk amp TeraPackOffsets 2 3 4 5 April 2015 83 XML Command Reference Spectra Tape Libraries Chapter 11 mediaExchange mediaExchange xml importExport The bulk TAP carousel rotates to face the door When the bulk TAP door release button illuminates green press the button to open the door and insert the magazines When you close the door the robotics will move the magazines to the specified chambers Note Because the timeoutInMinutes parameter was not included in the command the library uses the default timeout of 10 minutes THis means you have 10 minutes to press the button to open the bulk TAP door insert the magazines in the carousel and close the bulk TAP door IMPORTING EXPORTING OR EXCHANGING CARTRIDGES The steps in the following examples illustrate the command sequences for using the bulk TAP to import or export one or more magazines Notes You must be logged into the library using the login xml command before issuing commands Refer to the Importing and Exporting Cartridges chapter of your library s
89. d was not a valid command for the library Notes Cleaning partitions do not require an SLS activation key If any partitions use a Fibre Channel drive to provide the robotic control path you can configure a maximum of six drive exporters The drive exporters can be used for six different partitions or multiple exporters can be configured in the same partition Ifall partitions use either a RIM or QIP for the robotic control path you can configure one partition per drive in the library up to a maximum of 16 partitions See Enabling BlueScale Software Support Options and Upgrades in your library s User Guide for information about purchasing and entering activation keys A cleaning partition can be shared by multiple storage partitions as long as the cleaning cartridges are compatible with the drives in the storage partitions This command does not enable encryption If you need to use encryption with the partition modify the partition after it is created to enable encryption See the Spectra Encryption User Guide for detailed instructions 12 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition Syntax Notes To simplify locating the corresponding information in your library s User Guide the parameters in the following syntax statement are listed in the same order as the corresponding settings presented by the BlueScale partition wizard In some cases the command parameters c
90. d with the command in the command response without requesting progress To view a list of all asynchronous actions and background operations that the library is processing use the taskList xml command see taskList xml on page 143 15 April 2015 XML Command Reference Spectra Tape Libraries Chapter 1 Overview Using this Command Reference Syntax command xml progress where command is the base URL of the command that was issued Command Response The command response depends on whether or not the command that was sent is still in progress Response command is in progress Response no command in progress lt progress gt lt progress gt lt activePage gt lt message gt No Pending Actions lt message gt command name lt status gt OK lt status gt lt activePage gt lt progress gt lt message gt message lt message gt lt status gt OK FAILED QUEUE SUBMITTED ACTIVE lt status gt lt progress gt Example Command The following command package xml progress returns the progress of the package update command System Errors If the web server encounters an error while processing a request or command it returns the following XML formatted data lt error gt lt message gt message lt message gt lt description gt description lt description gt lt error gt where the value for This parameter Indicates
91. de for additional information about HHM Note The parameters used in the HHMData xml commands depend on the library type To determine the parameters for your library use the HHMData xml command without any parameters Topic no parameters or list page 40 resetCounterData page 43 setThresholdData page 46 39 Chapter 6 HHMData no parameters or list Description Returns a report showing the current data for all of the HHM counters for the library Syntax HHMData xml action list Command Response The command immediately returns the following XML formatted data which shows the list of HHM counters for the library the associated threshold values for each counter and any reminders that have been posted The data for each counter is returned in a separate counter section of the HHM data Note The names and number of the HHM counters as well as the reminders for the Trip1 and Trip2 sub counters differ depending on the types of HHM counters supported by the library lt HHMData gt lt counter gt lt typeName gt Horizontal Axis Vertical Axis Picker Axis Toggle Axis Rotational Axis Side Axis General Maintenance Drive to Drive Move Drive to Slot Move Slot to Slot Move Slot to Drive Move TAP In Move TAP Out Move lt typeName gt lt subType gt lt typeName gt Life Trip1 Trip2 lt typeName gt lt value gt value lt value gt lt unit gt unit of measure lt unit gt lt reminder gt
92. drives in the partition or a Global Spare drive assigned to the partition to verify all of the data on each cartridge A Important This parameter is only valid when Media Lifecycle Management MLM is enabled for the library see Enabling MLM and Configuring Global Settings in your library s User Guide A Important The command cannot contain both the enableFullscan and the enableQuickscan parameters or the command will fail Values inlineDrives Use one of the drives in the partition to verify the data on a single track of each cartridge globalSpareDrives Use a Global Spare drive assigned to the partition to verify the data on a single track of each cartridge Notes The enableQuickscan parameter is omitted when configuring a cleaning partition The enableQuickscan parameter is optional for storage partitions The enableQuickscan parameter is only valid if the partition uses LTO 5 or later generation drives When you include the enableQuickscan parameter in the command you must specify one or more PostScan triggers using the scanAfter parameter The globalSpareDrives parameter value is only valid if the partition includes Global Spare drives configured using the globalSpares parameter See Using PostScan in your library s User Guide for information about this parameter scanAfter optional The PostScan triggers used to start either a FullScan or QuickScan operation A Important
93. dwareID The library s hardware ID serial number date The month day and year mm dd yyyy that the ASL file was generated time The time hh mm ss based on a 24 hour clock at which the ASL file was generated April 2015 19 XML Command Reference Spectra Tape Libraries Chapter 2 autosupport getASL Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt autosupport xml lt line gt lt line gt Query string lt line gt lt line gt action lt generateASL getASLNames getASL gt lt line gt lt usage gt lt syntaxError gt Example Command and Response The following command autosupport xml action getASLNames retrieves a list of the ASL files currently available on the library lt autosupport gt lt ASLNames gt lt ASLName gt 0919402 01 13 2014 17 03 50 as1 lt ASLName gt lt ASLName gt 0919402 01 23 2014 12 17 21 as1 lt ASLName gt lt ASLNames gt lt autosupport gt Description Retrieves the specified ASL file from the library Syntax autosupport xml action getASL amp name ASLName where the value for This parameter Specifies name The name of the ASL file to be retrieved by the command Command Response The command immediately returns a stream of data containing the ASL file Syntax Error Response lt syntaxError gt lt message gt er
94. e QIP identifies the file as a QIP log file yy is the last two digits of the year mm is the two digit month and dd is the two digit day getQIPLog A Important Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt traces xml lt line gt lt line gt Query string lt line gt lt line gt action lt getCanLogNames getCanLog getQIPLogNames getQIPLog gt lt line gt lt usage gt lt syntaxError gt Example Command and Response The following command retrieves a list of zip files containing QIP logs lt traces gt lt qipLogNames gt logName gt Q01P_11_09_25 zip lt logName gt A lt logName gt QIP_10_11_20 zip lt logName gt lt qipLogNames gt lt traces gt Description Retrieves the specified zip file containing QIP logs from the LCM Use the traces xml action getQIPLogNames command to determine the names of the QIP logs currently stored on the hard drive in the LCM The getQIPLog command is only supported for libraries that are using the Spectra LS module as the LCM Issuing this command to a library that uses a Spectra PC as the LCM returns an empty list Syntax traces xml action getQIPLog amp name value where the value for This parameter Indicates name The name of the zipped set of QIP log files being requested using the form QIP_yy_mm_dd zip where QIP identifies the file as a Q
95. e no longer available for purchase The TS11x0 and TS11x0 Maintenance values are only supported in T950 and TFinity libraries that have TS11x0 technology drives installed rotaryPosition The position of the bulk TAP carousel Values UserSide The bulk TAP carousel is facing the outside of the library RobotSide The bulk TAP carousel is facing the interior of the library Unknown The library is unable to determine the position of the carousel Uninitialized The bulk TAP has not completed its initialization process Note rotaryPosition is only shown when the TAPDevice is leftBulk or rightBulk Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt mediaExchange xml lt line gt lt line gt Query string lt line gt lt line gt action getTAPState lt line gt lt line gt TAP mainTop mainBottom leftBulk rightBulk lt line gt lt line gt drawerNumber 1 14 optional default 1 lt line gt lt usage gt lt syntaxError gt 79 April 2015 XML Command Reference Spectra Tape Libraries Chapter 11 mediaExchange importExport Example Commands and Responses The following command mediaExchange xml action get TAPState amp TAPDevice mainTop amp drawerNumber 1 retrieves the status of the chamber in the top of the main frame TAP indicating that the top TAP chamber contains an LTO magaz
96. e of the parameter for which data is returned in the command responses In some cases the XML tabs delineate a group of related tags The formatting of the command response depends on the output device For clarity this command reference indents each hierarchical level of the XML tags 17 April 2015 XML Command Reference Spectra Tape Libraries CHAPTER 2 autosupport autosupport xml generateASL The autosupport xml command is used to generate a new AutoSupport Log ASL file or retrieve a previously generated ASL file ASL files are used during troubleshooting procedures and contain logs of specific library operations Command generate ASL this page getASLNames page 19 getASL page 20 Note See the AutoSupport chapter in your library s User Guide for detailed information about configuring and using AutoSupport Description Generates a new ASL file Syntax autosupport xml action generateASL Command Response The command returns the following XML formatted data lt autosupport gt lt status gt OK lt status gt lt message gt Started ASL creation Set progress in your query for status lt message gt lt autosupport gt Progress Use the autoSupport xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 18 Chapter 2 autosuppo
97. e on page 33 For each command variant of the base URL the chapter provides the command syntax definitions of all variables and parameters and the syntax error response It also provides an example of the command usage and the response Where appropriate the chapter also includes a command sequence that provides an example of how a sequence of XML commands and possibly operator actions at the physical library are used to perform a series of related operations Note Not all Tape Series libraries support all of the command variables and parameters In addition some commands are not supported by all libraries When a command or parameter is library specific that information is included in the description of the command This command reference uses the following conventions for describing the syntax and command response for each command All XML command base URLs begin with the following string IP Address g For clarity this string is not included in the syntax statement or the example for each command Depending on the browser you are using you may need to precede the XML command with http or if SSL is enabled for the library https Variables in the command syntax are shown as variable Do not include the bracket characters 1 when you type variables The response for a command is formatted using open and close XML tags lt tag name gt and lt tag name gt where each tag name corresponds to the nam
98. ediaExchange xml action importExport partition Partition 1 amp slotType IE amp TAPDevice leftBulk amp TeraPackOffsets 61 62 63 64 65 66 From the front of the bulk TAP wait for the bulk TAP door release button to illuminate solid green Press the bulk TAP door release button to open the bulk TAP door Insert six magazines into the chambers in the bulk TAP carousel When you place a magazine in the bulk TAP make sure that the textured surface on each side of the magazine is toward the inside of the library and that the guides on the sides of the magazine fit into the media guides on the media shelf Loading the magazines incorrectly or at an angle can result in damage to the carousel or the robotics Note Since no timeout was specified you have 10 minutes to press the button to open the bulk TAP door remove the magazines in the carousel and close the bulk TAP door After all of the magazines are loaded into the bulk TAP close the bulk TAP door firmly An audible click indicates that the door is latched closed The carousel rotates to the interior of the library and the transporter begins moving the magazines to the chambers specified by the TeraPackOffset values Run the following command to determine when the import operation is complete mediaExchange xml progress amp TAPDevice leftBulk Repeat the progress command as often as desired until the response is No Pending actions 85 April 2015 XML C
99. en Values yes no filterSwitchOpen Whether the frames filter interlock switch is open Values yes no frontSwitchOpen Whether the frames front interlock switch is open Values yes no safetyInterlockOpen Whether the frames safety interlock switch is open Values yes no frameIDInfo Frame numbers start with 80 for the main frame and are numbered in hexadecimal counting down to the left with the next frame being 7f and counting up to the right with the next frame being 81 driveFrameNumber The value of the drive frame switch 0 4 which is used to set the CAN addresses of all QIPs and drives The main frame is always drive frame 0 Not applicable for media service or bulk TAP frames switchedRailState The setting for the fixed rail Values ground 24 volts neither robotPowerEnabled Whether the robot has power enabled Values yes no internalLightsEnabled Whether the internal lights are enabled Values yes no externalLightsEnabled Whether the external lights are enabled TFinity libraries only Values yes no 64 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus This parameter Indicates controller frameManagementModule continued Environmentinfo fanPair Information for each fan pair controlled by the frame management continued module number The number for the fan pair Values 1 3 5 7 9 present Whether the fan is
100. er Port The port on the F QIP that provides Fibre Channel connectivity for SCSI drives The drive can be visible to the host through Port A Port B or both on the F QIP Values A B AB Address Fibre Channel address or SCSI ID for each direct attached drive Values Fibre Channel drives 0 through 125 for a fixed address or None to specify that the drive uses soft addressing Direct attached SCSI drives 0 through 15 for a wide SCSI bus Notes The drives parameter is omitted when configuring a cleaning partition When a drive is assigned as the driveExporter it is automatically included in the partition The ID values returned by the driveList xml command are the component identifiers for the drives currently installed in the library see driveList xml on page 24 The port parameter is only applicable to SCSI drives that use an F QIP to provide Fibre Channel connectivity to the host It is not supported for Fibre Channel SAS or direct attached SCSI drives The address parameter is only applicable to Fibre Channel and direct attached SCSI drives It is not supported for SAS or F QIP attached SCSI drives If the drive has two Fibre Channel ports only one port at a time can be used The drive detects the first port to have an active connection and applies the address settings to that port For direct attached SCSI drives make sure that the SCSI ID you specify is not assigned to any other devices on the
101. er 4 driveList no Description Returns detailed information about each of the drives in the parameters library or list syntax arivenist xml action 1ist Command Response The command returns the following XML formatted data lt driveList gt lt drive gt lt ID gt value lt ID gt lt driveStatus gt OK impaired missing unknown lt driveStatus gt lt partition gt value lt partition gt lt driveType gt value lt driveType gt lt connection gt lt connectionStatus gt value lt connectionStatus gt lt hostID gt value lt hostID gt lt portID gt value lt portID gt lt connection gt lt serialNumber gt value lt serialNumber gt lt manufacturerSerialNumber gt value lt manufacturerSerialNumber gt lt driveFirmware gt value lt driveFirmware gt lt dcmFirmware gt value lt dcmFirmware gt lt wwn gt value lt wwn gt lt sparedWith gt value lt sparedWith gt lt spareFor gt value lt spareFor gt lt sparePotential gt value lt sparePotential gt lt health gt value lt health gt lt firmwareStaging gt lt firmware gt value lt firmware gt lt complete gt yes no lt complete gt lt percentStaged gt value lt percentStaged gt lt committing gt yes no lt committing gt lt firmwareStaging gt lt drive gt lt drive gt lt drive gt lt driveList gt 25 April 2015 XML Command Reference Spectra Tape Libraries Chapter 4 driveList
102. er of seconds to wait before restoring power 0 forever lt line gt lt usage gt lt syntaxError gt Example Command and Response The following command powerOff xml numSecondsToRemainOff 60 powers off the library and then powers it back on again after 60 seconds 134 April 2015 XML Command Reference Spectra Tape Libraries CHAPTER 19 robotService robotService xml returnFrom Service The robotService xml command causes a TFinity library to send a robot to service or return a robot from service Topic returnFrom Service page 135 send To Service page 136 Description Move a TFinity robot from the service bay to operation in the library The service safety door must be open or the command will fail Note The command does not open the service safety door or instruct the operator to open the service safety door before the robot moves If the door is closed the command fails Syntax robotService xml action returnFromService robot 1 2 where the value for This parameter Indicates robot The number of the robot in the library Numbering is from left to right as viewed from the front of the library Values 1 The left robot as viewed from the front of the library 2 The right robot as viewed from the front of the library Command Response The command immediately returns the following XML formatted data lt robotService gt lt message gt St
103. erSupplyInPowerSupplyFRU Information for each power supply nominalVoltage The expected output from the power supply Values 5 12 24 actualVoltage The measured output from the power supply actualCurrentInAmps The measured current in Amps not applicable for 24 volt supplies April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus This parameter Indicates controller Environmentinfo continued powerControlModule Can be configured to supply Dual or Parallel AC power to the power supplies Along with supplying power to the power supplies the PCM monitors output voltage output current and PCM operational temperature ID The component identifier for the power module using the form FRx PCM where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames PCM Power Control Module parallelACPresent Whether the library has an optional parallel AC power module This module provides AC power to two separate banks of 5 12 volt and 24 volt supplies Values yes no primaryACPresent Whether power is connected to the primary AC input Values yes no secondaryACPresent Whether power is connected to the secondary AC input Values yes no supplyDetectionWorking Indicates if the library is able to communicate with the PCM IO expander Values yes no
104. ers to configure the other partitions If you licensed all of the chambers in the library and want to use a cleaning partition you must also subtract the number of chambers you want to use for the cleaning partition from the total number of chambers available to be assigned to the storage pool If you have not licensed all of the chambers in the library the unlicensed chambers are available for use in cleaning partitions 17 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies numEESlots The number of slots to be used for the partition s entry exit pool Values 0 through n 1 where n is the maximum number of licensed slots in the library A Important For libraries that use TeraPack magazines the number of slots assigned to the entry exit pool must be a multiple of the number of slots per magazine For an LTO partition the number of slots must be a multiple of 10 fora TS11x0 technology partition the number of slots must be a multiple of 9 A Important If you specify a number of slots that is greater than the licensed number of slots the command will fail Notes Although using an entry exit pool for each storage partition is considered optional an entry exit pool with at least one chamber is required for some library operations and is strongly recommended The numEESlots parameter is omitted when configuring a cleaning partition
105. es after the partition is created Values USB Saves the file to a USB device that is connected to the LCM emailRecipient The email address of an already configured mail recipient to whom the library will email the configuration backup file Notes If you want to save the configuration backup file that the library generates after the partition is created to a USB device make sure that the USB device is connected to the LCM before running the command Do not send the configuration backup file to autosupport spectralogic com Spectra Logic does not save emailed configuration files unless they are specifically requested for troubleshooting See Configure Mail Users in you library s User Guide for information about configuring mail users 102 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition Command Response The command returns the following XML formatted data lt partition gt lt status gt OK lt status gt lt message gt Started automatic partition creation Set progress in your query for status lt message gt lt library gt Progress Use the partition xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt
106. es not have a bulk TAP installed on the side specified by the parameter value When the command response is No Pending Actions the clean operation for the specified bulk TAP is complete Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt mediaExchange xml lt line gt lt line gt Query string lt line gt lt line gt action clean lt line gt lt line gt partition partition name lt line gt lt line gt TAPDevice main leftBulk rightBulk lt line gt lt usage gt lt syntaxError gt Example Command and Response The following command mediaExchange xml action clean amp parition Partition 1 amp TAPDevice leftBulk checks the left bulk TAP to make sure it is empty and that the door is locked If the bulk TAP contains one or more magazines the magazines are moved to storage chambers in Partition 1 Issue a mediaExchange xml progress amp TAPDevice leftBulk command to determine when the clean operation is complete getTAPState Description Requests the status of the specified TAP Syntax mediaExchange xml action getTAPState amp TAPDevice mainTop mainBottom leftBulk rightBulk amp drawerNumber value 77 April 2015 XML Command Reference Spectra Tape Libraries Chapter 11 mediaExchange where the value for This parameter Specifies TAPDevice The TAP for which status is being requested Values mainTop The to
107. essage gt error message text lt message gt lt usage gt lt line gt traces xml lt line gt lt line gt Query string lt line gt lt line gt action getCanLog lt line gt lt line gt name lt canLogName gt lt line gt lt usage gt lt syntaxError gt Example Command The following command traces xml action getCanLog amp name 12_03_20 zip returns a zip file containing the CAN logs that were collected on March 20 2012 Description Returns a list of the zip files containing QIP logs that are currently stored in the LCM The QIP logs generated each day are zipped and stored on the hard drive in the LCM Each zip filename includes the date it was created The getQIPLogNames command is only supported for libraries that are using the Spectra LS module as the LCM Issuing this command to a library that uses a Spectra PC as the LCM returns an empty list Syntax traces xml action getQIPLogNames Command Response The command returns the following XML formatted data lt traces gt lt qipLogNames gt logName gt QIP_yy_mm_dd zip lt logName gt A lt logName gt QIP_yy_mm_dd zip lt logName gt lt qipLogNames gt lt traces gt 147 April 2015 XML Command Reference Spectra Tape Libraries Chapter 23 traces where the value for This parameter Indicates logName The name of the file containing the zipped set of QIP log files Values QIP_yy_mm_dd zip wher
108. formation about the Spectra Tape Series libraries and their drives refer to the publications listed in this section Product Status The Spectra Logic Technical Support portal provides information about which products are currently supported and which are considered discontinued To view information about discontinued products log into the portal see your library s User Guide open the Knowledge Base and search using the term discontinuance About This Guide Related Information Spectra Tape Series Libraries This command reference and the following documents related to the Spectra Tape Series libraries are available as PDF files on the Spectra Logic website at https support spectralogic com documentation The User Guide for each library describes configuring operating troubleshooting and maintaining the library and its drives The Quick Reference Guide for each library provides a quick reference for the user interface and instructions for performing day to day library operations such as powering on and off and preparing importing and exporting media The BlueScale Toolbar Option Map provides a quick reference for locating the options and commands available through the BlueScale user interface The Release Notes and Documentation Updates for each library provide the most up to date information about the library drives and media Note The release notes are only available on the Spectra Logic Support port
109. full gt lt storageSlot gt lt entryExitSlot gt lt id gt 4625 lt id gt lt offset gt 52 lt offset gt lt full gt no lt full gt lt entryExitSlot gt lt drive gt lt id gt 256 lt id gt lt offset gt 1 lt offset gt lt barcode gt 031795L4 lt barcode gt lt isQueued gt no lt isQueued gt lt full gt yes lt full gt lt drive gt lt drive gt lt id gt 257 lt id gt lt offset gt 2 lt offset gt lt full gt no lt full gt lt drive gt lt partition gt lt inventory gt April 2015 XML Command Reference Spectra Tape Libraries 53 libraryStatus xml no parameters CHAPTER 8 libraryStatus The libraryStatus xml command returns status information for the library Topic no parameters below refreshECInfo page 70 refresh Environment page 71 Description Returns the library type serial number component status and engineering change level information for the library that received the command Syntax libraryStatus xml Command Response The command immediately returns the following XML formatted data lt libraryStatus gt lt libraryType gt TFinity T950 T680 T380 T200 T120 lt libraryType gt lt railPowerOn gt yes no lt railPower0n gt lt robot gt lt number gt 1 2 lt number gt lt state gt inService impaired good unknown lt state gt lt serviceFrame gt left right none unknown lt serviceFrame gt lt topHAXGe
110. g partition is assigned The cleaning partition name is case sensitive encryption Note The type of encryption if any enabled in the partition type is the type of encryption used BlueScale encryption using a QIP BlueScale encryption using an encryption enabled drive or Spectra TKLM encryption Values QIPBasedBlueScale DriveBasedBlueScale SpectraTKLM encryptionKey is the moniker of the encryption key assigned to a partition if type QIPBasedBlueScale or DriveBasedBlueScale decryptionKey is the list of monikers for the decryption keys assigned to a partition if type QIPBasedBlueScale or DriveBasedBlueScale Note A maximum of eight decryption keys can be assigned to a single partition moveOptionType Whether or not the partition is configured to use a virtualized cartridge inventory to speed moves to and from slots and drives Values default virtual Note This parameter only applies to TFinity libraries Syntax Error Response None 10 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition Example Command and Response The following command partition xml action list returns the following data for a T120 library with a single LTO storage partition named Partition 1 100 storage slots 8 entry exit slots the robotic control path provided by the only drive in the library no encryption enabled QuickScan with drives in the partition enabled no global
111. ges retrieving 140 to 142 severity classifications 141 systemMessages xml no parameters 140 to 142 base URL overview 140 7 taskList xml no parameters 143 to 144 base URL overview 143 technical support contacting 4 traces available types 150 retrieving 149 to 151 traces xml base URL overview 145 getCanLog 146 to 147 getCanLogNames 145 to 146 getQIPLog 148 to 149 getQIPLogNames_ 147 to 148 traceType 149 to 151 typographical conventions 11 16 to 17 U utils xml base URL overview 152 lockTensionRods 152 removeAllLibraryPartitions 1 53 resetInventory 154 resetLCM 155 resetRobot 155 selectiveSnowplow 156 verifyMagazineBarcodes 157 W website Spectra Logic 4 World Wide Name WWN Fibre Channel or SAS drives 28 X XML command interface general command syntax 13 XML command interface using asynchronous command processing 15 to 16 case sensitive syntax 14 checking command progress 15 to 16 command categories 13 connectivity requirements 12 creating scripts 13 issuing commands to library 13 log into library 14 72 to 73 overview 12 progress query syntax 15 to 16 system error syntax 16 typographical conventions 11 April 2015 60 XML Command Reference Spectra Tape Libraries
112. ground operation indicated by the name parameter in the task section of the response data Syntax Error Response None Example Command and Response The following command taskList xml lt taskList gt lt currentAsynchronousAction gt lt name gt MOVE_ELEMENTS lt name gt lt status gt ACTIVE lt status gt lt currentAsynchronousAction gt lt taskList gt 144 April 2015 XML Command Reference Spectra Tape Libraries traces xml getCanLog Names A Important CHAPTER 23 traces The traces XML command retrieves the CAN logs QIP logs and other traces stored on the library s LCM Spectra Logic uses these logs and traces to help diagnose problems with the library You only need to capture traces when instructed to do so by Spectra Logic Technical Support See Capturing Traces in your library s User Guide for additional information about the traces and logs Topic getCanLog Names this page getCanLog page 146 getQIPLog Names page 147 getQIPLog page 148 traceType page 149 Description Returns a list of the zip files containing the CAN logs that are currently stored in the LCM The CAN logs collected for each day are zipped and stored on the hard drive in the LCM Each zip filename includes the date it was created The getCanLogNames command is only supported for libraries that are using the Spectra LS module as the LCM Issuing this command t
113. guring mail users Do not send the configuration backup file to autosupport spectralogic com Spectra Logic does not save emailed configuration files unless they are specifically requested for troubleshooting If you want to save the configuration backup file that the library generates after the partition is created to a USB device make sure that the USB device is connected to the LCM before running the command Command Response The command returns the following XML formatted data lt library gt lt message gt Started partition creation Set progress in your query for status lt message gt lt library gt Progress Use the partition xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 123 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt partition xml lt line gt lt line gt Query string lt line gt lt line gt action new lt line gt lt line gt parition paritition namel lt line gt lt line gt type LTO LTO Cleaning TS11x0 TS11x0 Cleaning Super AIT Super DLT lt line gt lt line gt cleaningPartition partition name optional lt line gt
114. hannel ports only one port at a time can be used The drive detects the first port to have an active connection and applies the address settings to that port For direct attached SCSI drives the SCSI ID you specify must not be assigned to any other devices on the same SCSI bus Assigning the same SCSI ID to multiple devices will cause communication problems on the bus See the Architecture and the Configuring and Managing Partitions chapters in your library s User Guide for detailed information about drive component identifiers and addressing gt gt gt gt 16 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies globalSpares optional The component identifiers for the drives that will be used as Global Spare drives for the partition using the form FRx DBAx DRVax See DriveID on page 116 fora description of the parameters in the component identifier A Important Do not use the drive specified in the driveExporter parameter or any of the drives listed in the drives parameter or the command will fail Notes The globalSpares parameter is omitted when configuring a cleaning partition The globalSpares parameter is omitted if you do not want to configure one or more Global Spare drives for the partition The globalSpares parameter is not valid for SCSI drives The command can contain a comma separated list of Drive ID parame
115. he component identifier when the module is in a library that supports multiple frames PCM Power Control Module PowerSupplyx The number of the power supply module in the PCM Values 1 2 3 4 5 6 7 5 12 volt supplies 8 9 24 volt supplies inputPowerOkay Whether the input voltages to the power supply module are within normal ranges Values yes no outputPowerOkay Whether the output voltage s from the power supply module are within normal ranges Values yes no temperatureWarning Whether the power supply module has indicated a temperature warning greater than 140 F 60 C Values yes no temperatureAlarm Whether the power supply module has indicated a temperature alarm greater than 147 F 64 C Values yes no modelNumber The model number of the part manufacturerPartNumber The manufacturer s part number serial Number The serial number of the part modLevel The modification level for the part manufacturer The manufacturer of the part countryOf Manufacturer The country where the part was manufactured temperatureInCelsius The measured temperature in Celsius communicatingWithPCM Whether the power supply module is communicating with the power control module Values yes no fanInPowerSupply Information for each fan in the module number the number of the fan Values 1 2 3 okay Whether the fan is operating correctly Values yes no pow
116. he drive connection Values Connected to Host The drive is configured to be connected to the host using a direct attached connection Connected to Port The drive is configured to be connected to the host through an F QIP port Not Connected The drive is not configured to be connected to the host Unknown The status of the drive connection is unknown serialNumber The location based serial number assigned to the drive while it is in the library This is the serial number reported to the host for the drive Using a location based serial number makes it possible to replace one drive with another without having to reconfigure the storage management software that accesses the drive EXAMPLE In the example command response on page 29 the reported serial number for the first drive is 1011000EC2 manufacturerSerial Number The serial number assigned to the physical drive by the drive manufacturer This serial number is shown in MLM and DLM reports and is also used for tracking the drives when they are not inside the library Note This parameter is set to Unavailable if the library is unable to retrieve the manufacturer s serial number from the drive EXAMPLE In the example command response on page 29 the manufacturer serial number for the first drive is 10380861 driveFirmware The firmware version in use by the drive Values version The firmware version currently in use by the drive Unknown
117. he library and that the guides on the sides of the magazine fit into the media guides on the media shelf Loading the magazines incorrectly or at an angle can result in damage to the carousel or the robotics Note To ensure that you place the magazine in the same location that it originally occupied in the carousel remove one magazine at a time During an import using the bulk TAP the transporter moves the magazines from the bulk TAP to the specified inventory locations in the selected partition If you insert more magazines than the number of values for the TeraPackOffsets parameter the extra magazines will be left in the carousel You must then run the mediaExchange xml clean command for the partition and bulk TAP to remove the magazines before you can perform another import or export operation Syntax mediaExchange xml action importExport partition partition name amp slotType storage IE amp TAPdevice main leftBulk rightBulk amp timeout InMinutes value amp TeraPackOffsets n n n where the value for This parameter Specifies partition The exact name of the partition into which you want to import or export the magazines Use the partitionList xml command to retrieve a list of all the partitions currently configured in the library see partitionList xml on page 126 Notes The partition name is case sensitive The partition name is set when the partition is cre
118. his parameter Indicates doorOpen Whether the TAP door is open Values true false magazinePresent Whether a magazine is present in the specified chamber Values true false Note For the leftBulk and rightBulk command parameters the value for the magazinePresent parameter is only accurate when the value for the rotaryPosition parameter is RobotSide That is the bulk TAP carousel must be facing the interior of the library before the magazine states can be determined April 2015 XML Command Reference Spectra Tape Libraries Chapter 11 mediaExchange This parameter Indicates magazineSeated Whether the magazine is properly seated in the chamber Values true false Notes The magazineSeated parameter is only returned if the value for the magazinePresent parameter is true For the leftBulk and rightBulk command parameters the value for the magazineSeated parameter is only accurate when the value for the rotaryPosition parameter is RobotSide That is the bulk TAP carousel must be facing the interior of the library before the magazine states can be determined magazineType The magazine type Values LTO LTO Maintenance SDLT SAIT TS11x0 TS11x0 Maintenance Unknown Notes The magazineType parameter is only returned if the value for the magazinePresent parameter is true and the TAPDevice is leftBulk or rightBulk The SDLT and SAIT drives ar
119. idges if available Note Empty locations are not included in the list but can be identified by the gaps in the offset values returned by the command Syntax physInventory xml partition partition name where the value for This parameter Specifies partition The exact name of the partition for which you want a physical inventory list Notes Use the partitionList xml command to retrieve a list of all the partitions currently configured in the library see partitionList xml on page 126 Partition names are case sensitive The partition name is set when the partition is created See partition xml on page 101 for information about using the XML command interface to configure partitions in the library 127 Chapter 17 physInventory Command Response The command immediately returns the following XML formatted data lt physInventory gt lt partition gt lt name gt paritition name lt name gt lt storage gt lt magazine gt lt offset gt value lt offset gt lt barcode gt value lt barcode gt lt frameNumber gt value lt frameNumber gt lt tapeBayNumber gt value lt tapeBayNumber gt lt drawerNumber gt value lt drawerNumber gt lt slot gt lt number gt value lt number gt lt barcode gt value lt barcode gt lt slot gt lt magazine gt lt storage gt lt entryExit gt lt magazine gt lt offset gt value lt offset gt lt barcode gt
120. ine lt mediaExchange gt lt doorOpen gt false lt doorOpen gt lt magazinePresent gt true lt magazinePresent gt lt magazineSeated gt true lt magazineSeated gt lt magazineType gt LTO lt magazineType gt lt rotaryPosition gt Unknown lt rotaryPosition gt lt mediaExchange gt The following command mediaExchange xml action getTAPState amp TAP leftBulk amp drawerNumber 12 retrieves the status of chamber 12 in the left bulk TAP indicating that the chamber contains an LTO magazine and that the bulk TAP carousel is rotated to face the interior of the library lt mediaExchange gt lt doorOpen gt false lt doorOpen gt lt magazinePresent gt true lt magazinePresent gt lt magazineSeated gt true lt magazineSeated gt lt magazineType gt LTO lt magazineType gt lt rotaryPosition gt RobotSide lt rotaryPosition gt lt mediaExchange gt Description Imports magazines into or exports them from the specified partition using the specified TAP Requirements When using this command keep the following requirements in mind The direction of the move is determined by whether the first location specified in the list of TeraPackOffsets is empty or full If the first location is full the moves performed by the command are export operations If the first location is empty the moves performed by the command are import operations For a single command all of the locations specified by the values for the TeraPac
121. ing and Managing Partitions chapter in your library s User Guide for detailed information about configuring data and cleaning partitions Note Use the partitionList xml command to retrieve a list of the partitions currently configured on the library see partitionList xml on page 126 Topic autoCreate page 101 delete page 104 list page 106 new page 112 Description Automatically creates a single storage partition that uses all the chambers or slots in the T120 library that are enabled by the CoD key and all installed drives Requirements and Guidelines When preparing to use this command keep the following requirements and guidelines in mind This command can only be used if the library does not currently have any partitions configured If there are already partitions configured on the library the command will fail All of the drives and controllers RIMs or F QIPs installed in the library must be of the same technology and use the same interface For example if one drive is a Fibre Channel LTO drive then all of the drives must be Fibre Channel LTO drives With the exception of the T120 library one chamber in the library is reserved for the partition s entry exit pool As a result the number of chambers assigned to the storage pool is one fewer than the total number of chambers enabled by the CoD key For the T120 library the eject mode is set to Standard 101 Chapter 15 parti
122. ion gt lt driveType gt IBM Ultrium TD3 Fibre lt driveType gt lt librarySerialNumber gt 1012000EC2 lt librarySerialNumber gt lt manufacturerSerialNumber gt 10241727 lt manufacturerSerialNumber gt lt driveFirmware gt 93G0 lt driveFirmware gt lt dcmFirmware gt 4 7 0 lt dcmFirmware gt lt wwn gt 21 12 00 90 A5 00 OE C2 lt wwn gt lt health gt Green lt health gt lt drive gt lt driveList gt 29 April 2015 XML Command Reference Spectra Tape Libraries Chapter 4 driveList generateDrive Traces Description Generate a new drive trace file Syntax driveList xml action generateDriveTraces amp driveTracesDrives AllDrives Drive ID Drive ID where the value for This parameter Specifies driveTracesDrives The drive s you want to generate a drive trace Values AllDrives Drive ID x where AllDrives Generate traces for all LTO 5 and higher drives and TS1140 and higher drives Drive ID Is the component identifier for the drive you want to generate a drive trace using the form FRx DBAx interface technology DRVx where FRx The number of the frame Only used when the drive is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the drive Not used with the T120 library interface The interface used by the drive Values f Fibre Channel s Serial Attached SCSI
123. ire a reboot EXAMPLE In the command response on page 93 the value for the rebootInProcess parameter is false indicating that the update did not require a reboot of the LCM and RCM Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt package xml lt line gt lt line gt Query string lt line gt lt line gt action update getResults lt line gt lt usage gt lt syntaxError gt 92 April 2015 XML Command Reference Spectra Tape Libraries Chapter 13 package update A Important A Important Example Command and Response The following command package xml action getResults returns the following information for the example shown on page 96 lt package gt lt updateResults gt lt packageName gt BlueScale12 1 0 20120423F lt packageName gt lt component gt lt name gt LC OS lt name gt lt previousVersion gt 100 4 0 0 lt previousVersion gt lt updatedVersion gt 100 5 0 0 lt updatedVersion gt lt updateStatus gt OK lt updateStatus gt lt component gt lt component gt lt name gt LC Server lt name gt lt previousVersion gt 4 7 0 27 lt previousVersion gt lt updatedVersion gt 4 8 0 59 lt updatedVersion gt lt updateStatus gt OK lt updateStatus gt lt component gt lt component gt lt name gt LC Web Server lt name gt lt previousVersion gt 4 7 0 27 lt previousVersion gt lt updatedVersion
124. ironment Action Set progress in your query for status lt message gt lt status gt OK lt status gt lt libraryStatus gt Progress Use the libraryStatus xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt libraryStatus xml lt line gt lt line gt Query string lt line gt lt line gt action refreshECInfo refreshEnvironment lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt 71 April 2015 XML Command Reference Spectra Tape Libraries login xml username CHAPTER 9 login The login xml command is used to log a user into the library for the purpose of issuing additional XML commands to the library and checking the status of previously entered commands Description Connects to the library using the specified username and password See Configuring Library Users in your library s User Guide for information about configuring users and passwords as well as information about what sort of actions each user type can perform The connection to the library is automatically closed after the idle time specified through the BlueScale user interface System Setup screen see Auto Logout
125. it cannot be canceled Do not power off the library or any component during the update process Command Response The command returns the following XML formatted data indicating whether the package command ran successfully lt package gt lt status gt OK lt status gt lt message gt Started firmware update Set progress in your query for status lt message gt lt package gt Progress Use the package xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 95 April 2015 XML Command Reference Spectra Tape Libraries Chapter 13 package Retrieve the results and complete the update operation using one of the following methods If the command did not include the autoFinish parameter issue an update xml action getResults command to retrieve the results for the update and if necessary reboot the library to complete the update see getResults on page 91 for more information Updates do not take effect until the library completes the update process and if necessary reboots the LCM and any other components that were updated If you did not include the autoFinish parameter in the command you must send a package xml action getResults command in order to complete the update process See getResults on page 91 for more information If the command included the autoFini
126. kOffsets parameter must either be all empty or all full A single command cannot mix imports and exports Use the phyInventory xml command to determine the status of each inventory location in the partition see physInventory xml on page 127 80 April 2015 XML Command Reference Spectra Tape Libraries Chapter 11 mediaExchange A Important A Important No user intervention is possible while the command is being processed Before running the command issue the clean command mediaExchange xml action clean amp partition Partition name for the bulk TAP you plan to use see clean on page 75 The clean command ensures that the selected bulk TAP is empty and that the bulk TAP door is closed If the carousel contains magazines from a previous export or import operation the command will fail You must run the mediaExchange xml action clean command to empty the bulk TAP before you attempt the next import or export operation see clean on page 75 If you are exchanging magazines remove each magazine from the carousel and replace it with another one of the same type If you are exchanging cartridges remove the magazines from the carousel one at a time make the desired cartridge exchanges and then put the magazine back into the same location that it originally occupied When you place a magazine in the bulk TAP make sure that the textured surface on each side of the magazine is toward the inside of t
127. l progress Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt driveList xml lt line gt lt line gt Query string lt line gt lt line gt action generateDriveTraces lt line gt lt line gt driveTracesDrives Drive ID lt line gt lt line gt driveTracesGet Type lt email download saveToUSB gt lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt Example Command The following command generates a drive trace for drive 1 in DBA1 of frame 1 driveList xml action generateDriveTraces amp driveTracesDrives FR1 DBA1 fLTO DRV1 Description Retrieves the last drive trace file generated by the generateDriveTraces action see generateDriveTraces on page 30 Syntax driveList xml action getDriveTraces amp driveTracesGetType email download saveToUSB amp emailAddress Mail Recipient where the value for Specifies Where you want to save the drive trace file Values email Sends the file to the mail recipient specified by emailAddress download Downloads the file to the computer you are using to access the library save ToUSB Saves the file to a USB device that is connected to the LCM Note If you want to save the drive trace file to a USB device make sure that the USB device is connected to the LCM before running the command emailAddress The email
128. leshooting and maintaining the library Topic lockTension Rods page 152 removeAll Library Partitions page 153 reset Inventory page 154 resetLCM page 155 resetRobot page 155 selective Snowplow page 156 verify Magazine Barcodes page 157 Description Changes whether the tension rods are locked or can disengage when it is necessary for one TeraPorter in a TFinity library to push the other TeraPorter into it s service bay Note Do not change the behavior of the tension rods unless specifically instructed to do so by Spectra Logic Technical Support Syntax utils xml action lockTensionRods state on off where the value for This parameter Indicates state Whether the tension rods are locked Values on The tension rods are always locked and will not disengage This is the libraries default behavior off The tension rods are unlocked and can disengage as necessary 152 Chapter 24 utils removeAll Library Partitions Command Response The command returns the following XML formatted data lt utils gt lt lockTensionRods gt lt status gt OK lt status gt lt lockTensionRods gt lt utils gt Progress Use the utils xml progress command to determine when the reset operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 Syntax Error Re
129. library is not at a specific package level then the value of the name parameter in the current section of the command response is None The BlueScale user interface also displays None for the BlueScale version shown on the status bar and in the output of the Get Firmware Versions utility EXAMPLE In the command example below the full name of the current BlueScale version is BlueScale12 0 3 20111122F list The version names of each BlueScale package currently stored on the library Note If there are no package files stored in the library the list section is not returned EXAMPLE In the command example below the following BlueScale versions are currently stored on the library memory card BlueScale12 0 3 20111122F and BlueScale11 3 3 20110316F Syntax Error Response None Example Command The following command package xml returns the current BlueScale package information lt package gt lt current gt lt name gt BlueScale12 0 3 20111122F lt name gt lt current gt lt list gt lt name gt BlueScale12 0 3 20111122F lt name gt lt name gt BlueScale1l1 3 3 20110316F lt name gt lt list gt lt package gt 90 April 2015 XML Command Reference Spectra Tape Libraries Chapter 13 package getResults AN Important Description Returns status information for the most recent BlueScale package update including all component firmware versions If the package included upda
130. lt unit gt lt reminder gt lt typeName gt Service HAX lt typeName gt lt severity gt low lt severity gt lt defaultThreshold gt 35950000 lt defaultThreshold gt lt currentThreshold gt 35950000 lt currentThreshold gt lt postedDate gt 2011 08 09 17 08 04 lt postedDate gt lt reminder gt lt subType gt 42 April 2015 XML Command Reference Spectra Tape Libraries Chapter 6 HHMData lt subType gt lt typeName gt Trip2 Robot 1 lt typeName gt lt value gt 9295692 lt value gt lt unit gt inches lt unit gt lt reminder gt lt typeName gt Check Contact Brushes lt typeName gt lt severity gt low lt severity gt lt defaultThreshold gt 46300000 lt defaultThreshold gt lt currentThreshold gt 46300000 lt currentThreshold gt lt postedDate gt None lt postedDate gt lt reminder gt lt subType gt lt subType gt lt typeName gt Life Robot 2 lt typeName gt lt value gt 25172883 lt value gt lt unit gt inches lt unit gt lt subType gt lt subType gt lt typeName gt Tripl Robot 2 lt typeName gt lt subType gt lt counter gt lt HHMData gt resetCounter Description Resets the specified HHM counter to zero A counter is Data typically reset to zero following the completion of the regularly scheduled standard maintenance of the component A Cauti Do not run this command unless you are specifically directed to do so by Spectra aurion Logic Su
131. ly necessary to indicate whether the partition will use Port A Port B or both entered as A B or A B respectively You do not need to include the addressing parameters in the command unless you want to change the current settings Changing the configuration settings for an F QIP port affects all partitions that use that F QIP port See the Architecture and the Configuring and Managing Partitions chapters in your library s User Guide for detailed information about component identifiers port addressing and drive visibility to the host EXAMPLE Setting the QIPList parameter to QIP1 A B QIP2 A B specifies that both ports on two QIPs will be used to provide drive visibility Because no configuration settings are included in the command both QIPs will use previously configured settings for Port A and Port B 122 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies saveLibrary Configuration optional Where you want to save the configuration backup file that the library generates after the partition is created Values USB Saves the file to a USB device that is connected to the LCM emailRecipient The email address of an already configured mail recipient to whom the library will email the configuration backup file Notes See Configure Mail Users in you library s User Guide for information about confi
132. magazines during 94 updating drive firmware during 94 April 2015 159 XML Command Reference Spectra Tape Libraries Index Q powerOff xml no parameters 133 to 134 base URL overview 133 PreScan export or exchange magazines during 94 updating drive firmware during 94 Q QIP logs error when using Spectra PC 147 names of available 147 to 148 retrieving 148 to 149 stored on Spectra LS 148 R RIM or F QIP use to provide robotic control path 114 to 115 robotic control path useadrive 116 use a RIM or F QIP 114 to 115 robotService xml base URL overview 135 returnFromService 135 sendToService 136 robotUtilization xml no parameters 139 base URL overview 138 S sales contacting 4 Spectra Logic contacting 4 manuals obtaining 10 storage partitions configuring assign and configure drives 109 119 assign and configure exporting controller 114 to 115 assign and configure exporting drive 116 storage partitions configuring continued assign and configure F QIPs for drive visibility 122 assign entry exit slots 118 assign Global Spare drives 109 117 assign name 114 assign storage slots 117 assign type 108 114 associate a cleaning partition 110 120 command example 125 configure entry exit port mode 109 118 enable MLM PreScan 120 enable MLM QuickScan 121 requirements and guidelines 112 save configuration 123 set MLM PostScan triggers 121 system messa
133. mand is supported on T200 T380 T680 T950 and TFinity libraries Syntax utils xml action verifyMagazineBarcodes Command Response The command returns the following XML formatted data lt utils gt lt verifyMagazineBarcodes gt lt status gt OK lt status gt lt message gt verifyMagazineBarcodes started Set progress in your query for status lt message gt lt verifyMagazineBarcodes gt lt utils gt Progress Use the utils xml progress command to determine when the reset operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt utils xml lt line gt lt line gt Query string lt line gt lt line gt action lockTensionRods removeAllLibraryPartitions resetLCM resetRobot resetInventory selectiveSnowplow verifyMagazineBarcodes lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt 157 April 2015 XML Command Reference Spectra Tape Libraries A autosupport xml base URL overview 18 generateASL 18 to 19 getASL 20 getASLNames 19 backups stop before updating library software 94 BlueScale software See library software bulk TAP chamber numbering 81 configure timeout 82 prepare for use 75 to 77 81 77 to 80 use f
134. mmand prepares the Fibre Channel drive in drive bay 1 of DBA1 located in frame 1 of a T950 library to be replaced driveList xml action prepareToReplaceDrive amp driveName FR1 DBA1 fLTO DRV1 The following command prepares the Fibre Channel drive in drive bay 1 of DBAS of a T380 library to be replaced driveList xml action prepareToReplaceDrive amp driveName DBA3 fLTO DRV1 34 April 2015 XML Command Reference Spectra Tape Libraries Chapter 4 driveList resetDrive Description Resets the specified drive by power cycling it Syntax driveList xml action resetDrive amp driveName drive to reset where the value for This parameter Specifies driveName The component identifier of the drive you want to reset using the form FRx DBAx interface technology DRVx where FRx The number of the frame Only used when the drive is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the drive Not used with the T120 library interface The interface used by the drive Values f Fibre Channel s Serial Attached SCSI SAS blank SCSI technology The technology used by the drive Values LTO TS11x0 SDLT SAIT DRVx The number of the drive bay in the DBA as viewed from the back of the library For all libraries except the T120 the value of x can be 1 through 4 For the T120 library the value of x can be
135. mplete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 105 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition list Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt partition xml lt line gt lt line gt Query string lt line gt lt line gt action delete lt line gt lt line gt parition paritition name lt line gt lt line gt saveLibraryConfiguration USB emailRecipient optional lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt Example Command and Response The following command partition xml action delete amp partition Partition 1 amp saveLibraryConfiguration JaneSuperuser YourCompany com deletes the partition named Partition 1 and emails the configuration backup file to the mail user JaneSuperuser YourCompany com Description Lists all existing partitions including details such as partition type size assigned drives etc Syntax partition xml action list Command Response The command returns the following XML formatted data lt partition gt lt partitionData gt lt name gt partition name lt name gt lt type gt LTO LTO Cleaning TS11x0 TS11x0 Cleaning Super AIT Super DLT lt type gt lt emulation gt emulation type
136. n Status and Report Commands in this category perform operations such as returning the operational status of the library components library operating parameters performance metrics current configurations and cartridge inventory These commands do not modify any system states Control Commands in this category perform operations such as moving tapes from one element in the library to another performing BlueScale updates collecting traces running utilities and powering off the library Issuing Commands A standard programming language such as Java Perl or Python can be used to send a series of XML commands to the library In addition to sending the XML commands the programs can parse the XML formatted data that the library returns as the command response and interpret any output generated by the command Command Syntax All of the XML commands use standard web URL structure The general syntax for an XML command is IP Address gf command URL parameter 1 value amp parameter 2 value amp amp parameter n value where IP Address The IP address of the library gf The name of the directory where the webserver used for command processing resides command URL The base URL of the XML command 13 April 2015 XML Command Reference Spectra Tape Libraries Chapter 1 Overview Using the XML Command Interface parameter 1 through parameter n Parameters who
137. n also use the package xml command to retrieve the name of the BlueScale package currently being used by the library as well as a list of all of the BlueScale package files currently stored on the memory card in the LCM including the one currently in use Topic no parameters or list this page getResults page 91 update page 93 Updating the Library BlueScale Software page 97 Description Retrieves the name of the BlueScale package currently being used by the library The data returned by the command also lists all of the BlueScale package files currently stored on the memory card in the LCM including the one currently in use Syntax package xml action list Command Response The command immediately returns the following XML formatted data lt package gt lt current gt lt name gt version name lt name gt lt current gt lt list gt lt name gt version name lt name gt lt name gt version name lt name gt lt list gt lt package gt 89 Chapter 13 package where the value for This parameter Indicates current The full version package name of the BlueScale software version currently running on the library The package name format is BlueScale n n nl YYYYMMDDIrelease type where n n n The version number YYYYMMDD The date of the BlueScale package release type Either an F for Full release or an I for Incremental release Note If the
138. n the bulk TAP you must run the mediaExchange xml action clean command to empty the bulk TAP and then repeat the original command Note The timeoutInMinutes parameter only applies to the current command TeraPackOffsets A comma separated list of the offset values for the magazines to be moved These offsets identify virtual locations in the partition inventory Values Use the physInventory xml action partition command to obtain the offset value for the inventory locations you want to use see physInventory xml on page 127 Note The full or empty state of the first location in the list determines whether an import or export operation will be performed The list must either contain all empty or all full locations Command Response The command returns the following XML formatted data lt mediaExchange gt lt message gt Media export import started for main leftBulk rightBulk TAP lt message gt lt status gt OK lt status gt lt mediaExchange gt When the bulk TAP door release button illuminates solid green press the button and insert remove or exchange the magazines or the cartridges in the magazines as required et 82 April 2015 XML Command Reference Spectra Tape Libraries Chapter 11 mediaExchange Progress If desired you can use the following command to monitor the progress of the importExport command see Progress for Asynchronous Commands on page 15 mediaExchange xml progre
139. nSpeedSetting gt ewFansCalibrated gt no lt newFansCalibrated gt newFilterCalibrated gt no lt newFilterCalibrated gt anInFCM gt lt number gt 1 lt number gt lt poweredOn gt yes lt poweredOn gt lt speedInRPM gt 4320 lt speedInRPM gt lt fanInFCM gt Fr FH Fh w pp We BS ATA IE ATAA AN OB A Fh lt lightBank gt lt number gt 1 lt number gt lt poweredOn gt yes lt poweredOn gt lt lightBank gt lt fanControlModule gt 68 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus lt frameManagementModule gt lt ID gt FR1 FMM lt ID gt lt frameIDInfo gt 0x80 lt frameIDInfo gt lt twentyFourVoltVoltage gt 23 914 lt twentyFourVoltVoltage gt lt fiveVoltVoltage gt 5 136 lt fiveVoltVoltage gt lt fanRailVoltage gt 13 847 lt fanRailVoltage gt lt switchedRailVoltage gt 23 914 lt switchedRailVoltage gt lt twentyFourVoltCurrentInAmps gt 4 525 lt twent yFourVoltCurrent InAmps gt lt powerConsumedInWatts gt 0 lt powerConsumedInWatts gt lt sampleRateInSeconds gt 2 lt sampleRateInSeconds gt lt samplesTaken gt 52 lt samplesTaken gt lt temperaturelnCelsius gt 24 lt temperaturelnCelsius gt lt EPMTemperaturelnCelsius gt 44 lt EPMTemperaturelnCelsius gt lt frameToFrameTemperaturelnCelsius gt 44 lt frameToFrameTemperaturelnCelsius gt frameToFrameAttached gt yes lt frameToFrameAttached gt frameT
140. ncryptionPassword password where the value for This parameter Specifies encryptionPassword The encryption user password The value for this parameter is blank if no password has been set Command Response The command immediately returns the following XML formatted data lt encryption gt lt status gt OK lt status gt lt encryption gt 37 Chapter 5 encryption Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt encryption xml lt line gt lt line gt Query string lt line gt lt line gt action login lt line gt lt line gt encryptionPassword encryption password lt line gt lt usage gt lt syntaxError gt Example Command The following command encryption xml action logintencryptionPassword encryptl logs into the encryption feature using the encryption password encrypt1 38 April 2015 XML Command Reference Spectra Tape Libraries CHAPTER 6 HHMData HHMData xml The HHMData xml command retrieves the current status of the Hardware Health Monitoring HHM counters for the library and lets you reset certain counters to zero after performing the necessary hardware maintenance procedures You can also set the threshold level at which certain counters send a reminder that maintenance is needed See View Hardware Health Monitoring HHM Data in your library s User Gui
141. nder Values Service HAX Check Contact Brushes TFinity library only Service HAX Belt all except T120 and TFinity libraries Service VAX Service VAX Belt Service VAX Cable T120 only Service Transporter all except T120 Service Required Notes The Life counter does not have a reminder threshold value associated with it and cannot be reset to zero For this reason the command response data for the Life counter does not include a reminder section Not all Trip1 and Trip2 subType counters have an associated reminder threshold value If the threshold for the subType counter has not been reached the reminder section is not present The reminder threshold values for the Trip1 and Trip2 subType counters are set using the setThresholdData command see setThresholdData on page 46 After the maintenance action indicated in the HHM reminder has been completed the current value of the reminder can be reset to zero see resetCounterData on page 43 April 2015 XML Command Reference Spectra Tape Libraries Chapter 6 HHMData This parameter Indicates severity The urgency of the reminder Values low medium high See Check and Respond to Messages in your library s User Guide for a description of these system messages EXAMPLE In the example command response on page 42 a Service HAX reminder was posted for the Trip1 counter on 2011 08 09 17 08 04 The reminder has a low severi
142. ntrol lers xml action list immediately returns the following XML formatted data lt control llers gt lt controller gt lt ID gt FR1 DBA6 F QIP1 lt ID gt lt status gt Normal lt status gt lt firmware gt 8 15 42 lt firmware gt lt type gt 2 Gbps FC RIM lt type gt lt port gt lt name gt B lt name gt lt useSoftAddress gt yes lt useSoftAddress gt lt loopId gt 0 lt loopId gt lt initiator Enabled gt Enabled gt no lt initiator lt fibreConnectionMode gt Automatic lt fibreConnect ionMode gt lt port gt lt port gt lt name gt A lt name gt lt useSoftAddress gt yes lt useSoftAddress gt lt loopId gt 0 lt loopId gt lt initiator Enabled gt Enabled gt no lt initiator lt fibreConnectionMode gt Automatic lt fibreConnect ionMode gt lt port gt lt controller gt lt controllers gt April 2015 XML Command Reference Spectra Tape Libraries 23 CHAPTER 4 driveList driveList xml The driveList xml command is used to identify the drives in the library and perform troubleshooting operations on a specific drive Note Refer to your library s User Guide for detailed information about the requirements for using and replacing drives in the library Command no parameters or list page 25 generateDriveTraces page 30 getDrive Traces page 31 prepareTo ReplaceDrive page 33 resetDrive page 35 24 Chapt
143. ntroller Environmentinfo continued frameManagementModule The frame management module located in the bottom front of each T950 and TFinity frame stores frame ID information and controls miscellaneous items like fans and lights ID The component identifier for the module using the form FRx FMM where FRx The number of the frame FMM Frame Management Module twentyFourVoltVoltage The measured voltage of the 24 volt input five VoltVoltage The measured voltage of the 5 volt input fanRail Voltage The measured fan rail voltage switchedRail Voltage The measured switch rail voltage twentyFourVoltCurrentInAmps The measured current for the 24 volt input powerConsumedInWatts The measured power consumed sampleRateInSeconds The sample rate in seconds samplesTaken The number of samples taken temperatureInCelsius The measured temperature in Celsius EPMTemperatureInCelsius The measured temperature of the service frame power module in Celsius TFinity libraries only frameToFrameTemperatureInCelsius The measured temperature of the frame to frame board in Celsius frameToFrameAttached Whether the frame to frame board cables are attached Values yes no frameToFrame5VoltEnabled Whether the frame to frame board 5 volt supply is enabled Values yes no fansEnabled Whether the frame management module fans are enabled Values yes no backSwitchOpen Whether the frames back interlock switch is op
144. nutes to press the button to open the bulk TAP door remove the magazines in the carousel and close the bulk TAP door Close the bulk TAP door firmly An audible click indicates that the door is latched closed The carousel rotates to the interior of the library and the transporter begins moving the magazines to the chambers specified by the TeraPackOffset values Run the following command to determine when the import operation in complete mediaExchange xml progress amp TAPDevice leftBulk Repeat the progress command as often as desired until the response is No Pending actions 86 April 2015 XML Command Reference Spectra Tape Libraries CHAPTER 12 optionKeys optionKeys xml add The optionKeys xml command adds a new option activation key to the library and lists all option keys currently active in the library See Enabling Bluescale Software Support Options And Upgrades in your User Guide for more information about option keys Topic add page 87 list page 87 Description Adds a new activation key to the library Syntax optionKeys xml action add key xey where the value for This parameter Indicates key The alphanumeric key for activating the option The key is not case sensitive list Command Response The command immediately returns the following XML formatted data lt optionKeys gt lt status gt OK lt status gt lt optionKe
145. o a library that uses a Spectra PC as the LCM returns an empty list Syntax traces xml action getCanLogNames Command Response The command immediately returns the following XML formatted data lt traces gt lt canLogNames gt lt logName gt latest zip lt logName gt lt logName gt yy_mm_dd zip lt logName gt lt logName gt yy_mm_dd zip lt logName gt lt canLogNames gt lt traces gt 145 Chapter 23 traces where the value for This parameter Indicates logName The name of the file containing the zipped set of CAN log files Values latest zip Contains the CAN log files for the current date The zip file is created at the time it is requested yy_mm_dd zip Contains the CAN log files that were generated on the date indicated in the filename where yy is the last two digits of the year mm is the two digit month and dd is the two digit day getCanLog A Important Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt traces xml lt line gt lt line gt Query string lt line gt lt line gt action lt getCanLogNames getCanLog getQIPLogNames getQIPLog gt lt line gt lt usage gt lt syntaxError gt Example Command and Response The following command traces xml action getCanLogNames returns the following XML formatted data containing the list of CAN logs currently avail
146. oFrame5VoltEnabled gt yes lt frameToFrame5VoltEnabled gt fansEnabled gt yes lt fansEnabled gt backSwitchOpen gt no lt backSwitchOpen gt filterSwitchOpen gt no lt filterSwitchOpen gt lt frontSwitchOpen gt no lt frontSwitchOpen gt lt safetyInterlockOpen gt no lt safetyInterlockOpen gt lt driveFrameNumber gt 0x7 lt driveFrameNumber gt lt switchedRailState gt 24Volt lt switchedRailState gt lt robotPowerEnabled gt yes lt robotPowerEnabled gt lt internalLightsEnabled gt yes lt internalLightsEnabled gt lt externalLightsEnabled gt yes lt externalLightsEnabled gt NAA AA lt fanPair gt lt number gt 1 lt number gt lt present gt yes lt present gt lt fanPair gt lt fan gt lt number gt 1 lt number gt lt speedInRPM gt 8280 lt speedInRPM gt lt fan gt lt controllerEnvironmentinfo gt lt ECInfo gt lt lt component gt lt ID gt LCM Spectra PC lt ID gt lt EC gt 5 lt EC gt lt serialNumber gt LS31133012 lt serialNumber gt lt toplLevelAssemblyEC gt 2 lt topLevelAssemblyEC gt lt topLevelAssemblySerialNumber gt lt date gt 08 22 2013 lt date gt lt component gt ECInfo gt lt libraryStatus gt 69 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus refreshECInfo
147. odule temperatureInCelsius The measured temperature in Celsius backPanelSwitch Whether the back panel switch is closed or open Values closed open fanPanelSwitch Whether the fan panel switch is closed or open Values closed open filterPanelSwitch Whether the filter panel switch is closed or open Values closed open frontTAPFramePanelSwitch Whether the front TAP frame panel switch is closed or open Values closed open boardVoltage The measured value of the 24 volt supply on the FCM fanInputVoltage The measured fan input voltage fanSpeedVoltage The measured fan speed voltage fanSpeedSetting The set fan speed newFansCalibrated This is no longer used It will always show a value of no newFilterCalibrated This is no longer used It will always show a value of no fanInFCM Information for each fan controlled by the fan control module number The number of the fan Values 1 2 3 4 5 6 7 8 9 10 on Whether the fan is on yes or off no Values yes no speedInRPM The measured speed of the fan lightBank Information for each light bank controlled by the fan control module number The number of the light bank Values 1 2 3 on Whether the light bank is on yes or off no Values yes no 63 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus This parameter Indicates co
148. ombine the settings from multiple BlueScale partition wizard screens The parameters following the initial action new parameter do not need to be entered in any specific order partition xml action new partition partition name amp type LTO LTO Cleaning TS11x0 TS11x0 Cleaning Super AIT Super DLT QIPExporter QIP ID robot visibilityl laddressing mode i driveExporter Drive ID address hardAddress robot visibility addressing mode hardAddress amp Drive ID address T globalSpares First Drive ID Last Drive ID amp numStorageSlots value amp CJ num ESlots value amp eeType standard queued shared amp drives First Drive ID portaddress Last Drive ID portaddress amp cleaningPartition partition name amp enablePrescan amp enableFullscan enableQuickScan inlineDrives globalSpareDrives amp scanAfter time valuewriteread time valuewriteread amp QIPList First QIP ID drive visibilityl laddressing mode E 3 hardAddress drive visibility addressing mode hardAddress scp Last QIP ID drive visibilityl laddressing mode Es hardAddress drive visibility addressing mode hardAddress amp saveLibraryConfiguration USB emailRecipient 113 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition where the val
149. ommand Reference Spectra Tape Libraries Chapter 11 mediaExchange mediaExchange xml importExport Export or Exchange Magazines or Cartridges Example 1 After performing the steps in Preparation on page 84 run the following command to export magazines from the storage pool for Partition 1 Note This example uses the data from the example command response for the physInventory xml partition Partition 1 command beginning on page 130 mediaExchange xml action importExport partition Partition 1 amp slotType storage amp TAPDevice leftBulk amp TeraPackOffsets 1 6 The library retrieves the two magazines and places them in the left bulk TAP carousel When all of the magazines have been retrieved or when the bulk TAP is full the carousel rotates to face the outside of the library and the door release button LED illuminates solid green From the front of the bulk TAP press the bulk TAP door release button to open the bulk TAP door Remove the magazines from the bulk TAP or make the desired cartridge exchanges When you place a magazine in the bulk TAP make sure that the textured surface on each side of the magazine is toward the inside of the library and that the guides on the sides of the magazine fit into the media guides on the media shelf Loading the magazines incorrectly or at an angle can result in damage to the carousel or the robotics 5 Note Since no timeout was specified you have 10 mi
150. or import export operation 82 status C CAN logs error when using Spectra PC 145 names of available 145 to 146 retrieving 146 to 147 stored on Spectra LS 146 center TAP See main frame TAP cleaning partitions configuring assign name 114 assign storage slots 117 assign type 108 114 requirements and guidelines 112 save configuration 123 contacting Spectra Logic 4 corporate headquarters Spectra Logic 4 D documentation obtaining for libraries 10 related to drive use 11 typographical conventions 11 16 to 17 driveList xml no parameters or list 25 to 29 base URL overview 24 generateDriveTraces 30 to 31 31 to 32 prepareToReplaceDrive 33 to 34 resetDrive 35 to 36 drives getDriveTraces assign as Global Spares 109 117 assign to a partition and configure 109 119 component identifier 26 connection type for T120 library 27 current firmware version 27 DCM firmware version 27 DM health status 28 download drive trace file 31 to 32 email drive trace file 31 to 32 firmware staging status 28 generate drive trace file 30 to 31 location based serial number 27 manufacturer serial number 27 partition assignment 26 prepare for replacement 33 to 34 reset 35 to 36 save drive trace file 31 to 32 sparing status 28 status reported by library 26 158 INDEX drives continued type identifier 27 use to provide robotic control path 116 World Wide Name
151. p chamber of the TAP in the main frame mainBottom The bottom chamber of the TAP in the main frame leftBulk The bulk TAP on the left end of the library rightBulk The bulk TAP on the right end of the library Notes For T200 and T380 libraries only the mainTop parameter value is supported The leftBulk and rightBulk parameter values are not supported by libraries that do not include a bulk TAP In addition the command fails if the library does not have a bulk TAP installed on the side specified by the parameter value drawerNumber Optional The chamber drawer in the specified TAP for which status is being requested Values 1 through 14 Default 1 Notes For the mainTop and mainBottom parameters the value for drawerNumber is always 1 The chambers in the bulk TAP carousel are numbered from right to left and top to bottom when viewed from the front of the library Command Response The command immediately returns the following XML formatted data lt mediaExchange gt lt doorOpen gt true false lt doorOpen gt lt magazinePresent gt true false lt magazinePresent gt lt magazineSeated gt true false lt magazineSeated gt lt magazineType gt LTO LTO Maintenance SDLT SAIT TS11x0 TS11x0 Maintenance Unknown lt magazineType gt lt rotaryPosition gt UserSide RobotSide Unknown Uninitialized lt rotaryPosition gt lt mediaExchange gt where the value for T
152. pe drives IBM Tape Device Drivers Installation and User s Guide Note This guide also provides information about using the IBM Tape Diagnostic Tool ITDT to troubleshoot drive problems IBM TotalStorage LTO Ultrium Tape Drive SCSI Reference LTO 1 through LTO 4 IBM TotalStorage LTO Ultrium Tape Drive SCSI Reference LTO 5 and LTO 6 For drive specific information search for the product name for example LTO 5 on the documentation page on the IBM website You can also search the IBM Support Portal at http www 947 ibm com support entry portal Documentation TS11x0 Technology Drives The following documents provide information that is applicable to TS11x0 technology drives IBM System Storage Tape Drive 3592 SCSI Reference IBM Tape Device Drivers Installation and User s Guide Note This guide also provides information about using the IBM Tape Diagnostic Tool ITDT to troubleshoot drive problems Typographical Conventions This command reference uses the following conventions to highlight important information Note Read text marked with Note for additional information or suggestions about the current topic Read text marked by the Important icon for information that will help you complete a procedure or avoid extra steps Read text marked by the Caution icon for information you must know to avoid damaging the library the tape drives or losing data Read text marked
153. ple command response on page 53 the barcode for the cartridge in the first storage slot listed is 83270L4 isQueued Whether the cartridge in the specified slot is queued for ejection from the library Values yes no Notes Queued ejects are only supported by the T120 library For all other libraries the value for this parameter is always no This parameter is only returned when the value for the full parameter is yes full Whether the slot or drive is full Values yes no Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt inventory xml lt line gt lt line gt Query string lt line gt lt line gt partition partition name lt line gt lt usage gt lt syntaxError gt April 2015 52 XML Command Reference Spectra Tape Libraries Chapter 7 inventory Example Command and Response The following command inventory xml partition Partition 1 retrieves the following cartridge inventory for a partition named Partition 1 lt inventory gt lt partition gt lt name gt Partition 1 lt name gt lt storageSlot gt lt id gt 4096 lt id gt lt offset gt 1 lt offset gt lt barcode gt 83270L4 lt barcode gt lt isQueued gt no lt isQueued gt lt full gt yes lt full gt lt storageSlot gt lt storageSlot gt lt id gt 4151 lt id gt lt offset gt 47 lt offset gt lt full gt no lt
154. pport Changing the counter values can result in components not receiving regularly scheduled maintenance when it is due Notes Only one subType counter of one HMM counter can be reset in each resetCounterData command To reset multiple counters you must issue separate commands The following syntax is for a TFinity library The syntax for other libraries does not include the robot parameter This command corresponds to the HHM Set Counters advanced utility in the BlueScale user interface Syntax HHMData xml action resetCounterDatattype Horizontal Axis Vertical Axis Picker Axis Toggle Axis Rotational Axis Side Axis Drive to Drive Move Drive to Slot Move Slot to Slot Move Slot to Drive Move TAP In Move TAP Out Move subType Tripl Trip2 None amp robot Robot 1 Robot 2 43 April 2015 XML Command Reference Spectra Tape Libraries Chapter 6 HHMData where the value for This parameter Specifies type The name of the HHM counter for which the subType counter specified by the command is to be reset Values Horizontal Axis Vertical Axis Picker Axis Rotational Axis Magazine Axis Toggle Axis Side Axis Drive to Drive Move Drive to Slot Move Slot to Slot Move Slot to Drive Move TAP In Move TAP Out Move EXAMPLE In the command example on page 45 the HMM counter to reset is Horizontal Axis subType The name of the subType counter to be reset Values Trip1 Trip2
155. pter 8 libraryStatus lt powerControlModule gt lt ID gt FR1 PCM lt ID gt lt parallelACPresent gt no lt parallelACPresent gt lt primaryACPresent gt no lt primaryACPresent gt lt secondaryACPresent gt no lt secondaryACPresent gt lt supplyDetectionWorking gt yes lt supplyDetectionWorking gt lt ACCurrent InAmps gt 0 lt ACCurrent InAmps gt lt primaryACVoltage gt 19 lt primaryACVoltage gt lt secondaryACVoltage gt 53 lt secondaryACVoltage gt lt twelveVoltVoltage gt 11 901 lt twelveVoltVoltage gt lt fiveVoltVoltage gt 4 931 lt fiveVoltVoltage gt lt onBoardTemperaturelnCelsius gt 25 lt onBoardTemperaturelnCelsius gt lt remoteTemperaturelnCelsius gt 0 lt remoteTemperaturelnCelsius gt lt powerSupplyInPCM gt lt position gt 1 lt position gt lt faulted gt no lt faulted gt lt powerSupplyInPCM gt lt powerSupplyInPCM gt lt position gt 9 lt position gt lt faulted gt no lt faulted gt lt powerSupplyInPCM gt lt powerControlModule gt lt fanControlModule gt lt ID gt FCM lt ID gt lt frameNumber gt 1 lt frameNumber gt temperaturelnCelsius gt 22 lt temperaturelnCelsius gt backPanelSwitch gt closed lt backPanelSwitch gt fanPanelSwitch gt closed lt fanPanelSwitch gt filterPanelSwitch gt closed lt filterPanelSwitch gt boardVoltage gt 24 024 lt boardVoltage gt nInputVoltage gt 12 000 lt fanInputVoltage gt nSpeedVoltage gt 9 006 lt fanSpeedVoltage gt nSpeedSetting gt 2 lt fa
156. ratureWarning gt lt temparatureAlarm gt yes no lt temperatureAlarm gt lt modelNumber gt value lt modelNumber gt lt manufacturerPartNumber gt value lt manufacturerPartNumber gt lt serialNumber gt value lt serialNumber gt lt modLevel gt value lt modLevel gt lt manufacturer gt value lt manufacturer gt lt countryOfManufacturer gt value lt countryOfManufacturer gt lt temperaturelnCelsius gt value lt temperaturelnCelsius gt lt communicatingWithPCM gt yes no lt communicatingWithPCM gt lt fanInPowerSupplyFRU gt lt number gt 1 2 3 lt number gt lt okay gt yes lt okay gt lt fanInPowerSupplyFRU gt lt powerSupplyInPowerSupplyFRU gt lt nominalVoltage gt 5 12 24 lt nominalVoltage gt lt actualVoltage gt value lt actualVoltage gt lt actualCurrentInAmps gt value lt actualCurrentInAmps gt lt powerSupplyInPowerSupplyFRU gt lt powerSupplyFRU gt lt powerControlModule gt lt ID gt value lt ID gt lt temperaturelnCelsius gt value lt temperaturelnCelsius gt lt parallelACPresent gt yes no lt parallelACPresent gt lt primaryACPresent gt yes no lt primaryACPresent gt lt secondaryACPresent gt yes no lt secondaryACPresent gt lt supplyDetectionWorking gt yes no lt supplyDetectionWorking gt lt ACCurrentInAmps gt value lt ACCurrent InAmps gt lt primaryACVoltage gt value lt primaryACVoltage gt lt secondaryACVoltage gt value lt
157. rlock switch Values closed open robotInServiceFrame Whether the robot is in the service position in the service frame Values yes no bulkIEPresent Whether the service frame includes a bulk TAP Values yes no bulkIEDoorOpen Whether the bulk TAP door is open neither latch engaged Values yes no bulkIEAjar Whether the bulk TAP door is ajar only one latch engaged Values yes no solenoidPinPosition Whether the bulk TAP carousel solenoid pin is fully extended This is an indication of whether the carousel is fully rotated either facing into the library or facing out toward the door or in an undetermined position Values fully extended undetermined bulkTAPLocation If bulkIEPresent is yes bulkTAPLocation indicates the location of the bulk TAP as viewed from the front Values left right 65 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus This parameter Indicates controller ECInfo The engineering change level for library components Environmentinfo Note For components with a drive ID for example DBA1 fLTO DRV2 the continued information is for the drive sled DCM and not the drive itself component Information for a specific component ID A description of the component including the frame number DBA number and component number if relevant serial Number The serial number of the component if relevant top
158. roller failover feature See Choose the Robotic Control Path in you library s User Guide for additional requirements when using the controller failover feature A Important A RIM or an F QIP can be the exporting controller for multiple partitions If this is the case the configuration settings included in the command will affect all partitions associated with the exporting controller Values QIP ID The component identifier for the exporting RIM or F QIP using the form FRx DBAx F QIPx where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the controller Not used with the T120 library F QIPx The number of the controller bay where the QIP is installed For all libraries except the T120 the value of x is always 1 For the T120 library the value of x is either 1 or 2 robot visibility The port of the exporting controller that provides the robotic control path for the partition Values A B A Important At least one port must be specified The first port is separated from the QIP ID by a semicolon If both ports are used the second port is separated from the first by a semicolon For each port optionally include the addressing mode and the hard address if required 14 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 p
159. rom another use your storage management software to eject all of the cartridges from the partition you want to delete The library moves the media to the partition s entry exit pool Export the media from the library as described in mediaExchange xml on page 75 or Exporting or Exchanging Magazines and Cartridges in your library s User Guide After the partition is deleted any magazines in the chambers that were assigned to the partition s storage and entry exit pools are not accessible until the chambers are assigned to another partition If the storage partition is configured to use encryption make sure that you have exported the encryption key s for any cartridges that were in the partition as described in the Spectra Encryption User Guide The encryption key s will be required if you import the cartridges into another partition in order to access the data on the cartridges If you plan to delete a cleaning partition use the BlueScale user interface to edit any storage partitions that use the cleaning partition to unassociate the cleaning partition from the storage partition 104 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition Syntax partition xml action delete amp partition partition name amp saveLibraryConfiguration USB emailRecipient where the value for This parameter Specifies partition The name of the partition you want to delete Notes
160. ror message text lt message gt lt usage gt lt line gt autosupport xml lt line gt lt line gt Query string lt line gt lt line gt action getASL lt line gt lt line gt name ASL Name lt line gt lt usage gt lt syntaxError gt Example Command and Response The following command autosupport xml action getASL amp name 0919402 01 13 2014 17 03 50 asl returns a file named autosupport zip which contains all of the ASL data 20 April 2015 XML Command Reference Spectra Tape Libraries CHAPTER 3 controllers xml list controllers The controllers xml command returns status information for the library controllers QIPs and RIMs Note Unless otherwise specified the features of both RIM and RIM2 are the same and RIM is used to refer to both Description Returns controller status type firmware failover configuration and port configuration information Syntax controllers xml action list Command Response The command immediately returns the following XML formatted data lt controllers gt lt controller gt lt ID gt FRx DBAx F QIPx lt ID gt lt status gt Normal Missing Impaired lt status gt lt firmware gt value lt firmware gt lt type gt 8 Gbps FC RIM2 4 Gbps FC RIM 2 Gbps FC RIM 1 Gbps Ethernet RIM 4 Gbps Fibre Channel 2 Gbps Fibre Channel 1 Gbps lt type gt Ethernet lt failoverFrom gt FRx DBAx F QIPx lt failoverFrom gt l
161. rt getASLNames Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt autosupport xml lt line gt lt line gt Query string lt line gt lt line gt action lt generateASL getASLNames getASL gt lt line gt lt usage gt lt syntaxError gt Example Command and Response Use the following command to generate anew ASL file and save it autosupport xml action generateASL When the response to the autosupport xml progress indicates that the ASL file generation is complete use the autosupport xml act ion getASLNames command to display the names of all ASL files and then use the autoSupport xml act ion getASL amp name ASLName command to retrieve the file Description Returns a list of the ASL files currently stored on the library Syntax autosupport xml action getASLNames Command Response The command immediately returns a list of ASL files currently stored on the library The list of ASL files is returned using the following format lt autosupport gt lt ASLNames gt lt ASLName gt HardwareID date time asl lt ASLName gt lt ASLName gt HardwareID date time asl lt ASLName gt lt ASLNames gt lt autosupport gt where the value for This parameter ASLName Indicates The filename of the ASL file where the filename includes the value for each of the following variables Har
162. rting controller that provides the robotic control path for the partition Values A B AB Note Port information will only appear if the exporter is an F QIP or RIM slotsPerChamber The number of slots per magazine This number depends on the technology Each LTO magazine has slots for 10 LTO cartridges a TS11x0 technology magazine has 9 slots For a T120 library slotsPerChamber is always 1 numStorageSlots The number of slots assigned for storing data cartridges Note For libraries that use TeraPack magazines the number of slots assigned for storage is a multiple of the number of slots per magazine For an LTO partition the number of slots must be a multiple of 10 for a TS11x0 technology partition the number of slots must be a multiple of 9 108 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies numEESlots The number of slots assigned for the partition s entry exit pool Notes For libraries that use TeraPack magazines the number of slots assigned to the entry exit pool is a multiple of the number of slots per magazine For an LTO partition the number of slots must be a multiple of 10 for a TS11x0 technology partition the number of slots must be a multiple of 9 This parameter is not applicable for T120 libraries eeType The E E Entry Exit port operation mode Values standard queued shared No
163. rtitionList partitionList xml no parameters The partitionList xml command is used to retrieve a list of all currently configured partitions Description Returns a list of all the partitions configured in the library Syntax partitionList xml Command Response The command immediately returns the following XML formatted data lt library gt lt partitionName gt first partition name lt partitionName gt lt partitionName gt last partition name lt partitionName gt lt library gt where the value for This parameter Specifies partitionName The exact name of each partition configured in the library Note The partition name is set when the partition is created See partition xml on page 101 for information about using the XML command interface to configure partitions in the library Syntax Error Response None Example Command and Response The following command partitionList xml returns the following list of partitions lt library gt lt partitionName gt Partition 1 lt partitionName gt lt partitionName gt Clean 1 lt partitionName gt lt library gt 126 CHAPTER 17 physinventory physInventory xml partition The physInventory xml command retrieves a list of all occupied magazine and cartridge locations in the specified partition The list includes the offset value for each occupied magazine and slot as well as the barcodes of the magazines and cartr
164. rtitions See Using PreScan in your library s User Guide for information about this parameter enableFullscan That the partition will use the FullScan feature to verify each data cartridge optional FullScan uses a Global Spare drive assigned to the partition to verify all of the data on each cartridge A Important This parameter is only valid when Media Lifecycle Management MLM is enabled for the library see Enabling MLM and Configuring Global Settings in your library s User Guide A Important The command cannot contain both the enableFullscan and the enableQuickscan parameters or the command will fail Notes The enableFullscan parameter is omitted when configuring a cleaning partition The enableFullscan parameter is optional for storage partitions The enableFullscan parameter is only valid if the partition includes Global Spare drives configured using the globalSpares parameter When you include the enableFullscan parameter in the command you must specify one or more PostScan triggers using the scanAfter parameter See Using PostScan in your library s User Guide for information about this parameter 120 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies enableQuickscan optional That the partition will use the QuickScan feature to verify each data cartridge QuickScan uses either one of the
165. s Stop all library operations A Important Confirm that all of the following conditions are met before beginning the upgrade process All backup processes have completed All storage management software daemons are stopped Use your storage management software to move any cartridges that are currently in drives back to their storage locations If you cannot use your storage management software move the cartridges as described in your library User Guide Pause or stop library background operations if they are running Any tapes currently being scanned are returned to their storage locations Management Tools screen b Click Pause PostScan to pause the PostScan operation for one hour c Click Stop Discovery to stop the PreScan operation To ensure that no commands are sent to the controllers Spectra Logic recommends disconnecting Fibre Channel cables connected to the F QIPs RIMs and any tape drives used as robotic exporters Back up your MLM database see Back Up the MLM and DLM Databases in your library s User Guide for instructions Note Backing up the MLM database also backs up the DLM database Back up the library configuration see Backing Up the Library Configuration in your library s User Guide for instructions Back up all of your BlueScale encryption keys see Exporting and Protecting Keys in the Spectra Encryption User Guide for instructions 94 April 2015
166. s actions Syntax taskList xml Command Response If the library is not currently performing any asynchronous or background operations the command returns a page with empty parameter tags If the library is performing any asynchronous or background operations the command returns the following XML formatted data lt taskList gt lt currentAsynchronousAction gt lt name gt action name lt name gt lt status gt QUEUE SUBMITTED ACTIVE WAITINGFORUSER DETACHED lt status gt lt feedbackString gt feedback message lt feedbackString gt lt currentAsyncronousAction gt lt currentBackgroundTasks gt lt task gt lt name gt background task lt name gt lt thread gt lt description gt thread description lt description gt lt thread gt lt task gt lt task gt lt task gt lt currentBackgroundTasks gt lt taskList gt 143 Chapter 22 taskList where the value for This parameter Indicates current Asynchronous Action The section of the command response that contains information about any asynchronous operation the library is processing Notes The library only processes one asynchronous operation at a time If the library is not currently processing any asynchronous operations this section will appear with empty parameter tags current BackgroundTask The section of the command response that contains information
167. s no lt frontSwitchOpen gt lt safetyInterlockOpen gt yes no lt safetyInterlockOpen gt lt frameIDInfo gt value lt frameIDInfo gt lt driveFrameNumber gt value lt driveFrameNumber gt lt switchedRailState gt ground 24 volts neither lt switchedRailState gt lt robotPowerEnabled gt yes no lt robotPowerEnabled lt internalLightsEnabled gt yes no lt internalLightsEnabled gt lt externalLightsEnabled gt yes no lt externalLightsEnabled gt lt fanPair gt lt number gt 1 3 5 7 9 lt number gt lt present gt yes no lt present gt lt fanPair gt lt fanInFMM gt lt number gt 1 2 3 4 5 6 7 8 9 10 lt number gt lt on gt yes no lt on gt lt speedInRPM gt value lt speedInRPM gt lt fanInFMM gt lt powerSupplyInFMM gt lt position gt value lt position gt lt faulted gt yes no lt faulted gt lt powerSupplyInFMM gt lt frameManagementModule gt lt serviceBayControlModule gt lt ID gt value lt ID gt lt frameIDInfo gt value lt frameIDInfo gt lt safetyDoorState gt value lt safetyDoorState gt lt overrideSwitch gt value lt overrideSwitch gt lt rearAccessPanel gt open closed lt rearAccessPanel gt lt sideAccessPanel gt open closed lt sideAccessPanel gt lt sidePanel gt open closed lt sidePanel gt lt robot InServiceFrame gt yes no lt robot InServiceFrame gt lt bulkIEPresent gt yes no lt bulkIEPresen
168. same SCSI bus Assigning the same SCSI ID to multiple devices on the same SCSI bus will cause communication problems on the bus See the Architecture and the Configuring and Managing Partitions chapters in your library s User Guide for detailed information about drive component identifiers and addressing 19 April 2015 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies cleaningPartition optional The name of the cleaning partition that you want to associate with the storage partition in order to use the Auto Drive Clean feature Notes The cleaningPartition parameter is omitted when configuring a cleaning partition The partition name is case sensitive The specified cleaning partition must already be configured on the library The specified cleaning partition must use the same media type as the storage partition enablePrescan optional That the partition will use the PreScan feature to discover cartridges in a storage partition in place of the default Media Auto Discovery process A Important This parameter is only valid when Media Lifecycle Management MLM is enabled for the library see Enabling MLM and Configuring Global Settings in your library s User Guide Notes The enablePrescan parameter is omitted when configuring a cleaning partition The enablePrescan parameter is optional for storage pa
169. se use the manually set threshold Note If default is set to false then the value parameter must contain a valid number In this case it is not necessary to also use the default parameter in the command 46 April 2015 XML Command Reference Spectra Tape Libraries Chapter 6 HHMData This parameter Specifies value The value for the reminder threshold if the value for the default parameter is set to false Values 1 through 4294967295 Notes If the default parameter is set to true then it is not necessary to include the value parameter in the command The unit of measure for the events depends on the type of counter For example for the Service HAX counter the unit of measure for the reminder threshold is inches traveled for the Service Required counter the unit of measure for the reminder threshold is elapsed minutes of operation See the unit parameter on page 41 for additional information EXAMPLE In the example command on page 48 the reminder threshold for the Service HAX Belt reminder is set to 46300000 When a Trip1 or Trip2 counter that uses this reminder reaches this value the library will add a reminder to the data returned by the HHMData xml command The command response indicates that the threshold was set successfully Command Response The command immediately returns the following XML formatted data lt HHMData gt lt setThresholdData gt lt status
170. se values further define how the library responds to the base URL command These parameters are described in the following table A Important The parameter names and their values are case sensitive most use camelCase If you fail to receive a response back from the library make sure that you typed the action name and any parameter names and values correctly A Important If you include an unsupported parameter value in the command the command fails and returns an error message indicating that the command received was not a valid command for the library Notes In some cases the base URL can be used without any additional parameters The syntax statements in this guide show these separators in bold in to make them easier to see This parameter Specifies parameter 1 value The name of the first parameter following the base URL and its value A Important The first parameter must be separated from the base URL by a question mark and from any additional parameters by an ampersand amp Note There are a few scenarios where a parameter does not have a value In these cases the usage of the parameter is all that is required parameter 2 value The name and value of each additional parameter for the command Multiple through parameters must be separated by an ampersand amp parameter n value Note Not all commands include additional parameters Library Login and Logout
171. sh parameter but the update did not require a reboot you can retrieve the update results using the systemMessages xml command see systemMessages xml on page 140 If the command included the autoFinish parameter and the update require a reboot you can retrieve the update results using the traces xml traceType Message command see traces xml on page 145 Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt package xml lt line gt lt line gt Query string lt line gt lt line gt action update lt line gt lt line gt package package name lt line gt lt line gt autoFinish optional lt line gt lt usage gt lt syntaxError gt Example Command The following command package xml action update amp package BlueScalel2 1 0 20120423F amp autoFinish updates the library to BlueScale12 1 0 20120423F When the update is complete the LCM or RCM may reboot if the package included updates to the LCM or RCM firmware 96 April 2015 XML Command Reference Spectra Tape Libraries Chapter 13 package package xml update UPDATING THE LIBRARY BLUESCALE SOFTWARE The following steps illustrate the sequence of commands used when updating the library to a new version of the BlueScale software Notes You must be logged into the library using the login xml command before you can issue any additional commands Refer to Upd
172. sponse lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt utils xml lt line gt lt line gt Query string lt line gt lt line gt action lockTensionRods lt line gt lt line gt state lt on off gt lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt Description Removes all partitions configured in the library and then cycles library power Syntax utils xml action removeAllLibraryPartitions Command Response The command returns the following XML formatted data lt utils gt lt removeAllLibraryPartitions gt lt status gt OK lt status gt lt removeAllLibraryPartitions gt lt utils gt When the command completes library power is cycled and any connections to the library through the XML command interface are lost Wait five to fifteen minutes for the reset to complete and then reconnect Progress Use the utils xml progress command to determine when the operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 or there is no response from the library 153 April 2015 XML Command Reference Spectra Tape Libraries Chapter 24 utils reset Inventory Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt utils xml lt line gt lt
173. ss amp TAPDevice main leftBulk rightBulk where the value for This parameter Specifies TAPDevice The TAP for which import or export operation is being requested Values main The TAP in the main frame leftBulk The bulk TAP on the left end of the library rightBulk The bulk TAP on the right end of the library Notes The main parameter value is not currently supported The command always fails if it contains the main parameter value The leftBulk and rightBulk parameter values are not supported by libraries that do not include a bulk TAP In addition the command fails if the library does not have a bulk TAP installed on the side specified by the parameter value When the command response is No Pending Actions the command is complete Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt mediaExchange xml lt line gt lt line gt Query string lt line gt lt line gt action importExport lt line gt lt line gt partition partition name lt line gt lt line gt slotType storage IE lt line gt lt line gt timeout InMinutes 1 10080 optional default 10 lt line gt lt line gt TAPDevice main leftBulk rightBulk lt line gt lt line gt TeraPackOffsets n n n lt line gt lt usage gt lt syntaxError gt Example Command After using the pnysInventory xml1 comman
174. t lt speedInRPM gt value lt speedInRPM gt lt fanInFCM gt lt lightBank gt lt number gt 1 2 3 lt number gt lt on gt yes no lt on gt lt lightBank gt lt fanControlModule gt lt frameManagementModule gt lt ID gt value lt ID gt lt twentyFourVoltVoltage gt value lt twentyFourVoltVoltage gt lt fiveVoltVoltage gt value lt fiveVoltVoltage gt lt fanRailVoltage gt value lt fanRailVoltage gt lt switchedRailVoltage gt value lt switchedRailVoltage gt lt twentyFourVoltCurrentInAmps gt value lt twentyFourVoltCurrentInAmps gt lt powerConsumedInWatts gt value lt powerConsumedInWatts gt lt sampleRateInSeconds gt value lt sampleRateInSeconds gt lt samplesTaken gt value lt samplesTaken gt lt temperaturelnCelsius gt value lt temperaturelnCelsius gt lt EPMTemperatureInCelsius gt value lt EPMTemperatureInCelsius gt 56 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus lt frameToFrameTemperaturelnCelsius gt value lt frameToFrameTemperaturelnCelsius gt lt frameToFrameAttached gt yes no lt frameToFrameAttached gt lt frameToFrameFiveVoltEnabled gt yes no lt frameToFrameFiveVoltEnabled gt lt fansEnabled gt yes no lt fansEnabled gt lt backSwitchOpen gt yes no lt backSwitchOpen gt lt filterSwitchOpen gt yes no lt filterSwitchOpen gt lt frontSwitchOpen gt ye
175. t lt line gt traceType Encryption Error EtherLib Event lt line gt lt line gt traceType GPIO HHM Inventory Kernel Lock lt line gt lt line gt traceType ssage MLM PackageUpdate SNMP lt line gt lt line gt traceType SpectraTKLM WebServer lt line gt lt line gt traceType Initialization LogicalLibrary Motion lt line gt lt line gt traceType HydraExit Geometry Pools lt line gt lt line gt traceType MotionInventory MotionOptions lt line gt lt line gt traceType MotionRestart1 MotionRestart2 lt line gt lt line gt traceType QIP name of QIP to act on lt line gt lt line gt traceType QIPDump name of QIP to act on lt line gt lt usage gt lt syntaxError gt Example Command and Response The following command traces xml traceType QIP FR3 DBA6 F QIP1 returns information about the RIM with the component identifier of FR3 DBA6 F QIP1 For example HW_ISR initialized HW_TIM initialized startup PCI bridge parity is ON startup PCI bus 1 dev 6 intr 1 funct 0 llab 4620 startup PCI bus 1 dev 7 intr 0 funct 0 1077 2300 startup PCI bus 0 dev 8 intr 5 funct 0 1077 2300 HW_PCI initialized found 3 PCI devices X 26 main Module MEM initialized DRAM X 31 main MAIN SYS a032a0000 a07fffff 00460000h bytes 150 April 2015 XML Command Reference Spectra Tape Libraries utils xml lockTension Rods CHAPTER 24 utils The utils xml command provides utilities used for troub
176. t lt storageSlot gt lt id gt first storage slot ID lt id gt lt offset gt value lt offset gt lt barcode gt value lt barcode gt lt isQueued gt yes no lt isQueued gt lt full gt yes no lt full gt lt storageSlot gt lt storageSlot gt lt id gt last storage slot ID lt id gt lt offset gt value lt offset gt lt barcode gt value lt barcode gt lt isQueued gt yes no lt isQueued gt lt full gt yes no lt full gt lt storageSlot gt lt entry lt id gt ExitSlot gt first EE slot ID lt id gt lt offset gt value lt offset gt lt barcode gt value lt barcode gt lt isQueued gt yes no lt isQueued gt lt full gt yes no lt full gt ExitSlot gt lt entry lt entry lt id gt ExitSlot gt last EE slot ID 1 lt id gt lt offset gt value lt offset gt lt barcode gt value lt barcode gt lt isQueued gt yes no lt isQueued gt lt full gt yes no lt full gt ExitSlot gt lt entry lt drive gt lt id gt first drivel lt id gt lt barcode gt value lt barcode gt lt isQueued gt value lt isQueued gt lt full gt yes no lt full gt lt drive gt lt drive gt lt id gt last drive lt id gt lt barcode gt value lt barcode gt lt isQueued gt value lt isQueued gt lt full gt yes no lt full gt lt drive gt lt partition gt lt inventory gt 50 April
177. t failoverTo gt FRx DBAx F QIPx lt failoverTo gt lt port gt lt name gt A B lt name gt lt useSoftAddress gt yes no lt useSoftAddress gt lt loopId gt value lt loopId gt lt initiatorEnabled gt yes no lt initiatorEnabled gt lt fibreConnect ionMode gt loop fabric automatic lt fibreConnect ionMode gt lt port gt lt controller gt lt controllers gt 21 Chapter 3 controllers where the value for This parameter Indicates ID The component identifier for the exporting RIM or F QIP using the form FRx DBAx F QIPx where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the controller Not used with the T120 library F QIPx The number of the controller bay where the QIP is installed For all libraries except the T120 the value of x is always 1 For the T120 library the value of x is either 1 or 2 status The operating status of the controller Values Normal Missing or Impaired the QIP code fails CAN commands firmware The firmware version in use by the controller type The type of controller Values 8 Gbps FC RIM2 RIM2 4 Gbps FC RIM 4 Gb second Fibre Channel RIM 2 Gbps FC RIM 2 Gb second Fibre Channel RIM 1 Gbps Ethernet RIM 1 Gb second Ethernet RIM 4 Gbps Fibre Channel
178. t gt lt bulkIEDoorOpen gt yes no lt bulkIEDoorOpen gt lt bulkIEAjar gt yes no lt bulkIEAjar gt lt solenoidPinPosition gt fully extended undetermined lt solenoidPinPosition gt lt bulkTAPLocation gt left right lt bulkTAPLocation gt lt serviceBayControlModule gt lt controllerEnvironment Info gt 57 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus lt ECInfo gt lt component gt lt ID gt value lt ID gt lt EC gt value lt EC gt lt serialNumber gt value lt serialNumber gt lt topLevelAssemblyEC gt value lt topLevelAssemblyEC gt lt topLevelAssemblySerialNumber gt value lt topLevelAssemblySerialNumber gt lt date gt value lt date gt lt component gt lt ECInfo gt lt libraryStatus gt where the value for This parameter Indicates libraryType railPowerOn The type of Spectra Logic library that received the command Values TFinity T950 T680 T380 T200 or T120 Whether the rail power is on yes or off no TFinity libraries only Values yes no robot The status of the robot s There is one section for each robot TFinity libraries only Note If the LCM does not report any robots or has an error accessing the robot data the robot parameter is not included Values number The num
179. t houses the drive providing it power and a location based identifier ID The component identifier for the drive using the form FRx DBAx DRVx where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the controller Not used with the T120 library DRVx The number of the drive bay in the DBA For all libraries except the T120 the value of x can be 1 through 4 For the T120 library the value of x can be 1 through 6 for full height drives and 1b through 6a for half height drives twelveVoltVoltage The measured voltage of the 12 volt power supply fiveVoltVoltage The measured voltage of the 5 volt power supply fanCurrentInAmps The measured current being drawn by the drive sled fan temperatureInCelsius The measured temperature in Celsius 60 April 2015 XML Command Reference Spectra Tape Libraries Chapter 8 libraryStatus This parameter Indicates controller Environmentinfo continued powerSupplyFRU The 5 12 VDC and 24 VDC power supply modules convert AC input to provide the 5 VDC and 12 VDC power used by the drives in the frame and the 24 VDC required by the robotics ID The component identifier for the power module using the form FRx PCM PowerSupplyx where FRx The number of the frame Only used in t
180. tatus gt lt login gt The login command also returns a session ID cookie that is required for subsequent XML commands issued from the same location If you are using a web browser to send commands the cookie is handled transparently by the browser If you are sending XML commands using a scripting language the script must include commands to manage the session Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt login xml lt line gt lt line gt Query string lt line gt lt line gt username valid user name lt line gt lt line gt password valid password lt line gt lt line gt forceFrontPanel optional lt line gt lt usage gt lt syntaxError gt Example Command The following command login xml username su password amp forceFrontPanel logs into the library as the default superuser which in this example does not have a password set When the BlueScale web interface is subsequently accessed using the same session cookie returned from this command all front panel functionality is available April 2015 73 XML Command Reference Spectra Tape Libraries CHAPTER 10 logout logout xml The logout xml command is used to close the connection to the library A Important If you do not use the logout xml command the connection to the library is automatically closed after the idle time specified through
181. te The queued and shared values are only supported by the T120 library drives List of the component identifiers for the drives assigned to the partition ID The component identifier for the drive using the form FRx DBAx DRVx where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the controller Not used with the T120 library DRVx The number of the drive bay in the DBA as viewed from the back of the library For all libraries except the T120 the value of x can be 1 through 4 For the T120 library the value of x can be 1 through 6 for full height drives and 1b through 6a for half height drives Note Ifa drive is an exporter it is only listed in the exporter section see exporters on page 108 globalSpares The component identifiers for the drives used as Global Spare drives for the partition using the form FRx DBAx DRVx See drives above for a description of the parameters in the component identifier MLM Media The MLM media verification features that are enabled for the partition See Verification Configuring and Using Media Lifecycle Management in your User Guide for more information preScan whether or not the PreScan feature is enabled in the partition Values yes no postScan the type of PostScan operation enabled in the partition
182. ters to specify multiple Global Spare drives The ID values returned by the driveList xml command without any parameters are the component identifiers for the drives currently installed in the library see driveList xml on page 24 See the Configuring and Managing Partitions chapter in your library s User Guide for detailed information about configuring Global Spare drives numStorageSlots The number of slots to be used for storing the cartridges that are accessible to the host for this partition Values 1 through n where n is the maximum number of licensed slots in the library A Important For libraries that use TeraPack magazines the number of slots assigned for storage must be a multiple of the number of slots per magazine For an LTO partition the number of slots must be a multiple of 10 for a TS11x0 technology partition the number of slots must be a multiple of 9 A Important If you specify a number of slots that is greater than the licensed number of slots the command will fail Notes The number of slots per magazine depends on the technology Each LTO magazine has slots for 10 LTO cartridges a TS11x0 technology magazine has 9 slots The size of the partition s storage pool is the total number of chambers you want to assign to the partition MINUS the number of chambers you want to reserve for the partition s entry exit pool If you plan to create multiple partitions be sure to reserve enough chamb
183. tes to the LCM or RCM firmware the command also reboots the LCM and RCM Updates do not take effect until the library completes the update process and if necessary reboots the LCM and any other components that were updated If you did not include the autoFinish parameter in the command you must send a package xml action getResults command in order to complete the update process See getResults on page 91 for more information Notes Running this command is not required in order to complete the update process if you include the autoFinish parameter in the package xml action update command as described on autoFinish on page 95 The remote connection to the library is lost when the LCM reboots Allow sufficient time for the LCM to complete its initialization then reconnect to the library Syntax package xml action getResults Command Response The command immediately returns the following XML formatted data lt package gt lt updateResults gt lt packageName gt package name lt packageName gt lt component gt lt name gt firmware component name lt name gt lt previousVersion gt previous firmware version lt previousVersion gt lt updatedVersion gt updated firmware version lt updatedVersion gt lt updateStatus gt OK failure message message text lt updateStatus gt lt component gt lt component gt lt component gt lt rebootInProcess gt true false lt rebootInProcess gt lt upd
184. the BlueScale user interface System Setup screen see Auto Logout Timeout in your library s User Guide A Important Connections to the library through the XML command interface are included in the maximum of eight simultaneous remote sessions supported by the library Syntax logout xml Command Response The command immediately returns the following XML formatted data lt logout gt Syntax Error Response None Example Command The following command logout xml immediately closes the connection to the library To run another XML command you must first login using the login xml command see login xml on page 72 74 CHAPTER 11 mediaExchange mediaExchange xml The mediaExchange xml command is used to import export or exchange cartridges and magazines using the TeraPack Access Port TAP or the bulk TAP if present The command also lets you prepare the bulk TAP for imports by ensuring that it does not contain any previously imported or exported magazines Note The mediaExchange xml command is not valid for the T120 library Refer to the Spectra T120 Library User Guide for information about importing cartridges into or exporting cartridges from a T120 Topic clean this page getTAPState page 77 importExport page 80 Importing Exporting or Exchanging Cartridges page 84 clean Description Prepares the specified bulk TAP for an import export command by making sure that it is
185. the controller RIM F QIP or direct attach drive s that provides the robotic control path for the partition ID For a RIM or QIP ID The component identifier for the exporting RIM or F QIP using the form FRx DBAx F QIPx where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the controller Not used with the T120 library F QIPx The number of the controller bay where the QIP is installed For all libraries except the T120 the value of x is always 1 For the T120 library the value of x is either 1 or 2 For a direct attached drive ID The component identifier for the exporting drive s using the form FRx DBAx DRVx where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the controller Not used with the T120 library DRVx The number of the drive bay in the DBA as viewed from the back of the library For all libraries except the T120 the value of x can be 1 through 4 For the T120 library the value of x can be 1 through 6 for full height drives and 1b through 6a for half height drives type describes the type of device being used to provide the robotic control path Values drive QIP unknown port is the port of the expo
186. tion If you want to use Auto Drive Clean with the partition and the library does not contain any chambers that are not enabled by the CoD activation key you will need to modify the partition after it is created to remove some of the chambers assigned to it so that you can create a cleaning partition If you want to use the Global Spares option with the partition you will need to modify the partition after it is created to unassign one or more of the drives that were automatically assigned to the partition and then reassign those drives as Global Spares You may want to modify the partition after it is created to remove some of the chambers that were automatically assigned to the storage pool and reassign them to the entry exit pool to provide additional chambers for importing and exporting magazines This command does not enable encryption If you need to use encryption with the partition modify the partition after it is created to enable encryption See the Spectra Encryption User Guide for detailed instructions Syntax partition xml action autoCreate partition partition name amp saveLibraryConfiguration USB emailRecipient where the value for This parameter Specifies partition The name you want to use for the partition Note The partition name is case sensitive saveLibrary Configuration optional Where you want to save the configuration backup file that the library generat
187. tion Lock QIP QIP ID Error LogicalLibrary QIPDump QIP ID EtherLib Message SNMP Event MLM SpectraTKLM Geometry Motion WebServer where QIP ID The component identifier for the RIM or F QIP for which you want to retrieve the specified trace data The QIP ID is in the form FRx DBAx F QIPx where FRx The number of the frame Only used in the component identifier when the controller is in a library that supports multiple frames DBAx The number of the drive bay assembly DBA containing the controller Not used with the T120 library F QIPx The interface type of the controller Fibre Channel and the number of the controller bay where it is installed For all libraries except the T120 the value of x is always 1 For the T120 library the value of x is either 1 or 2 149 April 2015 XML Command Reference Spectra Tape Libraries Chapter 23 traces Command Response The command returns the raw trace data formatted according to the type of trace requested Note The trace data is returned in ASCII format not XML format Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt traces xml lt line gt lt line gt Query string lt line gt lt line gt traceType Action AutoDriveCLean AutoSupport lt line gt lt line gt traceType BackgroundClient CAN Connection lt line g
188. ts the RCM which restarts all of the control code running on the RCM including the code that controls the robotics Any move requests fail until the RCM completes its initialization Note This command is only supported on T950 libraries Syntax utils xml action resetRobot Command Response The command returns the following XML formatted data lt utils gt lt resetRobot gt lt status gt OK lt status gt lt resetRobot gt lt utils gt 155 April 2015 XML Command Reference Spectra Tape Libraries Chapter 24 utils selective Snowplow Progress Use the utils xml progress command to determine when the reset operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt utils xml lt line gt lt line gt Query string lt line gt lt line gt action lockTensionRods removeAllLibraryPartitionsl resetLCM resetRobot resetInventory selectiveSnowplow verifyMagazineBarcodes lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt Description Changes the behavior of the transporter when it is putting a TeraPack magazine into a chamber Notes Do not enable this option unless specifically instructed to do so by Spectra Logic Technical S
189. ts when configuring this feature EXAMPLE Setting the OIPExporter parameter to QIP1 A loop 100 specifies that Port A of QIP1 will provide robot visibility for the partition The specified port will use loop addressing and the hard address will be set to 100 April 2015 15 XML Command Reference Spectra Tape Libraries Chapter 15 partition This parameter Specifies driveExporter The name and addressing for the direct attached drive or drives that provide the robotic control path for the partition using ADI These drives export the partition to the hosts using the library receiving and processing the robotic motion commands sent from the host to the transporter A Important If the partition will use a RIM or an F QIP to provide the robotic control path do not use the driveExporter parameter If both the QIPExporter and the driveExporter parameters are used the command will fail Important An ADI option activation key must be stored in the library For T950 and TFinity libraries using an LTO 5 or later generation tape drive for the robotic control path is supported by BlueScale 12 6 and later Important A TS11x0 technology drive cannot be used as a driveExporter TS11x0 technology partitions must use a QIPExporter RIM Important Do not use a drive that is listed in the globalSpares parameter Important You can select multiple LTO 5 and later generation drives as controllers
190. ty defaultThreshold The value of the factory default setting for the reminder threshold EXAMPLE In the example command response on page 42 the Trip1 subType counter for the Horizontal Axis has a default threshold value of 35950000 currentThreshold The value of the current reminder threshold see setThresholdData on page 46 for information about setting the reminder threshold EXAMPLE In the example command response on page 42 the current threshold value for the Trip1 subType counter for the Horizontal Axis is set to 35950000 postedDate The date on which the reminder for a counter was posted If a reminder has not been posted the date is set to None EXAMPLE In the example command response on page 42 a Service HAX reminder was posted for the Trip1 counter on 2011 08 09 17 08 04 Syntax Error Response None Example Command and Response The following command HHMData xml retrieves the following HHM data Note The following example shows part of the HHM data returned by a TFinity library The actual data returned depends on the library type lt HHMData gt lt counter gt lt typeName gt Horizontal Axis lt typeName gt lt subType gt lt typeName gt Life Robot 1 lt typeName gt lt value gt 25172883 lt value gt lt unit gt inches lt unit gt lt subType gt lt subType gt lt typeName gt Tripl Robot 1 lt typeName gt lt value gt 49513396 lt value gt lt unit gt inches
191. type LTO QIPExporter FR1 DBA1 F QIP1 A fabric amp globalSpares FR1 DBA1 fLTO DRV4 amp numStorageSlots 920 amp numEESlots 10 amp drives FR1 DBA1 f LTO DRV1 fabric FR1 DBA1 fLTO DRV2 fabric amp cleaningPartition LTO Clean nablePrescantenableQuickScan globalSpareDrives scanAfter write read amp saveLibraryConfiguration JaneSuperuser YourCompany com creates a single LTO storage partition named Partition 1 The partition has the following characteristics The RIM uses the fabric addressing mode The robotics are only visible to the host through Port A Drive FR1 DBA1 fLTO DRV4 is configured as a Global Spare drive The partition has 920 slots assigned to the storage pool and ten slots assigned to the entry exit pool Drives FR1 DBA1 fLTO DRV1 and FR1 DBA1 fLTO DRV2 are assigned to the partition The drives use the fabric addressing mode A cleaning partition named LTO Clean is assigned to the storage partition which enables the Auto Drive Clean feature Both PreScan and QuickScan using Global Spares are enabled The PostScan trigger is set to add each cartridge to the automatic PostScan queue after it is ejected from a drive following either a data write or data read operation The configuration backup file generated after the partition is configured is sent to mail user JaneSuperuser YourCompany com 125 April 2015 XML Command Reference Spectra Tape Libraries CHAPTER 16 pa
192. ue for This parameter Specifies partition The name you want to use for the partition Names can be up to 32 alphanumeric characters and can include the _ and the space character A Important The partition name is case sensitive type The type of partition to create Values LTO LTO Cleaning TS11x0 TS11x0 Cleaning Super DLT Super AIT A Important If you specify drive type that is not present the command will fail Notes The TS11x0 and TS11x0 Cleaning parameter values are only valid in a T380 T950 or TFinity library that has TS11x0 technology drives installed The Super DLT and Super AIT parameters are only supported in libraries that contained these drives when purchased QIPExporter The name and addressing for the controller RIM or F QIP that provides the robotic control path for the partition This controller exports the partition to the hosts using the library receiving and processing the robotic motion commands sent from the host to the transporter A Important If the partition will use a direct attached drive to provide the robotic control path do not use the QIPExporter parameter If both the QIPExporter and the driveExporter parameters are used in the same command the command will fail A Important TS11x0 technology partitions must use a QIPExporter and not a driveExporter A Important The specified RIM or F QIP cannot be specified as a failover partner for the cont
193. uppliers Note on Java Support The Software may contain support for programs written in Java Java technology is not fault tolerant and is not designed manufactured or intended for use of resale as online control equipment in hazardous environments requiring fail safe performance such as in the operation of nuclear facilities aircraft navigation or communications systems air traffic control direct life support machines or weapons systems in which the failure of Java technology could lead directly to death personal injury or severe physical or environmental damage No Liability for Certain Damages Except as prohibited by law Software suppliers shall have no liability for any indirect special consequential or incidental damages arising from or in connection with the use or performance of the Software This limitation shall apply even if any remedy fails of its essential purpose In no event shall Software suppliers individually be liable for any amount in excess of U S two hundred fifty dollars U S 250 00 Limitations on Reverse Engineering Decompilation and Disassembly You may not reverse engineer decompile or disassemble the Software except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation Software Transfer Allowed with Restrictions You may permanently transfer rights under this EULA only as part of a permanent sale or transfer of the Spectra produ
194. upport This command is only supported on TFinity libraries Syntax utils xml action selectiveSnowplow amp state on off where the value for This parameter Indicates state Whether the standard transporter behavior for putting a magazine in a chamber is modified Values on The alternate TeraPack magazine behavior is used off The standard TeraPack magazine behavior is used Command Response The command returns the following XML formatted data lt utils gt lt selectiveSnowplow gt lt status gt OK lt status gt lt selectiveSnowplow gt lt utils gt Progress Use the utils xml progress command to determine when the reset operation is complete The operation is complete when the command response is No Pending Actions see Progress for Asynchronous Commands on page 15 156 April 2015 XML Command Reference Spectra Tape Libraries Chapter 24 utils verify Magazine Barcodes Syntax Error Response lt syntaxError gt lt message gt error message text lt message gt lt usage gt lt line gt utils xml lt line gt lt line gt Query string lt line gt lt line gt action selectiveSnowplow lt line gt lt line gt state lt on off gt lt line gt lt line gt progress while running lt line gt lt usage gt lt syntaxError gt Description Runs the advanced utility to verify the barcodes on all TeraPack magazines Note This com
195. xml command lets you monitor the percentage of each hour that the library s robotics are actively operating over the last 24 hours The data is updated every hour while the library is powered on Notes The command response can include up to 24 data sets one for each hour that data was collected over a 24 hour period The first time period begins one full hour after the library is powered on Data collected during the first partial hour following power on is discarded as invalid data The data is stored in volatile memory and is not retained when the library is powered off This command is not currently supported for the TFinity library 138 Chapter 20 robotUtilization no Description Returns the robotics usage data for the past 24 hour period parameters beginning with the most recent data Syntax robotUtilization xml Command Response The command immediately returns the following XML formatted data lt robotUtilization gt lt robotUtilizationDataPoint gt lt hourStartingAt gt most current hour lt hourStartingAt gt lt percentUtilization gt percent active lt percentUtilization gt lt robotUtilizationDataPoint gt lt robotUtilizationDataPoint gt lt hourStartingAt gt least current hour lt hourStartingAt gt lt percentUtilization gt percent active lt percentUtilization gt lt robotUtilizationDataPoint gt lt robotUtilization gt where the value for This parameter Indicates
196. ys gt Syntax Error Response lt errorMessage gt lt message gt error message text lt message gt lt usage gt lt line gt optionkeys xml lt line gt lt line gt Query string lt line gt lt line gt action add lt line gt lt line gt key key lt line gt lt usage gt lt errorMessage gt Description Returns a list of all active option keys currently entered in the library 87 Chapter 12 optionKeys Syntax optionKeys xml action list Command Response The command immediately returns the following XML formatted data lt optionKeys gt lt optionKey gt lt keyValue gt key value lt keyValue gt lt description gt description lt description gt lt action gt ADD OR OVERWRITE lt action gt lt daysRemaining gt number of days remaining lt daysRemaining gt lt optionKey gt lt optionKeys gt where the value for This parameter Indicates keyValue The alphanumeric key for activating the option The keys are not case sensitive description The option activated by the key action Whether the key replaces adds to or coexists with previously entered keys of daysRemaining the same type Values ADD The new quantity is added to previously entered keys of the same type OR Multiple keys of this type can coexist on the library The feature associated with either the new key or previously entered keys of the same type can be used OVERWRITE
197. zine and slot sections for each magazine in the desired section of the physical inventory data For each magazine you want to export or exchange determine its offset value EXAMPLE The command response data for the physInventory xml command shown on page 130 shows the first two magazine locations in the storage pool The storage section of the physical inventory data does not include offset values 2 3 4 or 5 These missing offset values indicate these magazine locations are empty and can be used as destinations when importing magazines The magazine with an offset value of 1 does not include a slot section indicating that the magazine is empty The magazine with an offset value of 6 includes two slot sections number 1 and number 3 indicating that each of these slots contains a cartridge there is not a slot number 2 indicating that this slot is empty 132 April 2015 XML Command Reference Spectra Tape Libraries CHAPTER 18 powerOff powerOff xml no parameters The powerOff xml command power cycles the library See Controlling the Library Power in your library s User Guide for detailed information about power cycling the library Description Powers the library off and then if desired powers it on again Preparation Before powering off the library use the following steps to prepare for shut down 1 Use your storage management software to stop any backups running to the library

Download Pdf Manuals

Related Search

Related Contents

取扱説明書（応用編） - お客様サポート  Buffalo TeraStation TS7120r Enterprise  Pyle PTCDCS3UIP audio turntable  取扱説明書（PDF）をダウンロード  Samsung ML-2165/SEE Εγχειρίδιο χρήσης    Montaje y modo de empleo Instruções para montagem e      

Copyright © All rights reserved. Failed to retrieve file