Client agent configuration file

The Client Agent configuration file

The Client Agent configuration file, uag.cfg, is located on the remote client workstation in the $UAG_HOME directory. This file (which is scanned for entries whenever a job is submitted to the workstation) can be utilized to run multiple options associated with the Client Agent.

We recommend that you do not change any of the variables within the agent module's configuration file, unless instructed to do so by a member of Computer Associates Technical Support.

	We recommend that you do not change any of the variables within the agent module's configuration file, unless instructed to do so by a member of Computer Associates Technical Support.

Options available via the agent's configuration file

Options are available only when used in conjunction with the agent's configuration file, uag.cfg.

Any options that are set from the front-end through the ARCserveIT Manager, will take precedence over the options set in the configuration file.

	Any options that are set from the front-end through the ARCserveIT Manager, will take precedence over the options set in the configuration file.

Syntax for specifying options

When specifying options within this file, each option should be listed on its own line. An example view of the uag.cfg file is shown below

-s 6553

-b 16384

# `#' denotes a commented line

-c 50

:

-s 6553 -b 16384 # `#' denotes a commented line -c 50

Client Agent options

A complete listing of options available for use when starting the Client Agent is shown in the table below. These options are used to optimize and customize the operation of the Client Agent. They are not required in order for the Client Agent to run and should be used with caution.

Option

Description

-ARCUSER
Sets the ALLOW/DENY list per ARCserveIT username.
Example:
-ARCUSER A:ARCUSER1 N:ARCUSER2
- where A corresponds to -ALLOW and N corresponds to -DENY.
Note: This option is used with single user mode in conjunction with the -S or -NOPASSWORD option.

-ALLOW
Host or Network IP Address Allow list
The ALLOW option defines the IP Addresses that are allowed the access to the agents.
Example:
-ALLOW N:192.35.100.0(255.255.255.0) H:141.1.100.10
- where N denotes a network address. An optional subnet mask can be set.
- where H denotes a host's IP Address
Note: This option is used with single user mode in conjunction with the-S or -NOPASSWORD option.

-b <bufsize>
Disk I/O buffer size in bytes. [16384] (16384 .. 65536)

-c <n>
Sleep "n" miliseconds while waiting (0...1000) [0]

-DENY
Host or Network IP Address Deny list
The DENY option defines the IP Addresses that are not allowed the access to the agents.
Example:
-DENY N:.35.100.0(255.255.255.0) H:141.1.100.10
- where N denotes a network address. An optional subnet mask can be set.
- where H denotes a host's IP Address
Note: This option is used with single user mode in conjunction with the -S or -NOPASSWORD option.

-e
Turns off traversing across file system. [Traverse FS]

-l
Enabling this option will cause the agent to check for advisory locks [mandatory locks only]

-m <maxbuf>
Number of buffers allocated for I/O (2 .. 1024) [128]

-n
Back up NFS mount directories [no NFS directories]

-NOPASSWORD
Enables the -ALLOW, -DENY, and -ARCUSER options to be used. Same as the -S option in that no password is required in Single User Mode.

-P <n>

-Prebackup <filename>
-Postbackup <filename>
-Prerestore <filename>
-Postrestore <filename>

To execute the default pre/post-scripts associated with the type of job being run (backup or restore), while changing the default time-out, option <-P> should be specified followed by a variable number <n>, which is user defined and measured in minutes [5](0..10).
For example: The option -P 10 assigns a wait time period for the pre-script (backup or restore) of 10 minutes.

Important Note: If the -P option is used but <n> is not specified, an error will occur.

The default script associated with each option is listed below:
-Prebackup = uag_pre_backup
-Postbackup = uag_post_backup
-Prerestore = uag_pre_restore
-Postrestore = uag_post_restore
To substitute a specific default pre/post-script with one that is user-defined, you must specify its corresponding option, followed by the new script name:
uagent -Prebackup <AAA> -P <10>
In this example, the user-defined pre-script "AAA" would be substituted for the default backup script with a wait time of 10 minutes.
When creating a user defined pre/post-script, the contents should conform to the Bourne Shell syntax.
If no parent path is specified, all script are relative to $UAG_HOME. Otherwise you are required to list the full path name. All options specified remain in effect until the Client Agent program is stopped and then restarted.

-s <bufsz>
Socket buffer size option. Specifies the size of the socket buffer. (4096..65536) [system dependent]

-S
Single user mode option.

-T tar
-T cpio
Sets agent to use either the tar or cpio native UNIX backup format.

-t
Access time option. When specified, Client Agent will NOT reset the last access time to its original. Use only with Solaris 2.2, otherwise it is not recommended for use. [Reset ACC. time]

-v
Verbose mode. Enables the print out of detailed debugging messages to the console.

Option	Description
-ARCUSER	Sets the ALLOW/DENY list per ARCserveIT username. Example: -ARCUSER A:ARCUSER1 N:ARCUSER2 - where A corresponds to -ALLOW and N corresponds to -DENY. Note: This option is used with single user mode in conjunction with the -S or -NOPASSWORD option.
-ALLOW	Host or Network IP Address Allow list The ALLOW option defines the IP Addresses that are allowed the access to the agents. Example: -ALLOW N:192.35.100.0(255.255.255.0) H:141.1.100.10 - where N denotes a network address. An optional subnet mask can be set. - where H denotes a host's IP Address Note: This option is used with single user mode in conjunction with the-S or -NOPASSWORD option.
-b <bufsize>	Disk I/O buffer size in bytes. [16384] (16384 .. 65536)
-c <n>	Sleep "n" miliseconds while waiting (0...1000) [0]
-DENY	Host or Network IP Address Deny list The DENY option defines the IP Addresses that are not allowed the access to the agents. Example: -DENY N:.35.100.0(255.255.255.0) H:141.1.100.10 - where N denotes a network address. An optional subnet mask can be set. - where H denotes a host's IP Address Note: This option is used with single user mode in conjunction with the -S or -NOPASSWORD option.
-e	Turns off traversing across file system. [Traverse FS]
-l	Enabling this option will cause the agent to check for advisory locks [mandatory locks only]
-m <maxbuf>	Number of buffers allocated for I/O (2 .. 1024) [128]
-n	Back up NFS mount directories [no NFS directories]
-NOPASSWORD	Enables the -ALLOW, -DENY, and -ARCUSER options to be used. Same as the -S option in that no password is required in Single User Mode.
-P <n> -Prebackup <filename> -Postbackup <filename> -Prerestore <filename> -Postrestore <filename>	To execute the default pre/post-scripts associated with the type of job being run (backup or restore), while changing the default time-out, option <-P> should be specified followed by a variable number <n>, which is user defined and measured in minutes [5](0..10). For example: The option -P 10 assigns a wait time period for the pre-script (backup or restore) of 10 minutes. Important Note: If the -P option is used but <n> is not specified, an error will occur. The default script associated with each option is listed below: -Prebackup = uag_pre_backup -Postbackup = uag_post_backup -Prerestore = uag_pre_restore -Postrestore = uag_post_restore To substitute a specific default pre/post-script with one that is user-defined, you must specify its corresponding option, followed by the new script name: uagent -Prebackup <AAA> -P <10> In this example, the user-defined pre-script "AAA" would be substituted for the default backup script with a wait time of 10 minutes. When creating a user defined pre/post-script, the contents should conform to the Bourne Shell syntax. If no parent path is specified, all script are relative to $UAG_HOME. Otherwise you are required to list the full path name. All options specified remain in effect until the Client Agent program is stopped and then restarted.
-s <bufsz>	Socket buffer size option. Specifies the size of the socket buffer. (4096..65536) [system dependent]
-S	Single user mode option.
-T tar -T cpio	Sets agent to use either the tar or cpio native UNIX backup format.
-t	Access time option. When specified, Client Agent will NOT reset the last access time to its original. Use only with Solaris 2.2, otherwise it is not recommended for use. [Reset ACC. time]
-v	Verbose mode. Enables the print out of detailed debugging messages to the console.