What does each of the variables do in the VMware module settings file?

$mstrVMWareWebServerCustomFieldName = "";
This is the custom field for each product that will use VMware. This custom fields' value is the VMWare VM name so the module knows what VM to access for a customers plan. This is a string and should look something like:
$mstrVMWareWebServerCustomFieldName = "VM Name";

$mblnEnableVMBandwidthRecievedData = false;
This settings is either true or false, a Boolean, and if set to true and bandwidth monitoring is enabled, it also will retrieve incoming data transfer for the VMs as well as outgoing transfer.

$maryVMwareConsoleTempUsers = Array("WHMCSVmwareConsoleUser1"=>"WHMCSVmwareConsoleUser1Password","WHMCSVmwareConsoleUser2"=>"WHMCSVmwareConsoleUser2Password");
This setting is an array and contains the VMware Console users username and password that will be used for each user when they request to open a console in WHMCS. You must create these users in VMware and assign them a console only interaction role. If you have a domain in windows or linux then you must precede the username with the domain and a backslash such as domainuser

$mstrVMwareConsoleTempUserToCopyRoleFrom = "WHMCSVmwareConsoleUser1";
This setting is a string and containts the username of the first user listed in the user array config settings $maryVMwareConsoleTempUsers. This user must be assigned to a VM and is used to copy the role that is assigned to this user to all the other users in the $maryVMwareConsoleTempUsers setting when used to open consoles.

$mblnSuspendVMInsteadOfShutdown = false;
This setting is either true or false, a Boolean, and when set to true and WHMCS suspends a service with a VM in VMware, it suspends the VM in VMware. If set to false then instead of suspended the VM, it does a soft shutdown of the VM instead.

$mblnOnWHMCSTerminateContinueIfVMMissing = false;
This setting is either true or false, a Boolean, and when set to false and WHMCS termiantes a service and the VM cannot be found then the terminate fails. If set to true and the VM does not exist in VMware (or cannot be found) then the terminate function in WHMCS is successful.

$mblnDoVIXAutoProvisioning = false;
This setting is either true or false, a Boolean, and when set to false uses the old SSH provisioning method, which is not recommend any more. It is recommend to set this to true and use the VIX method with vSphere 5.x and higher with the WHMCS add-on module to configure auto-provisioning.

$mblnShowAllDatastores = false;
This setting is either true or false, a Boolean, and when set to true will show local data stores to the ESX/ESXi servers, as well as shared data stores.

$mblnEnableVMwareConsoleHTML5 = false;
This setting is either true or false, a Boolean, and when set to true will use the HTML5 console instead of the VMware Web Browser (VMRC) plugin.

$mintVMwareConsoleUserExpireHours = 6;
This setting is an interger, in hours, and sets the time for when a console user is automatically disconnected from a VM. This is used to prevent users being tied up to VMs when not in use.

$mintVMwareConsoleUserExpireMinutes = 0;
This setting is an interger, in minutes, and sets the time for when a console user is automatically disconnected from a VM. This is used to prevent users being tied up to VMs when not in use. This setting overrides the hours setting above.

$mblnEnableVMwareConsoleHTML5HostFix = False;
This setting is either true or false, a Boolean, and when set to true fixes an issue with vSphere 5.x under certain installation conditions and the HTML5 console does not connect correctly (errors out with disconnect message).

$mblnEnableVMwareConsoleHTML5ThumbprintFix = False;
This setting is either true or false, a Boolean, and when set to true fixes an issue with vSphere 5.x under certain installation conditions and the HTML5 console does not connect correctly (errors out with disconnect message).

$mintVersionHTMLMKSVersionOverride = 0;
This setting is a numeric value when set and allows you to set what URL and port ot use for the HTML5 console that will be used in WHMCS. Examples are:
VMware 5.1, https, port 9443,/vsphere-clien/vmrc/vmrc.jsp set as:
$mintVersionHTMLMKSVersionOverride = 1;
VMware 6, https, port 9443,/vsphere-client/webconsole.html set as:
$mintVersionHTMLMKSVersionOverride = 2;
VMware 5.5 U1 and lower, http, 7331, /console/ set as:
$mintVersionHTMLMKSVersionOverride = 4;
VMware 5.5 U2 and higher, https, 7343, /console/ set as:
$mintVersionHTMLMKSVersionOverride = 7;

Print Article

Add Bookmark


Was this article helpful?

Yes, it was helpful.

No, it was not helpful.