usr/src/man/man1m/metaoffline.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 METAOFFLINE 1M "Mar 26, 2006"
   7 .SH NAME
   8 metaoffline, metaonline \- place submirrors offline and online
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/metaoffline\fR \fB-h\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/sbin/metaoffline\fR [\fB-s\fR \fIsetname\fR] [\fB-f\fR] \fImirror\fR \fIsubmirror\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fB/usr/sbin/metaonline\fR \fB-h\fR
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fB/usr/sbin/metaonline\fR [\fB-s\fR \fIsetname\fR] \fImirror\fR \fIsubmirror\fR
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBmetaoffline\fR command prevents Solaris Volume Manager from reading and
  34 writing to the submirror that has been taken offline. While the submirror is
  35 offline, all writes to the mirror will be kept track of (by region) and will be
  36 written when the submirror is brought back online. The \fBmetaoffline\fR
  37 command can also be used to perform online backups: one submirror is taken
  38 offline and backed up while the mirror remains accessible. (However, if this is
  39 a two-way mirror, data redundancy is lost while one submirror is offline.) The
  40 \fBmetaoffline\fR command differs from the \fBmetadetach\fR command because it
  41 does not sever the logical association between the submirror and the mirror. To
  42 completely remove a submirror from a mirror, use the \fBmetadetach\fR command.
  43 .sp
  44 .LP
  45 A submirror that has been taken offline will only remain offline until the
  46 \fBmetaonline\fR command is invoked or the system is rebooted.
  47 .sp
  48 .LP
  49 When the \fBmetaonline\fR command is used, reading from and writing to the
  50 submirror resumes. A resync is automatically invoked to resync the regions
  51 written while the submirror was offline. Writes are directed to the submirror
  52 during resync. Reads, however, will come from a different submirror. Once the
  53 resync operation completes, reads and writes are performed on that submirror.
  54 The \fBmetaonline\fR command is only effective on a submirror of a mirror that
  55 has been taken offline.
  56 .sp
  57 .LP
  58 The \fBmetaoffline\fR and \fBmetaonline\fR commands can not be used on RAID 1
  59 volumes in application-based recovery (ABR) mode.
  60 .sp
  61 .LP
  62 A submirror that has been taken offline with the \fBmetaoffline\fR command can
  63 only be mounted as read-only.
  64 .SH OPTIONS
  65 .sp
  66 .LP
  67 Root privileges are required for all of the following options except \fB-h\fR.
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fB-f\fR\fR
  72 .ad
  73 .RS 14n
  74 Forces offlining of submirrors that have slices requiring maintenance.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fB-h\fR\fR
  81 .ad
  82 .RS 14n
  83 Displays usage message.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB-s\fR \fB\fIsetname\fR\fR\fR
  90 .ad
  91 .RS 14n
  92 Specifies the name of the diskset on which \fBmetaoffline\fR and
  93 \fBmetaonline\fR will work. Using the \fB-s\fR option will cause the command to
  94 perform its administrative function within the specified diskset. Without this
  95 option, the command will perform its function on local metadevices.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fImirror\fR\fR
 102 .ad
 103 .RS 14n
 104 Specifies the metadevice name of the mirror from which the submirror will be
 105 either taken offline or put online.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fIsubmirror\fR\fR
 112 .ad
 113 .RS 14n
 114 Specifies the metadevice name of the submirror to be either taken offline or
 115 put online.
 116 .RE
 117
 118 .SH EXAMPLES
 119 .LP
 120 \fBExample 1 \fRTaking a Submirror Offline
 121 .sp
 122 .LP
 123 This example takes one submirror, \fBmymirror_sub1\fR, offline from mirror
 124 \fBmymirror\fR.
 125
 126 .sp
 127 .in +2
 128 .nf
 129 # metaoffline mymirror mymirror_sub1
 130 .fi
 131 .in -2
 132 .sp
 133
 134 .SH EXIT STATUS
 135 .sp
 136 .LP
 137 The following exit values are returned:
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fB0\fR\fR
 142 .ad
 143 .RS 6n
 144 Successful completion.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fB>0\fR\fR
 151 .ad
 152 .RS 6n
 153 An error occurred.
 154 .RE
 155
 156 .SH ATTRIBUTES
 157 .sp
 158 .LP
 159 See \fBattributes\fR(5) for descriptions of the following attributes:
 160 .sp
 161
 162 .sp
 163 .TS
 164 box;
 165 c | c
 166 l | l .
 167 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 168 _
 169 Interface Stability     Stable
 170 .TE
 171
 172 .SH SEE ALSO
 173 .sp
 174 .LP
 175 \fBmdmonitord\fR(1M), \fBmetaclear\fR(1M), \fBmetadb\fR(1M),
 176 \fBmetadetach\fR(1M), \fBmetahs\fR(1M), \fBmetainit\fR(1M),
 177 \fBmetaparam\fR(1M), \fBmetarecover\fR(1M), \fBmetarename\fR(1M),
 178 \fBmetareplace\fR(1M), \fBmetaroot\fR(1M), \fBmetaset\fR(1M),
 179 \fBmetassist\fR(1M), \fBmetastat\fR(1M), \fBmetasync\fR(1M),
 180 \fBmetattach\fR(1M), \fBmd.tab\fR(4), \fBmd.cf\fR(4), \fBmddb.cf\fR(4),
 181 \fBmd.tab\fR(4), \fBattributes\fR(5), \fBmd\fR(7D)
 182 .sp
 183 .LP
 184 \fI\fR
 185 .SH NOTES
 186 .sp
 187 .LP
 188 The \fBmetaonline\fR and \fBmetaoffline\fR commands are not applicable to
 189 mirrors in application-based recovery (ABR) mode.