nsr_group(5)
nsr_group(5)
NAME
nsr_group - NetWorker resource type 'NSR group'
SYNOPSIS
type: NSR group
DESCRIPTION
Each NetWorker group is described by a single resource of type NSR
group (see nsr_resource(5)). To edit the NSR group resources for a
NetWorker server type:
nsradmin -c "type:NSR group"
or use the NetWorker Management Console. See the nsradmin(8) manual page
for more information on using the NetWorker administration program.
These resources control when a group of NetWorker clients begin saving
data and whether backups are started automatically each day. Each NSR
client resource (see nsr_client(5)) lists the groups of which that
client (or save sets for that client) is a member. Groups can only be
deleted if no clients are members of them.
ATTRIBUTES
The following attributes are defined for resource type NSR group. The
information in parentheses describes how the attribute values are
accessed. Create-only indicates that the value cannot be changed by an
administrator once the resource is created. Read/write means the value
can be set as well as read at any time. Choice indicates that the
value can only be selected from a given list. Yes/no means only a yes
or no choice is possible. Static attributes change values rarely, if
ever. Dynamic attributes have values which change rapidly. 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). For example, an attribute marked (create-only, static)
has a value which is set when the attribute is created and never
changes. Several additional attributes (for example, administrator)
are common to all resources, and are described in nsr_resource(5).
name (create-only)
This attribute contains the name of the group defined by this
resource. The name must be unique for this NetWorker server,
but otherwise can be anything that makes sense to the adminis-
trator. This name will appear as a choice attribute of each NSR
client and NSR pool(5) resource. The NSR group resource named
'Default' may be modified, but it may not be removed. The name
can only be specified when the group is created.
Example: name: marketing;
comment (read/write)
This attribute is provided for the administrator to keep any
explanatory remarks or supplementary information about the
group.
snapshot (read/write, yes/no)
This attribute determines whether the group represents snapshot
backups. NOTE: This feature is enabled with Legato PowerSnap
modules only.
autostart (read/write, choice)
This attribute determines if this group will be saved automati-
cally every day. It may be one of three values: Enabled, Dis-
abled or Start now. When the value is Enabled, the members of
this group will start saving data at the time specified in the
start time attribute. When the value is Disabled, the member of
this group will not automatically start saving their data. When
the Start now value is specified, the member clients will start
saving their data immediately. The attribute will then return to
its prior value.
Example: autostart: Enabled;
autorestart (read/write, choice, hidden)
This attribute controls whether this group should be automati-
cally restarted when an incomplete run (due to a power failure
or administrator intervention) is noticed during NetWorker
server startup. Like the autostart attribute, setting this
attribute's value to Restart now causes NetWorker to restart the
group immediately. Enabling autorestart only has an effect if
autostart is also enabled.
stop now (read/write, choice, hidden)
Setting this value to 'True' when this group is running causes
this group to abort all of its saves immediately. Once the
group is stopped, the value is set back to 'False'. These are
the only valid values.
start time (read/write)
This attribute specifies the time of day when this group will
start saving. The NetWorker server's local time is used. The
time is specified as "hours:minutes". Note that the quotes may
be necessary when using character-based administration tools
such as the nsradmin program because of the colon in the value.
The hours may range from 0 to 23 (using a 24 hour clock) and the
minutes range from 0 to 59.
Example: start time: "4:53";
last start (read/write, hidden)
The last time this group was started. If multiple instances
were attempted to run, only one instance will update this
attribute. The "last end" attribute will be cleared when this is
set. This attribute is for informational purposes only, and
changing it has no effect on the system.
last end (read/write, hidden)
The last time this group ended or completed. This attribute is
for informational purposes only, and changing it has no effect
on the system. This attribute gets updated only if last start
attribute is updated. If the savegrp program or the machine
terminates abnormally, the "last end" attribute may not be
updated.
interval (read/write, static, hidden)
This attribute specifies how often this group is to be run auto-
matically by NetWorker. Manually starting a group overrides the
interval. The default value is 24:00, which means run once a
day.
restart window (read/write, static, hidden)
This attribute is used for automatically restarted groups by
NetWorker. This defines the amount of time for which restarts
are valid. If the restart window has elapsed from the previous
start of group, the restart attempt is converted into a fresh
start. Also individual savesets are considered elapsed even if
successfully completed previously but the start time is older
than this window. These savesets are considered eligible for
restart. This attribute helps maintain the start time of all
savesets completed as part of the group fall within this time
window. The restart window attribute has to be less than inter-
val and setting it to half of interval helps avoid overruning
restart attempts beyond the next scheduled start. The default
value is 12:00, which is half of default value of interval
(24:00).
success threshold (read/write, choice)
This attribute helps set the criteria for reporting the success
of all savesets within a group. The default value is Warning
which means if any saveset has warning(s) during backup it will
be reported in the Successful Save Sets section. The client(s)
of these savesets will be reported as successful with warning(s)
in the completion report's header summary. If set to Success ,
any savesets completed with warning(s) will be reported in the
Unsuccesful Savesets section. Please note any failures will
invoke a retry on the saveset if retry count is not 0. The
client will also be reported as failed in the savegroup comple-
tion report's header summary.
snapshot policy (read/write, choice)
Snapshot policy associated with the group, if this group happens
to have snapshot set to Yes. NOTE: this feature is enabled with
PowerSnap modules only.
snapshot pool (read/write, choice)
Pool to which Snapshot meta data needs to be backed up. NOTE:
this feature is enabled with EMC PowerSnap modules only.
force incremental (read/write, static, hidden, choice)
Setting this attribute to `Yes' will force an incremental level
of a savegroup, when the interval attribute is less than 24
hours and the group is started after 12:00am+interval. Please
note that 12:00am is midnight. The default value is `Yes.' A
value of `No' means that all backups are done at pre-determined
level (as specified in the group resource's level attribute).
This attribute applies only to automatically started groups.
The following example shows how to use this attribute in con-
junction with "interval". Assume that a group g1 has to be
backed up every 6 hours and the first backup must be a level
backup. For g1, set the interval to 06:00, set autostart to
"enabled" and set force incremental to 'Yes.' Also set the
level to the desired level. In this case the first scheduled run
of group g1 (before 6:00am) will be run at the level configured.
Subsequent scheduled runs of group g1 on the same day (after
6:00am) will be run at incremental level.
savegrp parallelism (read/write)
If this value is non-zero, then the savegrp program eschews all
other parallelism policies and attempts to keep that number of
saves running.
client retries (read/write)
The number of times failed clients should be retried before
savegrp gives up and declare them failed. Zero means do not
retry. Abandoned saves are not retried, because they may even-
tually complete. A client's save sets are retried by savegrp
whenever it would otherwise not be able to start a new save set.
That is, savegrp prefers to start new save sets first, and only
retries when there is nothing else to do.
Example: client retries: 1;
clones (read/write, static, yes/no, choice)
Setting this value to 'Yes' causes saves of this group to auto-
matically make a clone of every save set backed up. The save
set clones will be sent to the pool named in the clone pool
attribute.
clone pool (read/write, static, choice)
The pool to which save set clones should be sent when 'clones'
is 'Yes'. Only pools of type 'Backup Clone' are allowed (see
nsr_pool(5)).
options (read/write, static, hidden)
The values specify flags with which this group will be run. The
values No Monitor, No index save, No save, Verbose, Estimate,
and Preview map to the savegrp command line flags -m, -I, -n,
-v, -E, and -p respectively. Some of these values (Preview and
No save) are automatically reset when a run of savegrp completes
normally.
Example: options: Verbose;
level (read/write, hidden, choice)
This is an explicit level the savegroup will use when started
automatically by NetWorker. This hidden attribute can be modi-
fied by a user. This value is not cleared automatically, that
is, if one sets this attribute to full, this savegroup will run
with a full level until this value is manually cleared. When
not specified (the normal case), the NSR Schedule for each
client filesystem will be used to determine the level. Manually
running savegrp from the command line overrides this value. The
choices are the standard level identifiers 'full', 'consoli-
date', `incr', `skip', and the number levels `1' through `9'.
printer (read/write, static, hidden)
The printer to which the bootstrap save set information will be
printed, if one is generated by the run of this group. This
hidden attribute can be modified by a user. If an invalid
printer name is specified, bootstrap information will be
included in the savegroup completion information piped through
the savegroup completion notification (see nsr_notification(5)).
Example: printer: ps;
schedule (read/write, choice, hidden)
The schedule to use for determining what level of save to per-
form. This hidden attribute can be modified by a user. This
value is not cleared automatically, that is, if one sets this
attribute to a particular schedule, all clients which are part
of this group will have their schedules overridden until this
value is manually cleared. This overrides the schedule speci-
fied for individual clients. See nsr_schedule(5)).
schedule time (read/write, hidden)
An explicit time can be specified when looking at a schedule to
determine which level of save to perform. A null value (normal
setting) means use the current date to determine the level.
Example: schedule time: "3:00 am 01/11/93";
expiration time (read/write, hidden)
An explicit expiration time can be specified for the savesets
saved with this group. This value will be forwarded to every
save and backup command (see save(3)). A null value (normal set-
ting) means no expiration time is set.
inactivity timeout (read/write, static, hidden)
The number of minutes that the savegrp command waits for any
kind of activity on the server before concluding that a savegrp
descendant is hung. This hidden attribute can be modified by a
user. Once a hang is detected, savegrp prints a message indi-
cating that a save is being aborted, kills or aborts the backup,
and moves on to its next task. Inactivity is defined as the
last time a client has sent data to the server. If a client has
a very large filesystem and an incremental is run, it is possi-
ble for savegrp to abort a save set that only appears to be
hung. In these cases, the inactivity timeout should be
increased to accommodate the particular client.
Example: inactivity timeout: 30;
soft runtime limit (read/write, static)
The number of minutes since the start time of the group after
which no new child processes will be launched. Index and boot-
strap saves are exempt and will be started regardless of this
setting. An empty string or a value of 0 indicates that no soft
timeout will be enforced. Default value is 0.
Example: soft runtime limit: 240;
hard runtime limit (read/write, static)
The number of minutes since the start time of the group, after
which all processes launched by the group will be sent a termi-
nation request. An empty string or a value of 0 indicates that
no hard timeout will be enforced. Default value is 0.
Example: hard runtime limit: 480;
work list (read/write, dynamic, hidden)
The list of saves still not completed. These come in sets of
three values: the client name, the level of save, and the path
to save.
Example: work list: mars, incr, /usr, mars, incr, /g, mars,
venus, /usr
completion (read/write, dynamic, hidden)
The status of each save set that has been completed. These come
in sets of four values: the client name, the path saved, a sta-
tus message (succeeded, failed, or unexpectedly exited), and the
output from the save.
Example: completion: "mars", "/usr", "succeeded", "mars: /
level=full, 6577 KB 00:06:41 625 files"
progress file name (read/write, dynamic, hidden)
The name of a (private) file where savegrp stores the current
representation of the group's work list and completion informa-
tion. Using a file avoids the constant pushing of massive
amounts of information between savegrp and the RAP database
owner, nsrd.
status (read-only, dynamic, hidden)
The current status of this NSR group. Currently, this can have
the values 'idle', 'running' and 'cloning'. The value 'idle' is
set when the group is not active, it is 'running' while backups
are in progress, and it is `cloning' when the backups are com-
plete and clones are automatically being made.
EXAMPLE
The default NSR group resource automatically starts its members at 33
minutes past 3 o'clock in the morning:
type: NSR group;
name: Default;
autostart: Enabled;
start time: "3:33";
administrator: root;
A complete example follows, with the hidden attributes shown with val-
ues reasonable for an active group:
type: NSR group;
name: Default;
autostart: Enabled;
start time: "3:33";
options: Restartable;
printer: lp2;
inactivity timeout: 30;
work list: mars, incr, /g, mars, incr, index,
venus, incr, /usr, venus, incr, index,
jupiter, full, /, jupiter, full, /usr,
jupiter, full, index
completion: mars, /, succeeded,
"mars: / level=incr, 31 KB 00:01:01 72 files
",
mars, /usr, succeeded,
"mars: /usr level=incr, 2 KB 00:00:48 5 files
",
venus, /, succeeded,
"venus: / level=incr, 7711 KB 00:04:37 29 files
";
administrator: root, &operator;
SEE ALSO
nsr(8), nsr_notification(5), nsr_pool(5), nsr_resource(5),
nsr_schedule(5), nsradmin(8), savegrp(8)
NetWorker 7.6.2 Jul 14, 11 nsr_group(5)