Agent Configuration File
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 nxagentd.conf is a master configuration file for NetXMS agent. It contains all information necessary for agent's operation. Default location for this file is /etc/nxagentd.conf on UNIX systems and C:\nxagentd.conf on Windows.
The file can contain one or more parameters in Parameter = Value form, each parameter should be on its own line. Comments can be inserted after "#" sign. This file can also contain configuration for subagents. In this case, subagents’ parameters should be placed in separate sections. Beginning of the section is indicated by "*" sign, followed by a section name.
The file can contain the following parameters (in main section):
| Parameter | Description | Default Value | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Action | Define action, which can be later executed by management server. See the Agent Configuration section for detailed description of this parameter. | No defaults | ||||||||||
| ActionShellExec | Same as Action, but on Windows platform agent will use shell to execute command instead of normal process creation. There is no difference between Action and ActionShellExec on UNIX platforms. | No defaults | ||||||||||
| AppAgent | ||||||||||||
| BackgroundLogWriter | Enable (yes) or disable (no) log writer as separate background thread. Has no effect if logging is done through syslog or Windows Event Log. | no | ||||||||||
| CodePage | Code page used by NetXMS agent. Has no effect on Windows or if agent was compiled without iconv support. | Depends on your system, usually ISO8859-1 | ||||||||||
| ControlServers | A list of management servers, which can execute actions on agent and change agent's config. Hosts listed in this parameter also have read access to the agent. Both IP addresses and DNS names can be used. Multiple servers can be specified in one line, separated by commas. If this parameter is used more than once, servers listed in all occurrences will have access to agent. | Empty list | ||||||||||
| CreateCrashDumps | Enable (yes) or disable (no) creation of agent's crash dumps. Only has effect on Windows platforms. | no | ||||||||||
| DataDirectory | ||||||||||||
| DailyLogFileSuffix | ||||||||||||
| DebugLevel | Set agent 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. | C:\ | ||||||||||
| EnableActions | Enable (yes) or disable (no) action execution by agent. | yes | ||||||||||
| EnabledCiphers | Controls what ciphers agent can use for connection encryption. A value for this parameter is a cipher code. To enable more
than one cipher, the codes should be summed up. Possible cipher codes:
Example (enable AES-256 and IDEA): EnabledCiphers = 5 |
15 | ||||||||||
| EnableProxy | Enable (yes) or disable (no) agent proxy functionality. | no | ||||||||||
| EnableSNMPProxy | Enable (yes) or disable (no) SNMP proxy functionality. | no | ||||||||||
| EnableSNMPTrapProxy | Enable (yes) or disable (no) SNMP trap proxy functionality. | no | ||||||||||
| EnableSubagentAutoload | Enable (yes) or disable (no) loading of platform subagent(s). | yes | ||||||||||
| EnableWatchdog | Enable (yes) or disable (no) automatic agent restart in case of unexpected shutdown. | no | ||||||||||
| ExecTimeout | Timeout in milliseconds for external parameter execution. | 2000 | ||||||||||
| ExternalMasterAgent | ||||||||||||
| ExternalList | ||||||||||||
| ExternalParameter | Add parameter handled by external command. To add multiple parameters, you should use multiple ExternalParameter entries. See the Agent Configuration section for detailed description of this parameter. | No defaults | ||||||||||
| ExternalParameterShellExec | Add list handled by external command. To add multiple parameters, you should use multiple ExternalList entries. | No defaults | ||||||||||
| ExternalParametersProvider | ||||||||||||
| ExternalSubagent | ||||||||||||
| FileStore | Directory to be used for storing files uploaded by management server(s). | /tmp on UNIX
C:\ on Windows | ||||||||||
| FullCrashDumps | ||||||||||||
| ListenAddress | IP address that the agent should listen on. If 0.0.0.0 or * is specified as listen address, agent will listen on all available IP addresses. | 0.0.0.0 | ||||||||||
| ListenPort | TCP port to be used for incoming requests. | 4700 | ||||||||||
| LogFile | Agent's log file. To write log to syslog (or Event Log on Windows), use {syslog} as file name. | {syslog} | ||||||||||
| LogHistorySize | Defines how many old log files should be kept after log rotation. | 4 | ||||||||||
| LogRotationMode | ||||||||||||
| LogUnresolvedSymbols | If set to yes, all dynamically resolved symbols, which failed to be resolved, will be logged. | no | ||||||||||
| MasterServers | List of management servers, which have full access to agent. Hosts listed in this group can upload files to agent and initiate agent upgrade, as well as perform any task allowed for hosts listed in Servers and ControlServers. Both IP addresses and DNS names can be used. Multiple servers can be specified in one line, separated by commas. If this parameter is used more than once, servers listed in all occurrences will have access to agent. | Empty list | ||||||||||
| MaxLogSize | Maximum log size, in bytes. When log file reaches this limit, log rotation occurs. Use 0 to disable log rotation. | 16777216 | ||||||||||
| MaxSessions | Maximum number of simultaneous communication sessions. Possible value can range from 2 to 1024. | 32 | ||||||||||
| PlatformSuffix | String to be added as suffix to the value of System.PlatformName parameter. | Empty string | ||||||||||
| RequireAuthentication | If set to yes, a host connected to an agent has to provide correct shared secret before issuing any command. | no | ||||||||||
| RequireEncryption | If set to yes, a host connected to an agent will be forced to use encryption, and if encryption is not supported by a remote host, the connection will be dropped. If an agent was compiled without encryption support, this parameter has no effect. | no | ||||||||||
| Servers | A list of management servers, which have read access to this agent. Both IP addresses and DNS names can be used. Multiple servers can be specified in one line, separated by commas. If this parameter is used more than once, servers listed in all occurrences will have access to agent. | Empty list | ||||||||||
| SessionIdleTimeout | Communication session idle timeout in seconds. If an agent will not receive any command from peer within the specified timeout, session will be closed. | 60 | ||||||||||
| SharedSecret | Agent's shared secret used for remote peer authentication. If RequireAuthentication set to no, this parameter has no effect. | admin | ||||||||||
| EncryptedSharedSecret | Agent's shared secret used for remote peer authentication, encrypted using "nxencpasswd -a". If RequireAuthentication set to no, this parameter has no effect. | |||||||||||
| SNMPTimeout | Timeout in milliseconds for SNMP requests sent by agent | 3000 | ||||||||||
| SNMPTrapListenAddress | Interface address which should be used by server to listen for incoming SNMP trap connections. Use value 0.0.0.0 or * to use all available interfaces. | * | ||||||||||
| SNMPTrapPort | Port that will be used to listen SNMP traps | 162 | ||||||||||
| StartupDelay | Number of seconds that agent should wait on startup before start servicing requests. This parameter can be used to prevent false reports about missing processes or failed services just after monitored system startup. | 0 | ||||||||||
| SubAgent | Subagent to load. To load multiple subagents, you should use multiple SubAgent parameters. Subagents will be loaded in the same order as they appear in configuration file. | No defaults | ||||||||||
| TimeOut | ||||||||||||
| WaitForProcess | If specified, an agent will pause initialization until given process starts. | No defaults |
Configuration file example:
#
# Sample agent’s configuration file
#
MasterServers = 10.0.0.4
LogFile = {syslog}
SubAgent = winperf.nsm
# Below is a configuration for winperf subagent, in separate section
*WinPerf
EnableDefaultCounters = yes