The ADSM common options are located in the dsm.opt client options file. These options are arranged in the following categories:
During ADSM installation and setup, a sample client options file named dsm.smp is provided. If you want to use options other than those specified in the sample client options file, you can create your own options file. Copy the sample file to the dsm.opt file and modify the required options in the new copy. Required options, such as nodename, provide information that the backup-archive client needs to establish communication with an ADSM server.
The default location for the client options file is the installation directory, sys:/adsm. During installation, you can select a different volume and directory name on your NetWare server, or you can select a volume and directory on a remote NetWare server. The search add line in your autoexec.ncf file points to the directory where your client options file is located.
Some options are used only with ADSM commands. For more information about these options, see "Command Options".
Table 3 lists the authorization options that control access to an ADSM
server.
Table 3. Authorization Options
| Option | Description | Page |
|---|---|---|
| nwpwfile | Specifies whether ADSM encrypts a NetWare user's id and password and saves them to a .pwd file. Use to save NetWare user ID and password for subsequent connections. | Nwpwfile |
| nwuser | Specifies a user id and password to connect to a NetWare server. The user must have NetWare supervisor status. ADSM prompts the user for a user id and password if each item is not specified. | Nwuser |
| optfile | Specifies the options file you want ADSM to use when you start an ADSM session. | Optfile |
| password | Specifies an ADSM password. | Password |
| passwordaccess | Specifies whether you want your ADSM password generated automatically or set as a user prompt. | Passwordaccess |
| passworddir | Forces the directory location in which to store an encrypted password file. | Passworddir |
Table 4 lists client options that control some aspects of backup and archive
processing.
Table 4. Backup and Archive Client Options
| Option | Description | Page |
|---|---|---|
| changingretries | Specifies the number of retries to attempt when backing up or archiving a file that is in use. | Changingretries |
| compressalways | Specifies whether to compress files before sending them to the ADSM server. | Compressalways |
| compression | Specifies whether to compress files or send them uncompressed if compression causes them to grow. | Compression |
| dirmc | Specifies the management class to use for directories. If this is not specified, the management class with the longest retention time is used. | Dirmc |
| domain | Specifies the volumes included in your default client domain for incremental backup. | Domain |
| exclude | Specifies a file or group of files you want to exclude from backup services. Any file in your client domain that is not specifically excluded with this option is considered for backup. | Exclude |
| include | Specifies one of the following:
| Include |
| inclexcl | Specifies the path and file name of your include-exclude options file. | Inclexcl |
| memoryefficientbackup | Specifies a memory-saving backup algorithm for incremental backups. Use this with the incremental command. | Memoryefficientbackup |
| subdir | Specifies whether to include subdirectories of a named directory. | Subdir |
| tapeprompt | Specifies whether you want ADSM to wait for a tape that is required for a backup or archive to be mounted, or to prompt you for your choice. | Tapeprompt |
Table 5 lists the options that apply when you use specific ADSM
commands.
| Option | Description | Page |
|---|---|---|
| editor | Specifies if the command line interface editor and command retrieve capability is turned on or off. | Editor |
| quiet | Specifies that you do not want processing information to display on your screen. | Quiet |
| scrolllines | Specifies the number of lines to display at one time when displaying a list of items. Use this option only when scrollprompt is set to Yes. | Scrolllines |
| scrollprompt | Specifies that ADSM either stops after displaying the number of lines defined by scrolllines, or that it scrolls to the end of the list. | Scrollprompt |
| verbose | Specifies that you want processing information to display on your screen. |
|
Communication options specify how your client node communicates with an ADSM server. The options you specify depend upon the communication protocol you select.
Ask your ADSM administrator for assistance in setting your communication options. To specify which of these protocols you want, use the commmethod option. For more information, see Commmethod.
Table 6 lists the communication options for IPX/SPX.
Table 6. IPX/SPX Communication Options
| Option | Description | Page |
|---|---|---|
| ipxbuffersize | Specifies the size, in kilobytes, of the IPX/SPX communication buffer. | IPXBuffersize |
| ipxserveraddress | Specifies the IPX/SPX address for an ADSM server. | IPXServeraddress |
| ipxsocket | Specifies the IPX/SPX socket number for an ADSM server. | IPXSocket |
Use the nodename option to specify the client node for which you want
to request services.
Table 7. NODENAME Communication Option
| Option | Description | Page |
|---|---|---|
| nodename | The nodename option specifies one of the following:
| Nodename |
To use the TCP/IP protocol, include the TCPserveraddress option in your
client options file.
Table 8. TCP/IP Communication Options
| Option | Description | Page |
|---|---|---|
| tcpbuffsize | Specifies the size, in kilobytes, of the ADSM internal TCP/IP communication buffer. | TCPBuffsize |
| tcpport | Specifies the TCP/IP port address for an ADSM server. | TCPPort |
| tcpserveraddress | Specifies the TCP/IP address for an ADSM server. | TCPServeraddress |
| tcpwindowsize | Specifies the size, in kilobytes, of the TCP/IP sliding window for your client node. | TCPWindowsize |
This option controls how ADSM manages the entries in the log file.
Table 9. Error Processing Option
| Option | Description | Page |
|---|---|---|
| errorlogname | Specifies the path and name of the error log. | Errorlogname |
| errorlogretention | Specifies the number of days to keep log file entries in the error log, and whether to save pruned entries. | Errorlogretention |
| nwwaitonerror | Specifies whether an error message is displayed if an error occurs while exiting an ADSM session. | Nwwaitonerror |
You can use options to select formats for date, time, numbers, and
language if you have the client installed for that language.
Table 10. Format and Language Options
| Option | Description | Page |
|---|---|---|
| dateformat | Specifies the format used to display dates. | Dateformat |
| language | Specifies the language used to display messages. | Language |
| numberformat | Specifies the format used to display numbers. | Numberformat |
| timeformat | Specifies the format used to display time. | Timeformat |
Use the following options to restore and retrieve files when you enter a
restore or retrieve command.
Table 11. Restore and Retrieve Options
| Option | Description | Page |
|---|---|---|
| replace | Specifies whether to overwrite an existing file, or to prompt you for your choice when you restore or retrieve files. | Replace |
| subdir | Specifies whether you want to include subdirectories of a named directory. | Subdir |
| tapeprompt | Specifies whether you want ADSM to wait for a required tape to be mounted for a restore or retrieve, or to prompt you for your choice. | Tapeprompt |
Some of the options in the client options file govern central scheduling. Use these options to provide information to ADSM when you perform scheduled work. ADSM uses scheduling options only when the schedule command is running.
ADSM server settings can override most of these options after the
backup-archive client program on your workstation connects with the ADSM
server.
| Option | Description | Page |
|---|---|---|
| maxcmdretries | Specifies the maximum number of times the client scheduler attempts to process a failed, scheduled command. | Maxcmdretries |
| postschedulecmd | Specifies a command to process after running a schedule. | Postschedulecmd |
| preschedulecmd | Specifies a command to process before running a schedule. | Preschedulecmd |
| queryschedperiod | Specifies the number of hours the client scheduler waits between unsuccessful attempts to contact the ADSM server for scheduled work. | Queryschedperiod |
| retryperiod | Specifies the number of minutes the client scheduler waits between attempts to process a failed, scheduled command, or between unsuccessful attempts to report results to the server. | Retryperiod |
| schedlogname | Specifies the filename where schedule log information is stored. | Schedlogname |
| schedlogretention | Specifies the number of days to keep log file entries in the schedule log, and whether to save pruned entries. | Schedlogretention |
| schedmode | Specifies which schedule mode to use, polling or prompted. | Schedmode |
| tcpclientaddress | Specifies the TCP/IP address of your client node. Use this only with the schedule command when you specify prompted as the schedule mode. | TCPClientaddress |
| tcpclientport | Specifies the TCP/IP port number of your client node. Use this only with the schedule command when you specify prompted as the schedule mode. | TCPClientport |
This option controls how ADSM processes transactions between the client and
the server.
Table 13. Transaction Processing Option
| Option | Description | Page |
|---|---|---|
| txnbytelimit | Controls transaction processing. | Txnbytelimit |