mkwpar Command
Purpose
Creates a system workload partition (WPAR), or a WPAR specification file.
Syntax
/usr/sbin/mkwpar [-a] [-A] [-b devexportsfile ] [-c] [-C] [-E directory] [-d directory ] [-B wparbackupdevice] [-D attribute=value ...] ... [-F] [-g vg ] [-h hostname] [-H architecture] [-i] [-I attribute=value ...] [ -k]... [-l] [-L attribute=value...] [-M attribute=value ...] ... [-N attribute=value ...] ... [-P] [-r] [-R attribute=value ...] [-S attribute[+|-]=value ...] [-t ] [ -T attribute=value ... ] [-s] [-u userscript] [-X attribute=value ...] [-U [uuid]] { -n wparname [-p [name]] [-e existingwparname -W | -f infile] [-o outfile [-w]] | -p [name] [-n wparname] [-e existingwparname -W | -f infile] [-o outfile [-w]] | -f infile [-n wparname] [-p [name]] [-o outfile [-w]] | -w -o outfile [-n wparname] [-p [name]] [-e existingwparname -W | -f infile] }
- White space must be included between a flag and its argument for attribute=value type flags. The mkwpar command is not supported on the TCB systems. Regardless of locale, only ASCII characters are allowed as arguments to mkwpar, chwpar, or wparexec.
- You must not run the mkwpar command during the AIX® Live Update operation.
- Must not be more than 25 bytes.
- Must not contain white space or any of the following symbols:
= : / ! ; ` ' " < > ~ & ( ) * + [ ] , . ^ 0 { } | \
- Must not start with hyphen (-) or 0.
Description
- Creating the configuration data of the workload partition in the workload partition database
- Creating and populating file systems of the workload partition
- Creating an SRC subsystem for the init process of the workload partition
- Defining the resource control profile of the workload partition through Workload Manager
- Writing a specification file to simplify creation of other, similar workload partitions
- Starting the workload partitions
- Specifying whether the workload partitions must be automatically started on system start or when /etc/rc.wpars is started
- Specifying WPAR specific routing, by using the -i and -I flags
The mkwpar command supports advanced logical volume and file system options by specifying the image.data file as an argument to the mkwpar -L flag.
The mkwpar command supports creating a rootvg WPAR, in which the root file systems are located solely in WPAR storage devices.
Flags
Item | Description | ||
---|---|---|---|
-a | Automatically resolves conflicting static settings if required. Resolvable settings are base directory, host name, and network configuration. |
||
-A | Specifies that the workload partition must be started each time /etc/rc.wpars is run, which is added to the global /etc/inittab to run each time that the system starts. The default is not to start the workload partition automatically. Tip: The workload partition is started immediately
upon completion of the mkwpar command. To start the workload partition immediately, use
the -s flag.
|
||
-b devexportsfile | Specifies an alternative file to use as the master device exports file. This file must match the format of a Device Exports File. If you do not specify a file name, /etc/wpars/devexports is used. | ||
-B wparbackupdevice | Specifies a device that contains
a workload partition backup image.
This image is used to populate the workload partition file systems.
The wparBackupDevice parameter is a workload partition image that is
created with the savewpar, mkcd, or mkdvd command.
The -B flag is used by the restwpar command as part
of the process of creating a workload partition from a backup
image. Note: The -B flag is mutually exclusive
with the -p flag.
|
||
-c | Configures the workload partition to be checkpointable. This option is valid only when more checkpoints or restart software are installed and configured. When you specify this flag, any file systems that are associated with only this flag (for example, through the -M flag) must be remote (for example, vfs=nfs). | ||
-C | Creates a versioned workload partition. This option is valid only when more versioned workload partition software is installed. | ||
-d directory | Specifies a base directory for the workload partition. If you do not specify a directory name, /wpars/<wparname> is used. | ||
-D [devname=device name | devid=device identifier] [rootvg=yes | no] [devtype=[clone | pseudo | disk | adapter | cdrom | tape]] | Configures exporting or virtualization
of a global device into the workload partition every time the
system starts. You can specify more than one -D flag to allocate
multiple devices. Separate the attribute=value by blank spaces. You
can specify the following attributes for the -D flag:
|
||
-e existingwparname | Uses an existing workload partition as the source for specification data. This flag is mutually exclusive with the -f flag. Any values that you specify using other mkwpar flags override those from the existing workload partition. | ||
-E | Specifies a directory which
contains additional filesets to install when a versioned workload partition is created. If
you do not specify a directory name, /usr/sys/inst.images is
used. This option is used only during creation of a versioned WPAR. |
||
-f infile | Indicates a specification file from which default values are read. This flag is mutually exclusive with the -e flag. Any values that you specify by using other mkwpar flags, override those flags from the loaded specification file. | ||
-F | Forces the command to continue rather than fail for most error conditions. | ||
-g vg | Indicates the default volume
group. If you do not specify a value, rootvg is used. This volume
group is used for each localfs file system whose volume group is not
specified by using the vg parameter of the -M flag. The volume group for file systems that you specified in the image.data file, supersedes the volume group that is specified with the -g flag. |
||
-h hostname | Specifies a host name for the workload partition. you do not specify a value, the mkwpar command uses the workload partition name for the host name. | ||
-H architecture | Creates an architecture compatible
workload partition. The valid architecture values are {pwr4,
ppc970, pwr5, pwr6, pwr7, and pwr8}. The architecture value must
be lower than, or equal to, the system hardware level. The applications
in the workload partition are presented with the lowest common denominator
of the specified architecture. If the workload partition is checkpointable,
the workload partition must be able to migrate between systems with
hardware levels greater than, or equal to, the workload partition
architecture. Note: Values pwr5 and ppc970 are
not compatible with each other. You cannot create a ppc970 compatible
WPAR on a POWER5 processor-based system even though the ppc970 processor
preceded the POWER 5 processor.
|
||
-i | Enables WPAR
specific routing for the workload partition. A default route is not created automatically. The -I flag is used to specify routes, including the default route. By default, outgoing network traffic from a workload partition is routed as if it is being sent from the global environment:
If you enable WPAR specific routing by specifying the -i flag, the workload partition creates and uses its own routing table for outgoing traffic. Routing entries are created automatically for each of the network addresses of the workload partition to accommodate broadcast, loopback, and subnet routes. For more information about the network attributes, see the -N flag. You can create explicit additions to the routing table of the workload partition using the -I flag. |
||
-I attribute=value ... | Adds routing table entries
to those tables that are automatically created when WPAR specific routing is
in effect. You can specify more than one -I flag to configure
multiple routes. Using the -I flag automatically enables WPAR specific routing as
described under the -i flag. You can specify the following attributes with the -I flag: |
||
rtdest=destination | (Required) Identifies the host or network to which you are directing the route. You can specify the value by using either symbolic name or numeric address. You can use the keyword default to specify a default route. For more information about the route rtdest attribute, see the Destination parameter of the route command. | ||
rtgateway=gateway | (Required) Identifies the gateway to which packets are addressed. You can specify the value by using either symbolic name or numeric address. | ||
rtnetmask=A.B.C.D | Specifies the network mask to the destination address. | ||
rtprefixlen=n | Specifies the length of a destination prefix, which is the number of bits in the netmask. The value must be a positive integer. | ||
rttype={net|host} | Forces the rtdest attribute to be interpreted as the specified type. | ||
rtinterface=if | Specifies the interface, for example, en0 ,
to associate with the route so that packets are sent by using the
interface when the route is chosen. |
||
rtfamily ={inet|inet6} | Specifies the address family. | ||
-k | Specifies the path to a user provided post installation customization script. The script is run in the global environment after the WPAR is created while WPAR file systems are mounted. The post customization script is called with the WPAR name as the first argument, and the WPAR base directory as the second argument. If the script exits with a nonzero return code, a warning is printed, but the mkwpar command has not failed. | ||
-l | Creates private and writable versions of the /usr and /opt file systems. | ||
-L [image_data= imagedatafile ] [shrink= {yes|no}] [ignore_maps= {yes|no}] |
|
||
-M directory=dir [ vfs=type ] [ size=sizespec ] [ vg=volumegroup ] [ logname=loglv ] [ dev=devicepath ] [ host=remotehost ] [ = ] [ mountopts=mountopts ] | Specifies mount configuration
attributes. Attributes must be separated by a blank space. You can
specify more than one -M flag. By default, the /usr and /opt file
systems of the workload partition are
mounted over the global /usr and /opt file systems in
read-only mode. The /proc file system of the workload partition is mounted over
the global /proc file system in read/write mode. New logical
volumes that are created in rootvg for /, /var, /tmp, and /home.
The default settings for a specified file system can be overridden
by using the -M flag with the directory attribute set
to the file system name. You can specify more file systems with additional -M flags.
The directory attribute denotes the directory within the workload partition where the device
must be mounted. File system specifications in the -M flag supersede file system specifications in the image.data file. There are 4 basic workload partition mount forms: |
||
localfs | Disk-based file system (vfs=jfs or vfs=jfs2) to be created at the location that is specified by the value of the directory within the directory structure of the workload partition. If you specify a dev attribute, it denotes an existing logical volume in the global environment, which is to be used to host the file system. For localfs file systems, you must specify the size attribute. Other optional attributes, which are of the form attr=value, include those attributes in the following list: | ||
logname | Specifies the log device to use for
this file system. This attribute must be specified only if the default
log device that the file system uses is insufficient.
|
||
mode | Specifies the octal permission mode to assign to the base directory of this file system. The default is 755. | ||
size | Specifies the size of the file system that is created in a format acceptable to the crfs command. | ||
vg | Specifies the volume group in which the file system (if no existing logical volume device is specified by using the dev attribute) is created. If you do not specify a value, the volume group that is specified in the -g flag is used. If you do not specify the -g flag, rootvg is assumed. | ||
Specifies other options to pass to the crfs command when the file system is being created. Options are passed directly to the crfs command so the value must be in the form that is required by the crfs command. | |||
-M directory=dir [ vfs=type ] [ size=sizespec ] [ vg=volumegroup ] [ logname=loglv ] [ dev=devicepath ] [ host=RemoteHost ] [ = ] [ mountopts=mountopts ] (continued) | Restriction:
Do not specify any options to the crfs command that correspond to the flags in the mkwpar command. The mkwpar command must not be specified by using the attribute because incorrect results might occur:
|
||
mountopts | Specifies the mount options (corresponding to the "options" attribute in an /etc/filesystems stanza). If you do not specify a mount option, by default, no mount flags are used. Option values that you can specify correspond to the -o options of the mount command. | ||
namefs | Specifies that the global
directory that is specified by the dev attribute is mounted
over the directory that is specified by the directory attribute in
the file system structure of the workload partition. The only other
attribute that is applicable to a namefs mount is mountopts. For the namefs type, you cannot map the /, /var, /opt, /usr, /tmp,
or /proc file system of a workload partition with write privileges
to a real /, /var, /opt, /usr, /tmp,
or /proc file system. The namefs mount can also be used with rootvg workload partitions. In this case, the content of the namefs mount is not saved by using the savewpar command. |
||
nfs | Specifies that the directory
that is specified by the dev attribute on the system that is
exported by the host attribute is mounted over the workload partition directory.
The only other attribute that is applicable to a nfs mount is mountopts.
Requirement: The global system and
the workload partition must both
have root permissions to the NFS device. You can give the global and
the WPAR root permission
to the NFS device, when you export the NFS mount, by specifying the
root access for the host names of both the global system and the workload partition. When an NFS device
is mounted, you cannot map the /, /var, /opt, or /usr file
system of a workload partition with
write privileges to a real /, /var, /opt, or /usr file
system.
|
||
directory | Specifies that the directory
that is specified by the directory attribute is added to the
file system structure of the workload partition. No file system
is created. Use this attribute to reduce the number of file systems
to manage in a workload partition,
such as by eliminating the separate file systems for /tmp and /var.
Ensure that the size of the containing file system is adjusted accordingly. Note: A
directory mount cannot be used for /usr or /opt.
|
||
-n wparname | Specifies the name for the workload partition to be created. You must specify a name, either by using the -n flag, or in a specification file by using the -f flag, unless the -p name or both -w and -o flags are used. | ||
-N attribute=value | Specifies network configuration
attributes. Separate the attribute=value pairs by blank spaces.
You can specify more than one -N flag to configure multiple
IP addresses. You must always specify the address or the address6 attribute
when you use the -N flag. Any other values that are not specified
are taken from the settings of the global system. If you do not specify
the -N flag, the mkwpar command attempts to discover
an appropriate IP address for the workload partition. To do that, the mkwpar command
performs the gethostbyname subroutine
on the workload partition host
name (specified with the -h flag).
If no -N flag is specified and no host name is specified, the mkwpar command
attempts to discover the IP address by performing the gethostbyname subroutine
on the workload partition name
(specified with the -n flag).
If you can find an address on the same subnet as any global interface,
use that interface settings with the resolved IP address to create
the default network entry. You can specify the following attributes
for the -N flag:
The name-mapped interface is defined in the /etc/wpars/devmap file.
You can specify the mapping between the name-mapped interface and
the system interface as follows:
To define an IPv6 network configuration, specify the -N flag with the address6, prefixlen, and interface attributes. The address6 attribute is a 128-bit address. The address is represented by eight 16-bit integers that are separated by colons. Each integer is represented by 4 hex digits. Leading zeros can be skipped, and consecutive null 16-bit integers can be replaced by two colons (one time per address). The prefixlen attribute is the number of high-order bits that are used to mask the IPv6 address and to comprise the prefix. The value of the prefixlen attribute ranges from 0 through 128. Each -N flag can accept either IPv4 attributes, or IPv6 attributes, but not both. |
||
-o outfile | Indicates an output path and file name to which to write specification data. This specification file can then be used to create a workload partition later, by using the -f flag. | ||
-O | This flag is used to force an existing volume group to be overwritten on a particular set of devices, specified with the -D rootvg=yes flag directive. If not specified, the overwrite value defaults to FALSE. This flag must be specified only once, as its setting is applied to all devices specified with the -D rootvg=yes flag directive. | ||
-p [name] | Indicates that the workload partition's file systems exist
and must be preserved, which means the root part must not be populated. You must specify the
existing file systems to the mkwpar command in one of the following two ways:
If you specify the -p flag with the name parameter, and no workload partition name is provided by using other means (for example, the -n flag or general.name in the specification file), you can also use the name parameter as the workload partition name. Note: The -p flag is
mutually exclusive with the -B flag.
The -p flag can be used to re-create a versioned workload partition. The workload partition's file systems must be preserved. To re-create such a versioned workload partition, the -f infile flag is included to provide a specification file that is saved from the original workload partition. The specification file is required to preserve the ostype value of the workload partition. |
||
-P | Sets the root password for the workload partition. The mkwpar command prompts you for the password interactively. | ||
-r | Duplicates the network name resolution configuration from
the global system. The following files, if they exist, are copied into the workload partition:
If the NSORDER environment variable is defined in the calling environment, it is added to the workload partition's /etc/environment file. |
||
-R attribute=value | Allows specification of resource control attributes. You specify only one -R flag. Most resource controls are similar to those resource control attributes that are supported by Workload Manager. You can use the following attributes: | ||
active={yes|no} | |||
Tip: If this field is set to 'no',
performance metrics such as processor and memory usage are not available
by using such commands as topas and wlmstat, either
inside and outside of the workload partition.
|
|||
rset=rset | |||
Configures the workload partition to use a resource set that was created by the mkrset command. | |||
shares_CPU=n | |||
Specifies the number of processor shares that are available to the workload partition. | |||
CPU=m%-SM%,HM% | |||
Specifies the percentage processor limits for the processes of the workload partition. | |||
shares_memory=n | |||
Specifies the number of memory shares that are available to the workload partition. | |||
memory=m%-SM%,HM% | |||
Specifies the percentage memory limits for the processes of the workload partition. | |||
procVirtMem=n[M|MB|G|GB|T|TB] | |||
Specifies the maximum amount of virtual memory that a single process can consume. Processes that exceed the specified limit are terminated. The valid units are megabytes (M or MB), gigabytes (G or GB), and terabytes (T or TB). The minimum limit that is allowed is 1 MB. The maximum limit that can be specified is 8796093022207M, 8589934591G, or 8388607T. If you set the value to -1 (no units), the limit is disabled. See Workload Manager limits File. | |||
totalVirtMem=n[M|MB|G|GB|T|TB] | |||
The maximum amount of virtual memory that can be consumed by the WPAR as a whole. Processes that cause the specified limit to be exceeded are terminated. The valid range and units are the same as procVirtMem. If you set the value to -1 (no units), the limit is disabled. See Workload Manager limits File. | |||
totalProcesses=n | |||
Specifies the total number of processes that are allowed in the workload partition. See Workload Manager limits File. | |||
totalPTYs=n | |||
Specifies the total number of pseudo terminals that are allowed in the workload partition. See pty Special File. | |||
totalLargePages=n | |||
Specifies the number of large pages that can be allowed for the workload partition. See Large Pages. | |||
pct_msgIDs=n% | |||
Specifies the percentage of the maximum number of message queue IDs of the system that are allowed in the workload partition. See Message Queue Kernel Services. | |||
pct_semIDs=n% | |||
Specifies the percentage of the maximum number of semaphore IDs of the system that are allowed in the workload partition. | |||
pct_shmIDs=n% | |||
Specifies the percentage of the maximum number of shared memory IDs of the system that are allowed in the workload partition. See Shared Memory. | |||
pct_pinMem=n% | |||
Specifies the percentage of the maximum pinned memory of the system that can be allocated to the workload partition. See Support for pinned memory. | |||
totalThreads=n | |||
Specifies the total number of threads that are allowed in the workload partition. See Workload Manager limits File. | |||
rootvg=yes|no | Used to indicate whether the specified disk device is to be used as a rootvg WPAR device. If the rootvg option is not specified, the command takes the default of no. | ||
-s | Starts the workload partition after it is created. | ||
-S secfile = /path/to/secattrs privs[+|-] = list | Configures the set of privileges
that can be assigned to processes that are running in a system workload partition. You can provide privileges in a specification file (see the -f flag), in a separate security attributes file through -S secfile=/path/to/secattrs, or on the command line by using the -S privs=list flag. If you do not provide security attributes through one of these mechanisms, the /etc/wpars/secattrs file is used by default. When you use a separate security attributes file (either the default file or the file that is supplied through -S secfile), this file is read once when the workload partition is created to determine the privileges that are associated with the workload partition. Subsequent changes to the file have no effect on existing workload partitions. The default security attributes file /etc/wpars/secattrs must not be modified directly as it might be overwritten in the future. If
you use a base list of privileges from a specification file or security
attributes file (including the default), individual privileges can
be added to or removed from the list by specifying -S privs+=list, -S
privs-=list, or both. Separate attributes must be separated
by a blank space and must be unique, which means secfile=, privs=,
privs+=, and privs-= cannot be specified more than once.
Privileges must be comma-separated (without spaces) and must be unique.
Attributes are processed in the following order regardless of the
order that is specified in either the command line or the specification
file:
Tip: If you specify the -S flag
on the command line, any security attributes in the specification
file are ignored.
|
||
-u userscript | Specifies the path to a user script to be run by workload partition commands at various administration
points. The parameter of the -u flag can be a string that is enclosed in quotation marks,
including more arguments to be passed to the script. The first component of the parameter of the
-u flag must be an absolute path to an existing executable file. The script is started in the
following manner:
The first argument indicates the administrative action that is being performed, as follows:
The second argument is the name of the workload partition. The script can use the lswpar command to obtain any other necessary configuration data. |
||
-U [Workload Partition UUID] | Specifies the Workload Partition UUID. If you do not specify the value, the UUID is automatically generated for the corresponding Workload Partition. | ||
-w | Writes the specification file only. Used with the -o flag, the -w flag causes the mkwpar command to quit after the new specification file is written, without actually creating the workload partition. | ||
-W | Filters the bootset related information from the WPAR specification file. When the -W flag is used with the -e flag to generate a specification file from an existing WPAR, the resulting specification file does not include the bootset related attributes, such as bootset and bootlist. | ||
-X [exportfile=/path/to/file |[kext=[/path/to/extension|ALL]] [local=yes | no] [major=yes | no] | Configures exporting kernel
extensions that will be allowed to load inside a workload partition.
You can specify more than one -X flag to allocate multiple
kernel extensions. Separate the attribute=value by
blank spaces. This flag is not valid for application workload partitions.
You can specify the following attributes for the -X flag:
|
||
-t | Copies the file systems from the rootvg volume groups from a system backup image specified by the -B flag or the global system. | ||
-T [ preserve_private ={yes|no} ] [ preserve_wpars ={yes|no} ] | Controls behavior when copying the file systems from a rootvg volume group or system backup. | ||
preserve_private ={yes|no} | Controls whether filesets that are designated as not visible within WPARs remain in a WPAR that is created by copying a rootvg volume group from a system backup or global system. The default value is no. | ||
preserve_wpars ={yes|no} | Indicates whether the file systems associated with WPARs are available in the source system in a WPAR, which is created by copying a rootvg volume group from a global system. The default value is no. |
Security
Access Control: Only the root user can run this command.
Examples
- To create a workload partition called
roy
, enter the following command:
All values that are not specified are generated or discovered from the global system settings.mkwpar -n roy -N address=192.168.0.51
- To create a workload partition based
on an existing specification file, enter the following command:
mkwpar -f /tmp/wpar1.spec
- To create a modified copy of a specification file with a new IP
address, host name, and workload partition name
(without creating a workload partition),
enter the following command:
mkwpar -f /tmp/wpar1.spec -N address=219.168.45.132 -h www.flowers.com -n wpar2 -o /tmp/wpar2.spec -w
- To create a specification file, which is based on an existing workload partition, enter the following
command:
mkwpar -e wpar1 -o /tmp/wpar2.spec -w
- To recreate a workload partition that
was previously removed with the rmwpar -p command, enter the
following command:
mkwpar -p wparname
- To create a rootvg workload partition, enter the following command:
mkwpar -n test -D devname=hdisk1 rootvg=yes -O
- To create a rootvg workload partition called wpar1 with the storage
device on an adapter, enter the following command (assuming that hdisk3
is attached to the adapter, fcs2):
mkwpar -n wpar1 -D devname=fcs2 -D devname=hdisk3 rootvg=yes
- To create a specification file from an existing
workload partition, without including bootset related information,
enter the following command:
mkwpar -e <existing wparname> -W -w -o <path to spec file>
- To create a WPAR with a default route,
enter the following command:
mkwpar -n wparB -N address=192.162.1.2 interface=en0 netmask=255.255.255.0 -i -I rtdest=0.0.0.0 rtgateway=192.162.1.1
- To create a WPAR with its own routing
table but no default route, enter the following command:
mkwpar -n wparA -N address=192.152.1.2 interface=en0 netmask=255.255.255.0 -i
Files
Item | Description |
---|---|
/etc/wpars/devexports | Default device export control file for workload partitions. |
/etc/wpars/secattrs | Default security file for workload partitions. |
/usr/samples/wpars/sample.spec | An annotated workload partition specification file. |