Using the OS/2 Backup-Archive Client


Entering Options With a Command

Follow these general rules when you enter options with a command:


Table 4. Using Options With Commands
Option Description Commands Page
Archmc Overrides the default management class for a file or a group of files. Archive Archmc
Deletefiles Deletes the local copy of files from your workstation after they are archived on the server. Archive Deletefiles
Description Specifies a description for a file that you are archiving, deleting, or retrieving.
Archive
Delete  Archive
Query  Archive
Retrieve

Description
Detail Displays management class attributes for available management classes. Query Mgmtclass Detail
Dirsonly Depending on the command; backs up, restores, or displays specified directories.
Incremental
Query Archive
Query Backup
Restore
Retrieve
Selective

Dirsonly
Filesonly Depending on the command; backs up, restores, or displays specified files.
Archive
Incremental
Query Archive
Query Backup
Restore
Retrieve
Selective

Filesonly
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

Fromdate
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

Fromnode
Fromowner Displays file spaces for an alternate owner. Also specifies an alternate owner from which to restore or retrieve files.
Query Archive
Query Backup
Query Filespace
Restore
Retrieve

Fromowner
Fromtime Used with the fromdate option to specify a beginning time on the specified date.
Query  Archive
Query Backup
Restore
Retrieve

Fromtime
Ifnewer Replaces existing files with the latest backup version if the backup version is newer than the existing version. Restore Ifnewer
Inactive Displays inactive backup versions of files.
Query Backup
Restore

Inactive
Incrbydate Requests an incremental backup by date. Incremental Incrbydate
Latest Restores the most recent backup version of a file whether it is active or inactive. Restore Latest
Noprompt Suppresses the confirmation prompt when deleting an archived file. Delete Archive Noprompt
Pick Displays a list of files from which you can select the ones to delete, restore, or retrieve.
Delete  Archive
Restore
Retrieve

Pick
Pitdate Specifies the file backup date to be used when ADSM selects files to be restored.
Query Backup
Restore

Pitdate
Pittime Used with pitdate to specify a beginning time on the specified date.
Query Backup
Restore

Pittime
Preservepath Specifies how the restore directory path is built.
Restore
Retrieve

Preservepath
Todate Sets a time limit for files. ADSM does not include files that are processed after this date.
Query Archive
Query  Backup
Restore
Retrieve

Todate
Totime Used with the todate option. Specifies an ending time on the specified date.
Query Archive
Query
 Backup
Restore
Retrieve

Totime
Volinformation Backs up or restores volumes.
Restore
Selective 

Volinformation

Command Line Options

The following sections contain descriptions of the client command options including syntax diagrams and parameters.

Archmc

Use the archmc option to override the default management class in the active policy set of your policy domain.

Syntax

>>-ARCHMc- managementclass-------------------------------------><
 

Parameters

managementclass

Names an available management class in the active policy set of your policy domain. This management class overrides the assigned management class for the files you are archiving.

Examples

Options file:
Does not apply.

Command line:
archive -archmc=ret2yrs c:\plan\proj1\budget.jan

Deletefiles

Use The deletefiles option to delete archived files from your workstation after they are stored on the server.

Syntax

>>-DELetefiles-------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
archive -deletefiles

Description

Use the description option to assign a description to a file when you archive it. If you do not remember the name of an archived file, you can use the description option to retrieve the file. For example, if you want to archive a file named budget.jan and assign the description 1997 Budget for Proj 1 to it, you would enter:

   archive -des="1997 Budget for Proj 1" c:\plan\proj1\budget.jan

Syntax

>>-DEScription- description------------------------------------><
 

Parameters

description

Assigns a description to the file you are archiving. If you use the archive command to archive more than one file, the description you enter is assigned to each of the files. For example, to archive a group of files and assign the same description, Project X, to each file, you would enter:
dsmc archive -description="Project X" c:\allproj\*.x

You can then use the description to retrieve all of the files.

Examples

Options file:
Does not apply.

Command line:
-des="1997 Budget for Proj 1"

Detail

Use the detail option to display detailed information about each management class in your active policy set. If you do not use the detail option, ADSM displays only the management class name and a brief description. Specifying the detail option tells ADSM to display information about attributes in each copy group contained in each management class. A management class can contain a backup copy group, an archive copy group, both, or neither.

Syntax

>>-DETail------------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
query mgmtclass -detail

Dirsonly

Use the dirsonly option to archive, retrieve, restore, or display directories for files that you select.

Syntax

>>-DIrsonly----------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
backup -dirsonly

Filesonly

Use the filesonly option to only include files when processing a supported command. During backup, placeholders for the directories are sent to the server, however, the directory attributes are not sent. For restore, the directory structure is rebuilt, but directory attributes are not recreated. The filesonly option only affects displaying names when used with one of the query commands.

Syntax

>>-FILESOnly---------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
incremental -filesonly "*"

Fromdate

Use the fromdate option to set a date from which you want to look for backed up files. ADSM does not include files processed before this date, although older directories might be included.

Syntax

>>-FROMDate- date----------------------------------------------><
 

Parameters

date

Specifies the date from which you want ADSM to look for backups. Enter the date in the format you selected with the dateformat option.

Examples

Options file:
Does not apply.

Command line:
-fromdate=12/11/1997

Fromnode

Use the fromnode option to affect which files are sent by the server.

Syntax

>>-FROMNode- node----------------------------------------------><
 

Parameters

node

Specifies the location name on a workstation or file server where archive files exist.

Examples

Options file:
Does not apply.

Command line:
query archive -fromnode=bob -subdir=Yes {floppy-a002}*

Fromowner

Use the fromowner option to specify an alternate owner from which to restore files. The owner must grant access to use the files. For example, to restore files from the d:\u\devel\proja directory belonging to user1, and place the restored files in a directory you own named d:\u\id\proja, enter:

 restore -fromowner=user1 d:\u\devel\proja user_a

Syntax

>>-FROMOwner- owner--------------------------------------------><
 

Parameters

owner

Name of alternate owner.

Examples

Options file:
Does not apply.

Command line:
archive -fromowner=\u\id\proja

Fromtime

Use the fromtime option with the fromdate and/or totime option to specify a beginning time or a window of time. For example, to list files beginning with those backed up on or after 5:00 AM on June 30, 1997, or those backed up between 5:00 AM on June 30, 1997 and 12:00 AM on July 15, 1997. This option is ignored if the fromdate option is not supplied.

Syntax

>>-FROMTime- time----------------------------------------------><
 

Parameters

time

Specifies a beginning time on the date supplied with the fromdate option.

Examples

Options file:
Does not apply.

Command line:
-fromt=11:59AM -fromd=06/30/97

Ifnewer

Use the ifnewer option to instruct ADSM to replace an existing file with the backup if the backup is newer than the existing file. This option is ignored if the replace option is No.

Only active backups are considered unless you also use the inactive or latest options.

Syntax

>>-IFNewer-----------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
restore -ifnewer

Inactive

Use the inactive option to instruct ADSM to restore an inactive backup if an active one is not available. Use the pick option to display both active and inactive backups in order to select a backup version that is older than the most recent backup.

Only active backups are considered unless you also use the inactive or latest options.

Syntax

>>-INActive----------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
-inactive

Incrbydate

Use the incrbydate option to determine the date and time of the last incremental backup. If the date and time of the file's most recent changes are later than those of the last backup, the file is backed up. If the changes are earlier, the file is not backed up, even if it is a new file.

Files are not expired or rebound on the server. The copy mode frequency attribute of the management classes is ignored.

Syntax

>>-INCRbydate--------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
incremental -incrbydate

Latest

Use the latest option to restore the most recent backup version of a file, even if the backup is inactive. Only active versions are considered for restore unless you use the inactive or latest options.

Syntax

>>-LATest------------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
restore -latest c:\devel\projecta

Noprompt

Use the noprompt option to suppress the confirmation prompt when deleting an archived file.

Syntax

>>-NOPRompt----------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
del archive c:\proja\*.prj -noprompt

Pick

Use the pick option to cause the restore, retrieve, and delete archive commands to present a list of files from which you may select entries to process. If you also enter the inactive option on the restore command, the list will contain both active and inactive versions..

Syntax

>>-PIck--------------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
restore c:\project\* -pick -inactive

Pitdate

Use the pitdate option, and optionally the pittime option to specify a point in time to list or restore backed-up files. ADSM lists or restores the latest versions of files backed up (but not deleted) on or before the pitdate/pittime. If necessary, inactive versions are used to complete the list.

Specify the date in the format you selected with the dateformat option. For example, the American English standard for the date is:

   date format 1 (mm/dd/yyyy)

If you include the dateformat option with the command, it must precede the pitdate option. It may not be possible to fully restore the file set as it existed at the specified point in time, depending on the version retention values defined by your ADSM administrator.

Syntax

>>-PITDate- date-----------------------------------------------><
 

Parameters

date

Specifies the appropriate date.

Examples

Options file:
Does not apply.

Command line:
restore -pitdate=08/01/1997

Pittime

Use the pittime option with the pitdate option to specify a point in time. ADSM will list (query backup) or restore the latest version of backed-up files as they existed on the server at that point in time. If files on your workstation have been changed or deleted since the specified date/time, ADSM will attempt to list/restore those files as they were at that time, using inactive vrsions if necessary. Client files created since the specified date/time are not deleted. The pittime option is ignored if the pitdate option is not entered.

Syntax

>>-PITTIME- time-----------------------------------------------><
 

Parameters

time

Specifies a time.

Examples

Options file:
Does not apply.

Command line:
query -pittime=06:00:00 -pitdate=08/01/1997

Preservepath

Use the preservepath option to control how much of the original path is recreated by ADSM when restoring to an alternate location. Use -subdir=yes to restore the entire subtree of the source directory under the target directory, starting with the lowest-level source directory. If a required directory/subdirectory does not exist, it is created. If a target file has the same name as a source file, it is overlaid. Use -replace to be prompted before files are overwritten.

Syntax

>>-PRESERvepath-+- complete--+---------------------------------><
                +- subtree---+
                '- none------'
 

Parameters

complete

Causes the entire path, starting from the root, to be restored into the specified directory. The entire path includes all files and directories except the filespace name.

subtree

Creates the lowest-level source directory as a subdirectory of the target directory. Files from the source directory are stored in the new subdirectory.

none

Restores all selected source files to the target directory.

Examples

Options file:
Does not apply.

Command line:
-preservepath

Todate

Use the todate option to specify the latest backup or archive date of files to be listed, restored, or retrieved (depending on what command is issued). ADSM does not list files archived after the specified date. Use this option with the fromdate option to list files backed up or archived between the from date and the to date.

Syntax

>>-TODate- date------------------------------------------------><
 

Parameters

date

Specifies an ending date.

Examples

Options file:
Does not apply.

Command line:
-todate=07/14/1997

Totime

Use the totime option with the todate option to specify an ending time on the specified date. For example, you could request a list of files that were backed up or archived on or before 11:59 PM on June 30, 1997.

Use totime and todate with fromtime and fromdate to request a list of files that were backed up or archived within a window of time. For example, you could request a list of files archived or backed up between 6:00 AM on July 1, 1997 and 11:59 PM on July 30, 1997.

Time must be in the format selected with the timeformat option. The default for totime is 23:59:59. When included in the command, the timeformat option must precede the fromtime and totime options.

Syntax

>>-TOTime- time------------------------------------------------><
 

Parameters

time

Specifies an ending time.

Examples

Options file:
Does not apply.

Command line:
restore -totime=23:00:00

Volinformation

Use the volinformation option to backup volume restrictions such as volume or disk space restrictions and trustee directory assignments for the root directory of a volume. This option works only when you are backing up or restoring non-root files.

Syntax

>>-VOLinformation----------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
Does not apply.

Command line:
selective -vol sys:


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]