Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Parallels Tools is a collection of utilities and drivers that vastly improve the virtual machine performance and enable some features that are not available otherwise. Parallels Tools are included with every copy of Parallels Desktop and are highly recommended to be installed in every virtual machine right after an operating system is installed in it. Your source virtual machine should have Parallels Tools installed. For instructions on how to install Parallels Tools, please see https://kb.parallels.com/en/115835.
To prepare the autodeploy package, you need to add the following required and optional components to it:
Parallels Desktop installation image (optional).
Parallels Desktop Business Edition license key (required, unless you are using "Activation using corporate account (SSO)").
One or more virtual machines (optional). The user can later install or download a virtual machine via the link in a configuration profile.
One or more Windows application stubs (optional). Stubs are special links to Windows applications installed in a virtual machine that can be added to the Dock in macOS during deployment.
You can also configure deployment options according to your needs by modifying the configuration file included in the autodeploy package.
You will have to take the following steps:
Download the Autodeploy package, which comes in a ZIP format.
Unarchive it.
[OPTIONALLY] Populate the folders with specific installation images and virtual machines.
Set the deployment preferences to your liking by amending the deploy.cfg
file.
Transform the resulting folder into an installable package ready for deployment.
The subsequent sections describe how to add the necessary components and how to configure autodeploy package options.
A Parallels Desktop for Mac license key is required to activate Parallels Desktop on target Macs. The key must be specified in the autodeploy package.
You can find the primary key in your Business Account customer area as described in this chapter. There, you can also issue secondary keys that we recommend to use for activation.
Attention: For security reasons, we strongly advise against using your primary key directly. Any compromised secondary keys can be deleted and replaced with new ones.
To specify the license key:
In the autodeploy package, expand the Parallels Desktop Autodeploy > Scripts > License Key and Configuration folder.
Open the deploy.cfg
file in a text editor.
Find the License
section (second from the top) and enter your Parallels Desktop Business Edition license key as a value of the license_key
variable. The key must be supplied in the following format: "XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX" (including quotes and dashes).
Save the deploy.cfg
file.
Starting from Parallels Desktop 18, 'Activation using corporate account (SSO)' option became available. This option works only if you have purchased a special license type and set up integration with your identity provider in Parallels My Account. Please check your license certificate for details. To enable 'Activation using corporate account' experience, comment the line with the license_key variable.
Note: Parallels Desktop activation requires Internet access. You need to make sure that port 443 is opened on target Mac computers so they can communicate with the Parallels License Server. You can also verify that the Mac computers can reach the Parallels License Server at https://desktop.parallels.com.
Adding a virtual machine to the autodeploy package is optional. You can mass deploy Parallels Desktop only and install virtual machines on individual Mac computers later. Consider the following possible scenarios:
If you are deploying Parallels Desktop on either Apple Silicon or Intel-based Mac computers (but not both at the same time), you can include a virtual machine in the autodeploy package, so it will be installed on a Mac as part of the deployment process.
Note: Architectural differences between Intel-based and Apple Silicon Macs require different virtual machines for each of them, even if the operating system type and version are the same. If you have both kinds of Macs in your organization and would like to deploy Parallels Desktop with a virtual machine on all of them, you need to create two autodeploy packages (one for Apple Silicon and another for Intel-based Macs) and deploy them separately.
There are two ways to include a virtual machine in the autodeploy package: as a downloadable link or as a local file manually added to the package. Regardless of which one you choose, take the following steps first:
Configure the virtual machine as described in the subsections of this chapter;
FULLY STOP the virtual machine by opening Actions in the macOS menu bar and choosing Shut Down. Suspending or pausing it will not suffice;
Reduce the size of the selected virtual machine by doing one of the following:
Open the Parallels Desktop Control Center, right-click on the virtual machine, and select Prepare for Transfer;
Alternatively, open the Parallels Desktop Control Center, right-click on the virtual machine, and select Show in Finder. Right-click on the virtual machine .pvm
file and select Compress {vm_name}.
Several popular MDM solutions have been known to experience issues with deploying large packages. As a way to mitigate this, you can amend the deploy.cfg
file to include a link to a file share location with the virtual machine file instead of including it in the package. Take the following steps:
Upload the compressed file to a permitted cloud storage that would be accessible to all target Macs (e.g., OneDrive or Google Share). Make sure the resulting link is direct and open to all the users affected by the deployment. The best way is to choose Share with anyone.
To add a virtual machine to the autodeploy package directly, simply copy the virtual machine file to the Virtual Machine(s) sub-folder that can be found under Bundle > Virtual machine(s) . More than one virtual machine can be added to the autodeploy package if needed.
Read on to learn about modifications that you can make to the virtual machine configuration before adding it to the autodeploy package.
By default, you can skip this step and allow the Autodeploy package to simply download the latest version of Parallels Desktop installation image from the Parallels Server.
The package should now look like this:
Please note that the Parallels Desktop installation image file name on the screenshot above is just an example. In your case, the file name will also include the current build number information.
When preparing a source virtual machine for mass deployment, you may change any of its configuration settings to fit your needs. The following list describes a few common options:
CPU & Memory. Beginning with Parallels Desktop 17, you can configure a virtual machine to select CPU and memory settings automatically depending on the available hardware resources. This option is preselected for all new virtual machines. To ensure it is selected, open the virtual machine configuration, and select Hardware > CPU & Memory. In the right pane, check that the Automatic option is selected.
Shared Folders and Profiles. Parallels Desktop offers great flexibility in bridging the capabilities of macOS and your guest operating system by configuring shared folders and profiles. Think over which files and folders you wish to share between the two operating systems and set them up beforehand.
Installing Applications. You can install all the necessary applications in the virtual machine before deploying it.
Windows application stubs are special links to Windows applications installed in a virtual machine that can be added to the Dock in macOS during deployment.
Note: Stubs will only work on VMs that have been deployed with the Autodeploy Package.
Application stubs are created in macOS when you create a virtual machine and install Parallels Tools in it. To see application stubs for a virtual machine:
In macOS, navigate to /Users/<user-name>/Applications (Parallels)
Expand a desired virtual machine folder. For example, Windows 11 Applications, as shown in the screenshot below:
The icons in the folder are Windows application stubs. If you double-click an icon, the corresponding Windows application will be started in the virtual machine.
You can add one or more application stubs to the autodeploy package to be added to the Dock on a target Mac computer. For example, if your Mac users use a particular application most of the time, it would make sense to add it to the Dock so they can quickly launch it without dealing with the user interfaces of Windows or Parallels Desktop.
To add one or more application stubs to the autodeploy package, simply copy it to the Windows Application(s) stubs to add to Dock folder of the package.
The recommended approach is to deploy without any virtual machines in the autodeploy package and instead provision a corporate VM image using a Configuration Profile in Parallels My Account. This method is especially useful when you plan to deploy Parallels Desktop on both Apple Silicon` and Intel-based Mac computers at the same time. For more information, please see and .
Open the deploy.cfg
file in a text editor, same as when , scroll to the Virtual Machines section and add the download link there exactly as described, following the instructions carefully.
Note: You can find out about other configuration options in the deploy.cfg file from .
When you want to distribute pre-configured Windows virtual machines to your users, you may need to manage those machines granularly: enroll them into domains, activate Windows licenses, differentiate PC names, enforce specific policies, enable company-wide licensing tools, etc. All that and more can be achieved with the help of Microsoft's Sysprep utility. To learn more, refer to .
However, if you wish to include a specific build in the package, open the Parallels Desktop DMG folder and copy the Parallels Desktop installation image file to it (the .dmg file). If you don't have the file, you can download it from .
Enforce USB Device Policies. Specify what types of USB devices can be connected to the virtual machine. See for complete details.
For the complete information about Parallels virtual machine configuration, please refer to the .
Windows application stubs are mandatory when you deploy Parallels Desktop using Single Application Mode. For more information, please see the section.
If you haven't already, download the Parallels Desktop Autodeploy Package to a Mac computer from this page.
Attention! Once you have downloaded the ZIP
file, it is essential that you remove any quarantine attributes from it, as they may affect all further steps. To do that, execute the following command in the macOS Terminal:
xattr -dr com.apple.quarantine /Users/{username}/Downloads/pd-autodeploy.zip
Make sure the file path matches that of your downloaded package.
The autodeploy package archive contains a folder named "Parallels Desktop Business Edition mass deployment package vxxx
", where "vxxx
" is the autodeploy package version number.
The folder contains the following files:
Changelog.txt — contains a record of changes that were made to the autodeploy package over time.
Deploy.cfg — contains all the parameters that you'll need to check and set, as described here.
Prepare — contains the build script that creates a flat package ready for deployment.
Read on to learn how to add the necessary components to the autodeploy package.
Once you have added all the files to the package and configured the deployment options in the deploy.cfg
file, it's time to turn the resulting folder into a flat package suitable for deployment via your MDM solution of choice.
Do the following:
Inside the Autodeploy Package folder, locate the Scripts folder, right-click on it, and choose Services > New Terminal at Folder. This will open a Terminal window right in the Scripts directory where the build script is located.
Launch the package building script by typing the following command and pressing Enter:
E.g.,
This action creates a .pkg file in the destination folder that is ready for distribution.
Once you have the Parallels Desktop autodeploy package configured, you can test it on a single Mac before you mass deploy it to other Mac computers in your organization.
To test the package:
Copy it to a Mac on which you want to test it. The Mac should have a configuration similar to other Mac computers on which you'll be deploying Parallels Desktop. Specifically, if your target Mac computers don't have Parallels Desktop and virtual machines installed, the test Mac shouldn't have them installed either. If target Macs have an older version of Parallels Desktop, the test Mac should have it installed too, so you can see what the results will be.
To speed up the execution of the package during testing, consider running it from the command line using /System/Library/CoreServices/Installer.app
. When executed this way, the package will not be tested by macOS for digital signature, and the usual package verification procedure will be skipped.
Please note that if you run the package by double-clicking on it, macOS will warn you that the package is not signed and will not install it. If you run the package by right-clicking and choosing Open, the signature check will be skipped but the verification of the package will take a long time if you have one or more virtual machines in it (because of the large size of a typical virtual machine).
When you use the Installer.app to run the package, the installation will commence installing immediately, without any checks or verifications. All of the above only applies when you run the package manually. When you mass deploy it on Mac computers, verification is not performed, and the installation is completely silent.
When the installation is complete, verify that Parallels Desktop is installed, activated, and is functioning properly. If your package is configured to deploy Parallels Desktop in Single Application Mode, try running the application and see that it starts and runs as it should.
Read on to learn how to mass deploy the package using one of the Mac management tools.
The autodeploy package contains a special script, which is automatically executed on a target Mac after the package is transferred to it. When executed, the script reads the configuration parameter values from the deploy.cfg
file, which you can modify according to your needs.
To modify the parameters, expand the License Key and Configuration folder in the autodeploy package and open the deploy.cfg file in a text editor. The configuration parameters are organized in sections, which are described below.
The License section is used to specify the Parallels Desktop Business Edition license key.
The Software Updates section is used to configure automatic updates for Parallels Desktop.
The Help and Support section is used to specify the action for the Help > Support Center menu item in the Parallels Desktop graphical user interface.
The Technical Data Reports section is used to specify whether Parallels Desktop issue reports should contain screenshots of the macOS and virtual machine desktops. You can exclude screenshots for security reasons.
The Security section allows you to enable or disable the password requirement for a number of Parallels Desktop operations.
The User Experience section allows you specify options related to user experience.
Please note that when the package is executed, it writes logs into /var/log/install.log
. If you experience issues, examine the logs. If that doesn't help, you can contact for business customers which is available 24/7.
Variable | Description |
---|
Please note that a can be used to control upgrades over major versions of Parallels Desktop. But if the updates_url
variable is used (see the table below), then the configuration profile option is ignored. The recommended approach is not to use the updates_url
variable and instead, use a configuration profile to enable upgrades when the IT feels confident about the new version.
Variable | Description |
---|
Variable | Description |
---|
Variable | Description |
---|
The Customer Experience section allows you to specify whether the Macs should participate in the Parallels Customer Experience Program (CEP). The Parallels Customer Experience Program is a feedback solution that allows Parallels Desktop to automatically collect usage statistics and system information that will help Parallels develop new features and updates for future releases. For more information, please see .
NOTE: Starting from Parallels Desktop 18, the CEP Participation option in the deployment package and in Parallels Desktop user interface is ignored. The setting for all users is managed by the license administrator in the Parallels My Account portal ().
Variable | Description |
---|
Variable | Description |
---|
Variable | Description |
---|
|
|
Single Application Mode is a special Parallels Desktop deployment option that allows you to largely obscure Parallels Desktop and Windows on a Mac, making Windows applications appear native to macOS. This mode is designed for system administrators who want Mac users in their organization to run one or more Windows applications while minimizing their interaction with Windows or Parallels Desktop.
Note: Single Application Mode is not supported for virtual machines running macOS.
When Parallels Desktop is deployed using Single Application Mode:
A Mac user will not see the Parallels Desktop icon, user interface, or the virtual machine window while interacting with Windows applications.
A Windows application icon is added to the Dock and is registered in macOS for opening the associated file types. When the user clicks on the icon, the application will run on a Mac desktop like a native macOS application.
A user's macOS workflows will remain largely unaffected by the background presence of Parallels Desktop and Windows.
Warning: Single Application Mode is incompatible with the Activation using corporate account option.
To deploy Parallels Desktop using Single Application Mode, do the following:
Add a virtual machine to the autodeploy package. For instructions, see Adding a Virtual Machine. Please take note of the following:
You can add only ONE virtual machine when using Single Application Mode.
The virtual machine must be completely shut down before adding it to the autodeploy package. DO NOT simply close it, as this will be detected as a crash by Windows, and a Mac user will have to deal with it at startup.
Add a Windows application stub to the autodeploy package that will be used to run a desired Windows application on a Mac. If you want to deploy more than one Windows application, add a corresponding stub for each one. For details, please see Adding Windows Application stubs.
To enable Single Application Mode, set the enable_single_application_mode="yes"
parameter in the deploy.cfg
file, as described in Configuring deployment options. The parameter is included in the User Experience section of the deploy.cfg
file.
Deploy Parallels Desktop to Mac computers as described in Deploying Parallels Desktop and Virtual Machines on Macs.
For Windows to be completely hidden on a Mac, you need to make some changes manually because they cannot be automated. The following list describes these changes:
Enable auto logon in Windows. Make sure that Windows in the virtual machine doesn't ask the user to log on. If this is not done, a Mac user will see the Windows logon screen when Windows starts or reboots.
Configure file associations in Windows. This is necessary so that Windows doesn't open another Windows application when the user tries to open a file from the primary application. For example, let's say you deployed Outlook for Windows. A Mac user may try to open a text file attachment in Outlook. Normally, the file will open in Notepad in Windows, which may confuse the user. To prevent this, you can associate text files with TextEdit (a macOS application) in a virtual machine. The ability to associate file extensions with macOS applications is a standard Parallels Desktop feature available in Windows in a virtual machine. In addition, we recommend that you have as few applications installed in Windows as possible in order not to create additional file associations.
Use the Productivity profile. When creating a virtual machine for Single Application Mode, choose the Productivity profile in the virtual machine Installation Assistant. If you are using an existing virtual machine, change its profile by going to Configuration > General > Configure for, clicking Change, and then selecting Productivity.
Remove Sound & Camera devices from the VM configuration. This will eliminate the chance of macOS prompting the user to provide Windows with access to the respective hardware. To do that, go to Configure > Hardware > Sound & Camera and click the "-" button in the bottom left corner.
Note: There's a known issue when users may see Windows screens when Windows is installing updates. There is also a known issue of macOS prompting users to allow Windows apps access to user folders at the first launch. Consider starting the application once after deployment and resolving all requests manually.
If you are deploying Parallels Desktop on macOS High Sierra, macOS Catalina, or macOS Mojave, you need to make sure in advance that Parallels Desktop kernel extensions are either approved or don't require user consent on each Mac. This is particularly important when using the Single Application Mode because if the extensions are not approved, Mac users will see warning messages about them when they try to run a Windows application for the first time. For more information, please see https://kb.parallels.com/en/128435.
| Specifies the registration mode for the deployed virtual machines. Accepted values:
The default destination folder for virtual machines can be modified using the |
| Specifies whether the virtual machine's SMBIOS ID (hardware ID) will be regenerated. Each Parallels virtual machine is assigned a universally unique SMBIOS ID when created. For your enterprise management software (e.g., Microsoft Intune) to properly account for unique Windows and software activations, unique SMBIOS IDs are required. However, specific scenarios like software development may require keeping SMBIOS IDs unchanged. Set the value of the
|
| Specifies whether the virtual machine(s) will be copied or moved from the autodeploy package to their destination folder on a Mac (see the explanation below). Accepted values:
If your autodeploy package contains one or more virtual machines, they need to be copied or moved to their destination folder on a Mac during deployment (see
|
|
| Alternatively, compressed or packed virtual machine files included in the autodeploy package are copied to the default location on a Mac, which is determined by the The variable name must be the same as the original virtual machine file name (including the “.pvm” or “.pvmz” extension). The value should contain a name and path where you want the virtual machine to be copied on a Mac. Please note the following:
Examples:
|
| The URL of a custom HTML page is to be displayed as a banner in the Parallels Desktop Control Center window. To disable the banner, comment out the variable or specify an empty string as a value. |
| The banner height, in pixels. The recommended value is 350. To use the current value (if you are updating Parallels Desktop on a Mac), comment out the variable. |
| The banner's minimum width measured in pixels. When resizing the Control Center window, its minimum width will be limited accordingly. The recommended value is 350. To use the current value (if you are updating Parallels Desktop on a Mac), comment out the variable. To disable the minimum width limitation, comment out the variable or specify 0 (zero) as a value. |
| Specify whether the installer should override the hypervisor type of each deployed VM to 'Apple' on macOS 11.0 Big Sur and newer. All macOS versions since macOS Big Sur require a Mac reboot to run a VM with a hypervisor type other than 'Apple'. To forcibly change the hypervisor type to 'Apple', use the following setting:
|
| Specifies the update URL. Possible values are:
2) If you don't want to wait until Parallels Desktop Business Edition updates become available, you can specify the URL to download updates intended for Parallels Desktop Standard and Pro editions, which are released a bit earlier. For more info, please see Configuring Parallels Desktop Update Options. The URL is as follows (when assigning it to the variable, put it in quotes): https://update.parallels.com/desktop/vNN/parallels/parallels_sbscr_updates.xml Note: The "vNN" part in the URL above represents the current Parallels Desktop version number. Whichever version you would like to use, substitute the NN with the correct number. |
| Specifies how often Parallels Desktop should check for updates. Possible values:
|
| Specifies the automatic update download options:
|
| Specifies a URL of a page that will be displayed when a user selects the Help > Support Center menu option in the Parallels Desktop graphical user interface. To display the default message, specify an empty string (this is the default behavior). To display your own Web page (help desk, wiki, etc.), specify its URL. |
| Specifies a URL that will be included in error message dialogs related to licensing operations. The URL should point to a web page or a resource that the user can visit to get help with the problem. The error message appears when there's a problem activating, renewing, or deactivating a Parallels Desktop license. If you specify a URL using this variable, it will be included in the message dialog in the form "For details click <URL>". If you don't specify a URL (comment out the variable or specify an empty string), the default "Contact your system administrator" message will be displayed. |
|
|
| The current password (if one is already set in target Parallels Desktop installations). Use this key if you want to disable or change the current password, or if you want to enable/disable any of the protected actions when the password is already set. For the following cases, both the 1. To disable the password completely, the 2. To change the password, the 3. To enable/disable any of the actions without changing the password, both the |
| Custom password. If no password is currently set, use this key to specify the password. If a password is currently set, see the description above. |
|
|
|
|
|
|
|
|
|
|
The following set of parameters allows you to specify whether a local Mac administrator password is required to perform a corresponding action in Parallels Desktop. Please note that the parameters described above provide a higher level of security since they allow you to use a custom password. |
| Note: Supported since Parallels Desktop 15.
|
|
|
|
|
|
|
|
|
| Hide hostname in activation/heartbeat requests.
|
| Possible values:
If the parameter is commented out, Parallels Desktop will be deployed using the "standard" mode. When using the Single Application Mode, it is recommended to prepare Windows guest operating system to have auto login enabled. NOTE: Please note that you cannot redeploy Parallels Desktop with this option set to |
| Possible values:
Please note that this setting will be applied to every virtual machine included in the autodeploy package. You can also configure each virtual machine to hide (or show) developer tools before deployment, but with this option, you can apply the setting automatically during deployment. |
If you are running the autodeploy package from a network share mounted on a Mac (e.g., manually), then you should use "Copy"
because moving a virtual machine from a remote location will be as slow as copying it, plus the virtual machine will be removed from the package if you move it, so the package will become incomplete (you want it to stay intact if you want to install it on other Macs).
Allows you to change the default destination folder for virtual machines. The default folder is determined by the value of the vm_register_mode
variable (see above). The vm_destination_folder
variable allows you to change the default folder while retaining the selected virtual machine's registration mode parameter value.
The parameter in this section allows you to change a virtual machine's default target location and/or name when it is copied to a Mac computer.
If you choose to and deploy them using a publicly available link, you should set their names and destinations by providing an uncommented string with the link and the new name and destination, e.g.
"https://example-my.sharepoint.com/exmpleurl1?e=XXXX&download=1"="~/Parallels/PrivateVM.zip"
This and the two variables below are grouped together and allow you to customize Parallels Desktop Control Center by displaying a custom HTML banner at the top of its window. For additional information, see .
"Parallels"
— Download updates from the Parallels website over the Internet. Updates are downloaded from a special server hosting Parallels Desktop Business Edition updates, which become available on the server at a slightly later date compared to Parallels Desktop Pro edition. This is the default and recommended option. For more info, please see .
1) If you have a local update server, specify a complete URL (in quotes) of the parallels_updates.xml
file on your local Web server. For more information, please see .
See also .
See also .
The following set of parameters allows you to set a custom password and then specify whether this password is required to perform a corresponding action in Parallels Desktop. For more information about this feature, please see .
Hostname parameters.
Specifies whether to enable Single Application Mode. For more information, please see .
Specifies whether to show or hide developer tools in the Parallels Desktop GUI. For more information, please see .