NSR_CLIENT(5) Legato NetWorker 4.0 NSR_CLIENT(5)
NAME
NSR client - NetWorker resource type ``NSR client''
SYNOPSIS
type: NSR client
DESCRIPTION
Each NSR client is described by a single resource of type NSR client
(see nsrresource(5)). To edit the NSR client resources for a Net
Worker server type:
nsradmin -c "type:NSR client"
See the nsradmin(8) manual page for more information on using the
NetWorker administration program.
For each NetWorker client, this resource describes which files should
be saved, the schedule used to save these files, which directive
should be used to omit files from the save, how long the files' index
entries should be kept in the on-line file index and the media index,
and which other machines can recover these files. A client may have
more than one resource describing it.
ATTRIBUTES
The following attributes are defined for resource type NSR client.
The information in parentheses describes how the attribute values are
accessed. Read-only indicates that the value cannot be changed by an
administrator. Read/write means the value can be set as well as
read. Hidden means it is an attribute of interest only to programs
or experts, and these attributes can only be seen when the hidden
option is turned on in nsradmin(8) or expert mode (-x) in net
worker(8). Dynamic attributes have values which change rapidly.
Several additional attributes (e.g. administrator) are common to all
resources, and are described in nsrresource(5).
name (read/write)
This attribute specifies the hostname of this NetWorker
client.
Example: name: venus;
server (read-only)
This attribute specifies the hostname of this client`s Net
Worker server. The client`s hostname will be used as the
default value.
Example: server: jupiter;
schedule (read/write)
This attribute specifies the name of the schedule controlling
the backup levels for the save sets listed in the `save set'
attribute. The default value is `Default'. Any currently
defined schedule names may be used, see nsrschedule(5).
Example: schedule: Default;
browse policy (read/write)
This attribute specifies the name of the policy controlling
how long entries will remain in this client's on-line file
Licensed material--property of copyright holder(s) 1
NSR_CLIENT(5) Legato NetWorker 4.0 NSR_CLIENT(5)
index. The default value is `Quarter'. Any currently defined
policy name may be used as long as the period defined by the
policy is not longer than the retention policy's period, see
nsrpolicy(5).
Example: browse policy: Quarter;
retention policy (read/write)
This attribute specifies the name of the policy controlling
how long entries will remain in the media index before they
are marked as recyclable. The default value is `Year'. Any
currently defined policy name may be used as long as the
period defined by the policy is not shorter than the browse
policy's period, see nsrpolicy(5).
Example: retention policy: Year;
directive (read/write)
This attribute specifies the directive file to use when back
ing up the client. The default value is `Default'. The valid
choices for the directive resource are names of the currently
defined `NSR directive' resources, see nsrdirective(5).
Example: directive: Default with compression;
group (read/write)
This attribute specifies the group this client is a member of.
The group controls the start time for automatic backups. The
value may be one of currently defined `NSR group' resources,
see nsrgroup(5). The default value is `Default'.
Example: group: Default;
save set (read/write)
The save set attribute lists the path names to be saved for
this client. The names should be separated by comma space (,
). The default value is `All'. On Unix clients, `All' refers
to the mounted file systems. On DOS clients, `All' refers to
file systems that have been specified on the client via the
`Change Automatic Backup' selection of the NetWorker for DOS.
By default, all of a DOS client's hard disks are backed up.
When a client needs to have different file systems saved on
different schedules, a client resource is needed for each
group of file systems on a particular schedule. A given path
name may only appear once. When `All' is used, no other path
names may be used.
Example: save set: /, /usr, /usr/src;
recover access (read/write)
This attribute lists the hostnames and netgroups of machines
that may recover files backed up by this client. Netgroup
names must be preceded by an ampersand ('&'). A plus sign,
``+'' signifies that any client whose root user is trusted by
the server's remote command system is also allowed to recover
the client's files. An empty list signifies that only the
client itself may recover its files. The default list is
empty.
Licensed material--property of copyright holder(s) 2
NSR_CLIENT(5) Legato NetWorker 4.0 NSR_CLIENT(5)
Example: recover access: mars;
statistics (constant, hidden, dynamic)
This attribute contains three values: the size of the client's
on-line file index in kilobytes, the number of kilobytes actu
ally used, and the number of entries in the index.
Example:
statistics: elapsed = 1761860, index size (KB) = 776,
amount used (KB) = 680, entries = 2216;
index save set (update-only, hidden, dynamic)
This attribute specifies the client file index save set to
purge when the index operation is set to purging oldest cycle.
Example: index save set: /;
rcmd user (read/write, hidden)
This attribute specifies the user login name the NetWorker
server will use to run commands on the client. The default
value is NULL, implying that `root' should be used. When
savegroup -p (see savegroup(8)) is run on the NetWorker
server, the server runs commands on the client to determine
which files to save.
Example: rcmd user: operator;
executable path (read/write, hidden)
This attribute specifies the path to use when the NetWorker
server is executing commands on the client. When no path is
specified, the "rcmd user's" $PATH is used.
Example: executable path: /etc/nsr;
server network interface (read/write, hidden, registered)
The name of the network interface on the server to be used for
saves and recovers.
Example: server network interface: mars-2 ;
aliases (read/write, hidden, registered)
This is a list of aliases (nicknames) for the client machine
that queries can match. If this list is empty, match on
client name alone.
Example: aliases: mars;
index operation (update-only, hidden, dynamic)
This attribute contains the current index operation. It is
normally `Idle'.
Example: index operation: Reclaiming space;
owner notification (read/write, hidden, registered)
A notification action to be executed to send the contents of
status messages to the owner/primary user of a machine (e.g.
savegroup completion messages).
Example: owner notification: /usr/ucb/mail -s "mars' owner
notification" carl@mars;
Licensed material--property of copyright holder(s) 3
NSR_CLIENT(5) Legato NetWorker 4.0 NSR_CLIENT(5)
index message (update-only, hidden, dynamic)
This attribute contains the ending status message for the pre
vious index operation. This attribute is typically blank,
indicating that the previous operation completed successfully.
Example: index message: could not index;
index operation start (update-only, hidden, dynamic)
This attribute contains the starting time of the current index
operation. This attribute is a null string ("") when the
operation is `Idle'. The format is weekday followed by hour
and minutes.
Example: index operation start: Wednesday 02:45;
index progress (update-only, hidden, dynamic)
This attribute contains the progress the index has made
towards finishing the current task. This attribute is blank
when the operation is `Idle'. The progress is expressed as a
percentage.
Example: index progress: 45;
EXAMPLES
Note: the hidden options are not shown in these examples.
A resource to define a client, called venus, backing up all of its
files to the NetWorker server mars:
type: NSR client;
name: venus;
server: mars;
schedule: Full Every Friday;
directive: Default with compression;
group: Default;
save set: All;
recover access: +;
rcmd user: ;
executable path: /etc/nsr;
index operation: Idle;
index message: ;
index progress: ;
index operation start: ;
The resources for a client backing up different file systems on dif
ferent schedules:
type: NSR client;
name: saturn;
server: mars;
schedule: Default;
directive: Default;
group: engineering;
save set: /, /usr, /usr/src;
recover access: venus;
rcmd user: operator;
Licensed material--property of copyright holder(s) 4
NSR_CLIENT(5) Legato NetWorker 4.0 NSR_CLIENT(5)
executable path: ;
index operation: Idle;
index message: ;
index progress: ;
index operation start: ;
type: NSR client;
name: saturn;
server: mars;
schedule: Full on 1st Friday of Month;
directive: Default;
group: Default;
save set: /usr/src/archive;
recover access: venus;
rcmd user: operator;
executable path: ;
index operation: Idle;
index message: ;
index progress: ;
index operation start: ;
SEE ALSO
ruserok(3), nsr(5), nsrschedule(5), nsrdirective(5), nsrgroup(5),
nsrpolicy(5), savegroup(8), savefs(8), nsradmin(8).
Licensed material--property of copyright holder(s) 5