usr/src/man/man1m/metaroot.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 METAROOT 1M "Mar 26, 2006"
   7 .SH NAME
   8 metaroot \- setup system files for root (/) metadevice
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/metaroot\fR \fB-h\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/sbin/metaroot\fR [\fB-n\fR] [\fB-k\fR \fIsystem-name\fR] [\fB-v\fR \fIvfstab-name\fR]
  18      [\fB-c\fR \fImddb.cf-name\fR] [\fB-m\fR \fImd.conf-name\fR] [\fB-R\fR \fIroot-path\fR] \fIdevice\fR
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBmetaroot\fR command edits the \fB/etc/vfstab\fR and \fB/etc/system\fR
  25 files so that the system may be booted with the root file system (\fB/\fR) on
  26 an appropriate metadevice. The only metadevices that support the root file
  27 system are a stripe with only a single slice or a mirror on a single-slice
  28 stripe.
  29 .sp
  30 .LP
  31 If necessary, the \fBmetaroot\fR command can reset a system that has been
  32 configured to boot the root file system (\fB/\fR) on a metadevice so that it
  33 uses a physical slice.
  34 .SH OPTIONS
  35 .sp
  36 .LP
  37 Root privileges are required for all of the following options except \fB-h\fR.
  38 .sp
  39 .LP
  40 The following options are supported:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB-c\fR \fImddb.cf-name\fR\fR
  45 .ad
  46 .RS 19n
  47 Use \fImddb.cf-name\fR instead of the default \fB/etc/lvm/mddb.cf\fR file as a
  48 source of metadevice database locations.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB-h\fR\fR
  55 .ad
  56 .RS 19n
  57 Display a usage message.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fB-k\fR \fIsystem-name\fR\fR
  64 .ad
  65 .RS 19n
  66 Edit a user-supplied \fIsystem-name\fR instead of the default \fB/etc/system\fR
  67 system configuration information file.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB-m\fR \fImd.conf-name\fR\fR
  74 .ad
  75 .RS 19n
  76 Edit the configuration file specified by \fImd.conf-name\fR rather than the
  77 default, \fB/kernel/drv/md.conf\fR.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB-n\fR\fR
  84 .ad
  85 .RS 19n
  86 Print what would be done without actually doing it.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB-R\fR \fIroot-path\fR\fR
  93 .ad
  94 .RS 19n
  95 When metaroot modifies system files, it accesses them in their relative
  96 location under \fIroot-path\fR.
  97 .sp
  98 The \fB-R\fR option cannot be used in combination with the \fB-c\fR,
  99 \fB-k\fR,\fB-m\fR, or \fB-v\fR options.
 100 .LP
 101 Note -
 102 .sp
 103 .RS 2
 104 The root file system of any non-global zones must not be referenced with the
 105 \fB-R\fR option. Doing so might damage the global zone's file system, might
 106 compromise the security of the global zone, and might damage the non-global
 107 zone's file system. See \fBzones\fR(5).
 108 .RE
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fB-v\fR \fIvfstab-name\fR\fR
 115 .ad
 116 .RS 19n
 117 Edit \fIvfstab-name\fR instead of the default \fB/etc/vfstab\fR table of file
 118 system defaults.
 119 .RE
 120
 121 .SH OPERANDS
 122 .sp
 123 .LP
 124 The following operands are supported:
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fIdevice\fR\fR
 129 .ad
 130 .RS 10n
 131 Specifies either the metadevice or the conventional disk device (slice) used
 132 for the root file system (\fB/\fR).
 133 .RE
 134
 135 .SH EXAMPLES
 136 .LP
 137 \fBExample 1 \fRSpecifying Root File System on Metadevice
 138 .sp
 139 .LP
 140 The following command edits \fB/etc/system\fR and \fB/etc/vfstab\fR to specify
 141 that the root file system is now on metadevice \fBd0\fR.
 142
 143 .sp
 144 .in +2
 145 .nf
 146 # metaroot d0
 147 .fi
 148 .in -2
 149 .sp
 150
 151 .sp
 152 .LP
 153 The following example shows the same command using a desriptive name for the
 154 metadevice.
 155
 156 .sp
 157 .in +2
 158 .nf
 159 # metaroot newrootfilesystem
 160 .fi
 161 .in -2
 162 .sp
 163
 164 .LP
 165 \fBExample 2 \fRSpecifying Root File System on SCSI Disk
 166 .sp
 167 .LP
 168 The following command edits \fB/etc/system\fR and \fB/etc/vfstab\fR to specify
 169 that the root file system is now on the SCSI disk device
 170 \fB/dev/dsk/c0t3d0s0\fR.
 171
 172 .sp
 173 .in +2
 174 .nf
 175 # metaroot /dev/dsk/c0t3d0s0
 176 .fi
 177 .in -2
 178 .sp
 179
 180 .SH FILES
 181 .sp
 182 .ne 2
 183 .na
 184 \fB\fB/etc/system\fR\fR
 185 .ad
 186 .RS 23n
 187 System configuration information file. See \fBsystem\fR(4).
 188 .RE
 189
 190 .sp
 191 .ne 2
 192 .na
 193 \fB\fB/etc/vfstab\fR\fR
 194 .ad
 195 .RS 23n
 196 File system defaults.
 197 .RE
 198
 199 .sp
 200 .ne 2
 201 .na
 202 \fB\fB/etc/lvm/mddb.cf\fR\fR
 203 .ad
 204 .RS 23n
 205 Metadevice state database locations.
 206 .RE
 207
 208 .sp
 209 .ne 2
 210 .na
 211 \fB\fB/kernel/drv/md.conf\fR\fR
 212 .ad
 213 .RS 23n
 214 Configuration file for the metadevice driver, \fBmd\fR.
 215 .RE
 216
 217 .SH EXIT STATUS
 218 .sp
 219 .LP
 220 The following exit values are returned:
 221 .sp
 222 .ne 2
 223 .na
 224 \fB\fB0\fR\fR
 225 .ad
 226 .RS 6n
 227 Successful completion.
 228 .RE
 229
 230 .sp
 231 .ne 2
 232 .na
 233 \fB\fB>0\fR\fR
 234 .ad
 235 .RS 6n
 236 An error occurred.
 237 .RE
 238
 239 .SH ATTRIBUTES
 240 .sp
 241 .LP
 242 See \fBattributes\fR(5) for descriptions of the following attributes:
 243 .sp
 244
 245 .sp
 246 .TS
 247 box;
 248 c | c
 249 l | l .
 250 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 251 _
 252 Interface Stability     Stable
 253 .TE
 254
 255 .SH SEE ALSO
 256 .sp
 257 .LP
 258 \fBmdmonitord\fR(1M), \fBmetaclear\fR(1M), \fBmetadb\fR(1M),
 259 \fBmetadetach\fR(1M), \fBmetahs\fR(1M), \fBmetainit\fR(1M),
 260 \fBmetaoffline\fR(1M), \fBmetaonline\fR(1M), \fBmetaparam\fR(1M),
 261 \fBmetarecover\fR(1M), \fBmetarename\fR(1M), \fBmetareplace\fR(1M),
 262 \fBmetaset\fR(1M), \fBmetassist\fR(1M), \fBmetastat\fR(1M), \fBmetasync\fR(1M),
 263 \fBmetattach\fR(1M), \fBmd.tab\fR(4), \fBmd.cf\fR(4), \fBmddb.cf\fR(4),
 264 \fBmd.tab\fR(4), \fBattributes\fR(5), \fBmd\fR(7D)
 265 .sp
 266 .LP
 267 \fI\fR