list-domains.pl

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, --no-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 limit the list to virtual servers on some plan, use the --plan flag followed by a plan name or ID. Similarly, you can select only virtual servers created using some template with the --template flag, followed by an ID or name.

To show only domains owned by some reseller, use the --reseller flag followed by a reseller name. Or to list those not owned by any reseller, use the --no-reseller flag. Finally, to list domains owned by any reseller, you can use the --any-reseller option.

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. You can also use --user-only to output only usernames, or --home-only to get just home directories, or --simple-multiline to get a faster subset of the information output in --multiline mode.

Command Line Help

virtualmin list-domains [--multiline | --name-only | --id-only |
                         --simple-multiline | --user-only | --home-only]
                        [--domain name]*
                        [--user name]*
                        [--id number]*
                        [--with-feature feature]
                        [--without-feature feature]
                        [--alias | --no-alias | --subserver |
                         --toplevel | --subdomain]
                        [--plan ID|name]
                        [--reseller name | --no-reseller |
                         --any-reseller]