Skip to content

Hash Variables

This page describes how to override several module's options be settings parameters in Access Hash field.

Resource Chooser

Variable Value Description
<custom-config-memory>value</custom-config-memory> Numeric Name of resource selector configurable option for memory. If unspecified default is Memory
<custom-config-diskspace>value</custom-config-diskspace> Numeric Name of resource selector configurable option for disk space. If unspecified default is Disk Space
<custom-config-bandwidth>value</custom-config-bandwidth> Numeric Name of resource selector configurable option for bandwidth. If unspecified default is Bandwidth
<custom-config-cpu>value</custom-config-cpu> Numeric Name of resource selector configurable option for cpu cores. If unspecified default is CPU
<custom-config-extraip>value</custom-config-extraip> Numeric Name of resource selector configurable option for extra ips. If unspecified default is Extra IP Address

Operating System Selector

Variable Value Description
<openvz-os-selector-name>value</openvz-os-selector-name> Text String Name of operating system selector configurable option for OpenVZ. If unspecified default is Operating System
<xenpv-os-selector-name>value</xenpv-os-selector-name> Text String Name of operating system selector configurable option for Xen PV. If unspecified default is Operating System
<xenhvm-os-selector-name>value</xenhvm-os-selector-name> Text String Name of operating system selector configurable option for Xen HVM. If unspecified default is Operating System
<kvm-os-selector-name>value</kvm-os-selector-name> Text String Name of operating system selector configurable option for KVM. If unspecified default is Operating System

Group Selector

Variable Value Description
<openvz-group-selector-name>value</openvz-group-selector-name> Text String Name of group selector configurable option for OpenVZ. If unspecified default is Location
<xenpv-group-selector-name>value</xenpv-group-selector-name> Text String Name of group selector configurable option for Xen PV. If unspecified default is Location
<xenhvm-group-selector-name>value</xenhvm-group-selector-name> Text String Name of group selector configurable option for Xen HVM. If unspecified default is Location
<kvm-group-selector-name>value</kvm-group-selector-name> Text String Name of group selector configurable option for KVM. If unspecified default is Location

Control Panel Selector

Variable Value Description
<control-panel-selector-name>value</control-panel-selector-name> Text String Name of control panel selector configurable option. If unspecified default is Control Panel

Default Product Override

Variable Value Description
<default-openvz-node>value</default-openvz-node> Text String This will overide the server any OpenVZ vps are created on. VALUE must be the name of the server as listed in SolusVM
<default-xen-node>value</default-xen-node> Text String This will overide the server any Xen PV vps are created on. VALUE must be the name of the server as listed in SolusVM
<default-hvm-node>value</default-hvm-node> Text String This will overide the server any Xen HVM vps are created on. VALUE must be the name of the server as listed in SolusVM
<default-kvm-node>value</default-kvm-node> Text String This will overide the server any KVM vps are created on. VALUE must be the name of the server as listed in SolusVM

General

Variable Value Description
<debug>value</debug> on/off This will give you debug output to screen when you run a module function. Only switch this on when you are testing, allways turn it off when you have finished with it
<port>value</port> numeric port number This will force the module to talk to the master on a custom port
<username-prefix>value</username-prefix> String Enter a default username prefix for the client login to solusvm. i.e: vmuser , When a client has multiple vps they will be created under the same account
<default-hostname>value</default-hostname> Hostname Specify a default hostname if no hostname is specified on order. i.e: vps.server.com. If not specified, vps.server.com will be used
<connect-timeout>value</connect-timeout> Number Specify a custom connection timout for the api (optional)
<connect-data-timeout>value</connect-data-timeout> Number Specify a custom data connection timout for the api (optional)
<admin-control>value</admin-control> enable/disable Enable/Disable the admin area controls. Default is enabled
<admin-control-type>value/admin-control-type> onload/ondemand Show admin control on page load or on demand. Default is onload
<controlpanelbutton-admin>value</controlpanelbutton-admin> url to admincp Button that links to admincp. Button will now show if left unspecified
<removeip-terminated-product>value</removeip-terminated-product> yes/no Remove ip's from terminated products. Default is yes
<connect-via-hostname>value</connect-via-hostname> yes/no Connect to SolusVM using the hostname instead of ipaddress. Default is no
<htpasswd-username>value</htpasswd-username> Username .htpasswd username if you are using basic authentication on the api
<htpasswd-password>value</htpasswd-password> Password htpasswd password if you are using basic authentication on the api
<randomipv4>value</randomipv4> on/off Create virtual server with a random IPv4 address
<disable-change-package>value</disable-change-package> on/off Disable automatic upgrade/downgrades

Client Area

Variable Value Description
<serialconsole>value</serialconsole> enable/disable Enable/Disable the clientarea serial console. Default is enable
<html5serialconsole>value</html5serialconsole> enable/disable Enable/Disable the clientarea HTML5 serial console. Default is enable
<vnc>value</vnc> enable/disable Enable/Disable the clientarea vnc. Default is enable
<consolepassword>value</consolepassword> enable/disable Enable/Disable the clientarea change console password function. Default is enable
<vncpassword>value</vncpassword> enable/disable Enable/Disable the clientarea change vnc password function. Default is enable
<rootpassword>value</rootpassword> enable/disable Enable/Disable the clientarea change root password function. Default is enable
<hostname>value</hostname> enable/disable Enable/Disable the clientarea change hostname function. Default is enable
<reboot>value</reboot> enable/disable Enable/Disable the clientarea reboot button. Default is enable
<boot>value</boot> enable/disable Enable/Disable the clientarea boot button. Default is enable
<shutdown>value</shutdown> enable/disable Enable/Disable the clientarea shutdown button. Default is enable
<graphs>value</graphs> enable/disable Enable/Disable displaying graphs in the client area. Default is enable
<vstatus>value</vstatus> enable/disable Enable/Disable displaying the virtual server status in the client area. Default is enable
<iplist>value</iplist> enable/disable Enable/Disable displaying the list of ipaddresses in the client area. Default is enable
<memusage>value</memusage> enable/disable Enable/Disable displaying the virtual server memory usage. Default is enable
<diskusage>value</diskusage enable/disable Enable/Disable displaying the virtual server disk usage. Default is enable
<bwusage>value</bwusage> enable/disable Enable/Disable displaying the virtual server bandwidth usage. Default is enable
<controlpanelbutton>value</controlpanelbutton> Link to control panel Add a login to control panel button to the clientarea controls. Unless specified, this feature is disabled
<clientkeyauth>value</clientkeyauth> enable/disable Enable/Disable client authentication button. Unless specified, this feature is disabled
<clientfunctions>value</clientfunctions> enable/disable Enable/Disable all the client functions. Default is enable