modify-domain.pl

Change parameters of a virtual server

This command can be used to modify various settings for an existing virtual server from the command line. The only mandatory parameter is --domain, which must be followed by the domain name of the server to update. The actual changes to make are specified by the other optional parameters, such as --pass to set a new password, --desc to change the server description, and --quota and --uquota to change the disk quota.

To add a private IP address to a virtual server that currently does not have one, the --ip or --allocate-ip options can be used, as described in the section on create-domain.pl.

To revert a server with a private IP back to the system's default shared address, use the --default-ip flag. If the system has more than one shared address, the --shared-ip flag can be used to change it.

To change a server's domain name, the --newdomain option can be used. It must be followed by a new domain name, which of course cannot be used by any existing virtual server. When changing the domain name, you may also want to use the --user option to update the administration username for the server. Both of these options will effect sub-servers as well, where appropriate.

Command Line Help

Changes the settings for a Virtualmin server, based on the specified
command-line parameters.

usage: modify-domain.pl  --domain domain.name
                        [--desc new-description]
                        [--user new-username]
                        [--pass new-password]
                        [--email new-email]
                        [--quota new-quota]
                        [--uquota new-unix-quota]
                        [--newdomain new-name]
                        [--bw bytes|NONE]
                        [--resel reseller|NONE]
                        [--ip address] | [--allocate-ip] |
                        [--default-ip | --shared-ip address]
                        [--prefix name]
                        [--template name|id]
                        [--add-exclude directory]*
                        [--remove-exclude directory]*
 
virtualmin_api_modify_domain.txt (360 views) · Last modified: 2008/12/08 13:12
 
Recent changes RSS feed

Talk and Get Help

Support
Forums
Bugs and Issues

Get Virtualmin

OS Support
Buy Online
Download
Copyright 2005-2007 Virtualmin, Inc. All rights reserved.