1 '\" te
2 .\" Copyright 2014 Nexenta Systems, Inc. All rights reserved.
3 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH ZONEADM 1M "Oct 30, 2013"
8 .SH NAME
9 zoneadm \- administer zones
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBzoneadm\fR \fB-z\fR \fIzonename\fR [\fB-u\fR \fIuuid-match\fR] \fIsubcommand\fR
14 [\fIsubcommand_options\fR]
15 .fi
16
17 .LP
18 .nf
19 \fBzoneadm\fR [\fB-R\fR \fIroot\fR] [\fB-z\fR \fIzonename\fR] [\fB-u\fR \fIuuid-match\fR] list
20 [\fIlist_options\fR]
21 .fi
22
23 .LP
24 .nf
25 \fBzoneadm\fR [\fB-R\fR \fIroot\fR] \fB-z\fR \fIzonename\fR [\fB-u\fR \fIuuid-match\fR] mark incomplete
26 .fi
27
28 .SH DESCRIPTION
29 .sp
30 .LP
31 The \fBzoneadm\fR utility is used to administer system zones. A zone is an
32 application container that is maintained by the operating system runtime.
33 .SH SECURITY
34 .sp
35 .LP
36 Once a process has been placed in a zone other than zone \fB0\fR, the process
37 or any of its children cannot change zones.
38 .SH OPTIONS
39 .sp
40 .LP
41 The following options are supported:
42 .sp
43 .ne 2
44 .na
45 \fB\fB-R\fR \fIroot\fR\fR
46 .ad
47 .sp .6
48 .RS 4n
49 Specify an alternate root (boot environment). This option can only be used in
50 conjunction with the "\fBlist\fR" and "\fBmark\fR" subcommands.
51 .RE
52
53 .sp
54 .ne 2
55 .na
56 \fB\fB-u\fR \fIuuid-match\fR\fR
57 .ad
58 .sp .6
59 .RS 4n
60 Unique identifier for a zone, as assigned by \fBlibuuid\fR(3LIB). If this
61 option is present and the argument is a non-empty string, then the zone
62 matching the \fBUUID\fR is selected instead of the one named by the \fB-z\fR
63 option, if such a zone is present.
64 .RE
65
66 .sp
67 .ne 2
68 .na
69 \fB\fB-z\fR \fIzonename\fR\fR
70 .ad
71 .sp .6
72 .RS 4n
73 String identifier for a zone.
74 .RE
75
76 .SH SUBCOMMANDS
77 .sp
78 .LP
79 Subcommands which can result in destructive actions or loss of work have a
80 \fB-F\fR flag to force the action. If input is from a terminal device, the user
81 is prompted if such a command is given without the \fB-F\fR flag; otherwise, if
82 such a command is given without the \fB-F\fR flag, the action is disallowed,
83 with a diagnostic message written to standard error. If a zone installation or
84 uninstallation is interrupted, the zone is left in the incomplete state. Use
85 uninstall to reset such a zone back to the configured state.
86 .sp
87 .LP
88 The following subcommands are supported:
89 .sp
90 .ne 2
91 .na
92 \fB\fBattach\fR [\fB-F\fR] [\fB-n\fR \fIpath\fR] [\fIbrand-specific
93 options\fR]\fR
94 .ad
95 .sp .6
96 .RS 4n
97 The \fBattach\fR subcommand takes a zone that has been detached from one system
262
263 .sp
264 .ne 2
265 .na
266 \fB\fBhelp\fR [\fIsubcommand\fR]\fR
267 .ad
268 .sp .6
269 .RS 4n
270 Display general help. If you specify \fIsubcommand\fR, displays help on
271 \fIsubcommand\fR.
272 .RE
273
274 .sp
275 .ne 2
276 .na
277 \fB\fBinstall\fR [\fB-x\fR \fInodataset\fR] [\fIbrand-specific options\fR]\fR
278 .ad
279 .sp .6
280 .RS 4n
281 Install the specified zone on the system. This subcommand automatically
282 attempts to verify first. It refuses to install if the verify step fails. See
283 the \fBverify\fR subcommand.
284 .sp
285 .ne 2
286 .na
287 \fB\fB-x\fR \fInodataset\fR\fR
288 .ad
289 .sp .6
290 .RS 4n
291 Do not create a \fBZFS\fR file system.
292 .RE
293
294 The zone's brand may include additional options that govern how the software
295 will be installed in the zone. See \fBbrands\fR(5) for specific brand
296 information.
297 .RE
298
299 .sp
300 .ne 2
301 .na
302 \fB\fBlist\fR [\fIlist_options\fR]\fR
303 .ad
582 # \fBzoneadm boot -- -i /sbin/init\fR
583 .fi
584 .in -2
585 .sp
586
587 .LP
588 \fBExample 3 \fRUsing the \fB-s\fR Option
589 .sp
590 .LP
591 The following command illustrates the use of the \fB-s\fR option.
592
593 .sp
594 .in +2
595 .nf
596 # \fBzoneadm boot -- -s\fR
597 .fi
598 .in -2
599 .sp
600
601 .SH EXIT STATUS
602 .sp
603 .LP
604 The following exit values are returned:
605 .sp
606 .ne 2
607 .na
608 \fB\fB0\fR\fR
609 .ad
610 .sp .6
611 .RS 4n
612 Successful completion.
613 .RE
614
615 .sp
616 .ne 2
617 .na
618 \fB\fB1\fR\fR
619 .ad
620 .sp .6
621 .RS 4n
622 An error occurred.
623 .RE
624
625 .sp
626 .ne 2
627 .na
628 \fB\fB2\fR\fR
629 .ad
630 .sp .6
631 .RS 4n
632 Invalid usage.
633 .RE
634
635 .SH ATTRIBUTES
636 .sp
637 .LP
638 See \fBattributes\fR(5) for descriptions of the following attributes:
639 .sp
640
641 .sp
642 .TS
643 box;
644 c | c
645 l | l .
646 ATTRIBUTE TYPE ATTRIBUTE VALUE
647 _
648 Interface Stability Committed
649 .TE
650
651 .SH SEE ALSO
652 .sp
653 .LP
654 \fBread\fR(1), \fBsvcs\fR(1), \fBzlogin\fR(1), \fBzonename\fR(1),
655 \fBinit\fR(1M), \fBkernel\fR(1M), \fBsvcadm\fR(1M), \fBsvc.startd\fR(1M),
656 \fBsvc.startd\fR(1M), \fBzonecfg\fR(1M), \fBlibuuid\fR(3LIB),
657 \fBattributes\fR(5), \fBbrands\fR(5), \fBnative\fR(5), \fBsmf\fR(5),
658 \fBzones\fR(5)
659 .SH NOTES
660 .sp
661 .LP
662 The \fBzones\fR(5) service is managed by the service management facility,
663 \fBsmf\fR(5), under the service identifier:
664 .sp
665 .in +2
666 .nf
667 svc:/system/zones:default
668 .fi
669 .in -2
670 .sp
671
672 .sp
673 .LP
674 Administrative actions on this service, such as enabling, disabling, or
675 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
676 status can be queried using the \fBsvcs\fR(1) command.
677 .sp
678 .LP
679 The act of installing a new non-global zone is a fresh installation of the
680 Solaris operating system. A new installation of Solaris must not require
|
1 '\" te
2 .\" Copyright 2014 Nexenta Systems, Inc. All rights reserved.
3 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH ZONEADM 1M "Dec 26, 2014"
8 .SH NAME
9 zoneadm \- administer zones
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBzoneadm\fR \fB-z\fR \fIzonename\fR [\fB-u\fR \fIuuid-match\fR] \fIsubcommand\fR
14 [\fIsubcommand_options\fR]
15 .fi
16
17 .LP
18 .nf
19 \fBzoneadm\fR [\fB-R\fR \fIroot\fR] [\fB-z\fR \fIzonename\fR] [\fB-u\fR \fIuuid-match\fR] list
20 [\fIlist_options\fR]
21 .fi
22
23 .LP
24 .nf
25 \fBzoneadm\fR [\fB-R\fR \fIroot\fR] \fB-z\fR \fIzonename\fR [\fB-u\fR \fIuuid-match\fR] mark incomplete
26 .fi
27
28 .SH DESCRIPTION
29 .LP
30 The \fBzoneadm\fR utility is used to administer system zones. A zone is an
31 application container that is maintained by the operating system runtime.
32 .SH SECURITY
33 .LP
34 Once a process has been placed in a zone other than zone \fB0\fR, the process
35 or any of its children cannot change zones.
36 .SH OPTIONS
37 .LP
38 The following options are supported:
39 .sp
40 .ne 2
41 .na
42 \fB\fB-R\fR \fIroot\fR\fR
43 .ad
44 .sp .6
45 .RS 4n
46 Specify an alternate root (boot environment). This option can only be used in
47 conjunction with the "\fBlist\fR" and "\fBmark\fR" subcommands.
48 .RE
49
50 .sp
51 .ne 2
52 .na
53 \fB\fB-u\fR \fIuuid-match\fR\fR
54 .ad
55 .sp .6
56 .RS 4n
57 Unique identifier for a zone, as assigned by \fBlibuuid\fR(3LIB). If this
58 option is present and the argument is a non-empty string, then the zone
59 matching the \fBUUID\fR is selected instead of the one named by the \fB-z\fR
60 option, if such a zone is present.
61 .RE
62
63 .sp
64 .ne 2
65 .na
66 \fB\fB-z\fR \fIzonename\fR\fR
67 .ad
68 .sp .6
69 .RS 4n
70 String identifier for a zone.
71 .RE
72
73 .SH SUBCOMMANDS
74 .LP
75 Subcommands which can result in destructive actions or loss of work have a
76 \fB-F\fR flag to force the action. If input is from a terminal device, the user
77 is prompted if such a command is given without the \fB-F\fR flag; otherwise, if
78 such a command is given without the \fB-F\fR flag, the action is disallowed,
79 with a diagnostic message written to standard error. If a zone installation or
80 uninstallation is interrupted, the zone is left in the incomplete state. Use
81 uninstall to reset such a zone back to the configured state.
82 .sp
83 .LP
84 The following subcommands are supported:
85 .sp
86 .ne 2
87 .na
88 \fB\fBattach\fR [\fB-F\fR] [\fB-n\fR \fIpath\fR] [\fIbrand-specific
89 options\fR]\fR
90 .ad
91 .sp .6
92 .RS 4n
93 The \fBattach\fR subcommand takes a zone that has been detached from one system
258
259 .sp
260 .ne 2
261 .na
262 \fB\fBhelp\fR [\fIsubcommand\fR]\fR
263 .ad
264 .sp .6
265 .RS 4n
266 Display general help. If you specify \fIsubcommand\fR, displays help on
267 \fIsubcommand\fR.
268 .RE
269
270 .sp
271 .ne 2
272 .na
273 \fB\fBinstall\fR [\fB-x\fR \fInodataset\fR] [\fIbrand-specific options\fR]\fR
274 .ad
275 .sp .6
276 .RS 4n
277 Install the specified zone on the system. This subcommand automatically
278 attempts to verify first, most verification errors are fatal. See the
279 \fBverify\fR subcommand.
280 .sp
281 .ne 2
282 .na
283 \fB\fB-x\fR \fInodataset\fR\fR
284 .ad
285 .sp .6
286 .RS 4n
287 Do not create a \fBZFS\fR file system.
288 .RE
289
290 The zone's brand may include additional options that govern how the software
291 will be installed in the zone. See \fBbrands\fR(5) for specific brand
292 information.
293 .RE
294
295 .sp
296 .ne 2
297 .na
298 \fB\fBlist\fR [\fIlist_options\fR]\fR
299 .ad
578 # \fBzoneadm boot -- -i /sbin/init\fR
579 .fi
580 .in -2
581 .sp
582
583 .LP
584 \fBExample 3 \fRUsing the \fB-s\fR Option
585 .sp
586 .LP
587 The following command illustrates the use of the \fB-s\fR option.
588
589 .sp
590 .in +2
591 .nf
592 # \fBzoneadm boot -- -s\fR
593 .fi
594 .in -2
595 .sp
596
597 .SH EXIT STATUS
598 .LP
599 The following exit values are returned:
600 .sp
601 .ne 2
602 .na
603 \fB\fB0\fR\fR
604 .ad
605 .sp .6
606 .RS 4n
607 Successful completion.
608 .RE
609
610 .sp
611 .ne 2
612 .na
613 \fB\fB1\fR\fR
614 .ad
615 .sp .6
616 .RS 4n
617 An error occurred.
618 .RE
619
620 .sp
621 .ne 2
622 .na
623 \fB\fB2\fR\fR
624 .ad
625 .sp .6
626 .RS 4n
627 Invalid usage.
628 .RE
629
630 .SH ATTRIBUTES
631 .LP
632 See \fBattributes\fR(5) for descriptions of the following attributes:
633 .sp
634
635 .sp
636 .TS
637 box;
638 c | c
639 l | l .
640 ATTRIBUTE TYPE ATTRIBUTE VALUE
641 _
642 Interface Stability Committed
643 .TE
644
645 .SH SEE ALSO
646 .LP
647 \fBread\fR(1), \fBsvcs\fR(1), \fBzlogin\fR(1), \fBzonename\fR(1),
648 \fBinit\fR(1M), \fBkernel\fR(1M), \fBsvcadm\fR(1M), \fBsvc.startd\fR(1M),
649 \fBsvc.startd\fR(1M), \fBzonecfg\fR(1M), \fBlibuuid\fR(3LIB),
650 \fBattributes\fR(5), \fBbrands\fR(5), \fBnative\fR(5), \fBsmf\fR(5),
651 \fBzones\fR(5)
652 .SH NOTES
653 .LP
654 The \fBzones\fR(5) service is managed by the service management facility,
655 \fBsmf\fR(5), under the service identifier:
656 .sp
657 .in +2
658 .nf
659 svc:/system/zones:default
660 .fi
661 .in -2
662 .sp
663
664 .sp
665 .LP
666 Administrative actions on this service, such as enabling, disabling, or
667 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
668 status can be queried using the \fBsvcs\fR(1) command.
669 .sp
670 .LP
671 The act of installing a new non-global zone is a fresh installation of the
672 Solaris operating system. A new installation of Solaris must not require
|