DCImanager Documentation

Configuration file

ISPSystem

The configuration file is located in /usr/local/mgr5/etc/dcimgr.conf.

This article describes parameters, paths, and options that can be added to the configuration file. 

Note

To apply the changes in the configuration file, restart the control panel with the command:

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

Parameters


Syntax: enter every parameter from a new line as "Parameter name=Value". 

To view a list of parameters:

/usr/local/mgr5/sbin/mgrctl -m dcimgr paramlist
  • DefaultIpType — when releasing a server with VPU, a new IP address of the selected type will be allocated for the server. Learn more in the article VPU (Vlan Per User);
  • VPUFreeIpPool —  (for internal use with IPmanagementV2) a pool of IP ranges that will be allocated to servers in VPU. Learn more in VPU (Vlan Per User);
  • DefaultVlan — default VLAN which is specified when releasing a server provided that the "AllowVlanOnFree" option is specified (it is not specified by default;
  • RouterSync — the router id for synchronization of VLAN list on the router with the router_vlan table;
  • VpuNetIpType — IP address type that will be allocated to servers in VPU. Learn more in  VPU (Vlan Per User);
  • VPUNetIpPool — the pool of IP ranges that will be allocated to servers in VPU. Learn more in VPU (Vlan Per User). For internal use with IPmanagementV2;
  • VpuNetIpTypeIpmi — IP address type that will be allocated to IPMI in VPU. Learn more in VPU (Vlan Per User);
  • VPUNetIpPoolIpmi — (for internal use with IPManagementV2)  pool of IP addresses that will be allocated to IPMI in VPU. Learn more in VPU (Vlan Per User). For internal use with IpManagement2;
  • AliasIpType — type of the range of alias IP addresses that will be allocated to servers in VPU. Learn more in VPU (Vlan Per User);
  • VPUAliasIpPool — type of alias IP addresses that will be allocated to servers in VPU. Learn more in "VPU (Vlan Per User)". For internal use with IpManagement2;
  • AllowVlanRange — VLAN identifiers that can be used to create VPU. The first and the last identifiers can be separated by a hyphen, ranges are separated by spaces. E.g. "1-15 29 50 333-400". Learn more in "VPU (Vlan Per User)";
  • AutonomSystem — autonomous system ID. It is used for Bird configuration. Learn more in VPU (Vlan Per User);
  • CheckServerOnFreeScript — script file name for server diagnostics;
  • DBHost — MySQL database server where the DCImanager database is kept. The default value is "localhost";
  • DBName — DCImanager database name. The default value is "dcimgr";
  • DBPassword —  DCImanager database user password. It is generated when you install DCImanager;
  • DBUser — DCImanager database user. The default value is "dcimgr";
  • DefaulServerIpPool — (for internal use with IPManagementV2) default type of IP pool ("public" by default) for servers. IP addresses from the selected pool will be allocated for them if another value is not specified in SettingsGlobal settings → the IP address range field;
  • DefaulServerIpType —  the default type of IP addresses for servers. IP addresses of this type will be allocated to the server if another value is not specified in SettingsGlobal settings→  IP range field. The default value is "public";
  • DefaultIPMIOwnerName — an operator username that will be specified in IPMI that was created automatically during the diagnostics (provided that the "AutoCreateIpmiUser" option is set. The name is displayed to a  server administrator. The default value is "dcimgr_oper", the maximum number of symbols — 15. It is also used when calling the setipmioper function: the function will check all IPMI (the reset=on parameter must be 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;
  • DefaultIPMIUserName — an administrator username that will be specified in IPMI that was created automatically during the diagnostics. The maximum length is 15 characters. The default value is "dcimgr";
  • DiagOnFreeTemplate — a diagnostics template that will start when a server is released;
  • HTTPProxy - HTTP proxy for IPv4. It is used for packet cache. http://<IP>:<Port>/, e.g. http://127.1.1.1:3128/.
  • HTTPProxyv6 - HTTP proxy for IPv6. It is used for packet cache.  http://[<IP>]:<Port>/, e.g. http://[1111:2222:3333::4444]:3128/;
  • IMIPAutoAllocIpPool — (for internal use with IPManagementV2) type of IP-addresses that will be allocated to the IPMIs that were created automatically  during diagnostics (the default value is "public");
  • IMIPAutoAllocIpType — IP address type that will be specified in automatically created IPMI (the default value is "public")";
  • IpInUseScript — script file name that will check the availability of an IP address before it will be deleted. The script must receive the IP address to STDINand return "OK", if the IP address is available. A different value means that the IP is already assigned. This parameter is used if IPmanager is not integrated with the panel;
  • IpmgrType — an IP pool  type (possible values are "ipmgr"/"local"/"none"/"remote");
  • IPMIConsoleLifeTime — IPMI lifetime, i.e. a period in hours that will pass before the file with the IPMI console will be deleted automatically (the default value is 24). Learn more IPMI console;
  • IPMIProxyV2Host — IPMI proxy server address (it can be set in the "IPMI proxy" module). Learn more IPMI proxy via auxiliary server;
  • IPMIProxyV2Login — IPMI proxy server administrator. The default value is "root". Learn more IPMI proxy via auxiliary server;
  • IPMIProxyV2Port — IPMI proxy server port. The default value is "22". Learn more IPMI proxy via auxiliary server;
  • IsoCountLimit — maximum number of ISO-images that users can upload; 
  • IsoLifetime  —  default lifetime (in hours) of ISO-images before automatic deletion; 

  • IsoSizeLimit —  ISO-image maximum size (in Mb);
  • LocalSpeedThreshold — minimal threshold that local connection speed is compared with during server diagnostics. If it is below 20% and more, the alert will be registered (the default value is "80"). The minimal value is calculated as follows: <LocalSpeedThreshold*Port_Speed/100>. Learn more Diagnostics mode ;
  • max_one_device_task — the maximum number of tasks per device that can be added to the queue (the default value is "10");
  • max_parallel_netwflow_threads — the maximum number of concurrent threads when the statistics is collected with Netflow (the default value is "4"). Read more in  The "NetFlow" module;
  • 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 OS deployment (DCImanager will define it automatically. We do not recommend that you change this parameter manually);
  • MgrIpv6 —  DCImanager IPv6 address that will be used for connection with servers during OS deployment (DCImanager will define it automatically. We do not recommend that you change this parameter manually);
  • MgrPortv4 — port for DCImanager IPv4-address that will be used for connection with servers during OS deployment (DCImanager will define it automatically. We do not recommend that you change this parameter manually);
  • MgrPortv6 — port for DCImanager IPv6-address that will be used for connection with servers during OS deployment (DCImanager will define it automatically. We do not recommend that you change this parameter manually);
  • NameServers — IPv4 and IPv6 of the name servers that will be added on the server after OS installation from the template. If it is not specified, the name servers that the control panel uses will be added. By default it is not specified;  
  • NetFlowIp — interface for statistics collection. Learn more NetFlow;
  • NetFlowPolicy — NetFlow statistics collection policy. Learn more NetFlow;
  • NetFlowPort — port for NetFlow statistics collection policy. Learn more NetFlow;
  • CopyFlowPath — path to the directory where NetFlow files will be located. Learn more NetFlow;
  • NFS_IP — separate IP-address for NFS. If it is not specified, it will be allocated from the control panel/location;
  • NovncEndPort — the last port of the range for noVNC connection to websockify (the default value is "6000"). Learn more IPMI proxy via auxiliary server;
  • NovncStartPort — the first port of the range for noVNC connection to websockify (the default value is "5901").  Learn more "IPMI proxy via auxiliary server";
  • OsInstallAfterScript — path to the local script that will be executed upon OS installation;
  • OsInstallTimeZone — time zone for the new OS;
  • PrefixLowBorder — the minimal value for the prefix. It is compared with the prefix of the IP address from the router table (the router_route.dest column in DCImanager database); if the prefix from the table is less than this limit, the error notification will be registered (provided that the AllowCheckRoutesTable option and the RouterSync parameter are specified);
  • ResetAPCTimeOut — timeout in milliseconds for the APC handler between disabling and enabling controlled socket when performing reboot. The minimum value is "2000", the default value is  "2000";
  • ServerSearchEnabled — server search status. Possible values: "off" — disabled, "on" — enabled. The default value — "off". Learn more Server search;
  • ServerSearchGateWay —  default gateway for automatic server search. Usually, it matches the primary IP address. Learn more Server search;
  • ServerSearchIp — IP address on the server with DCImanager where the DHCP-server will be set up. The IP address must belong to the network from which temporary IP addresses are allocated. Learn more Server search;
  • ServerSearchMask — network mask for server search.  The musk must include DCImanager IP address, the IP range, and Gateway IP for server search. Learn more Server search;
  • ServerSearchRange — the IP addresses that will be temporarily assigned to the found servers. It must not include DCImanager or location IP address. Learn more Server search;
  • ServerSearchTemplate — the server search template. Learn more Server search;
  • SetMaxPortSpeedOnOperation — the maximum speed size that will be set on switch ports. Once the operation is complete port server will be reset. Possible values: 1G, 10G, 16G, 40G;
  • SpareSerialLength — the length of the spare serial number (the default value is 10);
  • TFTP_IP — IP address for TFTP. If it is not specified, control panel or location IP address will be used;
  • TrapDaemonPort — the port that will receive SNMP-notifications. Learn more Network equipment management protocols ;
  • UserVid — VLAN range allowed for user VLAN. The first and the last identifier of the range are specified separated by a hyphen. E.g. "1-15 29 50 333-400". Learn more User VLAN;
  • TimeoutOsInstall — OS installation 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). 

Parameters only for DCImini

They are used only in DCImini configuration files on the location servers: 

  • DciMiniParentAddress — IP address of the server with DCImanager in the format <IP address>:<Port>;
  • MD5 — internal password hash.

Paths


Syntax: you need to enter every parameter from a new line as "path Value".

The list of the paths:

/usr/local/mgr5/sbin/mgrctl -m dcimgr pathlist
  • path dhcpd.conf — DHCP-server configuration file;
  • path exportfs — the command to apply the new configuration of the NFS service;
  • path exports - the file with a list of shared NFS-directories and their mounting parameters;
  • path ifconfig - ifconfig utility;
  • path ipmiredirectpath-  the directory where pseudo-links are kept during proxyingIPMI via ihttpd
  • path ipmi_stat_current_script - the path to the script that receives an IPMI IP address, username, and password to STDIN. It returns information about server power usage to STDOUT. Learn more Energy statistics ;
  • path service_nfsd - NFS-server start script;
  • path service_rpcbind - RPC-service start script;
  • path ipmitool- ipmitool utility (IPMI configuration);
  • path isotemplatedir - the path to directory with ISO-images;
  • path ostemplatedir- the path to directory with OS templates;
  • path ostemplatesubdirlist - OS templates subdirectory name;
  • path recipedir- the directory with recipes;
  • path secure-private-key - the control panel private key;
  • path service_bird- BIRD management script (it is used for the VPU mode);
  • path service_dhcpd- DHCP-server management script;
  • path service_nfsd - NFS-server management script; 
  • path service_rpcbind- rpcbind management script;
  • path service_samba- SMB-server management script;
  • path smb.conf- SMB-server configuration file
  • path tftp-root- the directory with subdirectories of the "srv"+id_server to receive files via TFTP during network boot.

Options


Syntax: you need to enter every parameter from a new line as "Option Value".

The list of options:

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

Available in DCImanager web-interface

You can enable or disable the options in the "Global settings" section and in the module settings forms: 

  • Option AllowAutoAuthOnServ — automatic authorization on the server during the server search operation after diagnostics. Learn more Server search module ;
  • Option AllowFreeServersAutoshutdown — automatically power off the servers that are no longer in use; 
  • 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;
  • Option AutoDetectIpmiConnection — allow to automatically mark server connection which has IPMI MAC-address as "service", when running server search and diagnostics;
  • Option AllowMixRack — connect the server to equipment from other racks;
  • Option AllowNetflowStat — allow DCImanager to collect traffic statistics with NetFlow/IPFIX
  • Option AllowSnmpTrap — enable SNMP notifications. Learn more Network management protocols;
  • Option AllowVlanOnFree — specify VLAN after server release. If you need to set up the IPMI address, IPMI connected will be assigned to the selected VLAN after diagnostics. If Ithe PMI address configuration is not required, the server port will be connected to the selected VLAN, and the system will run the diagnostics. Learn more VPU (Vlan Per User);
  • Option ClearHddOnDiag — allow cleaning HDD during server diagnostics. The first 512 Gb will be written zero. This option can be enabled if the diagnostics template supports it; 
  • Option DontChangeIpmiAdminPass — if the "AllowIPMIAutoconfig" option is specified, it will not change the password of IPMI administrator during server diagnostics.
  • Option EnableConnectionsAutoFix — allows to correct connections automatically. Learn more Correct server connections;
  • Option FullHddClearOnDiag — allows to clean disk (fully) during server diagnostics. This operation may take up to several hours depending on HDD size and speed (the Option ClearHddOnDiag option must be specified); 
  • Option IPMIProxyV2Ssl - enable data encryption (SSL) when connecting noVNC to websockify if the proxy is activated "IPMI proxy". Learn more IPMI proxy via auxiliary server
  • Option IPMIProxyV2AskAdmin - allow administrators to select a method to connect to IPMI web-interface. Learn more IPMI proxy via ihttpd;
  • 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. 
  • Option IpmiConsoleUseAdminAccess — the 'IPMI' console module allows server owners to upload the console with admin credentials. Learn more IPMI console
  • Option IpmiConsoleUseIhttpd — the 'IPMI' console module allows to upload the IPMI condole via ihttpd proxy. Learn more IPMI console
  • Option ShutdownAfterDiag — disable the server after diagnostics. This option will be applied to the servers with and without owners; 
  • Option PreciseRamDetection — define RAM by amount and frequency during the diagnostics process. Disabling this option will consider the RAM module found if it matches the amount of data specified in  DCImanager; 
  • Option ConfNetflowNotifyReportReady — indicates that a NetFlow/IPFIX report has been generated in the control panel. Learn more NetFlow.
  • Option UserRecipes — allows DCImanager users to use recipes. 

Not available in DCImanager web-interface

  • Option AddIpVlanToPort — this option is used if the server has multiple IP addresses with different VLAN. IP address VLAN will be assigned to server port as tagged . VLAN of the primary IP address will be assigned as  dual-mode ;
  • Option AllowCheckRoutesTable — checks errors with every IP from the network for VLAN. Checked if parameters "PrefixLowBorder", "RouterSync" are present;
  • Option AllowCheckVlanOnRouter — compare the list of VLAN on the router with the router_vlan table in the DCImanager database. The "RouterSync" parameter must be specified;
  • Option AllowNetflowStat - allow DCImanager to collect traffic statistics with NetFlow/IPFIX. Learn more NetFlow;
  • Option AllowNoPowerConnAdminOperations - start an operation on the server, which is not connected to the power supply; 
  • Option AllowSwithLog — add the File log field into EquipmentSwitchesEdit. If the field is not available, the switch log can be found in Equipment → SwitchesLog;
  • Option AllowVPU — activate Vlan Per User. Learn more VPU (Vlan Per User);
  • Option CheckSendByte — monitor operation start on the server. The system will add the iptables rule to calculate bytes on port 69 via udp (TFTP). If less than 100 bytes are received within 10 minutes after the operation is 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 no need to wait for a 2-hour timeout;
  • 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 issue notifications;
  • 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 EnableNFACCTDLog — add the nfacctd log into the var/nfacctd.log file. Learn more Module "NetFlow";
  • Option HardIpmiReset — enable "hard" server reboot via IPMI;
  • Option InventoryModule — enable the "Inventory" module in the 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 - the algorithm that checks for errors and shows corresponding alerts in Main menu → Servers Edit. The option is used for old server types;
  • Option SolidServersLabel - disable server search by a 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, the server search uses the condition "LIKE WHERE name LIKE '%name%'". Learn more Server search module.;
  • AllowAutoAuthOnServ — allow automatic authentication for providing server information during the server search procedure.
  • Option NoAskingSerialNumber — do not ask for a serial number when entering the server information after diagnostics. This option is available provided that Option AllowAutoAuthOnServ is specified;
  • Option NoAskingLabel — do not ask for a server label when entering the server information after diagnostics. his option is available provided that Option AllowAutoAuthOnServ is specified.
Thank you for your feedback!
Was the article useful?
Tell us why not:

it does not match the title

it was hard to understand

I didn't find the answer

recommendations from the article did not help

other

Tell us what you didn't like in the article: