This page lists many of the template variables that you can use in email messages to domain owners and mailboxes, initial website content, Apache and BIND configurations and many other places in Virtualmin. In all cases, variables like ${DOM} or $DOM will be replaced with the value from the domain or mailbox being created, such as foo.com. Additional variables can be found by looking in "/etc/webmin/virtual-server/domains/DOMAIN_ID". The parameters found in the files named "DOMAIN_ID" can all be used in the template variables.

The following variables are available in any template related to a virtual server.

In addition, any custom fields will be available in variables named $FIELD_fieldname , where fieldname is the name of the custom field.

The follow variables are available in any virtual-server related template, and will be set to 1 if the feature they are related to is enabled, 0 if not. They are most useful in blocks like ${IF-DNS} ... ${ENDIF-DNS}.

The following variables are similar, but are associated with plugin features :

When the template is related to a sub-server, variables for the parent server are also available. These are the same as those for the actual server, but with PARENT_DOMAIN_ prefixed, like $PARENT_DOMAIN_HOME and $PARENT_DOMAIN_DOM.

The following variables can be used in templates related to mailbox or FTP users, such as the email message sent when a mailbox is created :

If you have configured Virtualmin to run a script before or after a virtual server is modified, all of the variables listed on this page are available in Unix environment variables. However, they are prefixed with VIRTUALSERVER_ , such as $VIRTUALSERVER_DOM for the domain name. Also, any dashes are replaced with _ , so the variable to check for the AWstats plugin would be $VIRTUALMIN_AWSTATS

You could use them in a script like so :

#!/bin/sh
if [ "$VIRTUALSERVER_ACTION" = "CREATE_DOMAIN" ]; then
  echo Virtual server $VIRTUALSERVER_DOM has been created >>/var/log/virtualmin
fi

The $VIRTUALSERVER_ACTION variable can have one of the following values :