Parallels Desktop Developer's Guide
ProductsSupportDocumentation
  • Introduction
    • Parallels Desktop in Software Development
    • Optimizing Your Virtual Machine for Software Development
    • Download Pre-Configured Virtual Machines
  • Software Development-specific Functions of Parallels Desktop
    • Optimizing Remote Debugging
    • Generating a Core Dump
    • Using VM Names as DNS Names
    • Starting a Debugging Session
    • Establishing a Serial Connection over TCP
    • Using Rosetta to Run x86-64 Linux Software on Apple Silicon Macs
    • Resolving Guest OS DNS Requests Using etc/hosts
    • Changing the Virtual Screen Resolution on the Fly
    • Nested Virtualization Support
    • Simulating Adverse Network Connectivity Conditions
  • DevOps Service
  • AI Development with Parallels Desktop
    • Installing a Dedicated AI Development Virtual Machine
    • Using the Parallels AI Virtual Machine for Development
  • Integrations and Plugins
    • Integration with Chef/Ohai
    • Integration with Packer
    • Visual Studio Code Extension
    • Integration with Terraform
    • Integration with Vagrant
  • Command-Line Interface Utility
    • Manage Parallels Desktop from CLI
      • Display Parallels Desktop Information
      • License Management
        • Sign into Parallels Account
        • Install a Parallels Desktop License
        • Install/Remove a Deferred License
        • Update a License
        • Deactivate a License
      • Parallels Desktop Preferences
      • User List and Virtual Machine Location
      • Virtual Network Information and Settings
      • USB Devices
      • Report a Problem
      • Shut Down Parallels Desktop
      • Error Handling
    • Manage Virtual Machines from CLI
      • General Virtual Machine Management
        • List Virtual Machines
        • Create a Virtual Machine
        • Delete a Virtual Machine
        • Register/Unregister a Virtual Machine
        • Clone a Virtual Machine
        • Convert a Virtual Machine
        • Move Virtual Machine Files
        • Install Parallels Tools
        • Log into a Virtual Machine
        • Execute a Command in a Virtual Machine
        • Send a Keyboard Event to a Virtual Machine
          • List of Parallels Keyboard Key Codes
        • Query the Virtual Machine Status
        • Power Operations
        • Capture a Screen Area
        • Encrypt/Decrypt a Virtual Machine
        • Archive/Unarchive a Virtual Machine
        • Set Password Protection
      • Virtual Machine Configuration Tasks
        • CPU and Memory Parameters
        • Boot Order Parameters
        • Video Parameters
        • Mouse & Keyboard Parameters
        • Virtual Printer Parameters
        • USB & Bluetooth Parameters
        • Startup & Shutdown Parameters
        • Optimization Parameters
        • Sharing Parameters
        • Coherence Parameters
        • Security Parameters
        • Expiration Date Parameters
        • Device Management
          • Common Options
          • Adding/Modifying a Device
          • Virtual Hard Drive
          • Physical Hard Drive
          • Virtual Optical Drive
          • Physical Optical Drive
          • Virtual Floppy Drive
          • Physical Floppy Drive
          • Virtual Network Adapter
          • Virtual Serial Port
          • Virtual Parallel Port
          • Virtual Sound Card
          • Adding USB Support
        • Shared Folders
        • Advanced Settings
        • Miscellaneous
      • Snapshot Management
        • Taking a Virtual Machine Snapshot
        • Deleting a Snapshot
        • Listing Snapshots
        • Reverting to a Snapshot
      • Miscellaneous
        • Generating a Problem Report
        • Using Guest Debugger
        • Creating a VM Dump
      • Virtual Machine Disk Optimization
      • Error Handling
  • Parallels Open Source Initiatives
Powered by GitBook

Other Resources

  • Community Forum
  • Knowledge Base
  • Request Support

Social Media

  • Facebook
  • Twitter/X
  • YouTube
  • LinkedIn

© 2025 Parallels International GmbH. All rights reserved.

On this page
  1. Command-Line Interface Utility
  2. Manage Virtual Machines from CLI
  3. Virtual Machine Configuration Tasks

Security Parameters

--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).

PreviousCoherence ParametersNextExpiration Date Parameters

Last updated 1 year ago