Print this page
9842 man page typos and spelling
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1m/zoneadm.1m.man.txt
+++ new/usr/src/man/man1m/zoneadm.1m.man.txt
1 1 ZONEADM(1M) Maintenance Commands ZONEADM(1M)
2 2
3 3
4 4
5 5 NAME
6 6 zoneadm - administer zones
7 7
8 8 SYNOPSIS
9 9 zoneadm -z zonename [-u uuid-match] subcommand
10 10 [subcommand_options]
11 11
12 12
13 13 zoneadm [-R root] [-z zonename] [-u uuid-match] list
14 14 [list_options]
15 15
16 16
17 17 zoneadm [-R root] -z zonename [-u uuid-match] mark incomplete
18 18
19 19
20 20 DESCRIPTION
21 21 The zoneadm utility is used to administer system zones. A zone is an
22 22 application container that is maintained by the operating system
23 23 runtime.
24 24
25 25 SECURITY
26 26 Once a process has been placed in a zone other than zone 0, the process
27 27 or any of its children cannot change zones.
28 28
29 29 OPTIONS
30 30 The following options are supported:
31 31
32 32 -R root
33 33
34 34 Specify an alternate root (boot environment). This option can only
35 35 be used in conjunction with the "list" and "mark" subcommands.
36 36
37 37
38 38 -u uuid-match
39 39
40 40 Unique identifier for a zone, as assigned by libuuid(3LIB). If this
41 41 option is present and the argument is a non-empty string, then the
42 42 zone matching the UUID is selected instead of the one named by the
43 43 -z option, if such a zone is present.
44 44
45 45
46 46 -z zonename
47 47
48 48 String identifier for a zone.
49 49
50 50
51 51 SUBCOMMANDS
52 52 Subcommands which can result in destructive actions or loss of work
53 53 have a -F flag to force the action. If input is from a terminal device,
54 54 the user is prompted if such a command is given without the -F flag;
55 55 otherwise, if such a command is given without the -F flag, the action
56 56 is disallowed, with a diagnostic message written to standard error. If
57 57 a zone installation or uninstallation is interrupted, the zone is left
58 58 in the incomplete state. Use uninstall to reset such a zone back to the
59 59 configured state.
60 60
61 61
62 62 The following subcommands are supported:
63 63
64 64 attach [-F] [-n path] [brand-specific options]
65 65
66 66 The attach subcommand takes a zone that has been detached from one
67 67 system and attaches the zone onto a new system. Therefore, it is
68 68 advised (though not required) that the detach subcommand should be
69 69 run before the "attach" takes place. Once you have the new zone in
70 70 the configured state, use the attach subcommand to set up the zone
71 71 root instead of installing the zone as a new zone.
72 72
73 73 The -F option can be used to force the zone into the "installed"
74 74 state with no validation. This option should be used with care
75 75 since it can leave the zone in an unsupportable state if it was
76 76 moved from a source system to a target system that is unable to
77 77 properly host the zone. The -n option can be used to run the attach
78 78 subcommand, without executing the command. It uses the output of
79 79 the "detach -n" subcommand as input and is useful to identify any
80 80 conflicting issues, such as the network device being incompatible,
81 81 and can also determine whether the host is capable of supporting
82 82 the zone. The path can be "-", to read the input from standard
83 83 input.
84 84
85 85 The zone's brand may include additional options that govern how the
86 86 zone will be attached. See brands(5) for specific brand
87 87 information.
88 88
89 89 The zone being attached must first be configured using the zonecfg
90 90 (see zonecfg(1M)) command. This does not apply when running "attach
91 91 -n".
92 92
93 93 Use the following command to attach a zone:
94 94
95 95 # zoneadm -z my-zone attach
96 96
97 97
98 98
99 99
100 100 boot [-- boot_options]
101 101
102 102 Boot (or activate) the specified zones.
103 103
104 104 The following boot_options are supported:
105 105
106 106 -i altinit
107 107
108 108 Select an alternative executable to be the primordial Process.
109 109 altinit is a valid path to an executable. The default
110 110 primordial process is init(1M).
111 111
112 112
113 113 -m smf_options
114 114
115 115 The smf_options include two categories of options to control
116 116 booting behavior of the service management facility: recovery
117 117 options and messages options.
118 118
119 119 Message options determine the type and amount of messages that
120 120 smf(5) displays during boot. Service options determine the
121 121 services which are used to boot the system. See kernel(1M) for
122 122 a listing of the -m suboptions.
123 123
124 124
125 125 -s
126 126
127 127 Boots only to milestone svc:/milestone/single-user:default.
128 128 This milestone is equivalent to init level s. See
129 129 svc.startd(1M) and init(1M).
130 130
131 131
132 132
133 133 clone [-m copy] [-s zfs_snapshot] source_zone
134 134
135 135 Install a zone by copying an existing installed zone. This
136 136 subcommand is an alternative way to install the zone.
137 137
138 138 -m copy
139 139
140 140 Force the clone to be a copy, even if a "ZFS clone" is
141 141 possible.
142 142
143 143
144 144 -s zfs_snapshot
145 145
146 146 Specify the name of a ZFS snapshot to use as the source of the
147 147 clone. The snapshot must be a snapshot of the source zone taken
148 148 from a previous "zoneadm clone" installation.
149 149
150 150 The source zone must be halted before this subcommand can be used.
151 151
152 152
153 153 detach [-n]
154 154
155 155 Detach the specified zone. Detaching a zone is the first step in
156 156 moving a zone from one system to another. The full procedure to
157 157 migrate a zone is that the zone is detached, the zonepath directory
158 158 is moved to the new host, and then the zone is attached on the new
159 159 host. Once the zone is detached, it is left in the configured
160 160 state. If you try to install or clone to a configured zone that has
161 161 been detached, you will receive an error message and the install or
162 162 clone subcommand will not be allowed to proceed. The -n option can
163 163 be used to run the detach subcommand, without executing the
164 164 command. This generates the information needed for running the
165 165 "attach -n" subcommand, which is useful to identify any conflicting
166 166 issues, such as the network device being incompatible or if the
167 167 host is capable of supporting the zone. The information is sent to
168 168 standard output and can be saved to a file or piped to the "attach
169 169 -n" subcommand.
170 170
171 171 Use the following command to detach a zone:
172 172
173 173 # zoneadm -z my-zone detach
174 174
175 175
176 176 The source zone must be halted before this subcommand can be used.
177 177
178 178
179 179 halt
180 180
181 181 Halt the specified zones. halt bypasses running the shutdown
182 182 scripts inside the zone. It also removes run time resources of the
183 183 zone.
184 184
185 185
186 186 help [subcommand]
187 187
188 188 Display general help. If you specify subcommand, displays help on
189 189 subcommand.
190 190
191 191
192 192 install [-x nodataset] [brand-specific options]
193 193
194 194 Install the specified zone on the system. This subcommand
195 195 automatically attempts to verify first, most verification errors
196 196 are fatal. See the verify subcommand.
197 197
198 198 -x nodataset
199 199
200 200 Do not create a ZFS file system.
201 201
202 202 The zone's brand may include additional options that govern how the
203 203 software will be installed in the zone. See brands(5) for specific
204 204 brand information.
205 205
206 206
207 207 list [list_options]
208 208
209 209 Display the name of the current zones, or the specified zone if
210 210 indicated.
211 211
212 212 By default, all running zones are listed. If you use this
213 213 subcommand with the zoneadm -z zonename option, it lists only the
|
↓ open down ↓ |
213 lines elided |
↑ open up ↑ |
214 214 specified zone, regardless of its state. In this case, the -i and
215 215 -c options are disallowed.
216 216
217 217 If neither the -i or -c options are given, all running zones are
218 218 listed.
219 219
220 220 The following list_options are supported:
221 221
222 222 -c
223 223
224 - Display all configured zones. This option overides the -i
224 + Display all configured zones. This option overrides the -i
225 225 option.
226 226
227 227
228 228 -i
229 229
230 230 Expand the display to all installed zones.
231 231
232 232
233 233 -p
234 234
235 235 Request machine parsable output. The output format is a list of
236 236 lines, one per zone, with colon- delimited fields. These fields
237 237 are:
238 238
239 239 zoneid:zonename:state:zonepath:uuid:brand:ip-type
240 240
241 241
242 242 If the zonepath contains embedded colons, they can be escaped
243 243 by a backslash (""), which is parsable by using the shell
244 244 read(1) function with the environmental variable IFS. The uuid
245 245 value is assigned by libuuid(3LIB) when the zone is installed,
246 246 and is useful for identifying the same zone when present (or
247 247 renamed) on alternate boot environments. Any software that
248 248 parses the output of the "zoneadm list -p" command must be able
249 249 to handle any fields that may be added in the future.
250 250
251 251 The -v and -p options are mutually exclusive. If neither -v nor
252 252 -p is used, just the zone name is listed.
253 253
254 254
255 255 -v
256 256
257 257 Display verbose information, including zone name, id, current
258 258 state, root directory, brand type, ip-type, and options.
259 259
260 260 The -v and -p options are mutually exclusive. If neither -v nor
261 261 -p is used, just the zone name is listed.
262 262
263 263
264 264
265 265 mark incomplete
266 266
267 267 Change the state of an installed zone to "incomplete." This command
268 268 may be useful in cases where administrative changes on the system
269 269 have rendered a zone unusable or inconsistent. This change cannot
270 270 be undone (except by uninstalling the zone).
271 271
272 272
273 273 move new_zonepath
274 274
275 275 Move the zonepath to new_zonepath. The zone must be halted before
276 276 this subcommand can be used. The new_zonepath must be a local file
277 277 system and normal restrictions for zonepath apply.
278 278
279 279
280 280 ready
281 281
282 282 Prepares a zone for running applications but does not start any
283 283 user processes in the zone.
284 284
285 285
286 286 reboot [-- boot_options]]
287 287
288 288 Restart the zones. This is equivalent to a halt boot sequence. This
289 289 subcommand fails if the specified zones are not active. See boot
290 290 subcommand for the boot options.
291 291
292 292
293 293 shutdown [-r [-- boot_options]]
294 294
295 295 Gracefully shutdown the specified zone. This subcommand waits for
296 296 all zone processes to finish; the default timeout is
297 297 SCF_PROPERTY_TIMEOUT value from the SMF service system/zones. If
298 298 the -r option is specified, reboot the zone. See boot subcommand
299 299 for the boot options.
300 300
301 301
302 302 uninstall [-F]
303 303
304 304 Uninstall the specified zone from the system. Use this subcommand
305 305 with caution. It removes all of the files under the zonepath of
306 306 the zone in question. You can use the -F flag to force the action.
307 307
308 308
309 309 verify
310 310
311 311 Check to make sure the configuration of the specified zone can
312 312 safely be installed on the machine. Following is a break-down of
313 313 the checks by resource/property type:
314 314
315 315 zonepath
316 316
317 317 zonepath and its parent directory exist and are owned by root
318 318 with appropriate modes . The appropriate modes are that
319 319 zonepath is 700, its parent is not group or world-writable and
320 320 so forth. zonepath is not over an NFS mount. A sub-directory
321 321 of the zonepath named "root" does not exist.
322 322
323 323 If zonepath does not exist, the verify does not fail, but
324 324 merely warns that a subsequent install will attempt to create
325 325 it with proper permissions. A verify subsequent to that might
326 326 fail should anything go wrong.
327 327
328 328 zonepath cannot be a symbolic link.
329 329
330 330
331 331 fs
332 332
333 333 Any fs resources have their type value checked. An error is
334 334 reported if the value is one of proc, mntfs, autofs, or nfs or
335 335 the filesystem does not have an associated mount binary at
336 336 /usr/lib/fs/<fstype>/mount.
337 337
338 338 It is an error for the directory to be a relative path.
339 339
340 340 It is an error for the path specified by raw to be a relative
341 341 path or if there is no fsck binary for a given filesystem type
342 342 at /usr/lib/fs/<fstype>/fsck. It is also an error if a
343 343 corresponding fsck binary exists but a raw path is not
344 344 specified.
345 345
346 346
347 347 net
348 348
349 349 All physical network interfaces exist. All network address
350 350 resources are one of:
351 351
352 352 o a valid IPv4 address, optionally followed by "/" and
353 353 a prefix length;
354 354
355 355 o a valid IPv6 address, which must be followed by "/"
356 356 and a prefix length;
357 357
358 358 o a host name which resolves to an IPv4 address.
359 359 Note that hostnames that resolve to IPv6 addresses are not
360 360 supported.
361 361
362 362 The physical interface name is the network interface name.
363 363
364 364 A zone can be configured to be either exclusive-IP or shared-
365 365 IP. For a shared-IP zone, both the physical and address
366 366 properties must be set. For an exclusive-IP zone, the physical
367 367 property must be set and the address property cannot be set.
368 368
369 369
370 370 rctl
371 371
372 372 It also verifies that any defined resource control values are
373 373 valid on the current machine. This means that the privilege
374 374 level is privileged, the limit is lower than the currently
375 375 defined system value, and that the defined action agrees with
376 376 the actions that are valid for the given resource control.
377 377
378 378
379 379
380 380 EXAMPLES
381 381 Example 1 Using the -m Option
382 382
383 383
384 384 The following command illustrates the use of the -m option.
385 385
386 386
387 387 # zoneadm boot -- -m verbose
388 388
389 389
390 390
391 391 Example 2 Using the -i Option
392 392
393 393
394 394 The following command illustrates the use of the -i option.
395 395
396 396
397 397 # zoneadm boot -- -i /sbin/init
398 398
399 399
400 400
401 401 Example 3 Using the -s Option
402 402
403 403
404 404 The following command illustrates the use of the -s option.
405 405
406 406
407 407 # zoneadm boot -- -s
408 408
409 409
410 410
411 411 EXIT STATUS
412 412 The following exit values are returned:
413 413
414 414 0
415 415
416 416 Successful completion.
417 417
418 418
419 419 1
420 420
421 421 An error occurred.
422 422
423 423
424 424 2
425 425
426 426 Invalid usage.
427 427
428 428
429 429 ATTRIBUTES
430 430 See attributes(5) for descriptions of the following attributes:
431 431
432 432
433 433
434 434
435 435 +--------------------+-----------------+
436 436 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
437 437 +--------------------+-----------------+
438 438 |Interface Stability | Committed |
439 439 +--------------------+-----------------+
440 440
441 441 SEE ALSO
442 442 read(1), svcs(1), zlogin(1), zonename(1), init(1M), kernel(1M),
443 443 svcadm(1M), svc.startd(1M), svc.startd(1M), zonecfg(1M), libuuid(3LIB),
444 444 attributes(5), brands(5), native(5), smf(5), zones(5)
445 445
446 446 NOTES
447 447 The zones(5) service is managed by the service management facility,
448 448 smf(5), under the service identifier:
449 449
450 450 svc:/system/zones:default
451 451
452 452
453 453
454 454
455 455 Administrative actions on this service, such as enabling, disabling, or
456 456 requesting restart, can be performed using svcadm(1M). The service's
457 457 status can be queried using the svcs(1) command.
458 458
459 459
460 460
461 461 May 13, 2017 ZONEADM(1M)
|
↓ open down ↓ |
227 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX