1 '\" te
2 .\" Copyright (c) 2004, 2009 Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 2015 Joyent, Inc.
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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
5 .\" See the License for the specific language governing permissions and limitations under the License. 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
6 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH ZONECFG 1M "Nov 4, 2015"
8 .SH NAME
9 zonecfg \- set up zone configuration
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR}
14 .fi
15
16 .LP
17 .nf
18 \fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} \fIsubcommand\fR
19 .fi
20
21 .LP
22 .nf
23 \fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} \fB-f\fR \fIcommand_file\fR
24 .fi
25
26 .LP
27 .nf
28 \fBzonecfg\fR help
29 .fi
30
31 .SH DESCRIPTION
32 .LP
33 The \fBzonecfg\fR utility creates and modifies the configuration of a zone.
34 Zone configuration consists of a number of resources and properties.
35 .sp
36 .LP
37 To simplify the user interface, \fBzonecfg\fR uses the concept of a scope. The
38 default scope is global.
39 .sp
40 .LP
41 The following synopsis of the \fBzonecfg\fR command is for interactive usage:
42 .sp
43 .in +2
44 .nf
45 {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR}
46 zonecfg {\fB-z\fR \fIzonename | \fB-u\fR \fIuuid} subcommand\fR
47 .fi
48 .in -2
49 .sp
50
51 .sp
52 .LP
53 Parameters changed through \fBzonecfg\fR do not affect a running zone. The zone
54 must be rebooted for the changes to take effect.
55 .sp
56 .LP
57 In addition to creating and modifying a zone, the \fBzonecfg\fR utility can
58 also be used to persistently specify the resource management settings for the
59 global zone.
60 .sp
61 .LP
62 In the following text, "rctl" is used as an abbreviation for "resource
63 control". See \fBresource_controls\fR(5).
64 .sp
65 .LP
66 Every zone is configured with an associated brand. The brand determines the
318 \fB(global)\fR
319 .ad
320 .sp .6
321 .RS 4n
322 \fBscheduling-class\fR
323 .RE
324
325 .sp
326 .ne 2
327 .na
328 .B (global)
329 .ad
330 .sp .6
331 .RS 4n
332 .B fs-allowed
333 .RE
334
335 .sp
336 .ne 2
337 .na
338 \fB(global)\fR
339 .ad
340 .sp .6
341 .RS 4n
342 \fBzfs-io-priority\fR
343 .RE
344
345 .sp
346 .ne 2
347 .na
348 \fB\fBfs\fR\fR
349 .ad
350 .sp .6
351 .RS 4n
352 \fBdir\fR, \fBspecial\fR, \fBraw\fR, \fBtype\fR, \fBoptions\fR
353 .RE
354
355 .sp
356 .ne 2
357 .na
358 \fB\fBnet\fR\fR
359 .ad
360 .sp .6
361 .RS 4n
362 \fBaddress\fR, \fBallowed-address\fR, \fBdefrouter\fR, \fBglobal-nic\fR, \fBmac-addr\fR, \fBphysical\fR, \fBproperty\fR, \fBvlan-id\fR
363 .RE
364
365 .sp
366 .ne 2
367 .na
368 \fB\fBdevice\fR\fR
369 .ad
370 .sp .6
371 .RS 4n
372 \fBmatch\fR
373 .RE
374
375 .sp
376 .ne 2
377 .na
378 \fB\fBrctl\fR\fR
379 .ad
380 .sp .6
381 .RS 4n
382 \fBname\fR, \fBvalue\fR
605 zone's \fBhostid\fR property is empty by default, meaning that the zone does
606 not emulate a host identifier. Zone host identifiers must be hexadecimal values
607 between 0 and FFFFFFFE. A \fB0x\fR or \fB0X\fR prefix is optional. Both
608 uppercase and lowercase hexadecimal digits are acceptable.
609 .RE
610
611 .sp
612 .ne 2
613 .na
614 \fB\fBfs\fR: dir, special, raw, type, options\fR
615 .ad
616 .sp .6
617 .RS 4n
618 Values needed to determine how, where, and so forth to mount file systems. See
619 \fBmount\fR(1M), \fBmount\fR(2), \fBfsck\fR(1M), and \fBvfstab\fR(4).
620 .RE
621
622 .sp
623 .ne 2
624 .na
625 \fB\fBinherit-pkg-dir\fR: dir\fR
626 .ad
627 .sp .6
628 .RS 4n
629 The directory path.
630 .RE
631
632 .sp
633 .ne 2
634 .na
635 \fB\fBnet\fR: address, allowed-address, defrouter, global-nic, mac-addr, physical, property, vlan-id\fR
636 .ad
637 .sp .6
638 .RS 4n
639 The network address and physical interface name of the network interface. The
640 network address is one of:
641 .RS +4
642 .TP
643 .ie t \(bu
644 .el o
645 a valid IPv4 address, optionally followed by "\fB/\fR" and a prefix length;
646 .RE
647 .RS +4
648 .TP
649 .ie t \(bu
650 .el o
651 a valid IPv6 address, which must be followed by "\fB/\fR" and a prefix length;
652 .RE
653 .RS +4
654 .TP
655 .ie t \(bu
656 .el o
657 a host name which resolves to an IPv4 address.
658 .RE
659 Note that host names that resolve to IPv6 addresses are not supported.
660 .sp
661 The physical interface name is the network interface name.
662 .sp
663 The default router is specified similarly to the network address except that it
664 must not be followed by a \fB/\fR (slash) and a network prefix length.
665 .sp
666 A zone can be configured to be either exclusive-IP or shared-IP. For a
667 shared-IP zone, you must set both the physical and address properties; setting
668 the default router is optional. The interface specified in the physical
669 property must be plumbed in the global zone prior to booting the non-global
670 zone. However, if the interface is not used by the global zone, it should be
671 configured \fBdown\fR in the global zone, and the default router for the
672 interface should be specified here.
673 .sp
674 The global-nic is used for exclusive stack zones which will use a VNIC on-demand. When the zone boots, a VNIC named using the physical property will be created on the global NIC. If provided, the mac-addr and vlan-id will be set on this VNIC.
675 .sp
676 The \fBproperty\fR setting is a resource which can be used to set arbitrary name/value pairs on the network. These name/value pairs are made available to the zone's brand, which can use them as needed to set up the network interface.
677 .sp
678 For an exclusive-IP zone, the physical property must be set and the address and
679 default router properties cannot be set.
680 .RE
681
682 .sp
683 .ne 2
684 .na
685 \fB\fBdevice\fR: match\fR
686 .ad
687 .sp .6
688 .RS 4n
689 Device name to match.
690 .RE
691
692 .sp
693 .ne 2
694 .na
695 \fB\fBrctl\fR: name, value\fR
696 .ad
697 .sp .6
894 .na
895 \fBglobal: \fBfs-allowed\fR\fR
896 .ad
897 .sp .6
898 .RS 4n
899 A comma-separated list of additional filesystems that may be mounted within
900 the zone; for example "ufs,pcfs". By default, only hsfs(7fs) and network
901 filesystems can be mounted. If the first entry in the list is "-" then
902 that disables all of the default filesystems. If any filesystems are listed
903 after "-" then only those filesystems can be mounted.
904
905 This property does not apply to filesystems mounted into the zone via "add fs"
906 or "add dataset".
907
908 WARNING: allowing filesystem mounts other than the default may allow the zone
909 administrator to compromise the system with a malicious filesystem image, and
910 is not supported.
911 .RE
912
913 .sp
914 .ne 2
915 .na
916 \fBglobal: \fBzfs-io-priority\fR\fR
917 .ad
918 .sp .6
919 .RS 4n
920 Specifies a priority for this zone's ZFS I/O. The priority is used by the ZFS I/O scheduler as in input to determine how to schedule I/O across zones. By default all zones have a priority of 1. The value can be increased for zones whose I/O is more critical. This property is the preferred way to set the \fBzone.zfs-io-priority\fR rctl.
921 .RE
922
923 .sp
924 .LP
925 The following table summarizes resources, property-names, and types:
926 .sp
927 .in +2
928 .nf
929 resource property-name type
930 (global) zonename simple
931 (global) zonepath simple
932 (global) autoboot simple
933 (global) bootargs simple
934 (global) pool simple
935 (global) limitpriv simple
936 (global) brand simple
937 (global) ip-type simple
938 (global) hostid simple
939 (global) cpu-shares simple
940 (global) max-lwps simple
941 (global) max-msg-ids simple
942 (global) max-sem-ids simple
943 (global) max-shm-ids simple
944 (global) max-shm-memory simple
945 (global) scheduling-class simple
946 (global) zfs-io-priority simple
947 fs dir simple
948 special simple
949 raw simple
950 type simple
951 options list of simple
952 net address simple
953 allowed-address simple
954 defrouter simple
955 global-nic simple
956 mac-addr simple
957 physical simple
958 property list of complex
959 name simple
960 value simple
961 vlan-id simple
962 device match simple
963 rctl name simple
964 value list of complex
965 attr name simple
966 type simple
967 value simple
968 dataset name simple
969 dedicated-cpu ncpus simple or range
970 importance simple
971
972 capped-memory physical simple with scale
973 swap simple with scale
974 locked simple with scale
975
976 capped-cpu ncpus simple
977 .fi
978 .in -2
979 .sp
980
981 .sp
1152 .sp .6
1153 .RS 4n
1154 Specify the name of \fBzonecfg\fR command file. \fIcommand_file\fR is a text
1155 file of \fBzonecfg\fR subcommands, one per line.
1156 .RE
1157
1158 .sp
1159 .ne 2
1160 .na
1161 \fB\fB-z\fR \fIzonename\fR\fR
1162 .ad
1163 .sp .6
1164 .RS 4n
1165 Specify the name of a zone. Zone names are case sensitive. Zone names must
1166 begin with an alphanumeric character and can contain alphanumeric characters,
1167 the underscore (\fB_\fR) the hyphen (\fB-\fR), and the dot (\fB\&.\fR). The
1168 name \fBglobal\fR and all names beginning with \fBSUNW\fR are reserved and
1169 cannot be used.
1170 .RE
1171
1172 .sp
1173 .ne 2
1174 .na
1175 \fB\fB-u\fR \fIuuid\fR\fR
1176 .ad
1177 .sp .6
1178 .RS 4n
1179 Specify the uuid of a zone instead of the Zone name.
1180 .RE
1181
1182 .SH SUBCOMMANDS
1183 .LP
1184 You can use the \fBadd\fR and \fBselect\fR subcommands to select a specific
1185 resource, at which point the scope changes to that resource. The \fBend\fR and
1186 \fBcancel\fR subcommands are used to complete the resource specification, at
1187 which time the scope is reverted back to global. Certain subcommands, such as
1188 \fBadd\fR, \fBremove\fR and \fBset\fR, have different semantics in each scope.
1189 .sp
1190 .LP
1191 \fBzonecfg\fR supports a semicolon-separated list of subcommands. For example:
1192 .sp
1193 .in +2
1194 .nf
1195 # \fBzonecfg -z myzone "add net; set physical=myvnic; end"\fR
1196 .fi
1197 .in -2
1198 .sp
1199
1200 .sp
1201 .LP
1251 .RE
1252
1253 .sp
1254 .ne 2
1255 .na
1256 \fB\fBcommit\fR\fR
1257 .ad
1258 .sp .6
1259 .RS 4n
1260 Commit the current configuration from memory to stable storage. The
1261 configuration must be committed to be used by \fBzoneadm\fR. Until the
1262 in-memory configuration is committed, you can remove changes with the
1263 \fBrevert\fR subcommand. The \fBcommit\fR operation is attempted automatically
1264 upon completion of a \fBzonecfg\fR session. Since a configuration must be
1265 correct to be committed, this operation automatically does a verify.
1266 .RE
1267
1268 .sp
1269 .ne 2
1270 .na
1271 \fB\fBcreate [\fR\fB-F\fR\fB] [\fR \fB-a\fR \fIpath\fR |\fB-b\fR \fB|\fR \fB-t\fR \fItemplate\fR\fB] [\fR\fB-X\fR\fB]\fR\fR
1272 .ad
1273 .sp .6
1274 .RS 4n
1275 Create an in-memory configuration for the specified zone. Use \fBcreate\fR to
1276 begin to configure a new zone. See \fBcommit\fR for saving this to stable
1277 storage.
1278 .sp
1279 If you are overwriting an existing configuration, specify the \fB-F\fR option
1280 to force the action. Specify the \fB-t\fR \fItemplate\fR option to create a
1281 configuration identical to \fItemplate\fR, where \fItemplate\fR is the name of
1282 a configured zone.
1283 .sp
1284 Use the \fB-a\fR \fIpath\fR option to facilitate configuring a detached zone on
1285 a new host. The \fIpath\fR parameter is the zonepath location of a detached
1286 zone that has been moved on to this new host. Once the detached zone is
1287 configured, it should be installed using the "\fBzoneadm attach\fR" command
1288 (see \fBzoneadm\fR(1M)). All validation of the new zone happens during the
1289 \fBattach\fR process, not during zone configuration.
1290 .sp
1291 Use the \fB-b\fR option to create a blank configuration. Without arguments,
1292 \fBcreate\fR applies the Sun default settings.
1293 .sp
1294 Use the \fB-X\fR option to facilitate creating a zone whose XML definition already exists on the host. The zone will be atomically added to the zone index file.
1295 .RE
1296
1297 .sp
1298 .ne 2
1299 .na
1300 \fB\fBdelete [\fR\fB-F\fR\fB]\fR\fR
1301 .ad
1302 .sp .6
1303 .RS 4n
1304 Delete the specified configuration from memory and stable storage. This action
1305 is instantaneous, no commit is necessary. A deleted configuration cannot be
1306 reverted.
1307 .sp
1308 Specify the \fB-F\fR option to force the action.
1309 .RE
1310
1311 .sp
1312 .ne 2
1313 .na
1314 \fB\fBend\fR\fR
1351 \fB\fBinfo zonename | zonepath | autoboot | brand | pool | limitpriv\fR\fR
1352 .ad
1353 .br
1354 .na
1355 \fB\fBinfo [\fR\fIresource-type\fR
1356 \fB[\fR\fIproperty-name\fR\fB=\fR\fIproperty-value\fR\fB]*]\fR\fR
1357 .ad
1358 .sp .6
1359 .RS 4n
1360 Display information about the current configuration. If \fIresource-type\fR is
1361 specified, displays only information about resources of the relevant type. If
1362 any \fIproperty-name\fR value pairs are specified, displays only information
1363 about resources meeting the given criteria. In the resource scope, any
1364 arguments are ignored, and \fBinfo\fR displays information about the resource
1365 which is currently being added or modified.
1366 .RE
1367
1368 .sp
1369 .ne 2
1370 .na
1371 \fB\fBremove\fR [\fR\fB-F\fR\fB] \fIresource-type\fR\fB [\fR\fIproperty-name\fR\fB=\fR\fIproperty-value\fR\fB]* \fR(global scope)\fR
1372 .br
1373 \fB\fBremove\fR \fR\fIproperty-name\fR\fB \fR\fIproperty-value\fR\fB \fR(resource scope)\fR
1374 .ad
1375 .sp .6
1376 .RS 4n
1377 In the global scope, removes the specified resource. The \fB[]\fR syntax means
1378 0 or more property name-value pairs. If you want to only remove a
1379 single instance of the resource, you must specify enough property name-value
1380 pairs for the resource to be uniquely identified. If no property name-value
1381 pairs are specified, all instances will be removed. If there is more than one
1382 pair specified, a confirmation is required, unless you use the \fB-F\fR
1383 option. Likewise, the \fB-F\fR option can be used to remove a resource that
1384 does not exist (that is, no error will occur). In the resource scope, remove
1385 the specified name-value pair.
1386 .RE
1387
1388 .sp
1389 .ne 2
1390 .na
1391 \fB\fBselect\fR \fIresource-type\fR
1392 \fB{\fR\fIproperty-name\fR\fB=\fR\fIproperty-value\fR\fB}\fR\fR
1393 .ad
1394 .sp .6
1395 .RS 4n
1396 Select the resource of the given type which matches the given
1397 \fIproperty-name\fR \fIproperty-value\fR pair criteria, for modification. This
1398 subcommand is applicable only in the global scope. The scope is changed to that
1399 resource type. The \fB{}\fR syntax means 1 or more of whatever is inside the
1400 curly braces. You must specify enough \fIproperty -name property-value\fR pairs
1401 for the resource to be uniquely identified.
1402 .RE
1403
1404 .sp
1405 .ne 2
|
1 '\" te
2 .\" Copyright (c) 2004, 2009 Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 2015 Joyent, Inc.
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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
5 .\" See the License for the specific language governing permissions and limitations under the License. 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
6 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH ZONECFG 1M "Nov 4, 2015"
8 .SH NAME
9 zonecfg \- set up zone configuration
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBzonecfg\fR \fB-z\fR \fIzonename\fR
14 .fi
15
16 .LP
17 .nf
18 \fBzonecfg\fR \fB-z\fR \fIzonename\fR \fIsubcommand\fR
19 .fi
20
21 .LP
22 .nf
23 \fBzonecfg\fR \fB-z\fR \fIzonename\fR \fB-f\fR \fIcommand_file\fR
24 .fi
25
26 .LP
27 .nf
28 \fBzonecfg\fR help
29 .fi
30
31 .SH DESCRIPTION
32 .LP
33 The \fBzonecfg\fR utility creates and modifies the configuration of a zone.
34 Zone configuration consists of a number of resources and properties.
35 .sp
36 .LP
37 To simplify the user interface, \fBzonecfg\fR uses the concept of a scope. The
38 default scope is global.
39 .sp
40 .LP
41 The following synopsis of the \fBzonecfg\fR command is for interactive usage:
42 .sp
43 .in +2
44 .nf
45 zonecfg \fB-z\fR \fIzonename subcommand\fR
46 .fi
47 .in -2
48 .sp
49
50 .sp
51 .LP
52 Parameters changed through \fBzonecfg\fR do not affect a running zone. The zone
53 must be rebooted for the changes to take effect.
54 .sp
55 .LP
56 In addition to creating and modifying a zone, the \fBzonecfg\fR utility can
57 also be used to persistently specify the resource management settings for the
58 global zone.
59 .sp
60 .LP
61 In the following text, "rctl" is used as an abbreviation for "resource
62 control". See \fBresource_controls\fR(5).
63 .sp
64 .LP
65 Every zone is configured with an associated brand. The brand determines the
317 \fB(global)\fR
318 .ad
319 .sp .6
320 .RS 4n
321 \fBscheduling-class\fR
322 .RE
323
324 .sp
325 .ne 2
326 .na
327 .B (global)
328 .ad
329 .sp .6
330 .RS 4n
331 .B fs-allowed
332 .RE
333
334 .sp
335 .ne 2
336 .na
337 \fB\fBfs\fR\fR
338 .ad
339 .sp .6
340 .RS 4n
341 \fBdir\fR, \fBspecial\fR, \fBraw\fR, \fBtype\fR, \fBoptions\fR
342 .RE
343
344 .sp
345 .ne 2
346 .na
347 \fB\fBnet\fR\fR
348 .ad
349 .sp .6
350 .RS 4n
351 \fBaddress\fR, \fBphysical\fR, \fBdefrouter\fR
352 .RE
353
354 .sp
355 .ne 2
356 .na
357 \fB\fBdevice\fR\fR
358 .ad
359 .sp .6
360 .RS 4n
361 \fBmatch\fR
362 .RE
363
364 .sp
365 .ne 2
366 .na
367 \fB\fBrctl\fR\fR
368 .ad
369 .sp .6
370 .RS 4n
371 \fBname\fR, \fBvalue\fR
594 zone's \fBhostid\fR property is empty by default, meaning that the zone does
595 not emulate a host identifier. Zone host identifiers must be hexadecimal values
596 between 0 and FFFFFFFE. A \fB0x\fR or \fB0X\fR prefix is optional. Both
597 uppercase and lowercase hexadecimal digits are acceptable.
598 .RE
599
600 .sp
601 .ne 2
602 .na
603 \fB\fBfs\fR: dir, special, raw, type, options\fR
604 .ad
605 .sp .6
606 .RS 4n
607 Values needed to determine how, where, and so forth to mount file systems. See
608 \fBmount\fR(1M), \fBmount\fR(2), \fBfsck\fR(1M), and \fBvfstab\fR(4).
609 .RE
610
611 .sp
612 .ne 2
613 .na
614 \fB\fBnet\fR: address, physical, defrouter\fR
615 .ad
616 .sp .6
617 .RS 4n
618 The network address and physical interface name of the network interface. The
619 network address is one of:
620 .RS +4
621 .TP
622 .ie t \(bu
623 .el o
624 a valid IPv4 address, optionally followed by "\fB/\fR" and a prefix length;
625 .RE
626 .RS +4
627 .TP
628 .ie t \(bu
629 .el o
630 a valid IPv6 address, which must be followed by "\fB/\fR" and a prefix length;
631 .RE
632 .RS +4
633 .TP
634 .ie t \(bu
635 .el o
636 a host name which resolves to an IPv4 address.
637 .RE
638 Note that host names that resolve to IPv6 addresses are not supported.
639 .sp
640 The physical interface name is the network interface name.
641 .sp
642 The default router is specified similarly to the network address except that it
643 must not be followed by a \fB/\fR (slash) and a network prefix length.
644 .sp
645 A zone can be configured to be either exclusive-IP or shared-IP. For a
646 shared-IP zone, you must set both the physical and address properties; setting
647 the default router is optional. The interface specified in the physical
648 property must be plumbed in the global zone prior to booting the non-global
649 zone. However, if the interface is not used by the global zone, it should be
650 configured \fBdown\fR in the global zone, and the default router for the
651 interface should be specified here.
652 .sp
653 For an exclusive-IP zone, the physical property must be set and the address and
654 default router properties cannot be set.
655 .RE
656
657 .sp
658 .ne 2
659 .na
660 \fB\fBdevice\fR: match\fR
661 .ad
662 .sp .6
663 .RS 4n
664 Device name to match.
665 .RE
666
667 .sp
668 .ne 2
669 .na
670 \fB\fBrctl\fR: name, value\fR
671 .ad
672 .sp .6
869 .na
870 \fBglobal: \fBfs-allowed\fR\fR
871 .ad
872 .sp .6
873 .RS 4n
874 A comma-separated list of additional filesystems that may be mounted within
875 the zone; for example "ufs,pcfs". By default, only hsfs(7fs) and network
876 filesystems can be mounted. If the first entry in the list is "-" then
877 that disables all of the default filesystems. If any filesystems are listed
878 after "-" then only those filesystems can be mounted.
879
880 This property does not apply to filesystems mounted into the zone via "add fs"
881 or "add dataset".
882
883 WARNING: allowing filesystem mounts other than the default may allow the zone
884 administrator to compromise the system with a malicious filesystem image, and
885 is not supported.
886 .RE
887
888 .sp
889 .LP
890 The following table summarizes resources, property-names, and types:
891 .sp
892 .in +2
893 .nf
894 resource property-name type
895 (global) zonename simple
896 (global) zonepath simple
897 (global) autoboot simple
898 (global) bootargs simple
899 (global) pool simple
900 (global) limitpriv simple
901 (global) brand simple
902 (global) ip-type simple
903 (global) hostid simple
904 (global) cpu-shares simple
905 (global) max-lwps simple
906 (global) max-msg-ids simple
907 (global) max-sem-ids simple
908 (global) max-shm-ids simple
909 (global) max-shm-memory simple
910 (global) scheduling-class simple
911 fs dir simple
912 special simple
913 raw simple
914 type simple
915 options list of simple
916 net address simple
917 physical simple
918 device match simple
919 rctl name simple
920 value list of complex
921 attr name simple
922 type simple
923 value simple
924 dataset name simple
925 dedicated-cpu ncpus simple or range
926 importance simple
927
928 capped-memory physical simple with scale
929 swap simple with scale
930 locked simple with scale
931
932 capped-cpu ncpus simple
933 .fi
934 .in -2
935 .sp
936
937 .sp
1108 .sp .6
1109 .RS 4n
1110 Specify the name of \fBzonecfg\fR command file. \fIcommand_file\fR is a text
1111 file of \fBzonecfg\fR subcommands, one per line.
1112 .RE
1113
1114 .sp
1115 .ne 2
1116 .na
1117 \fB\fB-z\fR \fIzonename\fR\fR
1118 .ad
1119 .sp .6
1120 .RS 4n
1121 Specify the name of a zone. Zone names are case sensitive. Zone names must
1122 begin with an alphanumeric character and can contain alphanumeric characters,
1123 the underscore (\fB_\fR) the hyphen (\fB-\fR), and the dot (\fB\&.\fR). The
1124 name \fBglobal\fR and all names beginning with \fBSUNW\fR are reserved and
1125 cannot be used.
1126 .RE
1127
1128 .SH SUBCOMMANDS
1129 .LP
1130 You can use the \fBadd\fR and \fBselect\fR subcommands to select a specific
1131 resource, at which point the scope changes to that resource. The \fBend\fR and
1132 \fBcancel\fR subcommands are used to complete the resource specification, at
1133 which time the scope is reverted back to global. Certain subcommands, such as
1134 \fBadd\fR, \fBremove\fR and \fBset\fR, have different semantics in each scope.
1135 .sp
1136 .LP
1137 \fBzonecfg\fR supports a semicolon-separated list of subcommands. For example:
1138 .sp
1139 .in +2
1140 .nf
1141 # \fBzonecfg -z myzone "add net; set physical=myvnic; end"\fR
1142 .fi
1143 .in -2
1144 .sp
1145
1146 .sp
1147 .LP
1197 .RE
1198
1199 .sp
1200 .ne 2
1201 .na
1202 \fB\fBcommit\fR\fR
1203 .ad
1204 .sp .6
1205 .RS 4n
1206 Commit the current configuration from memory to stable storage. The
1207 configuration must be committed to be used by \fBzoneadm\fR. Until the
1208 in-memory configuration is committed, you can remove changes with the
1209 \fBrevert\fR subcommand. The \fBcommit\fR operation is attempted automatically
1210 upon completion of a \fBzonecfg\fR session. Since a configuration must be
1211 correct to be committed, this operation automatically does a verify.
1212 .RE
1213
1214 .sp
1215 .ne 2
1216 .na
1217 \fB\fBcreate [\fR\fB-F\fR\fB] [\fR \fB-a\fR \fIpath\fR |\fB-b\fR \fB|\fR
1218 \fB-t\fR \fItemplate\fR\fB]\fR\fR
1219 .ad
1220 .sp .6
1221 .RS 4n
1222 Create an in-memory configuration for the specified zone. Use \fBcreate\fR to
1223 begin to configure a new zone. See \fBcommit\fR for saving this to stable
1224 storage.
1225 .sp
1226 If you are overwriting an existing configuration, specify the \fB-F\fR option
1227 to force the action. Specify the \fB-t\fR \fItemplate\fR option to create a
1228 configuration identical to \fItemplate\fR, where \fItemplate\fR is the name of
1229 a configured zone.
1230 .sp
1231 Use the \fB-a\fR \fIpath\fR option to facilitate configuring a detached zone on
1232 a new host. The \fIpath\fR parameter is the zonepath location of a detached
1233 zone that has been moved on to this new host. Once the detached zone is
1234 configured, it should be installed using the "\fBzoneadm attach\fR" command
1235 (see \fBzoneadm\fR(1M)). All validation of the new zone happens during the
1236 \fBattach\fR process, not during zone configuration.
1237 .sp
1238 Use the \fB-b\fR option to create a blank configuration. Without arguments,
1239 \fBcreate\fR applies the Sun default settings.
1240 .RE
1241
1242 .sp
1243 .ne 2
1244 .na
1245 \fB\fBdelete [\fR\fB-F\fR\fB]\fR\fR
1246 .ad
1247 .sp .6
1248 .RS 4n
1249 Delete the specified configuration from memory and stable storage. This action
1250 is instantaneous, no commit is necessary. A deleted configuration cannot be
1251 reverted.
1252 .sp
1253 Specify the \fB-F\fR option to force the action.
1254 .RE
1255
1256 .sp
1257 .ne 2
1258 .na
1259 \fB\fBend\fR\fR
1296 \fB\fBinfo zonename | zonepath | autoboot | brand | pool | limitpriv\fR\fR
1297 .ad
1298 .br
1299 .na
1300 \fB\fBinfo [\fR\fIresource-type\fR
1301 \fB[\fR\fIproperty-name\fR\fB=\fR\fIproperty-value\fR\fB]*]\fR\fR
1302 .ad
1303 .sp .6
1304 .RS 4n
1305 Display information about the current configuration. If \fIresource-type\fR is
1306 specified, displays only information about resources of the relevant type. If
1307 any \fIproperty-name\fR value pairs are specified, displays only information
1308 about resources meeting the given criteria. In the resource scope, any
1309 arguments are ignored, and \fBinfo\fR displays information about the resource
1310 which is currently being added or modified.
1311 .RE
1312
1313 .sp
1314 .ne 2
1315 .na
1316 \fB\fBremove\fR \fIresource-type\fR\fB{\fR\fIproperty-name\fR\fB=\fR\fIproperty
1317 -value\fR\fB}\fR(global scope)\fR
1318 .ad
1319 .sp .6
1320 .RS 4n
1321 In the global scope, removes the specified resource. The \fB[]\fR syntax means
1322 0 or more of whatever is inside the square braces. If you want only to remove a
1323 single instance of the resource, you must specify enough property name-value
1324 pairs for the resource to be uniquely identified. If no property name-value
1325 pairs are specified, all instances will be removed. If there is more than one
1326 pair is specified, a confirmation is required, unless you use the \fB-F\fR
1327 option.
1328 .RE
1329
1330 .sp
1331 .ne 2
1332 .na
1333 \fB\fBselect\fR \fIresource-type\fR
1334 \fB{\fR\fIproperty-name\fR\fB=\fR\fIproperty-value\fR\fB}\fR\fR
1335 .ad
1336 .sp .6
1337 .RS 4n
1338 Select the resource of the given type which matches the given
1339 \fIproperty-name\fR \fIproperty-value\fR pair criteria, for modification. This
1340 subcommand is applicable only in the global scope. The scope is changed to that
1341 resource type. The \fB{}\fR syntax means 1 or more of whatever is inside the
1342 curly braces. You must specify enough \fIproperty -name property-value\fR pairs
1343 for the resource to be uniquely identified.
1344 .RE
1345
1346 .sp
1347 .ne 2
|