eeadm tape reclaim

Reclaims the unreferenced space of a specified source tape, by only copying the active referenced contents on the source tape to another tape in the same pool and by reformatting the source tape after completion.

As the unreferenced data is not copied, the space usage of tape pool improves and the total available capacity of tape pool increases. The source tape remains in the same tape pool after the successful completion of the command, if --unassign option is not specified.

Note: This command works for the source tape in one of the following states:
  • appendable
  • append_fenced
  • full
  • data_full
  • recall_only
It selects a tape in the appendable state as the target of operation.

Depending on the amount of data to be copied from the source tape to the target tape, the command can occupy a pair of tape drives and tapes for hours. Use the -L or -S options to let the command exit when it reaches a specified limit before it copies all the active data from the source tape, which allows other tasks to preempt the tape drives and tapes. If you later run the eeadm tape reclaim command for the same tape, the command resumes where the previous command suspended.

If the tape IDs are not specified, the eeadm tape reclaim command selects up to five tapes, or the number of tapes that are specified by the -n option that meet the criteria that are specified by the -G and -U options.

Before you run this command, all GPFS file systems must be mounted so that the command is able to check for the existence of the files on disk.

Syntax

eeadm tape reclaim <list_of_tapes> -p <pool> [-l <library>] [OPTIONS]
Required parameters
<list_of_tapes>
Specifies the tape ID (VOLSER) to reclaim, or multiple tape IDs that are separated by a space.

If a tape is in either a full or recall_only state, specify only one tape but without the -L option.

-p, --pool <pool>
Specifies the name of the tape pool to which the specified tapes belong.
-l, --library <library>
Specifies the name of the tape library where the tapes are managed. In a single tape library configuration, this option can be omitted.
Optional parameters
-C, --strict-check
A strict check is performed. It checks whether the file name on the disk and on the tape are identical. If there is a mismatch, the command fails, and you must run the eeadm tape reconcile command with the --commit-to-tape option first.
-m, --max-procs <max_tapes>
Specify the maximum number of source tapes to concurrently process. A task uses a pair of tape drives for each source tape, and it consumes two times the number of tape drives as specified by <max_tapes>. If this option is omitted, the task uses all idle tape drives whose roles have the g attribute, and whose drive types are compatible with the tape.
--unassign
Unassigns the source tape from the pool after the reclamation.
--use-readonly-drive
Allow to use read only drive for source tapes. The reclaim operation won't be interrupted by recall when this option is specified. The pacing options (-L and -S) and --use-readonly-drive are mutually exclusive.
Common options
--async
Runs the command in the background. Use the eeadm task list command to check the progress and result.
-h, --help
Shows this help text and exit.
Pacing option (if only one tape ID is specified)
-L, --stop-by-filecount <number_of_files>
Defines the maximum number of files to process with a single command.
-S, --stop-by-size <size_limit>
Defines the maximum amount in GiB to be processed with a single command.

The -L and -S options are mutually exclusive. It is suggested to specify --unassign option with -L and -S options to know that the command copied all the active contents of source tape.

Tape Selection Options (if <list_of_tapes> is not supplied)
-G, --choose-by-reclaimable <min_reclaimable_percent>
Defines the criteria of tapes that are selected as the source for reclamation. A tape is eligible for reclamation if the estimated reclaimable capacity of the tape exceeds the specified percentage. The default value is 75.
-n, --num-tapes <number_of_tapes>
Selects the specified number of tapes from the tape pool, and processes them. The default value is 5. If you make the number as small as possible, you can avoid the continuous allocation of tape drives for this task type.
-U, --choose-by-used <min_used_percent>
Defines the criteria of tapes that are selected as the source for reclamation. A tape is eligible for reclamation if the used capacity of the tape exceeds the specified percentage. The default value is 90.

Return codes

The following definitions apply to the return codes when the --async option is not specified.
0 (zero)
The operation completed successfully for all of the specified tapes, or when no tapes met the tape selection criteria.
Nonzero
The operation failed for all or some of the specified tapes.
If the --async option is specified, the following definitions apply to the return codes.
0 (zero)
The request of the operation was accepted and the new task was created.
Nonzero
The request of the operation was not accepted.

Examples

eeadm tape reclaim T00001JD -p MyPool1
eeadm tape reclaim T00001JD -p MyPool1 -l MyLibrary1 -L 10000
eeadm tape reclaim -p MyPool1 -l MyLibrary1 -n 2 -G 50 -U 95