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

   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 METAHS 1M "Mar 26, 2006"
   7 .SH NAME
   8 metahs \- manage hot spares and hot spare pools
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/metahs\fR [\fB-s\fR \fIsetname\fR] \fB-a\fR all \fIcomponent\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/sbin/metahs\fR [\fB-s\fR \fIsetname\fR] \fB-a\fR \fIhot_spare_pool\fR [\fIcomponent\fR]
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fB/usr/sbin/metahs\fR [\fB-s\fR \fIsetname\fR] \fB-d\fR \fIhot_spare_pool\fR [\fIcomponent\fR]
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fB/usr/sbin/metahs\fR [\fB-s\fR \fIsetname\fR] \fB-d\fR all \fIcomponent\fR
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fB/usr/sbin/metahs\fR [\fB-s\fR \fIsetname\fR] \fB-e\fR \fIcomponent\fR
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fB/usr/sbin/metahs\fR [\fB-s\fR \fIsetname\fR] \fB-r\fR \fIhot_spare_pool\fR \fIcomponent-old\fR
  38 .fi
  39
  40 .LP
  41 .nf
  42 \fB/usr/sbin/metahs\fR [\fB-s\fR \fIsetname\fR] \fB-r\fR all \fIcomponent-old\fR \fIcomponent-new\fR
  43 .fi
  44
  45 .LP
  46 .nf
  47 \fB/usr/sbin/metahs\fR [\fB-s\fR \fIsetname\fR] \fB-i\fR [\fIhot_spare_pool\fR]...
  48 .fi
  49
  50 .SH DESCRIPTION
  51 .sp
  52 .LP
  53 The \fBmetahs\fR command manages existing hot spares and hot spare pools. It is
  54 used to add, delete, enable, and replace components (slices) in hot spare
  55 pools. Like the \fBmetainit\fR command, the \fBmetahs\fR command can also
  56 create an initial hot spare pool. The \fBmetahs\fR command does not replace a
  57 component of a metadevice. This function is performed by the \fBmetareplace\fR
  58 command.
  59 .sp
  60 .LP
  61 Hot spares are always in one of three states: available, in-use, or broken.
  62 Available hot spares are running and ready to accept data, but are not
  63 currently being written to or read from. In-use hot spares are currently being
  64 written to and read from. Broken hot spares are out of service and should be
  65 repaired. The status of hot spares is displayed when \fBmetahs\fR is invoked
  66 with the \fB-i\fR option.
  67 .sp
  68 .LP
  69 Solaris Volume Manager supports storage devices and logical volumes, including
  70 hot spares, greater than 1 terabyte (TB) when Solaris 10 is running a 64-bit
  71 kernel.
  72 .sp
  73 .LP
  74 If a system with large volumes or hot spares is rebooted under a 32-bit Solaris
  75 10 kernel, the large volumes are visible through \fBmetastat\fR output, but
  76 they cannot be accessed, modified or deleted, and no new large volumes can be
  77 created. Any volumes or file systems on a large volume in this situation are
  78 also unavailable. If a system with large volumes is rebooted under a version of
  79 Solaris prior to Solaris 10, Solaris Volume Manager will not start. All large
  80 volumes must be removed before Solaris Volume Manager runs under another
  81 version of the Solaris Operating Environment.
  82 .SH OPTIONS
  83 .sp
  84 .LP
  85 Root privileges are required for any of the following options except \fB-i\fR.
  86 .sp
  87 .LP
  88 The following options are supported:
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB-a\fR \fBall\fR \fIcomponent\fR\fR
  93 .ad
  94 .sp .6
  95 .RS 4n
  96 Add \fIcomponent\fR to all hot spare pools. \fBall\fR is not case sensitive.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fB-a\fR \fIhot_spare_pool\fR \fB[\fR\fIcomponent\fR\fB]\fR\fR
 103 .ad
 104 .sp .6
 105 .RS 4n
 106 Add the \fIcomponent\fR to the specified \fIhot_spare_pool\fR.
 107 \fIhot_spare_pool\fR is created if it does not already exist.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fB-d\fR \fBall\fR \fIcomponent\fR\fR
 114 .ad
 115 .sp .6
 116 .RS 4n
 117 Delete \fIcomponent\fR from all the hot spare pools. The \fIcomponent\fR cannot
 118 be deleted if it is in the in-use state.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB-d\fR \fIhot_spare_pool\fR \fB[\fR\fIcomponent\fR\fB]\fR\fR
 125 .ad
 126 .sp .6
 127 .RS 4n
 128 Delete \fIhot_spare_pool\fR, if the \fIhot_spare_pool\fR is both empty and not
 129 referenced by a metadevice. If \fIcomponent\fR is specified, it is deleted from
 130 the \fIhot_spare_pool\fR. Hot spares in the in-use state cannot be deleted.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fB-e\fR \fIcomponent\fR\fR
 137 .ad
 138 .sp .6
 139 .RS 4n
 140 Enable \fIcomponent\fR to be available for use as a hot spare. The
 141 \fIcomponent\fR can be enabled if it is in the broken state and has been
 142 repaired.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB-i\fR \fB[\fR\fIhot_spare_pool\fR\fB\|.\|.\|.]\fR\fR
 149 .ad
 150 .sp .6
 151 .RS 4n
 152 Display the status of the specified \fIhot_spare_pool\fR or for all hot spare
 153 pools if one is not specified.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fB-r\fR \fBall\fR \fIcomponent-old component-new\fR\fR
 160 .ad
 161 .sp .6
 162 .RS 4n
 163 Replace \fIcomponent-old\fR with \fIcomponent-new\fR in all hot spare pools
 164 which have the component associated. Components cannot be replaced from any hot
 165 spare pool if the old hot spare is in the in-use state.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fB\fB-r\fR \fIhot_spare_pool component-old component-new\fR\fR
 172 .ad
 173 .sp .6
 174 .RS 4n
 175 Replace \fIcomponent-old\fR with \fIcomponent-new\fR in the specified
 176 \fIhot_spare_pool\fR. Components cannot be replaced from a hot spare pool if
 177 the old hot spare is in the in-use state.
 178 .RE
 179
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fB-s\fR \fB\fIsetname\fR\fR\fR
 184 .ad
 185 .sp .6
 186 .RS 4n
 187 Specify the name of the diskset on which \fBmetahs\fR works. Using the \fB-s\fR
 188 option causes the command to perform its administrative function within the
 189 specified diskset. Without this option, the command performs its function on
 190 local hot spare pools.
 191 .RE
 192
 193 .SH OPERANDS
 194 .sp
 195 .LP
 196 The following operands are supported:
 197 .sp
 198 .ne 2
 199 .na
 200 \fB\fIcomponent\fR\fR
 201 .ad
 202 .RS 18n
 203 The logical name for the physical slice (partition) on a disk drive, such as
 204 \fB/dev/dsk/c0t0d0s2\fR.
 205 .RE
 206
 207 .sp
 208 .ne 2
 209 .na
 210 \fB\fIhot_spare_pool\fR\fR
 211 .ad
 212 .RS 18n
 213 Names for hot spare pools can be any legal file name that is composed of
 214 alphanumeric characters, a dash ("-"), an underscore ("_"), or a period (".").
 215 Names must begin with a letter. The words "all" and "none" are reserved and
 216 cannot be used.
 217 .RE
 218
 219 .SH EXAMPLES
 220 .LP
 221 \fBExample 1 \fRAdding a Hot Spare to a Hot Spare Pool
 222 .sp
 223 .LP
 224 The following example adds a hot spare \fB/dev/dsk/c0t0d0s7\fR to a hot spare
 225 pool \fBmirror1_pool\fR:
 226
 227 .sp
 228 .in +2
 229 .nf
 230 # metahs -a mirror1_pool c0t0d0s7
 231 .fi
 232 .in -2
 233 .sp
 234
 235 .sp
 236 .LP
 237 When the hot spare is added to the pool, the existing order of the hot spares
 238 already in the pool is preserved. The new hot spare is added at the end of the
 239 list of hot spares in the hot spare pool specified.
 240
 241 .LP
 242 \fBExample 2 \fRAdding a Hot Spare to All Currently Defined Pools
 243 .sp
 244 .LP
 245 This example adds a hot spare to the hot spare pools that are currently
 246 defined:
 247
 248 .sp
 249 .in +2
 250 .nf
 251 # metahs -a all c0t0d0s7
 252 .fi
 253 .in -2
 254 .sp
 255
 256 .sp
 257 .LP
 258 The keyword \fBall\fR in this example specifies adding the hot spare,
 259 \fB/dev/dsk/c0t0d0s7\fR, to all the hot spare pools.
 260
 261 .LP
 262 \fBExample 3 \fRDeleting a Hot Spare
 263 .sp
 264 .LP
 265 This example deletes a hot spare, \fB/dev/dsk/c0t0d0s7\fR, from a hot spare
 266 pool, \fBhsp003\fR:
 267
 268 .sp
 269 .in +2
 270 .nf
 271 # metahs -d hsp003 c0t0d0s7
 272 .fi
 273 .in -2
 274 .sp
 275
 276 .sp
 277 .LP
 278 When you delete a hot spare, the position of the remaining hot spares in the
 279 pool changes to reflect the new order. For instance, if in this example
 280 \fB/dev/dsk/c0t0d0s7\fR were the second of three hot spares, after deletion the
 281 third hot spare would move to the second position.
 282
 283 .LP
 284 \fBExample 4 \fRReplacing a Hot Spare
 285 .sp
 286 .LP
 287 This example replaces a hot spare that was previously defined:
 288
 289 .sp
 290 .in +2
 291 .nf
 292 # metahs -r hsp001 c0t1d0s0 c0t3d0s0
 293 .fi
 294 .in -2
 295 .sp
 296
 297 .sp
 298 .LP
 299 In this example, the hot spare \fB/dev/dsk/c0t1d0s0\fR is replaced by
 300 \fB/dev/dsk/c0t3d0s0\fR. The order of the hot spares does not change.
 301
 302 .SH EXIT STATUS
 303 .sp
 304 .LP
 305 The following exit values are returned:
 306 .sp
 307 .ne 2
 308 .na
 309 \fB\fB0\fR\fR
 310 .ad
 311 .RS 6n
 312 Successful completion.
 313 .RE
 314
 315 .sp
 316 .ne 2
 317 .na
 318 \fB\fB>0\fR\fR
 319 .ad
 320 .RS 6n
 321 An error occurred.
 322 .RE
 323
 324 .SH ATTRIBUTES
 325 .sp
 326 .LP
 327 See \fBattributes\fR(5) for descriptions of the following attributes:
 328 .sp
 329
 330 .sp
 331 .TS
 332 box;
 333 c | c
 334 l | l .
 335 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 336 _
 337 Interface Stability     Stable
 338 .TE
 339
 340 .SH SEE ALSO
 341 .sp
 342 .LP
 343 \fBmdmonitord\fR(1M), \fBmetaclear\fR(1M), \fBmetadb\fR(1M),
 344 \fBmetadetach\fR(1M), \fBmetainit\fR(1M), \fBmetaoffline\fR(1M),
 345 \fBmetaonline\fR(1M), \fBmetaparam\fR(1M), \fBmetarecover\fR(1M),
 346 \fBmetarename\fR(1M), \fBmetareplace\fR(1M), \fBmetaroot\fR(1M),
 347 \fBmetaset\fR(1M), \fBmetassist\fR(1M), \fBmetastat\fR(1M), \fBmetasync\fR(1M),
 348 \fBmetattach\fR(1M), \fBmd.tab\fR(4), \fBmd.cf\fR(4), \fBmddb.cf\fR(4),
 349 \fBmd.tab\fR(4), \fBattributes\fR(5), \fBmd\fR(7D)
 350 .sp
 351 .LP
 352 \fI\fR
 353 .SH WARNINGS
 354 .sp
 355 .LP
 356 Do not create large (>1 TB) volumes if you expect to run the Solaris Operating
 357 Environment with a 32-bit kernel or if you expect to use a version of the
 358 Solaris Operating Environment prior to Solaris 10.