leadm

The leadm command is an administrative command for IBM Spectrum Archive™ Library Edition. It replaces the ltfsadmintool command, which will become obsolete in a future release. To see how the leadm command syntax compares to the ltfsadmintool command syntax, see leadm and ltfsadmintool command syntax comparison.

The leadm command has the following features.
Simple command syntax
The first argument (the command) specifies one of the IBM Spectrum Archive LE resources: the node, library, drive, or tape. The second argument (a subcommand) specifies the action to be done to the resource.

There are two option types: a global option that is common to all commands, and an action-specific option.

Other arguments (not a command, subcommand, or option) specify a target resource of the node, library, drive, or tape.

Multi-thread
The multi-thread function enables you to invoke multiple actions with one command. For example, you can format multiple tapes on multiple drives with one leadm command.
A shortened format for status information
Less important information is not included on the lists of status information. Detailed information can be obtained by another subcommand.
JSON output
JSON output is supported.

Syntax

The syntax of <keyword conref="top_tscom_reuse_names.dita#top_tscom_reuse_names/ltfsle"/> is:

leadm COMMAND SUBCOMMAND [global options] [subcommand options] target ...

The following global options apply to all of the leadm commands:
Global options
-s, host [:port], --server=host [:port]
Server and port to connect to [default: localhost:7600].
-r, --refresh
Refresh the inventory before the command is run [default: false].
-t THREADS, --threads=THREADS
The number of threads [default: 1].

The subcommand options are listed with the subcommands to which they apply.

The help option -h, --help can be used at any time to display useful information for specified arguments. For example, to display help information for the leadm command, use the following command:
$ leadm --help
The leadm commands specify the target resource, and are one of the following commands:
  • node
  • library
  • drive
  • tape

Command exit codes

One of the following codes is displayed after a leadm command is run:
0
All actions completed successfully.
1
A critical error, such as a protocol error, occurred.
2
A usage error, such as an invalid option, occurred.
3
All actions failed or some actions failed. For example, if a leadm tape format command requests the format of 4 tapes, but only 2 tapes are successfully formatted, some actions failed and the 3 code is issued.

See the following topics for details about the subcommands and options that you can use with the leadm commands.