Previous page

Next page

Locate page in Contents

Print this page

pctl list

Obtains a list of virtual machines on the Parallels server. The command allows to obtain a summary list containing only the virtual machine ID, name, and status, or to obtain a detailed information about a specific or all virtual machines.

Syntax

pctl list [ --all ] [ --template ] [ --no-header ]

[ -o, --output name [, name ...]] [ -s , --sort name | -name ]

pctl list --info [ ID | name ]

Parameters

Name

Description

-a, --all

List all, running, stopped, suspended, and paused virtual machines. If this and the rest of the parameters are omitted, only the running virtual machines will be displayed.

-t, --template

List the available virtual machine templates. The real virtual machines will not be included in the output.

--no-header

Do not display column headers.

-o, --output name

Display one (or any combination) of the following fields:

  • uuid -- Virtual machine ID.
  • name -- Virtual machine name.
  • status --Virtual machine status (running, stopped, etc.).

The above fields can be combined in a single command using comma separator (e.g. uuid, name ). The excluded fields will not be displayed. The field names must be typed in lower case.

-s, --sort name

Sort the virtual machine list by the specified parameter in ascending order.

-i, --info

Display detailed information about a virtual machine.

-f, --full

Display detailed information about the network cards in a virtual machine. Should be used with the --info option.

ID

The ID of the virtual machine for which to display the detailed information. If not specified, the information will be displayed for all registered virtual machines.

name

The name of the virtual machine for which to display the detailed information. If not specified, the information will be displayed for all registered virtual machines.

Links

General Syntax , Legend