Server Configuration File

From NetXMS Wiki
Jump to navigation Jump to search
This Wiki is deprecated and we are are currrently migrating remaining pages into product documentation (Admin Guide, NXSL Guide)

File netxmsd.conf is a master configuration file for NetXMS server. It should contain information necessary for establishing database connection, and some optional server parameters. Default location for this file is /etc/netxmsd.conf on UNIX systems and InstalationPath\etc\netxmsd.conf on Windows.

The file can contain the following parameters in Parameter = Value format:

Parameter Description Default Value
CodePage Code page used by NetXMS server. Has no effect on Windows or if server was compiled without iconv support. Depends on your system, usually ISO8859-1
CreateCrashDumps Control creation of server's crash dumps. Possible values: yes or no. Has effect only on Windows platforms. No
DailyLogFileSuffix Log file name suffix used when LogRotationMode is set to 1 (daily), can contain strftime(3) macros %Y%m%d
DataDirectory Directory where server looks for compiled MIB files, keep server encryption key, etc. "/var/netxms" or "C:\NetXMS\var"
DBDriver Database driver to be used. No default value
DBEncryptedPassword Hashed password, as produced by "nxencpass" none
DBDrvParams Additional driver-specific parameters. Empty string
DBLogin Database user name. netxms
DBName Database name (not used by ODBC driver). netxms_db
DBPassword Database user's password. Empty password
DBSchema Schema name not set
DBServer Database server (ODBC source name for ODBC driver). localhost
DebugLevel Set server debug logging level (0 - 9). Value of 0 turns off debugging, 9 enables very detailed logging. Can also be set with command line -D <level> option. 0
DumpDirectory Directory for storing crash dumps. "/" or "C:\"
FullCrashDumps Write full crash dump instead of minidump (Windows only) no
JavaLibraryDirectory
JavaPath
LibraryDirectory
ListenAddress Interface address which should be used by server to listen for incoming connections. Use value 0.0.0.0 or * to use all available interfaces. 0.0.0.0
LogFailedSQLQueries Control logging of failed SQL queries. Possible values: yes or no. yes
LogFile Server's log file. To write log to syslog (or Event Log on Windows), use {syslog} as file name. {syslog}
LogHistorySize Number rotated files to keep, older will be discarded 4
LogRotationMode Log rotation mode. Possible values: 0 (disabled), 1 (daily), 2 (when current file size is bigger than MaxLogSize) 2
MaxLogSize Maximum log file size in bytes, used only if LogRotationMode is set to 2 16777216
Module Additional server module to be loaded at server startup. To load multiple modules, add additional Module parameters. No default value
ProcessAffinityMask Sets a processor affinity mask for the netxmsd process (Windows only). A process affinity mask is a bit vector in which each bit represents a logical processor on which the threads of the process are allowed to run. See this MSDN article for more details. 0xFFFFFFFF


Configuration file example:

#
# Sample configuration file for NetXMS server
#

DBDriver = mysql.ddr
DBServer = localhost
DBName = netxms_db
DBLogin = netxms
DBPassword = password
LogFailedSQLQueries = yes
LogFile = {syslog}