usr/src/man/man4/volume-config.4

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH VOLUME-CONFIG 4 "Aug 8, 2003"
   7 .SH NAME
   8 volume-config \- Solaris Volume Manager volume configuration information for
   9 top down volume creation with metassist
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/share/lib/xml/dtd/volume-config.dtd\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 A volume configuration file, XML-based and compliant with the
  20 \fBvolume-config.dtd\fR Document Type Definition, describes the detailed
  21 configuration of the volume or volumes to be created, including the names,
  22 sizes and configurations of all the components used in the volume or volumes.
  23 This configuration file can be automatically generated by running
  24 \fBmetassist\fR with the \fB-d\fR option, or can be manually created.
  25 .sp
  26 .LP
  27 The volume configuration file can then be used to either generate a command
  28 file or to directly create volumes by running \fBmetassist\fR and specifying
  29 the volume configuration file as input to the command.
  30 .sp
  31 .LP
  32 As a system administrator, you would want to change, manually create, or edit
  33 the volume configuration file only if there are small details of the
  34 configuration that you want to change. For example, you might want to change
  35 names for volumes or hot spare pools, mirror read option, or stripe interlace
  36 values.
  37 .sp
  38 .LP
  39 It would be possible to also select different devices or change slice sizes or
  40 make similar changes, but that is generally not recommended. Substantial
  41 changes to the volume-config file could result in a poor or non-functional
  42 configuration.
  43 .sp
  44 .LP
  45 With a \fBvolume-config\fR file, you can run \fBmetassist\fR and provide the
  46 file as input to the command to generate either a command file or to actually
  47 set up the configuration.
  48 .SS "Defining Volume Configuration"
  49 .sp
  50 .LP
  51 The top level element \fB<volume-config>\fR surrounds the volume configuration
  52 data. This element has no attributes. A volume configuration requires exactly
  53 one \fB<diskset>\fR element, which must be the first element of the volume
  54 configuration. Additionally, the \fBvolume-config\fR can have zero or more of
  55 the following elements:  \fB<disk>\fR, \fB<slice>\fR, \fB<hsp>\fR,
  56 \fB<concat>\fR, \fB<stripe>\fR, \fB<mirror> \fR as required to define the
  57 configuration of the volume to be created.
  58 .SS "Defining Disk Set"
  59 .sp
  60 .LP
  61 Within the \fB<volume-config>\fR element, a \fB<diskset>\fR element must exist.
  62 The \fB<diskset>\fR element, with the name attribute, specifies the name of the
  63 diskset in which to create the volume or volumes. This element and attribute
  64 are required. If this named disk set does not exist, it is created upon
  65 implementation of this volume configuration.
  66 .SS "Defining Slice"
  67 .sp
  68 .LP
  69 The volume configuration format provides for a <slice> element that defines the
  70 name of a slice to use as a component of a volume. The \fB<slice>\fR element
  71 requires a name attribute which specifies a full ctd name. If the \fB<slice>\fR
  72 is newly created as part of the volume configuration, the \fBstartsector\fR and
  73 \fBsizeinblocks\fR attributes must be specified. If the slice was previously
  74 existing, these attributes need not be specified.
  75 .SS "Defining Hot Spare Pool"
  76 .sp
  77 .LP
  78 The volume configuration format provides for a \fB<hsp\fR> element that defines
  79 the name of a hot spare pool to use as a component of a configuration. The
  80 \fB<hsp>\fR element requires a name attribute which specifies a hot spare pool
  81 name.
  82 .sp
  83 .LP
  84 Slices defined by \fB<slice>\fR elements contained in the \fB<hsp>\fR element
  85 are included in the hot spare pool when metassist creates it."
  86 .SS "Defining Stripe"
  87 .sp
  88 .LP
  89 The \fB<stripe>\fR element defines stripes (interlaced RAID 0 volumes) to be
  90 used in a volume. The \fB<stripe>\fR element takes a required name attribute to
  91 specify a name conforming to Solaris Volume Manager naming requirements. If the
  92 name specifies an existing stripe, no \fB<slice>\fR elements are required. If
  93 the name specifies a new stripe, the \fB<slice>\fR elements to construct the
  94 slice must be specified within the \fB<stripe>\fR element. The \fB<stripe>\fR
  95 elements takes an optional interlace attribute as value and units (for example,
  96 16KB, 5BLOCKS, 20MB). If this value isn't specified, the Solaris Volume Manager
  97 default value is used.
  98 .SS "Defining Concat"
  99 .sp
 100 .LP
 101 The \fB<concat>\fR element defines concats (non-interlaced RAID 0 volumes) to
 102 be used in a configuration. It is the same as a \fB<stripe>\fR element, except
 103 that the interlace attribute is not valid.
 104 .SS "Defining Mirror"
 105 .sp
 106 .LP
 107 The \fB<mirror>\fR element defines mirrors (RAID 1 volumes) to be used in a
 108 volume configuration. It can contain combinations of \fB<concat>\fR and
 109 \fB<stripe>\fR elements (to explicitly determine which volumes are used as
 110 submirrors).
 111 .sp
 112 .LP
 113 The \fB<mirror>\fR element takes a required name attribute to specify a name
 114 conforming to Solaris Volume Manager naming requirements.
 115 .sp
 116 .LP
 117 The \fB<mirror>\fR element takes an optional read attribute to define the
 118 mirror read options (\fBROUNDROBIN\fR, \fBGEOMETRIC\fR, or \fBFIRST\fR) for the
 119 mirrors. If this attribute is not specified, the Solaris Volume Manager default
 120 value is used.
 121 .sp
 122 .LP
 123 The \fB<mirror>\fR element takes an optional write attribute to define the
 124 mirror write options (\fBPARALLEL\fR, \fBSERIAL\fR, or \fBFIRST\fR) for the
 125 mirrors. If this attribute is not specified, the Solaris Volume Manager default
 126 value is used. The \fB<mirror>\fR element takes an optional \fBpassnum\fR
 127 attribute (\fB0\fR-\fB9\fR) to define the mirror passnum that defines the order
 128 in which mirrors are resynced at boot, if required. Smaller numbers are
 129 resynced first. If this attribute is not specified, the Solaris Volume Manager
 130 default value is used.
 131 .SH EXAMPLES
 132 .LP
 133 \fBExample 1 \fRSpecifying a Volume Configuration
 134 .sp
 135 .LP
 136 The following is an example volume configuration:
 137
 138 .sp
 139 .in +2
 140 .nf
 141 <!-- Example configuration -->
 142 <volume-config>
 143   <!-- Specify the existing disk set to use -->
 144   <diskset name="redundant"/>
 145
 146 <!-- Create slices -->
 147 <slice name="/dev/dsk/c0t0d1s7" startsector="1444464" \e
 148      sizeinblocks="205632BLOCKS"/>
 149 <slice name="/dev/dsk/c0t0d1s6" startsector="1239840" \e
 150      sizeinblocks="102816KB"/>
 151
 152 <!-- Create a  concat -->
 153 <concat name="d12">
 154 <slice name="/dev/dsk/c0t0d0s7"/>
 155 <slice name="/dev/dsk/c0t0d0s6"/>
 156 <slice name="/dev/dsk/c0t0d1s7"/>
 157 <slice name="/dev/dsk/c0t0d1s6"/>
 158
 159 <!-- Create (and use) a HSP -->
 160 hsp name="hsp0">
 161 <slice name="/dev/dsk/c0t0d4s0"/>
 162 <slice name="/dev/dsk/c0t0d4s1"/>
 163 <slice name="/dev/dsk/c0t0d4s3"/>
 164 <slice name="/dev/dsk/c0t0d4s4"/>
 165 </hsp>
 166
 167 </concat>
 168
 169 <!-- Create a stripe -->
 170 <stripe name="d15" interlace="32KB">
 171 <slice name="/dev/dsk/c0t0d0s7"/>
 172 <slice name="/dev/dsk/c0t0d1s7"/>
 173
 174 <!-- Use a previously-defined HSP -->
 175 <hsp name="hsp0"/>
 176 </stripe>
 177
 178 <!-- Create a  mirror -->
 179 <mirror name="d10">
 180
 181 <!-- Submirror 1: An existing stripe -->
 182 <stripe name="d11"/>
 183
 184 <!-- Submirror 2: The concat defined above -->
 185 <concat name="d12"/>
 186
 187 <!-- Submirror 3: A stripe defined here -->
 188 <stripe name="d13">
 189 <slice name="/dev/dsk/c0t0d2s6"/>
 190 <slice name="/dev/dsk/c0t0d2s7"/>
 191 <slice name="/dev/dsk/c0t0d3s6"/>
 192 slice name="/dev/dsk/c0t0d3s7"/>
 193 </stripe>
 194
 195 </mirror>
 196
 197 </volume-config>
 198 .fi
 199 .in -2
 200
 201 .SH FILES
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fB/usr/share/lib/xml/dtd/volume-config.dtd\fR\fR
 206 .ad
 207 .sp .6
 208 .RS 4n
 209
 210 .RE
 211
 212 .SH SEE ALSO
 213 .sp
 214 .LP
 215 \fBmetassist\fR(1M), \fBmetaclear\fR(1M), \fBmetadb\fR(1M),
 216 \fBmetadetach\fR(1M), \fBmetahs\fR(1M), \fBmetainit\fR(1M),
 217 \fBmetaoffline\fR(1M), \fBmetaonline\fR(1M), \fBmetaparam\fR(1M),
 218 \fBmetarecover\fR(1M), \fBmetareplace\fR(1M), \fBmetaroot\fR(1M),
 219 \fBmetaset\fR(1M), \fBmetasync\fR(1M), \fBmetattach\fR(1M),
 220 \fBmount_ufs\fR(1M), \fBmddb.cf\fR(4)
 221 .sp
 222 .LP
 223 \fISolaris Volume Manager Administration Guide\fR