DCImanager configuration file

From ISPWiki
Jump to: navigation, search

This article describes parameters that can be specified in the [installation path]/etc/dcimgr.conf configuration file.

Options available in web-interface

  • Option AllowFreeServersAutoshutdown - enable server after release
  • Option AllowIPMIAutoconfig - add IPMI automatically after diagnostics
  • Option AllowIso - allow users to boot their own ISO-images
  • Option AutoCreateIpmiUser - if the "AllowIPMIAutoconfig" option is specified, it will create an operator in IPMI during server diagnostics, and save data for server owner (from version 5.136)
  • Option AllowMixRack - connect server to equipment from other racks
  • Option AllowNetflowStat - allow DCImanager to collected traffic statistics with NetFlow/IPFIX
  • Option AllowSnmpTrap - enable SNMP notifications.
  • Option AllowVlanOnFree - specify VLAN after server release
  • Option AllowVPU - activate Vlan Per User (VLAN and VPU and VPU: Technical details
  • Option ClearHddOnDiag - allow to clean disk (first 512 bytes) during server diagnostics
  • Option DontChangeIpmiAdminPass - if the "AllowIPMIAutoconfig" option is specified, it will not change password of IPMI administrator during server diagnostics. (from version 5.136)
  • Option EnableConnectionsAutoFix - allows to correct connections automatically
  • Option FullHddClearOnDiag - allows to clean disk (full) during server diagnostics
  • Option IPMIProxyV2Ssl - enable encryption when connecting noVNC to websockify if proxy is activated "IPMI proxy"
  • Option IPMIProxyV2AskAdmin - allow administrators to select a method to connect to IPMI web-interface ("IPMI proxy")
  • Option ShutdownAfterDiag - disable server after diagnostics.
  • Option AutoDetectIpmiConnection - allow to automatically mark server connection which has IPMI MAC-address as a service one,when running sever search and diagnostics (from version 5.129).
  • Option IpmiConsoleUseAdminAccess - the 'IPMI' console module allows server owners to upload the console using admin credentials (from version 5.146)
  • Option IpmiConsoleUseIhttpd - the 'IPMI' console module allows to upload the IPMI condole via ihttpd proxy (from version 5.146)

Options not available in web-interface

  • Option AddIpVlanToPort - if server has multiple IP addresses with different VLAN, VLAN of IP addresses will be assigned to server port as tagged. VLAN of primary IP address will be assigned as dual-mode.
  • Option AllowAutoCreateIpmiButton - add a button in the Server equipment module enabling to access an IPMI device automatically. In the form that will open you can choose an IP address type from which DCImanager will try allocating an IP for the IPMI device. After allocating the IP, DCImanager will create a user specified in the DefaultIPMIUserName parameter of the configuration file, and will generate a password.
  • Option AllowCheckRoutesTable - checks errors with every IP from network for VLAN. наличие проблем с каждым IP из сети для VLAN
  • Option AllowDeleteSpares - show the "Delete" button in "Spare parts" module on Admin level.
  • Option AllowNoPowerConnAdminOperations - start operation on the server, which is not connected to power supply.
  • Option CheckSendByte - monitor operations start on the server. If this option is set, iptables will add a rule to calculate bytes on port 69 via udp(TFTP) when starting an operation. If less than 100 bytes are received withing 10 minutes after the operation was started, that operation will be terminated, rules will be deleted from iptables, and an "operation failed" notification will be registered. This option allows to terminate operations that could not start correctly, so there is not need to wait for a 2-hour timeout.
  • Option AllowSwithLog - add the "Path to switch log" field into a switch edit form.
  • Option CheckTypeOsAfterDiag - start OS compatibility check (servertype.checktype) in case less than 3 records are specified in the os_to_types table for a selected server types in CleanUp operation phase.
  • Option ClearIPMIUserOnFree - delete all IPMI users when releasing server.
  • Option CreateIPMIOperatorOnNewOwner - create an IPMI operator when changing server owner
  • Option DebugSNMP - enable output of SNMP debug information into var/snmp.log
  • Option DisableEquipmentProblemsRegistration - disable registration of hardware issues.
  • Option DisableServerStatSave - disable traffic statistics collection for servers (AddTraffStatForServer won't be called)
  • Option DisableStat - disable statistics collection (the collectstat function won't show any result)
  • Option DisableStatusUpdate - disable hardware status updates (device_status_refresh event by periodic)
  • Option DublicateEquipmentIp - allow to add devices with IP addresses which are already in use
  • Option ExternalIpAllocation - (this option is out of date, and we do not recommend using it) allow for allocation of IP addresses from external pools, delete the "Add" and "Delete" buttons from a list of IP addresses
  • Option EnableConnectionsAutoFix - enable automatic correction of connections (Automatic correction of DCImanager connections)
  • Option EnableNFACCTDLog - add nfacctd log into the var/nfacctd.log file
  • Option HardIpmiReset - enable "hard" server reboot via IPMI
  • Option InventoryModule - enable the "Inventory" module in DCImanager interface. "Spare parts", "Delivery", "Broken servers", and "Inventory" for Administrators and Operators.
  • Option IPMIChangeBoot - pass the "ipmitool chassis bootdev pxe" command (and check response) before network server reboot
  • Option OldSpares - user old spare parts in DCImanager menu on Administrator and Operator levels. This option is set automatically if at list one old type is specified in the spares table)
  • Option OldServerType - allow users who still use old types of servers continue using them without alerts and new types notifications. This option is set automatically if at list one server type is specified in the typelist table.)
  • Option OldDiag - change algorithm that checks for errors and shows corresponding alerts in sever edit from (this option is used for old server types)
  • Option SolidServersLabel - disable server search by full match of their names using the condition "WHERE name IN ('name1', 'name2')" in a servers list filter, where name1, name2, nameX are parts of name space separated. If the option is not specified, server search uses the condition "LIKE WHERE name LIKE '%name%'"
  • AllowAutoAuthOnServ - allow automatic authentication for providing server information during the server search procedure.
  • NoAskingSerialNumber - do not ask for a serial number when entering the server information after diagnostics.
  • NoAskingLabel - do not ask for a server label when entering the server information after diagnostics.

Parameters

  • DefaultIpType - when releasing a server with VPU, a new IP address of the selected type will be allocated for the server (this can be configured in the "Global settings" starting from version 5.149) ("VLAN and VPU", "VPU: technical details")
  • VPUFreeIpPool - (for internal user with PmanagementV2) when releasing a server with VPU, an IP address will be allocated from this pool (this can be configured in the "Global settings" starting from version 5.149) ("VLAN and VPU", "VPU: technical details")
  • VpuNetIpType - specifies a type of IP addresses that will be allocated to servers in VPU (this can be configured in the "Global settings" starting from version 5.149) ("VLAN and VPU", "VPU: technical details")
  • VPUNetIpPool - (for internal use with IPManagementV2) specifies the pool of IP ranges that will be allocated to servers in VPU (this can be configured in the "Global settings" starting from version 5.149)
  • VpuNetIpTypeIpmi - specifies a type of IP addresses that will be allocated to IPMI in VPU (his can be configured in the "Global settings" starting from version 5.149) ("VLAN and VPU", "VPU: technical details")
  • VPUNetIpPoolIpmi - (for internal use with IPManagementV2) specifies a pool of IP addresses that will be allocated to IPMI in VPU (this can be configured in the "Global settings" starting from version 5.149)
  • AliasIpType - specifies a type of the range of alias IP addresses that will be allocated to servers in VPU (you can set them in the "Global settings" module) ("VLAN and VPU", "VPU: Technical details")
  • AllowVlanRange - specify VLAN ranges for VPU (format: 102-105, 2000-2500. You can set this parameter in the "Global settings" module) ("VLAN and VPU", "VPU: Technical details")
  • AutonomSystem - ID of the autonomous system (AutonomousSystem) for VPU BGP You can set this parameter in the "Global settings" module) ("VLAN and VPU", "VPU: Technical details")
  • CheckServerOnFreeScript - script file name for server check before diagnostics.
  • DBHost - server address with MySQL where DCImanager databases are kept. The default value is localhost.
  • DBName - DCImanager database name. The default value is dcimgr.
  • DBUser - DCImanager database user.
  • DBPassword - DBUser password.
  • DefaulServerIpPool - (for internal use with IPManagementV2) type of IP addresses that will be specified in automatically created IPMI ("public" by default) default IP type for servers. IP of this type will be allocated for them, if another value is not specified in the "IP address range" field in a server edit form. (the default value is "public", which can be set in the "Global settings" module)
  • DefaulServerIpType - default type of IP addresses for servers. IP addresses of that type will be allocated to server, if another value is not specified in the "IP range" field in a server edit form. (the default value is "public", which can be set in the "Global settings" module)
  • DefaultIPMIUserName - administrator username that will be specified in IPMI which was automatically created during diagnostics (the default value is "dcimgr")
  • DefaultIPMIOwnerName - operator name that will be specified in IPMI which was automatically created during diagnostics (provided that the "AutoCreateIpmiUser" option is specified. The default value is "dcimgr_oper"). The name is shown to administrator. (The default value is "dcimgr_oper", maximum number of symbols - 15, from version 5.136). It is also used when calling the setipmioper function: the function will check all IPMI (provided the the reset=on parameter is specified. If not, the function will check only the IPMI without server owner), create an IPMI operator, and show the data to the server owner (from version 5.137)
  • DefaultVlan - default VLAN which is specified when releasing a server provided that the "AllowVlanOnFree" option is specified (it is not specified by default; can be set in the "Global settings" module)
  • DiagOnFreeTemplate - choose a diagnostics template.
  • HTTPProxy - 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.
  • IMIPAutoAllocIpPool - (for internal use with IPManagementV2) type of IP-addresses that will be specified in automatically created IPMI (the default value is "public")
  • IMIPAutoAllocIpType - type of IP addresses that will be specified in automatically created IPMI (the default value is "public")
  • IpInUseScript - name of the script file that checks IP address availability before deletion
  • IpmgrType - type of IP pool (possible values "ipmgr"/"local"/"none"/"remote")
  • IPMIProxyV2Host - IPMI proxy server address (it can be set in the "IPMI proxy" module)
  • IPMIProxyV2Login - administrator of IPMI proxy server (the default value is "root"; it can be set in the "IPMI proxy" module)
  • IPMIProxyV2Port - port of IPMI proxy server (the default value is "22"; it can be set in the "IPMI proxy" module)
  • IsoCountLimit - maximum number of ISO-images
  • IsoLifetime - default lifetime of ISO-images before automatic deletion
  • IsoSizeLimit - maximum size of ISO-image, in Mb
  • LocalSpeedThreshold - minimal threshold in Мbit/sec that local connection speed is compared with during server diagnostics. If it is below 20% and more, alert will be registered (the default value is "80")
  • max_one_device_task - the maximum number of tasks per device that can be added to queue (the default value is "10")
  • max_parallel_threads - the maximum number of concurrent threads (the default value is "100")
  • MgrIpv4 - DCImanager IPv4 address that will be used for connection with servers during the OS installation process (DCImanager will define it automatically. We do not recommend that you change this parameter unless you are sure your actions are correct).
  • MgrIpv6 - DCImanager IPv6 address that will be used for connection with servers during the OS installation process (DCImanager will define it automatically. We do not recommend that you change this parameter unless you are sure your actions are correct).
  • MgrPortv4 - port for DCImanager IPv4-address that will be used for connection with servers during the OS installation process (DCImanager will define it automatically. We do not recommend that you change this parameter unless you are sure your actions are correct).
  • MgrPortv6 - port for DCImanager IPv6-address that will be used for connection with servers during the OS installation process (DCImanager will define it automatically. We do not recommend that you change this parameter unless you are sure your actions are correct).
  • NameServers - name servers that will be specified on servers before OS deployment (IP addresses v4/v6 space separated; not specified by default)
  • ServerSearchEnabled - Server search, possible values: off / on.
  • NetFlowIp - IP address for statistics collection.
  • NetFlowPolicy - NetFlow statistics collection policy ("Traffic usage")
  • NetFlowPort - port for NetFlow statistics collection policy ("Traffic usage")
  • CopyFlowPath - path to the directory where NetFlow files ("Traffic usage") will be copied.
  • NFS_IP - separate IP-address for NFS ((if it is not specified, it will be allocated from control panel/location)
  • NovncEndPort - the last port of the range for noVNC connection to websockify (the default value is "6000"; it is required for the "IPMI proxy" module)
  • NovncStartPort - the first port of the range for noVNC connection to websockify (the default value is "5901"; it is required for "IPMI proxy" module)
  • OsInstallAfterScript - path to the local script that will be executed upon OS installation (in DCImanager 5.23.0 and later).
    Within the script(FreeBSD) or response file(Debian/CentOS) the script can be accessed by clicking the link in the macro ($AFTER_INSTALL_SCRIPT_HTTPS)
  • OsInstallTimeZone - time zone for new OS (it can be set in the 'global settings" module)
  • PowerManagementType - power management type for statistics collection (not specified by default. Possible values "PDU"/"IPMI")
  • PrefixLowBorder - the minimal value for prefix. It is compared with prefix of IP address from the router table (the router_route.dest column in MySQL); if the prefix from the table is less than this limit, alert will be registered (it will check provided that the "AllowCheckRoutesTable" option is specified)
  • Release - (outdated parameter, we don't recommend using it) product version (possible values "alpha"/"beta"/"release", if it is not specified, "beta" is used)
  • ResetAPCTimeOut - specifies a timeout in milliseconds for the APC handler between disabling and enabling controlled socket when performing reboot. The minimum value is 2000 milliseconds.
  • RouterSync - router id for synchronization of VLAN list on that router with the router_vlan tbale ("VLAN and VPU", "VPU: Technical details")
  • ServerSearchEnabled - status of automatic server search (the default value is "off", possible values "on"/"off")
  • ServerSearchGateWay - default gateway for automatic server search
  • ServerSearchIp - DCImanager IP address for automatic server search
  • ServerSearchMask - network mask for automatic server search
  • ServerSearchRange - IP range of servers that were found during automatic server search
  • ServerSearchTemplate - diagnostics template for automatic server search
  • SetMaxPortSpeedOnOperation - this value will be set for port speed when starting an operation. Once the operation is complete port server will be reset. Possible values: 1G, 10G, 16G, 40G
  • SpareSerialLength - length of spare serial number (the default value is 10)
  • TFTP_IP - IP address for TFTP (if it is not specified, control panel or location's IP address will be used)
  • TrapDaemonPort - port to receive notifications.
  • UserVid - VLAN range allowed for user VLAN (it is specified in the "User VLAN" module)
  • TimeoutOsInstall - OS deployment timeout in *minutes* (the default value is 60)
  • TimeoutIsoLoad - upload timeout *in minutes* (the default value is 1440)
  • TimeoutServerDiag - server diagnostics timeout *in minutes* (the default value is 1440)
  • TimeoutServerRestore - server recovery timeout *in minutes* (the default value is 43200)
  • IPMIConsoleLifeTime - IPMI lifetime, i.e. period in hours that will pass before the file with IPMI console will be deleted automatically (by default 24).

Paths

  • path dhcpd.conf - location of the DHCP-service configuration file. The default value is /etc/dhcp/dhcpd.conf.
  • path exportfs - this command can be used to apply new configuration of the NFS service.
  • path exports - file with a list of shared NFS-directories and their mounting parameters
  • path ifconfig - ifconfig utility
  • path ipmiredirectpath - directory for pseudo-links during proxying IPMI via ihttpd
  • path ipmi_stat_current_script - path to the script that receives an IPMI IP address, username and password to STDIN. It returns information about server power usage to STDOUT.
  • path service_nfsd - NFS-server start script.
  • path service_rpcbind - RPC-service start script.
  • path ipmitool - ipmitool utility (IPMI configuration)
  • path isotemplatedir - path to directory with ISO-images
  • path ostemplatedir - path to directory with OS templates
  • path ostemplatesubdirlist - name of the OS templates subdirectory
  • path recipedir - directory with Recipes
  • path secure-private-key - secret key of control panel
  • path service_bird - script for BIRD-server management (VPU mode)
  • path service_dhcpd - script for DHCP--server management
  • path service_nfsd - script for NFS--server management
  • path service_rpcbind - script for rpcbind management
  • path service_samba - script for SMB-сервером
  • path smb.conf - SMB-server configuration file
  • path tftp-root - directory which keeps subdirectories of the "srv"+id_server to receive files via TFTP during network boot