.\"
.\" $Id: nsr_label.5,v 1.4.12.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_LABEL" 5 "Aug 23, 06" "StorEdge EBS 7.3.2"
.SH NAME
nsr_label \- Sun StorEdge EBS resource type ``NSR label''
.SH SYNOPSIS
.B  "type: NSR label"
.SH DESCRIPTION
Each NSR label template is described by a single resource of type
.BR "NSR label"
(see
.BR nsr_resource (5)).
To edit the NSR label resources for a Sun StorEdge EBS server, type:
.br
.RS
\fR\s10nsradmin -c "type:NSR label"\fP\s0
.RE
.br
or use
.B Sun StorEdge EBS Management Console.
See the
.BR nsradmin (8)
manual page for more information on
using the Sun StorEdge EBS administration program.
.LP
This resource describes the templates used to generate volume labels.
.SH ATTRIBUTES
.LP
The following attributes are defined for resource type
.BR "nsr_label" .
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 Choice
means that the value of the attribute can only be one from a list specific to 
that attribute (for example, separator can be '-', or '.').
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 label.
.br
.TP
.BR "fields" "		(read/write, list of strings)"
This attribute specifies the constituent fields of a
.IR "label template" .
When generating a volume name, the current value of each field is concatenated.
The first field is considered the most significant, the last field the least.
If there is a
.I separator
(see below) defined, then it will be placed between fields as they are
concatenated to form a volume name.
The fields are separated by commas.
.IP ""
There are four different types of
fields: `numeric range', `lower-case range', `upper-case range', and
a `list of strings'.
A `list of strings' consists of space (` ') separated strings.
The other types are specified as
starting and ending values separated by a dash (`-') .
The starting and ending values of a range must have the same number of characters.
.IP ""
The
.I next
attribute (see below) contains the current position or value of each field.
After a volume name has been assigned to a volume, the
.I next
attribute is incremented.
When the ending value is reached, the current value will wrap around to the
starting value.
A `list of strings' field is incremented by selecting
the next string in the list.
A numeric range field is incremented by adding 1 to its current value.
Lower-case and upper-case ranges are incremented by moving on to the next letter
in the least significant position.  In the example below, after aa.99, the next
label would be ab.00.
.br
.I Example:
\fR\s10fields: aa-zz, 00-99;\fP\s0
.TP
.BR "name" "	(create only, single string, static)"
This attribute specifies the name of this label template.
The label template is referred to by its name in the jukebox resource, see
.BR nsr_jukebox (5).
.br
.I Example:
\fR\s10name: Default;\fP\s0
.TP
.BR "next" "		(read/write, single string)"
This attribute specifies the next volume name to use.
After it is assigned to a volume, the next volume name will be
generated and remembered here.
The attribute consists of a component for each of the specified fields and
the separator.
.br
.I Example:
.br
\fR\s10next: aa.00;\fP\s0
.TP
.BR
Using the separator and field attributes shown above,
the
.I next
attribute would show:
.BR
\fR\s10next: aa.01;\fP\s0
.br
This would be followed by:
.BR
\fR\s10next: aa.02;\fP\s0
.TP
.BR "separator" "	(read/write, single choice, null ok)"
This attribute specifies the character to use to separate the label fields.
It may be one of `.', `_', `:', `-' or NULL.
.br
.I Example:
\fR\s10separator: .;\fP\s0
.SH EXAMPLES
A label resource named
.I engineering
is shown below.  (Hidden options are not shown.)
There are two range-type fields defined, the first ranging from `aa' to `zz',
the second from `00' to `99'.
The
.I separator
attribute has the value `.' and
it will be inserted in between the two fields.
The
.I next
attribute
holds the next name that will be generated by this template.
After
.I aa.00
is used, the
.I 00
will be incremented.
The new name will be
.IR aa.01 .
After 98 more names have been generated, the
.I next
attribute will hold the name
.IR aa.99 .
When this name is incremented, the
.I next
attribute will hold
.IR ab.00 .
After generating 67,500 more names, the
.I next
attribute will hold
.IR zz.99 .
This will be followed by
.IR aa.00 .
.LP
.br
.nf
\fR\s10
.ta \w'separator:'u+2nR +1m
	type:	NSR label;
	name:	engineering;
	fields:	aa-zz, 00-99;
	separator:	.;
	next:	aa.00;
.ta
.fi
.LP
A label resource named
.I accounting
is shown below.
The field attribute defines five component fields.
The
.I separator
attribute has the value `.'.
It will be inserted in between adjacent fields.
The
.I next
attribute
holds the next name that will be used with this template.
After
.I 0.23.aa.AA.first
is used, the fifth field will be incremented.
The new name will be
.IR 0.23.aa.AA.second .
This will be followed by
.IR 0.23.aa.AB.first .
After 1349 more volume names, the name will be
.IR 0.23.aa.ZZ.second .
This will be followed by
.IR 0.23.ab.AA.first .
After using
.IR 9.45.zz.ZZ.second ,
the name will wrap around to
.IR 0.23.aa.AA.first .
.LP
.nf
\fR\s10
.ta \w'separator:'u+2nR +1m
	type:	NSR label;
	name:	accounting;
	fields:	0-9, 23-45, aa-zz, AA-ZZ, first second;
	separator:	.;
	next:	0.23.aa.AA.first;
.ta
.fi
.LP
.SH SEE ALSO
.na
.BR nsradmin (8),
.BR nsrjb (8),
.BR nsrmm (8),
.BR nsr (8),
.BR nsr_jukebox (5)
.ad