Knowledgebase

 backup-domain

Backup one or more virtual servers This program is analogous to the Backup Virtual Servers page...

 change-license

Change a system’s Virtualmin license key This program updates all files that we know contain a...

 change-password

Changes the password of some Virtualmin user Designed to be called from Usermin’s Change...

 check-config

Run the Virtualmin config check This program checks your system’s Virtualmin configuration,...

 check-connectivity

Checks the external accessibility of virtual servers This command will run various tests to...

 clone-domain

Duplicates an existing virtual server with a new name This command will duplicate an existing...

 Command Line API

Virtualmin includes a powerful virtualmin command-line script, that can be run from the Unix...

 config-system

Perform initial configuration of system services This program is used to configure a system for...

 copy-mailbox

Copy mail from one location to another, perhaps converting formats The source mail is specified...

 create-admin

Creates an extra administrator for a virtual server This command creates a new administrator...

 create-alias

Create a new mail alias This command can be used to add a new email alias to a virtual server. It...

 create-database

Creates a database for a virtual server This command creates a new MySQL/MariaDB or PostgreSQL...

 create-domain

Create a virtual server This program can be used to create a new top-level, child or alias...

 create-login-link

Generates a link that can be used to login to Virtualmin This command can be used to login to...

 create-plan

Creates a new account plan for use with virtual servers This command allows you to create a new...

 create-protected-directory

Adds protection to a directory owned by some virtual server This command sets up protection for a...

 create-protected-user

Add a user to some protected directory This command adds a user to a protected directory,...

 create-proxy

Adds a per-directory proxy to some domain A proxy maps some URL on a virtual server to another...

 create-redirect

Adds a web redirect or alias to some domain A redirect maps some URL path like /foo to either a...

 create-reseller

Create one reseller account This command adds a single reseller account to your Virtualmin...

 create-rs-container

Creates a new empty Rackspace container This command creates a new container (directory) on...

 create-s3-bucket

Creates a new S3 bucket This command adds a bucket to Amazon’s S3 service. The login and password...

 create-shared-address

Adds an IP address for use by multiple virtual servers This command can be used to make an...

 create-simple-alias

Adds a mail alias to some domain, with simple parameters This command allows aliases using...

 create-template

Creates a template for use by new domains This command can be used to create a new virtual server...

 create-user

Create a mail, FTP or database user This program adds a new user to an existing virtual server....

 delete-admin

Deletes an extra administrator from a virtual server This command removes one extra administrator...

 delete-alias

Delete a mail alias This program simply removes a single mail alias from a virtual server. It...

 delete-backup

Delete one previous logged backup This command removes a Virtualmin backup, which can be...

 delete-database

Deletes one database To remove a single database from a virtual server and delete all of its...

 delete-domain

Delete one or more virtual servers To delete one or many servers (and all of their sub-servers...

 delete-php-directory

Remove any custom version of PHP for some directory If a specific version of PHP has been...

 delete-plan

Removes one existing account plan The plan to delete is specified either by ID with the --id...

 delete-protected-directory

Removes protection from a directory owned by some virtual server This command turns off...

 delete-protected-user

Removes a user from some protected directory This command removes a user from a protected...

 delete-proxy

Removes a proxy balancer from some domain This command deletes one proxy path from the virtual...

 delete-redirect

Removes a web redirect or alias from some domain This command deletes one redirect from the...

 delete-reseller

Delete one reseller This program deletes a single reseller account, specified by the --name...

 delete-rs-container

Deletes an existing Rackspace container This command deletes a container (directory) from...

 delete-rs-file

Deletes a single file from a Rackspace container This command deletes a file from Rackspace’s...

 delete-s3-bucket

Deletes an entire S3 bucket This command removes a bucket from Amazon’s S3 service. The login and...

 delete-s3-file

Deletes a single file from an S3 bucket This command removes a single file from Amazon’s S3...

 delete-script

Un-install one script from a virtual server This program completely removes a third-party script...

 delete-shared-address

Removes an IP address that can be used by virtual servers This command takes a single IP address...

 delete-template

Removes one virtual server template This command can be used to delete a Virtualmin template,...

 delete-user

Delete a mail, FTP or database user This command deletes one mail, FTP or database user from a...

 disable-domain

Temporarily disable a virtual server When a server is disabled, it will become temporarily...

 disable-feature

Turn off some features for a virtual server This program is very similar to enable-feature, and...

 disable-limit

Removes access to some feature or edit capability for some virtual servers This command can be...

 disable-writelogs

Disable logging via program This command is the opposite enable-writelogs. The domains that it...

 disconnect-database

Removes a database from the control of a virtual server This command removes access to a database...

 DomainKeys Identified Mail

DomainKeys Identified Mail (DKIM) is a standard that enhances email security by enabling the...

 downgrade-license

Downgrade Virtualmin Pro system to GPL version If you want to keep using Virtualmin on the same...

 download-dropbox-file

Downloads a single file from a Dropbox This command downloads a single file from Dropbox to your...

 download-rs-file

Downloads a single file from a Rackspace container This command downloads a file to your...

 download-s3-file

Downloads a single file from an S3 bucket This command downloads a single file from Amazon’s S3...

 enable-domain

Re-enable one virtual server This program reverses the disable process done by disable-domain ,...

 enable-feature

Turn on some features for a virtual server To enable features for one or more servers from the...

 enable-limit

Grants access to some feature or edit capability for some virtual servers This command can be...

 enable-writelogs

Enable logging via program By default, Virtualmin configures Apache to log to files in each...

 FAQ

FAQ Installation Should I pre-install Webmin before I run virtualmin-install.sh script? No....

 fix-domain-permissions

Set correct permissions on a domain’s home directory This command ensures that the ownership and...

 fix-domain-quota

Set the Unix quotas for some domains to match the Virtualmin configuration This command can be...

 generate-cert

Generate a new self-signed cert or CSR for a virtual server A self-signed certificate is one that...

 generate-letsencrypt-cert

Requests and installs a Let’s Encrypt cert for a virtual server The server must be specified with...

 get-command

Show information about some command This command outputs information about another API command,...

 get-dns

Output all DNS records for a domain For virtual servers with DNS enabled, this command provides...

 get-logs

Output webserver logs for a domain Given a domain name with the --domain flag, this command...

 get-ssl

Output SSL certificate information for a domain Given a domain name with the --domain flag, this...

 get-template

Outputs all settings in a template This command can be used to output all settings in a...

 How to Backup and Restore Virtual Servers

This tutorial provides detailed guidance on creating and restoring backups for virtual servers in...

 How to Configure LDAP

This documentation explains how Virtualmin can be setup to store users and mail aliases in an...

 import-database

Adds an existing database to a virtual server This command finds a MySQL/MariaDB or PostgreSQL...

 info

Show general information about this Virtualmin system This command is useful when debugging or...

 install-cert

Replace the SSL certificate or private key for a virtual server This command is typically used to...

 install-script

Install one third-party script This program performs the actual upgrade or install of a script...

 install-service-cert

Copy the cert and key from a virtual server to some other service The domain to copy the cert...

 license-info

Show license counts for this Virtualmin system This command simply outputs the serial number and...

 list-admins

Lists administrators belonging to a virtual server This program simply displays a list of extra...

 list-aliases

List aliases for a virtual server This program displays a list of mail aliases that exist in the...

 list-available-scripts

List known scripts This command simply outputs a list of scripts that can potentially installed...

 list-available-shells

List all shells for use with domain owners and mailboxes When run with no flags, this command...

 list-backup-keys

Lists all available backup encryption keys When run with no flags, this command outputs a table...

 list-backup-logs

Outputs a list of backups that have been run This command by default outputs logs of all backups...

 list-bandwidth

Shows bandwidth usage for some domain over a date range This command is useful for dumping...

 list-certs

Output the certificates for some or all virtual servers The virtual servers to list can be...

 list-certs-expiry

Output the certificates expiry date for matching or all existing virtual servers This program can...

 list-commands

Lists API scripts available This command lists all API commands available, categorized by type...

 list-config-revisions

List configuration file revisions from Git This command lists revisions of configuration files...

 list-custom

List custom fields for virtual servers When this command is run with no parameters, it will...

 list-databases

Lists databases for some virtual server This program simply displays a list of MySQL/MariaDB and...

 list-domains

Lists all virtual servers This program does not modify the system, but instead simply outputs a...

 list-dropbox-files

Lists all files under a Dropbox path This command lists all files under a path owner by the cloud...

 list-features

Lists features available when creating a domain This command outputs information about Virtualmin...

 list-gcs-buckets

Lists all buckets owned by the Google Cloud Storage This command lists all buckets under the...

 list-gcs-files

Lists all files in a Google Cloud Storage bucket This command lists all files in a bucket under...

 list-mailbox

Dump inbox email for one user This program is primarily for debugging and testing. It finds the...

 list-mysql-servers

Lists all registered remote MySQL servers This command lists all registered MySQL servers that...

 list-php-directories

List all directories in which a specific version of PHP has been activated By default this...

 list-php-ini

Show PHP variables for some or all domains This command can be used to list the value of a PHP...

 list-php-versions

Lists the available PHP versions on this system This command simply outputs a table of the...

 list-plans

List available account plans for new domains The command simply outputs a list of available plans...

 list-ports

Lists TCP ports associated with some virtual server This command lists all TCP ports in use by or...

 list-protected-directories

Lists protected directories owned by some virtual server This command outputs a table of all...

 list-protected-users

Lists users in some protected directory This command outputs a table of all users with access to...

 list-proxies

Lists web proxy balancers in some domain This command lists all the proxies configured for some...

 list-redirects

Lists web redirects and aliases in some domain This command lists all the aliases configured for...

 list-resellers

List existing resellers When run with no parameters, this program simply displays a...

 list-rs-containers

Lists all containers owned by a Rackspace account This command queries Rackspace’s cloud files...

 list-rs-files

Lists all files in a container owned by a Rackspace account This command queries Rackspace’s...

 list-s3-buckets

Lists all buckets owned by an S3 account This command queries Amazon’s S3 service for the list of...

 list-s3-files

Lists files in one S3 bucket This command queries Amazon’s S3 service for the list of files in a...

 list-scheduled-backups

Outputs a list of scheduled backups By default, this program displays a table of all scheduled...

 list-scripts

Display script installed into some virtual server The virtual servers to display scripts for can...

 list-server-statuses

Outputs the status of all servers managed by Virtualmin This command checks the status of your...

 list-service-certs

Output a virtual server’s certificates used by other services The only required flag is --domain,...

 list-shared-addresses

Lists shared IP addresses for virtual servers This command outputs a list of shared IP addresses...

 list-simple-aliases

Lists mail aliases in a simple format for some domain This program is similar to list-aliases,...

 list-templates

List available templates for new domains The command simply outputs a list of available templates...

 list-users

List users in a virtual server To get a list of users associated with some virtual server, this...

 Manual Installation

Unlike the Automated Virtualmin installation, to make use of this installation type, your OS does...

 migrate-domain

Imports a virtual server from some other product Virtualmin has the capability to import servers...

 modify-admin

Updates an extra administrator for a virtual server This program can be used to change the...

 modify-all-ips

Update all virtual servers with a new IP address This command updates all virtual servers using...

 modify-custom

Modify custom fields for a virtual server This program updates the value of one or more fields...

 modify-database-hosts

Adds or removes an allowed MySQL host for some or all domains This command can change the remote...

 modify-database-pass

Changes the MySQL/MariaDB or PostgreSQL password for some domain This command changes the...

 modify-database-user

Changes the MySQL/MariaDB or PostgreSQL login for some domain This command changes the username...

 modify-dns

Change DNS settings for virtual servers This program updates DNS-related options for one or more...

 modify-domain

Change parameters of a virtual server This command can be used to modify various settings for an...

 modify-limits

Changes the owner limits for some virtual server This command allows you to change various limits...

 modify-mail

Change mail-related settings for some domains This command can be used to configure BCC of...

 modify-php-ini

Changes PHP variables for some or all domains This command can be used to change the value of a...

 modify-plan

Modifies an existing account plan for use with virtual servers This command allows you to modify...

 modify-proxy

Changes a proxy balancer from some domain This command updates one proxy path from the virtual...

 modify-reseller

Modify attributes for an existing reseller This command can be used to change the details of a...

 modify-resources

Changes resource limits for some virtual servers This program allows you to change limits on...

 modify-scheduled-backup

Change some attributes of a scheduled backup This command can be used to change some attributes...

 modify-spam

Change spam filtering and delivery settings for a virtual server This command can be used to...

 modify-template

Changes one or more settings in a template This command can be used to change several settings in...

 modify-user

Change attributes of a mail, FTP or database user After a user has been created from the command...

 modify-users

Modify attributes of some or all users for some or all virtual servers This command can be used...

 modify-web

Change a virtual server’s web configuration This script can update the PHP and web forwarding...

 move-domain

Change the owner of a virtual server This command can be used to move a sub-server from one...

 notify-domains

Send email to some or all virtual server owners This command can be used to send a text format...

 rename-domain

Change the domain name, home directory or username of a virtual server This command is typically...

 resend-email

Re-send the signup email for a domain This command re-sends the initial sign-up email to a...

 reset-feature

Reset some virtual server feature back to it’s default This command resets the configuration for...

 reset-pass

Resets the password for some or all users in some or all virtual servers This command can be used...

 restart-server

Restarts one of the servers managed by Virtualmin This command stops and re-starts one of the...

 restore-config-revision

Restore configuration files from Git revisions This command restores configuration files from the...

 restore-domain

Restore one or more virtual servers To restore a Virtualmin backup from the command line, you...

 run-all-webalizer

Run Webalizer reports for all virtual servers This is designed to be called from Cron, instead of...

 run-api-command

Executes another API command over multiple servers Some Virtualmin API commands can only run on a...

 search-maillogs

Searches mail server and procmail logs This is the command-line equivant of the Search Mail Logs...

 set-dkim

Enable or disable DKIM for all domains To enable DKIM signing of outdoing emails, run this...

 set-global-feature

Turns on or off some Virtualmin feature or plugin globally This command is the equivalent of the...

 set-mysql-pass

Change the root MySQL password, even if the current password is unknown This command can be used...

 set-php-directory

Set the version of PHP to run in some directory If more than one version of PHP is installed on...

 set-spam

Change the spam and virus scanners for all domains By default, Virtualmin uses the stand-alone...

 setup-repos

Setup Virtualmin repositories This command sets up or repairs Virtualmin software repositories....

 start-stop-script

Stops, starts or restarts the server process for some script This command can be used to start,...

 syncmx-domain

Updates allowed relay addresses in one or more domains This command can be used to bring the...

 test-imap

Checks if IMAP login to some server works This is a tool for testing IMAP servers. It takes...

 test-pop3

Checks if POP3 login to some server works This is a tool for testing POP3 servers. It takes...

 test-smtp

Checks if the mail server can RCPT to some address This command is debugging tool for mailboxes...

 transfer-domain

Move a virtual server to another system This command copies or moves a virtual server to another...

 Troubleshooting Installation

Most installation problems are related to having third party repositories enabled, attempting to...

 unalias-domain

Convert an alias domain into a sub-server This command can be used to convert an alias server...

 unsub-domain

Convert a sub-domain into a sub-server This command can be used to convert a sub-domain into a...

 upgrade-license

Upgrade Virtualmin GPL system to Pro version This program can be used to upgrade Virtualmin GPL...

 upload-dropbox-file

Uploads a single file to Dropbox This command uploads a file from your Virtualmin system to...

 upload-rs-file

Uploads a single file to a Rackspace container This command uploads a file from your Virtualmin...

 upload-s3-file

Uploads a single file to an S3 bucket This command uploads a file from your Virtualmin system to...

 validate-domains

Check the configuration of virtual servers This program can be used to generate a report on...

 WP Workbench

WP Workbench is a specially crafted Virtualmin plugin that simplifies WordPress management. It...