═══ 1. Introduction ═══

The OS/2 Warp Server Backup/Restore Command Line gives you access to OS/2 Warp 
Server Backup/Restore operations from the OS/2 command line. It not only 
enables you to run backups and restores but also to perform most of the 
operations available from the graphical user interface version of the product. 

This reference assumes that the reader is familiar with basic OS/2 Warp Server 
Backup/Restore concepts such as backup methods, backup sets and file filters. 
This pre-requisite knowledge can be found in the main OS/2 Warp Server 
Backup/Restore user guide and in the on-line help.  If you have never used the 
graphical user interface version of the product you may find it helpful to 
experiment with that first before using the OS/2 Warp Server Backup/Restore 
Command Line 

The OS/2 Warp Server Backup/Restore Command Line was implemented using the OS/2 
Warp Server Backup/Restore C language API.  Therefore if you have programming 
knowledge you may find reading through the C API reference will also help your 
understanding of the command line interface. 

Note:  If you have a version of OS/2 Warp Server Backup/Restore other than the 
English version then commands can be issued in your native language as well as 
in English. To find out what the versions of the command are in your native 
language use the Help command. 


═══ 2. Using the OS/2 Warp Server Backup/Restore Command Line ═══

To run the OS/2 Warp Server Backup/Restore command line interface you must 
first run the API server.  See the Backup/Restore C API Guide and Reference for 
details on running the API server. 

By default the OS/2 Warp Server Backup/Restore Command Line looks for the 
server on the default pipe name.  If you want to communicate with the server on 
a different pipe, or over TCP/IP you can do so by setting the following 
environment variables or system settings. 

Environment Var.  System Setting  Description

PSNS_CONNECTION   Connection      Type of connection, PIPE (default) or TCPIP
PSNS_SERVER       Server          Name of the server
PSNS_PIPE         Pipe            Name of the pipe to use
PSNS_TCPIP        Tcpip           TCPIP configuration, <hostname>:<port #>
PSNS_QUIET        Quiet           Prevents user involvment during command.
                                  Must be YES or NO (or TRUE or FALSE or 1 or 0 )

OS/2 Warp Server Backup/Restore Command Line commands are not case sensitive, 
that is you can use any mix of upper and lower case letters.  However the names 
of OS/2 Warp Server Backup/Restore objects like backup methods and file filters 
are case sensitive so make sure to use the right case when specifying them.  If 
the names have spaces in them these must be included too. 

To run OS/2 Warp Server Backup/Restore Command Line commands simply open an 
OS/2 session, change directory to where you installed OS/2 Warp Server 
Backup/Restore then enter the command at the command prompt.  If you enter a 
command incorrectly the program will respond with an error message and help on 
the relevant command. 


═══ 3. OS/2 Warp Server Backup/Restore Commands ═══

This chapter describes the commands which can be issued via the OS/2 Warp 
Server Backup/Restore Command Line. For information on how to use the command 
line see Using the OS/2 Warp Server Backup/Restore Command Line. 

The following is a list of the commands which are recognised: 

 BackupMethod      To view, create, copy, delete, run or alter a backup method. 
 BackupSet         To view, create, delete, transfer or alter a backup set. 
 Event             To view, create, copy, delete or change a scheduled event. 
 FileFilter        To view, create, copy, delete or alter a file filter. 
 Help              To obtain on-line help for the program. 
 List              To list items which fit certain criteria, such as backup 
                   sets, backup or restore methods, file filters, or storage 
                   devices. 
 RestoreMethod     To view, create, copy, delete, run or alter a restore 
                   method. 
 Rulebook          To view, create, copy, delete or alter a rulebook. 
 Settings          To change or view the settings. 
 SourceDrive       To change, refresh or view the source drive settings. 
 StorageDevice     To change, create, delete or view the storage device 
                   settings. 
 TestServer        To test that a connection to a server is properly 
                   established. 
 Volume            To associate, change, create, delete or view the volume 
                   settings. 


═══ 3.1. BackupMethod ═══

Description 

The BackupMethod command can be used to create backup methods.  Having created 
a backup method it can then be run in order to perform a backup.  The command 
can also be used to change, copy, rename and delete backup methods. 

Syntax 

──BackupMethod─┬─Change─────┬───<Name>───┬───────────────────────┬──
                 ├─Copy───────┤            │ ┌───────────────────┐ │
                 ├─Create─────┤            │                    │ │
                 ├─Delete─────┤            └─┴─<Setting>=<Value>─┴─┘
                 ├─Rename─────┤
                 ├─Run────────┤
                 └─View───────┘

See one of the following for more details: 

 Change            Modifies an existing backup method. 
 Copy              Copies an existing backup method. 
 Create            Creates a new backup method. 
 Delete            Deletes an existing backup method. 
 Rename            Renames an existing backup method. 
 Run               Runs an existing backup method. 
 View              Views all the settings for an existing backup method. 


═══ 3.1.1. Change ═══

Description 

Changes the settings of an existing backup method. 

Note:  To change the name of a backup method use the Rename command. 

Syntax 

─BackupMethod Change ─────<Name>─┬───────────────────────────┬─···
                                   └─Description=<Description>─┘

···┬──────────────────────────┬─···
   └─AllFiles=─┬─TRUE|YES|1─┬─┘
               └─FALSE|NO|0─┘

···┬────────────────────┬─┬────────────────────┬─┬───────────────────────────┬─···
   └Drive=<Drive Letter>┘ └Directory=<Dir Name>┘ └Subdirectories=┬TRUE|YES|1┬┘
                                                                 └FALSE|NO|0┘

···┬─────────────────────────┬─┬────────────────────┬─···
   └UseRulebook=┬TRUE|YES|1┬─┘ └Rulebook=<Rulebook>─┘
                └FALSE|NO|0┘

···┬────────────────────────┬─┬──────────────────────┬─···
   └Compression=─┬─ON──────┬┘ └─Generations=<Number>─┘
                 ├─OFF─────┤
                 └─DEFAULT─┘

···┬───────────────────────────┬─┬────────────────────────┬─···
   └UseFileFilter=┬TRUE|YES|1┬─┘ └FileFilter=<FileFilter>─┘
                  └FALSE|NO|0┘


···┬────────────────────────────┬─┬────────────────────┬─┬──────────────────────┬──
   └ChangedFilesOnly=┬TRUE|YES|1┤ └Preview=┬TRUE|YES|1┬┘ └BackupSet=<Backup Set>┘
                     └FALSE|NO|0┘          └FALSE|NO|0┘

Note:  If the AllFiles setting is set to a TRUE value then the Subdirectories, 
       Drive and Directory settings are all ignored when a backup method is 
       run. 

Similarly if the UseRulebook setting is set to a TRUE value then the 
Compression and Generations settings are ignored when the backup method is run. 

 Examples 

 To turn on compression for the backup method called 'ServerBackup'. 

       psnscl backupmethod change ServerBackup Compression=ON

 To change the description of the 'ServerBackup' backup method. 

       psnscl backupmethod change ServerBackup Description="A full backup"


═══ 3.1.2. Copy ═══

Description 

Copies an existing backup method to a specified new name. 

Syntax 

─BackupMethod Copy <Name> NewName=<Name>─

Examples 

 To make a copy of backup method 'ServerBackup' and give it the name 
 'FullBackup'. 

       psnscl backupmethod copy ServerBackup NewName=FullBackup


═══ 3.1.3. Create ═══

Description 

Creates a new backup method. 

Syntax 

─BackupMethod Create ────<Name>────BackupSet=<Backup Set>─···

···─┬───────────────────────────┬───┬──────────────────────────┬─···
    └─Description=<Description>─┘   └─AllFiles=─┬─TRUE|YES|1─┬─┘
                                                └─FALSE|NO|0─┘

···┬────────────────────┬─┬────────────────────┬─┬───────────────────────────┬─···
   └Drive=<Drive Letter>┘ └Directory=<Dir Name>┘ └Subdirectories=┬TRUE|YES|1┬┘
                                                                 └FALSE|NO|0┘

···┬─────────────────────────┬─┬────────────────────┬─···
   └UseRulebook=┬TRUE|YES|1┬─┘ └Rulebook=<Rulebook>─┘
                └FALSE|NO|0┘

···┬────────────────────────┬─┬──────────────────────┬─···
   └Compression=─┬─ON──────┬┘ └─Generations=<Number>─┘
                 ├─OFF─────┤
                 └─DEFAULT─┘

···┬───────────────────────────┬─┬────────────────────────┬─···
   └UseFileFilter=┬TRUE|YES|1┬─┘ └FileFilter=<FileFilter>─┘
                  └FALSE|NO|0┘


···┬────────────────────────────┬─┬─────────────────────┬──
   └ChangedFilesOnly=┬TRUE|YES|1┤ └Preview=┬TRUE|YES|1┬─┘
                     └FALSE|NO|0┘          └FALSE|NO|0┘

Note:  If the AllFiles setting is set to a TRUE value then the Subdirectories, 
       Drive and Directory parameter settings are all ignored when a backup 
       method is run. 

Similarly if the UseRulebook parameter setting is set to a TRUE value then the 
Compression and Generations parameter settings are ignored when the backup 
method is run. 

 Defaults 

 Settings which are not explicitly specified when the backup method is created 
 will be set to their default values.  To alter the settings after the backup 
 method has been created you may use the Change command. 

 Examples 

 To create a new backup method called 'All D' which backs up all files on the D 
 drive to the 'Tape' backup set. 

       psnscl backupmethod create "All D" BackupSet="Tape" AllFiles=FALSE
                                Drive=D Directory="\" SubDirectories=TRUE

 To create a new backup method called 'Default' which backs up all files to the 
 default backup set.  The backup method will take the default settings for the 
 unspecified parameters. 

       psnscl backupmethod create Default BackupSet="<default>"


═══ 3.1.4. Delete ═══

Description 

Deletes a specified backup method. 

Syntax 

─BackupMethod Delete <Name>─

Examples 

 To delete a backup method called 'Default'. 

       psnscl backupmethod delete Default


═══ 3.1.5. Rename ═══

Description 

Renames an existing backup method to a specified new name. 

Syntax 

─BackupMethod Rename <Name> NewName=<Name>─

Examples 

 To rename the 'All D' backup method and call it 'All D to tape'. 

       psnscl backupmethod rename "All D" NewName="All D to tape"


═══ 3.1.6. Run ═══

Description 

Runs the specified backup method.  A progress panel is displayed while the 
backup runs. 

Syntax 

─BackupMethod Run <Name>─

Examples 

 To run the backup method 'ServerBackup'. 

       psnscl backupmethod run ServerBackup


═══ 3.1.7. View ═══

Description 

Views all the settings for a specified backup method. 

Syntax 

─BackupMethod View <Name>─

Examples 

 To view the backup method 'ServerBackup'. 

       psnscl backupmethod view ServerBackup


═══ 3.2. BackupSet ═══

Description 

 The BackupSet command is used to change, create, delete, empty, transfer or 
view a backup set. 

Syntax 

──BackupSet─┬─Change─────┬────<Name>───┬───────────────────────┬─
              ├─Create─────┤             │ ┌───────────────────┐ │
              ├─Delete─────┤             │                    │ │
              ├─Empty──────┤             └─┴─<Setting>=<Value>─┴─┘
              ├─TransferIn─┤
              ├─TransferOut┤
              └─View───────┘

For more information see one of the following: 

 Change            Changes the settings of a backup set 
 Create            Creates a new backup set 
 Delete            Deletes a backup set 
 Empty             Empties a backup set 
 TransferIn        Transfers In a backup set. 
 TransferOut       Transfers Out a backup set. 
 View              Views all the settings of a backup set 


═══ 3.2.1. Change ═══

Description 

Changes the settings of an existing backup set.  For single device backup sets 
the IncConfig setting should be omitted. 

Syntax 

──BackupSet Change──<Name>─┬───────────────────────────┬─···
                             └─Description=<Description>─┘
···─┬───────────────────────────────┬─┬───────────────────────┬─
    └─Configuration=<Config String>─┘ └─IncConfig=<IncConfig>─┘

Examples 

 To change the description for the single device backup set 'DRTape' to 
 'Disaster Recovery Tape'. 

       psnscl backupset change DRTape Description="Disaster Recovery Tape"


═══ 3.2.2. Create ═══

Description 

Creates a new backup set.  Note that once a backup set has been created it's 
storage device cannot be changed.  To create a dual device backup set specify 
the IncDevice and IncConfig settings.  To create a single device backup set 
omit these settings. 

Syntax 

──BackupSet Create <Name>─┬───────────────────────────┬─···
                            └─Description=<Description>─┘
···─Device=<Device>─┬───────────────────────────────┬─···
                    └─Configuration=<Config String>─┘
···──┬───────────────────────┬─┬───────────────────────┬─
     └─IncDevice=<IncDevice>─┘ └─IncConfig=<IncConfig>─┘

Examples 

 To create a single device backup set 'User Backups' that backs up to the 
 'Diskette A (3.5")' storage device.  The backup set is left to take the 
 default configuration string. 

       psnscl backupset create "User Backups" Device='Diskette A (3.5")'

 To create a dual device backup set 'Server Backups' that does an initial base 
 backup to the 'Drive G' storage device, then subsequent incremental backups to 
 the 'Tape' storage device.  The configuration string for the base device is 
 set so that backups will be performed to the 'BKPDIR' directory. 

       psnscl backupset create "Server Backups" Device="Drive G" Configuration="PATH=BKPDIR" IncDevice="Tape"


═══ 3.2.3. Delete ═══

Description 

Deletes an existing backup set. 

Syntax 

──BackupSet Delete <Name>─

Examples 

 To delete the backup set called 'Test'. 

       psnscl backupset delete Test


═══ 3.2.4. Empty ═══

Description 

Empties an existing backup set. 

Syntax 

──BackupSet Empty <Name>─

Examples 

 To empty the backup set called 'Weekly'. 

       psnscl backupset empty Weekly


═══ 3.2.5. TransferIn ═══

Description 

 Transfers in a backup set which has previously been transferred out.  If the 
Device setting is included OS/2 Warp Server Backup/Restore will scan that 
storage device for a backup set of the given name and transfer it in. 
Otherwise the command will look for the backup set in the 'Unavailable Sets' 
part of the backup sets container of the OS/2 Warp Server Backup/Restore 
Graphical User Interface (GUI). 

Syntax 

──BackupSet TransferIn <Name>─┬─────────────────┬─
                                └─Device=<Device>─┘

Examples 

 To transfer in the 'Data Files' backup set from the 'Diskette A (3.5")' 
 device. 

       psnscl backupset transferIn "Data Files" Device='Diskette A (3.5")'

 To transfer in the 'Recovery' backup set from the unavailable sets. 

       psnscl backupset transferIn "Recovery"


═══ 3.2.6. TransferOut ═══

Description 

 Transfers out an existing backup set. 

Syntax 

──BackupSet TransferOut <Name> Forget=─┬─TRUE|YES|1─┬─
                                         └─FALSE|NO|0─┘

Examples 

 Transfer out and forget the 'Data Files' backup set. 

       psnscl backupset transferOut 'Data Files' forget=YES


═══ 3.2.7. View ═══

Description 

 Views all the settings associated with a backup set. 

Syntax 

──BackupSet View <Name>─

Examples 

 To view the settings of the 'Drive D (General)' backup set. 

       psnscl backupset view "Drive D (General)"


═══ 3.3. Event ═══

Description 

The Event command is used to create OS/2 Warp Server Backup/Restore scheduled 
events. Once created, events can be updated and changed to inactive if they are 
not required. They can be re-activated when required again. 

Syntax 

──Event─┬─Change───┬───┬───────────────────────┬─ 
          ├─Copy─────┤   │ ┌───────────────────┐ │
          ├─Create───┤   │                    │ │
          ├─Delete───┤   └─┴─<Setting>=<Value>─┴─┘
          └─View─────┘

For more information see one of the following: 

 Change            Changes an existing scheduled event. 
 Copy              Copies an existing scheduled event. 
 Create            Creates a new scheduled event. 
 Delete            Deletes a scheduled event. 
 View              Views all the settings of a scheduled event. 


═══ 3.3.1. Change ═══

Description 

Changes the settings of an existing scheduled event. 

Note:  Once an event has been created its type (for example, Daily, Monthly) 
cannot be altered. 

Syntax 

──Event Change <ID> ─┬────────────────────────────┬···
                       │ ┌────────────────────────┐ │
                       │                         │ │
                       └─┴─<Time Setting>=<Value>─┴─┘

···┬─────────────────────────────┬─┬───────────────────┬···
   └BackupMethod=<Backup Method>─┘ └Active=┬TRUE|YES|1┬┘
                                           └FALSE|NO|0┘

···─┬────────────────────────────┬─┬───────────────────┬ 
    └ChangedFilesOnly=─┬YES─────┬┘ └Preview=─┬YES─────┬┘
                       ├NO──────┤            ├NO──────┤
                       └ASMETHOD┘            └ASMETHOD┘

Note:  The Time Setting parameters and their permitted values, depend on the 
type of event. There are five different types of scheduled events in OS/2 Warp 
Server Backup/Restore. The syntax with parameters and their values which are 
valid for these event types are as follows: 

Interval Events These happen at regular intervals in time, for example every 
hour or every 30 minutes. 

···─┬─────────────┬─┬──────────────────┬···
    └Hours=<Hours>┘ └Minutes=<Minutes>─┘

Daily Events These happen at a certain time each day. 

···─┬─────────────┬─┬──────────────────┬···
    └Hours=<Hours>┘ └Minutes=<Minutes>─┘

Startup Events These occur a fixed time after starting up OS/2 Warp Server 
Backup/Restore. 

···─┬─────────────┬─┬──────────────────┬···
    └Hours=<Hours>┘ └Minutes=<Minutes>─┘

Monthly Events These happen at a certain time on a certain day of each month. 

···─┬──────────┬─┬─────────────┬─┬──────────────────┬···
    └Day=<Day>─┘ └Hours=<Hours>┘ └Minutes=<Minutes>─┘

Named Days Events These happen at a certain time on some days of each month. 
You can select individually on which days of the week and in which weeks of the 
month the event will occur. 

···─┬───────────┬─┬─────────────┬─┬─────────────┬─┬──────────────────┬─···
    └Days=<Days>┘ └Weeks=<Weeks>┘ └Hours=<Hours>┘ └Minutes=<Minutes>─┘

Examples 

 To change the event with an ID of 1 to be inactive. 

       psnscl event change 1 Active=FALSE


═══ 3.3.2. Copy ═══

Description 

Copies an existing scheduled event.  The new event will be given the next 
available event ID. 

Syntax 

──Event Copy <ID>─ 

Examples 

 To make a copy of the event with ID 2. 

       psnscl event copy 2


═══ 3.3.3. Create ═══

Description 

Creates a new scheduled Event. 

Note:  Once an event has been created its type (for example, Daily, Monthly) 
cannot be altered. 

Syntax 

──Event Create Type=─┬INTERVAL───┬─┬────────────────────────────┬···
                       ├DAILY──────┤ │ ┌────────────────────────┐ │
                       ├STARTUP────┤ │                         │ │
                       ├MONTHLY.───┤ └─┴─<Time Setting>=<Value>─┴─┘
                       └NAMEDDAYS.─┘

···─BackupMethod=<Backup Method>─┬───────────────────┬···
                                 └Active=┬TRUE|YES|1┬┘
                                         └FALSE|NO|0┘

···─┬────────────────────────────┬─┬───────────────────┬ 
    └ChangedFilesOnly=─┬YES─────┬┘ └Preview=─┬YES─────┬┘
                       ├NO──────┤            ├NO──────┤
                       └ASMETHOD┘            └ASMETHOD┘

Note:  The Time Setting parameters and their permitted values, depend on the 
type of event. There are five different types of scheduled events in OS/2 Warp 
Server Backup/Restore. The syntax with parameters and their values which are 
valid for these event types are as follows: 

Interval Events These happen at regular intervals in time, for example every 
hour or every 30 minutes. 

···─┬─────────────┬─┬──────────────────┬···
    └Hours=<Hours>┘ └Minutes=<Minutes>─┘

Daily Events These happen at a certain time each day. 

···─┬─────────────┬─┬──────────────────┬···
    └Hours=<Hours>┘ └Minutes=<Minutes>─┘

Startup Events These occur a fixed time after starting up OS/2 Warp Server 
Backup/Restore. 

···─┬─────────────┬─┬──────────────────┬···
    └Hours=<Hours>┘ └Minutes=<Minutes>─┘

Monthly Events These happen at a certain time on a certain day of each month. 

···─┬──────────┬─┬─────────────┬─┬──────────────────┬···
    └Day=<Day>─┘ └Hours=<Hours>┘ └Minutes=<Minutes>─┘

Named Days Events These happen at a certain time on some days of each month. 
You can select individually on which days of the week and in which weeks of the 
month the event will occur. 

···─┬───────────┬─┬─────────────┬─┬─────────────┬─┬──────────────────┬─···
    └Days=<Days>┘ └Weeks=<Weeks>┘ └Hours=<Hours>┘ └Minutes=<Minutes>─┘

Defaults 

If some of the optional settings are not specified then they will be set to 
default values. 

 Setting             Default 
 Numerics            0 
 Days                No days selected 
 Weeks               No weeks selected 
 Active              Event Active 
 ChangedFilesOnly    ASMETHOD 
 Preview             NO 

 Examples 

 To create a daily event which runs the backup method SystemDaily at 23:00. 

       psnscl event create type=DAILY hours=23 minutes=0 BackupMethod=SystemDaily

 To create an event to run a backup method every week at 07:30 on Monday, 
 Wednesday, Friday and Sunday. 

       psnscl event create type=NAMEDDAYS Days="M W F S" Weeks="1234L"
                           BackupMethod=SystemDaily Hours=7 Minutes=30


═══ 3.3.4. Delete ═══

Description 

Deletes an existing scheduled event. 

Syntax 

──Event Delete <ID>─ 

Examples 

 To delete the event with ID 2. 

       psnscl event delete 2


═══ 3.3.5. View ═══

Description 

Views all the settings for a scheduled event. 

Syntax 

──Event View─┬<ID>┬─ 
               └Next┘

Examples 

 To display details of the event with ID 3. 

       psnscl Event View 3


═══ 3.4. FileFilter ═══

Description 

The FileFilter command is used to manipulate OS/2 Warp Server Backup/Restore 
file filters. Having created a file filter you can then go on to add rules to 
it or delete rules from it. These rules specify which files and directories you 
want to include or exclude using this filter. You can then use the filter when 
specifying a backup method. File filters are created with one rule that is 
always the 'last' rule in the filter and cannot be deleted. This special rule 
excludes everything and is matched if none of the other rules are matched 
first. 

File filters in OS/2 Warp Server Backup/Restore are either rule-based or 
tree-based. From the command line all file filters are displayed as rule-based 
since tree-based file filters are stored as rule-based file filters internally 
in OS/2 Warp Server Backup/Restore. Therefore setting the type of a file filter 
to tree-based from the OS/2 Warp Server Backup/Restore Command Line will only 
effect how the file filter is seen when using the graphical user interface 
(GUI) version of the product. 

Syntax 

──FileFilter─┬─Create─────┬───┬───────────────────────┬─ 
               ├─Change─────┤   │ ┌───────────────────┐ │
               ├─Rename─────┤   │                    │ │
               ├─Copy───────┤   └─┴─<Setting>=<Value>─┴─┘
               ├─Delete─────┤
               ├─View───────┤
               ├─AddRule────┤
               ├─DeleteRule─┤
               ├─ChangeRule─┤
               └─ViewRule───┘

For more information see one of the following: 

 Create            To create a new file filter. 
 Change            To change settings of a file filter. 
 Rename            To rename an existing file filter. 
 Copy              To make a copy of an existing file filter. 
 Delete            To delete an existing file filter. 
 View              To view the settings and rules of an existing file filter. 
 AddRule           To add a rule to an existing file filter. 
 DeleteRule        To delete a rule from an existing file filter. 
 ChangeRule        To change a rule in an existing file filter. 
 ViewRule          To view a rule in an existing file filter. 


═══ 3.4.1. Create ═══

Description 

This command creates a new file filter with the specified type and description. 

Syntax 

──FileFilter Create <Name>──┬───────────────────────────┬─┬─────────────┬───
                              └─Description=<Description>─┘ └─Type=─┬Tree┬┘
                                                                    └List┘

Examples 

 To create a list file filter called 'User Files'. 

                         psnscl filefilter create "User Files" Type=LIST


═══ 3.4.2. Change ═══

Description 

 This command changes the settings of an existing file filter. 

Syntax 

──FileFilter Change <Name>──┬───────────────────────────┬─┬─────────────┬───
                              └─Description=<Description>─┘ └─Type=─┬Tree┬┘
                                                                    └List┘

Examples 

 To change the type of the 'User Files' file filter to be a tree based filter. 

                         psnscl filefilter change "User Files" Type=TREE


═══ 3.4.3. Rename ═══

Description 

 This command is used to change the name of an existing file filter. 

Syntax 

──FileFilter Rename <Name> NewName=<Name>─

Note:  The NewName specified must be a unique file filter name. 

Examples 

 To rename the file filter 'User Files' to 'Customer Files'. 

                         psnscl filefilter rename "User Files" NewName="Customer Files"


═══ 3.4.4. Copy ═══

Description 

 This command makes a copy of an existing file filter giving it the new name 
specified. 

Syntax 

──FileFilter Copy <Name> NewName=<Name>─

Note:  The NewName specified must be a unique file filter name. 

Examples 

 To make a copy the file filter 'User Files' called 'Department Files' 

                         psnscl filefilter copy "User Files" NewName="Department Files"


═══ 3.4.5. Delete ═══

Description 

 Deletes an existing file filter. 

Syntax 

──FileFilter Delete <Name>──

Examples 

 To delete the file filter 'User Files' 

                         psnscl filefilter delete "User Files"


═══ 3.4.6. View ═══

Description 

 This command displays information about a file filter.  Use the ViewRule 
command to display information about a specific rule in the file filter. 

Syntax 

──FileFilter View <Name>──

Examples 

 To display details of the file filter called '<OS/2>' 

                         psnscl filefilter view "<OS/2>"


═══ 3.4.7. AddRule ═══

Description 

 Adds a new rule to a file filter. 

Syntax 

──FileFilter AddRule <Name> Number=<Number> Drive=<Drive Letter>──···

···─┬──────────────────────┬─┬──────────────────┬─···
    └─Directory=<Dir Name>─┘ └─Pattern=<Pattern>┘

···┬──────────────────────────────┬─┬─────────────────────┬──
   └─DoSubdirectories=┬TRUE|YES|1┬┘ └─Include=┬TRUE|YES|1┬┘
                      └FALSE|NO|0┘            └FALSE|NO|0┘

Examples 

 Adds a rule to the 'User Files' file filter to backup everything on the D 
 drive.  The new rule will become the second rule checked by the filter. 

                         psnscl filefilter addRule "User Files" Number=2 Drive=D
                             Directory="\" Pattern=* DoSubdirectories=TRUE Include=TRUE


═══ 3.4.8. DeleteRule ═══

Description 

 Deletes one of the rules in a file filter. 

Syntax 

──FileFilter DeleteRule <Name> Number=<Number>──

Examples 

 Deletes the first rule from the 'User Files' file filter. 

                         psnscl filefilter deleteRule "User Files" Number=1


═══ 3.4.9. ChangeRule ═══

Description 

 Changes the properties of one of the rules in a file filter. 

Syntax 

──FileFilter ChangeRule <Name> Number=<Number>─┬──────────────────────┬──···
                                                 └─Drive=<Drive Letter>─┘

···─┬──────────────────────┬─┬──────────────────┬─···
    └─Directory=<Dir Name>─┘ └─Pattern=<Pattern>┘

···┬──────────────────────────────┬─┬─────────────────────┬──
   └─DoSubdirectories=┬TRUE|YES|1┬┘ └─Include=┬TRUE|YES|1┬┘
                      └FALSE|NO|0┘            └FALSE|NO|0┘

Examples 

 Changes the first rule in the file filter 'User Files' to not include 
 subdirectories. 

                         psnscl filefilter changeRule 'User Files' Number=1
                                                     DoSubdirectories=FALSE


═══ 3.4.10. ViewRule ═══

Description 

 Displays the details of one of the rules in a file filter. 

Syntax 

──FileFilter ViewRule <Name> Number=<Number>──

Examples 

 Displays details of the first rule in the '<OS/2>' file filter. 

                         psnscl filefilter viewRule "<OS/2>" Number=1


═══ 3.5. Help ═══

Description 

The Help command is used to get help on the various commands used in the 
program. It is also a useful way of finding out what commands are available. 

Syntax 

──Help───┬─────────┬─┬────────────┬──
           └<command>┘ └<subcommand>┘

Type 'Help' to get a list of all the first-level Line commands accepted. To 
obtain a list of subcommands specific to a Line command, type 'Help' followed 
by the Line command for which you require the subcommands. 

For example, to obtain the subcommands of the BackupMethod command, type: 

   Help BackupMethod

To obtain the syntax diagram and a list of the settings a subcommand may take, 
type 'Help' followed by the Line command and subcommand for which you require 
the syntax. For example, to obtain the syntax for the Create subcommand of the 
BackupMethod command, type: 

   Help BackupMethod Create


═══ 3.6. List ═══

Description 

The List command is used to display a list of one of the types of objects which 
OS/2 Warp Server Backup/Restore uses (for example backup sets or backup methods 
). The report which is output may be filtered by various criteria depending on 
what type of object is being listed. 

Syntax 

──List─┬─BackupMethods────┬────────┬───────────────────────┬─────────── 
         ├─BackupSets───────┤        │ ┌───────────────────┐ │
         ├─Events───────────┤        │                    │ │
         ├─FileFilters──────┤        └─┴─<Setting>=<Value>─┴─┘
         ├─RestoreMethods───┤
         ├─Rulebooks────────┤
         ├─SourceDrives─────┤
         ├─StorageDevices───┤
         └─Volumes──────────┘

Use the 'where clause' to filter the output; if there is no 'where clause', all 
of the respective objects are listed. 

The settings and values for the 'where clause' depend on the type of object 
being listed.  See below for more details. 

Note:  The criteria for the 'where clause' may appear in any order. 

For more information and examples see one of the following: 

     BackupMethods 
     BackupSets 
     Events 
     FileFilters 
     RestoreMethods 
     Rulebooks 
     SourceDrives 
     StorageDevices 
     Volumes 


═══ 3.6.1. BackupMethods ═══

Description 

This section describes the List BackupMethods command.  This command is used to 
output a (possibly filtered) list of Backup Methods on your system. 

Syntax 

─List─BackupMethods──···

···─┬───────────┬─┬─────────────────────────┬─···
    └Name=<Name>┘ └Description=<Description>┘

···┬──────────────────────────┬─···
   └─AllFiles=─┬─TRUE|YES|1─┬─┘
               └─FALSE|NO|0─┘

···┬────────────────────┬─┬────────────────────┬─┬───────────────────────────┬─···
   └Drive=<Drive Letter>┘ └Directory=<Dir Name>┘ └Subdirectories=┬TRUE|YES|1┬┘
                                                                 └FALSE|NO|0┘

···┬─────────────────────────┬─┬────────────────────┬─···
   └UseRulebook=┬TRUE|YES|1┬─┘ └Rulebook=<Rulebook>─┘
                └FALSE|NO|0┘

···┬────────────────────────┬─┬──────────────────────┬─···
   └Compression=─┬─ON──────┬┘ └─Generations=<Number>─┘
                 ├─OFF─────┤
                 └─DEFAULT─┘

···┬───────────────────────────┬─┬────────────────────────┬─···
   └UseFileFilter=┬TRUE|YES|1┬─┘ └FileFilter=<FileFilter>─┘
                  └FALSE|NO|0┘


···┬────────────────────────────┬─┬────────────────────┬─┬──────────────────────┬─
   └ChangedFilesOnly=┬TRUE|YES|1┤ └Preview=┬TRUE|YES|1┬┘ └BackupSet=<Backup Set>┘
                     └FALSE|NO|0┘          └FALSE|NO|0┘

Examples 

 To list all backup methods that don't use compression. 

                         psnscl List BackupMethods Compression=OFF

 To list all backup methods. 

                         psnscl List BackupMethods


═══ 3.6.2. BackupSets ═══

Description 

This section describes the List BackupSets command.  This command is used to 
output a (possibly filtered) list of the backup sets on your system.  If the 
OnDevice parameter is specified then OS/2 Warp Server Backup/Restore will scan 
that storage device to generate the list of backup sets on the device at that 
time. 

Syntax 

─List─BackupSets─┬─────────────────┬─···
                   └OnDevice=<Device>┘

···─┬───────────┬─┬─────────────────────────┬─···
    └Name=<Name>┘ └Description=<Description>┘

···─┬───────────────┬─
    └Device=<Device>┘

Examples 

 To list all backup sets defined for the ADSM device. 

                         psnscl List BackupSets device="ADSM"


═══ 3.6.3. Events ═══

Description 

This section describes the List Events command. This command is used to output 
a (possibly filtered) list of the Scheduled Events defined on your system. 

Syntax 

─List─Events──···

···┬─────────────────────────────┬─┬───────────────────┬···
   └BackupMethod=<Backup Method>─┘ └Active=┬TRUE|YES|1┬┘
                                           └FALSE|NO|0┘

···┬──────────────────────────────────────────────···
   └Type=┬INTERVAL─┬──────────┬─────────────────┬─···
         ├DAILY────┤          │                 │
         ├STARTUP──┘          │                 │
         │                    │                 │
         ├MONTHLY──┬─────────┬┘                 │
         │         └Day=<Day>┘                  │
         └NAMEDDAYS┬───────────┬─┬─────────────┬┘
                   └Days=<Days>┘ └Weeks=<Weeks>┘

···─────────────────────────────────────┬─···
···─┬─────────────┬─┬──────────────────┬┘
    └Hours=<Hours>┘ └Minutes=<Minutes>─┘

···─┬───────────────────────┬─┬───────────────────────┬···
    └LastRun─┬>─┬<Date/Time>┘ └NextRun─┬>─┬<Date/Time>┘
             └<─┘                      └<─┘

···─┬────────────────────────────┬─┬───────────────────┬
    └ChangedFilesOnly=─┬YES─────┬┘ └Preview=─┬YES─────┬┘
                       ├NO──────┤            ├NO──────┤
                       └ASMETHOD┘            └ASMETHOD┘

Examples 

 To list all daily scheduled events. 

                         psnscl List Events Type=DAILY


═══ 3.6.4. FileFilters ═══

Description 

This section describes the List FileFilters command. This command is used to 
output a (possibly filtered) list of the file filters defined on your system. 

Syntax 

─List─FileFilters──···


···─┬───────────┬─┬─────────────────────────┬──┬─────────────┬───···
    └Name=<Name>┘ └Description=<Description>┘  └─Type=─┬Tree┬┘
                                                       └List┘


···─┬───────────────────────┬─
    └SearchFile=<File Name>─┘

Examples 

 To list all list based file filters. 

                         psnscl List FileFilters Type=LIST


═══ 3.6.5. RestoreMethods ═══

Description 

This section describes the List RestoreMethods command. This command is used to 
output a (possibly filtered) list of the restore methods defined on your 
system. 

Syntax 

─List─RestoreMethods──···


···─┬───────────┬─┬─────────────────────────┬─···
    └Name=<Name>┘ └Description=<Description>┘


···─┬──────────────────────┬─┬──────────────────────────┬─···
    └BackupSet=<Backup Set>┘ └─AllFiles=─┬─TRUE|YES|1─┬─┘
                                         └─FALSE|NO|0─┘

···┬────────────────────┬─┬────────────────────┬─···
   └Drive=<Drive Letter>┘ └Directory=<Dir Name>┘


···┬───────────────────────────┬─┬─────────────────┬─···
   └Subdirectories=┬TRUE|YES|1┬┘ └Pattern=<Pattern>┘
                   └FALSE|NO|0┘

···┬───────────────────┬─┬────────────────────┬─┬───────────────────┬─···
   └ByDate=┬TRUE|YES|1┬┘ └Preview=┬TRUE|YES|1┬┘ └Prompt=┬TRUE|YES|1┬┘
           └FALSE|NO|0┘           └FALSE|NO|0┘          └FALSE|NO|0┘

···┬─────────────────────────────┬─┬───────────────────────────────┬─···
   └OriginalLocation=┬TRUE|YES|1┬┘ └DestinationDrive=<Drive Letter>┘
                     └FALSE|NO|0┘

···┬───────────────────────────────┬─
   └DestinationDirectory=<Dir Name>┘


Note:  If the AllFiles setting is set to a TRUE value then the Subdirectories, 
       Drive, Directory and Pattern settings are all ignored when the restore 
       method is run. 

 Examples 

 To list all restore methods that start with the letter 'T'. 

                         psnscl List RestoreMethods name=T*


═══ 3.6.6. Rulebooks ═══

Description 

This section describes the List Rulebooks command. This command is used to 
output a (possibly filtered) list of the rulebooks defined on your system. 

Syntax 

─List─Rulebooks──···


···─┬───────────┬─┬─────────────────────────┬─
    └Name=<Name>┘ └Description=<Description>┘

Examples 

 To list all rulebooks. 

                         psnscl List rulebooks


═══ 3.6.7. SourceDrives ═══

Description 

This section describes the List SourceDrives command. This command is used to 
output a (possibly filtered) list of the source drives available on your 
system. 

Syntax 

─List─SourceDrives──···

···─┬─────────────────────┬─┬────────────────────┬─┬────────────────────┬
    └DriveType=┬HARDISK──┬┘ └Drive=<Drive Letter>┘ └Checked=┬TRUE|YES|1┬┘
               ├DISKETTE─┤                                  └FALSE|NO|0┘
               ├LANDRIVE─┤
               ├RWOPTICAL┤
               ├CDROM────┤
               ├REMOVABLE┤
               └OTHER────┘

Examples 

 List all source drives checked for backup. 

                         psnscl List SourceDrives Checked=TRUE


═══ 3.6.8. StorageDevices ═══

Description 

This section describes the List StorageDevices command. This command is used to 
output a (possibly filtered) list of the storage devices defined on your 
system. 

Syntax 

─List─StorageDevices──···

···─┬───────────┬─┬──────────────────┬─┬──────────────────────┬─
    └Name=<Name>┘ └DLLName=<DLL Name>┘ └Creatable=┬TRUE|YES|1┬┘
                                                  └FALSE|NO|0┘

Examples 

 To list all storage devices whose names begin with 'Drive' 

                         psnscl list storageDevices name=Drive*


═══ 3.6.9. Volumes ═══

Description 

This section describes the List Volumes command. This command is used to output 
a (possibly filtered) list of the volumes which are used by your system. 

Syntax 

─List─Volumes──···

···─┬───────────┬─┬───────────────┬─┬──────────────────────┬···
    └Name=<Name>┘ └Device=<Device>┘ └BackupSet=<Backup Set>┘

···─┬───────────────────────────┬─┬──────────────────────┬─┬──────────────────────┬···
    └TransferredOut=┬TRUE|YES|1┬┘ └Available=┬TRUE|YES|1┬┘ └NumBackupSets=<Number>┘
                    └FALSE|NO|0┘             └FALSE|NO|0┘

···─┬─────────────────────────────────────┬─
    │ ┌─────────────────────────────────┐ │
    │                                  │ │
    └─┴─┬TotalCapacity─┬─┬─<─┬─<Number>─┴─┘
        ├PSnSCapacity──┤ └─>─┘
        ├PSnSUsed──────┤
        ├PSnSFree──────┤
        ├OtherUsed─────┤
        ├OtherFree─────┤
        └TotalBad──────┘

Examples 

 To list all the available volumes. 

                         psnscl list volumes Available=TRUE


═══ 3.7. RestoreMethod ═══

Description 

The RestoreMethod command can be used to create restore methods. Having created 
a restore method it can then be run in order to perform the restore. The 
command can also be used to change, copy, rename and delete restore methods. 

Syntax 

──RestoreMethod─┬─Change─────┬───<Name>────┬───────────────────────┬─ 
                  ├─Copy───────┤             │ ┌───────────────────┐ │
                  ├─Create─────┤             │                    │ │
                  ├─Delete─────┤             └─┴─<Setting>=<Value>─┴─┘
                  ├─Rename─────┤
                  ├─Run────────┤
                  └─View───────┘

See one of the following for more details: 

 Change            Modifies an existing restore method. 
 Copy              Copies an existing restore method. 
 Create            Creates a new restore method. 
 Delete            Deletes an existing restore method. 
 Rename            Renames an existing restore method. 
 Run               Runs an existing restore method. 
 View              Views all the settings for an existing restore method. 


═══ 3.7.1. Change ═══

Description 

Changes the settings of an existing restore method. 

Note:  To change the name of a restore method use the Rename command. 

Syntax 

─RestoreMethod Change────<Name>───┬───────────────────────────┬─···
                                    └─Description=<Description>─┘

···─┬──────────────────────┬─┬──────────────────────────┬─···
    └BackupSet=<Backup Set>┘ └─AllFiles=─┬─TRUE|YES|1─┬─┘
                                         └─FALSE|NO|0─┘

···┬───────────────────────────┬─┬─────────────────┬─···
   └Subdirectories=┬TRUE|YES|1┬┘ └Pattern=<Pattern>┘
                   └FALSE|NO|0┘

···┬────────────────────┬─┬────────────────────┬─···
   └Drive=<Drive Letter>┘ └Directory=<Dir Name>┘

···┬───────────────────────────┬─┬─────────────────┬─···
   └Subdirectories=┬TRUE|YES|1┬┘ └Pattern=<Pattern>┘
                   └FALSE|NO|0┘

···┬───────────────────┬─┬────────────────────┬──···
   └ByDate=┬TRUE|YES|1┬┘ └DateTime=<Date/Time>┘
           └FALSE|NO|0┘

···┬────────────────────┬─┬───────────────────┬─···
   └Preview=┬TRUE|YES|1┬┘ └Prompt=┬TRUE|YES|1┬┘
            └FALSE|NO|0┘          └FALSE|NO|0┘

···┬─────────────────────────────┬─┬───────────────────────────────┬─···
   └OriginalLocation=┬TRUE|YES|1┬┘ └DestinationDrive=<Drive Letter>┘
                     └FALSE|NO|0┘

···┬───────────────────────────────┬─ 
   └DestinationDirectory=<Dir Name>┘

Note:  If the AllFiles setting is set to a TRUE value then the Subdirectories, 
       Drive, Directory and Pattern settings are all ignored when the restore 
       method is run. 

 Examples 

 To change the restore method 'Full Restore' to display a preview when it is 
 run. 

                         psnscl restoreMethod change "Full Restore" Preview=TRUE


═══ 3.7.2. Copy ═══

Description 

Copies an existing restore method to a specified new name. 

Syntax 

─RestoreMethod Copy <Name> NewName=<Name>─

Examples 

 To make a copy of the 'Full Restore' restore method called 'Total Restore' 

                         psnscl restoreMethod copy "Full Restore" NewName="Total Restore"


═══ 3.7.3. Create ═══

Description 

Creates a new restore method with the specified settings. 

Syntax 

─RestoreMethod Create <Name> BackupSet=<Backup Set>─···

···─┬───────────────────────────┬───┬──────────────────────────┬─···
    └─Description=<Description>─┘   └─AllFiles=─┬─TRUE|YES|1─┬─┘
                                                └─FALSE|NO|0─┘

···┬───────────────────────────┬─┬─────────────────┬─···
   └Subdirectories=┬TRUE|YES|1┬┘ └Pattern=<Pattern>┘
                   └FALSE|NO|0┘

···┬────────────────────┬─┬────────────────────┬─···
   └Drive=<Drive Letter>┘ └Directory=<Dir Name>┘

···┬───────────────────────────┬───···
   └Subdirectories=┬TRUE|YES|1┬┘
                   └FALSE|NO|0┘

···┬───────────────────┬─┬────────────────────┬──···
   └ByDate=┬TRUE|YES|1┬┘ └DateTime=<Date/Time>┘
           └FALSE|NO|0┘

···┬────────────────────┬─┬───────────────────┬─···
   └Preview=┬TRUE|YES|1┬┘ └Prompt=┬TRUE|YES|1┬┘
            └FALSE|NO|0┘          └FALSE|NO|0┘

···┬─────────────────────────────┬─┬───────────────────────────────┬···
   └OriginalLocation=┬TRUE|YES|1┬┘ └DestinationDrive=<Drive Letter>┘
                     └FALSE|NO|0┘

···┬───────────────────────────────┬─ 
   └DestinationDirectory=<Dir Name>┘

Note:  If the AllFiles setting is set to a TRUE value then the Subdirectories, 
       Drive, Directory and Pattern settings are all ignored when the restore 
       method is run. 

 Defaults 

 Settings which are not explicitly stated when the restore method is created 
 will set to their default values.  To alter the settings after the Method has 
 been created you may use the Change command. 

 Examples 

 To create a restore method called 'Full Restore' which restores everything 
 from the 'System Backup' backup set.  The restore method restores files to 
 there original location. 

                         psnscl restoreMethod create "Full Restore" backupset="System Backup"
                                             AllFiles=TRUE ByDate=FALSE OriginalLocation=TRUE


═══ 3.7.4. Delete ═══

Description 

Deletes an existing restore method. 

Syntax 

─RestoreMethod Delete <Name>─ 

Examples 

 To delete the 'Total Restore' restore method. 

                         psnscl restoreMethod delete "Total Restore"


═══ 3.7.5. Rename ═══

Description 

Renames an existing restore method to a specified new name. 

Syntax 

─RestoreMethod Rename <Name> NewName=<Name>─

Examples 

 To rename the 'Total Restore' restore method, giving it the new name 'Full 
 Restore'. 

                         psnscl restoreMethod rename "Total Restore" newName="Full Restore"


═══ 3.7.6. Run ═══

Description 

Runs an existing restore method.  A progress panel is displayed while the 
restore method is running.  For single device backup sets the Base and 
Incremental settings are ignored.  For dual device backup sets at least one of 
these settings must be specified. 

Syntax 

─RestoreMethod Run <Name>─┬─────────────────┬─┬────────────────────────┬─
                            └Base=┬TRUE|YES|1┬┘ └Incremental=┬TRUE|YES|1┬┘
                                  └FALSE|NO|0┘               └FALSE|NO|0┘

Examples 

 To run the restore method 'My Restore'. 

                         psnscl restoreMethod run "My Restore"

 To run the restore method 'Full Restore', restoring files from both the base 
 and incremental devices of the dual device backup specified in the restore 
 method. 

                         psnscl restoreMethod run "Full Restore" Base=yes Incremental=yes


═══ 3.7.7. View ═══

Description 

Views all the settings of an existing restore method. 

Syntax 

─RestoreMethod View <Name>─ 

Examples 

 To display the settings of the 'Full Restore' restore method. 

                         psnscl restoreMethod view "Full Restore"


═══ 3.8. Rulebook ═══

Description 

The Rulebook command is used to manipulate OS/2 Warp Server Backup/Restore 
rulebooks. Having created a rulebook you can then go on to add or delete rules 
to it. Rulebooks enable you to have more detailed control over how many 
generations of different files are backed up and which files you wish to use 
compression on. For example, one of the OS/2 Warp Server Backup/Restore example 
rulebook rules is to not compress files with a .ZIP extension as these are 
already compressed. 

Syntax 

──Rulebook─┬─Create─────┬───┬───────────────────────┬─ 
             ├─Change─────┤   │ ┌───────────────────┐ │
             ├─Rename─────┤   │                    │ │
             ├─Copy───────┤   └─┴─<Setting>=<Value>─┴─┘
             ├─Delete─────┤
             ├─View───────┤
             ├─AddRule────┤
             ├─DeleteRule─┤
             ├─ChangeRule─┤
             └─ViewRule───┘

For more information see one of the following: 

 Create            To create a new rulebook. 
 Change            To change settings of a rulebook. 
 Rename            To rename an existing rulebook. 
 Copy              To make a copy of an existing rulebook. 
 Delete            To delete an existing rulebook. 
 View              To view the settings of an existing rulebook. 
 AddRule           To add a rule to an existing rulebook. 
 DeleteRule        To delete a rule from an existing rulebook. 
 ChangeRule        To change a rule in an existing rulebook. 
 ViewRule          To view a rule in of an existing rulebook. 


═══ 3.8.1. Create ═══

Description 

This command creates a new rulebook with the specified Description. 

Syntax 

──Rulebook Create <Name>──┬───────────────────────────┬──
                            └─Description=<Description>─┘


Examples 

 To create a rulebook called 'User Rulebook' with a description. 

                         psnscl rulebook create "User Rulebook"
                                Description="Specifies generations for different user files"


═══ 3.8.2. Change ═══

Description 

This command changes the settings of an existing rulebook. 

Syntax 

──Rulebook Change <Name>──┬───────────────────────────┬──
                            └─Description=<Description>─┘

Examples 

 To change the description of the 'User Rulebook' rulebook. 

                         psnscl rulebook change "User Rulebook"
                                Description="Which user files should be compressed"


═══ 3.8.3. Rename ═══

Description 

This command is used to change the name of an existing rulebook. 

Syntax 

──Rulebook Rename <Name> NewName=<Name>─

Examples 

 To rename the rulebook 'User Rulebook' and give it the new name 'Customer 
 Rulebook'. 

                         psnscl rulebook rename "User Rulebook" NewName="Customer Rulebook"


═══ 3.8.4. Copy ═══

Description 

This command makes a copy of an existing rulebook giving it the new name 
specified. 

Syntax 

──Rulebook Copy <Name> NewName=<Name>─

Examples 

 To make a copy of the 'User Rulebook' rulebook, giving it the name 'Customer 
 Rulebook'. 

                         psnscl rulebook copy "User Rulebook" NewName="Customer Rulebook"


═══ 3.8.5. Delete ═══

Description 

Deletes an existing rulebook. 

Syntax 

──Rulebook Delete <Name>──

Examples 

 To delete the 'Customer Rulebook' rulebook. 

                         psnscl rulebook delete "Customer Rulebook"


═══ 3.8.6. View ═══

Description 

This command displays information about a rulebook.  Use the ViewRule command 
to display information about a specific rule in the rulebook. 

Syntax 

──Rulebook View <Name>──

Examples 

 To display details of the 'User Rulebook' rulebook. 

                         psnscl rulebook view "User Rulebook"


═══ 3.8.7. AddRule ═══

Description 

Adds a new rule to a rulebook. 

Syntax 

──Rulebook AddRule <Name> Number=<Number> Drive=<Drive Letter>──···

···─┬──────────────────────┬─┬──────────────────┬─···
    └─Directory=<Dir Name>─┘ └─Pattern=<Pattern>┘

···┬──────────────────────────────┬─┬─────────────────────┬─···
   └─DoSubdirectories=┬TRUE|YES|1┬┘ └─Generations=<Number>┘
                      └FALSE|NO|0┘

···─┬─────────────────────────┬──
    └─Compression=┬─ON───────┬┘
                  ├─OFF──────┤
                  └─DEFAULT──┘

Examples 

 To add a rule to the 'User Rulebook' rulebook that sets the number of 
 generations for all files ending in '.TXT' to 8. The rule is made the third 
 rule in the rulebook. The rule also specifies that the '.TXT' files should be 
 compressed. 

                         psnscl rulebook addRule "User Rulebook" number=3 Drive=* Directory=\
                             Pattern=*.TXT DoSubdirectories=TRUE Generations=8 Compression=ON


═══ 3.8.8. DeleteRule ═══

Description 

Deletes one of the rules in a rulebook. 

Syntax 

──Rulebook DeleteRule <Name> Number=<Number>──

Examples 

 To delete the first rule in the rulebook 'User Rulebook'. 

                         psnscl rulebook deleteRule "User Rulebook" number=1


═══ 3.8.9. ChangeRule ═══

Description 

Changes the properties of one of the rules in a rulebook. 

Syntax 

──Rulebook ChangeRule <Name> Number=<Number> Drive=<Drive Letter>──···

···─┬──────────────────────┬─┬──────────────────┬─···
    └─Directory=<Dir Name>─┘ └─Pattern=<Pattern>┘

···┬──────────────────────────────┬─┬─────────────────────┬─···
   └─DoSubdirectories=┬TRUE|YES|1┬┘ └─Generations=<Number>┘
                      └FALSE|NO|0┘

···─┬─────────────────────────┬──
    └─Compression=┬─ON───────┬┘
                  ├─OFF──────┤
                  └─DEFAULT──┘

Examples 

 To change the first rule in the 'User Rulebook' rulebook so that it uses the 
 default compression method. 

                         psnscl rulebook changeRule "User Rulebook" number=1 Compression=DEFAULT


═══ 3.8.10. ViewRule ═══

Description 

Displays the details of one of the rules in a rulebook. 

Syntax 

──Rulebook ViewRule <Name> Number=<Number>──

Examples 

 To view the second rule in the 'User Rulebook' rulebook. 

                         psnscl rulebook viewRule "User Rulebook" number=2


═══ 3.9. Settings ═══

Description 

 The Settings command is use to change and view general OS/2 Warp Server 
Backup/Restore settings.  These are the settings available through the control 
panel in the graphical user interface version of the product. 

Syntax 

──Settings─┬─Change─┬───┬───────────────────────┬─ 
             └─View───┘   │ ┌───────────────────┐ │
                          │                    │ │
                          └─┴─<Setting>=<Value>─┴─┘

For more information see one of the following: 

 Change            To change the settings 
 View              To view the settings 


═══ 3.9.1. Change ═══

Description 

 This command is used to change general OS/2 Warp Server Backup/Restore 
settings.  It allows you to change those settings that are accessed through the 
control panel in the graphical user interface version of the product. 

Syntax 

──Settings Change──┬───────────────────────┬─┬──────────────────────┬─···
                     └FileFilter=<FileFilter>┘ └BackupSet=<Backup Set>┘

···─┬───────────────────┬─┬────────────────────────┬─┬────────────────────┬──···
    └Rulebook=<Rulebook>┘ └Compression=─┬─ON──────┬┘ └Generations=<Number>┘
                                        └─OFF─────┘

···─┬──────────────────────────┬─┬────────────────────────┬─···
    └ManualPriority=─┬─HIGH───┬┘ └AutoPriority=─┬─HIGH───┬┘
                     └─NORMAL─┘                 └─NORMAL─┘

···─┬────────────────────┬─┬───────────────────┬─···
    └TemporaryPath=<path>┘ └Log=─┬─TRUE|YES|1─┬┘
                                 └─FALSE|NO|0─┘

···─┬────────────────────────────┬─┬───────────────────────────┬──···
    └LogSuccesses=─┬─TRUE|YES|1─┬┘ └LogFailures=─┬─TRUE|YES|1─┬┘
                   └─FALSE|NO|0─┘                └─FALSE|NO|0─┘

···─┬─────────────────────────────┬─┬──────────────────────────────┬─···
    └UseBackupExit=─┬─TRUE|YES|1─┬┘ └UseRestoreExit=─┬─TRUE|YES|1─┬┘
                    └─FALSE|NO|0─┘                   └─FALSE|NO|0─┘

···─┬───────────────────────┬─┬──────────────────────┬─···
    └LogFileLimit──<number>─┘ └BackupExit=<filename>─┘

···─┬───────────────────────┬─┬───────────────────────────┬─···
    └RestoreExit=<filename>─┘ └BackupACLs───┬─TRUE|YES|1─┬┘
                                            └─FALSE|NO|0─┘

···─┬───────────────────────┬─
    └ACLFilename=<filename>─┘


═══ 3.9.2. View ═══

Description 

 Displays the current OS/2 Warp Server Backup/Restore settings. 

Syntax 

──Settings View──

Examples 

 To view the current OS/2 Warp Server Backup/Restore settings. 

                         psnscl settings view


═══ 3.10. SourceDrive ═══

Description 

 The SourceDrive command is used to change the settings for source drives. You 
can also refresh the list of source drives and view details for a particular 
source drive. 

Syntax 

──SourceDrive─┬─Change───┬───┬───────────────────────┬─ 
                ├─Refresh──┤   │ ┌───────────────────┐ │
                └─View─────┘   │                    │ │
                               └─┴─<Setting>=<Value>─┴─┘

For more information see one of the following: 

 Change            To change the settings of a source drive. 
 Refresh           To refresh the list of source drives. 
 View              To view the settings of a source drive. 


═══ 3.10.1. Change ═══

Description 

 This command is used to change the settings of the source drive. 

Syntax 

──SourceDrive Change <Name>─┬───────────────────┬─┬─────────────────────┬───
                              └DriveType=DriveType┘ └Checked=┬TRUE|YES|1┬─┘
                                                             └FALSE|NO|0┘

Examples 

 To disable OS/2 Warp Server Backup/Restore from scanning the D drive when 
 performing a backup or preview. 

                         psnscl sourceDrive change D checked=FALSE


═══ 3.10.2. Refresh ═══

Description 

This command refreshes the list of source drives to include any source drives 
that may have been added since the last refresh. This is typically when a 
network drive has been assigned a drive letter. 

Syntax 

──SourceDrive Refresh──

Examples 

 To refresh the list of source drives. 

                         psnscl sourceDrive refresh


═══ 3.10.3. View ═══

Description 

Displays the settings for a particular source drive. 

Syntax 

──SourceDrive View <Name>──

Examples 

 To view the settings for the C Drive source drive. 

                         psnscl sourceDrive view C


═══ 3.11. StorageDevice ═══

Description 

The StorageDevice command is used to create storage devices, change their 
settings and delete unwanted storage devices. 

Syntax 

──StorageDevice─┬─Change───┬───┬───────────────────────┬─
                  ├─Create───┤   │ ┌───────────────────┐ │
                  ├─Delete───┤   │                    │ │
                  ├─Refresh──┤   └─┴─<Setting>=<Value>─┴─┘
                  └─View─────┘

For more information see one of the following: 

 Change            To change an existing storage device. 
 Create            To create a new storage device. 
 Delete            To delete a storage device. 
 Refresh           To refresh the list of storage devices. 
 View              To view the settings of a particular storage device. 


═══ 3.11.1. Change ═══

Description 

To change the StorageDevice. For details about configuration strings, please 
refer to the "Storage device and backup set configuration" section of the 
online "OS/2 Warp Server Backup/Restore C API Guide and Reference". 

Syntax 

──StorageDevice Change <Name>─┬─────────────────────────┬──
                                └Configuration=ConfigValue┘


═══ 3.11.2. Create ═══

Description 

To create a new StorageDevice. For details about configuration strings, please 
refer to the "Storage device and backup set configuration" section of the 
online "OS/2 Warp Server Backup/Restore C API Guide and Reference". 

Syntax 

──StorageDevice Create <Name>─┬──────────────────┬──
                                └Config=ConfigValue┘


═══ 3.11.3. Delete ═══

Description 

To delete a StorageDevice. 

Syntax 

──StorageDevice Delete <Name>──

Examples 

 To delete the 'Test' storage device. 

                         psnscl storageDevice delete Test


═══ 3.11.4. Refresh ═══

Description 

Refreshes the list of storage devices. 

Syntax 

──StorageDevice Refresh──

Examples 

 To refresh the storage devices. 

                         psnscl storageDevice refresh


═══ 3.11.5. View ═══

Description 

To view the settings of a storage device. 

Syntax 

──StorageDevice View <Name>──

Examples 

 To display details of the 'My ADSM' storage device. 

                         psnscl storageDevice view "My ADSM"


═══ 3.12. TestServer ═══

Description 

This command is used to test the connection to the OS/2 Warp Server 
Backup/Restore server. It does not take any parameters. If a connection to the 
server cannot be made an error message will be displayed. If a connection to 
the server is made successfully then details of the connection are displayed. 

Syntax 

──TestServer───


═══ 3.13. Volume ═══

Description 

The Volume command can be used to associate, change, create, delete or view the 
volumes. 

Syntax 

──Volume─┬─Associate───┬───┬───────────────────────┬──
           ├─Change──────┤   │ ┌───────────────────┐ │
           ├─Create──────┤   │                    │ │
           ├─Delete──────┤   └─┴─<Setting>=<Value>─┴─┘
           └─View────────┘

For more information see one of the following: 

 Associate         To associate a volume with a backup set. 
 Change            To change the settings of a volume. 
 Create            To create a new volume. 
 Delete            To delete an existing volume. 
 View              To view the settings of a volume. 


═══ 3.13.1. Associate ═══

Description 

This command associates the volume with the named backup set. 

Syntax 

──Volume Associate ID BackupSet=<Backup Set>──

Examples 

 To associate the volume with ID three with the 'System Backup' backup set. 

                         psnscl volume associate 3 backupSet="System Backup"


═══ 3.13.2. Change ═══

Description 

This command is used to change whether or not a volume is available for backup 
or restore. 

Syntax 

──Volume Change ID─┬──────────────────────┬──
                     └Available=┬TRUE|YES|1┬┘
                                └FALSE|NO|0┘

Examples 

 To make the volume with ID four unavailable. 

                         psnscl volume change 4 Available=FALSE


═══ 3.13.3. Create ═══

Description 

Creates a new volume.  OS/2 Warp Server Backup/Restore will assign the volume a 
unique ID. The optional BackupSet parameter will associate the new volume with 
the named backup set. 

Syntax 




──Volume Create Device=<Device>─┬──────────────────────┬───
                                  └BackupSet=<Backup Set>┘

Examples 

 To create a volume called unavailable. 

                         psnscl volume create BackupSet="My Backup Set" Device='Diskette A (3.5")'


═══ 3.13.4. Delete ═══

Description 

This command deletes an existing volume. 

Syntax 

──Volume Delete ID──

Examples 

 To delete the volume with ID two. 

                         psnscl volume delete 2


═══ 3.13.5. View ═══

Description 

This command displays the settings of a volume. 

Syntax 

──Volume View ID──.

Examples 

 To display the settings of the volume with ID 866736321 

                         psnscl volume view 866736321


═══ 4. Command Abbreviations ═══

───────────────────────┬──────────────┬───────────────────
 Keyword               │Abbreviation  │Minimum Required
 ──────────────────────┼──────────────┼──────────────────
 0                     │<N/A>         │0
 ──────────────────────┼──────────────┼──────────────────
 1                     │<N/A>         │1
 ──────────────────────┼──────────────┼──────────────────
 <Default>             │<N/A>         │<
 ──────────────────────┼──────────────┼──────────────────
 ACLFileName           │<N/A>         │ACL
 ──────────────────────┼──────────────┼──────────────────
 Activate              │Act           │Activa
 ──────────────────────┼──────────────┼──────────────────
 Active                │<N/A>         │Active
 ──────────────────────┼──────────────┼──────────────────
 AllFiles              │<N/A>         │Al
 ──────────────────────┼──────────────┼──────────────────
 AsMethod              │AMethod       │As
 ──────────────────────┼──────────────┼──────────────────
 AutoPriority          │APriority     │Au
 ──────────────────────┼──────────────┼──────────────────
 BackupACLs            │BACLs         │BackupA
 ──────────────────────┼──────────────┼──────────────────
 BackupExit            │BExit         │BackupE
 ──────────────────────┼──────────────┼──────────────────
 BackupMethod          │BMethod       │BackupMethod
 ──────────────────────┼──────────────┼──────────────────
 BackupMethods         │BMethods      │BackupMethods
 ──────────────────────┼──────────────┼──────────────────
 BackupSet             │BSet          │BackupSet
 ──────────────────────┼──────────────┼──────────────────
 BackupSets            │BSets         │BackupSets
 ──────────────────────┼──────────────┼──────────────────
 ByDate                │<N/A>         │By
 ──────────────────────┼──────────────┼──────────────────
 CDROM                 │<N/A>         │CD
 ──────────────────────┼──────────────┼──────────────────
 Change                │Ch            │Change
 ──────────────────────┼──────────────┼──────────────────
 ChangedFilesOnly      │Incremental   │Changed
 ──────────────────────┼──────────────┼──────────────────
 Checked               │<N/A>         │Che
 ──────────────────────┼──────────────┼──────────────────
 Compression           │<N/A>         │Com
 ──────────────────────┼──────────────┼──────────────────
 Configuration         │<N/A>         │Conf
 ──────────────────────┼──────────────┼──────────────────
 Connection            │<N/A>         │Conn
 ──────────────────────┼──────────────┼──────────────────
 Copy                  │Co            │Cop
 ──────────────────────┼──────────────┼──────────────────
 Creatable             │Template      │Creata
 ──────────────────────┼──────────────┼──────────────────
 Create                │Cr            │Create
 ──────────────────────┼──────────────┼──────────────────
 DAILY                 │<N/A>         │DAI
 ──────────────────────┼──────────────┼──────────────────
 DateTime              │<N/A>         │Dat
 ──────────────────────┼──────────────┼──────────────────
 Day                   │<N/A>         │Day
 ──────────────────────┼──────────────┼──────────────────
 Days                  │<N/A>         │Days
 ──────────────────────┼──────────────┼──────────────────
 DEFAULT               │<N/A>         │DEF
 ──────────────────────┼──────────────┼──────────────────
 Delete                │De            │Del
 ──────────────────────┼──────────────┼──────────────────
 Description           │<N/A>         │Desc
 ──────────────────────┼──────────────┼──────────────────
 DestinationDirectory  │DDir          │DestinationDi
 ──────────────────────┼──────────────┼──────────────────
 DestinationDrive      │DDrive        │DestinationDr
 ──────────────────────┼──────────────┼──────────────────
 Device                │<N/A>         │Dev
 ──────────────────────┼──────────────┼──────────────────
 Directory             │<N/A>         │Dir
 ──────────────────────┼──────────────┼──────────────────
 DISKETTE              │<N/A>         │DIS
 ──────────────────────┼──────────────┼──────────────────
 DLLName               │DName         │DL
 ──────────────────────┼──────────────┼──────────────────
 Drive                 │<N/A>         │Dr
 ──────────────────────┼──────────────┼──────────────────
 Empty                 │<N/A>         │Em
 ──────────────────────┼──────────────┼──────────────────
 Event                 │Ev            │Event
 ──────────────────────┼──────────────┼──────────────────
 Events                │Evs           │Events
 ──────────────────────┼──────────────┼──────────────────
 FALSE                 │<N/A>         │FA
 ──────────────────────┼──────────────┼──────────────────
 FileFilter            │FFilter       │FileFilter
 ──────────────────────┼──────────────┼──────────────────
 FileFilters           │FFilters      │FileFilters
 ──────────────────────┼──────────────┼──────────────────
 Generations           │Gens          │G
 ──────────────────────┼──────────────┼──────────────────
 HARDDISK              │<N/A>         │HA
 ──────────────────────┼──────────────┼──────────────────
 Help                  │<N/A>         │He
 ──────────────────────┼──────────────┼──────────────────
 HIGH                  │<N/A>         │HI
 ──────────────────────┼──────────────┼──────────────────
 Hours                 │<N/A>         │Ho
 ──────────────────────┼──────────────┼──────────────────
 ID                    │<N/A>         │I
 ──────────────────────┼──────────────┼──────────────────
 LANDRIVE              │<N/A>         │LAN
 ──────────────────────┼──────────────┼──────────────────
 LastRun               │LRun          │Las
 ──────────────────────┼──────────────┼──────────────────
 Letter                │<N/A>         │Le
 ──────────────────────┼──────────────┼──────────────────
 List                  │L             │Li
 ──────────────────────┼──────────────┼──────────────────
 Log                   │<N/A>         │Log
 ──────────────────────┼──────────────┼──────────────────
 LogFailures           │LFailures     │LogFa
 ──────────────────────┼──────────────┼──────────────────
 LogFileLimit          │LFLimit       │LogFi
 ──────────────────────┼──────────────┼──────────────────
 LogSuccesses          │LSuccesses    │LogS
 ──────────────────────┼──────────────┼──────────────────
 ManualPriority        │MPriority     │Ma
 ──────────────────────┼──────────────┼──────────────────
 Minutes               │<N/A>         │Mi
 ──────────────────────┼──────────────┼──────────────────
 MONTHLY               │<N/A>         │MO
 ──────────────────────┼──────────────┼──────────────────
 Name                  │<N/A>         │Name
 ──────────────────────┼──────────────┼──────────────────
 NAMEDDAYS             │<N/A>         │NAMED
 ──────────────────────┼──────────────┼──────────────────
 NewName               │NName         │New
 ──────────────────────┼──────────────┼──────────────────
 NextRun               │NRun          │Nex
 ──────────────────────┼──────────────┼──────────────────
 NO                    │<N/A>         │NO
 ──────────────────────┼──────────────┼──────────────────
 NORMAL                │<N/A>         │NOR
 ──────────────────────┼──────────────┼──────────────────
 OFF                   │<N/A>         │OF
 ──────────────────────┼──────────────┼──────────────────
 ON                    │<N/A>         │ON
 ──────────────────────┼──────────────┼──────────────────
 OriginalLocation      │OLocation     │Or
 ──────────────────────┼──────────────┼──────────────────
 OTHER                 │<N/A>         │OT
 ──────────────────────┼──────────────┼──────────────────
 Pattern               │<N/A>         │Pa
 ──────────────────────┼──────────────┼──────────────────
 Pipe                  │<N/A>         │Pi
 ──────────────────────┼──────────────┼──────────────────
 Preview               │<N/A>         │Pre
 ──────────────────────┼──────────────┼──────────────────
 Prompt                │<N/A>         │Pro
 ──────────────────────┼──────────────┼──────────────────
 Quiet                 │<N/A>         │Q
 ──────────────────────┼──────────────┼──────────────────
 Refresh               │<N/A>         │Ref
 ──────────────────────┼──────────────┼──────────────────
 REGULAR               │<N/A>         │REG
 ──────────────────────┼──────────────┼──────────────────
 Rename                │Re            │Ren
 ──────────────────────┼──────────────┼──────────────────
 RestoreExit           │RExit         │RestoreE
 ──────────────────────┼──────────────┼──────────────────
 RestoreMethod         │RMethod       │RestoreMethod
 ──────────────────────┼──────────────┼──────────────────
 RestoreMethods        │RMethods      │RestoreMethods
 ──────────────────────┼──────────────┼──────────────────
 RuleBook              │RBook         │RuleBook
 ──────────────────────┼──────────────┼──────────────────
 Rulebooks             │RBooks        │Rulebooks
 ──────────────────────┼──────────────┼──────────────────
 Run                   │<N/A>         │Run
 ──────────────────────┼──────────────┼──────────────────
 RWOPTICAL             │<N/A>         │RW
 ──────────────────────┼──────────────┼──────────────────
 Server                │<N/A>         │Ser
 ──────────────────────┼──────────────┼──────────────────
 Settings              │<N/A>         │Set
 ──────────────────────┼──────────────┼──────────────────
 SourceDrive           │SDrive        │SourceDrive
 ──────────────────────┼──────────────┼──────────────────
 SourceDrives          │SDrives       │SourceDrives
 ──────────────────────┼──────────────┼──────────────────
 STARTUP               │<N/A>         │STA
 ──────────────────────┼──────────────┼──────────────────
 StorageDevice         │SDevice       │StorageDevice
 ──────────────────────┼──────────────┼──────────────────
 StorageDevices        │SDevices      │StorageDevices
 ──────────────────────┼──────────────┼──────────────────
 Subdirectories        │SubDirs       │Su
 ──────────────────────┼──────────────┼──────────────────
 TCPIP                 │<N/A>         │TC
 ──────────────────────┼──────────────┼──────────────────
 TemporaryPath         │TempPath      │Tem
 ──────────────────────┼──────────────┼──────────────────
 TestServer            │TServer       │Tes
 ──────────────────────┼──────────────┼──────────────────
 TransferIn            │TIn           │TransferI
 ──────────────────────┼──────────────┼──────────────────
 TransferOut           │TOut          │TransferO
 ──────────────────────┼──────────────┼──────────────────
 TRUE                  │<N/A>         │TRU
 ──────────────────────┼──────────────┼──────────────────
 Type                  │<N/A>         │Ty
 ──────────────────────┼──────────────┼──────────────────
 UseBackupExit         │UBExit        │UseB
 ──────────────────────┼──────────────┼──────────────────
 UseFileFilter         │UFFilter      │UseF
 ──────────────────────┼──────────────┼──────────────────
 UseRestoreExit        │URExit        │UseRe
 ──────────────────────┼──────────────┼──────────────────
 UseRulebook           │URBook        │UseRu
 ──────────────────────┼──────────────┼──────────────────
 View                  │<N/A>         │Vi
 ──────────────────────┼──────────────┼──────────────────
 Volume                │Vol           │Volume
 ──────────────────────┼──────────────┼──────────────────
 Volumes               │Vols          │Volumes
 ──────────────────────┼──────────────┼──────────────────
 Weeks                 │<N/A>         │We
 ──────────────────────┼──────────────┼──────────────────
 Where                 │<N/A>         │Wh
 ──────────────────────┼──────────────┼──────────────────
 YES                   │<N/A>         │Y
───────────────────────┴──────────────┴───────────────────


═══ <hidden>  ═══

The name of an OS/2 Warp Server Backup/Restore object. 

     A name may be up to 31 characters long. 
     Names are case sensitive. 
     A name must uniquely identify the object within its class, that means you 
      cannot have for example, two backup methods with the same name. 
     A name may contain any characters subject to the one restriction that the 
      first character may not be a '<'. 
     If the name contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single string. 
     If the other type of quote is encountered during the name it is taken to 
      be part of the name. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the name. 

 If you are using the name to define a search criterion within a 'where clause' 
 of a List line command then wildcards may be used. 


═══ <hidden>  ═══

The description of an OS/2 Warp Server Backup/Restore object. 

     A description may be up to 127 characters long. 
     A description may contain any characters. 
     If the description contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single description. 
     If the other type of quote is encountered during the description it is 
      taken to be part of the description. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the description. 

 If you are using the description to define a search criterion within a 'where 
 clause' of a List line command then wildcards may be used. 


═══ <hidden>  ═══

Whether or not all files are to be included. 

It may take one of the following values: 

 1, True, Yes   Include all files. 
 0, False, No   Only include files from the specified directories. 

 Notes: 

     If the value is FALSE then the files included are decided by the settings 
      of the Drive, Directory and Subdirectories (and if you are using a 
      restore method, Pattern) parameters. 
     If the value is TRUE then the settings of the Drive, Directory and 
      Subdirectories (and if you are using a restore method, Pattern) 
      parameters are ignored. 
     The values TRUE, FALSE, YES and NO are not case sensitive. 


═══ <hidden>  ═══

Whether or not subdirectories are to be included in the current directory 
specification. 

For a backup method this indicates whether or not subdirectories of the 
specified root directory are to be included. 

For a restore method this indicates whether or not subdirectories of the 
specified original location of the root directory are to be included. 

For rulebooks and file filters this indicates whether subdirectories of the 
specified root directory are to be included by the rule. 

It may take one of the following values: 

 1, True, Yes   Include subdirectories in the specification. 
 0, False, No   Don't include subdirectories in the specification. 

                Note:  The values TRUE, FALSE, YES and NO are not case 
                sensitive. 


═══ <hidden>  ═══

The drive letter of a directory specification. 

For a backup method this is the source drive. 

For a restore method this is the drive of the original location of the source 
files. 

For rulebooks and file filter rules this is the drive of the directory for 
which a match is to be sought. 

The drive letter must be either a single character in the ranges a-z or A-Z, or 
alternatively an asterisk (*) to indicate all source drives. 

Warning: If the drive setting is being used within a 'where clause' of a List 
command then use of an asterisk (*) does not mean ignore the drive letter when 
matching criteria, it means list methods which explicitly have their source 
drive letter set to '*'. To ignore the drive letter when matching criteria, 
omit the drive setting from the 'where clause'. 


═══ <hidden>  ═══

The letter of the drive to where files will be restored. 

This must be a single character in the ranges A-Z or a-z. 

Note:  An asterisk (*) is not a valid option for this parameter. 


═══ <hidden>  ═══

The letter to which the source drive is attached. 

This must be a single character in the ranges A-Z or a-z. 


═══ <hidden>  ═══

The name of a directory within a directory specification. 

For a backup method this is the name of the source directory. 

For a restore method this is the name of the directory of the original location 
of the source files.  (That is, where the files were backed up from.) 

For a file filter or rulebook rule this is the name of the directory for which 
a match is to be sought. 

Notes: 

     This parameter does not include the drive letter. 
     If the directory name contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single directory name. 
     If the other type of quote is encountered during the name it is taken to 
      be part of the name. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the name. 


═══ <hidden>  ═══

The name of a directory within a directory specification. 

This indicates the name of the directory to which files are to be restored. 

     If the directory name contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single directory name. 
     If the other type of quote is encountered during the name it is taken to 
      be part of the name. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the name. 

 Note:  This parameter does not include the drive letter. 


═══ <hidden>  ═══

What type of compression is to be used with the associated backup method. 

This setting may take three values: 

 ON        Compression is to be used. 
 OFF       Compression is not to be used. 
 DEFAULT   Use the default compression value. 

 Notes: 

     If this setting is being used as a search criterion within a 'where 
      clause' of a List line command then using the ON/OFF value will not list 
      any backup methods which use the DEFAULT regardless of whether the 
      DEFAULT is to compress or not. 
     If the UseRulebook parameter setting within a backup method is set to a 
      true value then this setting will be ignored when the backup method is 
      run. 


═══ <hidden>  ═══

The name of the rulebook associated with the backup method. 

     To specify the default rulebook use the name <Default>. 
     If the name contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single name. 
     If the other type of quote is encountered during the name it is taken to 
      be part of the name. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the name. 

 Notes: 

     If you are using the Rulebook parameter setting to specify a search 
      criterion within a 'where clause' of a List line command then wild cards 
      may be used. 
     If the UseRulebook parameter setting within a backup method is set to a 
      true value then this setting will be ignored when the backup method is 
      run. 


═══ <hidden>  ═══

Whether or not a backup method uses a rulebook. 

It may take one of the following values: 

 1, True, Yes   The backup method uses a rulebook. 
 0, False, No   The backup method doesn't use a rulebook. 

 Notes: 

     The values TRUE, FALSE, YES and NO are not case sensitive. 
     If the backup method uses a rulebook then when it is run the Compression 
      and Generations parameter settings are ignored. 


═══ <hidden>  ═══

The name of the file filter associated with the backup method. 

     To specify the default file filter use the name <Default>. 
     If the name contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single name. 
     If the other type of quote is encountered during the name it is taken to 
      be part of the name. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the name. 

 Notes: 

     If you are using the FileFilter setting to specify a search criterion 
      within a 'where clause' of a List line command then wild cards may be 
      used. 
     If the UseFileFilter parameter setting is not set to a true value then 
      when the backup method is run this setting is ignored. 


═══ <hidden>  ═══

Whether or not a backup method uses a file filter. 

It may take one of the following values: 

 1, True, Yes   The backup method uses a file filter. 
 0, False, No   The backup method doesn't use a file filter. 

                Note:  The values TRUE, FALSE, YES and NO are not case 
                sensitive. 


═══ <hidden>  ═══

The number of different versions of a file that OS/2 Warp Server Backup/Restore 
will keep over a series of backups to a particular backup set. The number can 
be in the range 1-250. 

Note:  If the UseRulebook parameter setting is set to a true value then this 
setting will be ignored when the backup method is run. 


═══ <hidden>  ═══

Whether a backup method backs up all the files it finds or only the files which 
have changed since they were lasted backed up to the associated backup set. 

It may take one of the following values: 

 1, True, Yes   The backup method only backs up changed files. 
 0, False, No   The backup method backs up all files. 

                Note:  The values TRUE, FALSE, YES and NO are not case 
                sensitive. 


═══ <hidden>  ═══

Whether or not the backup or restore method presents the user with a preview of 
the files before they are actually backed up or restored. 

It may take one of the following values: 

 1, True, Yes   The backup/restore method presents the user with a preview. 
 0, False, No   The backup/restore method will process the files immediately 
                without a preview. 

                Note:  The values TRUE, FALSE, YES and NO are not case 
                sensitive. 


═══ <hidden>  ═══

The name of the backup set to which a backup method backs up, or from which a 
restore method restores. 

     To specify the default backup set, use the name <Default>. 
     If the name contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single name. 
     If the other type of quote is encountered during the name it is taken to 
      be part of the name. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the name. 
     If this is the backup set from which a restore method restores then you 
      may use the name '*' to indicate restore from all backup sets. 

 Note:  If you are using the BackupSet setting to specify a search criterion 
 within a 'where clause' of a List line command then wild cards may be used. 


═══ <hidden>  ═══

The name of the backup method which the scheduled event will run. 

     If the name contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single name. 
     If the other type of quote is encountered during the name it is taken to 
      be part of the name. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the name. 

 Note:  If the BackupMethod setting is being used within a 'where clause' of a 
 List line command then wildcards may be included in the name. 


═══ <hidden>  ═══

The name of a file which is included by a file filter. 

     This setting is only used during the 'where clause' when listing file 
      filters.  If this setting is used then only file filters which include 
      the specified file will be listed. 
     The filename should be fully qualified: it should not contain wildcards. 


═══ <hidden>  ═══

This is a standard OS/2 file pattern which may contain wildcards. 


═══ <hidden>  ═══

Whether or not a restore method automatically restores the most recent version 
of files or restores files as they were on a certain date and time. 

This setting may take the following values: 

 1, True, Yes   The restore method restores files as they were at a certain 
                time and date. 
 0, False, No   The restore method will restore the most recent version of 
                files. 

                Note:  The values TRUE, FALSE, YES and NO are not case 
                sensitive. 


═══ <hidden>  ═══

Whether or not a restore method prompts the user for each file to ask which 
version it should restore. 

This setting may take the following values: 

 1, True, Yes   The restore method prompts the user for each file. 
 0, False, No   The restore method will automatically select the version. 

                Note:  The values TRUE, FALSE, YES and NO are not case 
                sensitive. 


═══ <hidden>  ═══

Whether a restore method restores files to their original location or to a 
specified directory. 

This setting may take the following values: 

 1, True, Yes   The restore method restores files to their original location. 
 0, False, No   The restore method restores files to the location specified by 
                the DestinationDrive and DestinationDirectory settings. 

                Note:  The values TRUE, FALSE, YES and NO are not case 
                sensitive. 


═══ <hidden>  ═══

The type of a source drive.  This must be one of the following. 

 HARDDISK       A logical hard disk drive 
 DISKETTE       A floppy diskette drive 
 LANDRIVE       An attached LAN drive 
 RWOPTICAL      A read/write optical drive 
 CDROM          A CD-ROM drive 
 REMOVABLE      A removable drive 
 OTHER          Any other drive not falling into one of the categories above 


═══ <hidden>  ═══

Whether the source drive is set to be a possible source of files during backup. 

This setting may take the following values: 

 1, True, Yes   The source drive is scanned for files when a backup method is 
                run. 
 0, False, No   The source drive is not scanned for files to back up. 

                Note:  The values TRUE, FALSE, YES and NO are not case 
                sensitive. 


═══ <hidden>  ═══

The name of the DLL which implements the storage device. 

This should be the name of the library file without the .DLL extension. 
Wildcards may not be used. 


═══ <hidden>  ═══

Whether or not to list device classes for which new devices may be created. 

If many instances of the same type of device may exist (for example the 
diskette device will have an instance for each physical diskette drive) then 
OS/2 Warp Server Backup/Restore allows you to create new instances of the 
class. 

If you set this parameter to a true value then a list of the devices for which 
this applies will be returned. 

This setting may take the following values: 

 1, True, Yes   List storage device classes for which new device instances may 
                be created. 
 0, False, No   List storage device instances which have been created. 

 Notes: 

     The values TRUE, FALSE, YES and NO are not case sensitive. 
     The default is to list storage device instances which have already been 
      created. 


═══ <hidden>  ═══

The amount of space on a volume allocated to a particular purpose. For example 
this may be the total capacity on the volume which OS/2 Warp Server 
Backup/Restore may use. 

This should be a number with an optional unit indicator at the end. The 
possible units are: 

 <None>  A value in bytes 
 K       A value in kilobytes 
 M       A value in megabytes 
 G       A value in gigabytes 

 Examples 

 34        34 Bytes 
 54K       54 Kilobytes 
 100M      100 Megabytes 
 1G        1 Gigabyte 

 Note:  There should not be a space between the number and the unit indicator. 


═══ <hidden>  ═══

The name of the device instance which the volume uses. 

     If the name contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single name. 
     If the other type of quote is encountered during the name it is taken to 
      be part of the name. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the name. 

 Note:  If the Device setting is being used within a 'where clause' of a List 
 line command then wildcards may be included in the name. 


═══ <hidden>  ═══

The number of backup sets on a volume. 

This should be a positive integer in the range 0-255. 


═══ <hidden>  ═══

The name of the backup set using the volume. 

Note:  This setting is only valid when a maximum of one backup set may use the 
volume. This will be the case for removable media such as tapes and diskettes. 

     If the name contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single name. 
     If the other type of quote is encountered during the name it is taken to 
      be part of the name. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the name. 

 If this setting is being used within a 'where clause' of a List line command 
 then the following considerations also apply: 

     To list removable volumes which have no backup sets associated with them 
      use the empty string '' as the name. 
     Wildcards may be included in the name. 
     Only volumes which use removable media will be listed. 


═══ <hidden>  ═══

The total capacity of the volume, that is, the maximum amount of any data which 
may be stored on it. 


═══ <hidden>  ═══

The total amount of space on the volume which OS/2 Warp Server Backup/Restore 
may use, that is, the maximum amount of data which OS/2 Warp Server 
Backup/Restore may store on the volume. 


═══ <hidden>  ═══

The amount of space on the volume which OS/2 Warp Server Backup/Restore has 
used. 


═══ <hidden>  ═══

The amount of free space on the volume which is available to OS/2 Warp Server 
Backup/Restore, that is, the amount of space OS/2 Warp Server Backup/Restore is 
not currently using but may use in the future. 


═══ <hidden>  ═══

The amount of free space on the volume which is not available to OS/2 Warp 
Server Backup/Restore, that is, the amount of space which is not being used but 
which OS/2 Warp Server Backup/Restore cannot use for backing up files. 


═══ <hidden>  ═══

The amount of space on the volume which is used by applications other than OS/2 
Warp Server Backup/Restore 


═══ <hidden>  ═══

The amount of space on the volume which is unusable because the media is 
damaged.  An example of this would be bad sectors on diskettes. 


═══ <hidden>  ═══

Use this setting to list volumes which either belong to backup sets which have 
been transferred out or volumes which are currently available on the system. 

This setting may take the following values: 

 1, True, Yes   Only list volumes which belong to backup sets which have been 
                transferred out. 
 0, False, No   Only list volumes which satisfy one of the following 
                conditions: 
                    The volume is removable and unassociated with any backup 
                     set. 
                    The volume is removable but does not belong to a backup 
                     set which has been transferred out. 
                    The volume is fixed (for example, a harddisk). 

 Note:  The values TRUE, FALSE, YES and NO are not case sensitive. 


═══ <hidden>  ═══

Use this setting to list volumes which are either available or unavailable for 
backup. 

This setting reflects whether a volume appears in the 'Available' or 
'Unavailable' part of the volumes container within the OS/2 Warp Server 
Backup/Restore GUI. 

This setting may take the following values: 

 1, True, Yes   Only list volumes which are available for backup. 
 0, False, No   Only list volumes which are unavailable for backup. 

                Note:  The values TRUE, FALSE, YES and NO are not case 
                sensitive. 


═══ <hidden>  ═══

Whether or not the scheduled event is active. 

This setting may take the following values: 

 1, True, Yes   The event is active and will run at the specified times. 
 0, False, No   The event is inactive and will not run. 

                Note:  The values TRUE, FALSE, YES and NO are not case 
                sensitive. 


═══ <hidden>  ═══

The type of the scheduled event. 

This must be one of the following: 

 INTERVAL       An event which runs at regular intervals. 
 DAILY          An event which runs once every day. 
 STARTUP        An event which runs every time OS/2 Warp Server Backup/Restore 
                is started. 
 MONTHLY        An event which runs once every month. 
 NAMEDDAYS      An event which runs on specific days within a month. 


═══ <hidden>  ═══

Whether a scheduled event will show a preview before continuing a backup. 

This setting must take one of the following values: 

 YES         Always display a Preview regardless of what the backup method 
             says. 
 NO          Never display a Preview regardless of what the backup method says. 
 ASMETHOD    Only display a Preview if the backup method says so. 


═══ <hidden>  ═══

Whether a scheduled event will perform a full backup or only backup files which 
have changed since they were last backed up. 

This setting must take one of the following values: 

 YES         Always perform an incremental backup regardless of what the backup 
             method says. 
 NO          Always perform a full backup regardless of what the backup method 
             says. 
 ASMETHOD    Only do a full backup if the backup method says so. 


═══ <hidden>  ═══

The day in the month when a Monthly Event will be run. 

This must be a number in the range 1-31. 


═══ <hidden>  ═══

     For an Interval event this is the number of hours between events. 
     For a startup event this is the number of hours between the time OS/2 
      Warp Server Backup/Restore starts and the time the event is to be run. 
 This setting is used with the Minutes parameter value to specify a time 
 interval. The number must be in the range 0-23. 


═══ <hidden>  ═══

     For an Interval event this is the number of hours between events. 
     For a startup event this is the number of hours between the time OS/2 
      Warp Server Backup/Restore starts and the time the event is to be run. 
     For a Daily, Monthly or NamedDay event this is the hours component of the 
      time of day when the event is to be run. 
 This setting is used with the Minutes parameter value to specify a time. The 
 number must be in the range 0-23. 


═══ <hidden>  ═══

This is the minutes component of the time when the event is to be run. 

It must be a number in the range 0-59. 


═══ <hidden>  ═══

For an interval event this is the minute component of the time between events. 

For a startup event this is the minute component of the time between OS/2 Warp 
Server Backup/Restore startup and the time the event is to be run. 

The number must be in the range 0-59. 


═══ <hidden>  ═══

This is the hour component of the time of day when the event is to be run. 

It must be a number in the range 0-23. 


═══ <hidden>  ═══

This is the minutes component of the time of day when the event is to be run. 

It must be a number in the range 0-59. 


═══ <hidden>  ═══

The days of the week when the event is to be run. 

This is a character string of up to 7 characters long. It should be enclosed in 
either single (') or double (") quotes but the same type must be used to start 
and finish the string. 

Each character in the string corresponds to a day of the week.  The first 
character corresponds to Monday, the second to Tuesday and so on. 

If the character is a space then this is taken to mean that the event doesn't 
back up on this day.  If the character is anything else then this is taken to 
mean that the event does back up on this day. 

Examples 

'MTWTFSS'
would mean back up on all days of the week but 

'1111111'
would be equally valid as would 

'0000000'

' TW F  '
would mean back up on Tuesday, Wednesday and Friday. 

' 11 1  '
and 

' 00 0  '
would also mean the same. 

Notes 

     If the string is less than 7 characters then we assume that the event 
      doesn't back up on the days which are missing from the end of the string. 
      For example 

            'MTWTF'
      would mean back up on Weekdays. 
     If there are no spaces in the string then you don't actually need the 
      quotes. 


═══ <hidden>  ═══

The weeks in the month when the event is to be run. 

This is a character string of up to 5 characters long. It should be enclosed in 
either single (') or double (") quotes but the same type must be used to start 
and finish the string. 

Each character in the string corresponds to a particular week in the month: 

 Position  Week 
 1st       1st Week in month 
 2nd       2nd Week in month 
 3rd       3rd Week in month 
 4th       4th Week in month 
 5th       Last Week in month 

 If the character is a space then this means that the event doesn't back up on 
 that week.  If the character is anything else then it does. 

 Examples 

  '1234L'
 means back up on all weeks of the month as would 

  '11111'
 and 

  '00000'
  .

  '1 3 L'
 means back up on the 1st, 3rd and last weeks of the month. 

  '1 1 1'
 and 

  '0 0 0'
 would mean the same. 

 Notes 

     If the string is less than 5 characters then we assume that the event 
      doesn't back up on the weeks which are missing from the end of the 
      string. For example 

            '123'
      would mean back up on the first three weeks in the month. 
     If there are no spaces in the string then you don't actually need the 
      quotes. 


═══ <hidden>  ═══

A date and a time. 

This must be in the format 'yy:mm:dd:hh:mm', that is, 
year/month/day/hours/minutes. 

Examples 

97:7:24:0:0
- Midnight on the 24th July 1997 

98:1:1:12:0
- Midday on the 1st January 1998 

Note:  It is not permitted to miss out any of the specification: 

97:7:24
 for example would not be valid. 


═══ <hidden>  ═══

The time and date the event was last run. 


═══ <hidden>  ═══

The time and date the event will next be run. 


═══ <hidden>  ═══

The configuration string is dependent on the backup set's storage device. For 
information on the relevant settings for this, please refer to the "Storage 
device and backup set configuration" section of the online "OS/2 Warp Server 
Backup/Restore C API Guide and Reference". 


═══ <hidden>  ═══

All OS/2 Warp Server Backup/Restore objects have settings which are specific to 
the object type. 

Details of the various setting parameter names that are relevant are shown 
separately for each command. 

In the context of a List command these setting parameters may be used to form a 
'where clause' to filter the list output. 


═══ <hidden>  ═══

The value of OS/2 Warp Server Backup/Restore object settings depend on their 
type. 

Details of what the various setting parameter values may be are given 
separately for each command. 

In the context of a List command these setting parameter values may be used to 
form a 'where clause' to filter the list output. 


═══ <hidden>  ═══

The ID of a scheduled event. 

     This ID number is allocated by OS/2 Warp Server Backup/Restore when the 
      event is created and cannot be modified. 
     The number is an integer in the range 0-32767. 
     This number uniquely identifies a scheduled event and must be used when 
      an event is to be deleted, viewed or modified in any way. 


═══ <hidden>  ═══

If this flag is set then the next event which is scheduled to be run will be 
listed. 


═══ <hidden>  ═══

The type of the file filter. 

This must be one of the following: 

 List           Specifies a rule based file filter. 
 Tree           Specifies a list based file filter. 


═══ <hidden>  ═══

The number of a file filter rule. 

     File filter rules are numbered in the order in which they are matched. 
     Rule 1 is matched first and the highest number rule matched last. 
     Use the View command to find out how many rules a file filter has. 


═══ <hidden>  ═══

Specifies whether or not subdirectories of the specified directory are to be 
included in the rule. 


═══ <hidden>  ═══

Specifies whether when the rule matches a particular file then that file is 
included or excluded from the backup. 


═══ <hidden>  ═══

The number of a rulebook rule. 

     Rulebook rules are numbered in the order in which they are matched. 
     Rule 1 is matched first and the highest number rule matched last. 
     Use the View command to find out how many rules a rulebook has. 


═══ <hidden>  ═══

If a file matches this rule then this setting specifies the number of different 
versions of a file that OS/2 Warp Server Backup/Restore will keep over a series 
of backups to a particular backup set. The number can be in the range 1-250. 


═══ <hidden>  ═══

If a file matches this rule then this setting specifies whether compression 
will be used when backing up the file. 


═══ <hidden>  ═══

Specifies that files should be restored from the base device of a dual device 
backup set.  This setting will be ignored for single device backup sets. 


═══ <hidden>  ═══

Specifies that files should be restored from the incremental device of a dual 
device backup set.  This setting will be ignored for single device backup sets. 


═══ <hidden>  ═══

Specifies the incremental storage device for this backup set.  This setting 
should be omitted for single device backup sets. 

     If the name contains spaces then it must be enclosed in quotes. 
     Either single (') or double (") quotes may be used although the same type 
      of quote must be used to start and finish a single name. 
     If the other type of quote is encountered during the name it is taken to 
      be part of the name. 
     A double occurrence of the delimiting quote is taken to be a single 
      occurrence of the character within the name. 


═══ <hidden>  ═══

Specifies the configuration string for the incremental storage device of this 
backup set.  This setting should be omitted for single device backup sets. 

The configuration string is dependent on the storage device.  For information 
on the relevant settings for this, please refer to the "Storage device and 
backup set configuration" section of the online "OS/2 Warp Server 
Backup/Restore C API Guide and Reference". 


═══ <hidden>  ═══

Specifies whether the backup set should just be made unavailable or should be 
completely transferred out to the storage device and forgotten.