Name

Description

ID

Target virtual machine ID.

name

Target virtual machine name.

--cpus number

Number of virtual CPUs in the virtual machine. If the host has more than one CPU, this option allows you to set the number of virtual CPUs to be available in the virtual machine.

--memsize number

The amount of memory (RAM) available to the virtual machine, in megabytes.

--videosize number

The amount of video memory available to the virtual machine graphics card.

--memquota auto| guarantee :limit[: priority [: maxballoon }]

Sets the parameters of the memory consumption by the virtual machine:

• guarantee . The amount of memory a virtual machine is guaranteed to get on demand. By default, the guaranteed memory is calculated on the basis of RAM and video memory assigned to a virtual machine and is about a half of its total memory.
• limit . The maximum amount of memory a virtual machine is allowed to consume. By default, no limit is set for all newly created virtual machines, and any virtual machine may consume all free memory on the server.
• priority . The priority (from 1 to 100) that defines which virtual machine will get memory first. The higher the priority of a virtual machine, the more chances it has to get memory when the Parallels server has insufficient memory resources. By default, the priority is set to 50.
• ballooning . The maximum amount of memory the balloon driver in a virtual machine may allocate for its needs. By default, the balloon driver can allocate up to 60% of RAM set for a virtual machine.
• auto . Resets all memory parameters to their default values.

--mem-hotplug on|off

Enables or disables memory (RAM) hotplug support in the virtual machine. This feature is disabled in the virtual machine by default. The guest operating system must support memory hotplug for this functionality to work.

--description VM_description

Short description of the virtual machine.

--autostart on|off|auto

Defines the virtual machine start-up options:

• on -- the virtual machine is started automatically wen the Parallels server starts or the Parallels Server Bare Metal component responsible for managing virtual machines is disabled.
• off -- the autostart is off. This is the default virtual machine start-up mode.
• auto -- resume the virtual machine state prior to shutting down the Parallels server or disabling the Parallels Server Bare Metal component responsible for managing virtual machines.

If you set this option to on or auto , you must additionally specify the --start-as-user option.

--autostart-delay number

Sets the time delay used during the virtual machine automatic startup.

--autostop stop|suspend

Sets the automatic shutdown mode for the specified virtual machine:

• stop -- the virtual machine is stopped when you shut down the Parallels server or disable the Parallels component responsible for managing virtual machines.
• suspend -- the virtual machine is suspended when the Parallels server is shut down or the Parallels component responsible for managing virtual machines is disabled.

--applyconfig conf

Applies the resource parameter values from the specified VM configuration file to the virtual machine. The parameters defining the OS family and OS version are left intact.

--name name

Changes the virtual machine name.

--start-as-user administrator|owner| user : passwd

Specifies the account to use to autostart the virtual machine:

• administrator -- start the virtual machine as the administrator of the host operating system.
• owner -- start the virtual machine as the virtual machine owner.
• user:passwd -- start the virtual machine as the specified user.

--vnc-mode auto|manual|off

Enables or disables access to the virtual machine via the VNC protocol.

--vnc-port port

Sets the VNC port number.

--vnc-passwd passwd

Sets the VNC password.

--vnc-address address

Sets the IP address to use for logging in to the virtual machine via VNC. It must be one of the IP addresses assigned to the Parallels server.

By default, you can use any of the IP addresses of the Parallels server to log in to the virtual machine.

--cpu-hotplug on|off

Enables or disables CPU hotplug support in the virtual machine. This feature is disabled by default. The guest operating system must support CPU hotplug for this functionality to work.

--cpuunits units

Sets the CPU weight for the virtual machine. This is a positive integer number that defines how much CPU time the virtual machine can get as compared to the other virtual machines and Containers running on the server. The larger the number, the more CPU time the virtual machine can receive. Possible values range from 8 to 500000. If this parameter is not set, the default value of 1000 is used.

--cpulimit percent|megahertz

CPU limit, in percent or megahertz (MHz) the virtual machine is not allowed to exceed. By default, the limit is set in percent. To set the limit in MHz, specify "m" after the value.

Note : If the server has 2 processors, the total CPU time equals 200%.

--ioprio priority

Disk I/O priority level from 0 to 7. The default is 4.

--iolimit limit

Disk I/O bandwidth limit. The default is 0 (no limit). By default the limit is set in megabytes per second. You can use the following letters following the number to specify units of measure:

G -- gigabytes per second (e.g., 1G).

K -- kilobytes per second (e.g., 10K).

B -- bytes per second (e.g., 100B).

--cpumask N [, N , N1-N2 ]

An affinity mask indicating what CPU(s) the virtual machine processes should be run on.

You can specify a list of CPUs identified by their index numbers separated by commas (0, 1, 2, 3, etc.) or a range (4-6).

To make all CPUs available for the virtual machine processes specify --cpumask all .

--offline-management on|off

Turns the offline management on or off.

--offline-service service_name

The name of the service to use for offline management.

--userpasswd user : passwd

Sets the password for the specified user in the virtual machine. If the user account does not exist, it will be created. Parallels Tools must be installed in the virtual machine for the command to work.

--rate

Sets the guaranteed outgoing traffic rate in Kb/s for the virtual machine.

--ratebound

Turns the network traffic rate limitation set by the --rate parameter (above) on or off. The default value is "off".

--tools-autoupdate on|off

Turns on/off automatic updating of Parallels Tools in the guest operating system. If this option is set to ON, Parallels Tools updates will be performed automatically every time an update is available for Parallels Server Bare Metal. If this option is set to OFF, no automatic Parallels Tools updates will be performed, so that you can do it manually at a convenient time.