qvm-ls – List qubes and various information about them

Synopsis

qvm-ls [–verbose] [–quiet] [–help] [–all]

[–exclude EXCLUDE] [–spinner] [–no-spinner] [–format FORMAT | –fields FIELD [FIELD …] | –disk | –network | –kernel] [–tree] [–raw-data] [–raw-list] [–help-formats] [–help-columns] [–class CLASS [CLASS …]] [–label LABEL [LABEL …]] [–tags TAG [TAG …]] [–exclude-tags TAG [TAG …]] [–running] [–paused] [–halted] [–template-source TEMPLATE [TEMPLATE …]] [–netvm-is NETVM [NETVM …]] [–internal <y|n>] [–servicevm <y|n>] [–pending-update] [–features FEATURE=VALUE [FEATURE=VALUE …]] [–prefs PREFERENCE=VALUE [PREFERENCE=VALUE …]] [–sort COLUMN] [–reverse] [–ignore-case] [VMNAME …]

Positional arguments

VMNAME ...

Zero or more domain names

General options

--help, -h

Show help message and exit

--verbose, -v

Increase verbosity.

--quiet, -q

Decrease verbosity.

--all

List all qubes, this is default.

--exclude

Exclude the qube from –all. You need to use –all option explicitly to use –exclude.

--spinner

Have a spinner spinning while the spinning mainloop spins new table cells.

--no-spinner

No spinner today.

--version

Show program’s version number and exit

Formatting options

--format=FORMAT, -o FORMAT

Sets format to a list of columns defined by preset. All formats along with columns which they show can be listed with --help-formats.

--fields=FIELD,..., -O FIELD,...

Sets format to specified set of columns. This gives more control over --format. All columns along with short descriptions can be listed with --help-columns.

--tree, -t

List qubes as a network tree. Qubes are sorted as they are connected to their netvms. Names are indented relative to the number of connected netvms.

--raw-data

Output data in easy to parse format. Table header is skipped and columns are separated by | character.

--raw-list

Give plain list of VM names, without header or separator. Useful in scripts. Same as –raw-data –fields=name

--disk, -d

Same as –format=disk, for compatibility with Qubes 3.x

--network, -n

Same as –format=network, for compatibility with Qubes 3.x

--kernel, -k

Same as –format=kernel, for compatibility with Qubes 3.x

--help-columns

List all available columns with short descriptions and exit.

--help-formats

List all available formats with their definitions and exit.

Filtering options

--class CLASS ...

Show only qubes of specific class(es)

--label LABEL ...

Show only qubes with specific label(s)

--tags TAG ...

Shows only qubes having specific tag(s).

--exclude-tags TAG ...

Exclude qubes having specific tag(s).

--running, --paused, --halted

Shows only qubes matching the specified power state(s). When none of these options is used (default), all qubes are shown.

--template-source TEMPLATE ...

Filter results to the qubes based on the TEMPLATE(s)

--netvm-is NETVM ...

Filter results to the qubes connecting via NETVM(s)

--internal <y|n>

Show only internal qubes or exclude them from output

--servicevm <y|n>

Show only servicevms or exclude them from output

--pending-update

Filter results to qubes pending for update

--features FEATURE=VALUE ...

Filter results to qubes that match all specified features. Omitted VALUE means None (unset). Empty value means “” or ‘’ (blank)

--prefs PREFERENCE=VALUE ...

Filter results to qubes that match all specified preferences. Omitted VALUE means None (unset). Empty value means “” or ‘’ (blank)

Sorting options

--sort COLUMN

Sort based on provided column rather than NAME. Sort key must be in the output columns

--reverse

Reverse sort

--ignore-case

Ignore case distinctions when sorting

Authors

Joanna Rutkowska <joanna at invisiblethingslab dot com>
Rafal Wojtczuk <rafal at invisiblethingslab dot com>
Marek Marczykowski <marmarek at invisiblethingslab dot com>
Wojtek Porczyk <woju at invisiblethingslab dot com>