Using the Novell NetWare Backup-Archive Client


Client Options Reference

The following section contains detailed information about each of the ADSM processing options. These options are arranged in alphabetical order. Information for each option includes:

Note:For options with a yes parameter, acceptable alternatives are 1, true, and on. For options with a no parameter, acceptable alternatives are 0, false, and off.

Changingretries

The changingretries option specifies how many additional times you want ADSM to attempt to back up or archive a file that is in use during the first attempt.

This option relates to serialization, an attribute in a management class copy group. ADSM uses this option only when serialization is shared static or shared dynamic.

With shared static serialization, if a file is in use during the first backup or archive attempt, ADSM retries the operation the number of times you specified. If the file is in use during each attempt, the operation does not complete.

With a shared dynamic serialization, if a file is in use during the first backup or archive attempt, ADSM retries the operation the number of times you specified. The backup or archive operation occurs during the last attempt regardless of whether the file is currently in use. The only exception is if the open file has its share flag set to deny_read, in which case ADSM cannot back it up.

Syntax

                   .-4-------------.
>>-CHAngingretries-+---------------+---------------------------><
                   '-numberretries-'
 

Parameters

numberretries

Specifies the number of times ADSM retries a backup or archive operation if the file is in use during the first attempt. The range of values is 0 through 4; the default is set to 4.

Examples

Options file:
changingretries 3

Command line:
-cha=0

Commmethod

The commmethod option specifies the communication method you are using to provide connectivity for client-server communication.

Syntax

>>-COMMMethod--+- TCPip-----+----------------------------------><
               +- SNAlu6.2--+
               '- IPXspx----'
 

Parameters

TCPip

The Transmission Control Protocol/Internet Protocol (TCP/IP) communication method.

SNAlu6.2

The Systems Network Architecture (SNA) logical unit 6.2 (LU6.2) communication method.

IPXspx

The Internetwork Packet Exchange/Sequenced Packet Exchange (IPX/SPX) communication method. Use this method only with OS/2 and AIX servers.

Examples

Options file:
COMMM sna

Command line:
-COMMMETHOD=IPX

Compressalways

The compressalways option controls what ADSM does when a file grows during compression. ADSM continues to compress a file even if it determines the file size is increasing. You can specify to continue compressing, or to send the object uncompressed if it grows during compression.

Syntax

                  .-Yes-.
>>-COMPRESSAlways-+-----+--------------------------------------><
                  '-No--'
 

Parameters

Yes

File compression continues even if the file grows as a result of compression. This is the default.

No

The object is sent again uncompressed if it grows during compression.

Examples

Options file:
COMPRESSALWAYS Yes

Command line:
-COMPRESSA=No

Compression

The compression option specifies whether ADSM should compress files before sending them to the ADSM server. Compressing your files decreases the amount of data storage required to store backup versions and archive copies of your files. It can, however, affect ADSM throughput. Typically, a fast processor on a slow line benefits from compression, but a slow processor on a fast line does not.

This option controls compression only if your ADSM administrator specifies that your client node determines the choice.

Syntax

               .-No--.
>>-COMPRESSIon-+-----+-----------------------------------------><
               '-Yes-'
 

Parameters

No

Files are not compressed before they are sent to the server. This is the default.

Yes

Files are compressed before they are sent to the server.

Examples

Options file:
COMPRESSION Yes

Command line:
-COMPRESSI=No

Cpicbuffersize

The cpicbuffersize option specifies the size of the CPIC buffer for SNA LU6.2 communication. A larger buffer can improve communication performance, but uses more memory.

Syntax

                  .-31---.
>>-CPICBuffersize-+------+-------------------------------------><
                  '-size-'
 

Parameters

size

The size, in kilobytes of an SNA LU6.2 communication buffer.

The range of values is 1 to 31.

The default is 31.

Examples

Option file:
cpicbuffersize 31

Command line:
-cpicb=20

Cpicmodename

The cpicmodename option defines the mode name for the SNA LU6.2 communication method. For CPIC, this option identifies the SNA connection to the gateway and target logical unit. The CPIC mode name is used if the symbolic destination is not provided and the partner LU is located on another system. The mode name must be known on both the local and remote systems.

If you use this option, you must also use the tpname and the partnerluname options.

Syntax

>>-CPICModename- name------------------------------------------><
 

Parameters

name

The mode name for SNA LU6.2 communication. The name is case sensitive and should always be in upper case letters.

There is no default.

Examples

Option file:
cpicmodename vmnode

Command line:
-cpicm=vmmode

Dateformat

The dateformat option selects the format you want ADSM to use for displaying dates.

Syntax

              .-1-------------.
>>-DATEformat-+---------------+--------------------------------><
              '-format_number-'
 

Parameters

format_number

Displays the date using any one of the following formats. Specify the number (1 through 5) that corresponds to the date format you want to use.

  1. MM/DD/YYYY (This is the default.)

  2. DD-MM-YYYY

  3. YYYY-MM-DD

  4. DD.MM.YYYY

  5. YYYY.MM.DD

Examples

Options file:
DATEFORM 3

Command line:
-DATE=4

Dirmc

The dirmc option specifies the management class you want ADSM to use for directories. If you do not specify this option to associate a management class with directories, ADSM uses the management class with the longest retention period located in the active policy set of your policy domain.

Select a management class for directories that allows ADSM to retain directories at least as long as it retains the files associated with them.

Syntax

>>-DIRMc -mgmtclassname----------------------------------------><
 

Parameters

mgmtclassname

Specifies the name of the management class you want to associate with directories. ADSM uses the management class you specify for all directories it backs up. If you do not use this option, the management class with the longest retention period is associated with directories.

Examples

Options file:
DIRM managdir

Command line
Does not apply.

Domain

The domain option specifies the drives you want to include for incremental backup in your client domain. When you use this option in your client options file, it defines your default client domain. ADSM uses your default client domain in these situations to determine which volumes to process during an incremental backup:

If you do not specify volumes in your client options file, the default is all locally mounted volumes and the bindery.

When you use this option with the incremental command, it adds the volumes you specify to that which is defined in your client options file. For example, if you enter

domain SYS: data: bindery 

in the client options file and

load dsmc incremental -domain=USR:

on the command line, ADSM performs an incremental backup for your SYS: DATA USR volumes and the bindery.

If you use both the volume parameter and the domain option on the incremental command, ADSM ignores the domain option and processes only those volumes in the volumes parameter. For example, if you enter

load dsmc incremental SYS: data -domain=servera\SYS:

ADSM performs an incremental backup only for the SYS: and data: volumes.

Syntax

           .----------------.
           V  .-all-local-. |
>>-DOMain-----+-----------+-+----------------------------------><
              +-domain----+
              +-BINdery---+
              '-DIRectory-'
 

Parameters

all-local

Backs up all local volumes. This is the default.

domain

In your client options file, specifies the volumes to include in your default client domain. The volumes you specify can include the NDS. When you use domain with the incremental command, it processes those volumes in addition to ones specified in your options file.

BINdery

Specifies that the three system files that make up the bindery database are to be backed up.

DIRectory

Specifies the NDS.
Note:NDS is not included in domain all-local. To include NDS, you must add the directory to the domain entry.

Examples

Options file:
domain adsm\dir

Command line:
-domain="serrvera\SYS: serverb\SYS:"

Editor

The editor option specifies whether ADSM should turn on or off the command line interface editor and retrieve capability. If the editor and command retrieve function are not working on a specific TERMINAL setting, we recommend you turn off this function.

Options File for Novell NetWare Platforms

This option is placed in the system and client options file.

Syntax

          .-On--.
>>-EDitor-+-----+----------------------------------------------><
          '-Off-'
 

Parameters

On

Turn on the CLI editor and command retrieve capability. This is the default.

Off

Turn off the CLI editor and command retrieve capability.

Examples

Options file:
EDITOR On

Command line:
Does not apply.

Errorlogname

The errorlogname option specifies the path and name of the file where you want ADSM to store information about errors that occur during processing.

Syntax

>>-ERRORLOGName- filespec--------------------------------------><
 

Parameters

filespec

Specifies the path and file name where you want ADSM to store error log information. The default is a file named dsmerror.log in the installation directory.

Examples

Options file:
errorlogname SYS:/tmp/adsmerr.log

Command line:
-errorlogn=SYS:/tmp/adsmerr.log

Errorlogretention

The errorlogretention option specifies the number of days to keep entries in the error log, and whether to save the pruned entries.

The error log is pruned when the first error is written to the log after an ADSM session is started. If the only ADSM session you run is the client scheduler, and you run it 24 hours a day, the error log might not be pruned according to your expectations. Stop the session and restart it to permit ADSM to prune the error log when the next error is written.

Syntax

                       .-N----.  .-D-.
>>-ERRORLOGRetention---+------+--+---+-------------------------><
                       '-days-'  '-S-'
 

Parameters

N  or  days

Specifies how long to wait before pruning the error log.

N

Do not prune the error log. This allows the error log to grow indefinitely. This is the default.

days

The number of days to keep log file entries before pruning the log. The range of values is 0 through 9999.

D  or  S

Specifies whether to save the pruned entries. If you specify anything but D or S, ADSM uses the default, D. Use a space or comma to separate this parameter from the previous one.

D

Discard the log entries when you prune the log. This is the default.

S

Save the log entries when you prune the log. ADSM copies the pruned entries from the error log to dsmerlog.pru located in the same directory as the error log.

Examples

Options file:
ERRORLOGRETENTION 400 S

Command line:
-ERRORLOGR=400,S

Exclude

The exclude option excludes a file or group of files from ADSM backup services. When you back up files, any files you exclude with this option are not considered for backup. For example, you might want to exclude all temporary files, any local caches of network files, all files that contain compiled object code that you can easily reproduce using other methods, or your operating system files.

If you want to exclude an entire directory or subdirectory, use the exclude.dir option.

Use wildcard characters to exclude a broad range of files. See "Include and Exclude Groups of Files" for a list of characters that you can use. Then, if necessary, use the include option to make exceptions. You cannot, however, specify wildcard characters on the directory name when you want to exclude a single directory.

See "Creating an Include-Exclude List" for more information. See also the list of files that should always be excluded in "Exclude System Files".

Syntax

   .------------------.
   V                  |
>>---+-EXCLUDE------+-+-----pattern----------------------------><
     +-EXCLUDE.DIR--+
     '-EXCLUDE.FILE-'
 

Parameters

EXCLUDE.DIR

The pattern is used to find matching directory names. If a matching directory is found, that directory, its files, and all its subdirectories and their files are excluded from backup services.

EXCLUDE.FILE

Excludes files matching the pattern but not directories.

pattern

Specifies the file or group of files that you want to exclude from backup services. End the pattern with a file specification. If the pattern contains a blank space, enclose the pattern in quotation marks.

Examples
Note:In a NetWare environment, if you do not specify a server name, ADSM uses the local server name.

Options file:
exclude servera\*:/.../swapper.dat
exclude N1\*:/io.sys
exclude TFR\*:/.../spart.par
exclude nw2\sys:/*/budget.fin
exclude nw6\sys:/devel/*

Command line:
Does not apply.

Inclexcl

ADSM AUTHORIZED USER

The inclexcl option specifies the path and file name of your include-exclude options file if you use one. Use an include-exclude options file to exclude files from backup and to assign different management classes to specific files or groups of files.

For information about creating an include-exclude options file, see "Creating an Include-Exclude List".

Options File for Novell NetWare Platforms

This option is placed in the client system options file.

Syntax

>>-INCLExcl- filespec------------------------------------------><
 

Parameters

filespec

Specifies the path and file name of your include-exclude options file.

Examples

Options file:
inclexcl servera\dsm/backup.excl
inclexcl servera\etc/inclexcl.def

Command line:
Does not apply.

Include

The include option specifies one of the following:

If you do not assign a specific management class to files, ADSM uses the default management class in the active policy set of your policy domain.

See "Creating an Include-Exclude List" for more information.

Syntax

            .-------------.
            V             |
>>-INCLUDE------pattern---+---+-----------------+--------------><
                              '-mgmtclassname---'
 

Parameters

pattern

Specifies the files you want to include for backup services, or the file or group of files to which you want to assign a specific management class. End this variable with a file specification. If the pattern contains a blank, enclose it in quotation marks.

mgmtclassname

Specifies the name of the management class you want to assign to the files. If you do not specify a management class, ADSM uses the default management class.

Examples

Table 17. Options File Examples
Task Example
Explicitly include a subset of files that were excluded.
   exclude servera\SYS:/proj/text/*
   include servera\SYS:/proj/text/devel.*

Assign a management class to a group of files.
   include servera\SYS:/proj/text/* textfiles

Specify a management class to assign to all files to which you have not assigned a management class. This must be the first statement in your include-exclude list.

Use this method to assign a management class to all files to which you have not already assigned a specific management class, and for which you do not want ADSM to use the default management class.

   include *:/*  managall

IPXBuffersize

The IPXbuffersize option specifies the IPX buffer size needed to transfer data between the client node and the server. A larger buffer can improve communication performance, but it uses more memory.

Syntax

                 .-16---.
>>-IPXBuffersize-+------+--------------------------------------><
                 '-size-'
 

Parameters

size

Specifies the size, in kilobytes, that you want to use for the IPX/SPX communication buffer.

The range of values is 1 through 16; the default is 16.

Examples

Options file:
ipxb 8

Command line:
-ipxbuffersize=12

IPXServeraddress

The IPXserveraddress option specifies the IPX/SPX address of an ADSM server on an OS/2 or AIX host that is not in the same network as the client node. If the IPX/SPX address is not specified, the ADSM server must reside in the same network as the client node.

Syntax

>>-IPXSErveraddress- server_address----------------------------><
 

Parameters

server_address

Specifies an IPX/SPX address for an ADSM server consisting of exactly 20 hexadecimal digits. Each field must be padded with leading zeros if the value is shorter than the specified length. An IPX/SPX address is a concatenation of the following digits:

If an IPX/SPX address is not specified, the default address for the server is the same address as the client node.

Examples

Options file:
ipxse 0000000210005af6e7cc

Command line:
-ipxserveraddress=0000000210005af6e7cc

IPXSocket

The IPXsocket option specifies the socket number for an ADSM server on an OS/2 or AIX host.

Syntax

             .-8522---------.
>>-IPXSOcket-+--------------+----------------------------------><
             '-socketnumber-'
 

Parameters

socketnumber

Specifies a four-digit ADSM server socket number assigned by Novell. The default is 8522.

Examples

Options file:
ipxso 8524

Command line:
-ipxsocket=8524

Language

The language option specifies the national language for presenting client messages.

Syntax

            .-AMENG----.
>>-LANGuage-+----------+---------------------------------------><
            '-language-'
 

Parameters

language

Specifies the language you want to use. You can use American English (AMENG) with all clients. To use a different language, order the client in that language. Not all clients are available in all languages. The available languages are:

Examples

Options file:
LANGUAGE AMENG

Command line:
Does not apply.

Maxcmdretries

The maxcmdretries option specifies the maximum number of times the client scheduler on your NetWare server will attempt to process a failed, scheduled command. It starts only if the client scheduler has not yet backed up a file, never connected to the server, or failed before backing up a file. ADSM uses this option only when the schedule command is running.

Your ADSM administrator can also set this option. If your ADSM administrator specifies a value for this option, that value overrides what you specify in the client options file after your client node successfully contacts the ADSM server.

Syntax

                 .-2-------------.
>>-MAXCMDRetries-+---------------+-----------------------------><
                 '-maxcmdretries-'
 

Parameters

maxcmdretries

Specifies the number of times the client scheduler can attempt to process a scheduled command that fails. The range of values is 0 through 9999; the default value is 2.

Examples

Options file:
MAXCMDR 4

Command line:
-MAXCMDRETRIES=3

Memoryefficientbackup

The memoryefficientbackup option specifies a slower algorithm for processing incremental backups. With the memoryefficientbackup option, ADSM backs up one directory at a time, thus using less memory. However, the backup operation takes longer to complete.

Use this option with the incremental command when your machine is low on memory.

Syntax

                          .-No--.
>>-MEMORYEFficientbackup--+-----+------------------------------><
                          '-Yes-'
 

Parameters

No

Specifies that the client node should use the faster, more memory-intensive method when it processes incremental backups. This is the default.

Yes

Specifies that the client node should use the method that requires less memory when processing incremental backups.

Examples

Options file:
memoryefficientbackup yes

Command line:
-memoryef=no

Nodename

The nodename option identifies your NetWare server to the ADSM server. The node name is required. It is generally the NetWare server name. You can use different node names to identify multiple systems on your workstation. For example, if your machine is running both Windows and OS/2, you can specify winuser for the first client system, and os2user for the second client system.

You can also use the nodename option if you want to restore or retrieve files from a server other than the one from which you backed up or archived files.
Note:The machine name is not necessarily the TCP/IP host name.

Syntax

>>-NODename- nodename------------------------------------------><
 

Parameters

nodename

Specifies a 1 to 64 character name that identifies the node for which you want to request ADSM services. The default is the name of the machine. Even though this option is available, it is usually better to allow the node name to default to the machine name.

Examples

Options file:
NODENAME cougar

Command line:
-NOD=banshee

Numberformat

The numberformat option specifies the format you want ADSM to use for displaying numbers.

Syntax

                .-1------.
>>-NUMberformat-+--------+-------------------------------------><
                '-number-'
 

Parameters

number

Displays numbers in one of the following ways:
  1. 1,000.00 (This is the default.)
  2. 1,000,00
  3. 1 000,00
  4. 1 000.00
  5. 1.000,00
  6. 1'000,00

Examples

Options file:
num 4

Command line:
-numberformat=4

Nwignorecompressbit

The nwignorecompressbit option specifies whether you want to ignore the setting of the compressed file (Co) attribute during selection processing for incremental backups. This option is valid only on NetWare clients issuing an incremental backup on a NetWare 4 file system.

Syntax

                         .-No--.
>>-NWIGNORECOMpressbit---+-----+-------------------------------><
                         '-Yes-'
 

Parameters

No

Specifies that the NetWare client should interrogate the compressed file attribute during selection processing for incremental backups. This is the default.

Yes

Specifies that the NetWare client should ignore the setting of the compressed file attribute during selection processing for incremental backups. If nwignorecompressbit is set to yes and the only change to the file is that it was compressed by the NetWare 4 operating system, the file will not be incrementally backed up.

Examples

Options file:
NWIGNORECOMpressbit yes

Command line:
incremental sys: -NWIGNORECOM=Yes

Nwpwfile

The nwpwfile option encrypts the user id and password for a local or remote NetWare server and saves them in a file in the installation directory.

Syntax

              .-Yes-.
>>-NWPWFile---+-----+------------------------------------------><
              '-No--'
 

Parameters

Yes

Specifies that ADSM should encrypt the user id and password the first time a command is issued for a NetWare server, local or remote. The encrypted information is stored with the extension .pwd in your installation directory. When you issue subsequent commands for that server, ADSM obtains the password information instead of issuing a prompt. This is the default.

No

Specifies that ADSM should not encrypt the user id and password. Each time you issue a command to back up or archive files stored on a remote NetWare server. ADSM prompts you for the user id and password for the server.

Examples

Options file:
nwpwf off

Command line:
-nwpwfile=N

Nwuser

The nwuser option specifies a user id and password to connect to a local or remote NetWare server. The user must have NetWare supervisor authority. Use this option as many times as necessary in your client options file to provide password information for each NetWare server.

If you do not use this option, ADSM prompts you for a user id and password for each target service when you start a backup or archive operation.

When logging into a NetWare server from ADSM, you must use either:

For example, if you received the following message:

Please enter NetWare user for "ELLAS":

You can specify either:

.CN=Zorba.OU=Islands.O=Greece
 
or
 
Zorba (if the Bindery Context is set to OU=Islands.O=Greece)

ADSM will not accept the typeless name:

Zorba.Islands.Greece
Note:Bindery context does not affect ADSM NDS processing; you need not specify it.

Syntax

   .-----------------------------------.
   V                                   |
>>----NWUSer servername\user:password--+-----------------------><
 

Parameters

servername

A 1 to 48 character NetWare server name to which your client node has access.

user

A 1 to 48 character NetWare user with supervisor authority on the NetWare server.

password

A 1 to 128 character password for a user with supervisor authority on the NetWare server.

Examples

Options file:
nwus servera\supervisor:secret

The following example shows how you might specify a user id and password in order to back up an NDS tree:nwuser treea\.admin.ibm:secretwhere treea is the NDS tree name.

Command line:
-nwuser=serverb\mary:secret1

Nwwaitonerror

The nwwaitonerror option controls what happens if ADSM encounters an error while exiting. You can direct ADSM to do one of the following:

Note:You can exploit nwwaitonerror when running DSMC in an automated mode, for example, from a .NCF file. By default, you will be asked to <Press any key to continue> before exiting the DSMC program. By specifying nwwaitonerror yes, DSMC will not post this prompt.

Syntax

                   .-Yes-.
>>-NWWaitonerror---+-----+-------------------------------------><
                   '-No--'
 

Parameters

Yes

Specifies that ADSM should display an error message if it encounters an error. You must press Enter to return to the NetWare console. This is the default.

No

Specifies that ADSM should immediately return to the NetWare console if it encounters an error while exiting. No error message is displayed.

Examples

Options file:
nww yes

Command line:
-nwwait=N

Optfile

The optfile option specifies the options file you want ADSM to use when you start an ADSM session. You can use this option with dsm.nlm. You cannot use it in the options file or on any DSMC commands. If you do not use this option, ADSM uses the default options file, dsm.opt.

Syntax

>>-OPTFILE -file_name------------------------------------------><
 

Parameters

file_name

Specifies an alternate client options file. This must be a fully qualified file name.

Examples

Options file:
Does not apply.

Command line:
-optfile=SYS:/adsm/spike.opt

Partnerluname

The partnerluname option specifies a logical unit name that the transaction program uses to identify the ADSM server in the SNA network. The partner logical unit name is used if the symbolic destination name is not provided for SNA LU6.2 communications.

If you use this option, define the cpicmodename and tpname options.

Syntax

>>-PARtnerluname- logical_unit_name----------------------------><
 

Parameters

logical_unit_name

Specifies a name that identifies the remote target in an SNA network. Contact your system administrator for this name. There is no default.

Examples

Options file:
partnerlu ALMVMA

Command line:
-par=SANJOSEVM

Password

The password option specifies an ADSM password. If this option is not used and your administrator has set authentication on, you are prompted for a password when you start an ADSM session.
Note:If you are prompted for a password, it is not displayed as you enter it. However, if you use the password option, your password is displayed when you enter it.

Syntax

>>-PASsword- password------------------------------------------><
 

Parameters

password

Specifies a one-to-64 character password. A password is not case-sensitive.

Valid characters include:

Characters
Description
A-Z
Any letter, A through Z, upper or lowercase
0-9
Any number, 0 through 9
+
Plus
.
Period
_
Underscore
-
Hyphen
&
Ampersand

Examples

Options file:
password secretword

Command line:
-password=secretword

Passwordaccess

The passwordaccess option specifies whether you want your ADSM password generated automatically or set as a user prompt. If the authentication feature is enabled, check with an ADSM-authorized user to verify that a password is required for your client node.

Use the passworddir option in your option file to determine the directory in which to store an encrypted password file.

Syntax

                  .-prompt---.
>>-PASSWORDAccess-+----------+---------------------------------><
                  '-generate-'
 

Parameters

prompt

ADSM prompts you for your ADSM workstation password each time a client connects to the server. This is the default.

To keep your client node password secure, enter commands without the password, and wait for ADSM to prompt you for the password.

generate

ADSM encrypts and stores your password locally and generates a new password when the old password expires. An encrypted password is kept on your workstation for use when you start a session.

A password prompt will occur when registering a workstation with an ADSM server, or if your password was changed manually.

Examples

Options file:
passwordaccess generate

Command line:
Does not apply.

Passworddir

ADSM AUTHORIZED USER

The passworddir option forces the directory location in which to store an encrypted password file. The default directory location depends on how the client was installed.

Options File for Novell NetWare Platforms

This option is placed in the client system options file.

Syntax

>>-PASSWORDDIR location----------------------------------------><
 

Parameters

location

Specifies the location of the directory in which the password is found.

Examples

Options file:
passworddir

Command line:
Does not apply.

Postschedulecmd

The postschedulecmd option specifies a command that ADSM should process after it runs a schedule. ADSM does not wait for the command to complete before it continues with other processing.

This option works on Novell NetWare 4.0 and later. The command always returns a 0 return code, even if there are errors. The command and any errors are printed on the console.

Syntax

>>-POSTSchedulecmd "cmdstring"---------------------------------><
 

Parameters

"cmdstring"

Specifies the command to process. You can enter a command before a schedule using the preschedulecmd option. Use only one postschedulecmd option.

Use a blank, or null string for cmdstring if you want to prevent any commands that the ADSM administrator uses for postschedulecmd or preschedulecmd from running. If you specify a blank, or null string on either option, it prevents the administrator from using a command on both options.

If your administrator uses a blank, or null string on the postschedulecmd option, you cannot run a post-schedule command.

If the command string contains blanks, enclose it in double quotes. If you have double quotes within the command string, use single quotes to enclose them.

Examples

Options file:
postschedulecmd "restart database"

where the command string is a valid command for restarting your database.

Command line:
Does not apply.

Preschedulecmd

The preschedulecmd option specifies a command that ADSM should process before it runs a schedule. ADSM waits for the command to complete before it starts the schedule.

ADSM does not wait for the command to complete before continuing with other processing.

This option works on Novell NetWare 4.0 and later. The command always returns a 0 return code, even if there are errors. The command and any errors are printed on the console.

Syntax

>>-PRESchedulecmd "cmdstring"----------------------------------><
 

Parameters

"cmdstring"

Specifies the command to process. Use only one preschedulecmd option. You can enter a command after a schedule using this option.

Use a blank, or null string for cmdstring if you want to prevent any commands that the ADSM administrator uses for postschedulecmd and preschedulecmd from running . If you specify a blank, or null string on either option, it prevents the administrator from using a command on both options.

If your administrator uses a blank, or null string on the preschedulecmd option, you cannot run a pre-schedule command.

If the command string contains blanks, enclose it in double quotes. If you placed double quotes within the command string, use single quotes to enclose them.

Examples

Options file:
preschedulecmd "quiesce database"

Where the command string is a valid command for shutting down your database.

Command line:
Does not apply.

Processorutilization

The processorutilization option specifies the amount of cpu time assigned to ADSM.

Because this option can affect other applications on your client node, use only when speed is a high priority.

Syntax

                        .-0------.
>>-PROCESSORutilization-+--------+-----------------------------><
                        '-number-'
 

Parameters

number

Specifies the amount of time ADSM will control the cpu, in hundredths of a second, before yielding it to another application. For example, if the number is 1000, ADSM will control the cpu for 10 seconds.

The minimum value is 0. There is no maximum value. The default is 0.

Examples

Options file:
processor 2

Command line:
--processorutilization=10

Queryschedperiod

The queryschedperiod option specifies the number of hours you want the client scheduler to wait between attempts to contact the ADSM server for scheduled work. This option applies only when you set the schedmode option to polling. ADSM uses this option only when the schedule command is running.

Your ADSM administrator can also set this option. If your ADSM administrator specifies a value for this option, that value overrides the value set in your client options file after your client node successfully contacts the ADSM server.

Syntax

                    .-12----.
>>-QUERYSCHedperiod-+-------+----------------------------------><
                    '-hours-'
 

Parameters

hours

Specifies the number of hours the client scheduler waits between attempts to contact the ADSM server for scheduled work. The range of values is 1 through 9999; the default value is 12.

Examples

Options file:
QUERYSCH 6

Command line:
-QUERYSCHEDPERIOD=8

Quiet

The quiet option prevents messages from displaying on your screen during ADSM processing. For example, when you run either the incremental or selective command, ADSM displays information about each file it backs up. Use the quiet option if you do not want to view that information.

When you use the quiet option, certain error information still displays on your screen, and messages are written to log files If you do not specify quiet, ADSM uses the default option, verbose.

Syntax

>>-QUIET-------------------------------------------------------><
 

Examples

Options file:
quiet

Command line:
-quiet

Replace

The replace option specifies what you want ADSM to do when it restores files that already exist on your Netware Server. This option applies to the restore and retrieve commands only.

Syntax

           .-Prompt-.
>>-REPlace-+--------+------------------------------------------><
           +-All----+
           +-Yes----+
           '-No-----'
 

Parameters

Prompt

During a restore or retrieve process, ADSM prompts you to overwrite a file when it encounters an existing file on your workstation. This is the default.

When prompted, you can choose to overwrite the existing unprotected file or choose to overwrite all existing files, including read-only files.

All

ADSM overwrites all existing files, including read-only files.

Yes

ADSM overwrites any existing files, except read-only files.

No

ADSM does not overwrite any existing files.

Examples

Options file:
replace all

Command line:
-replace=off

Retryperiod

The retryperiod option specifies the number of minutes you want the client scheduler to wait between attempts to process a scheduled command that fails, or between unsuccessful attempts to report results to the server. ADSM uses this option only when the schedule command is running.

Your ADSM administrator can also set this option. If your ADSM administrator specifies a value for this option, that value overrides the value specified in your client options file after your client node successfully contacts the ADSM server.

Syntax

               .-20------.
>>-RETRYPeriod-+---------+-------------------------------------><
               '-minutes-'
 

Parameters

minutes

Specifies the number of minutes the client scheduler waits between attempts to contact the ADSM server, or to process a scheduled command that fails. The range of values is 1 through 9999. The default value is 20.

Examples

Options file:
RETRYP 10

Command line:
-RETRYPERIOD=15

Schedlogname

The schedlogname option specifies the path and file name where you want schedule log information stored. When you run the schedule command, output from scheduled commands displays on your screen while it is also sent to the file you specified with this option.

Use this option only when you run the schedule command.

Syntax

>>-SCHEDLOGName filespec---------------------------------------><
 

Parameters

filespec

Specifies the path and file name where you want ADSM to store schedule log information when it processes scheduled work. If you specify a file name only, ADSM stores the file in your current directory. The installation directory and a file name of dsmsched.log are the defaults.

Examples

Options file:
schedlogname SYS:/mydir/schedlog.jan

Command line:
-schedlogn=SYS:/mydir/schedlog.jan

Schedlogretention

The schedlogretention option specifies the number of days to keep entries in the schedule log, and whether to save the pruned entries. The schedule log is pruned after a scheduled event completes.

Syntax

                       .-N----.  .-D-.
>>-SCHEDLOGRetention---+------+--+---+-------------------------><
                       '-days-'  '-S-'
 

Parameters

N  or  days

Specifies how long to wait before pruning the schedule log.

N

Do not prune the log. This allows the log to grow indefinitely. This is the default.

days

Specifies the number of days to keep log file entries before pruning the schedule log. The range of values is 0 through 9999.

D  or  S

Specifies whether or not to save the pruned entries. If you specify anything but D or S, ADSM uses the default, D. Use a space or comma to separate this parameter from the previous one.

D

Discards the log entries when pruning the log. This is the default.

S

Saves the log entries when pruning the log. ADSM copies the entries that are pruned from the log to dsmsched.pru which is stored in the same directory as the schedule log.

Examples

Options file:
SCHEDLOGRETENTION 30 S

Command line:
-SCHEDLOGRETENTION=30,S

Schedmode

Note:This option applies only if you are using the TCP/IP communication method and the schedule command is running.

The schedmode option specifies which ADSM schedule mode to use. The schedule mode determines whether your client node periodically asks the ADSM server for scheduled work (polling), or whether the ADSM server contacts your client node when it is time to start a scheduled operation (prompted). All communication methods can use polling, but only TCP/IP can use prompted.

Your ADSM administrator can specify that the ADSM server support either mode or one mode. If your ADSM administrator specifies either mode, you can select the schedule mode. If your ADSM administrator specifies only one mode, specify that same mode in your client options file or scheduled work will not be processed.

If the schedule mode is prompted, supply values for the tcpclientaddress and tcpclientport options on the schedule command. You can then be contacted at an address or port other than the one that made first contact with the server.

Syntax

              .-POlling--.
>>-SCHEDMODe--+----------+-------------------------------------><
              '-PRompted-'
 

Parameters

POlling

The client scheduler queries the ADSM server for scheduled work at prescribed time intervals. Set the time intervals using the queryschedperiod option. This is the default.

PRompted

The client scheduler waits for the ADSM server to contact your client node when scheduled work needs to be done.

Examples

Options file:
SCHEDMODE PROMPTED

Command line:
-SCHEDMOD=PO

Scrolllines

The scrolllines option specifies the number of lines you want to appear at one time when ADSM displays lists of information on your screen. Use this option when you set the scrollprompt option to Yes, and you use ADSM commands.

Syntax

               .-20-----.
>>-SCROLLLines-+--------+--------------------------------------><
               '-number-'
 

Parameters

number

Specifies the number of lines you want ADSM to display at one time when it displays lists of information on your screen. The range of values is 1 through 80; the default value is 20.

Examples

Options file:
SCROLLLINES 25

Command line:
-SCROLLL=25

Scrollprompt

The scrollprompt option specifies whether you want ADSM to stop and wait after displaying the number of lines you indicated with the scrolllines option, or you want ADSM to scroll through all lines and stop at the end of the list.

Syntax

                .-No--.
>>-SCROLLPrompt-+-----+----------------------------------------><
                '-Yes-'
 

Parameters

No

ADSM scrolls to the end of the list and stops. This is the default.

Yes

ADSM stops and waits after displaying the number of lines you indicated with the scrolllines option. The following prompt displays at the bottom of the screen:
   Press 'Q' to quit, 'C' to continuous scroll, or 'Enter' to continue.

You can also specify Yes as On, True, or 1.

Examples

Options file:
SCROLLPRO Yes

Command line:
-SCROLLP=Yes

Subdir

The subdir option specifies whether you want ADSM to include subdirectories of named directories on the following commands:

Archive
Delete Archive
Incremental (when the filespec is not a domain)
Query Archive
Query Backup
Restore
Retrieve
Selective

Syntax

          .-No--.
>>-SUbdir-+-----+----------------------------------------------><
          '-Yes-'
 

Parameters

No

ADSM does not process subdirectories. This is the default.

Yes

ADSM processes subdirectories. Because ADSM searches all the subdirectories of a directory that it is processing, it can take longer for ADSM to complete the requested task than if subdir were No. Specify Yes only when necessary.

Examples

Options file:
SUBDIR Yes

Command line:
-SU=Yes

Symbolicdestination

The symbolicdestination option specifies a symbolic ADSM server name. Contact your ADSM administrator for the correct name. The symbolic destination name indexes SNA routing and security parameters that are stored in communication directory files.

When a symbolic destination is used with the commmethod option for SNA LU6.2 communication, you do not need to specify the tpname, partnerluname, or cpicmodename options.

This option is required if your communication protocol is SNA LU6.2 and a transaction program name or partner logical unit name is not provided.

Syntax

>>-SYMbolicdestination Sym_dest_name---------------------------><
 

Parameters

Sym_dest_name

Specifies a one-to-eight character symbolic destination name for the ADSM server. Contact your ADSM administrator for this name. There is no default.

Examples

Options file:
symbolicdestination adsm

Command line:
-sym=anrserv

Tapeprompt

The tapeprompt option specifies whether to wait for a tape to mount if it is required for a backup, archive, restore, or retrieve process, or to prompt you for a choice.

Syntax

              .-No--.
>>-TAPEPrompt-+-----+------------------------------------------><
              '-Yes-'
 

Parameters

No

You are not prompted for your choice. ADSM waits for the appropriate tape to mount. This is the default.

Yes

When you enter a command to back up, archive, restore, or retrieve data, ADSM prompts you when a tape is required. At the prompt, you can choose to wait for the appropriate tape to be mounted. If you choose not to wait, the file is not processed.

Examples

Options file:
TAPEPROMPT NO

Command line:
-TAPEP=NO

TCPBuffsize

The tcpbuffsize option specifies the size to use for the ADSM internal TCP/IP communication buffer. Although it uses more memory, a larger buffer can improve communication performance.

Syntax

               .-31---.
>>-TCPBuffsize-+------+----------------------------------------><
               '-size-'
 

Parameters

size

Specifies the size, in kilobytes, that you want to use for the ADSM internal TCP/IP communication buffer. The range of values is one through 32. The default is 31.

Examples

Options file:
tcpb 2

Command line:
-tcpbuffsize=31

TCPClientaddress

The tcpclientaddress option specifies a TCP/IP address if your client node has more than one address, and you want the server to contact an address other than the one that was used to make the first server contact.

Use this option only if you are using prompted for schedmode. This option is used only when the schedule command is running.

Syntax

>>-TCPCLIENTAddress client_address-----------------------------><
 

Parameters

client_address

Specifies the TCP/IP address you want the ADSM server to use to contact your client node. Specify a TCP/IP Internet domain name or a dot address.

Examples

Options file:
tcpclienta dsmclnt.sanjose.ibm.com

Command line:
-tcpclientaddress=128.33.10.249

TCPClientport

The tcpclientport option specifies a different TCP/IP port number for the ADSM server to contact other than the one that was used to make the first server contact. If the default or specified port is busy, ADSM attempts to use any other available port. Use this option only if you specify prompted for schedmode.

This option is used only when the schedule command is running.

Syntax

                 .-1501----------------.
>>-TCPCLIENTPort-+---------------------+-----------------------><
                 '-client_port_address-'
 

Parameters

client_port_address

Specifies the TCP/IP port address you want the ADSM server to use to contact your client node. The range of values is 1000 through 32767; the default is 1501.

Examples

Options file:
tcpclientp 1502

Command line:
-tcpclientport=1492

TCPPort

The tcpport option specifies a TCP/IP port address for an ADSM server. Obtain this address from your ADSM administrator.

Syntax

           .-1500---------.
>>-TCPPort-+--------------+------------------------------------><
           '-port_address-'
 

Parameters

port_address

Specifies the TCP/IP port address that is used to communicate with an ADSM server. The range of values is 1000 through 32767. The default is 1500.

Examples

Options file:
tcpp 1501

Command line:
-tcpport=1492

TCPServeraddress

The tcpserveraddress option specifies the TCP/IP address for an ADSM server. Obtain this server address from your ADSM administrator.

Syntax

>>-TCPServeraddress server_address-----------------------------><
 

Parameters

server_address

Specifies a one- to 64-character TCP/IP address for an ADSM server. Specify a TCP/IP Internet domain name or a dot address.

Examples

Options file:
tcps dsmchost.endicott.ibm.com

Command line:
-tcpserveraddress=129.33.249

TCPWindowsize

The tcpwindowsize option specifies the buffer size of the TCP/IP sliding window that you want to use for your client node. This buffer size is used when you send or receive data. Although it uses more memory, a larger buffer size can improve communication performance.

Syntax

                 .-32----------.
>>-TCPWindowsize-+-------------+-------------------------------><
                 '-window_size-'
 

Parameters

window_size

Specifies the size, in kilobytes, that you want to use for your client node TCP/IP sliding window. The minimum value is one, and the maximum value is 64. The default is 32.

Examples

Options file:
tcpwindowsize 1

Command line:
-tcpw=24

Timeformat

The timeformat option specifies the format in which you want system time displayed.

Syntax

              .-1-------------.
>>-TIMEformat-+---------------+--------------------------------><
              '-format_number-'
 

Parameters

format_number

Displays time in one of the formats displayed below. Select the format number ( 1-4) according to the format in which you want to represent time.
  1. 23:00:00 (This is the default.)
  2. 23,00,00
  3. 23.00.00
  4. 12:00:00AM/PM

Examples

Options file:
TIMEFORMAT 4

Command line:
-TIME=3

TPName

The tpname option specifies a symbolic name for the transaction program name. The transaction program name is required if the symbolic destination name is not provided for SNA LU6.2 communication.

If you use this option, you must also define the cpicmodename and partnerluname options.

Syntax

>>-TPname symbolic_name----------------------------------------><
 

Parameters

symbolic_name

Specifies a one- to 64-character transaction program name of the target logical unit (the ADSM server). Contact your ADSM administrator for this name. There is no default.
Note:To communicate with an AIX ADSM server, enter dsmserv as the symbolic name.

Examples

Options file:
tpname adsm

Command line:
-tp=adsm

Txnbytelimit

The txnbytelimit option specifies the number of kilobytes ADSM should buffer before it sends a transaction to the server. A transaction is the unit of work exchanged between the client and server. Because ADSM can transfer more than one file or directory between the client and server before it commits the data to server storage, a transaction can contain more than one file or directory. This is sometimes referred to as a transaction group.

This option allows you to control the amount of data sent between the client and server before the server commits the data and changes to the server database, thus altering the speed with which the client performs work. This limit applies when files are batched together during backup. It is also used when receiving files from the server during a restore procedure.

The server administrator can limit the number of files or directories contained within a group transaction using the txngroupmax option; the actual size of a transaction can be less than your limit. Once this number is reached, the client sends the files to the server even if the transaction byte limit is not reached.

Syntax

                .-2048---.
>>-TXNBytelimit-+--------+-------------------------------------><
                '-number-'
 

Parameters

number

Specifies the number of kilobytes ADSM can buffer together in a transaction before it sends data to the server. The range of values is 300 through 25600 (25 MB). The default is 2048.

Examples

Options file:
txnb 1024

Command line:
-txnb=1024

Verbose

The verbose option specifies that you want processing information to display on your screen. This is the default. Specify the quiet option if you do not want processing information to display on your screen.

Syntax

>>-VErbose-----------------------------------------------------><
 

Examples

Options file:
VERBOSE

Command line:
-VE


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