usr/src/man/man1m/metaparam.1m

   1 '\" te
   2 .\" Copyright (c) 2004, 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 METAPARAM 1M "Mar 26, 2006"
   7 .SH NAME
   8 metaparam \- modify parameters of metadevices
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/metaparam\fR \fB-h\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/sbin/metaparam\fR [\fB-s\fR \fIsetname\fR]
  18      [\fIconcat/stripe\fR \fIor\fR \fIRAID5\fR \fIoptions\fR] \fIconcat/stripe\fR \fIRAID\fR
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fB/usr/sbin/metaparam\fR [\fB-s\fR \fIsetname\fR] [\fImirror\fR \fIoptions\fR] \fImirror\fR
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBmetaparam\fR command is used to display or modify current parameters of
  30 metadevices.
  31 .sp
  32 .LP
  33 If just the metadevice is specified as an argument to the \fBmetaparam\fR
  34 command, the current settings are displayed.
  35 .sp
  36 .LP
  37 The \fBmetaparam\fR command enables most metadevice (volume) parameters to be
  38 changed. Only the interlace value cannot be changed by \fBmetaparam\fR, because
  39 it is established when the metadevice is created and cannot be changed
  40 thereafter.
  41 .SH OPTIONS
  42 .sp
  43 .LP
  44 Root privileges are required for all of the options.
  45 .sp
  46 .LP
  47 The following options are supported:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fB-h\fR\fR
  52 .ad
  53 .sp .6
  54 .RS 4n
  55 Displays usage message.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fB-s\fR \fB\fIsetname\fR\fR\fR
  62 .ad
  63 .sp .6
  64 .RS 4n
  65 Specify the name of the diskset on which \fBmetaparam\fR works. Using the
  66 \fB-s\fR option causes the command to perform its administrative function
  67 within the specified diskset. Without this option, the command performs its
  68 function on local metadevices.
  69 .RE
  70
  71 .SH CONCAT/STRIPE OR RAID5 OPTIONS
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB-h\fR\fIhot_spare_pool\fR \fB| none\fR\fR
  76 .ad
  77 .sp .6
  78 .RS 4n
  79 Specifies the hot spare pool to be used by a metadevice. If \fBnone\fR is
  80 specified, the metadevice is disassociated with the hot spare pool assigned to
  81 it. If the metadevice is currently using a hot spare, then \fBmetaparam\fR
  82 cannot replace the hot spare pool.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fIconcat/stripe\fR \fB|\fR\fIRAID\fR\fR
  89 .ad
  90 .sp .6
  91 .RS 4n
  92 Specifies the metadevice name of the concatenation, stripe, or concatenation of
  93 stripes, or of the RAID5 metadevice.
  94 .RE
  95
  96 .SH MIRROR OPTIONS
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fB-r roundrobin | geometric | first\fR\fR
 101 .ad
 102 .sp .6
 103 .RS 4n
 104 Modifies the read option for a mirror. The \fB-r\fR option must be followed by
 105 either \fBroundrobin\fR, \fBgeometric\fR, or \fBfirst\fR. \fBroundrobin\fR,
 106 which is the default action under the \fBmetainit\fR command, specifies reading
 107 the disks in a round-robin (load balancing) method. \fBgeometric\fR allows for
 108 faster performance on sequential reads. \fBfirst\fR specifies reading only from
 109 the first submirror.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fB-w parallel | serial\fR\fR
 116 .ad
 117 .sp .6
 118 .RS 4n
 119 Modifies the write option for a mirror. The \fB-w\fR option must be followed by
 120 either \fBparallel\fR or \fBserial\fR. \fBparallel\fR, the default action under
 121 the \fBmetainit\fR command, specifies that all writes are parallel.
 122 \fBserial\fR specifies that all writes are serial.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fB-p\fR \fIpass_number\fR\fR
 129 .ad
 130 .sp .6
 131 .RS 4n
 132 A number from 0-to-9 that specifies the order in which a mirror is resynced
 133 during reboot. The default is 1. Smaller pass numbers are resynced first. Equal
 134 pass numbers are run concurrently. If 0 is used, the mirror resync is skipped.
 135 0 should only be used for mirrors mounted as read-only, or as \fBswap\fR.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fImirror\fR\fR
 142 .ad
 143 .sp .6
 144 .RS 4n
 145 Specifies the metadevice name of the mirror.
 146 .RE
 147
 148 .SH EXAMPLES
 149 .LP
 150 \fBExample 1 \fRAssociating Hot Spare Pool with RAID5 Metadevice
 151 .sp
 152 .LP
 153 This example associates a hot spare pool, \fBuser_pool\fR, with a RAID5
 154 metadevice, \fBuser_raid\fR.
 155
 156 .sp
 157 .in +2
 158 .nf
 159 # metaparam -h user_pool user_raid
 160 .fi
 161 .in -2
 162 .sp
 163
 164 .LP
 165 \fBExample 2 \fRChanging Read Option to Geometric
 166 .sp
 167 .LP
 168 This example changes the read option on a mirror \fBd50\fR from the default of
 169 roundrobin to geometric.
 170
 171 .sp
 172 .in +2
 173 .nf
 174 # metaparam -r geometric d50
 175 .fi
 176 .in -2
 177 .sp
 178
 179 .SH EXIT STATUS
 180 .sp
 181 .LP
 182 The following exit values are returned:
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fB0\fR\fR
 187 .ad
 188 .sp .6
 189 .RS 4n
 190 Successful completion.
 191 .RE
 192
 193 .sp
 194 .ne 2
 195 .na
 196 \fB\fB>0\fR\fR
 197 .ad
 198 .sp .6
 199 .RS 4n
 200 An error occurred.
 201 .RE
 202
 203 .SH ATTRIBUTES
 204 .sp
 205 .LP
 206 See \fBattributes\fR(5) for descriptions of the following attributes:
 207 .sp
 208
 209 .sp
 210 .TS
 211 box;
 212 c | c
 213 l | l .
 214 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 215 _
 216 Interface Stability     Stable
 217 .TE
 218
 219 .SH SEE ALSO
 220 .sp
 221 .LP
 222 \fBmdmonitord\fR(1M), \fBmetaclear\fR(1M), \fBmetadb\fR(1M),
 223 \fBmetadetach\fR(1M), \fBmetahs\fR(1M), \fBmetainit\fR(1M),
 224 \fBmetaoffline\fR(1M), \fBmetaonline\fR(1M), \fBmetarecover\fR(1M),
 225 \fBmetarename\fR(1M), \fBmetareplace\fR(1M), \fBmetaroot\fR(1M),
 226 \fBmetaset\fR(1M), \fBmetassist\fR(1M), \fBmetastat\fR(1M), \fBmetasync\fR(1M),
 227 \fBmetattach\fR(1M), \fBmd.tab\fR(4), \fBmd.cf\fR(4), \fBmddb.cf\fR(4),
 228 \fBmd.tab\fR(4), \fBattributes\fR(5), \fBmd\fR(7D)
 229 .sp
 230 .LP
 231 \fI\fR