A Command Line Interface Reference

The CLI is firmware-based. Therefore, some CLI commands listed below may be unavailable if you are running older versions of the library firmware.

Admin accessible CLI commands include:

audit

This command performs a physical audit on all or part of the library.

audit

Displays help for the audit command, the same as "help audit".

audit *

Initiates a physical audit of the entire library. This command returns immediately and displays no results.

Example:

SL3000> audit *
   requestId
   requestId 9
   Done
   Failure Count 0
   Success Count 1
COMPLETED
audit <device address> <address>

Performs a physical audit of a single address and displays the results.

  • <device address> - specifies the robot to use in library, rail, column, side, row format.

  • <address> - specifies the slot location to audit in library, rail, column, side, row format.

Example:

SL3000> audit 1,1,0,1,0 1,1,-10,1,1
   requestId
   requestId 9
   Attributes Media Label #EMPTY..
   Object     Location    1,1,-10,1,1
   Done
   Failure Count 0
   Success Count 1
COMPLETED
audit <device address> <start address> <end address>

Performs a physical audits of a range of addresses and displays the results.

  • <device address> - specifies the robot to use in library, rail, column, side, row format.

  • <start address> <end address> - specifies the starting and ending slot location to audit in library, rail, column, side, row format. Only the row is variable between the start and end addresses.

Example:

SL3000> audit 1,1,0,1,0 1,1,-10,1,1 1,1,-10,1,5
   requestId
   requestId 10
   Attributes Media Label #EMPTY..
   Object     Location    1,1,-10,1,1
 
   Attributes Media Label EN34410R
   Object     Location    1,1,-10,1,5
   ...
   Done
   Failure Count 0
   Success Count 5
COMPLETED
audit multiRowScan {enable | disable | print} <device address>

Enables or disables multiple row scan audit capability to speed up audit time.

  • print - prints the multi-row scan audit state.

  • <device address> - specifies the robot to use in library, rail, column, side, row format.

Example:

SL3000> audit multiRowScan print 1,1,0,1,0
   requestId
   requestId 8401
   Attributes Multi Row Scan enabled
   Object     Robot          1,1,0,1,0
   Done
   Failure Count 0
   Success Count 1
COMPLETED

capCommand

This command is for managing CAPs.

capCommand

Displays help for the capCommand command, the same as "help capCommand".

capCommand forceUnreserve <device address>

Forces the release of a CAP. If cartridges are in the CAP, the reservation changes to "default". If there are no cartridges in the CAP, the reservation changes to "none".

  • <device address> - specifies the CAP to release in library, rail, column, side, row format.

capCommand {lock | unlock} <device address>

Locks or unlocks a CAP specified by the device address.

  • <device address> - specifies the CAP to lock/unlock in library, rail, column, side, row format.

capCommand resetCap {left | right | both}

This command forces the reset of a cap string or strings based on the provided side argument.

Example:

SL3000> capCommand resetCap right
   requestId
   requestId 17002
   Done
   Failure Count 0
   Success Count 1
COMPLETED

cleaning

This family of commands displays and controls cleaning and diagnostic cartridge-related functions within the library. Only customers with the media validation feature should use these commands.

cleaning

Displays help for the cleaning command, the same as "help cleaning".

cleaning list {cleaning | diagnostic}

Lists all cleaning or diagnostic cartridges in the system slots.

Example:

SL3000> cleaning list cleaning
   requestId
   requestId 9001
   Attributes Expired  false
      Label            CLN0080U
      Location         1,1,-12,1,13
      Max Usage Count  100
      Media Type       9840_Cleaning
      Status           ok
      Usage Count      0
Object Cartridge       cleaning
cleaning import <cap device address>

Imports cleaning and diagnostic cartridges to system slots. Only one import/export operation is allowed at a time. There must be a minimum 2 empty system slots for SL3000 libraries to allow imports.

  • <cap device address> - specifies the CAP to use for the import operation, in library, rail, column, side, row format.

Example:

SL3000> cleaning import 1,1,5,2,0
   requestId
   requestId 10101
   Message CAP open(ing). Place cartridges to import in CAP, then close CAP.Use CONTINUE cmd to proceed...
   Done
   Failure Count 0
   Success Count 0
COMPLETED
cleaning export <cap device address> cleaning [select expired]

Exports cleaning cartridges. Only one import/export operation is allowed at a time.

  • <cap device address> - specifies the CAP to use for the export operation, in library, rail, column, side, row format.

Example:

SL3000> cleaning export 1,1,5,2,0 cleaning
   requestId
   requestId 9601
   Address      1.1.-12.1.12
   Success      Cartridge Exported
   Volume Label CLN002CU
   Message CAP open(ing). Remove cartridges, then close CAP.Use CONTINUE cmd to proceed...
   Done
   Failure Count 0
   Success Count 1
COMPLETED
cleaning export <cap device address> <cartridge address>

Exports a specific cleaning or diagnostic cartridge to the specified cap. Only one import/export operation is allowed at a time.

  • <cap device address> - specifies the CAP to use for the export operation, in library, rail, column, side, row format.

  • <cartridge address> - specifies the location of the cartridge to export in library, rail, column, side, row format. The specified cartridge must be in a system slot and must be either a cleaning or diagnostic cartridge.

Example:

SL3000> cleaning export 1,1,5,2,0 1,4,-12,1,12
   requestId
   requestId 9601
   Address      1.4.-12.1.12
   Success      Cartridge Exported
   Volume Label CLN002CU
   Message CAP open(ing). Remove cartridges, then close CAP.Use CONTINUE cmd to proceed...
   Done
   Failure Count 0
   Success Count 1
COMPLETED
cleaning threshold list

Displays a list of cleaning cartridge types and their warning thresholds. Each cleaning cartridge type has 4 attributes:

  • Index - cleaning cartridge type used by the "cleaning threshold set" command

  • Media type - the type of cleaning cartridge used

  • Maximum usage count - recommended max usage by tape manufacturer

  • Warning threshold value - user-defined threshold that determines when a warning status is set for a cleaning cartridge once its usage count reaches that threshold.

Example:

SL3000> cleaning threshold list
   requestId
   requestId 15001
   Attributes
   Object     Index               1
              Media Type          SgtUltrium1_Cleaning
              Recommend Max Usage 100
              Warning Threshold   0
   Attributes
   Object     Index               3
              Media Type          T10000_Cleaning
              Recommend Max Usage 50
              Warning Threshold   0
cleaning threshold set <warning threshold value> <list index number>

Sets a warning threshold value for a particular cleaning cartridge type.

  • <warning threshold value> - can be any positive integer up to 1000. A value of 0 indicates no warning threshold.

  • <list index number> - cleaning cartridge type as specified by the index number from the table listing of the ”cleaning threshold list” command.

Example:

SL3000> cleaning threshold set 55 11
   requestId
   requestId 15101
   Attributes
   Object      Success true
   Done
COMPLETED
cleaning driveWarning set { on | off }

Sets the drive cleaning warning flag to either on or off.

  • on - the drive health status will be set to warn if it needs cleaning

  • off - the drive health status is not affected if the drive needs cleaning

config

This command will either display the current physical library configuration or set library configuration parameters.

config

Displays help for the config command, the same as "help config".

config print

Displays the current physical library configuration.

config ilc print

Display the ilc status.

config ilc {enable | disable}

Enables or disables the Inter-Library Communications (ILC) LAN. If a disable is requested, the library must first be taken offline using the "accessState offline <device address>" command.

config print

Displays the current physical library configuration.

config serviceInfo print

Displays the library service information.

config serviceInfo set

Sets service information: contact &rsquor;contactName' phone &rsquor;phoneNumber' streetAddr &rsquor;streetAddress' city &rsquor;city' state &rsquor;state' country &rsquor;country' zip &rsquor;zipCode' description &rsquor;description data'.

The maximum string length is 31 characters. Each string must be delimited by &rsquor; ' (single quotes) to provide the ability to use spaces and other characters.

Example:

SL3000> config serviceInfo set city 'Denver' contact 'Andy' country 'USA' description 'Manager' phone '303 222-4444' state 'C0' streetAddr '1 tape drive' zip '80027'

requestId
requestId 1512402
Device serviceInfo
Success true
Done
Failure Count 0
Success Count 1
COMPLETED

date

This command sets the library date in Greenwich Mean Time (GMT).

date

Displays help for the date command, the same as "help date".

date print

Displays the current system date.

date <MM> / <DD> / <YYYY>

Sets the system date. In a library complex, the library with libraryId = 1 is the master. Change the date on the master library.

  • <MM> - two digit month

  • <DD> - two digit day

  • <YYYY> - four digit year

drive

This command displays information about the drives or executes the drive utilities such as adiEnable, fastLoad, power, and rewindUnload.

drive

Displays help for the drive command, the same as "help drive".

drive adiEnable {on | off | print}

Turns on or off or prints status of drive discovery with ADI. Once enabled, any subsequently added drives will attempt ADI drive discovery. To enable ADI for all ADI capable drives in the library, the library must be rebooted.

drive fastLoad {on | off | print}

Turns on or off or prints the status of the fastLoad feature. FastLoad changes the behavior of drive mounts (move commands). With fastLoad on, the robot will not wait for a complete load of a PUT to a drive, but will go immediately to the next operation. Also changes the behavior of the rewindUnload command to return immediately, not waiting for the drive to unload. The state of the fastLoad applies to all drives.

Note:

This command only affects commands issued in the same CLI session where this command was issued.
drive print { <drive address> | * }

Displays summary drive information: location, state, status, type, firmware version, interface type, in use, serial number, state (online/offline), status (ok, warning, or error), and drive vendor.

  • <drive address> - specifies the drive in library, rail, column, side, row format.

  • * - displays drive information for all drives in the library

drive search {on | off} <drive address>

Causes the green LED on the drive tray to blink. Blinking continues until the search off command issued. Used to locate a drive within the library.

  • <drive address> - specifies the drive in library, rail, column, side, row format.

hwActivation

This command activating certain library features after purchasing a hardware activation permit.

Note:

The library must be rebooted when disabling openVolser, dualRobot, or redundant electronics.
hwActivation

Displays help for the hwActivation command, same as "help hwActivation".

hwActivation addLicenseFile

Adds a license file. The license file must be named SL3000_license_config.dsf. The full path name being /usr/local/SL3000_license_config.dsf.

hwActivation deleteFile <index>

Deletes the specified installed feature file.

  • <index> - specifies file number to delete as specified in the library controller hwActivation module database. See "hwActivation listFiles".

hwActivation listFiles

Lists the installed feature files in the library controller hwActivation module database.

hwActivation print

Lists all of the enabled features in the library controller hwActivation module database.

FibreConfig

This command obtains and sets multi-port fibre channel configurations for the library controller. The Fibre Channels controls and displays by this command are not to be confused with the fibre channel configurations to tape drives. This command is only available on the SL3000.

fibreConfig print

Displays the status of the library fibre channel connections.

fibreConfig ports print

Displays the number of multi fibre port channels enabled.

fibreConfig config <hard|soft> <loopId> <portNum>

Sets either hard or soft addressing, and sets the fibre loop ID if hard addressing is enabled to the provided value. The loop ID is set to 126 if hard addressing is disabled. This configuration is on a per port basis.

fibreConfig ports set <number to enable>

Sets the number of multi fibre port channels to enable. The MultiFibrePort license limitation and the physical hardware determine the maximum number of ports to enable.

mediaValidation

This command manages the media validation feature.

mediaValidation

Displays help for the mediaValidation command, same as "help mediaValidation"

mediaValidation print { all | poolOnly } { * | @ }

Displays drive locations of the media validation pool.

  • all - lists all drive slots

  • poolOnly - lists only drive slots in the media validation pool

  • * - displays only information for the target library

  • @ - displays information for the entire complex

mediaValidation reservation clear <drive address>

Clears media validation reservation for specified drive.

  • <drive address> - specifies the drive in library, rail, column, side, row format.

mediaValidation stopValidation <drive address>

Stops a validation currently in progress. Cartridge is returned to source storage slot.

  • <drive address> - specifies the drive in library, rail, column, side, row format.

network

This command configures and displays network configuration for the controller card.

network clone [Port 2B IP address] [Port 2A IP address]

Used for redundant electronics configuration. Copies all port, routing, and IP policy configurations to side B HBC. IP addresses are replaced with the ones specified in the command for side B. If no port IP address is specified, then they are not set on side B.

network config print

Displays the target library side (A or B) that is set for network commands.

network config side {a | b}

Sets the target library side for network commands.

network config clear

Clears the network configuration. This command stops network connectivity. Reconfiguration requires access to the serial port on the HBC card.

network export

Exports library network configuration file (.lnc) and generates a network configuration script (.scr). It can only be used in cases where no prior network configurations have been set.

network gateway <IP address>

Sets the external network default gateway.

network gateway clear

Clears the external network default gateway.

network import

Imports a library network configuration file (.lnc).

network ip <IP address>

Sets the IP address of port 2B.

network ip address add <IP address> dev {2A | 2B}

Sets the IP address of a particular port.

network ip address del <IP address> dev {2A | 2B}

Removes the IP address of a port.

network ip address show [dev {2A | 2B}]

Displays the current address information for a particular port or both ports if dev is not specified.

network ip link set dev {2A | 2B} {up | down}

Sets the operation status of a port, which controls whether a port can send and receive Ethernet traffic.

  • up - sets port online

  • down - sets port offline

network ip policy {enable | disable} dev {2A | 2B}

Enables or disables policy routing for device 2A or 2B.

network ip policy status

Displays policy routing status for devices 2A and 2B.

network ip policy route {add | del} <IP address> dev {2A | 2B}

Adds or deletes a static route to policy for device 2A or 2B.

network ip policy route {add | del} <IP address> via <Gateway IP address> dev {2A | 2B}

Adds or deletes a static route to policy for device 2A or 2B via gateway.

network ip policy route show [ dev {2A | 2B} ]

Displays policy route information for device 2A or 2B.

network ip route add default via <IP address>

Sets the default gateway routing IP address.

network ip route delete default

Deletes the default gateway routing IP address.

network ip route {add | del} <IP address [/netmask] > dev {1A | 1B | 2A | 2B}

Adds or deletes a static IP (Internet Protocol) routing address for a specified host. This command also enables a user to set the netmask for a particular port.

Example:

SL3000>network ip route add 129.80.81.59/24 dev 1B
COMPLETED
network ip route {add | del} <IP address [/netmask] > via <Gateway IP address>

Adds or deletes a static route to a destination network IP gateway address.

network ip route show [dev {2A | 2B}]

Displays the current routing table information or routing table information for a particular port.

network name <host name string>

Sets the host name.

network netmask <netmask>

Sets the external network netmask in xxx.xxx.xxx.xxx form.

network print

Displays the current network configuration for the external Ethernet ports (2A and 2B).

partition

This command displays the current status or disables the partition feature.

partition

Displays help for the partition command, same as "help partition".

partition autoClean set { * | <Partition Id> }

Set auto clean in a specified partition (0, for a non-partitioned library).

partition attribute status { * | <Partition Id> }

Displays the status attributes of a single specified partition or all partitions.

partition fastLoad set '<partitionId-mode, partitionId-mode, ...>'

Sets the fastLoad mode for a one or more specified partitions. Currently the only valid modes are true or false. This command is only available on the SL3000.

Example:

SL3000> partition fastload set '1-true,3-false'
   requestId
   requestId 40901
   Attributes Success true
   Object
   Done
   Failure Count 0
   Success Count 2
COMPLETED
partition getCapacity

Displays the capacity values for library or any defined partitions.

partition get state <Partition Id>

Displays the current state of the specified partition(s). This command is available on SL3000 libraries only

partition predefined file <partition file number>

Uses a predefined partition text file to set the library partition configuration. Each file name consists of the word ”partition” and a numeric value ie ”2” and a ”.txt” extension. The predefined files are below.

partition1.txt – Non-partitioned Base with a HLI interface.
partition2.txt – Non-partitioned Base with a SCSI interface.
partition3.txt – One partitioned Base with a HLI interface.
partition4.txt – One partitioned Base with a SCSI interface.
partition5.txt – Two partitioned Base with a HLI interface.
partition6.txt – Two partitioned Base with a SCSI interface.
partition7.txt – Two partition Base w/DEM HLI and SCSI partitions.
partition8.txt – Two partition Base w/DEM SCSI interface.
partition9.txt – Multiple partitions (stripes) HLI interface.
partition10.txt – Multiple partitions (stripes) SCSI interface.
partition11.txt – Multiple partitions (random) HLI interface.
partition12.txt – Multiple partitions (random) SCSI interface.

Example:

SL3000> partition predefined file 5
   requestId
   requestId 7601
   Done
   Failure Count 0
   Success Count 1
COMPLETED
partition setCapacity { <Partition Id> , <Capacity> }

Sets the capacity for the designated partition. Existing partitions not listed in the command will have their capacity set to zero.

Example:

SL3000> partition setCapacity 1,200 2,50 3,600
   requestId 7601
   Done
   Failure Count 0
   Success Count 1
COMPLETED
partition setNonPartitionedHLI

Sets the partition to hli0. If there are any drives in the media validation pool, they must be removed beforehand. If in complex, it sets all the libraries to hli0.

partition set state {online | offline} <Partition Id>

Sets the current state (offline/online) of a specified partition.

partition set {hli | scsi}

Sets the interface type for the entire library. Available on SL3000 only.

partition status

Displays the current partitioning status.

reControl

This command controls/switches the redundant electronics and retrieves the library controller redundant electronics statuses.

reControl

Displays help for the reControl command, same as "help reControl".

reControl status [ <library address> | * ]

Retrieves the redundant electronics status.

  • <library address> - specifies the library in library, rail, column, side, row format. For example: 2, 0, 0, 0, 0.

  • * - retrieves status from all libraries in a complex

snmp

This command configures the Simple Network Management Protocol (SNMP). For detailed information, see the SNMP Reference Guide on OTN.

ssh

This command controls configuration for the ssh daemon/server which resides on the HBC. This is the protocol utility which SLC and other various applications use to connect to the library controller.

ssh print

Prints the current ssh daemon protocol settings.

ssh set version1and2

Sets the ssh daemon protocol restriction to v1 and v2. (this is the default). The ssh server is restarted.

ssh set version2

Sets the ssh daemon protocol restriction to v2 only.

time

This command sets the library time in military time notation.

time

Displays help for the time command, same as "help time".

time print

Displays the current system time.

time <HH> : <MM>

Sets the system time. Resolution is within one minute. In a library complex, the library with libraryId = 1 is the master. Change the time on the master library.

  • <HH> - two digit hour

  • <MM> - two digit minute

time <HH> : <MM> : <SS>

Sets the system time. Resolution is within one second. In a library complex, the library with libraryId = 1 is the master. Change the time on the master library.

  • <HH> - two digit hour

  • <MM> - two digit minute

  • <SS> - two digit second

traceRoute

This command traces the network route to a specified IP address.

traceRoute <IP Address>

Executes a traceRoute to the IP address specified.

version

This command displays the customer version and the versions of the software for the device(s) requested.

version print [ <device address> | *]

Displays the software version of code for a device or all devices.

  • <device address> - specifies the device in library, rail, column, side, row format.

whereAmi

This command displays the system and logic card information relative to the library and card related to the redundant electronics command being executed.

whereAmi

Displays the information relating to where the command is being issued.

Example:

SL3000> whereAmI
   Host Name: gulibtst02b
   Port 2B IP Address: 172.20.151.24
   Library Type: SL3000
   HBC side: B
   Active side: B
COMPLETED