Using the Client Agents

Configuring UNIX Client Agents

A complete listing of options available for use when starting the UNIX 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.

NOTE: 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.

option use
-b <bufsize> Disk I/O buffer size in bytes. [16384]
(16384 .. 65536)
-c<n> Sleep "n" miliseconds while waiting
(0... 1000) [0]
-e Turns off traversing across file system [Traverse FS]
-S Singe user mode option
-ARCUSER Sets the ALLOW/DENY list per ARCserveIT username. For 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 The ALLOW option defines the IP Addresses that are allowed the access to the agents. For 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.

-s <bufsiz> Socket buffer size option. Specifies the size of the socket buffer. (4096..65536) [system dependent]
-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.
-T tar / -T cpio Sets agent to use either the tar or cpio native UNIX backup format.
-v Verbose mode. Enables the print out of detailed debugging messages to the console.
-DENY Host or Network IP Address Deny list. The DENY option defines the IP Addresses that are not allowed the access to the agents. For 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) and H denotes a host's IP Address.

NOTE: This option is used with single user mode in conjunction with the -S or -NOPASSWORD option.

-P <n> 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.
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. 

 option             use
 -b        Disk I/O buffer size in bytes.  [16384]
                    (16384 .. 65536)
 -c              Sleep "n" miliseconds while waiting
                    (0...  1000) [0]
 -e                 Turns off traversing across file system
                    [Traverse FS]
 -S                 Singe user mode option
 -ARCUSER           Sets the ALLOW/DENY list per ARCserveIT
                    username. For example:
                    -ARCUSER A:ARCUSER1 N:ARCUSER2 where A
                    corresponds to -ALLOW and N corresponds
                    to -DENY.
                    ________________________________________
                       ¬e;  This option is used with
                       single user mode in conjunction
                       with the -S or -NOPASSWORD option.
                    ________________________________________
 -ALLOW             The ALLOW option defines the IP
                    Addresses that are allowed the access to
                    the agents. For 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
                    ________________________________________
                       ¬e;  This option is used with
                       single user mode in conjunction
                       with the -S or  -NOPASSWORD
                       option.
                    ________________________________________
 -s         Socket buffer size option.  Specifies
                    the size of the socket buffer.
                    (4096..65536) [system dependent]
 -l                 Enabling this option will cause the
                    agent to check for advisory locks
                    [mandatory locks only]
                    Number of buffers allocated for I/O (2
 -mn         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.
 -T tar / -T cpio   Sets agent to use either the tar or cpio
                    native UNIX backup format.
 -v                 Verbose mode.  Enables the print out of
                    detailed debugging messages to the
                    console.
 -DENY              Host or Network IP Address Deny list.
                    The DENY option defines the IP Addresses
                    that are not allowed the access to the
                    agents. For 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) and H denotes a host's IP Address.
                    ________________________________________
                       ¬e;  This option is used with
                       single user mode in conjunction
                       with the -S or -NOPASSWORD option.
                    ________________________________________
 -P              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 , 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.
                    If the -P option is used but  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
                     -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.

UNIX Client Agent control files

The Client Agent control files provide a means for limiting which directories, file systems or file system types will be excluded from backup operations on a particular workstation.

© 1998 The Santa Cruz Operation, Inc. All rights reserved.