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 nwadmin(8) GUI. 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 (e.g. 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 administrator. 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;

autostart	(read/write, choice)
    The autostart attribute determines if this group will be saved automatically every day. It may be one of three values: Enabled, Disabled 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 controls whether this group should be automatically 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)
    The start time 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. This attribute is for informational purposes only, and changing it has no effect on the system.

interval		(read/write, static, hidden)
    The interval time specifies how often this group is to be run automatically by NetWorker. Manually starting a group overrides the interval. The default value is 24:00, which means run once a day.

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. The default value is `Yes,' which means force an incremental if the group is run more than once a day. A value of `No' would allow more than one full per day.

client retries	(read/write)
    The number of times failed clients should be retried before savegroup gives up and declare them failed. Zero means don't retry. Abandoned saves are not retried, because they may eventually complete. A client's save sets are retried by savegroup whenever savegroup would otherwise not be able to start a new save set. That is, savegroup 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 automatically 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 the savegroup 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 savegroup 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 modified by a user. This value is not cleared automatically, i.e. 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 savegroup from the command line overrides this value. The choices are the standard level identifiers `full', `consolidate', `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 perform. This hidden attribute can be modified by a user. This value is not cleared automatically, i.e. 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 specified 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";

inactivity timeout	(read/write, static, hidden)
    The number of minutes that the savegroup command waits for any kind of activity on the server before concluding that a savegroup descendant is hung. This hidden attribute can be modified by a user. Once a hang is detected, savegroup prints a message indicating 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 possible for savegrp to abort a save set that only appears to be hung. In these cases, the inactivity timeout should be increased to accomodate the particular client.
    Example: inactivity timeout: 30;

work list	(read/write, dynamic, hidden)
    The list of saves still not completed. These come in sets of 3 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 4 values: the client name, the path saved, a status 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"

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 complete 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 values 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), nwadmin(8), savegroup(8).