/CREATE-VM-DEFINITION creates a persistent VM definition.
The following attributes and resources for the VM are entered in the VM definition:
VM index and VM name (identification of the VM)
Main memory size of the VM
Minimum and maximum main memory size of the VM for main memory reconfiguration
Multiprocessor level of the VM
(Member) CPU quota and maximum CPU utilization of the VM
Adding of the VM to a VM group (SU /390)
Assignment of the VM to a CPU pool
Settings for controlling the real CPU (SU /390)
Maximum I/O utilization of the VM (SU /390)
Devices for the VM
The password for administration
Range of commands for the VM administrator
- Privileges of the VM
| As it is recommended that a VM be created without the privileges IO-PRIORITY and IO-RESET (see "CREATE-VM (Initialize a VM)"), IO-PRIORITY=*NO and IO-RESET=*NO should also be entered for the VM in the VM definition. |
Specifications for automatic startup of the guest system on the VM when activating the VM definition
After the command has been executed, a persistent VM definition with the specified VM name exists. Further /CREATE-VM or /CREATE-VM-DEFINITION commands with this VM name are rejected.
This command is reserved for the VM2000 administrator.
CREATE-VM-DEFINITION | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM-NAME = <name 1..8>
Name of the VM definition.
Identical to the name of the virtual machine which is to be initialized.
 | See also the general conditions for SU x86 in section “Recommendations for the definition and use of VM names” in section "Initializing a VM". |
VM-INDEX =
The VM index.
VM-INDEX = *ANY
The VM index is assigned by VM2000 when the VM definition is activated.
VM-INDEX = <integer 2..99>
Specifies the VM index.
VM0002), only the appropriate VM index (in this case 2) may be specified.If VM-INDEX=*ANY is specified and the VM migrated at a later point (VM Migration), the VM will receive any free VM index on the target SU. Otherwise, the specified (fixed) VM index must be available on the target SU as well.
MEMORY-SIZE = <integer 1..1048576>(DIMENSION = *MEGABYTE / *GIGABYTE)
Predefined size of main memory for the appropriate VM up to a size of 1 Tbyte
(terabyte; 1 Tbyte = 1024 Gbytes = 1 048 576 Mbytes).
 | On SU x86, a small amount of a VM’s main memory is required for the firmware component. The main memory of a VM must be at least 1024 Mbytes large. The value must be a multiple of 2 Mbytes. |
MIN-MEMORY-SIZE = *STD / <integer 1..1048576>(DIMENSION = *MEGABYTE / *GIGABYTE)
Predefined minimum size of the main memory for the relevant VM when main memory is reconfigured. The default is the size of the main memory for the VM as defined by MEMORY-SIZE.
| On SU x86, the main memory of a VM must be at least 1024 Mbytes in size. The value must be a multiple of 2 Mbytes. |
MAX-MEMORY-SIZE = *STD / <integer 1..1048576>(DIMENSION = *MEGABYTE / *GIGABYTE)
Predefined maximum size of the main memory for the VM when main memory is reconfigured. The default value is twice the size of the VM’s main memory which is predefined by MEMORY-SIZE. Take note of the information in section "Initializing a VM".
| This operand has no effect for SU /390. The value must be a multiple of 2 Mbytes for SU x86. |
PROCESSOR =
Envisaged multiprocessor level of the VM (see "Virtual CPUs").
PROCESSOR = *MONO
The VM is to be created with one virtual CPU.
PROCESSOR = *BI
The VM is to be created with two virtual CPUs.
PROCESSOR = *TRIPLE
The VM is to be created with three virtual CPUs.
PROCESSOR = *QUADRO
The VM is to be created with four virtual CPUs.
PROCESSOR = *OCTO
The VM is to be created with eight virtual CPUs.
PROCESSOR = *MAXIMUM
A VM with the maximum possible number of virtual CPUs is to be created. The maximum possible number of virtual CPUs matches the number of real normal CPUs which are available for VM2000 operation, see "Real CPUs".
On SU /390, the maximum number of virtual CPUs is 16.
PROCESSOR = *EXTRA-AND-NORMAL
A VM is to be configured with as many virtual CPUs as normal CPUs and extra CPUs are available for VM2000 operation. 
On SU /390, up to 16 virtual CPUs are possible.
A VM with this number of CPUs can utilize the maximum CPU capacity, including the CPU capacity of the attached extra CPUs. For a Server Unit without extra CPUs this value is the same as the value of PROCESSOR=*MAXIMUM.
PROCESSOR = <integer 1..32>
A VM is set up with the number of virtual CPUs specified here. A value less than or equal to the value of PROCESSOR=*MAXIMUM is permissible.
CPU-QUOTA =
Envisaged CPU quota of the VM.
CPU-QUOTA = *STD / <fixed 0.01..99.99>(...)
CPU quota of a VM which is not (yet) to be assigned to a VM group when the VM definition is activated. Determines the VM’s share of the CPU capacity of the CPU pool in comparison to the VM groups and the other VMs which have not been added to a VM group (see "Planning distribution of the CPU capacity to the VMs").
The default value is 1(CPU-POOL-NAME=*STDPOOL), i.e. the VM is assigned to the standard CPU pool, but not to a VM group, when the VM definition is activated.
CPU-POOL-NAME =
Defines the CPU pool to which the VM is to be assigned when the VM definition is activated.
Every VM is always assigned to precisely one CPU pool.
When the VM definition is activated, the CPU pool must possess at least one attached real CPU.
CPU-POOL-NAME = *STDPOOL
The VM is assigned to the standard CPU pool.
CPU-POOL-NAME = <name 1..8>
Name of the CPU pool to which the VM is assigned.
CPU-QUOTA = *BY-VM-GROUP(...)
CPU quota of a VM which is to be assigned to the specified VM group when the VM definition is activated (SU /390). This determines the VM’s CPU share in comparison to the other VMs in the VM group (see "Operating VM groups (SU /390)"). The VM is implicitly assigned to the CPU pool of the VM group.
VM-GROUP-NAME = <name 1..8>
Name of the VM group to which the VM is added.
MEMBER-CPU-QUOTA = *STD / <fixed 0.01..99.99>
Member CPU quota of the VM. The default value is 1.
MAX-CPU-UTILIZATION = 100 / <fixed 0.01..100.00>
Envisaged maximum CPU utilization of the VM (see "Planning distribution of the CPU capacity to the VMs").
 | If the VM belongs to a VM group, its maximum CPU utilization is also restricted by the “maximum CPU utilization of the VM group” (see "Operating VM groups (SU /390)"). |
VM-ACTIVE-IDLE =
Determines on SU /390 whether, in the event of fixed CPU assignment, a VM still retains control over a real CPU if the VM’s virtual CPU which runs on this is inactive (interruptible wait state, "Idle"), see "Initializing a VM".
VM-ACTIVE-IDLE = *NO
The VM leaves control over the real CPU if the VM’s virtual CPU which runs on this becomes inactive (interruptible wait state, "Idle").
VM-ACTIVE-IDLE = *AT-DEDICATED-CPUS
The VM retains control over the real CPU even if the VM’s virtual CPU which runs on this is inactive (interruptible wait state, "Idle"). This idle time is then indicated in the VM2000 accounting records, with /SHOW-VM-STATUS (VM-ACTIVE output column) and in the VM2000 report of openSM2 as a time in which the VM actively uses the real CPU.
VM-ACTIVE-IDLE=*AT-DEDICATED-CPUS is only effective if the VM’s maximum CPU utilization (see "Initializing a VM") is not restricted.MAX-IO-UTILIZATION = 100 / <integer 1..100>
Envisaged maximum I/O utilization of the VM (SU /390, see "Use of IORM in VM2000 operation").
DEVICES =
Determines the devices which are to be assigned to the VM when the VM definition is activated.
DEVICES = *NONE
No devices are to be assigned to the VM when the VM definition is activated.
DEVICES = *PUBSET-DEVICES(...)
The devices of a pubset are to be assigned to the VM when the VM definition is activated.
PUBSET =
Determines the pubset. Only the pubset is noted in the VM definition. The devices of the pubset are determined only when the VM definition is activated.
PUBSET = *BY-PUBRES-DEVICE(...)
Determines the devices of the pubset by means of the pubres device.
UNIT = <alphanum-name 2..2> / <x-text 4..4>
Mnemonic device name of the pubres device.
PUBSET = <cat-id 1..4>
Catalog ID of the pubset. The pubset must be entered together with its pubres device in the monitor system’s MRS catalog.
USAGE =
Specifies the usage mode which the devices of the VM's pubset are to be assigned when the VM definition is activated.
USAGE = *EXCLUSIVE
The devices are to be assigned exclusively to the VM.
USAGE = *SHARED
The devices are to be assigned to the VM as shareable (usage mode SHARED), see "Usage mode of a device".
DEVICES = *DEVICE-RANGE(...)
The VM is to be assigned all devices contained in this name range when the VM definition is activated. All devices currently contained in the name range are entered in the VM definition.
<x-text 4..4> (in *DEVICE-RANGE) are selected from FROM to TO in hexadecimal order. Otherwise, device names <alphanum-name 2..2> are selected in alphabetical order. | If UNITS are specified with *DEVICE-RANGE or with wildcards, alias devices (PAV/DPAV) and CRD devices are ignored. |
FROM = <alphanum-name 2..2> / <x-text 4..4>
Defines the start of the name range.
TO = <alphanum-name 2..2> / <x-text 4..4>
Defines the end of the name range. The mnemonic device name must be in the same value range (2- or 4-digit mn) as the FROM device name and must be greater than or equal to the FROM device name in ascending order in the value range.
USAGE = *EXCLUSIVE / *SHARED
Specifies the usage mode which the devices in the name range of the VM are to be assigned when the VM definition is activated. See "operand USAGE for *PUBSET-DEVICES".
DEVICES = <alphanum-name 1..4 with-wild(20)>(...)
The VM is to be assigned the specified devices when the VM definition is activated. The devices are entered in the VM definition.
USAGE = *EXCLUSIVE / *SHARED
Specifies the usage mode which the devices of the VM are to be assigned when the VM definition is activated. See "operand USAGE for *PUBSET-DEVICES".
USAGE = *VC
The device is to be assigned exclusively to the VM as a virtual console when the VM definition is activated (SU /390). It must be appropriately generated. Only one device for each VM can be operated as a virtual console.
PASSWORD =
Password controlling access authorization in /BEGIN-VM-DIALOG. The password can be up to 8 bytes long.
PASSWORD = *NONE
No password is necessary.
PASSWORD = <c-string 1..8>
Password in character form.
PASSWORD = <x-string 1..16>
Password in hexadecimal form. The password comprising zeros only (X'00..00') is ignored.
ADMIN-PRIVILEGES =
Defines the envisaged command/function range for the VM administrator (see "Extending and restricting the range of commands/functions").
ADMIN-PRIVILEGES = *STD
Standard command/function range.
ADMIN-PRIVILEGES = *MAXIMUM
Extended command/function range for the VM administrator.
PRIVILEGES = *PARAMETERS(...)
Describes privileges of the VM (see "Initializing a VM").
IO-RESET = *NO / *YES
Specifies on SU /390 whether the channels are reset in the hardware for this VM at /START-VM or when the guest system is restarted or the channels reconfigured.
IO-PRIORITY = *NO / *YES
Specifies on SU /390 whether a waiting virtual CPU of the VM is executed again on a real CPU by the VM2000 hypervisor immediately after the end of pending input/output for this VM.
AUTO-SNAP-ASSIGNMENT = *YES / *NO
Determines whether the guest system on the VM may implicitly assign itself snap units for Snapsets without the VM and device being assigned the ASSIGN-BY-GUEST privilege or attribute.
ASSIGN-BY-GUEST = *NO / *YES(...)
Specifies whether devices can also be implicitly assigned to this VM by the guest system (*YES).
Alternatively (*NO), the devices must be assigned explicitly to the VM by the VM or VM2000 administrator.
SET-NAME =
Determines the assignment sets from which the guest system may implicitly assign devices to the VM.
SET-NAME = *STDSET / list-poss (8): <name 1..8> / *STDSET
Explicit specification of the assignment sets.
The explicit list of the assignment sets can be extented up to 28 assignment sets with /MODIFY-VM-DEFINITION.
SET-NAME = *ALL
All existing and future assignment sets.
SET-NAME = *EXCEPT(SET-NAME = list-poss (8): <name 1..8> / *STDSET)
All existing and future assignment sets with the exception of those which are specified with SET-NAME.
The explicit exception list of the assignment sets can be extented up to 28 assignment sets with /MODIFY-VM-DEFINITION.
AUTO-IPL =
Determines whether the guest system on the VM is to be started automatically when the VM definition is activated.
AUTO-IPL = *NO
The guest system on the VM is not started automatically.
AUTO-IPL = *YES(...)
The guest system on the VM is started automatically.
The parameters for the automatic startup must be appropriately supplied with values.
IPL-UNIT = <alphanum-name 2..2> / <x-text 4..4>
Mnemonic device name of the disk device used for the initial program loading (IPL) of the guest system. The device must be assigned to the VM explicitly and exclusively.
IPL-CONSOLE = <alphanum-name 2..2>
Mnemonic device name of the KVP output device.
MODE = *AUTOMATIC / *FAST
Defines the type of system initialization (AUTOMATIC or FAST startup).
SYSTEM-NAME = *NONE / <name 1..8>
Specifies the system name.
The specification is ignored on SU /390.
Command return codes
(SC2) | Main code | Meaning |
0 | CMD0001 | Command successfully executed |
Guaranteed messages
VMS2301