Man page of NSR_ARCHIVE_REQUEST
Section: File Formats (5)
Updated: Dec 11, 08
Return to Main Contents
nsr_archive_request - NetWorker resource type ``NSR archive request''
type: NSR archive request
Each NSR archive request is described by a single resource of type
NSR archive request
To edit the NSR archive request resources for a NetWorker server type:
nsradmin -c "type:NSR archive request"
manual page for more information on
using the NetWorker administration program.
The archive request resource may also be edited using
NetWorker Management Console.
This resource allows administrators to set up an archive to occur later or
to set up frequent archives of a set of data.
The administrator can run an archive on a specified client within the
next 24 hours.
The archive is executed via the
The following attributes are defined for resource type
NSR archive request.
The information in parentheses describes how the attribute values are accessed.
indicates that the value cannot be changed by an administrator.
means the value can be set as well as read.
means it is an attribute of interest only to programs or experts.
Hidden attributes can only be seen when the hidden option is turned on in
means that the value of the attribute can only be one from a list specific to that attribute (for example, status can be start now or start later).
attributes have values which change rapidly.
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 (for example, administrator) are common
to all resources, and are described in
- comment (read/write)
This attribute is provided for the administrator to keep any explanatory
remarks or supplementary information about the archive request.
- annotation (read/write)
This attribute contains the annotation text associated with the archive
save set generated from this archive request.
annotation: Product Release 4.1;
- archive clone pool (read/write)
This attribute indicates the archive clone media pool the archive request
should use when cloning the archive save set generated by this archive
archive clone pool: Archive clone;
- archive completion (read/write)
A notification action to be executed to send status of the archive request to.
archive completion: /usr/ucb/mail -s "Product Archive" systemadmin;
- archive pool (read/write)
This attribute can be used to override the normal media pool selection
applied to the archive save set generated from the archive request.
Selecting a pool will direct the archive to that media pool.
archive pool: Archive;
- client (read/write)
This attribute indicates what NetWorker archive client the archive request
is to be executed on.
- clone (read/write)
This attribute controls whether the archive save set generated by the
archive request is to be cloned.
A value of
implies the archive save set should be cloned.
A value of
does not imply cloning.
- cloned (read/write, hidden)
This attribute is unused.
- completion time (read/write, hidden)
This attribute indicates when the archive request completed.
The format is "day-of-week month day hours:minutes:seconds year".
"Thu Oct 22 17:00:37 1994";;
- directive (read/write)
This attribute specifies the directive to use when running the archive.
The default value is nothing selected.
The valid choices for the directive resource are names of the
currently defined `NSR directive' resources, see
directive: Default with compression;
- grooming (read/write)
This attribute indicates any grooming actions to be taken once the archive
save set generated by the archive request has been created, verified, and
A value of
implies no action.
A value of
implies the files and directories specified in the
attribute will be removed via the
- log (read/write, hidden)
This attribute contains any information pertaining to the execution
This attribute specifies the name of this NetWorker archive request.
name: Product Source Tree;
- save set (read/write)
This attribute lists the path names to be archived on the archive client.
The names should be separated by a comma and a space (", ").
save set: /product/src, /accounting/db;
- start time (read/write)
This attribute determines when the archive request will be run. The
attribute (see above) must be set to
for the archive request to be scheduled.
The 24 hour clock format is "hours:minutes".
start time: 3:33;
- status (read/write, choice)
This attribute determines if an archive request should be run.
No value implies the archive request is not scheduled.
causes the archive request to be run immediately. Selecting
causes the archive request to be run at the time specified by the
- verified (read/write, hidden)
This attribute is unused.
- verify (read/write, choice)
This attribute indicates the archive request should verify the archive.
for more information on archiving.
choice causes the verification to occur.
choice will not cause any verification.
If the user also requests that the archive save set be cloned, the verification
is done on the clone since the cloning operation will have verified the
original archive save set.
- Save operations (read/write, string)
This attribute specifies the save operation instructions in
the form of:
This attribute is required if save set attribute of the archive client
contains non-ASCII names. Specify:
- I18N:mode=nativepath (for NetWorker 7.4 or later clients on UNIX platforms
with non-ASCII save set names)
- I18N:mode=utf8path (for pre-7.4 clients and NetWorker clients on Windows
platforms with non-ASCII save set names)
Save operations: I18N:mode=nativepath;
the hidden options are not shown in this example.
A resource to define an archive request, called Product:
type:NSR archive request;
annotation:Product Release 3.0;
directive:Default with compression;
archive clone pool:Archive Clone;
archive completion:mail -s Product Source Archive productteam;
- SEE ALSO
This document was created by
using the manual pages.
Time: 02:39:51 GMT, October 02, 2010