NetXMS Wiki

Difference between revisions of "Agent Configuration File"

Agent Configuration File (view source)

Revision as of 18:13, 13 September 2022

1,768 bytes added ,  18:13, 13 September 2022
m
Text replacement - "^" to "{{deprecated}}"
(Created page with "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/n...")
 
m (Text replacement - "^" to "{{deprecated}}")
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
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.
{{deprecated}}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 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.


Line 8: Line 8:
! Parameter !! Description !! Default Value
! Parameter !! Description !! Default Value
|-
|-
| Action || Define action, which can be later executed by management server. See the Agent Configuration section for detailed description of
| Action || Define action, which can be later executed by management server. See the Agent Configuration section for detailed description of this parameter. || No defaults
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
| 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
| 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
Line 18: Line 21:
|-
|-
| CreateCrashDumps || Enable (''yes'') or disable (''no'') creation of agent's crash dumps. Only has effect on Windows platforms. || ''no''
| 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:\''
| DumpDirectory || Directory for storing crash dumps. || ''C:\''
Line 26: Line 36:
than one cipher, the codes should be summed up.
than one cipher, the codes should be summed up.
Possible cipher codes:
Possible cipher codes:
1 AES-256
{| class="wikitable"
2 BLOWFISH
|-
4 IDEA
| 1 || AES-256
8 Triple DES
|-
| 2 || BLOWFISH
|-
| 4 || IDEA
|-
| 8 || 3DES
|-
| 16 || AES-128
|}
 
Example (enable AES-256 and IDEA):
Example (enable AES-256 and IDEA):
EnabledCiphers = 5 || ''15''
EnabledCiphers = 5
|| ''15''
|-
|-
| EnableProxy || Enable (''yes'') or disable (''no'') agent proxy functionality. || ''no''
| EnableProxy || Enable (''yes'') or disable (''no'') agent proxy functionality. || ''no''
|-
|-
| EnableSNMPProxy || Enable (''yes'') or disable (''no'') SNMP 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''
| EnableSubagentAutoload || Enable (''yes'') or disable (''no'') loading of platform subagent(s). || ''yes''
Line 42: Line 64:
|-
|-
| ExecTimeout || Timeout in milliseconds for external parameter execution. || ''2000''
| 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
| 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
| FileStore || Directory to be used for storing files uploaded by management server(s). || ''/tmp'' on UNIX
''C:\'' on Windows
''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''
| 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''
Line 55: Line 89:
|-
|-
| LogHistorySize || Defines how many old log files should be kept after log rotation. || ''4''
| 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''
| LogUnresolvedSymbols || If set to yes, all dynamically resolved symbols, which failed to be resolved, will be logged. || ''no''
Line 75: Line 111:
|-
|-
| SharedSecret || Agent's shared secret used for remote peer authentication. If '''RequireAuthentication''' set to no, this parameter has no effect. || ''admin''
| 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''
| 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''
| 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
| 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
| WaitForProcess || If specified, an agent will pause initialization until given process starts. || No defaults
|}
|}
Configuration file example:
<syntaxhighlight lang="ini">
#
# 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
</syntaxhighlight>
Retrieved from "https://wiki.netxms.org/wiki/Special:MobileDiff/614...1788"