Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
--time-sync <on | off>
Enables or disables the virtual machine time synchronization.
--disable-timezone-sync <on | off>
Enables or disables timezone synchronization. Enable this option to sync only UTC time without timezone synchronization.
--sync-vm-hostname <on | off>
Enables or disables synchronization of the virtual machine name and hostname in guest OS. Supported only for Linux guests.
--sync-ssh-ids <on | off>
Enables or disables synchronization of macOS SSH public keys with those from the guest OS "authorized_keys" file.
This feature is similar to the ssh-copy-id(1) utility. When enabled, all macOS SSH public keys are added to the guest OS "authorized_keys" file. This allows users to log in to the guest OS via SSH without having to enter the password.
The following SSH keys are synced:
- When a user creates a new SSH key pair in macOS, the public key is also added to the guest OS.
- When a user removes a public key from macOS, this key is also removed from the guest OS.
The details of the current implementation:
- Public key synchronization is currently available for Linux guests only.
- Public key synchronization works if the guest OS user has the same name in macOS or the user is the only regular user of the guest system.
The public key is synced in the following cases:
- After Parallels Tools are installed.
- After booting or rebooting the guest OS.
- After the virtual machine resumes.
- After the public key synchronization feature is enabled/disabled.
Additional information:
- If the feature is disabled, all macOS SSH public keys are removed from the guest OS.
- The "authorized_keys" file and public keys are searched only in the "~/.ssh" directory.
- SSH authorization certificates are not supported.
--show-dev-tools <on | off>
Enables or disables show developer tools in the menu.
--swipe-from-edges <on | off>
Enables or disables edge swipe gestures.
--rename-ext-disks
Renames external virtual hard drive bundles using the virtual machine name.
Loading...
--sync-host-printers <on | off>
Enables or disables using host printers in Windows guests (starting from Windows 2000).
--sync-default-printer <on | off>
Synchronizes host's default printer with Windows default printer.
Note: This subset of parameters is not supported for macOS virtual machines.
--videosize <num>
Sets the amount of memory for the virtual machine graphic card (in megabytes).
--3d-accelerate <off | highest | dx9>
Sets 3d acceleration video mode.
--vertical-sync <on | off>
Enables or disables vertical synchronization.
--high-resolution <on | off>
Enables or disables high resolution video mode for retina display.
--device-bootorder <"name1 name2 ...">
Specifies the order of boot devices for the virtual machine. Supported devices are HDD, CD/DVD, or external storage. A device name can be obtained using the prlctl list -i command.
--efi-boot <on | off>
This sets the EFI boot options. Specify on to boot using the EFI firmware, or specify off to boot using the BIOS firmware (the default).
--select-boot-device <on | off>
Enables or disables selecting a boot device at the virtual machine startup.
--external-boot-device <name>
Sets an external device from which to boot the virtual machine.
--smart-mouse-optimize <auto | on | off>
Sets smart mouse optimization mode.
--sticky-mouse <on | off>
Enables or disables the sticky mouse option.
--keyboard-optimize <auto | accessibility | on | off>
Sets a keyboard optimization mode.
--cpus <num>
Sets the number of CPUs to be available to the virtual machine.
--memsize <num>
Sets the amount of memory for the virtual machine (in megabytes).
--auto-share-camera <on | off>
Enables or disables automatic Web camera sharing.
--auto-share-bluetooth <on | off>
Enables or disables automatic sharing of Bluetooth devices.
--support-usb30 <on | off>
Enables or disables USB 3.0 support.
--autostart <off | open-window | start-app | start-host | user-login>
Sets the virtual machine autostart options:
off: The virtual machine is started manually.
open-window: The virtual machine starts when its window opens.
start-app: The virtual machine starts when Parallels Desktop starts.
start-host: The virtual machine is started automatically on the host boot.
user-login: The virtual machine is started automatically on user logon.
--autostart-delay <n>
Sets the delay of the virtual machine autostart on host boot to n seconds.
--autostop <stop | suspend | shutdown>
Specifies what should happen to the virtual machine on host shutdown.
--startup-view <same | window | coherence | fullscreen | modality | headless>
Sets the virtual machine startup view options:
same: Same as the last time
window: Normal window
coherence: Coherence
fullscreen: Full screen
modality: Modality
headless: Headless
--on-shutdown <window | close | quit>
Sets the virtual machine shutdown options:
window: The virtual machine window stays open after the virtual machine is shut down.
close: The virtual machine window closes after the virtual machine is shut down.
quit: Parallels Desktop quits after the virtual machine is shut down.
--on-window-close <suspend | shutdown | stop | ask | keep-running>
Sets the virtual machine window close options:
suspend: The virtual machine is suspended after its window is closed.
shutdown: The virtual machine is shut down after its window is closed.
stop: The virtual machine is forcibly stopped after its window is closed.
ask: Ask the user what to do: suspend, shut down, or stop the virtual machine.
keep-running: The virtual machine is kept running after its window is closed.
--pause-idle <on | off>
Enables or disables pausing of an idle virtual machine.
--undo-disks <off | discard | ask>
Sets the virtual machine undo disks options:
off: Undo disks mech is off.
discard: Discard all changes made in the virtual machine after it is stopped.
ask: Ask the user what to do: apply changes or discard them after the virtual machine is stopped.
This section describes prlctl set command options that you can use to configure a virtual machine.
The general syntax is as follows:
prlctl set <vm_id | vm_name> [options]
The prlctl set command is used to modify the configuration of a virtual machine and manage virtual machine devices and shared folders. The subsequent subsections describe parameters and options that can be used with this command to perform a variety of virtual machine configuration management tasks.
--require-pwd <exit-fullscreen | change-vm-state | manage-snapshots | change-guest-pwd | change-vm-config>:<on | off>
Require an administrator password to perform a corresponding action. Use --allow-to-confirm to make the system ask for username and password.
--require-custom-pwd <exit-fullscreen | change-vm-state | manage-snapshots | change-guest-pwd | change-vm-config>:<on | off>
Require a custom password to perform an operation. The change-guest-pwd option allows you to change the guest OS password via command line. Use --allow-to-confirm to make the system ask for username and password. Other options are self-explanatory.
--custom-pwd [--custom-pwd-mode <on | off | change>] [--replace-commands]
Set, reset, or changes a custom password for operations that require it. The options are described below.
--custom-pwd-mode < on | off | change> — set, reset, or change a custom password for operations that require it.
--allow-to-confirm [--host-admin] — prompt to enter admin credentials or a custom password if an operation requires it. If no operation requires a password, this option will be ignored. If an operation requires a password, this option shows a prompt to enter it. If an operation requires a password, but this option is omitted, the operation will fail with a corresponding error. To make an operation require a password, use the following options: --require-pwd , --require-custom-pwd, or --lock-edit-settings as described in this guide. --host-admin specifies the host administrator name if an administrator password is required to unlock the Parallels Desktop preferences for editing.
--replace-commands — specify this option to reset commands that are protected with the admin password. This means that when you enable a custom password, commands that require the admin password will now require a custom password. Commands that previously required a custom password will be discarded. The same logic is used when you switch back to the admin password (set --custom-pwd-mode to off). When you disable a custom password, commands that require it will now require the admin password. Commands that previously required the admin password will be discarded. This option is ignored if --custom-pwd-mode is set to change.
--lock-on-suspend <on | off>
Always locks the guest OS on suspend.
--isolate-vm <on | off>
Isolates the the virtual machine from the host.
--smart-guard <on | off>
Enables or disables smart guard mech.
--sg-notify-before-create <on | off>
Notifies the user before creating a snapshot.
--sg-interval <seconds>
Sets a time interval between taking snapshots.
--sg-max-snapshots <num>
Sets the maximum allowed number of snapshots.
--lock-edit-settings <on | off [--host-admin <name>]>
Locks or unlocks editing of the virtual machine configuration.
--host-admin <name>
Specifies the host administrator name if an administrator password is required to unlock editing of the virtual machine configuration.
--userpasswd <user : passwd> [--host-admin <name>]
Sets a password for the specified user in the virtual machine. If the user account does not exist, it is created. The --host-admin <name> parameter specifies the host administrator name if an administrator password is required to change the user password in the virtual machine. Parallels Tools must be installed in the virtual machine for the command to succeed.
--password-to-edit
Note: This parameter has been dropped in Parallels Desktop 15. In previous versions, it was used to set a custom password to modify the virtual machine configuration. In Parallels Desktop 15 and newer, use the --require-custom-pwd and --custom-pwd commands (described at the beginning of this section).
The following options can be used with the prlctl set command to manage devices:
--device-add — add a new device.
--device-set — modify an existing device.
--device-del — delete (remove) a device.
--device-connect — connect a device.
--device-disconnect — disconnect a device.
Only one option can be specified in a single command.
--smart-mount <on | off>
Enables or disables shared volumes.
--shared-profile <on | off>
Enables or disables shared profile.
--shared-cloud <on | off>
Enables or disables shared cloud.
--sh-app-guest-to-host <on | off>
Enables or disables sharing guest applications with the host.
--show-guest-app-folder-in-dock <on | off>
Enables or disables showing the folder with guest OS applications in the Dock.
--sh-app-host-to-guest <on | off>
Enables or disables sharing host applications with guests.
--shared-clipboard <on | host-to-guest | guest-to-host | off>
Note: This command is not yet supported for macOS virtual machines running on Apple Silicon Macs. The shared clipboard is enabled by default on macOS virtual machines.
Controls the availability of clipboard contents between the Mac and Windows/Linux virtual machines.
The options described here are common for all types of devices.
--device-connect <device_name>
Connects the specified device to a running virtual machine. The device can be of type fdd, cdrom, sound, or net. To obtain a device name, use the prlctl list -i command.
--device-disconnect <device_name>
Disconnects the specified device from a running virtual machine.
--device-set <device_name> <<--enable | --disable> | <--connect | --disconnect>>
Enables/disables or connects/disconnects the specified device to/from a virtual machine. Please note that the --device-set command is also used to modify a device configuration and has additional parameters, which are different for different types of devices. The parameters for each device type are described in subsequent sections of this guide.
--device-del <device_name> [--detach-only | --destroy-image | --destroy-image-force]
Removes the specified device from the virtual machine.
If --detach-only is specified and the device is a virtual hard disk drive, the disk image is preserved.
If --destroy-image is specified, the virtual HDD image is removed from the server.
If --destroy-image-force is specified, the virtual HDD image is removed from all snapshots and from the server.
The default action on deleting a virtual HDD is to detach the HDD image as if --detach-only was specified.
--expiration <<on|off>|date:<yyyy-MM-ddThh:mm:ss>|time-check:<seconds>|offline-time:<seconds>|time-server:<url>|note:<text>>
Expiration date parameters:
on|off: Enables or disables expiration date checking.
date: Sets a date and time when the virtual machine usage period expires (e.g., 2024-12-31T20:30:00).
time-check: Sets how often (in seconds) Parallels Desktop contacts the time server to check the expiration date and time.
offline-time: Sets the time period (in seconds) during which a user can work with the virtual machine if Parallels Desktop is unable to check the expiration date and time.
time-server: Specifies the URL of a trusted time server to check the expiration date and time.
note: Adds a note (e.g., system administrator contact info).
--device-add hdd [--image <image_name>] [--type <expand | plain>] [--size <n>] [--split]
[--iface <ide | scsi | sata>] [--position <n>]
[--subtype <buslogic | lsi-spi | lsi-sas>]
[--online-compact <on | off>]
--device-set <hdd_name> [--image <image_name>] [--type <expand | plain>]
[--size <n>] [--split] [--iface <ide | scsi | sata>] [--position <n>]
[--subtype <buslogic | lsi-spi | lsi-sas>] [--online-compact <on | off>]
hdd_name: The name of the virtual hard drive to modify (--device-set command only). Virtual hard drives are named using the hddN format, where N is the drive index number starting from 0 (e.g., hdd0, hdd1). To obtain the list of disk names, use the prlctl list --info
command.
--image: specifies the name of the file to be used for emulating the VM virtual disk drive. If this option is omitted, a new file is created inside the directory storing all VM-related configuration files and assigned the name of harddiskN.hdd
.
--type: specifies the type of the virtual disk from one of the following:
expand (default): virtual disks of this type are small initially and grow in size as you add data to it.
plain: virtual disks of this type have a fixed size from the moment of their creation.
--size: hard disk size, in megabytes.
--split: splits the hard disk into 2GB pieces.
--iface: virtual hard disk interface type: ide, scsi, or sata.
--position: the SCSI / IDE / SATA device identifier to be used for the disk drive. Allowed ranges:
0-3 for IDE disk drives
0-6 for SCSI disk drives
0-5 for SATA disk drives
--subtype: virtual hard disk subtype: buslogic, lsi-spi, lsi-sas.
--online-compact: enables or disables virtual hard disk online compact mode.
The general syntax for adding a device is as follows:
prlctl set <vm_id | vm_name> --device-add <hdd | cdrom | net | fdd | serial | parallel | sound | usb> [device_options]
To modify a device:
prlctl set <vm_id | vm_name> --device-set <device_name> [device_options]
The subsequent sections describe options and parameters for each device type.
--winsystray-in-macmenu <on | off>
Shows the Windows notification area in the Mac menu bar.
--auto-switch-fullscreen <on | off>
Allows applications to auto-switch to full screen.
--disable-aero <on | off>
Enables or disables Windows Aero.
--hide-min-windows <on | off>
Allows to hide minimized windows.
--device-add cdrom --device <name> [--iface <ide | scsi | sata>] [--passthr <yes | no>]
[--position <n>] [--subtype <buslogic | lsi-spi | lsi-sas>]
--device: the name of the host computer's optical drive that will be connected to the virtual machine. To obtain the names of all optical drives installed on the host, use the prlsrvctl info command.
--iface: virtual optical drive interface type.
--passthr: enables the passthrough mode for the specified device.
--position: the SCSI / IDE / SATA device identifier to be used for the drive. Allowed ranges:
0-3 for IDE disk drives
0-6 for SCSI disk drives
0-5 for SATA disk drives
--subtype: virtual optical drive subtype.
--device-add hdd --device <real_name> [--iface <ide | scsi | sata>] [--passthr <yes | no>]
[--position <n>] [--subtype <buslogic | lsi-spi | lsi-sas>]
--device: the name of the host computer hard drive that will be connected to the virtual machine. To obtain the names of all hard disks installed on the host, use the prlsrvctl info command.
--iface: virtual hard disk interface type: ide, scsi, sata.
--passthr: enables the passthrough mode for the specified device.
--position: the SCSI / IDE / SATA device identifier to be used for the drive. Allowed ranges:
0-3 for IDE disk drives
0-6 for SCSI disk drives
0-5 for SATA disk drives
--subtype: virtual hard disk subtype: buslogic, lsi-spi, lsi-sas.
Note: Adding virtual optical drives is not supported in macOS virtual machines.
--device-add cdrom [--image <name>] [--iface <ide | scsi | sata>] [--position <n>]
[--subtype <buslogic | lsi-spi | lsi-sas>]
--device-set <drive_name> [--image <name>] [--iface <ide | scsi | sata>]
[--position <n>] [--subtype <buslogic | lsi-spi | lsi-sas>]
drive_name: The name of the optical drive to modify (--device-set command only). To obtain the list of the available drives, use the prlctl list --info
command.
--image: connect the specified image file to the virtual machine. The following image file formats are supported: iso, cue, ccd, dmg.
--iface: virtual optical interface type: ide, scsi, sata.
--position: the SCSI / IDE / SATA device identifier to be used for the optical drive. Allowed ranges:
0-3 for IDE disk drives
0-6 for SCSI disk drives
0-5 for SATA disk drives
--subtype: virtual optical drive subtype: buslogic, lsi-spi, lsi-sas.
Note: Adding virtual floppy drives is not supported in macOS virtual machines.
The command adds a virtual floppy disk drive based on a file image.
--device-add fdd --image <image> [--recreate]
--device-set <fdd_name> --image <image> [--recreate]
fdd_name: The name of the FDD to modify. To obtain the list of the available drives, use the prlctl list --info
command.
--image: specifies the image file.
--recreate: if included, recreates the image file if it exists.
--device-add net --type <shared | bridged | host-only> [--iface <name>] [--mac <addr | auto>]
[--ipadd <addr [/mask]> | --ipdel <addr[/mask]> | --dhcp <yes | no> | --dhcp6 <yes | no>]
[--gw <gw>] [--gw6 <gw>] [--nameserver <addr>] [--searchdomain <addr>]
[--configure <yes | no>] [--apply-iponly <yes | no>]
[--adapter-type <virtio | e1000 | e1000e | rtl>]
--device-set <adapter_name> --type <shared | bridged | host-only> [--iface <name>]
[--mac <addr | auto>]
[--ipadd <addr [/mask]> | --ipdel <addr[/mask]> | --dhcp <yes | no> | --dhcp6 <yes | no>]
[--gw <gw>] [--gw6 <gw>] [--nameserver <addr>] [--searchdomain <addr>]
[--configure <yes | no>] [--apply-iponly <yes | no>]
[--adapter-type <virtio | e1000 | e1000e | rtl>]
adapter_name: the name of the virtual network adapter to modify (--device-set command only). To obtain the list of the available adapters, use the prlctl list --info command.
--type: the type of the network adapter to create in the virtual machine.
--iface: the host network interface to be assigned to the bridged or host-only virtual network adapter.
--mac: the MAC address to be assigned to the virtual network adapter. If omitted, the MAC address will be automatically generated.
--ipadd: the IP address to be assigned to the network adapter in the virtual machine.
--ipdel: the IP address to be removed from the network adapter in the virtual machine.
--dhcp: specifies whether the virtual network adapter should get its IP settings through a DHCP server.
--dhcp6: specifies whether the virtual network adapter should get its IPv6 settings through a DHCP server.
--gw: the default gateway to be used by the virtual machine.
--gw6: the default IPv6 gateway to be used by the virtual machine.
--nameserver: the default DNS server to be used by the virtual machine.
--searchdomain: the default search domain to be used by the virtual machine.
--configure: if set to yes, the settings above are applied to the virtual network adapter instead of its original settings. Configuring any of the settings automatically sets this option to yes.
--apply-iponly: if set to yes, the hostname, nameserver, and search domain settings from the virtual machine configuration file are ignored.
--adapter-type: specifies the network adapter emulation type.
Note: Adding a Serial port is not supported in macOS virtual machines.
--device-add serial {--device <name>|--output <file>|--socket <name>
[--socket-mode <server|client>]}
Modify a serial port
--device-set <port_name> {--device <name>|--output <file>|--socket <name>
[--socket-mode <server|client>]}
port_name: the name of the port to modify (--device-set command only). To obtain the list of the available ports, use the prlctl list --info command.
--device: the number of the host computer serial port that will be used by the virtual machine.
--output: the path to the file where the output of the virtual serial port will be sent.
--socket: the name of the host computer socket to which the serial port will be connected.
--socket-mode: the socket operation mode.
--device-add parallel {--device <name> | --output <file>}
Modify a parallel port
--device-set <port_name> {--device <name> | --output <file>}
port_name: the name of the port to modify (--device-set command only). To obtain the list of the available ports, use the prlctl list --info command.
--device: the parallel port number on the host computer that will be used by the virtual machine.
--output: the path to the file where the output of the virtual parallel port will be sent.
--name <name>
Changes the virtual machine name.
--description <desc>
Sets the virtual machine description.
--distribution <name | list>
Sets the virtual machine OS version(s) family.
--asset-id <id>
Changes the virtual machine asset ID.
--template <on | off>
Converts the virtual machine to the template and back.
--tools-autoupdate <yes | no>
Enables or disables the auto-update mode for Parallels Tools Agent.
--usedefanswers <on | off>
Enables or disables default mech answers to the questions from the virtual machine.
A shared folder is a host OS folder that can be accessed from a virtual machine.
--shf-host <on | off>
Enables or disables sharing the user-defined host OS folders with guest OS.
--shf-host-add <name> --path <path> [--mode <ro | rw>] [--shf-description <desc>]
[--enable | --disable]
Shares the host OS folder name with a virtual machine.
--shf-host-del <name>
Removes the specified folder from the list of shared folders.
--shf-host-set <name> --path <path> [--mode <ro | rw>] [--shf-description <desc>]
[--enable | --disable]
Modifies the settings of the host OS shared folder name.
--shf-host-defined <off | alldisks | home>
off: Disable sharing of folders defined by the host OS.
alldisks: Share all host OS disks with a virtual machine.
home: Share a host OS user's home directory with a virtual machine.
--shf-guest <on | off>
Enables or disables sharing of user-defined guest OS folders with the host OS.
--shf-guest-automount <on | off>
Enables or disables automatic mounting of shared guest OS folders on the desktop.
This command adds USB support to a virtual machine, making the USB & Bluetooth configuration options available.
--device-add usb
Note: Adding a sound card is not supported in macOS virtual machines.
--device-add sound --output <name> --input <name>
--ouput: the name of a physical output device to which to connect the virtual sound card.
--input: the name of the physical input device to which to connect the virtual sound card.
--faster-vm <on | off>
Sets the performance mode: faster virtual machine or faster host.
--adaptive-hypervisor <on | off>
Enables or disables adaptive hypervisor.
--disable-winlogo <on | off>
Enables or disables the Windows logo.
--auto-compress <on | off>
Enables or disables automatic compression of virtual disks.
--nested-virt <on | off>
Enables or disables nested virtualization.
--pmu-virt <on | off>
Enables or disables PMU virtualization.
--longer-battery-life <on | off>
Sets a power option: longer battery life or better performance.
--battery-status <on | off>
Shows or hide battery status.
--resource-quota <low | medium | unlimited>
Sets the virtual machine resource quota:
low: The host takes priority in resources.
medium: The host and the virtual machine share resources evenly.
unlimited: The virtual machine uses the maximum possible resources.