nsr_resource(5)
nsr_resource(5)
NAME
nsr_resource - NetWorker resource format
SYNOPSIS
resource ::= attribute list <blank line>
attribute list ::= attribute [ ; attribute ]*
attribute ::= name [ : value [ , value ]* ]
name, value ::= <printable string>
DESCRIPTION
The NetWorker system uses files containing resources to describe itself
and its clients. Each resource represents a component of the NetWorker
system that might need administration. Devices, schedules, and clients
are examples of NetWorker resources. The system administrator manipu-
lates resources to control the NetWorker system. The file and the
resources in them are accessible through NetWorker Management Console
and nsradmin(8) programs. They can also be viewed with a normal text
editor.
The files all share a common format. The same format is used by the
nsradmin(8) program. Each resource is described by a list of
attributes, and ends in a blank line. Each attribute in the attribute
list has a name and an optional list of values. The attribute name is
separated from the attribute values by a colon (:), attribute values
are separated by commas (,), and each attribute ends in a semicolon
(;). A comma, semicolon or back-slash (\) at the end of a line contin-
ues the line. A line beginning with a pound-sign (#) is a comment and
the rest of the line is ignored. The back-slash character can also be
used to escape the special meaning of other characters (comma, semi-
colon, pound-sign, and back-slash).
The attribute name and values can contain any printable character.
Upper and lower case is not distinguished on comparisons, and extra
white space is removed from both ends but not from inside of names and
values. For example,
Name: this is a test;
matches
name : This Is A Test ;
but is different than
Name: this is a test;
EXAMPLES
In the following example resource, there are eight attributes. They
are type, name, server, schedule, directive, group, save set, and
remote access. The remote access attribute has no value.
type: NSR client;
name: venus;
server: earth;
schedule: Default;
directive: Unix standard directives;
group: Default;
save set: All;
remote access: ;
In the following resource, there are six attributes. The administrator
attribute has three values: &engineering, root, and operator. Note
that the three values are separated by commas. The action attribute
has one value: incr incr incr incr incr full incr. Note that this is a
single value - it just happens to have spaces separating its words.
type: NSR schedule;
action: incr incr incr incr incr full incr;
administrator: &engineering, root, operator;
name: engineering servers;
override: ;
period: Week;
SPECIAL ATTRIBUTES
Each NetWorker resource includes seven special attributes: type, name,
administrator, hostname, ONC program number, ONC version number, and
ONC transport. The type and name attributes are normally visible, but
the others attributes are hidden. That an attribute is hidden indi-
cates that it is infrequently used and perhaps esoteric. Hidden
attributes should usually not be changed by the user.
The type attribute defines which other attributes a resource can con-
tain. For example, a resource with type NSR client will always include
the attribute server, while a resource of type NSR schedule does not.
The name attribute is a descriptive name of the object that a resource
represents. In the first example above, the name attribute is the name
of the NetWorker client machine. In the second example, the name
attribute describes a schedule used to back up the the servers in the
engineering department.
The administrator attribute is the list of users that have permission
to modify or delete this resource. This attribute is inherited from
the type: NSR resource when a new resource is created. The administra-
tor of the NSR resource also controls who has permission to create and
delete NetWorker resources.
The hostname attribute specifies the hostname of the machine on which
the service that controls this resource is running. It is used inter-
nally and cannot be changed by the administrator.
The remaining attributes (ONC program number, ONC version number, and
ONC transport) specify the Open Network Computing information for this
service. They should never be changed manually.
In some cases, the resource identifier will be visible. Although it
may look like an attribute, it is an internal value that is set and
used by the NetWorker system to provide unique identification of each
resource. When new resources are created in the edit command of
nsradmin(8), the resource identifier attribute should be left off. This
signals that this is a new resource and a new identifier will be
assigned.
NetWorker resources are implemented by the Legato Resource Administra-
tion Platform, which is described in the resource(5) manual page. This
flexible architecture means that in future releases of NetWorker, more
resource types or attributes may be added, and the administration tools
in this release will automatically be able to use them. To make this
possible, each server provides type descriptors that are used inter-
nally to describe the attributes of each type, between the administra-
tion tools and the services. These type descriptors may cause limita-
tion on the values, such as only allowing a single value, allowing no
value, or only numeric values.
RESOURCE TYPES
This release of NetWorker defines the following types of resources:
NSR This resource describes a NetWorker server. It contains
attributes that control administrator authorization, information
about operations in progress, and statistics and error informa-
tion about past operations. For more information see the
nsr_service(5) manual page.
NSR client
This resource describes a NetWorker client. It includes
attributes that specify the files to save, which schedule to
use, and which group this client belongs to. There may be more
than one client resource for a NetWorker client. This allows a
client to save files on different schedules. For more informa-
tion see the nsr_client(5) manual page.
NSR device
This resource type describes a storage device. It includes
attributes that specify a particular device name (for example,
/dev/nrst1), media type (for example, 8mm), and the name of the
currently mounted volume. It also provides status and statis-
tics on current and past operations. For more information see
the nsr_device(5) manual page.
NSR directive
This resource describes a directive. Directives control how a
client's files are processed as they are being saved. For more
information see the nsr_directive(5), nsr(5) and uasm(1) manual
pages.
NSR group
This resource specifies a logical grouping of NetWorker clients
and a starting time. Each day, at the specified time, all mem-
bers of the group will start their saves. For more information
see the nsr_group(5) manual page.
NSR jukebox
This resource type describes a jukebox. It includes attributes
such as the jukebox model, the first and last slot numbers in
the jukebox, and the names of the devices within the jukebox.
For more information see the nsr_jukebox(5) manual page.
NSR label
This resource type specifies a template describing a sequence of
names to be used when labeling volumes. For more information see
the nsr_label(5) manual page.
NSR license
This resource contains licensing information for each feature
currently enabled in this NetWorker installation. It contains
various enabler and authorization codes that are used by Net-
Worker to validate licensed capabilities. For more information
see the nsr_license(5) and nsrcap(1) manual pages.
NSR notification
A notification specifies an action to be performed when a par-
ticular type of NetWorker event takes place. For more informa-
tion see the nsr_notification(5) manual page.
NSR policy
Policy resources are used as part of the index management pro-
cess in NetWorker. These policies control how long entries
remain in a client's on-line file index and when to mark a save
set as recyclable. For more information see the nsr_policy(5)
manual page.
NSR pool
dates. The level controls the amount of data saved when a
client is backed up. For more information see the
nsr_schedule(5) manual page.
NSR schedule
Schedule resources define a sequence of save levels and an over-
ride list. The override list is made up of pairs of levels and
dates. The level controls the amount of data saved when a
client is backed up. For more information see the nsr_schedule(5)
manual page.
NSR stage
Each stage resource describes a staging policy. The resource
includes attributes that define control parameters for the pol-
icy, and devices managed by the policy. For more information
see the nsr_stage(5) manual page.
FILES
/nsr/res/nsrdb Holds the NetWorker server's resources. Files in
this directory should never be edited directly. Use
nsradmin(8) or NetWorker Management Console instead.
SEE ALSO
resource(5), nsr(5), nsr_client(5), nsr_device(5), nsr_directive(5),
nsr_group(5), nsr_jukebox(5), nsr_label(5), nsr_license(5), nsrcap(8),
nsr_notification(5), nsr_policy(5), nsr_pool(5), nsr_schedule(5),
nsr_service(5), nsr_stage(5), nsr(8), savegroup(8), savefs(8),
nsradmin(8), uasm(8).
NetWorker 7.6.2 Jul 14, 11 nsr_resource(5)