4.1.1. General Syntax

The prlctl utility is used to perform administration tasks on virtual machines. The utility supports a full range of tasks from creating and administering virtual machines to getting statistics and generating problem reports.

Syntax. 

prlctl <command> <VM_name> [<options>] [-v, --verbose <number>] [--timeout <sec>]
       [-l, --login [<user>[:_<passwd>_]@]<server>] [-p, --read-passwd <file>]]

Table 4.1. Options

NameDescription

<command>

The name of the command to execute.

<VM_name>

The name of the virtual machine to perform the operation on. To obtain the list of the available virtual machines, use the prlctl list command.

<options>

Command options. See individual commands for available options.

-v, --verbose <number>

Enables verbose output. The greater the <number>, the higher the verbosity.

-l, --login [<user>[:<passwd>]@]<server>

Connect to a remote <server> with the specified credentials. If this flag is omitted, the prlctl command is assumed to be run locally.

-p, --read-passwd <file>

Use the password from the file <file> to log in to a remote hardware node, other credentials being specified with the --login option. The --read-passwd option can be specified multiple times in order to form a password stack for operations requiring multiple passwords. Each password must be supplied in a separate file.

To display help, enter prlctl without any options.