nxhttpd traces removed
[public/netxms.git] / contrib / nxagentd.conf-dist
1 #
2 # Sample configuration file for NetXMS agent
3 #
4
5 #
6 # Servers
7 #
8 # List of management servers which have read access to this agent.
9 # Both IP addresses and DNS names can be used. Multiple servers can be
10 # specified in one line, separated by commas. If this parameter used more
11 # than once, servers listed in all occurences will have access to agent.
12 #
13 # Examples:
14 # Servers = 10.0.0.1
15 # Servers = 127.0.0.1, srv1.domain.com, srv2.domain.com
16
17 #
18 # ControlServers
19 #
20 # List of management servers which can execute actions on agent. Hosts
21 # listed in this parameter also have read access to the agent. Both
22 # IP addresses and DNS names can be used. Multiple servers can be specified
23 # in one line, separated by commas. If this parameter used more than
24 # once, servers listed in all occurences will have access to agent.
25 #
26 # Examples:
27 # ControlServers = 10.0.0.1
28 # ControlServers = 127.0.0.1, srv1.domain.com, srv2.domain.com
29
30 #
31 # MasterServers
32 #
33 # List of management servers which have full access to agent. Hosts listed
34 # in this group can change agent's config, upload files to agent and initiate
35 # agent upgrade, as well as perform any task allowed for hosts listed in
36 # Servers and ControlServers. Both IP addresses and DNS names can be used.
37 # Multiple servers can be specified in one line, separated by commas.
38 # If this parameter used more than once, servers listed in all occurences
39 # will have access to agent.
40 #
41 # Examples:
42 # MasterServers = 10.0.0.1
43 # MasterServers = 127.0.0.1, srv1.domain.com, srv2.domain.com
44
45 #
46 # ListenPort
47 #
48 # Defines the port number for the agent to listen on incoming connections.
49 # Default values is 4700
50 #
51 # Examples:
52 # ListenPort = 4700
53
54 #
55 # LogFile
56 #
57 # Agent's log file. To write log to syslog (or Event Log on Windows),
58 # use {syslog} as file name.
59 #
60 # Examples:
61 # LogFile = {syslog}
62 # LogFile = /var/log/nxagentd.log
63
64 #
65 # RequireAuthentication
66 #
67 # If set to "yes", host connected to agent have to provide correct shared
68 # secret before issuing any command. Default value is "no".
69 #
70 # Example:
71 # RequireAuthentication = no
72
73 #
74 # RequireEncryption
75 #
76 # If set to "yes", host connected to agent will be forced to use encryption,
77 # and if encryption is not supported by remote host, connection will be
78 # dropped. Default value is "no". This parameter has no effect if agent
79 # was compiled without encryption support.
80 #
81 # Example:
82 # RequireEncryption = no
83
84 #
85 # EnabledCiphers
86 #
87 # Control what ciphers agent can use for connection encryption. Value for
88 # this parameter is a cipher code. To enable more than one cipher, they
89 # codes should be added. By default, all possible ciphers are enabled.
90 #
91 # Possible cipher codes:
92 # 1 = AES-256
93 # 2 = BLOWFISH
94 # 4 = IDEA
95 # 8 = Triple DES
96 #
97 # Example (enable AES-256 and IDEA):
98 # EnabledCiphers = 5
99
100 #
101 # SharedSecret
102 #
103 # Agent's shared secret. Used only if RequireAuthentication set to "yes".
104 #
105 # Example:
106 # SharedSecret = secret
107
108 #
109 # MaxSessions
110 #
111 # Maximum number of simultaneous communication sessions. Possible value can
112 # be in range from 2 to 1024. Default value is 32.
113 #
114 # Example:
115 # MaxSessions = 32
116
117 #
118 # SessionIdleTimeout
119 #
120 # Communication session's idle timeout in seconds. If agent will not receive
121 # any command from peer within specified timeout, session will be closed.
122 # Default value is 60 seconds.
123 #
124 # Example:
125 # SessionIdleTimeout = 60
126
127 #
128 # FileStore
129 #
130 # Directory to be used for storing files uploaded by installation server(s).
131 #
132 # Example:
133 # FileStore = /var/nxagentd
134
135 #
136 # TimeOut
137 #
138 # GET request timeout in seconds. If GET request cannot be completed for
139 # specified amount of time, agent will return an error to server.
140 # Default value is 5 seconds.
141 #
142 # Example:
143 # TimeOut = 5
144
145 #
146 # StartupDelay
147 #
148 # Number of seconds agent should wait on startup before start servicing
149 # requests. This parameter can be useful to prevent false reports about
150 # missing processes or failed services just after monitored system startup.
151 # Default value is 0, i.e. no startup delay.
152 #
153 # Example:
154 # StartupDelay = 0
155
156 #
157 # PlatformSuffix
158 #
159 # String to be added as suffix to value of System.PlatformName parameter.
160 #
161 # Example:
162 # PlatformSuffix = dbg
163
164 #
165 # EnableSubagentAutoload
166 #
167 # Enable or disable autoloading of platform subagent(s).
168 # Default value is "yes".
169 #
170 # Example:
171 # EnableSubagentAutoload = yes
172
173 #
174 # EnableProxy
175 #
176 # Allow requests forwarding
177 # Default value is "no"
178 #
179 # Example:
180 # EnableProxy = no
181
182 #
183 # EnableSNMPProxy
184 #
185 # Allow SNMP requests forwarding
186 # Default value is "no"
187 #
188 # Example:
189 # EnableSNMPProxy = no
190
191 #
192 # SubAgent
193 #
194 # Subagent to load. To load multiple subagents, you should use multiple
195 # SubAgent parameters. Subagents will be loaded in the same order as they
196 # appears in configuration file.
197 #
198 # UNIX example:
199 # SubAgent = [path_to_netxms_install_dir]/lib/libnsm_linux.so
200 #
201 # Windows example:
202 # SubAgent = winperf.nsm
203
204 #
205 # ExternalParameter
206 #
207 # Add parameter handled by external command. To add multiple parameters, you
208 # should use multiple ExternalParameter entries. Please note that on Windows
209 # agent uses system process execution API for execution of specified
210 # command, so you cannot use pipes or shell commands. If you need to
211 # execute command via shell, use ExternalParameterShellExec instead.
212 #
213 # Syntax:
214 # ExternalParameter = <parameter_name>:<command_line>
215 # If you specify parameter name as "name(*)", then you can use $1 .. $9 in
216 # command line to substitute actual arguments passed from server.
217 #
218 # Examples:
219 # ExternalParameter = Test:echo test
220 # ExternalParameter = LineCount(*):cat $1 | wc -l
221 # ExternalParameter = Test2(*):myprog $1 $2
222
223 #
224 # ExternalParameterShellExec
225 #
226 # Add parameter handled by external command. To add multiple parameters, you
227 # should use multiple ExternalParameterShellExec entries. This is similar
228 # to ExternalParameter with exception that agent will use shell to execute
229 # specified command instead of system process exeution API. This difference
230 # presented only on Windows system, on other systems ExternalParameter and
231 # ExternalParameterShellExec behaves identically.
232 #
233 # Syntax:
234 # ExternalParameterShellExec = <parameter_name>:<command_line>
235 # If you specify parameter name as "name(*)", then you can use $1 .. $9 in
236 # command line to substitute actual arguments passed from server.
237 #
238 # Examples:
239 # ExternalParameterShellExec = Test:dir c:\ | wc -l