.\"
.\" $Id: nsr_schedule.5,v 1.1.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_SCHEDULE" 5 "Aug 23, 06" "StorEdge EBS 7.3.2"
.SH NAME
nsr_schedule \- Sun StorEdge EBS resource type "NSR schedule"
.SH SYNOPSIS
.B  "type: NSR schedule"
.SH DESCRIPTION
Each Sun StorEdge EBS schedule is described by a single resource of type
.BR "NSR schedule"
(see
.BR nsr_resource (5)).
To edit the
.B NSR schedule
resources for a Sun StorEdge EBS server, type:
.RS
\fR\s10nsradmin \-c "type:NSR schedule"\fP\s0
.RE
See
.BR nsradmin (8)
for more information on using the Sun StorEdge EBS administration program.
.PP
This resource describes a sequence of levels controlling the amount of
data saved by Sun StorEdge EBS clients (see
.BR nsr_client (5)).
There is one
.B NSR schedule
resource for each Sun StorEdge EBS schedule.
.SH ATTRIBUTES
.PP
The following attributes are defined for resource type
.BR "NSR schedule" .
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.  Several additional hidden
attributes (e.g., administrator) are common to all resources, and are
described in
.BR nsr_resource (5).
.TP
.BR "name"			(read/write)
This attribute specifies the schedule's name.  The schedule is
referred to by its name in client resources.
.br
.I Example:
\fR\s10name: monthly_fulls;\fP\s0
.TP
.BR "comment" "                       (read/write)"
This attribute is provided for the administrator to keep any explanatory
remarks or supplementary information about the schedule.
.br
.TP
.BR "period"			(read-only)
This attribute specifies the length of the schedule's period.  It may
be either "Week" or "Month".  "Week" schedules repeat every 7 days and
start on Sunday.  "Month" schedules start over at the first of each
month.  The default is "Week."
.br
.I Example:
\fR\s10period: Month;\fP\s0
.TP
.BR "action"			(read/write)
This attribute specifies the sequence of save levels making up the
schedule.  One entry is used for each day of the schedule.  The
entries must be separated by whitespace, i.e., blanks or tabs.  The
valid levels are "consolidate," "full," "incr," "skip," and the numbers 
1 through 9.  The actions consolidate, full, incr, and skip may be
abbreviated "c," "f," "i," and "s," respectively.
.sp
When the action attribute does not contain enough entries to account
for every day in the period, Sun StorEdge EBS will repeat the list of actions
when the end of the action list is reached.
.br
.I Example:
\fR\s10action: f i i i i i i;\fP\s0
.TP
.BR "override"		(read/write)
This attribute specifies a list of actions and dates overriding the
actions specified in the
.I action
attribute.  The format of the override specification is
.IR "action date" .
.I action
must be one of "full," "incr," "skip," or one of the numbers 1 through
9.
.I date
must be either a
.I fixed date
or
.I recurring date.
.I Fixed date
is of the form "month/day/year."  Month and day are 2 digit numbers,
year may be either 2 or 4 digits. If the year is 2 digits, numbers in the
range 70-99 are assumed to be offsets from 1900, those in the range 00-69
are assumed to be offset from 2000.
.I Recurring date
is of the form `[
.I number
] 
.I weekday
every [
.I number
]
.I period'.
.I number
can be a number (1, 2, 3, etc.) or an ordinal (first, second, third, etc.), and 
it is optional. 
.I weekday
must be one of "monday," "tuesday," "wednesday," "thursday," "friday," 
"saturday," "sunday." The use of "last" for 
.I number
is not supported (for example, "last friday" cannot be used to refer to the 
last Friday of the month).
.I period
must be one of "week," "month," "quarter," or "year."
Action/date pairs are separated by commas (`,').
.br
.I Example:
\fR\s10override:  full 1/1/1994, full first friday every 2 week;\fP\s0
.fi
.SH EXAMPLE
.PP
The following defines a
.B NSR schedule
resource named "Default."  The Default schedule may be modified, but
it may not be deleted.  Each Sun StorEdge EBS server must have a Default
schedule.  This schedule has a period of one week, does a full save on
Sunday, followed by 6 incremental saves.  There are no override
actions specified.
.PP
.RS
.nf
\fR\s10
.ta \w'override:'u+2nR +2n
	type:	NSR schedule;
	name:	Default;
	period:	Week;
	action:	f i i i i i i;
	override:;
.ta
.RE
.fi
.PP
The following defines a schedule named "quarterly."  It has a period
of one month.  The action attribute specifies level 5, 9, and
incremental saves.  In the override attribute, full saves are
specified for the first day of each quarter.  Note that there are only
7 entries in the action attribute.  Upon reaching the end of the list,
Sun StorEdge EBS will start over at the beginning of the list, performing a
level 5 save.
.PP
.RS
.nf
\fR\s10
.ta \w'override:'u+2nR +2n
	type:	NSR schedule;
	name:	quarterly;
	period:	Month;
	action:	5 incr incr incr 9 incr incr;
	override:	f 1/1/1994, f 3/1/1994, f 6/1/1994, f 9/1/1994, f 1/1/1995;
.ta
.fi
.RE
.SH SEE ALSO
.na
.BR nsr (8),
.BR savefs (8),
.BR mminfo (8),
.BR nsradmin (8),
.BR nsr_client (5),
.BR nsr_policy (5),
.BR nsr_resource (5),
.ad