The following section contains detailed information about each of the ADSM common options. These options are arranged in alphabetical order. Information for each option includes:
For information about syntax, see "Reading Syntax Diagrams".
| 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. |
ADSM AUTHORIZED USER
The automount option specifies a symbolic link to an NFS mount point monitored by the Solaris automounter. The automount filespace specified in this option is considered a valid domain for ADSM incremental backup.
This option is required if you want to add the mount point to File Systems for Backup/Archive on the File System Information window in the ADSM GUI. It is also required if you want to include the mount point in an incremental backup using the command-line client or the client scheduler if the symbolic link points to a mount point monitored by automounter using indirect map.
Options File
This option is placed in the client system options file and it is valid for a Solaris workstation only.
Syntax
>>-AUTOMount- filespace----------------------------------------><
Parameters
Examples
where /home/user1/ -> /tmp_mnt/home/user1/
The books option makes the ADSM online publications available through the ADSM graphical user interface (GUI) if you are using one of these workstations: AIX, HP-UX, or IRIX. If you set this option in your options file, you can click on View Books on the Help menu to read the online publications. If you do not set this option, start the online book reader outside of ADSM to read the online books.
| Attention: | When users select View Books from the Help menu, ADSM starts the
online book reader as a separate program. Online book readers can use a
large amount of system resources because they display graphics and process
large files. You might require more resources than is available on your
machine; if you run it at the same time as ADSM (or any other program), the
workstation might lock. If this happens, do not use View
Books. Stop ADSM and any other programs that use large amounts of
system resources, and start the program again.
You do not need to use the books option to use the ADSM online library. ADSM does not stop the reader program when you stop ADSM. |
Options File
This option is placed in the client user options file.
Syntax
>>-BOOKS- command----------------------------------------------><
Parameters
The ADSM Online Product Library contains the online books and readers for the supported platforms. You or your administrator must install the books and readers separately from the product. See the information booklet included with the CD-ROM for details.
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
ADSM AUTHORIZED USER
The changingretries option specifies how many additional times you want ADSM to attempt to back up or archive a file that is in use during the first attempt.
This option relates to serialization, an attribute in a management class copy group. ADSM uses this option only when serialization is shared static or shared dynamic.
With shared static serialization, if a file is in use during the first backup or archive attempt, ADSM retries the operation the number of times you specified. If the file is in use during each attempt, the operation does not complete.
With a shared dynamic serialization, if a file is in use during the first backup or archive attempt, ADSM retries the operation the number of times you specified. The backup or archive operation occurs during the last attempt regardless of whether the file is currently in use.
Options File
This option is placed in the client system options file.
Syntax
>>-CHAngingretries- numberretries------------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The checkthresholds option specifies 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.
Options File
This option is placed at the beginning of the client system options file before any server stanzas. You must have the ADSM HSM client installed on your workstation.
Syntax
>>-CHEckthresholds- interval-----------------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The commmethod option specifies the communication method you are using to provide connectivity for client-server communication.
Options File
This option is placed in the client system options file.
Syntax
>>-COMMMethod-+- TCPip-----+-----------------------------------><
+- SNAlu6.2--+
'- SHAREmem--'
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 start-up window for the schedule ends. |
Options File
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
This option is placed in the client system options file.
Syntax
>>-COMMRESTARTInterval- seconds--------------------------------><
Parameters
Examples
The compressalways option controls what ADSM does when a file grows during compression. You can specify to continue compressing, or to send the object again if it grows during compression.
Options File
This option is placed in the client user options file.
Syntax
.-Yes-.
>>-COMPRESSAlways-+-----+--------------------------------------><
'-No--'
Parameters
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
ADSM AUTHORIZED USER
The compression option specifies whether ADSM should compress files before sending them to the ADSM server. Compressing your files decreases the amount of data storage required to store backup versions, archive copies of your files, and migrated files, if you have the ADSM HSM client installed. It can, however, affect ADSM throughput. Typically, a fast processor on a slow line benefits from compression, but a slow processor on a fast line does not.
This option controls compression only if your ADSM administrator specifies that your client node determines the choice.
Options File
This option is placed in the client system options file.
Syntax
.-No--.
>>-COMPRESSIon-+-----+-----------------------------------------><
'-Yes-'
Parameters
Examples
ADSM AUTHORIZED USER
The cpicbuffersize option specifies the size of the CPIC buffer for SNA LU6.2 communication. A larger buffer can improve communication performance, but uses more memory.
Options File
This option is placed in the client system options file.
Syntax
>>-CPICBuffersize- size----------------------------------------><
Parameters
The range of values is 1 through 31; the default is 31.
Examples
ADSM AUTHORIZED USER
The cpicmodename option defines the mode name for the SNA LU6.2 communication method. For CPIC, this option identifies the SNA connection to the gateway and target logical unit. The CPIC mode name is used if the symbolic destination is not provided, and the partner LU is located on another system. The mode name must be known on both the local and remote systems.
If you use this option, you must also use the tpname and the partnerluname options.
Options File
This option is placed in the client system options file.
Syntax
>>-CPICModename- name------------------------------------------><
Parameters
There is no default.
Examples
The dateformat option selects the format you want 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.
Options File
This option is placed 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
ADSM AUTHORIZED USER
The defaultserver option specifies the server to which ADSM backs up and archives files by default from your local systems.
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 will also specify the ADSM server to which ADSM migrates files from your local file systems.
Options File
This option is placed at the beginning of the client system options file before any server stanzas.
Syntax
>>-DEFAULTServer- servername-----------------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The dirmc option specifies the management class you want ADSM to use for backed up directories. If you do not specify this option to associate a management class with backed up directories, ADSM uses the management class with the longest retention period located in the active policy set of your policy domain.
Select a management class for backed up directories that allows ADSM to retain directories at least as long as it retains the files associated with them.
Options File
This option is placed in the client system options file.
Syntax
>>-DIRMc- mgmtclassname----------------------------------------><
Parameters
Examples
The domain option specifies the file systems you want to include for incremental backup in your client domain. When you use this option in your client user options file, it defines your default client domain. ADSM uses your default client domain in these situations to determine which file systems to process during an incremental backup:
If you do not use the domain option to specify file systems in your client user options file, the default is all locally mounted file systems except /tmp.
| Note: | You can include a virtual mount point in your client domain. For information about defining a virtual mount point, see Virtualmountpoint. |
When you use this option with the incremental command, it adds the file systems you specify to that which is defined in your client user options file. For example, if you enter:
DOMAIN /home/ /usr/ /datasave/
in your client user options file and
dsmc incremental -domain="/fs1 /fs2"
on the command line, ADSM performs an incremental backup for your /home, /usr, /datasave, /fs1, and /fs2 file systems.
If you use both the filesystem parameter and the domain option on the incremental command, ADSM ignores the domain option and processes only those file systems in the filesystem parameter. For example, if you enter:
dsmc incremental /usr /data -domain="/fs1 /fs2"
ADSM performs an incremental backup only for the /usr and /data file systems.
Options File
This option is placed in the client user options file.
Syntax
.-all-local-.
>>-DOMain-+-----------+----------------------------------------><
'-domain----'
Parameters
Examples
The dotdircheck option specifies 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.
Options File
This option is placed in the client user options file.
Syntax
.-Yes-.
>>-DOTDIRcheck-+-----+-----------------------------------------><
'-No--'
Parameters
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 function.
Options File
This option is placed in the system and client options file.
Syntax
.-ON--.
>>-EDITOR-+-----+----------------------------------------------><
'-OFf-'
Parameters
Examples
The errorlogname option specifies the fully qualified path and file name of the file where you want ADSM to store information about errors that occur during processing.
Syntax
>>-ERRORLOGname- filespec--------------------------------------><
Parameters
The default is the path in the DSM_LOG environment variable plus the file name dsmerror.log.
Examples
The errorlogretention option specifies the number of days to keep entries in the error log, and whether to save the pruned entries.
The error log is pruned when the first error is written to the log after an ADSM session is started. If the only ADSM session you run is the client scheduler, and you run it 24 hours a day, the error log might not be pruned according to your expectations. Stop the session and restart it to permit ADSM to prune the error log when the next error is written.
Options File
This option is placed in the client system options file.
Syntax
.-N----. .-D-.
>>-ERRORLOGRetention---+------+--+---+-------------------------><
'-days-' '-S-'
Parameters
Examples
ADSM AUTHORIZED USER
The errorprog option specifies a program to which you want ADSM to send a message if a severe error occurs during space management processing.
Options File
This option is placed in the client system options file and is used only when the ADSM HSM client is installed on your workstation. It must be included in a server stanza.
Syntax
>>-ERRORProg- program-name-------------------------------------><
Parameters
Examples
The exclude option excludes a file or group of files from ADSM backup services. When you back up files, any files you exclude with this option are not considered for backup. For example, you might want to exclude all temporary files, any local caches of network files, all files that contain compiled object code that you can easily reproduce using other methods, or your operating system files.
If you 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.
Use wildcard characters to exclude a broad range of files. See "Include and Exclude Groups of Files" for a list of characters that you can use. Then, if necessary, use the include option to make exceptions. You cannot, however, specify wildcard characters on the directory name when you want to exclude a single directory. For example,
exclude.dir /home/xx/test*
excludes the directories /home/xx/testold, /home/xx/testnew, and /home/xx/test.
See "Creating an Include-Exclude Options File" for more information. See also the list of files that should always be excluded in "Exclude System Files".
Options File
This option is placed 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 /unix/ exclude /.../core exclude /home/jones/proj1/* include /home/jones/proj1/devplan/ exclude.backup /home/jones/proj1/devplan/ include /home/jones/proj1/status/ exclude.spacemgmt /home/jones/proj1/status/ exclude.backup /users/home1/file1 exclude.spacemgmt /users/home1/file1
The followsymbolic option specifies whether you want ADSM to:
Options File
This option is placed in the client user options file.
Syntax
.-No--.
>>-FOLlowsymbolic-+-----+--------------------------------------><
'-Yes-'
Parameters
Examples
ADSM AUTHORIZED USER
The groups option lists groups on your workstation that you want to authorize to request services from the ADSM server. You can use the groups option more than once to specify a large number of group names.
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.
Options File
This option is placed 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
ADSM AUTHORIZED USER
The inclexcl option specifies the path and file name of your include-exclude options file if you use one. Use an include-exclude options file to exclude files from backup and to assign different management classes to specific files or groups of files.
If you have the ADSM HSM client installed on your workstation, you can use an include-exclude options file to exclude files from both backup and space management, exclude files from backup only, exclude files from space management only, and assign different management classes to specific files or groups of files.
For information about creating an include-exclude options file, see "Creating an Include-Exclude Options File".
In other UNIX environments, your include-exclude options file must be in a directory, such as /etc, to which all users have read access.
Options File
This option is placed in the client system options file.
Syntax
>>-INCLExcl- filespec------------------------------------------><
Parameters
Examples
inclexcl /usr/dsm/backup.excl inclexcl /etc/inclexcl.def
ADSM AUTHORIZED USER
The include option specifies 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 Options File" for more information.
Options File
This option is placed in the include-exclude options file, the client system options file, or the client user options file.
Syntax
.---------------------------------------------------.
V |
>>----INCLUDE-+--------+- pattern-+-----------------+--+-------><
'-.File--' '- mgmtclassname--'
Parameters
Examples
Figure 25. Options File Examples
| Task | Example |
|---|---|
| Include a subset of files that were excluded. |
exclude /home/proj/text/* include /home/proj/text/devel.* |
| Assign a management class to a group of files. |
include /home/proj/text/* textfiles |
| Specify a management class to assign to all files to which you have not
assigned a management class. This must be the first
statement in your include-exclude list.
Use this method to assign a management class to all files to which you have not already assigned a specific management class and for which you do not want ADSM to use the default management class. |
include * managall |
ADSM AUTHORIZED USER
The kernelmessages option specifies whether you want ADSM to display HSM-related messages during processing.
| Note: | For transparent recall, if more than one process accesses the same migrated file at one time, the kernel displays a message for the first process only that accesses the file. |
Options File
This option is placed in the client system options file, and it is used only when the ADSM HSM client is installed on your workstation. Place it at the beginning of the client system options file before any server stanzas.
Syntax
.-Yes-.
>>-KERNelmessages-+-----+--------------------------------------><
'-No--'
Parameters
Examples
The language option specifies the national language for presenting client messages.
Options File
This option is placed in the client user options file and is valid for all UNIX clients except AIX, DEC, HP-UX, SGI, and Solaris. For AIX, DEC, HP-UX, SGI, and Solaris clients the language setting is derived from the LANG environment variable.
Syntax
>>-LANGuage- language------------------------------------------><
Parameters
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
ADSM AUTHORIZED USER
The mailprog option specifies 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 with the passwordaccess option.
Options File
This option is placed in the client system options file.
Syntax
>>-MAILprog filespec userid------------------------------------><
Parameters
Examples
mailprog /usr/bin/xsend root (for AIX)
| Note: | Run the enroll command before ADSM can use xsend. |
ADSM AUTHORIZED USER
The maxcmdretries option specifies the maximum number of times the client scheduler (on your workstation) will attempt to process a failed, scheduled command. It starts only if the client scheduler has not yet backed up a file, never connected to the server, or failed before backing up a file. ADSM uses this option only when the schedule command is running.
Your ADSM administrator can also set this option. If your ADSM administrator specifies a value for this option, that value overrides what you specify in the client options file after your client node successfully contacts the ADSM server.
Options File
This option is placed in the client system options file.
Syntax
>>-MAXCMDRetries- maxcmdretries--------------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The maxrecalldaemons option specifies the maximum number of ADSM recall 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.
Options File
This option is placed in the client system options file, and it is used only when the ADSM HSM client is installed on your workstation. Place at the beginning of the client system options file before any server stanzas.
Syntax
>>-MAXRECAlldaemons number-------------------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The maxreconcileproc option specifies the maximum number of reconciliation processes that HSM can start at one time.
Options File
This option goes
is placed in the client system options file, and it is used only when the ADSM HSM client is installed on your workstation. Place it at the beginning of the client system options file before any server stanzas.
Syntax
>>-MAXRECOncileproc maxreconcileproc---------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The maxthresholdproc option specifies the maximum number of threshold migration processes that HSM can start at one time.
| Note: | When a file system runs out of space, HSM does not verify that 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 now in progress. |
Options File
This option is placed in the client system options file, and it is used only when the ADSM HSM client is installed on your workstation. Place it at the beginning of the client system options file before any server stanzas.
Syntax
>>-MAXThresholdproc maxthresholdproc---------------------------><
Parameters
Examples
The memoryefficientbackup option specifies a more memory-efficient algorithm for processing incremental backups, backing up one directory at a time, and using less memory. Use this option when your machine is running low on memory.
Syntax
.-No--.
>>-MEMORYEFficientbackup-+-----+-------------------------------><
'-Yes-'
Parameters
Examples
ADSM AUTHORIZED USER
The migfileexpiration option specifies 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.
Options File
This option is placed in the client system options file, and it is used only when the ADSM HSM client is installed on your workstation. Place at the beginning of the client system options file before any server stanzas.
Syntax
>>-MIGFileexpiration days--------------------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The migrateserver option specifies the name of the server to which you want ADSM to migrate files from your client node. You can specify one migration server only for each client node; users cannot override the server you specify for migration in a client user options file or when entering a command.
If you do not specify a server with the migrateserver option, ADSM migrates your files to the server specified with the defaultserver option. If you do not specify a server with either of these options, by default, ADSM migrates your files to the server that was identified in the first stanza of your client system options file.
After ADSM begins migrating files to the server you specified, do not make any changes to your client system options file that might cause ADSM to contact a different server for migration, unless your ADSM administrator exports your migrated files from the specified server and imports them to another. Otherwise, ADSM will be unable to locate your migrated files until you modify options to specify the server to which your files were originally migrated.
Options File
This option is placed in the client system options file, and it is used only when the ADSM HSM client is installed on your workstation. Place it at the beginning of the client system options file before any server stanzas.
Syntax
>>-MIGRateserver servername------------------------------------><
Parameters
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 Passwordaccess generate Inclexcl /adm/adsm/migexl.list
ADSM AUTHORIZED USER
The minrecalldaemons option specifies the minimum number of ADSM recall daemons you want to run at one time to perform recalls for your client node.
Options File
This option is placed in the client system options file, and it is used only when the ADSM HSM client is installed on your workstation. Place it at the beginning of the client system options file before any server stanzas.
Syntax
>>-MINRecalldaemons number-------------------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
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 time-out option you can simply erase the dsmstat executable in the ADSM program directory.
Options File
This option is placed in the client system options file.
Syntax
>>-NFSTIMEout number-------------------------------------------><
Parameters
Examples
In your client system options file (dsm.sys) use the nodename option to assign a new name to your client node if you do not want to use the default. The default is the name returned by the hostname command.
When connecting to a server, the ADSM client must identity itself to the server. This login identification is determined as follows:
Syntax
>>-NODename- nodename------------------------------------------><
Parameters
Examples
The numberformat option specifies 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. |
Options File
This option is placed in the client user options file and is valid for all UNIX clients.
Syntax
>>-NUMberformat- number----------------------------------------><
Parameters
| 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 optfile option specifies 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 specified in the DSM_CONFIG environment variable.
Syntax
>>-OPTFILE- file_name------------------------------------------><
Parameters
Examples
The optionformat option specifies the format you must use when sending ADSM HSM client commands.
Options File
This option is placed in the client user options file, and it 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
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
ADSM AUTHORIZED USER
The partnerluname option specifies a logical unit name that the transaction program uses to identify the ADSM server in the SNA network. The partner logical unit name is used if the symbolic destination name is not provided for SNA LU6.2 communications.
If you use this option, define the cpicmodename and tpname options.
Options File
This option is placed in the client system options file.
Syntax
>>-PARtnerluname- logical_unit_name----------------------------><
Parameters
Examples
The password option specifies an ADSM password. If this option is not used and your administrator has set authentication on and passwordaccess is set to prompt, you are prompted for a password when you start an ADSM session.
| Note: | If you are prompted for a password, it is not displayed as you enter it. However, if you use the password option, your password is displayed when you enter it. |
Syntax
>>-PASsword- password------------------------------------------><
Parameters
Valid characters include:
Examples
ADSM AUTHORIZED USER
The passwordaccess option specifies whether you want your ADSM password stored and read from a file or you want the user prompted for the password.
If the ADSM HSM client is installed, set the passwordaccess option to generate. Use the passworddir option in your client system options file to determine the directory location in which to store the encrypted password file. The default directory location depends on how the client was installed.
Options File
This option is placed in the client system options file.
Syntax
.-Prompt---.
>>-PASSWORDAccess---+----------+-------------------------------><
'-Generate-'
Parameters
To keep your client node password secure, enter ADSM commands without the password, and wait for ADSM to prompt you for the password.
An ADSM-authorized user is prompted for a password when registering a workstation with an ADSM server, or if the password was changed by an ADSM administrator using the update noded command.
Examples
ADSM AUTHORIZED USER
The passworddir option forces the directory location in which to store an encrypted password file. The default directory location depends on how the client was installed.
Options File
This option is placed in the client system options file.
Syntax
>>-PASSWORDDIR- directoryname----------------------------------><
Parameters
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
ADSM AUTHORIZED USER
The postschedulecmd option specifies a command that ADSM should process after running a schedule.
If you want ADSM to wait for the command to complete before continuing with other processing, specify POSTschedulecmd. If you do not want it to wait, specify POSTNschedulecmd.
Options File
This option is placed in the client system options file.
Syntax
>>-+-POSTSchedulecmd--+-- "cmdstring"-------------------------->< '-POSTNschedulecmd-'
Parameters
Use a blank, or null, string for cmdstring if you want to prevent any scheduled commands from running that the ADSM administrator uses for postschedulecmd and preschedulecmd. If you specify a blank, or null, string on either option, it prevents the administrator from using a scheduled command on both options. However, if your administrator uses a blank, or null, string on the postschedulecmd option, that prevents you from running a post-schedule command.
If the command string contains blanks, enclose it in double quotes. If you have double quotes within the command string, use single quotes to enclose them.
Examples
The command string is a valid command for restarting your database.
ADSM AUTHORIZED USER
The preschedulecmd option specifies a command that ADSM should process before it runs a schedule. If you want ADSM to wait for the command to complete before continuing with other processing, specify PREschedulecmd. If you do not want it to wait, specify PRENschedulecmd.
Options File
This option is placed in the client system options file.
Syntax
>>-+-PRESchedulecmd--+-- "cmdstring"--------------------------->< '-PRENschedulecmd-'
Parameters
Use a blank, or null, string for cmdstring if you want to prevent any scheduled commands from running that the ADSM administrator uses for postschedulecmd and preschedulecmd. If you specify a blank, or null, string on either option, it prevents the administrator from using a scheduled command on both options.
However, if your administrator uses a blank, or null, string on the preschedulecmd option, that prevents you from running a pre-schedule command.
If the command string contains blanks, enclose it in double quotes. If you have double quotes within the command string, use single quotes to enclose them.
Examples
The command string is a valid command for quiescing your database.
ADSM AUTHORIZED USER
The queryschedperiod option specifies the number of hours you want the client scheduler to wait between attempts to contact the ADSM server for scheduled work. This option applies only when you set the schedmode option to polling. ADSM uses this option only when the schedule command is running.
Your ADSM administrator can also set this option. If your ADSM administrator specifies a value for this option, that value overrides the value set in your client system options file after your client node successfully contacts the ADSM server.
Options File
This option is placed in the client system options file.
Syntax
>>-QUERYSCHedperiod- hours-------------------------------------><
Parameters
Examples
The quiet option prevents messages from displaying on your screen during ADSM processing. For example, when you run either the incremental or selective command, ADSM displays information about each file it backs up. Use the quiet option if you do not want to view that information.
When you use the quiet option, certain error information still displays on your screen, and messages are written to log files. If you do not specify quiet, ADSM uses the default option, verbose.
| Note: | If the quiet or verbose option is specified in the server client option set, then the server setting overrides the quiet or verbose option specified on the client, even if FORCE is set to NO on the server. |
Options File
This option is placed in the client user options file.
Syntax
>>-QUIET-------------------------------------------------------><
Examples
ADSM AUTHORIZED USER
The reconcileinterval option specifies how often ADSM reconciles your file systems. ADSM reconciles each file system for which space management is active and builds a new Migration Candidates list.
Options File
This option is placed in the client system options file, and it is used only when the ADSM HSM client is installed on your workstation. Place it at the beginning of the client system options file before any server stanzas.
Syntax
>>-RECOncileinterval interval----------------------------------><
Parameters
Examples
The replace option specifies what you want ADSM to do when it restores or retrieves files that already exist on your workstation.
Options File
This option is placed 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
The restoremigstate option specifies whether you want ADSM to restore/retrieve stub files for migrated and premigrated files (placing them in a migrated condition), or restore/retrieve backup/archive versions of migrated and premigrated files (placing them in a resident condition) during a restore/retrieve operation.
ADSM can restore/retrieve 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, the migrated file is removed from ADSM storage.
If you set restoremigstate to Yes (the default), and if the migrated or premigrated file has not expired, ADSM restores/retrieves 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/retrieve a stub file for a hardlinked file, the stub file is not restored/retrieved 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 enter 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. |
Options File
This option is placed in the client user options file, and it is used only when the ADSM HSM client is installed on your workstation.
Syntax
.-Yes-.
>>-RESToremigstate---+-----+-----------------------------------><
'-No--'
Parameters
| Note: | A stub file created during a restore/retrieve 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. 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/retrieved to stub files. |
Examples
ADSM AUTHORIZED USER
The retryperiod option specifies the number of minutes you want the client scheduler to wait between attempts to process a scheduled command that fails, or between unsuccessful attempts to report results to the server. ADSM uses this option only when the schedule command is running.
Your ADSM administrator can also set this option. If your ADSM administrator specifies a value for this option, that value overrides the value specified in your client system options file after your client node successfully contacts the ADSM server.
Options File
This option is placed in the client system options file.
Syntax
>>-RETRYPeriod- minutes----------------------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The schedlogname option specifies the name and location of a file where you want schedule log information stored. When you run the schedule command, output from scheduled commands displays on your screen while it is also sent to the file you specified with this option.
Use this option only when you run the schedule command.
Options File
This option is placed in the client system options file.
Syntax
>>-SCHEDLOGName- filespec--------------------------------------><
Parameters
The default is the current directory with a file name of dsmsched.log.
Examples
ADSM AUTHORIZED USER
The schedlogretention option specifies the number of days to keep entries in the schedule log, and whether to save the pruned entries. The schedule log is pruned after a scheduled event completes.
Options File
This option is placed in the client system options file.
Syntax
.-N----. .-D-.
>>-SCHEDLOGRetention---+------+--+---+-------------------------><
'-days-' '-S-'
Parameters
Examples
ADSM AUTHORIZED USER
| Note: | This option applies only if you are using the TCP/IP communication method and the schedule command is running. |
The schedmode option specifies which ADSM schedule mode to use. The schedule mode determines whether your client node periodically asks the ADSM server for scheduled work (polling), or whether the ADSM server contacts your client node when it is time to start a scheduled operation (prompted). All communication methods can use polling, but only TCP/IP can use prompted.
Your ADSM administrator can specify that the ADSM server support either mode or one mode. If your ADSM administrator specifies either mode, you can select the schedule mode. If your ADSM administrator specifies only one mode, specify that same mode in your client options file or scheduled work will not be processed.
If the schedule mode is prompted, supply values for the tcpclientaddress and tcpclientport options on the schedule command. You can then be contacted at an address or port other than the one that made first contact with the server.
Options File
This option is placed in the client system options file.
Syntax
.-POlling--.
>>-SCHEDMODe--+----------+-------------------------------------><
'-PRompted-'
Parameters
Examples
The scrolllines option specifies the number of lines you want to appear at one time when ADSM displays lists of information on your screen. Use this option when you set the scrollprompt option to Yes, and you use ADSM commands.
Options File
This option is placed in the client user options file.
Syntax
>>-SCROLLLines- number-----------------------------------------><
Parameters
Examples
The scrollprompt option specifies whether you want ADSM to stop and wait after displaying the number of lines you indicated with the scrolllines option, or you want ADSM to scroll through all lines and stop at the end of the list.
Options File
This option is placed in the client user options file.
Syntax
.-No--.
>>-SCROLLPrompt-+-----+----------------------------------------><
'-Yes-'
Parameters
Press 'Q' to quit, 'C' to continuous scroll, or 'Enter' to continue.
Examples
In your client system options file, the servername option specifies 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 example demonstrates how to specify 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
In your client user options file or on the command line, use the servername option to specify which server to contact for backup-archive services. When specified in a client user options file or on the command line, the servername option overrides the default server specified in your client system options file.
| Note: | You cannot use the servername option to override the server specified for migration in your client system options file. |
Options File
This option is placed in both the client system options file and the client user options file.
Syntax
>>-SErvername servername---------------------------------------><
Parameters
Examples
The shmport option specifies the TCP/IP port address that the server is listening on to establish a shared memory connection. Shared memory communication is supported between AIX, HP-UX, and Solaris clients and servers on the same workstation. To use shared memory, TCP/IP must be installed on your workstation.
| Note: | The value specified for shmport in the client system options file must match the value specified for shmport in the server options file. |
Options File
This option is placed in the client system options file, and it is valid for AIX, HP-UX, and Solaris only.
Syntax
>>-SHMPort port_address----------------------------------------><
Parameters
Examples
The subdir option specifies whether you want ADSM to include subdirectories of named directories on the following commands:
Options File
This option is placed in the client user options file.
Syntax
.-No--.
>>-SUbdir-+-----+----------------------------------------------><
'-Yes-'
Parameters
If a subdirectory is a mounted file system, it is not necessary even if subdir is Yes.
Examples
ADSM AUTHORIZED USER
The symbolicdestination option specifies a symbolic ADSM server name. Contact your ADSM administrator for the correct name. The symbolic destination name indexes SNA routing and security parameters that are stored in communication directory files.
When a symbolic destination is used with the commmethod option for SNA LU6.2 communication, you do not need to specify the tpname, partnerluname, or cpicmodename options.
This option is required if your communication protocol is SNA LU6.2 and a transaction program name or partner logical unit name is not provided.
Options File
This option is placed in the client system options file.
Syntax
>>-SYMbolicdestination- Sym_dest_name--------------------------><
Parameters
Examples
The tapeprompt option specifies whether to wait for a tape to mount if it is required for a backup, archive, restore, or retrieve process, or to prompt you for a choice.
| Note: | Tape prompting does not occur during a scheduled operation regardless of the setting for the tapeprompt option. |
Options File
This option is placed in the client user options file.
Syntax
.-No--.
>>-TAPEPrompt-+-----+------------------------------------------><
'-Yes-'
Parameters
Examples
ADSM AUTHORIZED USER
The tcpbuffsize option specifies the size to use for the ADSM internal TCP/IP communication buffer. Although it uses more memory, a larger buffer can improve communication performance.
Options File
This option is placed in the client system options file.
Syntax
>>-TCPBuffsize- size-------------------------------------------><
Parameters
As a result of the operating system communication settings, your system may not accept all values in the range of 1 to 32.
| For AIX users only: | When specifying commmethod CLIO, the maximum size is 512. CLIO/S performance improves with a larger tcpbuffsize. |
Examples
ADSM AUTHORIZED USER
The tcpclientaddress option specifies a TCP/IP address if your client node has more than one address, and you want the server to contact an address other than the one that was used to make the first server contact.
Use this option only if you are using prompted for schedmode. This option is used only when the schedule command is running.
Options File
This option is placed in the client system options file.
Syntax
>>-TCPCLIENTAddress- client_address----------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The tcpclientport option specifies a different TCP/IP port number for the ADSM server to contact other than the one that was used to make the first server contact. If the default or specified port is busy, ADSM attempts to use any other available port. Use this option only if you specify prompted for schedmode.
This option is used only when the schedule command is running.
Options File
This option is placed in the client system options file.
Syntax
>>-TCPCLIENTPort- client_port_address--------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
| Note: | This option is for an AIX client only. All other clients buffer small transactions before sending them to the server. |
The tcpnodelay option has 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. The tcpnodelay option might improve performance in higher-speed networks.
Options File
This option is placed in the client system options file.
Syntax
.-No--.
>>-TCPNodelay-+-----+------------------------------------------><
'-Yes-'
Parameters
Examples
ADSM AUTHORIZED USER
The tcpport option specifies a TCP/IP port address for an ADSM server. Obtain this address from your ADSM administrator.
Options File
This option is placed in the client system options file.
Syntax
>>-TCPPort- port_address---------------------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The tcpserveraddress option specifies the TCP/IP address for an ADSM server. Obtain this server address from your ADSM administrator.
Options File
This option is placed in the client system options file.
Syntax
>>-TCPServeraddress- server_address----------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The tcpwindowsize option specifies the buffer size of the TCP/IP sliding window that you want to use for your client node. This buffer size is used when you send or receive data. Although it uses more memory, a larger buffer size can improve communication performance.
Options File
This option is placed in the client system options file.
Syntax
>>-TCPWindowsize- window_size----------------------------------><
Parameters
As a result of the operating system communication settings, your system may not accept all values in the range of 1 to 2048.
Examples
The timeformat option selects 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. |
Options File
This option is placed in the client user options file and is valid for all UNIX clients.
Syntax
>>-TIMEformat- format_number-----------------------------------><
Parameters
| 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
ADSM AUTHORIZED USER
The tpname option specifies a symbolic name for the transaction program name. The transaction program name is required if the symbolic destination name is not provided for SNA LU6.2 communication.
If you use this option, you must also define the cpicmodename and partnerluname options.
Options File
This option is placed in the client system options file.
Syntax
>>-TPname- symbolic_name---------------------------------------><
Parameters
| Note: | To communicate with an AIX ADSM server, enter dsmserv as the symbolic name. |
Examples
ADSM AUTHORIZED USER
The txnbytelimit option specifies the number of kilobytes ADSM should buffer before it sends a transaction to the server. A transaction is the unit of work exchanged between the client and server. Because ADSM can transfer more than one file or directory between the client and server before it commits the data to server storage, a transaction can contain more than one file or directory. This is sometimes referred to as a transaction group.
This option allows you to control the amount of data sent between the client and server before the server commits the data and changes to the server database, thus changing the speed with which the client performs work. This limit applies when files are batched together during backup. It is also used when receiving files from the server during a restore procedure.
The server administrator can limit the number of files or directories contained within a group transaction using the txngroupmax option; the actual size of a transaction can be less than your limit. Once this number is reached, the client sends the files to the server even if the transaction byte limit is not reached.
Options File
This option is placed in the client system options file.
Syntax
>>-TXNBytelimit- number----------------------------------------><
Parameters
Examples
ADSM AUTHORIZED USER
The users option authorizes 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.
Define your root user name only with the users option to exclude all other users from accessing the server.
Options File
This option is placed in the client system options file.
Syntax
.-------------------------. | .-------------. | V V | | >>----USERs---- username--+--+---------------------------------><
Parameters
Examples
users carol larry davecd kathyba michelle users amyb tkaspar kbsmith egray srjames users davidp monnett athompson johnrd armand
The verbose option specifies that you want processing information to display on your screen. This is the default. Specify the quiet option if you do not want processing information to display on your screen.
| Note: | If the quiet or verbose option is specified in the server client option set, then the server setting overrides the quiet or verbose option specified on the client, even if FORCE is set to NO on the server. |
Options File
This option is placed in the client user options file.
Syntax
>>-VErbose-----------------------------------------------------><
Examples
ADSM AUTHORIZED USER
The virtualmountpoint option defines a virtual mount point for a file system if you want ADSM to consider files that begin with a specific directory within that file system for backup. Using the virtualmountpoint option to identify a directory within a file system provides a direct path to the files you want to back up, saving processing time. It is more efficient to define a virtual mount point within a file system than it is to define the file system using the domain option, and then to use the exclude option in your include-exclude options file to exclude the files that 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 for local and remote file systems, and you can define more than one virtual mount point within the same file system.
| Note: | If the directory you want to specify as a virtual mount point is a symbolic link, set the followsymbolic option to Yes. If that option is set to No (the default), you are not allowed to use a symbolic link as a virtual mount point. |
After you define a virtual mount point, you can specify the path and directory name with the domain option in either the default client user options file or on the incremental command to include it for incremental backup services. 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 on the incremental command.
Options File
This option is placed in the client system options file.
Syntax
.-------------------------------. V | >>----VIRTUALMountpoint directory--+---------------------------><
Parameters
Define only one virtual mount point with each virtualmountpoint option that 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 that you want to use.
Examples
virtualmountpoint /afs/xyzcorp.com/home/ellen/ virtualmountpoint /afs/xyzcorp.com/home/ellen/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:
When connecting to a server, the ADSM client must identity itself to the server. This login identification is determined as follows:
Syntax
>>-VIRTUALNodename- nodename-----------------------------------><
Parameters
Examples