> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/parallels-desktop-developers-guide/command-line-interface-utility/manage-virtual-machines-from-cli/virtual-machine-configuration-tasks/security-parameters.md).

# 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**

{% hint style="warning" %}
**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).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.parallels.com/landing/parallels-desktop-developers-guide/command-line-interface-utility/manage-virtual-machines-from-cli/virtual-machine-configuration-tasks/security-parameters.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.