.\"
.\" $Id: nsr_archive_request.5,v 1.3.64.1 2005/07/25 17:17:33 btompkin Exp $ Copyright (c) 2005 EMC Corporation.
.\"

.\"
.\" Copyright (c) 2005 EMC Corporation.
.\"
.\" All rights reserved.  This is an UNPUBLISHED work, and
.\" comprises proprietary and confidential information of EMC.
.\" Unauthorized use, disclosure, and distribution are strictly
.\" prohibited.  Use, duplication, or disclosure of the software
.\" and documentation by the U.S. Government is subject to
.\" restrictions set forth in a license agreement between the
.\" Government and EMC or other written agreement specifying
.\" the Government's rights to use the software and any applicable
.\" FAR provisions, such as FAR 52.227-19.
.\"

.TH NSR_ARCHIVE_REQUEST 5 "Aug 23, 06" "StorEdge EBS 7.3.2"
.SH NAME
nsr_archive_request \- Sun StorEdge EBS resource type ``NSR archive request''
.SH SYNOPSIS
.B  "type: NSR archive request"
.SH DESCRIPTION
Each NSR archive request is described by a single resource of type
.BR "NSR archive request"
(see
.BR nsr_resource (5)).
To edit the NSR archive request resources for a Sun StorEdge EBS server type:
.br
.sp
.RS
\fR\s10nsradmin -c "type:NSR archive request"\fP\s0
.RE
.br
.sp
See the
.BR nsradmin (8)
manual page for more information on
using the Sun StorEdge EBS administration program.
The archive request resource may also be edited using
.B Sun StorEdge EBS Management Console.
.LP
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
.BR nsralist (8))
command.
.SH ATTRIBUTES
.LP
The following attributes are defined for resource type
.BR "NSR archive request" .
The information in parentheses describes how the attribute values are accessed.
.B Read-only
indicates that the value cannot be changed by an administrator.
.B Read/write
means the value can be set as well as read.
.B Hidden
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
.BR nsradmin (8).
.B Choice
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).
.B Dynamic
attributes have values which change rapidly.
.B Encrypted
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
.BR nsr_resource (5).
.TP
.BR "comment" "		(read/write)"
This attribute is provided for the administrator to keep any explanatory
remarks or supplementary information about the archive request.
.br
.TP
.BR "annotation" "	(read/write)"
This attribute contains the annotation text associated with the archive
save set generated from this archive request.
.br
.I Example:
\fR\s10annotation: Product Release 4.1;\fP\s0
.TP
.BR "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
request.
.br
.I Example:
\fR\s10archive clone pool: Archive clone;\fP\s0
.TP
.BR "archive completion" "	(read/write)"
A notification action to be executed to send status of the archive request to.
.br
.I Example:
\fR\s10archive completion: /usr/ucb/mail -s "Product Archive" systemadmin;\fP\s0
.TP
.BR "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.
.br
.I Example:
\fR\s10archive pool: Archive;\fP\s0
.TP
.BR "client" "		(read/write)"
This attribute indicates what Sun StorEdge EBS archive client the archive request
is to be executed on.
.br
.I Example:
\fR\s10client: neptune;\fP\s0
.TP
.BR "clone" "		(read/write)"
This attribute controls whether the archive save set generated by the
archive request is to be cloned.
A value of
.I Yes
implies the archive save set should be cloned.
A value of
.I No
does not imply cloning.
.br
.I Example:
\fR\s10clone: No;\fP\s0
.TP
.BR "cloned" "		(read/write, hidden)"
This attribute is unused.
.br
.I Example:
\fR\s10cloned: No;\fP\s0
.TP
.BR "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".
.br
.I Example:
\fR\s10"Thu Oct 22 17:00:37 1994";;\fP\s0
.TP
.BR "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 
.BR nsr_directive (5).
.br
.I Example:
\fR\s10directive: Default with compression;\fP\s0
.TP
.BR "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 
cloned.
A value of
.I none
implies no action.
A value of
.I remove
implies the files and directories specified in the
.B "save set"
attribute will be removed via the
.BR rmdir (2)
and
.BR unlink (2)
system calls.
.br
.I Example:
\fR\s10grooming: none;\fP\s0
.TP
.BR "log" "		(read/write, hidden)"
This attribute contains any information pertaining to the execution
of the
.B nsralist
command.
.br
.I Example:
\fR\s10log:;\fP\s0
.BR "name" "		(read/write)"
This attribute specifies the name of this Sun StorEdge EBS archive request.
.br
.I Example:
\fR\s10name: Product Source Tree;\fP\s0
.TP
.BR "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 (", ").
.br
.I Example:
\fR\s10save set: /product/src, /accounting/db;\fP\s0
.TP
.BR "start time" "	(read/write)"
This attribute determines when the archive request will be run.  The
.B status
attribute (see above) must be set to
.I "start later"
for the archive request to be scheduled.
The 24 hour clock format is "hours:minutes".
.br
.I Example:
\fR\s10start time: 3:33;\fP\s0
.TP
.BR "status" "		(read/write, choice)"
This attribute determines if an archive request should be run.  
No value implies the archive request is not scheduled.
Selecting
.I "start now"
causes the archive request to be run immediately.  Selecting
.I "start later"
causes the archive request to be run at the time specified by the
.B "start time"
attribute. 
.br
.I Example:
\fR\s10status:;\fP\s0
.TP
.BR "verified" "	(read/write, hidden)"
This attribute is unused.
.br
.I Example:
\fR\s10verified: No;\fP\s0
.TP
.BR "verify" "		(read/write, choice)"
This attribute indicates the archive request should verify the archive.
See 
.BR nsr_archive (5)
for more information on archiving.
Selecting the
.I Yes
choice causes the verification to occur.
Selecting the
.I No
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.
.br
.I Example:
\fR\s10verify: Yes;\fP\s0
.LP
.SH EXAMPLE
.LP
.B Note:
the hidden options are not shown in this example.
.LP
A resource to define an archive request, called Product:
.LP
.br
.nf
\fR\s10
.ta \w'archive clone pool:'u+2nR +2n
	type:	NSR archive request;
	name:	Product Source;
	annotation:	Product Release 3.0;
	status:	Start later;
	start time:	"2:00";
	client:	space;
	save set:	/product/source;
	directive:	Default with compression;
	archive pool:	Archive;
	verify:	Yes;
	clone:	Yes;
	archive clone pool:	Archive Clone;
	grooming:	none;
	archive completion:	mail -s Product Source Archive productteam;
.fi
.LP
.SH SEE ALSO
.na
.BR nsr (5),
.BR nsr_directive (5),
.BR nsr_resource (5),
.BR nsradmin (8),
.BR rmdir (2),
.BR unlink (2).
.ad