Lists all virtual servers.

This program does not modify the system, but instead simply outputs a list of all existing virtual servers. By default, the list is a reader-friendly format, but the --multiline option can be used to display more details for each server, in a format suitable for parsing by other programs. The --domain option can be used to specify a single virtual server to list, in cases where you know exactly which server you are interested in.

To limit the domains to those owned by a single user, the --user parameter can be given, following by a domain owner's name. You can also limit it to particular server types with the --alias, --subserver, --toplevel and --subdomain parameters. Or to only show domains with a particular feature active, use the --with-feature parameter followed by a feature code like dns or web. Alternately, --without-feature can be used to show only domains without some feature enabled.

To get a list of domain names only, use the --name-only parameter. To get just Virtualmin domain IDs, use --id-only. These are useful when iterating through domains in a script.

usage: list-domains.pl   [--multiline | --name-only | --id-only]
                         [--domain name]*
                         [--user name]*
                         [--with-feature feature]
                         [--without-feature feature]
                         [--alias | --subserver |
                          --toplevel | --subdomain]