nsr_task(5)
nsr_task(5)
NAME
nsr_task - NetWorker resource type "NSR task"
SYNOPSIS
type: NSR task
DESCRIPTION
A resource of type NSR task is used to create automatically reaccuring
actions. The actions themselves are defined using other resources. This
resource is used for secheduling. See nsr_resource(5) for more infor-
mation on NetWorker resources. To edit the NSR task resource type:
nsradmin -c "type:NSR task"
or use NetWorker Management Console. See nsradmin(8) for more informa-
tion on using the NetWorker administration program.
ATTRIBUTES
The following attributes are defined for resource type NSR task. The
information in parentheses describes how the attribute values are
accessed. Create-only indicates that the value cannot be changed by an
administrator, except when the resource is created. Read/write means
the value can be changed at any time by authorized administrators.
Choice list means that any number of values can be chosen from the
given list. Single string means that only a single value is allowed.
Static attributes change values rarely, if ever. 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 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, static)
This attribute holds the name of the resource and uniquely iden-
tifies it.
comment (read/write)
This attribute is provided for the administrator to keep any
explanatory remarks or supplementary information about the
resource.
action (read/write)
This attribute specifies the action to be taken by providing the
resource type and name of the command resource in a colon seper-
ated string. Note, you must provide quotes around the value due
to the embedded colon character.
Example:
action: "NSR hypervisor:vcserver.mydomain.com";
autostart (read/write, choice list)
This attribute controls whether the task should be automatically
started at the specified start time. If the start now choice is
available, selecting it will cause the task to be executed imme-
diately (when the resource is updated), but the attribute value
will remain unchanged.
start time (read/write)
This attribute specifies when to automatically execute the task.
The format is expected to be hh:mm in a 24 hour clock (so 23:00
would initiate the task at 11:00 pm.
Example:
start time: "23:00";
interval (read/write)
This attribute is used to specify how often the task is exe-
cuted. The defaul value is 24:00, meaning run once per day.
period (read/write, choice list)
This attribute controls when the plan cycle will repeat. For
example, a week cycle repeats the plan actions every 7 days
while monthly does so once per month.
plan (read/write)
This attribute contains a white-space separated sequence of exec
and skip specifing if the task should be performed on a given
day of the cycle defined by the period attribute. Only the first
character of each entry is inspected so a weekly cycle could be
abbreviated s e e e e e s . When the plan attribute does not
contain enough actions to account for every day in the period,
NetWorker will repeat the actions begining from the first entry.
last start (read only)
The attribute holds the last time the task was started.
last end (read only)
This attribute contains the last time the task ended.
last message (read only)
This attribute holds any message from the last time the task was
executed.
job id (read only)
This attribute contains the job identifier for a running task.
status (read only)
This attribute holds the current status of the task. It can have
the values disabled, idle and running.
EXAMPLE
A complete example of resource creation follows:
type: NSR task;
name: mytask;
action: "NSR hypervisor:maelstrom.legato.com";
FILES
/nsr/res/nsrdb - files in this directory should never be edited
directly. Use NetWorker Management Console or nsradmin instead.
SEE ALSO
nsr_resource(5), nsr_hypervisor(5), nsr(8), nsradmin(8), nsrtask(8),
nsrvim(8)
NetWorker 7.6.2 Jul 14, 11 nsr_task(5)