Chapter 2.

Entering Administrative Commands

This chapter contains information about entering and routing administrative commands. An administrative command includes: Command name: The command name can consist of a single action word, such as HALT, or it can consist of an action word and an object for the action, such as DEFINE DOMAIN. You can enter the entire command name or the abbreviation specified in the syntax diagram for the command. Positional parameters: Some commands have required or optional positional parameters. You must enter positional parameters in the order indicated in the syntax diagram for a command. For example, to copy a policy set: 1. Enter the name of the policy to which the policy set belongs 2. Enter the name of the policy set you want to copy 3. Enter the name you want to assign the copy copy policyset domain1 oldset newset Keyword parameters: Some commands have required or optional keyword parameters. When included in a command, a keyword parameter must follow any positional parameters in the command. Use the equal sign to distinguish between the keyword and the value. A keyword parameter can, for example, provide a description of an object, identify an object (such as a storage pool or policy domain), or specify a setting for an option. You can enter either the entire keyword, or the abbreviation identified in the syntax diagram for the command. For example, to include a description for a new policy domain, enter: define domain acctg description="accounting"

Command Entry Rules

The following are general rules for entering Tivoli Storage Manager administrative commands: Enter a command in any column of the input line. Unless otherwise noted, you can specify commands in any combination of uppercase and lowercase characters. If a parameter allows a list of values, enter the values immediately following the equal sign and delimit the value with a comma. For example, cLasses=policy,storage When you refer to file space names, specify the file space name using the exact capitalization that is used by Tivoli Storage Manager. Use the QUERY FILESPACE command to find out the correct capitalization. If a description (a string of text) for a parameter begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks. For example, if the opening quotation is a single quotation mark, the closing quotation mark must also be a single quotation mark.

For example, to register a new client node named Louie, with a password of secret, and with his title included as contact information, enter: register node louie secret contact="manager of dept. 61f" The following table presents ways of entering a description for the CONTACT parameter. The value can contain quotation marks, embedded blanks, or equal signs.

For this description manager manager's "manager" manager's report manager's "report" manager=dept. 61f manager reports to dept. 61f

Enter this contact=manager contact="manager's" or contact='manager"s' contact='"manager"' or contact="""manager""" contact="manager's report" or contact='manager''s report' contact='manager''s "report"' contact='manager=dept. 61f' contact='manager reports to dept. 61f' or contact="manager reports to dept. 61f"

Processing Administrative Commands

Tivoli Storage Manager processes administrator commands in the foreground or in the background. When administrative commands process, you receive a message indicating: Whether the command completed successfully (in the case of a foreground process) Whether the command was sent to the server to be processed (in the case of a background process)

Tivoli Storage Manager sends a confirmation message when commands are issued that affect the availability of the server or data managed by the server. Tivoli Storage Manager does not send a confirmation message if the command is issued from the server console or from an administrative client with the NOCONFIRM option specified. Tivoli Storage Manager formats the output processed from commands according to your screen or window width. If the width of your screen or window is not wide enough to display the output horizontally, Tivoli Storage Manager arranges and displays the information vertically.

Commands Processed in the Foreground

Foreground processing specifies that each command issued must complete before another command is issued. You can cancel commands processed in the foreground from the server console or another administrative client session. When you issue a QUERY command from the administrative client, multiple screens of output may be generated. If this occurs and additional output is not needed, you can cancel the display of output to the client workstation. While canceling does not end the processing of the command, it ends any further display of command output.

For some commands, you can specify whether to wait for Tivoli Storage Manager to complete processing the command in the foreground before you issue other commands. By including the WAIT parameter, you can specify whether Tivoli Storage Manager processes the following commands in the foreground: BACKUP DB BACKUP STGPOOL DEFINE DBVOLUME DEFINE LOGVOLUME DEFINE VOLUME DELETE FILESPACE DELETE VOLUME EXPIRE INVENTORY EXTEND DB EXTEND LOG MOVE DATA MOVE DRMEDIA PREPARE REDUCE DB REDUCE LOG RESTORE STGPOOL RESTORE VOLUME VARY

Commands Processed in the Background

Background processing specifies that you can enter commands while the server is processing a previously issued command. When you enter a command that creates a background process, Tivoli Storage Manager submits a request to the server to perform the task identified in the command. Each background process is assigned a process number. Use the CANCEL PROCESS command to cancel commands that generate background processes. Use the QUERY PROCESS command to obtain the status and process number of a background process. If a background process is active when you cancel it, the server stops the process. Any changes that are uncommitted are rolled back, however, changes that are committed are not rolled back. The following is a list of commands that can generate background processes: AUDIT LIBRARY AUDIT LICENSES AUDIT VOLUME BACKUP DB BACKUP STGPOOL CHECKIN LIBVOLUME EXPORT POLICY EXPORT SERVER EXTEND LOG IMPORT ADMIN IMPORT NODE IMPORT POLICY

CHECKOUT LIBVOLUME DEFINE DBCOPY

IMPORT SERVER MOVE DATA MOVE DRMEDIA

DEFINE LOGCOPY MOVE MEDIA DELETE DBVOLUME PREPARE DELETE FILESPACE REDUCE DB DELETE LOGVOLUME REDUCE LOG DELETE VOLUME RESTORE STGPOOL EXPIRE INVENTORY RESTORE VOLUME EXPORT ADMIN VARY EXPORT NODE

Using Wildcard Characters

In some commands, such as the query commands, you can use wildcard characters to create a patternmatching expression that specifies more than one object. Using wildcard characters makes it easier to tailor a command to your needs. The wildcard characters you use depend on the operating system from which you issue commands. For example, you can use wildcard characters such as an asterisk (*) to match any (0 or more) characters or you can use a question mark (?), or a percent sign (%) to match exactly one character. Table 1 provides references to wildcard characters for some operating systems. Use wildcard characters appropriate for your system. Table 1. Wildcard Characters by Environment Environment AIX, UNIX , HP-UX, DOS, OS/2 , SunOS, (R) Windows AS/400 , CMS, TSO
(R) (R) (R)

Match-Any * *

Match-Exactly-One ? %

For example, if you want to query all the management classes whose names begin with DEV in all the policy sets in DOMAIN1, and your system uses an asterisk as the match-any character, you can enter: query mgmtclass domain1 * dev*

However, if your system uses a question mark as the match-exactly-one character, and you want to query the management classes in POLICYSET1 in DOMAIN1 you can enter: query mgmtclass domain1 policyset1 mc? Tivoli Storage Manager displays information about management classes with names MC.

Examples for Match-Any Characters

Table 2 shows additional examples using wildcard characters to match any characters. Table 2. Match-Any Character Pattern ab* ab*rs ab*ef*rs Matches ab, abb, abxxx Does Not Match a, b, aa, bb

abrs, abtrs, abrsrs ars, aabrs, abrss abefrs, abefghrs abefr, abers

Examples for Match-Exactly-One Character

Table 3 shows additional examples using wildcard characters to match exactly one character. The question mark (?) can be replaced by a percent sign (%) if your platform uses that character instead of (?). Table 3. Match-Exactly-One Character Pattern ab? ab?rs Matches abc abfrs Does Not Match ab, abab, abzzzz abrs, abllrs abefrs, abdefrs, abefjrs

ab?ef?rs abdefjrs ab??rs

abcdrs, abzzrs abrs, abjrs, abkkkrs

Naming Conventions in Tivoli Storage Manager

When you use DEFINE commands to define volumes for the database, recovery log and storage pools, the naming convention for the volume name is dependent on the type of sequential access media or random access media you are using. This publication provides the command syntax and rules to follow when naming these volumes.

Naming Objects in Tivoli Storage Manager

Tivoli Storage Manager restricts the number and type of characters that you can use to name objects. The following characters are available for defining object names.

A-Z 0-9 _ . + & Note:

Any letter, A through Z Any number, 0 through 9 Underscore Period Hyphen Plus Ampersand A password is not case sensitive.

The following table shows the maximum length of characters permitted for naming objects. Type of Name Administrators, client option sets, client nodes, passwords, server groups, server names Device classes, management classes, policy domains, profiles, schedules, scripts, backup sets storage pools Maximum Length 64 30

Routing Commands
Command routing allows you to route commands to one or more servers for processing. Command routing allows the server that originated the command to route the command to multiple servers and then to collect the output from these servers. For information about how to setup and manage multiple servers for command routing, see the Administrator's Guide. Routing commands to other servers requires that administrators have the same administrator ID and password as well as the administrative authority required on each server to which the command is being routed. Administrators cannot route commands to other servers from the server console. Each server identified as the target of a routed command must first be defined using the DEFINE SERVER command. The command is automatically routed to all servers specified as members of a server group or to individual servers specified with the command. After the command has completed processing on all servers, the output displays, in its entirety, for each server. For example, the output from SERVER_A displays in its entirety, followed by the output from SERVER_B. The output includes summary messages for each individual server and identifies which server processed the output. Return codes indicate whether or not commands processed on the servers successfully. These return codes will include one of three severities: 0, ERROR, or WARNING.

Examples of Routing Commands

The following examples describe how to route the QUERY STGPOOL command to one server, multiple servers, a server group, multiple server groups, or a combination of servers and server groups. Each server or server group in a list must be separated with a comma, without spaces. When routing commands inside scripts, you must enclose the server or server group in parentheses and omit the colon.

Routing Commands to a Single Server: To route the QUERY STGPOOL command to a server named ASTRO, enter: astro: query stgpool The colon after the server name indicates the end of the routing information. This is also called the server prefix. Another way to indicate the end of routing information is to use parentheses around the server name, for example: (astro) query stgpool Routing Commands to Multiple Servers: To route the QUERY STGPOOL command to multiple servers named HD_QTR, MIDAS, SATURN, enter: hd_qtr,midas,saturn: query stgpool or (hd_qtr,midas,saturn) query stgpool If the first server has not been defined to Tivoli Storage Manager, the command is routed to the next defined server in the list of servers. Routing Commands to a Server Group: To route the QUERY STGPOOL command to a server group named ADMIN, enter: admin: query stgpool or (admin) query stgpool If the server group ADMIN has servers named SECURITY, PAYROLL, PERSONNEL defined as group members, the command is routed to each of these servers. Routing Commands to Server Groups: To route the QUERY STGPOOL command to two server groups named ADMIN2 and ADMIN3, enter: admin2,admin3: query stgpool or (admin2,admin3) query stgpool If the server group ADMIN2 has servers SERVER_A, SERVER_B, and SERVER_C defined as group members, and server group ADMIN3 has servers ASTRO, GUMBY, and CRUSTY defined as group members, the command is routed to servers SERVER_A, SERVER_B, SERVER_C, ASTRO, GUMBY, and CRUSTY. Routing Commands to Two Servers and a Server Group: To route the QUERY STGPOOL command to a server group named DEV_GROUP and to the servers named MERCURY and JUPITER, enter:

dev_group,mercury,jupiter: query stgpool or (dev_group,mercury,jupiter) query stgpool If the server group DEV_GROUP has servers SALES, MARKETING, and STAFF defined as group members, the command is routed to servers SALES, MARKETING, STAFF, MERCURY, and JUPITER. Routing Commands Inside Scripts: When routing commands inside scripts, you must enclose the server or server group in parentheses and omit the colon. Otherwise, the command will not be routed when the RUN command is issued, and will only be run on the server where the RUN command is issued. For example, to route the QUERY STGPOOL command inside a script: 1. Define a script called QU_STG to route it to the DEV_GROUP server group: 2. define script qu_stg "(dev_group) query stgpool" 3. Run the QU_STG script: 4. run qu_stg If the server group DEV_GROUP has servers SALES, MARKETING, and STAFF defined as group members, the QUERY STGPOOL command is routed to these servers.