The following sections contain detailed information about each of the ADSM processing options. These options are arranged in alphabetical order. Information for each option includes:
The option name is shown in a combination of uppercase and lowercase characters. The uppercase characters indicate the minimum abbreviation you can use for the option name.
| 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. |
Figure 74 lists the options available for the Apple Macintosh platform.
Figure 74. Macintosh Options Reference
Books Changingretries Commmethod Compressalways Compression Dateformat Dirmc Domain Errorlogname Errorlogretention Exclude Include Language |
Matchallchar Matchonechar Maxcmdretries Nodename Numberformat Memoryefficientbackup Password Passwordaccess Passworddir Postschedulecmd Preschedulecmd Queryschedule |
Quiet Retryperiod Schedcompleteaction Schedlogname Schedlogretention Tapeprompt Tcpbuffsize Tcpport Tcpserveraddress Tcpwindowsize Timeformat Verbose |
Figure 75 lists the options available for the Novell NetWare platform.
Figure 75. NetWare Options Reference
Changingretries Commmethod Compressalways Compression Cpicbuffersize Cpicmodename Dateformat Dirmc Domain Editor Errorlogname Errorlogretention Exclude Include Inclexcl IPXBuffersize IPXServeraddress IPXSocket Language Maxcmdretries |
Memoryefficientbackup Nodename Numberformat Nwignorecompressbit Nwpwfile Nwuser Nwwaitonerror Optfile Partnerluname Password Passwordaccess Passworddir Postschedulecmd Preschedulecmd Processorutilization Queryschedperiod Quiet Replace Retryperiod |
Schedlogname Schedlogretention Schedmode Scrolllines Scrollprompt Subdir Symbolicdestination Tapeprompt TCPBuffsize TCPClientaddress TCPClientport TCPNodelay TCPPort TCPServeraddress TCPWindowsize Timeformat TPName Txnbytelimit Verbose |
Figure 76 lists the options available for the OS/2 platform.
Figure 76. OS/2 Options Reference
Books Changingretries Commmethod Commrestartduration Commrestartinterval Compressalways Compression Cpicbuffersize Cpicmodename Dateformat Dirmc Domain Editor Errorlogretention Exclude Inclexcl Include Ipxbuffersize Ipxserveraddress Ipxsocket Lanadapter |
Language Mailprog Maxcmdretries Memoryefficientbackup Namedpipename Netbiosbuffersize Netbiosname Netbiosservername Netbiostimeout Nodename Numberformat Optfile Partnerluname Password Passwordaccess Passworddir Postschedulecmd Preschedulecmd Queryschedperiod Quiet Replace |
Retryperiod Schedlogname Schedlogretention Schedmode Scrolllines Scrollprompt Shmport Subdir Symbolicdestination Tapeprompt Tcpbuffsize Tcpclientaddress Tcpclientport Tcpnodelay Tcpport Tcpserveraddress Tcpwindowsize Timeformat Tpname Txnbytelimit Verbose |
ADSM processing options reside in these files:
This file contains required communication options, authorization options, a subset of options that relate to backup and archive processing, scheduling options, and options that relate to HSM.
If you are a root user, you are responsible for creating and modifying the client system options file.
The client user options file contains options that control processing for sessions with ADSM, including some additional options that relate to backup, archive, restore, and retrieve processing.
If you are a root user, you create a default client user options file that can be used by all users on your workstation.
If you are a user and want to use different options than those specified in the default client user options file, you can create your own options file.
You can always override any of the options set in the client user options file you use by entering the options with appropriate ADSMcommands. For more information, see "Using Options With Commands".
The include-exclude options file contains a list of the include and exclude options. See "Creating an Include-Exclude List" for detailed examples on each platform.
Figure 77 lists the options available for the UNIX platform.
Figure 77. UNIX Options Reference
Automount Books Changingretries Checkthresholds Commmethod Commrestartduration Commrestartinterval Compressalways Compression CPICBuffersize CPICModename Dateformat Defaultserver Dirmc Domain Dotdircheck Editor Errorlogretention Errorprog Exclude Followsymbolic Groups Inclexcl Include Kernelmessages Language |
Largecommbuffers Mailprog Maxcmdretries Maxrecalldaemons Maxreconcileproc Maxthresholdproc Memoryefficientbackup Migfileexpiration Migrateserver Minrecalldaemons NFSTimeout Nodename Numberformat Optfile Optionformat Partnerluname Password Passwordaccess Passworddir Postschedulecmd Preschedulecmd Queryschedperiod Quiet Reconcileinterval Replace Restoremigstate |
Retryperiod Schedlogname Schedlogretention Schedmode Scrolllines Scrollprompt Servername Shmport Subdir Symbolicdestination Tapeprompt TCPBuffsize TCPClientaddress TCPClientport TCPNodelay TCPPort TCPServeraddress TCPWindowsize Timeformat TPName Txnbytelimit Users Verbose Virtualmountpoint Virtualnodename |
Figure 78 lists the options available for the Microsoft Windows NT platform.
Figure 78. Windows NT Options Reference
Backupregistry Books Changingretries Commmethod Commrestartduration Commrestartinterval Compression CPICBuffersize CPICModename Dateformat Dirmc Domain Errorlogretention Exclude Fstypes Include IPXBuffersize |
IPXServeraddress IPXSocket Lanadapter Language Maxcmdretries Memoryefficientbackup Netbiosbuffersize Netbiosname Netbiosservername Netbiostimeout Nodename Numberformat Optfile Partnerluname Password Passwordaccess Passworddir |
Queryschedperiod Retryperiod Schedlogname Schedlogretention Skipntpermissions Skipntsecuritycrc Subdir Symbolicdestination Tapeprompt TCPBuffsize TCPPort TCPServeraddress TCPWindowsize Timeformat TPName Txnbytelimit |
Figure 79 lists the options available for the Microsoft Windows 95 platform.
Figure 79. Windows 95 Options Reference
Books Changingretries Commmethod Commrestartduration Commrestartinterval Compressalways CPICBuffersize CPICModename Compression Dateformat Dirmc Domain Errorlogretention Exclude Fstypes IPXBuffersize IPXServeraddress IPXSocket Lanadapter Language |
Maxcmdretries Memoryefficientbackup Netbiosbuffersize Netbiosname Netbiosservername Netbiostimeout Nodename Numberformat Optfile Partnerluname Password Passwordaccess Passworddir Postschedulecmd Preschedulecmd Queryschedperiod Quiet Replace Retryperiod |
Schedlogname Schedlogretention Schedmode Scrolllines Scrollprompt Subdir Symbolicdestination Tapeprompt TCPBuffsize TCPClientaddress TCPClientport TCPNodelay TCPPort TCPServeraddress TCPWindowsize Timeformat TPName Txnbytelimit Verbose |
Use the AUTOMOUNT option to specify a symbolic link to an NFS mount point monitored by the Solaris automounter. The automount filespace specified in this option is considered as a valid domain for ADSM incremental backup.
This option is required if you want ADSM to add the automount filespace to the File Systems for Backup/Archive part of the File System Information window in the ADSM GUI. It is also required if you want to include the automount filespace in an incremental backup using the command-line client or the client scheduler when the symbolic link points to a mount point monitored by automounter using indirect map.
Supported Clients
Clients that can use this option: UNIX.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is valid for Solaris workstations only.
Syntax
>>-AUTOMount- filespace----------------------------------------><
Parameters
Examples
Where /home/user1 -> /tmp_mnt/home/user1
Use the BACKUPREGISTRY option to specify whether ADSM should back up the NT registry during incremental backups.
Supported Clients
Clients that can use this option: Windows NT.
Syntax
.-Yes-.
>>-BACKUPRegistry-+-----+--------------------------------------><
'-No--'
Parameters
This is the default.
Examples
Use the BOOKS option to make the ADSM online publications available through the ADSM graphical user interface.
If you set the option in the options file, you can read the online publications by clicking on the Help menu; View Books item. If you do not set the option, you can still read the online books by starting the online book reader outside of ADSM.
Supported Clients
Clients that can use this option: Macintosh, OS/2, Windows 95, Windows NT, and UNIX.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
>>-BOOKS- command----------------------------------------------><
Parameters
All ADSM books are available in online readable format using either IBM BookManager, Adobe Acrobat Reader, or a Web browser. The BookManager, Acrobat Reader, and HTML versions are available on the ADSM Online Product Library CD-ROM (SK2T-1396). The BookManager, Acrobat Reader, and HTML versions are also available on the other CD-ROMs listed in "Related Publications".
You or your administrator must install the books and readers separately from the product, as described in the information booklet included with the CD-ROM.
Because of the large amount of disk space required to hold the reader programs and ADSM publications, we recommend that the ADSM administrator install the readers and publications on a LAN server or other machine easily accessible to client users.
Examples
Use the CHANGINGRETRIES option to specify 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, which is an attribute in a management class copy group. ADSM uses this option only when serialization is shared static or shared dynamic.
With shared static, if a file is in use during the first backup or archive attempt, ADSM retries the operation the number of times specified with this option. If the file is in use during each attempt, the operation is not completed.
With shared dynamic, if a file is in use during the first backup or archive attempt, ADSM retries the operation the number of times specified with this option. The backup or archive occurs during the last attempt regardless of whether the file is currently in use.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-CHAngingretries- numberretries------------------------------><
Parameters
The range of values is 0 to 4.
The default is 4.
Examples
Use the CHECKTHRESHOLDS option to specify how often the space monitor daemon checks space usage on your file systems. The space monitor daemon checks each file system to which you have added space management.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is used only when the ADSM HSM client is installed on your workstation. It must be placed at the beginning of the client system options file before any server stanzas.
Syntax
>>-CHEckthresholds interval------------------------------------><
Parameters
The range of values is 1 to 9999.
The default is 5.
Examples
Use the COMMMETHOD option to specify the communication method you are using to provide connectivity for client-server communication.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-COMMmethod-+- SHAREdmem--+----------------------------------><
+- SNAlu6.2---+
+- TCPip------+
+- NETBios----+
+- IPXspx-----+
'- NAMEdpipe--'
Parameters
| Note: | On an AIX 4.1 server, you can establish a maximum of 10 concurrent shared memory communications sessions. |
Examples
The commrestartduration option specifies the maximum number of minutes you want the ADSM client to try to reconnect to an ADSM server after a communication error occurs.
| Note: | The connection and schedule will fail if a communication failure occurs while a schedule is running, and the client is unable to reconnect to the server before the startup window for the schedule ends. |
Options File for UNIX Platforms
This option is placed in the client system options file.
Syntax
>>-COMMRESTARTDuration- minutes--------------------------------><
Parameters
Examples
The commrestartinterval option specifies the number of seconds you want the ADSM client to wait between attempts to reconnect to an ADSM server after a communication error occurs.
| Note: | This option is used only when commrestartduration is set to a value greater than 0. |
Options File for UNIX Platforms
This option is placed in the client system options file.
Syntax
>>-COMMRESTARTInterval- seconds--------------------------------><
Parameters
Examples
Use the COMPRESSALWAYS option to control what ADSM does when a file grows during compression. You can cause ADSM to either continue compressing or not to send the object if it grows during compression. This option has no effect unless the COMPRESSION option is set to Yes.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
.-Yes-.
>>-COMPRESSAlways-+-----+--------------------------------------><
'-No--'
Parameters
This is the default.
For API applications, if the object grows during compression, the send will terminate with return code DSM_RC_COMPRESS_GREW. The application is responsible for trying the resend without compression by setting the API dsmSendObj function ObjAttr.objCompressed parameter to bTrue. For additional information see ADSTAR Distributed Storage Manager Using the Application Programming Interface, SH26-4081.
Examples
Use the COMPRESSION option to specify 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 of files, archived copies of files, and migrated files. However, it can 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 the choice is determined by your client node.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
.-No--.
>>-COMPRESSIon-+-----+-----------------------------------------><
'-Yes-'
Parameters
This is the default.
Examples
Use the CPICBUFFERSIZE option to specify the size of the CPIC buffer for SNA LU6.2 communication. A larger buffer can improve communication performance, but uses more memory.
Supported Clients
Clients that can use this option: All except Macintosh.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-CPICBuffersize- size----------------------------------------><
Parameters
The range of values is 1 to 31.
The default for UNIX, OS/2, and NetWare is 31.
Examples
Use the CPICMODENAME option to define 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.
Supported Clients
Clients that can use this option: All except Macintosh.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-CPICModename- name------------------------------------------><
Parameters
There is no default.
Examples
Use the DATEFORMAT option to select the format you want ADSM to use for displaying dates.
For AIX and Solaris Users Only: AIX and Solaris support a locale describing every user interface that varies with location or language. The default directories for system-supplied locales are /usr/lib/nls/loc in AIX, and /usr/lib/localedef/src in Solaris. The ADSM backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. If the locale--specified format consists of digits and separator characters then ADSM defaults to dateformat 0, otherwise dateformat 1 is used. Consult the documentation on your local system for details on setting up your locale definition.
Supported Clients
Clients that can use this option: All
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
>>-DATEformat- number------------------------------------------><
Parameters
| For AIX and Solaris Users Only: | To set a particular date format, edit the source file for your locale and
modify the d_fmt line to support your needs. Whatever date format
you select applies both to output and to input, except input year can be
either 2 or 4 digits.
|
Examples
Use the DEFAULTSERVER option to specify the server to which ADSM backs up and archives files from your local systems by default.
If you have the ADSM HSM client installed on your workstation, and you do not specify a migration server with the MIGRATESERVER option, this option also specifies the ADSM server to which ADSM migrates files from your local file systems.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file. It must be placed at the beginning of the client system options file before any server stanzas.
Syntax
>>-DEFAULTServer- servername-----------------------------------><
Parameters
Examples
Use the DIRMC option to specify the management class you want ADSM to use for backed up directories. If you do not use this option to associate a management class with backed up directories, ADSM uses the management class in the active policy set of your policy domain that has the longest retention period.
When choosing a management class for backed up directories, be sure to choose one that allows ADSM to retain directories at least as long as it retains the files associated with them.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-DIRMc- mgmtclassname----------------------------------------><
Parameters
The default is the management class in the active policy set of your policy domain with the longest retention period.
Examples
This description applies generally to all platforms. Consider the term local drives to mean volumes or file systems if one of those terms applies to your platform. For more specific information about this option, see the "Setting Processing Options" section of the appropriate Using the Backup-Archive Client book for your platform.
Use the DOMAIN option to specify the drives you want to include in your client domain for incremental backup. When you use this option in your client options file, it defines your default client domain. ADSM uses your default client domain to determine which local drives to process during an incremental backup in these situations:
If you do not specify local drives with the DOMAIN option in your client options file, the default is all local drives.
When you use this option with the INCREMENTAL command, it adds the local drives you specify to what is defined in your client options file. For example, if you enter DOMAIN c: d: e: in the client options file and you enter dsmc incremental -domain="g: h:" on the command line, ADSM performs an incremental backup for your c:, d:, e:, g:, and h: local drives.
If you use both the drives parameter and the DOMAIN option on the INCREMENTAL command, ADSM ignores the DOMAIN option and processes only those drives in the drives parameter. For example, if you enter the following, ADSM performs an incremental backup only for the e: and f:.
dsmc incremental e: f: -domain="g: h:"
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
.-all-local-.
>>-DOMain-+-----------+----------------------------------------><
'-domain----'
Parameters
Examples
Use the DOTDIRCHECK option to specify whether you want ADSM to check for "." and ". ." entries in a directory during an incremental backup.
Setting this option to Yes allows you to back up VM NFS-mounted minidisks that do not contain those entries.
Supported Clients
Clients that can use this option: UNIX.
Options File for UNIX Platforms
This option goes in the client user options file.
Syntax
.-Yes-.
>>-DOTDIRcheck-+-----+-----------------------------------------><
'-No--'
Parameters
This is the default.
Examples
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 fuction.
Supported Clients
Clients that can use this option: UNIX.
Options File for UNIX Platforms
This option is placed in the system and client options file.
Syntax
.-ON--.
>>-EDITOR-+-----+----------------------------------------------><
'-OFf-'
Parameters
Examples
Use the ERRORLOGNAME option to specify the path and name of the file where you want ADSM to store information about errors that occur during processing.
Supported Clients
Clients that can use this option: Macintosh and Novell.
Syntax
>>-ERRORLOGname- filespec--------------------------------------><
Parameters
The default is the installation directory with a file name of dsmerror.log.
Examples
Use the ERRORLOGRETENTION option to specify:
The error log is pruned when the first error is written to the log after an ADSM session is started and after every schedule is run. If the only ADSM session you run is the scheduler, and you run it 24 hours a day, the error log might not be pruned according to your expectations. You must stop the session and restart it to allow the log to be pruned when the next error is written.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
.-N----. .-D-.
>>-ERRORLOGRetention---+------+--+---+-------------------------><
'-days-' '-S-'
Parameters
This is the default.
The range of values is 0 to 9999.
If you specify anything but D or S, ADSM uses the default D. You must use a space or comma to separate this parameter from the previous one.
This is the default.
ADSM copies the entries pruned from the error log to dsmerlog.pru. This file is in the same directory as the error log.
Examples
Use the ERRORPROG option to specify a program you want ADSM to execute if a severe error occurs during HSM processing.
For example, ADSM executes the program if the space monitor daemon stops running, an orphaned stub file is found when ADSM reconciles a file system, or ADSM is unable to locate a migrated file in ADSM storage when attempting to recall the file.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is used only when the ADSM HSM client is installed on your workstation.
Syntax
>>-ERRORProg program-name--------------------------------------><
Parameters
The program you specify must accept standard input.
Examples
Use the EXCLUDE option to exclude 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, and operating system files.
If you have the ADSM backup-archive client and the ADSM HSM client installed on your workstation, use the exclude option to exclude a file or group of files from both backup and space management services. Any files you exclude with this option are not considered for backup or for migration.
To exclude a file from backup only, use the exclude.backup option. To exclude a file from space management only, use the exclude.spacemgmt option.
If you want to exclude an entire directory from ADSM backup services, use the exclude.dir option. For example, you might want to exclude a particular subdirectory within a directory when you back up the directory. When you exclude a directory, you can still choose to back up specific files within the directory, using selective backup.
The exclude.dir option works only if the excluded directory is a subdirectory; if you explicitly specify the directory or the files within it, the file is backed up.
You can use wildcard characters to exclude a broad range of files. See "Including and Excluding Groups of Files" for a list of wildcards you can use. Then, if necessary, you can use the INCLUDE option to make exceptions.
See "Creating an Include-Exclude List" for more information. See also the list of files in "Excluding System Files" that should always be excluded for each platform.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the include-exclude options file, the client system options file, or the client user options file.
Syntax
.----------------------------------------.
V |
>>----EXCLUDE-+------------------+-pattern--+------------------><
+-.Backup----------+
+-.Dir-------------+
+-.File------------+
+-.FILE.Backup-----+
+-.FILE.Spacemgmt--+
+-.FS--------------+
'-.Spacemgmt-------'
Parameters
Examples
exclude ?:\...\swapper.dat exclude "*:\ea data. sf" exclude ?:\io.sys exclude ?:\...\spart.par exclude c:\*\budget.fin exclude c:\devel\* exclude.backup c:\temp\file1 exclude.spacemgmt c:\temp\file1
Use the FOLLOWSYMBOLIC option to specify whether you want ADSM to restore files to symbolic links, and to allow a symbolic link to be used as a virtual mount point.
Supported Clients
Clients that can use this option: UNIX.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
.-No--.
>>-FOLlowsymbolic-+-----+--------------------------------------><
'-Yes-'
Parameters
This is the default.
Examples
Use the FSTYPES option to specify which types of file systems you want to see when looking at another node's file spaces on the ADSM server. This is only used when you are querying, restoring, or retrieving files from another node, allowing you to see non-FAT drives.
Supported Clients
Clients that can use this option: Windows 95 and Windows NT.
Syntax
>>-FSTYPES-+- *-----------+------------------------------------><
| .--------. |
| V | |
'--- types--+--'
Parameters
The default is to show FAT and RMT-FAT drives only.
Examples
Use the GROUPS option to authorize specific groups on your workstation to request ADSM services.
You can use the GROUPS option more than once to authorize a large number of groups.
If you do not specify group names with the GROUPS option or user IDs with the USERS option, all users can request ADSM services. If you use the GROUPS option, the USERS option, or both, only users included in one of the specified groups or included in the list of users can request ADSM services.
A root user is always authorized to request services.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
.---------------------------. | .--------------. | V V | | >>----GRoups---- groupname--+--+-------------------------------><
Parameters
Examples
groups dsmcdev group1 test1 test2 design1 groups endicott almaden qadev qadev1 tools23 groups tools31 tools35 toolsdv toolsdv1
Use the INCLEXCL option to specify the path and file name of your include-exclude options file if you choose to use one.
You can use an include-exclude options file to exclude specific files or groups of files from backup (and migration if you have the HSM client installed). You can also use an include-exclude options file to assign management classes to specific files or groups of files.
For detailed information about excluding and including files, see "Creating an Include-Exclude List".
In other UNIX environments, be sure that your include-exclude options file is in a directory, such as /etc, to which all users have read access.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-INCLExcl filespec-------------------------------------------><
Parameters
Examples
inclexcl /usr/dsm/backup.excl inclexcl /etc/inclexcl.def
Use the INCLUDE option to specify one of the following:
The include option cannot be used to override an exclude.dir option.
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.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the include-exclude options file, the client system options file, or the client user options file.
Syntax
.---------------------------------------------------.
V |
>>----INCLUDE-+--------+- pattern-+-----------------+--+-------><
'-.File--' '- mgmtclassname--'
Parameters
You must end this variable with a file specification.
If the pattern contains a blank, you must enclose the pattern in quotation marks.
Examples
exclude c:\proj\text\* include c:\proj\text\devel.*
include c:\proj\text\* textfiles
include ?:* managall
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.
Use the IPXBUFFERSIZE option to specify the size you want to use for the IPX buffer used to transfer data between the client node and the server.
A larger buffer can improve communication performance, but uses more memory.
Supported Clients
Clients that can use this option: Novell, OS/2, Windows 95, and Windows NT.
Syntax
>>-IPXBuffersize- number---------------------------------------><
Parameters
The range of values is 1 to 16.
The default is 16.
Examples
Use the IPXSERVERADDRESS option to specify the IPX/SPX address of an ADSM server on a Novell, OS/2, Windows 95, or Windows NT host.
Supported Clients
Clients that can use this option: Novell, OS/2, Windows 95 and Windows NT.
Syntax
>>-IPXSErveraddress- server_address----------------------------><
Parameters
An IPX/SPX address is a concatenation of the following:
Each field must be padded with leading zeros if the value is shorter than the specified length.
If an IPX/SPX address is not specified, the default address for the server is the same as the address for the client workstation.
Examples
Use the IPXSOCKET option to specify the socket number for an ADSM server on an Novell, OS/2, Windows 95, or Windows NT host.
Supported Clients
Clients that can use this option: Novell, OS/2, Windows 95, and Windows NT.
Syntax
>>-IPXSOcket- socketnumber-------------------------------------><
Parameters
The default is 8522.
Examples
Use the KERNELMESSAGES option to specify whether you want ADSM to display HSM-related messages issued by the kernel during processing.
| Note: | For transparent recall, if more than one process accesses the same migrated file at one time, the kernel issues a message for the first process that accesses the file only. |
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is used only when the ADSM HSM client is installed on your workstation. It must be placed at the beginning of the client system options file before any server stanzas.
Syntax
.-Yes-.
>>-KERNelmessages-+-----+--------------------------------------><
'-No--'
Parameters
This is the default.
Examples
Use the LANADAPTER option to specify a communication adapter number when using the NETBIOS communication method.
Supported Clients
Clients that can use this option: OS/2
Syntax
>>-LANAdapter- adapter_number----------------------------------><
Parameters
The number must be 0 or 1.
The default is 0.
Examples
Use the LANGUAGE option to specify the national language for presenting client messages.
Supported Clients
Clients that can use this option: All except AIX, DEC, HP-UX, SGI, and Solaris.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file. For AIX, DEC, HP-UX, SGI, and Solaris clients the language setting is derived from the LANG environment variable.
Syntax
>>-LANGuage- language------------------------------------------><
Parameters
Some platforms support other languages. Refer to the individual client books listed in Figure 2 for more information.
Examples
The largecommbuffers option specifies whether the client will use increased buffers to transfer large amounts of data between the client and the server. You can disable this option when your machine is running low on memory.
Syntax
.-Yes-.
>>-LARGECOMmbuffers-+-----+------------------------------------><
'-No--'
Parameters
Examples
Use the MAILPROG option to specify the program and user ID to which you want ADSM to send a newly generated password when the old one expires.
Use this option only when you choose GENERATE for PASSWORDACCESS.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-MAILprog filespec userid------------------------------------><
Parameters
Examples
mailprog /usr/bin/xsend root mailprog /bin/mailx USER1 (for OpenEdition MVS)
| Note: | You must run the ENROLL command before ADSM can use xsend. |
Use the MATCHALLCHAR option to specify the character to use as a match-all wildcard character. For example, File* matches File1, FileA1, and File.
This option must appear before any INCLUDE or EXCLUDE statements in the Preferences file.
Supported Clients
Clients that can use this option: Macintosh only.
Syntax
>>-MATCHAllchar character--------------------------------------><
Parameters
You can use any valid ASCII character for MATCHALLCHAR except Control+X or Control+Y. Do not use the same character for both MATCHALLCHAR and MATCHONECHAR.
Examples
Use the MATCHONECHAR option to specify the character to use as a match-one wildcard character. For example, File? matches File1, but not File or File10.
This option must appear before any INCLUDE or EXCLUDE statements in the Preferences file.
Supported Clients
Clients that can use this option: Macintosh only.
Syntax
>>-MATCHOnechar character--------------------------------------><
Parameters
You can use any valid ASCII character for MATCHONECHAR, except Control+X or Control+Y. Do not use the same character for both MATCHALLCHAR and MATCHONECHAR.
Examples
Use the MAXCMDRETRIES option to specify the maximum number of times you want the client scheduler on your workstation to attempt to process a scheduled command that fails.
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.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-MAXCMDRetries- maxcmdretries--------------------------------><
Parameters
The range of values is 0 to 9999.
The default value is 2.
Examples
Use the MAXRECALLDAEMONS option to specify the maximum number of ADSMrecall daemons you want to run at one time to perform recalls for your client node.
During your normal operations, if you notice that the number of recall daemons running at one time is often close to the maximum number allowed, increase the value specified for the MAXRECALLDAEMONS option. For example, if you use an application that opens multiple files at one time, and all of the files it opens are migrated, that application could use all available recall daemons. If ADSM is unable to start a recall daemon for another process that attempts to access a migrated file, that process will be unable to continue until a recall daemon is available.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is used only when the ADSM HSM client is installed on your workstation. It must be placed at the beginning of the client system options file before any server stanzas.
Syntax
>>-MAXRECAlldaemons number-------------------------------------><
Parameters
The range of values is 2 to 99.
The default is 20.
Examples
Use the MAXRECONCILEPROC option to specify the maximum number of automatic reconciliation processes HSM can perform at one time.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is used only when the ADSM HSM client is installed on your workstation. It must be placed at the beginning of the client system options file before any server stanzas.
Syntax
>>-MAXRECOncileproc maxreconcileproc---------------------------><
Parameters
The range of values is 1 to 99.
The default is 3.
Examples
Use the MAXTHRESHOLDPROC option to specify the maximum number of automatic threshold migration processes HSM can perform at one time.
| Note: | When a file system runs out of space, ADSM does not check to see whether the maximum number of threshold migration processes are already running. It starts threshold migration as part of the demand migration process regardless of the number of threshold migration processes that are currently in progress. |
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is used only when the ADSM HSM client is installed on your workstation. It must be placed at the beginning of the client system options file before any server stanzas.
Syntax
>>-MAXThresholdproc maxthresholdproc---------------------------><
Parameters
The range of values is 1 to 99.
The default is 3.
Examples
Use the MEMORYEFFICIENTBACKUP option to specify a slower algorithm for processing incremental backups. With the MEMORYEFFICIENTBACKUP option, ADSM backs up one directory at a time, thus using less memory.
Use this option with the INCREMENTAL command when your machine is running low on memory.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
.-Yes or No depending on platform.-.
>>-MEMORYEFficientbackup-+----------------------------------+--><
+-Yes------------------------------+
'-No-------------------------------'
Parameters
This is the default for OS/2, UNIX, Windows NT, and Windows 95.
This is the default for Macintosh, and NetWare
Examples
Use the MIGFILEEXPIRATION option to specify the number of days ADSM keeps copies of migrated or premigrated files on the ADSM server after they are modified on your local file system or deleted from your local file system.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is used only when the ADSM HSM client is installed on your workstation. It must be placed at the beginning of the client system options file before any server stanzas.
Syntax
>>-MIGFileexpiration days--------------------------------------><
Parameters
The range of values is 0 to 9999.
The default is 7.
Examples
Use the MIGRATESERVER option to specify the name of the ADSM server to which you want to migrate files from your client node. You can specify only one migration server for each client node, and users cannot override the server you specify for migration in a client user options file or when issuing a command.
If you do not specify a server with the MIGRATESERVER option, ADSM migrates your files to the server identified with the DEFAULTSERVER option. If you do not specify a server with the MIGRATESERVER option or the DEFAULTSERVER option, ADSM migrates your files to the server identified in the first stanza of your client system options file by default.
After ADSM begins migrating files to the server you specify with this option or to the default server, do not make any changes to your client system options file that cause ADSM to contact a different server for migration unless your ADSM administrator exports your migrated files from the currently specified server and imports them to another. Otherwise, ADSM will be unable to locate your migrated files until you modify options in your client system options file to contact the server to which your files were originally migrated.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is used only when the ADSM HSM client is installed on your workstation. It must be placed at the beginning of the client system options file before any server stanzas.
Syntax
>>-MIGRateserver servername------------------------------------><
Parameters
Your client system options file must contain a stanza, beginning with the SERVERNAME option, that contains at least the required communication options for the server you specify with the MIGRATESERVER option.
Examples
MIGRATEServer server_b SErvername server_a COMMmethod TCPip TCPPort 1500 TCPServeraddress almvmd.almaden.ibm.com Inclexcl /adm/adsm/excl.list SErvername server_b COMMmethod SNAlu6.2 PARtnerluname raptor TPname appcdel CPICMOdename appc Inclexcl /adm/adsm/migexl.list
Use the MINRECALLDAEMONS option to specify the minimum number of ADSMrecall daemons you want to retain to perform recalls for your client node.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is used only when the ADSM HSM client is installed on your workstation. It must be placed at the beginning of the client system options file before any server stanzas.
Syntax
>>-MINRecalldaemons number-------------------------------------><
Parameters
The range of values is 1 to 99.
The default is 3.
Examples
Use the NAMEDPIPENAME option to specify the name of a named pipe to use for communications between an ADSM client and an ADSM server on the same workstation.
Supported Clients
Clients that can use this option: OS/2, Windows NT.
Syntax
>>-NAMEdpipename- name-----------------------------------------><
Parameters
The default is \PIPE\DSMSERV.
Examples
Use the NETBIOSBUFFERSIZE option to specify the size you want to use, in kilobytes, for the NETBIOS communication buffer.
Supported Clients
Clients that can use this option: OS/2 and Windows NT.
Syntax
>>-NETBIOSBuffersize- size-------------------------------------><
Parameters
The range of values is 1 to 31.
The default is 16.
Examples
Use the NETBIOSNAME option to specify a NETBIOS name for your workstation.
Supported Clients
Clients that can use this option: OS/2 and Windows 95.
Syntax
>>-NETbiosname- name-------------------------------------------><
Parameters
The name can be a maximum of 16 characters and is case sensitive. The first character cannot be an asterisk (*), and the first three characters cannot be the letters IBM.
The default is ADSM concatenated with a time of day value.
Examples
Use the NETBIOSSERVERNAME option to specify a NETBIOS name for an ADSM server.
Supported Clients
Clients that can use this option: OS/2, Windows 95, and Windows NT.
Syntax
>>-NETBIOSServername- name-------------------------------------><
Parameters
The name can be a maximum of 16 characters and is case sensitive. The first character cannot be an asterisk (*), and the first three characters cannot be the letters IBM.
The default is ADSMSERV1.
Examples
Use the NETBIOSTIMEOUT option to specify the number of seconds that must elapse before a timeout occurs for a NETBIOS send or receive. If your LAN environment has slow response times or you are backing up directly to tape, it is recommended that you use a value of 0.
Supported Clients
Clients that can use this option: OS/2, Windows 95, and Windows NT.
Syntax
>>-NETBIOSTimeout- seconds-------------------------------------><
Parameters
The range of values is 1 to 120. A value of 0 results in no timeout.
The default is 60.
Examples
The nfstimeout option specifies the amount of time in seconds ADSM will wait for an NFS system call response before timing out. If you do not have any NFS mounted filesystems or you do not want this timeout option you can simply erase the dsmstat executable in the ADSM program directory.
Supported Clients
Clients that can use this option: UNIX.
Syntax
>>-NFSTIMEout- seconds-----------------------------------------><
Parameters
Examples
Use the NODENAME option to identify your workstation to the server. You can use different node names to identify multiple systems on your workstation.
You can also use the NODENAME option if you want to restore or retrieve files from the server while you are working from a different workstation. When you use the NODENAME option, ADSM prompts you for the ADSM password assigned to the node you specify if a password is required. On a UNIX client, if you enter the correct password for the node you specify, you become a virtual root user and can access all backups and archives that originated from the specified node.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option is used in the client system options file to specify the name of your client node, or use virtualnodename in the client user options file to specify the name of a different client node. When virtualnodename is used in the client user options file or with a command, the node name specified must be different than the name returned by the hostname command.
Syntax
>>-NODename- nodename------------------------------------------><
Parameters
For Windows NT and Windows 95, the default is the name of the machine if you do not use this option. We recommend that you do not use the NODENAME option on Windows NT or Windows 95, allowing the node name to default to the machine name.
For UNIX, the default is the same as the name returned by the hostname command.
Examples
Use the NUMBERFORMAT option to specify the format you want ADSM to use for displaying numbers.
| For AIX and Solaris Users Only: | AIX and Solaris support a locale describing every user interface that varies with location or language. The default directories for system-supplied locales are /usr/lib/nls/loc in AIX, and /usr/lib/localedef/src in Solaris. ADSM backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. Consult the documentation on your local system for details about setting up your locale definition. |
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
>>-NUMberformat- number----------------------------------------><
Parameters
This is the default.
| For AIX and Solaris Users Only: | To define number formats, modify the following lines in the source file of your locale. Whatever format you select applies both to output and to input. |
Examples
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.11 file system.
Supported Clients
Clients that can use this option: Novell only.
Syntax
.-No--.
>>-NWIGNORECOMpressbit---+-----+-------------------------------><
'-Yes-'
Parameters
Examples
Use the NWPWFILE option to encrypt the user ID and password for a NetWare server and to save them in a file in the installation directory.
If you set NWPWFILE to Yes, the first time you issue a command for a remote NetWare server, ADSM encrypts the user ID and password you provide and stores that information in a file with an extension of .pwd in your installation directory. When you issue subsequent commands for that server, ADSM obtains the password information from that file instead of issuing a prompt.
If you set NWPWFILE to No, ADSM prompts you for the user IDs and passwords for remote NetWare servers each time you issue a command to back up or archive files stored on those servers.
Supported Clients
Clients that can use this option: Novell only.
Syntax
.-Yes-.
>>-NWPWFile---+-----+------------------------------------------><
'-No--'
Parameters
This is the default.
Examples
Use the NWUSER option to specify a user ID and password to connect to a remote and local NetWare server. The user must have NetWare supervisor equivalence. You can use this option as many times as necessary in your client options file to provide password information for each remote NetWare server.
If you do not use this option in your client options file, ADSM prompts you for a user ID and password when you initiate a backup or archive operation.
Supported Clients
Clients that can use this option: Novell only.
Syntax
.-----------------------------------. V | >>----NWUSer servername\user:password--+-----------------------><
Parameters
Examples
Use the NWWAITONERROR option to control what happens if ADSM encounters an error while exiting. You can direct ADSM to do one of the following:
Supported Clients
Clients that can use this option: Novell only.
Syntax
.-Yes-.
>>-NWWaitonerror---+-----+-------------------------------------><
'-No--'
Parameters
This is the default.
Examples
Use the OPTFILE option to specify the options file you want ADSM to use when you start an ADSM session. You can use this option only when you start the clients, (dsm and dsmc). 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. For UNIX, ADSM uses the default options file specified in the DSM_CONFIG environment variable.
Supported Clients
Clients that can use this option: OS/2, UNIX, Windows 95, Windows NT, Novell.
Syntax
>>-OPTFILE file_name-------------------------------------------><
Parameters
Examples
For this option, the entry shown as a command line example is specified in the command box of the icon properties.
Use the OPTIONFORMAT option to specify the format users must use when issuing ADSM HSM client commands.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file and is used only when the ADSM HSM client is installed on your workstation.
Syntax
>>-OPTIONFormat-+- STandard--+---------------------------------><
'- SHort-----'
Parameters
dsmmigrate -Recursive -Detail /home/user1/file1 dsmmigrate -r -d /home/user1/file1
This is the default.
dsmmigrate -Rv /home/user1/file1 dsmmigrate -v -R /home/user1/file1
Refer to Using the UNIX HSM Clients for details regarding these two command formats.
Examples
Use the PARTNERLUNAME option to specify a logical unit name used by the transaction program 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 either SNA LU6.2 communications.
If you use this option, you must also define the CPICMODENAME and TPNAME options.
Supported Clients
Clients that can use this option: All except Macintosh.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-PARtnerluname- logical_unit_name----------------------------><
Parameters
There is no default.
Examples
Use the PASSWORD option to specify an ADSM password.
If your administrator has set authentication to On and passwordaccess is set to prompt, and you do not enter a password with this option when you start an ADSM session, ADSM prompts you for a password.
Be careful when using this option. If ADSM prompts you for a password, ADSM ensures the password is not displayed as you type it in. However, the password cannot be hidden when you enter it with the PASSWORD option.
Supported Clients
Clients that can use this option: All.
Syntax
>>-PASsword password-------------------------------------------><
Parameters
A password is not case sensitive.
Examples
Use the PASSWORDACCESS option to specify how you want to handle the ADSM password for your client node if one is required.
An ADSM password is required for your client node only when your ADSM administrator enables the authentication feature. Check with your administrator to verify whether you need a password.
If a password is required, you can choose to:
On a UNIX workstation, each user must know the ADSM password for your client node. Any user who knows the ADSM password for your client node can gain access to all backups and archives that originate from your client node.
On a UNIX workstation, users do not need to know the ADSM password for your client node. Any user who does not know the ADSM password for your client node can access only the backups and archives the user owns and those to which the user has been granted access by other users.
| Note: | If you have the ADSM HSM client installed on your workstation, the PASSWORDACCESS option must be set to GENERATE. This is required because the HSM client provides several automatic services such as threshold and demand migration, transparent recall, and reconciliation. |
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
.-Prompt---.
>>-PASSWORDAccess-+----------+---------------------------------><
'-Generate-'
Parameters
This is the default.
Attention: If you set PASSWORDACCESS to PROMPT, be aware of the following:
For example, if the user enters the node name and password for your client node from a different client node, the user becomes a virtual root user.
Or, if you change the name of your client node (using the NODENAME option in the dsm.sys file), and the same node name is specified in the dsm.opt file, a user who enters the correct password becomes a virtual root user. The same is true if a user specifies the same node name by using the NODENAME option with a command and enters the correct password.
For API applications, ADSM does not prompt for a password directly. If PASSWORDACCESS is set to PROMPT, the password must be supplied when a session is initiated. The application is responsible for obtaining the ADSM password.
ADSM does not prompt you for a password when you request services. However, you are prompted for a password if:
On Windows 95 and Windows NT, the generated password is stored in the registry.
On a UNIX workstation, when you set the PASSWORDACCESS option to GENERATE, you can use the MAILPROG option to specify a program and user ID to which you want ADSM to send the new password each time the old one expires.
On an OS/2 workstation, you can set the PASSWORDDIR option to specify the directory in which you want ADSM to store the file that contains your password. The name of the file is based on the server name and ends with .PWD. If you do not specify a directory with the PASSWORDDIR option, ADSM stores the password file in the directory specified with the DSM_DIR variable. If a directory is not specified with the DSM_DIR variable, ADSM stores the password file in the C:\ directory.
Attention: On a UNIX workstation, when PASSWORDACCESS is set to GENERATE, be aware of the following:
If you want users to be able to access only the backups and archives they own and those to which they have been granted access by other users, set PASSWORDACCESS to GENERATE and do not give the ADSM password for your client node to users.
Examples
Use the PASSWORDDIR option to specify the directory in which you want ADSM to store a file that contains your encrypted password. Use this option only when you specify Generate for the PASSWORDACCESS option.
When you specify Generate for the PASSWORDACCESS option, ADSM automatically generates a new password for your client node each time the password expires. It stores the password in an encrypted format in a file, and stores the file in a directory based on the following order of precedence:
The name of the password file is based on the server name and ends with .PWD.
Supported Clients
Clients that can use this option: All
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-PASSWORDDIR- directory_path---------------------------------><
Parameters
The default is the directory specified with the DSM_DIR environment variable, or if no directory is specified with that variable, the C:\ directory.
For UNIX, if root, the default directory is /etc/security/adsm for AIX and /etc/adsm for other UNIX platforms. If non-root, the default directory is the contents of environment variable DSM_DIR, if not blank, or the directory from which the executable was loaded.
Examples
Use the POSTSCHEDULECMD option to specify a command that ADSM should process after running a schedule.
For Macintosh, UNIX, Windows 95, and Windows NT, if you want ADSM to wait for the command to complete before continuing with other processing, specify POSTschedulecmd. If you don't want it to wait, specify POSTNschedulecmd.
For OS/2, ADSM waits for the command to complete before continuing with other processing.
For Novell, ADSM does not wait for the command to complete before continuing with other processing.
Supported Clients
Clients that can use this option:Macintosh, Novell, OS/2, UNIX, Windows NT, and Windows 95.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-+-POSTSchedulecmd--+-- "cmdstring"-------------------------->< '-POSTNschedulecmd-'
Parameters
You can use only one POSTSCHEDULECMD option. You can also issue a command before a schedule using the PRESCHEDULECMD 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 a null string for either option, it prevents the administrator from using a command on both options.
However, if your administrator uses a blank or a null string for the POSTSCHEDULECMD option, that prevents you from running a post-schedule command.
If the command string contains blanks, you must enclose it in double quotes. If you have double quotes within the command string, use single quotes to enclose them.
For Macintosh, cmdstring should specify an AppleScript to launch. If cmdstring is only a file name, such as "Database Script", ADSM looks for that file in the Scripts folder inside the ADSM folder. Otherwise, cmdstring should contain the full path of the file, such as "La Pomme:Scripting:Database Script".
Examples
where the command string is a valid command for restarting your database.
Use the PRESCHEDULECMD option to specify a command that ADSM should process before running a schedule.
For Macintosh and UNIX, if you want ADSM to wait for the command to complete before continuing with other processing, specify PREschedulecmd. If you don't want it to wait, specify PRENschedulecmd.
For OS/2, ADSM waits for the command to complete before continuing with other processing.
For Novell, ADSM does not wait for the command to complete before continuing with other processing.
Supported Clients
Clients that can use this option: Macintosh, Novell, OS/2, UNIX, Windows NT, and Windows 95.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-+-PRESchedulecmd--+-- "cmdstring"--------------------------->< '-PRENschedulecmd-'
Parameters
You can use only one PRESCHEDULECMD option. You can also issue a command after a schedule using the POSTSCHEDULECMD 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 for either option, it prevents the administrator from using a command on both options.
However, if your administrator uses a blank or a null string for the PRESCHEDULECMD option, that prevents you from running a pre-schedule command.
If the command string contains blanks, you must enclose it in double quotes. If you have double quotes within the command string, use single quotes to enclose them.
For Macintosh, cmdstring should specify an AppleScript to launch. If cmdstring is only a file name, such as "Database Script", ADSM looks for that file in the Scripts folder inside the ADSM folder. Otherwise, cmdstring should contain the full path of the file, such as "La Pomme:Scripting:Database Script".
Examples
where the command string is a valid command for quiescing your database.
Use the PROCESSORUTILIZATION option to control the percentage of CPU time allotted to ADSM.
Because this option can affect other applications running on your client node, use it only when speed is of the utmost importance.
Supported Clients
Clients that can use this option: Novell only.
Syntax
>>-PROCESSORutilization- number--------------------------------><
Parameters
The minimum value is 0. There is no maximum value.
The default is 1.
Examples
Use the QUERYSCHEDPERIOD option to specify 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 the SCHEDMODE option is set 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 what you specify in the client options file after your client node successfully contacts the ADSM server.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-QUERYSCHedperiod- hours-------------------------------------><
Parameters
The range of values is 1 to 9999.
The default is 12.
Examples
Use the QUIET option to keep messages from being displayed on your screen during ADSM processing.
For example, when you run the INCREMENTAL or SELECTIVE command, ADSM displays information about each file it backs up. You can use the QUIET option if you do not wish to view that information.
When you use the QUIET option, certain error information still appears on your screen, and messages are written to log files.
If you do not specify QUIET, ADSM uses the VERBOSE option by default.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
>>-QUIET-------------------------------------------------------><
Examples
Use the RECONCILEINTERVAL option to specify how often ADSM reconciles your file systems. ADSM reconciles each file system for which space management is active.
The reconciliation process synchronizes the client and server and builds a new migration candidates list for each file system.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file and is used only when the ADSM HSM client is installed on your workstation. It must be placed at the beginning of the client system options file before any server stanzas.
Syntax
>>-RECOncileinterval interval----------------------------------><
Parameters
If you specify a value of 0, ADSM does not automatically reconcile your file systems.
The range of values is 0 to 9999.
The default is 24.
Examples
Use the REPLACE option to specify what you want ADSM to do when restoring files that already exist on your workstation. This applies only to the RESTORE and RETRIEVE commands.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
.-Prompt-.
>>-REPlace-+--------+------------------------------------------><
+-All----+
+-Yes----+
'-No-----'
Parameters
When prompted, you can choose to overwrite the existing unprotected file, or choose to overwrite all existing files, including read-only files.
Examples
Use the RESTOREMIGSTATE option to specify whether you want ADSM to restore stub files for migrated and premigrated files (placing them in a migrated state) or restore backup versions of migrated and premigrated files (placing them in a resident state) during a restore operation.
ADSM can restore a stub file for a migrated or premigrated file only when:
When a stub file for a migrated file or the original copy of a premigrated file is erased from a local file system, ADSM marks the migrated file for expiration the next time reconciliation is run. When the number of days specified with the MIGFILEEXPIRATION option elapse, ADSM removes the migrated file from ADSM storage.
If you set RESTOREMIGSTATE to Yes (the default), and if the migrated or premigrated file has not expired, ADSM restores the file to a stub file, regardless of whether it has been marked for expiration.
| Attention |
|---|
|
The RESTOREMIGSTATE option does not support hardlinked files. If you attempt to restore a stub file for a hardlinked file, a stub file is not restored unless all of the files that are hardlinked together have been deleted from the local file system. When one file in a set of hardlinked files is migrated, all of the hardlinked files in the set become stub files. When you issue the RESTORE command with the RESTOREMIGSTATE option, and ADSM restores a stub file for a hardlinked file, the stub file has the same name as the file that was originally migrated. Stub files are not restored for any other files that were previously in the hardlinked set of files. |
Supported Clients
Clients that can use this option: AIX only.
Options File for UNIX Platforms
For AIX clients, this option goes in the client user options file and is used only when the ADSM HSM client is installed on your workstation.
Syntax
.-Yes-.
>>-RESToremigstate---+-----+-----------------------------------><
'-No--'
Parameters
This is the default.
| Note: | A stub file created during a restore operation contains the information necessary to recall the migrated file from ADSM storage. It does not contain any leading bytes of data from the file. In addition, any recall mode previously set for the migrated file (for example, migrate-on-close or read-without-recall) is not stored in the stub file. The recall mode is set to normal for all files restored to stub files. |
Examples
Use the RETRYPERIOD option to specify 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 what you specify in the client options file after your client node successfully contacts the ADSM server.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-RETRYPeriod- minutes----------------------------------------><
Parameters
The range of values is 1 to 9999.
The default is 20.
Examples
Use the SCHEDCOMPLETEACTION to specify an action to take after a schedule has been completed.
ADSM uses this option only when the scheduler is running.
Supported Clients
Client that can use this option: Macintosh
Syntax
>>-SCHEDCOMPLETEaction-+- Quit------+--------------------------><
'- SHUTdown--'
Parameters
Examples
Use the SCHEDLOGNAME option to specify the name and location of a file where you want ADSM to store the schedule log.
When you run the SCHEDULE command, output from scheduled commands appears on your screen. It is also directed to the file you specify with this option.
ADSM uses this option only when the SCHEDULE command is running.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-SCHEDLOGName- filespec--------------------------------------><
Parameters
The default is the current directory with a file name of dsmsched.log.
Examples
Use the SCHEDLOGRETENTION option to specify:
ADSM prunes the log after every schedule is run.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
.-N----. .-D-.
>>-SCHEDLOGRetention---+------+--+---+-------------------------><
'-days-' '-S-'
Parameters
This is the default.
The range of values is 0 to 9999.
If you specify anything but D or S, ADSM uses the default D. You must use a space or comma to separate this parameter from the previous one.
This is the default.
Examples
This option applies only if you are using the TCP/IP communication method, and the SCHEDULE command is running.
Use the SCHEDMODE option to specify 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 except TCP/IP only use POLLING.
Your ADSM administrator can specify that either mode is supported by the ADSM server, or only one mode is supported. If your ADSM administrator specifies either, you can choose the schedule mode. If your ADSM administrator specifies only one mode, you must specify that same mode in your client options file. Otherwise, scheduled work is not processed.
If the scheduling mode is PROMPTED, you can supply values for the TCPCLIENTADDRESS and TCPCLIENTPORT with the SCHEDULE command. This allows you to be contacted at an address or port other than the one that made initial contact with the server.
Supported Clients
Clients that can use this option: Novell, OS/2, UNIX, Windows NT, and Windows 95.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
.-POlling--.
>>-SCHEDMODe--+----------+-------------------------------------><
'-PRompted-'
Parameters
This is the default.
Examples
Use the SCROLLLINES option to specify the number of lines you want to appear at one time when ADSM displays lists of information on your screen.
ADSM uses this option only when you set the SCROLLPROMPT option to Yes, and you are using ADSM commands.
Supported Clients
Clients that can use this option: Novell, OS/2, UNIX, Windows NT, and Windows 95.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
>>-SCROLLLines- number-----------------------------------------><
Parameters
The range of values is 1 to 80.
The default is 20.
Examples
Use the SCROLLPROMPT option to specify whether you want ADSM to stop and wait after displaying the number of lines you specify with the SCROLLLINES option, or scroll through all lines and stop at the end of the list.
Supported Clients
Clients that can use this option: Novell, OS/2, UNIX, Windows NT, and Windows 95.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
.-No--.
>>-SCROLLPrompt-+-----+----------------------------------------><
'-Yes-'
Parameters
This is the default.
Press 'Q' to quit, 'C' to continuous scroll, or 'Enter' to continue.
Examples
Use the SERVERNAME option in your client system options file to specify the name you want to use to identify an ADSM server and to begin a stanza containing options for that server. You can name and specify options for more than one server.
The following is an example of specifying options for two different servers:
SErvername server_a COMMmethod TCPip TCPPort 1500 TCPServeraddress almvmd.almaden.ibm.com Passwordaccess prompt Groups adsm Users sullivan mushock tallan Inclexcl /adm/adsm/backup.excl SErvername server_b COMMmethod SNAlu6.2 PARtnerluname raptor TPname appcdel CPICMOdename appc Passwordaccess generate Mailprog /usr/bin/xsend root Groups system adsm Inclexcl /adm/adsm/archive.excl
If you specify multiple servers, users can choose the server to contact for backup-archive services by using the SERVERNAME option when starting ADSM. For example:
dsm -servername=server_b dsmc incremental /u -servername=server_b
You can also specify which server to contact for backup-archive services by placing the SERVERNAME option in the client user options file.
For backup-archive services, the order of precedence for which server to contact is:
For HSM services, the order of precedence for which server to contact is:
Users cannot override the migrate server specified in the client system options file.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in both the client system options file and the client user options file.
Syntax
>>-SErvername servername---------------------------------------><
Parameters
A server name can be as many as 64 characters long and is not case sensitive.
Examples
Use the SHMPORT option to specify the TCP/IP port address that the server is listening on to establish a shared memory connection. Shared memory communication is supported between OS/2, AIX, HP-UX, and Solaris clients and servers on the same workstation. To use shared memory, TCP/IP must be installed on the workstation.
| Note: | The value specified for this option in the client system options file (dsm.sys) must match the value specified for the SHMPORT option in the dsmserv.opt file for the server. |
Supported Clients
Clients that can use this option: OS/2, AIX, HP-UX, and Solaris only.
Options File for UNIX Platforms
For AIX, HP-UX, and Solaris clients, this option goes in the client system options file.
Syntax
>>-SHMPort port_address----------------------------------------><
Parameters
The range of values is 1000 to 32767.
The default is 1510.
Examples
Use the SKIPNTPERMISSIONS option to specify whether ADSM should back up Windows NT security information during backups.
Supported Clients
Clients that can use this option: Windows NT.
Syntax
.-No--.
>>-SKIPNTPermissions-+-----+-----------------------------------><
'-Yes-'
Parameters
This is the default.
| Note: | When skipntpermissions is set to Yes, then skipntsecuritycrc is not applicable. |
Examples
Use the SKIPNTSECURITYCRC option to specify whether ADSM should compute the security CRC for permission comparison during subsequent backups.
| Note: | This option is applicable only when skipntpermissions is set to No. |
Supported Clients
Clients that can use this option: Windows NT.
Syntax
.-No--.
>>-SKIPNTSecuritycrc-+-----+-----------------------------------><
'-Yes-'
Parameters
This is the default.
Examples
Use the SUBDIR option to specify whether you want ADSM to include subdirectories of specified directories on the following commands:
Supported Clients
Clients that can use this option: All except Macintosh.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
.-No--.
>>-SUbdir-+-----+----------------------------------------------><
'-Yes-'
Parameters
This is the default.
For UNIX systems, if a subdirectory is a file system in itself, it is not processed even if SUBDIR is Yes.
Because ADSM searches all the subdirectories of a directory being processed, it can take longer for ADSM to complete the requested task than if SUBDIR were No. Therefore, we recommend you use Yes only when necessary.
Examples
Use the SYMBOLICDESTINATION option to specify a symbolic ADSM server name. Contact your ADSM administrator to get 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 have 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.
Supported Clients
Clients that can use this option: All except Macintosh.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-SYMbolicdestination sym_dest_name---------------------------><
Parameters
There is no default.
Examples
Use the TAPEPROMPT option to specify whether you want ADSM to wait for a tape to be mounted if required for a backup, archive, restore, or retrieve process, or prompt you for your choice. If you have the HSM client installed on your workstation, the TAPEPROMPT option also specifies whether you want ADSM to wait for a tape to be mounted if required for selective migration.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
.-No--.
>>-TAPEPrompt-+-----+------------------------------------------><
'-Yes-'
Parameters
| Note: | For API applications, this is recommended to allow backup directly to tape. |
This is the default.
Examples
Use the TCPBUFFSIZE option to specify the size you want to use for the ADSM internal TCP/IP communication buffer.
A larger buffer can improve communication performance, but uses more memory.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-TCPBuffsize size--------------------------------------------><
Parameters
The range of values is 1 to 32.
The default for UNIX, OS/2, NetWare, Windows NT, and Windows 95 is 31.
The default for Macintosh is 16.
For UNIX users: As a result of the operating system communication settings, your system may not accept all values in the range of 1 to 32.
Examples
Use the TCPCLIENTADDRESS option to specify a TCP/IP address if your client node has more than one address, and you want the server to contact a different address than the one used to make initial contact with the server.
You can use this option only if you are using PROMPTED for SCHEDMODE.
ADSM uses this option only when the SCHEDULE command is running.
Supported Clients
Clients that can use this option: Novell, OS/2, UNIX, Windows NT, and Windows 95.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-TCPCLIENTAddress client_address-----------------------------><
Parameters
The value you specify for this parameter can be a TCP/IP Internet domain name or a dot address.
Examples
Use the TCPCLIENTPORT option to specify a TCP/IP port number if you want the ADSM server to contact a different port than the one used to make initial contact with the server.
You can use this option only if you are using PROMPTED for SCHEDMODE.
ADSM uses this option only when the SCHEDULE command is running.
If the default or specified port is busy, ADSM attempts to use any other available port.
Supported Clients
Clients that can use this option: Novell, OS/2, UNIX, Windows NT, and Windows 95.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-TCPCLIENTPort client_port_address---------------------------><
Parameters
The range of values is 1000 to 32767.
The default is 1501.
Examples
Use the TCPNODELAY option to have an ADSM transaction sent immediately to the server, rather than having small transactions buffered before sending. A small transaction is one that is smaller than the byte limit set with the TXNBYTELIMIT option. TCPNODELAY might improve performance in higher-speed networks, especially within an IBM SP2 computer.
You can use this option with an AIX, Windows NT, or Windows 95 client only. All other clients buffer small transactions before sending them to the server.
Supported Clients
Clients that can use this option: AIX, Windows NT, and Windows 95.
Options File for UNIX Platforms
For AIX clients, this option goes in the client system options file.
Syntax
.-No--.
>>-TCPNodelay-+-----+------------------------------------------><
'-Yes-'
Parameters
This is the default.
Examples
Use the TCPPORT option to specify a server's TCP/IP port address.
Obtain this port address from your ADSM administrator.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-TCPPort port_address----------------------------------------><
Parameters
The range of values is 1000 to 32767.
The default is 1500.
Examples
Use the TCPSERVERADDRESS option to specify the TCP/IP address for an ADSM server.
Obtain this server address from your ADSM administrator.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-TCPServeraddress server_address-----------------------------><
Parameters
The value you specify for this parameter can be a TCP/IP Internet domain name or a dot address.
Examples
Use the TCPWINDOWSIZE option to specify the size of the TCP/IP sliding window you want to use for your client node. This is the size of the buffer used when sending or receiving data.
A larger size can improve communication performance, but uses more memory.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-TCPWindowsize window_size-----------------------------------><
Parameters
For UNIX users: As a result of the operating system communication settings, your system may not accept all values in the range of 1 to 2048.
Examples
Use the TIMEFORMAT option to select the format you want ADSM to use for displaying the system time.
| For AIX and Solaris Users Only: | AIX and Solaris support a locale describing every user interface that varies with location or language. The default directories for system-supplied locales are /usr/lib/nls/loc in AIX, and /usr/lib/localedef/src in Solaris. The ADSM backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. If the locale-specified format consists of digits, separators, and if applicable the AM/PM string, then the default timeformat 0 is used, otherwise the default is timeformat 1. Consult the documentation on your local system for details on setting up your locale definition. |
Supported Clients
Clients that can use this option: All
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
>>-TIMEformat format_number------------------------------------><
Parameters
This is the default.
| For AIX and Solaris Users Only: | To set a particular time format, edit the source file for your locale and
modify the t_fmt line to support your needs. Whatever time format
you select applies both to output and to input.
|
Examples
Use the TPNAME option to specify a symbolic name for the transaction program name. The transaction program name is required if the symbolic destination name is not provided for either SNA LU6.2 communication.
If you use this option, you must also define the CPICMODENAME and PARTNERLUNAME options.
Supported Clients
Clients that can use this option: All except Macintosh.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-TPname symbolic_name----------------------------------------><
Parameters
Contact your ADSM administrator for this name.
There is no default.
| Note: | To communicate with an AIX ADSM server, the symbolic_name must be dsmserv in all lower-case letters. |
Examples
Use the TXNBYTELIMIT option to select the number of kilobytes ADSM should buffer before sending a transaction to the server. This limit applies when files are batched together during backup. It is also used when receiving files from the server during restore.
A transaction for ADSM can have two meanings:
The transaction processing option relates to the second meaning of transaction. To alter the speed with which your client performs work, you can use the TXNBYTELIMIT option to specify the amount of data that can be sent between the client and server before the server commits the data and changes the server database.
The server can limit the number of files or directories contained within a group transaction, however, so the actual size of a transaction can be less than your limit.
The number of kilobytes buffered is limited by the TXNGROUPMAX option set on the ADSM server. TXNGROUPMAX determines the number of files or directories that can be sent in a single transaction. Once this number is reached, the client sends the files to the server even if the transaction byte limit is not reached.
Supported Clients
Clients that can use this option: All except Macintosh.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
>>-TXNBytelimit number-----------------------------------------><
Parameters
Examples
Use the USERS option to authorize specific users on your workstation to request services from an ADSM server.
You can use this option more than once to specify a large number of user IDs.
If you do not specify group names with the GROUPS option or user IDs with the USERS option, all users can request ADSM services. If you use the GROUPS option, the USERS option, or both, only users included in one of the specified groups or included in the list of users can request ADSM services.
You can use the USERS option to exclude all other users from accessing the server by defining only your root user name.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
.-------------------------. | .-------------. | V V | | >>----USERs---- username--+--+---------------------------------><
Parameters
Examples
users carol larry davecd kathyba michelle users amyb msmith kbsmith kjones srjames users davidp mtallan marylbt johnrd armand
Use the VERBOSE option to specify that you want processing information to appear on your screen.
For example, when you run the INCREMENTAL command, ADSM generates information about each file it backs up. You can use the VERBOSE option if you want ADSM to display that information on your screen.
The alternative is the QUIET option. If you do not specify either option, VERBOSE is the default.
Supported Clients
Clients that can use this option: All.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
>>-VErbose-----------------------------------------------------><
Examples
Use the VIRTUALMOUNTPOINT option to define a virtual mount point for a file system if you want ADSM to consider files for backup beginning with a specific directory within that file system.
Using the VIRTUALMOUNTPOINT option to identify a directory within a file system provides a direct path to the files you want to back up, thus saving processing time. It is more efficient to define a virtual mount point within a file system than to define the file system with the DOMAIN option, and then use the EXCLUDE option in your include-exclude options file to exclude the files you do not want ADSM to consider for backup.
You can use the VIRTUALMOUNTPOINT option to define virtual mount points for multiple file systems, and you can define more than one virtual mount point within the same file system. You can use the VIRTUALMOUNTPOINT option to define virtual mount points for both local and remote file systems.
| Note: | If the directory you want to specify as a virtual mount point is a symbolic link, be sure to set the FOLLOWSYMBOLIC option to Yes. If that option is set to No, which is the default, ADSM does not allow a symbolic link to be used as a virtual mount point. |
After you define a virtual mount point, you can include it for incremental backup services by specifying the path and directory name in the DOMAIN option in either the default client user options file or in the INCREMENTAL command. Users can also specify the path and directory name of the virtual mount point with the DOMAIN option in their own client user options files and with the INCREMENTAL command.
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client system options file.
Syntax
.-------------------------------. V | >>----VIRTUALMountpoint directory--+---------------------------><
Parameters
You cannot use wildcard characters in the path or directory names.
Define only one virtual mount point with each VIRTUALMOUNTPOINT option you include in your client system options file. Use the VIRTUALMOUNTPOINT option as many times as necessary to define all of the virtual mount points you want to use.
Examples
virtualmountpoint /afs/xyzcorp.com/u/bob virtualmountpoint /afs/xyzcorp.com/u/bob/test/data
The virtualnodename option identifies your workstation to the server. You can use different node names to identify multiple systems on your workstation.
You can also use the virtualnodename option if you want to restore or retrieve files from the server while you are working from a different workstation. When you use the virtualnodename option, ADSM prompts you for the ADSM password assigned to the node you specify, if a password is required.
In your client user options file (dsm.opt) or in a command, use the virtualnodename option only when you want to request services for a different client node than the one on which you are working (the one specified in your client system options file). When you use the virtualnodename option in your client user options file or with a command:
Supported Clients
Clients that can use this option: UNIX only.
Options File for UNIX Platforms
For UNIX clients, this option goes in the client user options file.
Syntax
>>-VIRTUALNodename- nodename-----------------------------------><
Parameters
| Note: | If the node name you specify in your client user options file or on the command line is different than the name returned by the hostname command on your workstation, ADSM assumes you are specifying a different client node, even if the node name you specify is the same as the node name specified in your client system options file. Do not specify the virtualnodename option in your client user options file or with a command unless you want to request services for a client node other than the one on which you are currently working. |
Examples