VMmanager Cloud Documentation
Documentation
/
VMmanager Cloud Documentation
/
Configuration
/
VMmanager Cloud fine tuning
/
Configuration file

Configuration file

All the settings can be divided into three groups: paths, options, and parameters. In this article, you will find parameters that can be modified in the /usr/local/mgr5/etc/vmmgr.conf configuration file. 

Note

Restart the control panel to apply changes.

/usr/local/mgr5/sbin/mgrctl -m vmmgr exit

Parameters

Syntax: write in a new line. Parameter name=value.

To view a list of parameters execute the command:

/usr/local/mgr5/sbin/mgrctl -m vmmgr paramlist

Parameter groups:

  • general settings of the control panel;
  • backup configuration;
  • networks and network interfaces;
  • virtual machines and OS deployment;
  • libvirt;
  • COREmanager parameters.

General settings

  • CephAuthUserName - a username that is used for connection to Ceph. The default value is vmmgr.
  • DistRsyncMaxProc - the number of rsync processes that run simultaneously (it is used for synchronization of OS templates and ISO). The default value is 3.
  • CloudIpDev - network interface to which the license IP address will be added in case the master server is changed in VMmanager Cloud;
  • CloudIp - IP address of the VMmanager Cloud license. That IP address will move from one cluster node to another in case the master server fails;
  • CloudMask - a mask associated with the cluster IP address on the new master server;
  • DBHost - server address where the VMmanager database is located. The default value is localhost.
  • DBUser - VMmanager database user.
  • DBPassword - database user password, specified in DBUser.
  • DBName - VMmanager database name. The default value is vmmgr.
  • LicIp - license IP address.
  • MainIp - IP-address of the master node. Used for creating an NFS-storage.
  • NfsMountParam - parameters that will be used to mount the NFS storage. The default value is rsize=8192,wsize=8192,timeo=14,intr
  • NodeReservedMemPercent - the amount of memory in percent reserved on cluster nodes. The default value is 0
  • NoVncStartPort - starting port for NoVnc. The default value is 15900
  • NoVncEndPort - ending port for NoVnc. The default value is 16900
  • NoVncNextPort - next port to be allocate for NoVnc.
  • OsTplDistributionMethod - OS templates synchronization method on cluster nodes (nfs, rsync, manual). VMmanager-Cloud supports only rsync. VMmanager-KVM uses nfs by default. If you create a large number of nodes in VMmanager KVM, we recommend that you use distrsync. distrsync is supported starting with version 5.65. For more information, please refer to the article Synchronizing OS templates on cluster nodes
  • OversellMemFactor - overselling amount. The default value is 100%. 
  • RebootOnDemandTimer - a period in seconds that will pass before the next reboot of virtual machines for applying changes. The default value is 86400 seconds.
  • RsyncBwLimit - bandwidth limit during templates synchronization process (in KiB/s).
  • sshAuthorizedKeysFile - path to the authorized_keys file. The default value is /root/.ssh/authorized_keys
  • sshPublicKey - path to the public ssh key. The default value is [installation path]/etc/ssh_id_rsa.pub
  • sshPrivatKey - path to the private ssh key. The default value is [installation path]/etc/ssh_id_rsa
  • sshKnownHosts - path to the file known_host. The default value is [installation path]/etc/known_host
  • TempIpType - a type of temporary IPv4 address created during VM setup. The default value is "public". If that parameter is added into the configuration file, temporary IPv4 of a specified type will be always allocated during OS deployment/reinstallation.
  • UserIsoCountLimit - the limit on the number of ISO-images per specific user. This value will be applied if the limit is not set when creating a new user.
  • UserIsoSizeLimit - the limit on the ISO-image size per specific user. This value will be applied if the limit is not set when creating a new user.
  • VmCountHardLimit - hard limit on the number of the virtual machine on a cluster node. The default value is unlimited.
  • VMminiPanelKey - hashed password for access to vmmini.
  • VncInterface - network interface that VNC of virtual machines will connect to. The default value is - auto. This value can be specified in the "Policy" module. *VmwatchListenIp - the IP address that vmwatch-master listens. 
  • VmwatchListenPort - the port that vmwatch-master listens. 

Backup configuration

  • BackupPriority - priority to start the backupctl process. Possible values -20 to 19, where -20 - is the highest priority, 19 - the lowest. 10 is set by default;
  • BackupTimeout - timeout in minutes for vm preparation. The default value is unlimited;
  • LVMSnapshotSize - disk size for snapshots in %. The default value is 100. Note: providing a value less than 100% may lead to snapshot oversize, therefore data cannot be added to disk;
  • UserSnapshotLimit - the limit on the number of virtual machine's snapshots a user can make. The default value is unlimited

Network and network interfaces

  • BridgePrefix — prefix that can be added to a newly created network bridge. The default value is vmbr;
  • DefaultIfaceName — the name of the main network interface of a cluster node. It is used in the VMmini configuration file for statistics collection. If that parameter is not specified, it will be identified automatically by the "ip" utility;
  • CollectTcStatistic — ignore dropped packets in statistics Management → Virtual machines → Bandwidth usage, if the VM traffic limit is enabled. It is specified in the VMmini configuration file on a required cluster node. If the option is not specified, statistics will include the dropped packets. 

Creation of virtual machines and OS deployment

  • CreateVmDisableNodeTimer - a period in minutes that will pass before a cluster node will be excluded from the list of available nodes for automatic location. If this parameter is specified, after the creation of a virtual machine on a cluster node, virtual machines cannot be created automatically on that node during the specified period or before VM installation terminates. By default, the value is not set.
  • DefaultRecipe - a recipe that will be set up by default. It is specified in the "Policy" configuration form. For more information, please refer to the article Recipes in VMmanager
  • DomainDiskDriverCache - data cache method in libvirt (none, default, writethrough, writeback, directsync, unsafe).
  • GenMACPrefix - MAC-address prefix generated by a control panel for network interfaces of virtual machines. The first two bytes of a MAC-address in hexadecimal notation colon separated. The default value is 52:54
  • HTTPProxyv4 - HTTP proxy for IPv4. It is used for packet cache during the installation process using OS templates.
  • HTTPProxyv6 - HTTP proxy for IPv6. It is used for packet cache during the installation process using OS templates.
  • iSCSITargetDir - a target directory where disks will be created on the iscsi-storage. The default value is /iscsivolumes
  • IsoCountLimit - a limit on the number of ISO-images per user. The default value is 0. (In the control panel you can set a larger value, but the values from the configuration file will be applied).
  • IsoLifetime - a period in hours to delete a user ISO-image. The default value is 24
  • IsoSizeLimit - the limit on the ISO-image size per user. The default value is 0. (In the control panel you can set a larger value, but the values from the configuration file will be applied).
  • ManagerMacId - VMmanager unique identifier for generating MAC-address.
  • MgrURL - this parameter is not used.
  • NextHopIPv4 - IPv4 address that is used as default gateway when installing VM OS template from the template.
  • NextHopIPv6 - IPv6 address that is used as default gateway when installing VM OS template from the template.
  • OsInstallAfterScript - path to the local script that will be executed after OS deployment (starting from version 5.27).
  • OsInstallTimeZone - timezone, which is passed in macros to the kickstart script and recipes for time zone setup on a guest operating system during deployment. Host time zone is used by default.

Libvirt

  • LibVirtDebugLevel - libvirt logging level. The default value is 3. The maximum level - 1, the minimum - 4. The log is written to [installation path]/var/libvirt.log.
  • LibvirtHooksDir - directory where libvirt hooks are located. The default value is/etc/libvirt/hooks
  • LibvirtNcTimeout - timeout for simple libvirt operations (that are not associated with data copy). The default value is 60
  • LibvirtSockPath - path to the libvirt socke-file (the default value is /var/run/libvirt/libvirt-sock

Parameters inherited from COREmanager 

Configuration file parameters

  • AuthenLifeTime — session lifetime in seconds. Sessions that remain idle for more than the period specified, will be removed automatically. The default value is "3600";
  • BuilderOnUpdateXml — path to the script that starts when changing the XML-files of the control panel. It is used in the developer mode;
  • ConnectionLimit — the number of simultaneous connections processed by CORE. The default value is "100";
  • DefaultAccessIp — allow access from the selected IP addresses regardless user settings;
  • DefaultButtonView — default button types in the control panels. The default value is "buttontext":
    • buttontext — icons and text.
  • DefaultHintView — show hints to form fields. The default value is "hintactive":
    • hintactive — the hint will be shown when focusing on the hint;
    • hintpassive — the hint will be shown when moving the mouse cursor on the hint;
  • DefaultInterface — name of the interface to which alias IP addresses are added by default;
  • DefaultLang — default language that will be used. if the browser language cannot be identified or the control panel doesn't support that language;
  • DefaultTheme dragon — the default interface theme;
  • ExpireLogsDays — period in days to store the operation log of the control panel. Indicated in days. The default value is "365";
  • ExceedEmailCount — the number of mail notifications that can be sent to one mailbox per day;
    • 0 — no mail notifications will be sent;

    • 1 — one mail notification of the specified type will be sent to one mailbox per day:

      Types of mail notifications
  • FileMaxEditSize — maximum file size (in KiB) that a user can open in the file manager. The default value is 1024;
  • ForwardedSecret — a key that is used for setting a real IP address is proxy is configured. For more information please refer to the article Control panel address;
  • FsEncoding — file system encoding for the file manager. UTF-8 is used by default;
  • InternalAdminName — administrator who sends internal requests;
  • LastLogin — show the banner informing when you accessed the system for the last time. Possible values:
    • info - always show the banner,
    • warning- show the banner only if the IP address was changed,
    • none - do not show the banner,
  • LicIp — license IP address;
  • LongRequest — time in seconds. If the request is executed for a longer time, it will be registered in the long requests log var/<panel name>.long.log. The default value is 300;
  • MailMode — mail server type to send email notifications;
  • MakefileDir — path to the assembly directory. It is used in the developer mode. The default value is"src/builder";
  • OneTimeExpire — limits the validity period of the temporary key for authorization. The key is created using the session.newkey function. By default, the parameter has a value of 3600 seconds and can take any integer value. For example, to change the validity period of a key from 1 hour to 10 minutes, set OneTimeExpire 600;
  • PWGenCharacters — symbols that are used for randomly generated password. The default value is "1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ". To make the control panel use special characters (#, $, & etc.) when generating a password, add the required characters to the parameter value;
  • PWGenLen — length of the randomly generated password. The default value is "8";
  • PWStrength — check password strength. The default value is "2":
    • 0 - do not check;
    • 1 - week passwords can be used (K = 3..6);
    • 2 - week passwords cannot be used (K = 6..9);
    • 3 - only strong passwords can be used (K = 9..∞).

    • The password is checked against the dictionary words, and the coefficient of the password strength (K)is calculated as follows: . N — total number of symbols. Nu — number of unique symbols (case-sensitive). Ns — number of special symbols. Nr — number of letters with a different case. Nc — number of consecutive symbols of the same type (letters, digits, special symbols).

  • ProblemsAddressFrom — email from which the mail issue notifications are sent;
  • ProblemsAddressTo — email that receives the mail issue notifications;

  • ProblemsEmailEnabled — this option allows sending the mail issue notifications. The default value is "off":

    • on — enabled;
    • off — disabled.
  • ProblemsKeepOld — period to store notifications in the control panel. The default value is "30";
  • ProblemsKeepSolved — period to store unsolved issues in the control panel. The default value is "7";
  • ProblemsLang — language that is used to describe issues in the email notifications;
  • ProblemsPeriod — period in minutes that will pass before the next attempt to resolve the issue will be made. The default value is "60";
  • ProblemsShowAll — show notifications about user issues. The default value is "off":
    • on — enabled;
    • off — disabled.
  • ProblemsSmtpPort — SMTP-server port to send issue notifications;
  • ProblemsSmtpServer — SMTP-server address to send issue notifications;
  • RestrictAuthinfoRange — authinfo “whitelist” settings. For more information please refer to the article Guide to ISPsystem software API;
  • SMTPPass — user password of the SMTP-server to send issue notifications;
  • SMTPPort — SMTP-server port to send email notifications;
  • SMTPServer — SMTP-server address to send email notifications;
  • SMTPUser — username of the SMTP-server port to send email notifications;
  • SenderName — notification sender name;
  • StartPage — default start page;
  • SOARefreshTime — refresh parameter for SOA record. Determines by default the time interval in seconds after which the system checks whether it needs to update a domain zone in seconds for secondary DNS servers. If the serial number has changed since its last check, then the domain zone on the secondary DNS server will be updated;
  • XSLFOProc — parameters to call the external FO-processor.

Paths

Syntax: path space value, write with a new line. 

To view a list of parameters execute the command:

/usr/local/mgr5/sbin/mgrctl -m vmmgr pathlist

VMmanager paths 

  • BackupTmpDir - directory for temporary files of the backup system. The default value isvar/.backup/tmp Attention- do not specify the same directory both for remotetmp and BackupTmpDir. Note: the control panel cleans the temporary directory on a regular basis. Do not use directories with important data as a temporary directory; 
  • ostemplatedir - directory that can be accessed through NFS on all servers. The default value is /nfsshare; 
  • ostemplatesubdirlist - the list of sub-directories of the OS template repository. (separated by ':'), where the system will search for templates;
  • recipedir - directory where recipes are kept. The default value is "/nfsshare/recipes/" If you run VMmanager Cloud please note: this directory should be inside the directory specified in path ostemplatedir; 
  • remotetmp - directory where a qcow image of a virtual machine is converted into raw. Default value is /tmp . Attention - do not specify the same directory both for remotetmp and BackupTmpDir; 
    Note
    In the current version of VMmanager, using the remotetmp parameter may cause an error when adding cluster nodes. We recommend that you disable this option when you add a cluster node.
  • cmd_dd - path to the dd utility. The default value is "dd". It is used in Backus module, in the migration of disks between storages, copying of disk image during setup. This configuration can be used to lower the load on the disk subsystem by running dd via ionice (you can specify path cmd_dd ionice -c2 -n7 dd in the configuration file); 
  • cmd_qemu-img - path to the qemu-img utility. The default value is "qemu-img". See the path cmd_dd parameter.

Paths inherited from COREmanager 

  • ifconfig — the ifconfig utility. The default value is "/sbin/ifconfig".

Options

Syntax: Option space name, write with a new line. 

To view a list of parameters execute the command:

/usr/local/mgr5/sbin/mgrctl -m vmmgr optionlist

VMmanager options

  • BuildBridgesManually - do not automatically create new bridges and do not associate bridges with external interfaces on cludter nodes.
  • DisableInstallQemuEvRepo - the centos-release-qemu-ev repository will be disabled before the installation of software on a cluster node. (Starting from version 5.87, only on CentOS 7).
  • DisableIntegrityCheck - disable disk integrity checking during VM migration, transferring a disk between storages, importing a VM from another cluster.
  • DisableRebootOnDemand - disable delayed reboot of virtual machines, which configuration was modified. A delayed reboot will be performed 24 hours after modification is made provided that the virtual machine was not rebooted or suspended from the control panel.
  • ExternalIpAllocation - disable attempts to allocate an IP address without BILLmanager. It is used only in integration IPmanager + VMmanager + BILLManager
  • HostBasedCpu - create virtual machines with the same CPU type as on the parent system. It allows installing virtual machines with Windows 2016 / Windows 10.
  • IgnoreKVMHwSupport - add a cluster node, even if hardware virtualization is not supported.
  • PeriodicFixIp - check correspondence between IP addresses specified in the configuration file of a virtual machine and IPs in the database.
  • UserRecipes - allow users to edit recipes. A user will be able to view and read the list of recipes from repositories and those created by an administrator, and as well as create his own recipes that won't be available to other users.
  • UseOwnNetworkFilter - do not create anti-spoofing rules.
  • VncSSL - enable SSL for VNC

Options inherited from COREmanager 

  • DisableAutoUpdate — disable auto updates of a control panel;
  • DisableCookieSecure — disable the Secure attribute for cookies. Add this option to access a control panel through HTTP. By default, the option is not specified in the configuration file;
  • DoNotRestoreTasks — do not recover cron jobs. After you have added this option, a control panel will try to create the required cron jobs upon each start;
  • EULA — a user has pressed the "I agree" button to accept ISPsystem License agreement. Deleting this option will show the License agreement when starting the control panel the next time;

  • EnableAcmeshDebug — in the file /usr/local/mgr5/var/<panel_name>_acme_sh.log the log of issuing and updating LE certificates is written. By default, the option is disabled;

    Comments

  • EnableDbAuthlog — if this option is enabled and the type of MySQL database is used, the authorization log will be written to the database. Logging stops. By default, the option is disabled;

    Details
  • FirstStart — the first start of a control panel. The Setup Wizard will open when an administrator logs in to a panel for the first time;

  • HtmlToTextConverter — Specifies which converter to use to convert html to text. Can take the following values:

    • internal;
    • w3m — used by default;
    • lynx;
  • IgnorePluginError — ignore the errors that occur when using a plug-in (if you couldn't start the plug-in or it returned invalid XML). After you have added this option the function will be executed but the corresponding error notification will be registered;
  • RestrictAuthinfo — enable restrictions for authinfo. For more information please refer to the article Guide to ISPsystem software API;
  • SocialDisableFacebook — disable authorization of users through the Facebook social network;
  • SocialDisableGoogle — disable user authorization through a Google account;
  • SocialDisableVkontakte — disable authorization of users through the VK social network;
  • UsageStatAgree — send anonymous information about the use of the control panel. We collect information to improve the quality of our services. We don't collect any form or table values.