Using the UNIX Backup-Archive Clients

Entering Client Commands

A client command can include one or more of these components:

• Command name
• Options
• Parameters.

The sections that follow describe each of these components.

Command Name

The first part of a command is the name that identifies it. The command name consists of a single word, such as help or schedule, or an action word and an object for that action, such as query archive. Enter the full command name, the minimum abbreviation, or an abbreviation containing the minimum abbreviation allowed. For example, you can enter any of the following versions of the query schedule command:

   query schedule
   q sc
   q sched
   query sc

Options

There are two groups of options that you can use with commands. They are:

• Client options. The group of options that are set in your client options file. To override any option in that file, enter the option with an ADSM command. For specific information about using these client options, go to "Using Options With Commands". In addition, you can specify any of the client options listed in Figure 28 on any of the commands.
  

  Figure 28. Client Options Valid on all Commands
  

  Client Option	Client Option	Client Option
  commmethod compression compressalways cpicbuffersize cpicmodename dateformat domain errorlogname editor errorlogretention followsymbolic language largecommbuffers maxcmdretries nfstimeout nodename	numberformat optfile partnerluname password passwordaccess postnschedulecmd postschedulecmd prenschedulecmd preschedulecmd queryschedperiod quiet retryperiod schedlogname schedlogretention schedmode	scrolllines scrollprompt servername symbolicdestination tapeprompt tcpbuffsize tcpclientaddress tcpclientport tcpport tcpserveraddress tcpwindowsize timeformat verbose virtualmountpoint virtualnodename

• Client command options. The group of options that you can use with specific commands on the command line only. Figure 29 provides an alphabetical list of the command-line options, a brief description, and the commands on which they are used. For specific information about using these client command options, go to Chapter 7. "Using Options With Commands".
  

  Figure 29. Command-Line Options
  

  Option	Description	Commands
  archmc	Overrides the assigned management class for a file or a group of files.	Archive
  deletefiles	Deletes the local copy of files from your workstation after they are archived on the server.	Archive
  description	Specifies a description for a file that you are archiving, deleting, or retrieving.	Archive Delete Archive Query Archive Retrieve
  detail	Displays management class attributes for available management classes.	Query Mgmtclass
  dirsonly	Backs up or restores only directories.	Archive Incremental Query Archive Query Backup Restore Retrieve Selective
  filesonly	Backs up or restores only files.	Archive Incremental Query Archive Query Backup Restore Retrieve Selective
  fromdate	Sets a date limit for files. ADSM does not include files processed before this date when it processes the command, although older directories might be included.	Query Archive Query Backup Restore Retrieve
  fromnode	Displays file spaces on an alternate node. Also specifies an alternate node from which to restore or retrieve files.	Query Archive Query Backup Query Filespace Query Mgmtclass Restore Retrieve
  fromowner	Displays file spaces for an alternate owner. Also specifies an alternate owner from which to restore or retrieve files.	Query Archive Query Backup Restore Retrieve
  fromtime	Used with the fromdate option to specify a beginning time on the specified date.	Query Archive Query Backup Restore Retrieve
  ifnewer	Replaces existing files with the latest backup version if the backup version is newer than the existing version.	Restore
  inactive	Displays inactive backup versions of files.	Query Backup Restore
  incrbydate	Requests an incremental backup by date.	Incremental
  latest	Restores the most recent backup version of a file whether it is active or inactive.	Restore
  noprompt	Suppresses the verification prompt when deleting an archived file.	Delete Archive
  pick	Displays a list of files from which you can choose the ones to delete, restore, or retrieve.	Delete Archive Restore Retrieve
  pitdate	Specifies the file backup date to be used when ADSM selects files to be restored.	Query Backup Restore
  pittime	Used with pitdate to specify a beginning time on the specified date.	Query Backup Restore
  preservepath	Specifies how the restore directory path is built.	Restore Retrieve
  todate	Sets a date limit for files. ADSM does not include files that are processed after this date.	Query Archive Query Backup Restore Retrieve
  totime	Used with the todate option. Specifies an ending time on the specified date.	Query Archive Query Backup Restore Retrieve
  volinformation	Backs up or restores volume restrictions such as volume or disk space restrictions and trusted directory assignments for the root directory of a volume.	Archive Incremental Restore Retrieve Selective

Parameters

Commands have either required parameters, optional parameters, or none, for example, query mgmtclass has no parameters, only options. Required parameters provide information to perform a task. The most commonly required parameter is a file specification. For example, if you want to archive a file named budget.fin from the /project directory, you would enter:

   dsmc archive /project/budget.fin

Some commands have optional parameters. If you do not enter a value for an optional parameter, ADSM uses the default value. For example, the restore command includes a required parameter, sourcefilespec, that identifies the path and file name in ADSM storage that you want to restore, and an optional parameter, destinationfilespec, that identifies where you want to place the restored files. If you do not use destinationfilespec, by default, ADSM restores the files to the original source path. If you want to restore the files to a different directory, enter a value for destinationfilespec. For example, to restore /project/budget.fin to /newproj/newbudg.fin, you would enter:

   dsmc restore /project/budget.fin /newproj/newbudg.fin

Enter parameters in the order indicated in the command syntax diagram.

Filespec Syntax

Use the following syntax rules when specifying file specification parameters, such as filespec, sourcefilespec, and destinationfilespec:

• If a file specification does not begin with a filespace name (an opening directory delimiter) the file specification is assumed to be a subdirectory of the current working directory and ADSM builds the fully-qualified file specification. For example, if the current working directory is /home/me, then the destinationfilespec would be /home/me/mydir in the following command:

  restore /fs/dir1/* mydir/
  

• The only command which will accept a simple file space name is the incremental command. The following example is valid:

  dsmc i /fs
  

  The following example is not valid:

  dsmc sel /fs
  

• When specifying sourcefilespec, if the directory name ends with /, then /* is implied unless the dirsonly option is specified.

  When specifying a file specification, if the name ends with /, then it is considered a directory, otherwise it is considered a file.

  The following example illustrates these two rules, even though mydir and yourdir are both directories, the command will fail because /* is implied after mydir, and yourdir is considered a file:

  restore /home/mydir/ /away/yourdir
  

  The following example illustrates the second rule, even though mydir and yourdir are both directories, the command will fail because mydir and yourdir are considered as files:

  restore /home/mydir /away/yourdir
  

• Do not use wildcards as part of the filespace name or anywhere in the destinationfilespec. The one exception to this rule is the set access command where wildcards are allowed in the two lowest-level parts of the filespec. For example, use the following command to grant access to all files in and below the /fs/dir1 directory:

  set access /fs/dir1/*/*