Print this page
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man1m/zonecfg.1m
          +++ new/usr/src/man/man1m/zonecfg.1m
↓ open down ↓ 2 lines elided ↑ open up ↑ 
   3    3  .\" Copyright 2015 Joyent, Inc.
   4    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    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    6  .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7    7  .TH ZONECFG 1M "Nov 4, 2015"
   8    8  .SH NAME
   9    9  zonecfg \- set up zone configuration
  10   10  .SH SYNOPSIS
  11   11  .LP
  12   12  .nf
  13      -\fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR}
       13 +\fBzonecfg\fR \fB-z\fR \fIzonename\fR
  14   14  .fi
  15   15  
  16   16  .LP
  17   17  .nf
  18      -\fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} \fIsubcommand\fR
       18 +\fBzonecfg\fR \fB-z\fR \fIzonename\fR \fIsubcommand\fR
  19   19  .fi
  20   20  
  21   21  .LP
  22   22  .nf
  23      -\fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} \fB-f\fR \fIcommand_file\fR
       23 +\fBzonecfg\fR \fB-z\fR \fIzonename\fR \fB-f\fR \fIcommand_file\fR
  24   24  .fi
  25   25  
  26   26  .LP
  27   27  .nf
  28   28  \fBzonecfg\fR help
  29   29  .fi
  30   30  
  31   31  .SH DESCRIPTION
  32   32  .LP
  33   33  The \fBzonecfg\fR utility creates and modifies the configuration of a zone.
↓ open down ↓ 1 lines elided ↑ open up ↑ 
  35   35  .sp
  36   36  .LP
  37   37  To simplify the user interface, \fBzonecfg\fR uses the concept of a scope. The
  38   38  default scope is global.
  39   39  .sp
  40   40  .LP
  41   41  The following synopsis of the \fBzonecfg\fR command is for interactive usage:
  42   42  .sp
  43   43  .in +2
  44   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
       45 +zonecfg \fB-z\fR \fIzonename subcommand\fR
  47   46  .fi
  48   47  .in -2
  49   48  .sp
  50   49  
  51   50  .sp
  52   51  .LP
  53   52  Parameters changed through \fBzonecfg\fR do not affect a running zone. The zone
  54   53  must be rebooted for the changes to take effect.
  55   54  .sp
  56   55  .LP
↓ open down ↓ 271 lines elided ↑ open up ↑ 
 328  327  .B (global)
 329  328  .ad
 330  329  .sp .6
 331  330  .RS 4n
 332  331  .B fs-allowed
 333  332  .RE
 334  333  
 335  334  .sp
 336  335  .ne 2
 337  336  .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  337  \fB\fBfs\fR\fR
 349  338  .ad
 350  339  .sp .6
 351  340  .RS 4n
 352  341  \fBdir\fR, \fBspecial\fR, \fBraw\fR, \fBtype\fR, \fBoptions\fR
 353  342  .RE
 354  343  
 355  344  .sp
 356  345  .ne 2
 357  346  .na
 358  347  \fB\fBnet\fR\fR
 359  348  .ad
 360  349  .sp .6
 361  350  .RS 4n
 362      -\fBaddress\fR, \fBallowed-address\fR, \fBdefrouter\fR, \fBglobal-nic\fR, \fBmac-addr\fR, \fBphysical\fR, \fBproperty\fR, \fBvlan-id\fR
      351 +\fBaddress\fR, \fBphysical\fR, \fBdefrouter\fR
 363  352  .RE
 364  353  
 365  354  .sp
 366  355  .ne 2
 367  356  .na
 368  357  \fB\fBdevice\fR\fR
 369  358  .ad
 370  359  .sp .6
 371  360  .RS 4n
 372  361  \fBmatch\fR
↓ open down ↓ 242 lines elided ↑ open up ↑ 
 615  604  .ad
 616  605  .sp .6
 617  606  .RS 4n
 618  607  Values needed to determine how, where, and so forth to mount file systems. See
 619  608  \fBmount\fR(1M), \fBmount\fR(2), \fBfsck\fR(1M), and \fBvfstab\fR(4).
 620  609  .RE
 621  610  
 622  611  .sp
 623  612  .ne 2
 624  613  .na
 625      -\fB\fBinherit-pkg-dir\fR: dir\fR
      614 +\fB\fBnet\fR: address, physical, defrouter\fR
 626  615  .ad
 627  616  .sp .6
 628  617  .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  618  The network address and physical interface name of the network interface. The
 640  619  network address is one of:
 641  620  .RS +4
 642  621  .TP
 643  622  .ie t \(bu
 644  623  .el o
 645  624  a valid IPv4 address, optionally followed by "\fB/\fR" and a prefix length;
 646  625  .RE
 647  626  .RS +4
 648  627  .TP
↓ open down ↓ 15 lines elided ↑ open up ↑ 
 664  643  must not be followed by a \fB/\fR (slash) and a network prefix length.
 665  644  .sp
 666  645  A zone can be configured to be either exclusive-IP or shared-IP. For a
 667  646  shared-IP zone, you must set both the physical and address properties; setting
 668  647  the default router is optional. The interface specified in the physical
 669  648  property must be plumbed in the global zone prior to booting the non-global
 670  649  zone. However, if the interface is not used by the global zone, it should be
 671  650  configured \fBdown\fR in the global zone, and the default router for the
 672  651  interface should be specified here.
 673  652  .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  653  For an exclusive-IP zone, the physical property must be set and the address and
 679  654  default router properties cannot be set.
 680  655  .RE
 681  656  
 682  657  .sp
 683  658  .ne 2
 684  659  .na
 685  660  \fB\fBdevice\fR: match\fR
 686  661  .ad
 687  662  .sp .6
↓ open down ↓ 216 lines elided ↑ open up ↑ 
 904  879  
 905  880  This property does not apply to filesystems mounted into the zone via "add fs"
 906  881  or "add dataset".
 907  882  
 908  883  WARNING: allowing filesystem mounts other than the default may allow the zone
 909  884  administrator to compromise the system with a malicious filesystem image, and
 910  885  is not supported.
 911  886  .RE
 912  887  
 913  888  .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  889  .LP
 925  890  The following table summarizes resources, property-names, and types:
 926  891  .sp
 927  892  .in +2
 928  893  .nf
 929  894  resource          property-name   type
 930  895  (global)          zonename        simple
 931  896  (global)          zonepath        simple
 932  897  (global)          autoboot        simple
 933  898  (global)          bootargs        simple
↓ open down ↓ 2 lines elided ↑ open up ↑ 
 936  901  (global)          brand           simple
 937  902  (global)          ip-type         simple
 938  903  (global)          hostid          simple
 939  904  (global)          cpu-shares      simple
 940  905  (global)          max-lwps        simple
 941  906  (global)          max-msg-ids     simple
 942  907  (global)          max-sem-ids     simple
 943  908  (global)          max-shm-ids     simple
 944  909  (global)          max-shm-memory  simple
 945  910  (global)          scheduling-class simple
 946      -(global)          zfs-io-priority simple
 947  911  fs                dir             simple
 948  912                     special         simple
 949  913                     raw             simple
 950  914                     type            simple
 951  915                     options         list of simple
 952  916  net               address         simple
 953      -                   allowed-address simple
 954      -                   defrouter       simple
 955      -                   global-nic      simple
 956      -                   mac-addr        simple
 957  917                     physical        simple
 958      -                   property        list of complex
 959      -                    name            simple
 960      -                    value           simple
 961      -                   vlan-id         simple
 962  918  device            match           simple
 963  919  rctl              name            simple
 964  920                     value           list of complex
 965  921  attr              name            simple
 966  922                     type            simple
 967  923                     value           simple
 968  924  dataset           name            simple
 969  925  dedicated-cpu     ncpus           simple or range
 970  926                     importance      simple
 971  927
↓ open down ↓ 190 lines elided ↑ open up ↑ 
1162 1118  .ad
1163 1119  .sp .6
1164 1120  .RS 4n
1165 1121  Specify the name of a zone. Zone names are case sensitive. Zone names must
1166 1122  begin with an alphanumeric character and can contain alphanumeric characters,
1167 1123  the underscore (\fB_\fR) the hyphen (\fB-\fR), and the dot (\fB\&.\fR). The
1168 1124  name \fBglobal\fR and all names beginning with \fBSUNW\fR are reserved and
1169 1125  cannot be used.
1170 1126  .RE
1171 1127  
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 1128  .SH SUBCOMMANDS
1183 1129  .LP
1184 1130  You can use the \fBadd\fR and \fBselect\fR subcommands to select a specific
1185 1131  resource, at which point the scope changes to that resource. The \fBend\fR and
1186 1132  \fBcancel\fR subcommands are used to complete the resource specification, at
1187 1133  which time the scope is reverted back to global. Certain subcommands, such as
1188 1134  \fBadd\fR, \fBremove\fR and \fBset\fR, have different semantics in each scope.
1189 1135  .sp
1190 1136  .LP
1191 1137  \fBzonecfg\fR supports a semicolon-separated list of subcommands. For example:
↓ open down ↓ 69 lines elided ↑ open up ↑ 
1261 1207  configuration must be committed to be used by \fBzoneadm\fR. Until the
1262 1208  in-memory configuration is committed, you can remove changes with the
1263 1209  \fBrevert\fR subcommand. The \fBcommit\fR operation is attempted automatically
1264 1210  upon completion of a \fBzonecfg\fR session. Since a configuration must be
1265 1211  correct to be committed, this operation automatically does a verify.
1266 1212  .RE
1267 1213  
1268 1214  .sp
1269 1215  .ne 2
1270 1216  .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
     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
1272 1219  .ad
1273 1220  .sp .6
1274 1221  .RS 4n
1275 1222  Create an in-memory configuration for the specified zone. Use \fBcreate\fR to
1276 1223  begin to configure a new zone. See \fBcommit\fR for saving this to stable
1277 1224  storage.
1278 1225  .sp
1279 1226  If you are overwriting an existing configuration, specify the \fB-F\fR option
1280 1227  to force the action. Specify the \fB-t\fR \fItemplate\fR option to create a
1281 1228  configuration identical to \fItemplate\fR, where \fItemplate\fR is the name of
↓ open down ↓ 1 lines elided ↑ open up ↑ 
1283 1230  .sp
1284 1231  Use the \fB-a\fR \fIpath\fR option to facilitate configuring a detached zone on
1285 1232  a new host. The \fIpath\fR parameter is the zonepath location of a detached
1286 1233  zone that has been moved on to this new host. Once the detached zone is
1287 1234  configured, it should be installed using the "\fBzoneadm attach\fR" command
1288 1235  (see \fBzoneadm\fR(1M)). All validation of the new zone happens during the
1289 1236  \fBattach\fR process, not during zone configuration.
1290 1237  .sp
1291 1238  Use the \fB-b\fR option to create a blank configuration. Without arguments,
1292 1239  \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 1240  .RE
1296 1241  
1297 1242  .sp
1298 1243  .ne 2
1299 1244  .na
1300 1245  \fB\fBdelete [\fR\fB-F\fR\fB]\fR\fR
1301 1246  .ad
1302 1247  .sp .6
1303 1248  .RS 4n
1304 1249  Delete the specified configuration from memory and stable storage. This action
↓ open down ↓ 56 lines elided ↑ open up ↑ 
1361 1306  specified, displays only information about resources of the relevant type. If
1362 1307  any \fIproperty-name\fR value pairs are specified, displays only information
1363 1308  about resources meeting the given criteria. In the resource scope, any
1364 1309  arguments are ignored, and \fBinfo\fR displays information about the resource
1365 1310  which is currently being added or modified.
1366 1311  .RE
1367 1312  
1368 1313  .sp
1369 1314  .ne 2
1370 1315  .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
     1316 +\fB\fBremove\fR \fIresource-type\fR\fB{\fR\fIproperty-name\fR\fB=\fR\fIproperty
     1317 +-value\fR\fB}\fR(global scope)\fR
1374 1318  .ad
1375 1319  .sp .6
1376 1320  .RS 4n
1377 1321  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
     1322 +0 or more of whatever is inside the square braces. If you want only to remove a
1379 1323  single instance of the resource, you must specify enough property name-value
1380 1324  pairs for the resource to be uniquely identified. If no property name-value
1381 1325  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.
     1326 +pair is specified, a confirmation is required, unless you use the \fB-F\fR
     1327 +option.
1386 1328  .RE
1387 1329  
1388 1330  .sp
1389 1331  .ne 2
1390 1332  .na
1391 1333  \fB\fBselect\fR \fIresource-type\fR
1392 1334  \fB{\fR\fIproperty-name\fR\fB=\fR\fIproperty-value\fR\fB}\fR\fR
1393 1335  .ad
1394 1336  .sp .6
1395 1337  .RS 4n
↓ open down ↓ 530 lines elided ↑ open up ↑ 
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX