Administrator's Reference
Use this command to identify, move, and track sequential access primary and
copy storage pool volumes that are managed by an automated library (including
an external library).
This command processes one or more sequential access storage pool
volumes. The volumes moved by the MOVE DRMEDIA command for offsite
recovery are not processed by the MOVE MEDIA command.
This command generates a background process that can be cancelled with the
CANCEL PROCESS command. To display information on background processes,
use the QUERY PROCESS command.
You can use the QUERY ACTLOG command to view whether the MOVE MEDIA command
was successful. You can also view this information from the server
console.
Privilege Class
To issue this command, you must have one of the following privilege
classes:
- If the CMD parameter is specified and the REQSYSAUTHOUTFILE server
option is set to NO: operator, unrestricted storage, or system
privilege.
- If the CMD parameter is specified and the REQSYSAUTHOUTFILE server
option is set to YES (the default): system privilege.
Syntax
>>-MOVe MEDia---volume_name----STGpool--=--pool_name------------>
>-----+----------------+---------------------------------------->
'-Days--=--days--'
>-----+---------------------------------------+----------------->
'-WHERESTate--=--+-MOUNTABLEInlib----+--'
'-MOUNTABLENotinlib-'
>-----+----------------------------------+---------------------->
| .-,------------. |
| V | |
'-WHERESTATUs--=----+-FULl----+--+-'
+-FILling-+
'-EMPty---'
>-----+--------------------------+------------------------------>
'-ACCess--=--+-READWrite-+-'
'-READOnly--'
.-REMove--=--Yes------.
>-----+---------------------------+---+---------------------+--->
'-OVFLOcation--=--location--' '-REMove--=--+-No---+-'
+-Yes--+
'-Bulk-'
>-----+--------------------+---+----------------------------+--->
'-CMd--=--"command"--' '-CMDFilename--=--file_name--'
.-APPend--=--No------. .-CHECKLabel--=--Yes-----.
>-----+--------------------+---+------------------------+------><
'-APPend--=--+-No--+-' '-CHECKLabel--=--+-Yes-+-'
'-Yes-' '-No--'
Parameters
- volume_name (Required)
- Specifies the name of the sequential access primary or copy storage pool
volume to be processed. You can use a wildcard character to specify the
name. All matching volumes are considered for processing.
- STGpool (Required)
- Specifies the name of the sequential access primary or copy storage pool
that is used to select the volumes for processing. You can use a
wildcard character to specify the name. All matching storage pools are
processed. If the storage pool specified is not managed by an automated
library, no volumes are processed.
- Days
- Specifies the number of days that must elapse after the volume has been
written or read, and before the volume is eligible for processing by the MOVE
MEDIA command. This parameter is optional. You can specify a
number from 0 to 9999. The default value is 0. The most recent
of the volume's last written date or last read date is used to calculate
the number of days elapsed.
- WHERESTate
- Specifies the state of the volumes to be processed. This parameter
is used to restrict processing to the volumes that are currently in the
specified state. This parameter is optional. The default value
is MOUNTABLEINLIB.
Possible values are:
- MOUNTABLEInlib
- Specifies that storage pool volumes are to transition from the
MOUNTABLEINLIB state to the MOUNTABLENOTINLIB state. Volumes in the
MOUNTABLEINLIB state contain valid data and are in the library.
- MOUNTABLENotinlib
- Specifies that storage pool volumes are to change from the
MOUNTABLENOTINLIB state back to the MOUNTABLEINLIB state. Volumes in
the MOUNTABLENOTINLIB state may contain valid data and are in the overflow
location.
For empty scratch volumes, the MOVE MEDIA command deletes the
volume records so that they can be used again.
For private volumes, the MOVE MEDIA command resets the volume
location to blank, changes the volumes's state to CHECKIN, and changes
the last update date to the current date.
For scratch volumes with data, the MOVE MEDIA command resets
the volume location to blank, changes the volumes's state to CHECKIN, and
changes the last update date to the current date.
Note: | Volumes in the CHECKIN state may contain valid data and need to be checked
into the library.
|
- WHERESTATUs
- Specifies that the move process should be restricted by volume
status. This parameter is optional. You can specify more than
one status in a list by separating each status with a comma and no intervening
spaces. If you do not specify a value for this parameter, volumes moved
from the MOUNTABLEINLIB state to the MOUNTABLENOTINLIB state are restricted to
only full volumes, and volumes moved from the MOUNTABLENOTINLIB state to the
MOUNTABLEINLIB state are restricted to only empty volumes.
Possible values are:
- FULl
- Specifies to move volumes with a status of FULL.
- FILling
- Specifies to move volumes with a status of FILLING.
- EMPty
- Specifies to move volumes with a status of EMPTY.
- ACCess
- Specifies how users and system processes access files in the storage pool
volume that is moved out from an automated library and stored in an overflow
location by the MOVE MEDIA command. This parameter is optional.
If you do not specify a value for this parameter, moving volumes from the
MOUNTABLEINLIB state to the MOUNTABLENOTINLIB process will update
volume's access mode to READONLY, and moving volumes from the
MOUNTABLENOTINLIB state to the MOUNTABLEINLIB process will update the
volume's access mode to READWRITE.
Possible values are:
- READWrite
- Specifies that users and system processes can read from and write to files
stored on the volume that is in the overflow location. If this value is
specified, TSM requests the volume to be checked into the library when the
volume is needed for a read or write operation.
- READOnly
- Specifies that users and system processes can only read files stored on
the volume that is in the overflow location. TSM requests the volume to
be checked into the library only when the volume is needed for a read
operation.
- OVFLOcation
- Specifies the overflow location that is the destination of the volumes
being processed. The maximum length of the location name is 255
characters. The location name information must be enclosed in quotation
marks if it contains any blank characters. If you do not specify an
overflow location and the storage pool also has no overflow location
identified, TSM changes the location of the ejected volume to a null string
("").
- REMove
- Specifies whether TSM ejects the volumes from the library. This
parameter is optional. The default is YES. Possible values
are:
- Yes
- Specifies that the volume is ejected from the library. The volume
entry is deleted from the TSM library inventory. This option applies to
all automated libraries.
- No
- Specifies that the volume is not ejected from a SCSI library. This
option only applies to a SCSI library. This option deletes the volume
entry from the TSM library inventory and leaves the volume in its slot.
The REMOVE=NO option does not apply to a 349x library. For a 349x
library, the volume is always ejected from the library even if REMOVE=NO is
specified on the MOVE MEDIA command. The REMOVE=NO option does not
apply to a library type of EXTERNAL.
- Bulk
- This option does not apply to a library type of EXTERNAL.
- For 349x libraries: Specifies that the volume is ejected
to a predefined high capacity area in the library, instead of an I/O
station.
- For SCSI libraries with multiple Entry/Exit ports:
Specifies that the volume is ejected to the next available Entry/Exit
port. An informational message is issued stating that the tape volume
should be removed from the Bulk I/O station at the convenience of the
operator. The user is not prompted to issue the REPLY command.
After all Entry/Exit ports are full, the cartridge is left in its home cell
and a message is issued stating that the tape volume should be removed from
its home cell at the convenience of the operator. This message provides
the home cell's element number, which in some libraries may require an
element map to identify it. If you specify this parameter for a SCSI
library that does not have multiple Entry/Exit ports, TSM leaves the volume at
its home cell.
- CMd
- Specifies the creation of executable commands. This parameter is
optional. You must enclose your command specification in quotation
marks. The maximum length of the command specification is 255
characters. For each volume successfully processed by the MOVE MEDIA
command, TSM writes the associated commands to a file. Specify the file
name with the CMDFILENAME parameter. If you do not specify the
filename, the MOVE MEDIA command will generate a default filename by appending
the string "exec.cmds.media" to the TSM server directory.
If the length of the command written to the file exceeds 255 characters, it
is split into multiple lines and a continuation character, +, is added to all
but the last line of the command. You may need to alter the
continuation character according to the requirements of the product that
executes the commands.
If you do not specify CMD, the MOVE MEDIA command will not generate any
executable commands.
- string
- Specifies the string to build an executable command. You can
specify any free form text for the string. Enclose the full string in
quotation marks. For example, the following is a valid executable
command specification:
CMD="UPDATE VOLUME &VOL"
The following is an invalid executable command specification:
CMD=""UPDATE VOLUME" &VOL"
- substitution
- Specifies a variable for which you want the command to substitute a
value. The possible substitution variables are:
- &VOL
- Specifies to subsititute the volume name for &VOL. You can
specify lowercase characters, &vol. No spaces or blanks are allowed
between ampersand, &, and VOL. If there are spaces or blanks
between ampersand and VOL, the MOVE MEDIA command will treat them as strings
and no substitution will be set. If &VOL is not specified, no
volume name is set in the executable command.
- &LOC
- Specifies to substitute the volume for &LOC. You can specify
lowercase characters, &loc. No spaces or blanks are allowed between
ampersand, &, and LOC. If there are spaces or blanks between
ampersand and LOC, the MOVE MEDIA command will treat them as strings and no
substitution will be set. If &LOC is not specified, no location
name is set in the executable command.
- &VOLDSN
- Specifies to substitute the volume file name for &VOLDSN. An
example of a storage pool tape volume file name using the default prefix TSM
is TSM.BFS. If &VOLDSN is not specified, no volume file name
is set in the executable command.
- &NL
- Specifies to substitute a new line character for &NL. When
&NL is specified, the MOVE MEDIA command splits the command at the
position where the &NL is and will not append any continuation
character. The user is responsible for specifying the proper
continuation character before the &NL if one is required. The user
is also responsible for the length of the line written. If the &NL
is not specified and the length of the command line exceeds 255, the command
line is split into multiple lines and a continuation character, +, is added to
all but the last line of the command.
- CMDFilename
- Specifies the full path name of a file that will contain the commands
specified with CMD. This parameter is optional. The maximum
length of the file name is 1279 characters. If you do not specify a
file name, the MOVE MEDIA command will generate a default file name by
appending the string "exec.cmds.media" to the TSM server
directory. The server directory is determined in the following
order:
- If defined, the directory pointed to by the DSMSERV_DIR environment
variable.
- If the DSMSERV_DIR environment variable is not defined, the current
working directory of the TSM server process.
The MOVE MEDIA command automatically allocates the file name specified or
generated. If the file name exists, you can use the APPEND=YES
parameter to add to the file. Otherwise, the file is
overwritten. If a file is accidentally overwritten and you need to run
the commands that had been in the file, issue the QUERY MEDIA command to
rebuild the executable commands for the desired volumes. If the MOVE
MEDIA command fails after the command file is allocated, the file is not
deleted.
- APPend
- Specifies to write at the beginning or ending of the command file
data. The default is NO. Possible values are:
- No
- Specifies to write the data from the beginning of the command file.
If the given command file exists, its contents are overwritten.
- Yes
- Specifies to append the command file by writing at the end of the command
file data.
- CHECKLabel
- Specifies whether TSM should read volume labels for sequential
media. For SCSI devices you can suppress label checking by setting the
CHECKLabel to NO. This parameter is not applicable to 349X
libraries. This parameter is optional. The default is NO.
Possible values are:
- Yes
- Specifies that TSM attempts to read the media label. Reading the
media label verifies that the correct volume is being checked out.
- No
- Specifies that TSM does not attempt to read media label. This
increases performance because the read process does not occur.
Examples
Task 1
Move all full volumes that are in the ARCHIVE sequential primary storage
pool out of the library.
- Command:
- move media * stgpool=archive
Task 2
Generate the CHECKIN LIBVOLUME commands for full and partially full volumes
that are in the ONSITE.ARCHIVE primary storage pool and stored in the
overflow location, Room 2948/Bldg31.
- Command:
- move media * stgpool=onsite.archive
wherestate=mountablenotinlib wherestatus=full,filling
ovflocation=room2948/bldg31 cmd="checkin libvol lib3494 &vol
status=private" cmdfilename=/TSM/move/media/checkin.vols
- Output:
- MOVE MEDIA created the executable commands in
/TSM/move/media/checkin.vols:
+--------------------------------------------------------------------------------+
|------------------------------------------------------------------ |
|checkin libvol lib3494 TAPE04 status=private |
|checkin libvol lib3494 TAPE13 status=private |
|checkin libvol lib3494 TAPE14 status=private |
| ------------------------------------------------------------------ |
+--------------------------------------------------------------------------------+
Note: | Run the CHECKIN LIBVOLUME commands by issuing the TSM MACRO command with
/TSM/move/media/checkin.vols as the macro name.
|
Related Commands
Table 145. Commands Related to MOVE MEDIA
Command
| Description
|
QUERY MEDIA
| Displays information about storage pool volumes moved by the MOVE MEDIA
command.
|
[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]