NSR_CLIENT(5) Legato NetWorker 4.1.1 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
NetWorker server type:
nsradmin -c "type:NSR client"
See the nsradmin(8) manual page for more information on using the
NetWorker administration program. The client resource may also be
edited using the command networker(8), or nwadmin(8).
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 who is allowed to back up, browse, and recover this client's
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 by selecting the details Menu
Item in the View Menu for a particular window in networker(8), or
nwadmin(8). Dynamic attributes have values which change rapidly.
Encrypted attributes contain data that is not displayed in its
original form. The assumption is that the data is sensitive in
nature and needs to be protected from accidental disclosure. Several
additional attributes (e.g. administrator) are common to all
resources, and are described in nsrresource(5).
name (read-only, single string)
This attribute specifies the hostname of this NetWorker
client.
Example: name: venus;
server (constant, single string)
This attribute specifies the hostname of this client`s
NetWorker server. The server`s hostname will be used as the
default value.
Example: server: jupiter;
schedule (read/write, choice)
This attribute specifies the name of the schedule controlling
the backup levels for the save sets listed in the `save set'
Licensed material--property of copyright holder(s) 1
NSR_CLIENT(5) Legato NetWorker 4.1.1 NSR_CLIENT(5)
attribute. The default value is `Default'. Any currently
defined schedule names may be used, see nsrschedule(5).
Example: schedule: Default;
browse policy (read/write, choice)
This attribute specifies the name of the policy controlling
how long entries will remain in this client's on-line file
index. The default value is `Month'. 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: Month;
retention policy (read/write, choice)
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, choice)
This attribute specifies the directive to use when backing up
the client. The default value is NULL. The valid choices for
the directive resource are names of the currently defined `NSR
directive' resources, see nsrdirective(5).
Example: directive: Unix with compression directives;
group (read/write, choice list)
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, list)
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 set
of file systems on a particular schedule. For all the client
resources with the same name in a group, a given path name may
only appear once. When a client resource lists the save set
`All', it must be the only client resource with it's name
belonging to it's group.
Example: save set: /, /usr, /usr/src;
Licensed material--property of copyright holder(s) 2
NSR_CLIENT(5) Legato NetWorker 4.1.1 NSR_CLIENT(5)
priority (hidden, read/write, choice)
This attribute controls the backup priority of this client.
Priority 1 is the highest, 1000 is the lowest. Automated
savegroup's will attempt to back up clients with higher
priorities before clients with lower priorities. Note that
this is a hint only. Savegroup has many parameters to
consider, and may choose a lower priority client while trying
to balance the load.
Example: priority: 500;
remote access (read/write, string list)
This attribute controls who may back up, browse, and recover a
client's files. By default this attribute is an empty list,
signifying that only users on the client are allowed to back
up, browse, and recover it's files. Additional users, hosts,
and netgroups may be granted permission to access this
client's files by adding their names to this attribute.
Netgroup names must be preceded by an ampersand ('&'). Input
of the form <user>@<host> or <host>/<user>, grants access to
the client's files to the specified users. The <user> and/or
<host> may be a wild card, "*". If a user name is a wild
card, it means all users at the host are granted access the
the client's data. When a host name is a wild card, that user
on all hosts is granted access to the client's data. All
users on a host may also be granted access to the client's
data by just listing the host's name, i.e. <host> is
equivalent to *@<host> or <host>/*. A plus sign, ``+'',
grants access to the client's files to all users on any host
whose root user is trusted by the server's remote command
system. Note that this attribute does not override file
system permissions, the user still needs the necessary file
system permissions to back up, browse, or recover a file. The
following example grants access to the client's data for all
users that satisfy at least one of the following criteria,
<user name, user's hostname, server's domain> is a member of
the netgroup "netadmins", the user is from the host mars, the
user is from the host jupiter, the user's name is sam from
host pluto, or the user's id is root from any host.
Example: remote access: &netadmins, mars, *@jupiter,
sam@pluto, */root;
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
actually 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: /;
Licensed material--property of copyright holder(s) 3
NSR_CLIENT(5) Legato NetWorker 4.1.1 NSR_CLIENT(5)
remote user (read/write, string)
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: remote user: operator;
password (read/write, encrypted)
The savegroup command uses this attribute when initiating the
commands savefs and save on the client's machine. The
commands save and savefs use the password to gain access to
the files being backed up. If a password is given, then the
"remote user" attribute for the client resource must also be
defined. This attribute does not need to be set for Unix
clients.
executable path (read/write, string, hidden)
This attribute specifies the path to use when the NetWorker
server is executing commands on the client. When no path is
specified, the "remote user's" $PATH is used.
Example: executable path: /etc/nsr;
server network interface (read/write, string, hidden)
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, string list, hidden)
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)
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;
index message (update-only, hidden, dynamic)
This attribute contains the ending status message for the
previous index operation. This attribute is typically blank,
indicating that the previous operation completed successfully.
Example: index message:;
Licensed material--property of copyright holder(s) 4
NSR_CLIENT(5) Legato NetWorker 4.1.1 NSR_CLIENT(5)
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;
parallelism (read/write, hidden)
This attribute specifies the maximum number of saves that
should be run at the same time for the client.
Example: parallelism: 2;
archive services (read/write, choice)
This attribute determines if this system can use archive
services. This attribute can only be set if archive support
has been enabled on the server. The choices are enabled or
disabled. Example: archive services: enabled;
archive users (read/write, string list)
This attribute specifies a list of users that are allowed to
use the archive services on the client. This attribute can
only be set if archive support has been enabled on the server.
If no users are listed, only administrators and the local root
user are allowed to use the archive services on the client. A
value of '*' implies any user is allowed to archive or
retrieve data. The '/' and '@' characters are not allowed as
part of the user name.
Example: archive users: paul;
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: Unix with compression directives;
group: Default;
save set: All;
remote access: +;
remote user: ;
executable path: /etc/nsr;
index operation: Idle;
Licensed material--property of copyright holder(s) 5
NSR_CLIENT(5) Legato NetWorker 4.1.1 NSR_CLIENT(5)
index message: ;
index progress: ;
index operation start: ;
archive services: Disabled;
archive users: ;
The resources for a client backing up different file systems on
different schedules:
type: NSR client;
name: saturn;
server: mars;
schedule: Default;
directive: ;
group: engineering;
save set: /, /usr, /usr/src;
remote access: venus, sam@*, jupiter/john;
remote user: operator;
executable path: ;
index operation: Idle;
index message: ;
index progress: ;
index operation start: ;
archive services: Disabled;
archive users: ;
type: NSR client;
name: saturn;
server: mars;
schedule: Full on 1st Friday of Month;
directive: Unix standard directives;
group: Default;
save set: /usr/src/archive;
remote access: sam@venus, &netadmins, root@*;
remote user: operator;
executable path: ;
index operation: Idle;
index message: ;
index progress: ;
index operation start: ;
archive services: Disabled;
archive users: ;
SEE ALSO
ruserok(3), nsr(5), nsrschedule(5), nsrdirective(5), nsrgroup(5),
nsrpolicy(5), savegroup(8), savefs(8), nsradmin(8), networker(8),
nwadmin(8).
Licensed material--property of copyright holder(s) 6