agent data reconciliation block size and timeout can be configured
[public/netxms.git] / include / nms_agent.h
1 /*
2 ** NetXMS - Network Management System
3 ** Copyright (C) 2003-2013 Victor Kirhenshtein
4 **
5 ** This program is free software; you can redistribute it and/or modify
6 ** it under the terms of the GNU Lesser General Public License as published by
7 ** the Free Software Foundation; either version 3 of the License, or
8 ** (at your option) any later version.
9 **
10 ** This program is distributed in the hope that it will be useful,
11 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ** GNU General Public License for more details.
14 **
15 ** You should have received a copy of the GNU Lesser General Public License
16 ** along with this program; if not, write to the Free Software
17 ** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 **
19 ** File: nms_agent.h
20 **
21 **/
22
23 #ifndef _nms_agent_h_
24 #define _nms_agent_h_
25
26 #ifdef _WIN32
27 #ifdef LIBNXAGENT_EXPORTS
28 #define LIBNXAGENT_EXPORTABLE __declspec(dllexport)
29 #else
30 #define LIBNXAGENT_EXPORTABLE __declspec(dllimport)
31 #endif
32 #else /* _WIN32 */
33 #define LIBNXAGENT_EXPORTABLE
34 #endif
35
36
37 #include <nms_common.h>
38 #include <nms_util.h>
39 #include <nxconfig.h>
40 #include <nxdbapi.h>
41
42 /**
43 * Initialization function declaration macro
44 */
45 #if defined(_STATIC_AGENT) || defined(_NETWARE)
46 #define DECLARE_SUBAGENT_ENTRY_POINT(name) extern "C" BOOL NxSubAgentRegister_##name(NETXMS_SUBAGENT_INFO **ppInfo, Config *config)
47 #else
48 #ifdef _WIN32
49 #define DECLSPEC_EXPORT __declspec(dllexport) __cdecl
50 #else
51 #define DECLSPEC_EXPORT
52 #endif
53 #define DECLARE_SUBAGENT_ENTRY_POINT(name) extern "C" BOOL DECLSPEC_EXPORT NxSubAgentRegister(NETXMS_SUBAGENT_INFO **ppInfo, Config *config)
54 #endif
55
56 /**
57 * Constants
58 */
59 #define AGENT_LISTEN_PORT 4700
60 #define AGENT_PROTOCOL_VERSION 2
61 #define MAX_RESULT_LENGTH 256
62 #define MAX_CMD_LEN 256
63 #define COMMAND_TIMEOUT 60
64 #define MAX_SUBAGENT_NAME 64
65 #define MAX_INSTANCE_COLUMNS 8
66
67 /**
68 * Agent policy types
69 */
70 #define AGENT_POLICY_CONFIG 1
71 #define AGENT_POLICY_LOG_PARSER 2
72
73 /**
74 * Agent log parser policy folder
75 */
76 #define LOGPARSER_AP_FOLDER _T("logparser_ap")
77 #define CONFIG_AP_FOLDER _T("config_ap")
78
79 /**
80 * Error codes
81 */
82 #define ERR_SUCCESS ((UINT32)0)
83 #define ERR_UNKNOWN_COMMAND ((UINT32)400)
84 #define ERR_AUTH_REQUIRED ((UINT32)401)
85 #define ERR_ACCESS_DENIED ((UINT32)403)
86 #define ERR_UNKNOWN_PARAMETER ((UINT32)404)
87 #define ERR_REQUEST_TIMEOUT ((UINT32)408)
88 #define ERR_AUTH_FAILED ((UINT32)440)
89 #define ERR_ALREADY_AUTHENTICATED ((UINT32)441)
90 #define ERR_AUTH_NOT_REQUIRED ((UINT32)442)
91 #define ERR_INTERNAL_ERROR ((UINT32)500)
92 #define ERR_NOT_IMPLEMENTED ((UINT32)501)
93 #define ERR_OUT_OF_RESOURCES ((UINT32)503)
94 #define ERR_NOT_CONNECTED ((UINT32)900)
95 #define ERR_CONNECTION_BROKEN ((UINT32)901)
96 #define ERR_BAD_RESPONSE ((UINT32)902)
97 #define ERR_IO_FAILURE ((UINT32)903)
98 #define ERR_RESOURCE_BUSY ((UINT32)904)
99 #define ERR_EXEC_FAILED ((UINT32)905)
100 #define ERR_ENCRYPTION_REQUIRED ((UINT32)906)
101 #define ERR_NO_CIPHERS ((UINT32)907)
102 #define ERR_INVALID_PUBLIC_KEY ((UINT32)908)
103 #define ERR_INVALID_SESSION_KEY ((UINT32)909)
104 #define ERR_CONNECT_FAILED ((UINT32)910)
105 #define ERR_MALFORMED_COMMAND ((UINT32)911)
106 #define ERR_SOCKET_ERROR ((UINT32)912)
107 #define ERR_BAD_ARGUMENTS ((UINT32)913)
108 #define ERR_SUBAGENT_LOAD_FAILED ((UINT32)914)
109 #define ERR_FILE_OPEN_ERROR ((UINT32)915)
110 #define ERR_FILE_STAT_FAILED ((UINT32)916)
111 #define ERR_MEM_ALLOC_FAILED ((UINT32)917)
112 #define ERR_FILE_DELETE_FAILED ((UINT32)918)
113 #define ERR_NO_SESSION_AGENT ((UINT32)919)
114 #define ERR_SERVER_ID_UNSET ((UINT32)920)
115 #define ERR_NO_SUCH_INSTANCE ((UINT32)921)
116
117 /**
118 * Bulk data reconciliation DCI processing status codes
119 */
120 #define BULK_DATA_REC_RETRY 0
121 #define BULK_DATA_REC_SUCCESS 1
122 #define BULK_DATA_REC_FAILURE 2
123
124 /**
125 * Max bulk data block size
126 */
127 #define MAX_BULK_DATA_BLOCK_SIZE 8192
128
129 /**
130 * Parameter handler return codes
131 */
132 #define SYSINFO_RC_SUCCESS 0
133 #define SYSINFO_RC_UNSUPPORTED 1
134 #define SYSINFO_RC_ERROR 2
135 #define SYSINFO_RC_NO_SUCH_INSTANCE 3
136
137 /**
138 * WinPerf features
139 */
140 #define WINPERF_AUTOMATIC_SAMPLE_COUNT ((UINT32)0x00000001)
141 #define WINPERF_REMOTE_COUNTER_CONFIG ((UINT32)0x00000002)
142
143 /**
144 * User session states (used by session agents)
145 */
146 #define USER_SESSION_ACTIVE 0
147 #define USER_SESSION_CONNECTED 1
148 #define USER_SESSION_DISCONNECTED 2
149 #define USER_SESSION_IDLE 3
150 #define USER_SESSION_OTHER 4
151
152 /**
153 * Descriptions for common parameters
154 */
155 #define DCIDESC_FS_AVAIL _T("Available space on file system {instance}")
156 #define DCIDESC_FS_AVAILPERC _T("Percentage of available space on file system {instance}")
157 #define DCIDESC_FS_FREE _T("Free space on file system {instance}")
158 #define DCIDESC_FS_FREEPERC _T("Percentage of free space on file system {instance}")
159 #define DCIDESC_FS_TOTAL _T("Total space on file system {instance}")
160 #define DCIDESC_FS_TYPE _T("Type of file system {instance}")
161 #define DCIDESC_FS_USED _T("Used space on file system {instance}")
162 #define DCIDESC_FS_USEDPERC _T("Percentage of used space on file system {instance}")
163 #define DCIDESC_NET_INTERFACE_64BITCOUNTERS _T("Is 64bit interface counters supported")
164 #define DCIDESC_NET_INTERFACE_ADMINSTATUS _T("Administrative status of interface {instance}")
165 #define DCIDESC_NET_INTERFACE_BYTESIN _T("Number of input bytes on interface {instance}")
166 #define DCIDESC_NET_INTERFACE_BYTESOUT _T("Number of output bytes on interface {instance}")
167 #define DCIDESC_NET_INTERFACE_DESCRIPTION _T("Description of interface {instance}")
168 #define DCIDESC_NET_INTERFACE_INERRORS _T("Number of input errors on interface {instance}")
169 #define DCIDESC_NET_INTERFACE_LINK _T("Link status for interface {instance}")
170 #define DCIDESC_NET_INTERFACE_MTU _T("MTU for interface {instance}")
171 #define DCIDESC_NET_INTERFACE_OPERSTATUS _T("Operational status of interface {instance}")
172 #define DCIDESC_NET_INTERFACE_OUTERRORS _T("Number of output errors on interface {instance}")
173 #define DCIDESC_NET_INTERFACE_PACKETSIN _T("Number of input packets on interface {instance}")
174 #define DCIDESC_NET_INTERFACE_PACKETSOUT _T("Number of output packets on interface {instance}")
175 #define DCIDESC_NET_INTERFACE_SPEED _T("Speed of interface {instance}")
176 #define DCIDESC_NET_IP_FORWARDING _T("IP forwarding status")
177 #define DCIDESC_NET_IP6_FORWARDING _T("IPv6 forwarding status")
178 #define DCIDESC_NET_RESOLVER_ADDRBYNAME _T("Resolver: address for name {instance}")
179 #define DCIDESC_NET_RESOLVER_NAMEBYADDR _T("Resolver: name for address {instance}")
180 #define DCIDESC_PHYSICALDISK_FIRMWARE _T("Firmware version of hard disk {instance}")
181 #define DCIDESC_PHYSICALDISK_MODEL _T("Model of hard disk {instance}")
182 #define DCIDESC_PHYSICALDISK_SERIALNUMBER _T("Serial number of hard disk {instance}")
183 #define DCIDESC_PHYSICALDISK_SMARTATTR _T("")
184 #define DCIDESC_PHYSICALDISK_SMARTSTATUS _T("Status of hard disk {instance} reported by SMART")
185 #define DCIDESC_PHYSICALDISK_TEMPERATURE _T("Temperature of hard disk {instance}")
186 #define DCIDESC_SYSTEM_CPU_CACHE_SIZE _T("CPU {instance}: cache size (KB)")
187 #define DCIDESC_SYSTEM_CPU_CORE_ID _T("CPU {instance}: core ID")
188 #define DCIDESC_SYSTEM_CPU_COUNT _T("Number of CPU in the system")
189 #define DCIDESC_SYSTEM_CPU_FREQUENCY _T("CPU {instance}: frequency")
190 #define DCIDESC_SYSTEM_CPU_MODEL _T("CPU {instance}: model")
191 #define DCIDESC_SYSTEM_CPU_PHYSICAL_ID _T("CPU {instance}: physical ID")
192 #define DCIDESC_SYSTEM_HOSTNAME _T("Host name")
193 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_AVAILABLE _T("Available physical memory")
194 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_AVAILABLE_PCT _T("Percentage of available physical memory")
195 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_BUFFERS _T("Physical memory used for buffers")
196 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_BUFFERS_PCT _T("Percentage of physical memory used for buffers")
197 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_CACHED _T("Physical memory used for cache")
198 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_CACHED_PCT _T("Percentage of physical memory used for cache")
199 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_FREE _T("Free physical memory")
200 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_FREE_PCT _T("Percentage of free physical memory")
201 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_TOTAL _T("Total amount of physical memory")
202 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_USED _T("Used physical memory")
203 #define DCIDESC_SYSTEM_MEMORY_PHYSICAL_USED_PCT _T("Percentage of used physical memory")
204 #define DCIDESC_SYSTEM_MEMORY_VIRTUAL_ACTIVE _T("Active virtual memory")
205 #define DCIDESC_SYSTEM_MEMORY_VIRTUAL_ACTIVE_PCT _T("Percentage of active virtual memory")
206 #define DCIDESC_SYSTEM_MEMORY_VIRTUAL_FREE _T("Free virtual memory")
207 #define DCIDESC_SYSTEM_MEMORY_VIRTUAL_FREE_PCT _T("Percentage of free virtual memory")
208 #define DCIDESC_SYSTEM_MEMORY_VIRTUAL_TOTAL _T("Total amount of virtual memory")
209 #define DCIDESC_SYSTEM_MEMORY_VIRTUAL_USED _T("Used virtual memory")
210 #define DCIDESC_SYSTEM_MEMORY_VIRTUAL_USED_PCT _T("Percentage of used virtual memory")
211 #define DCIDESC_SYSTEM_MEMORY_VIRTUAL_AVAILABLE _T("Available virtual memory")
212 #define DCIDESC_SYSTEM_MEMORY_VIRTUAL_AVAILABLE_PCT _T("Percentage of available virtual memory")
213 #define DCIDESC_SYSTEM_MEMORY_SWAP_FREE _T("Free swap space")
214 #define DCIDESC_SYSTEM_MEMORY_SWAP_FREE_PCT _T("Percentage of free swap space")
215 #define DCIDESC_SYSTEM_MEMORY_SWAP_TOTAL _T("Total amount of swap space")
216 #define DCIDESC_SYSTEM_MEMORY_SWAP_USED _T("Used swap space")
217 #define DCIDESC_SYSTEM_MEMORY_SWAP_USED_PCT _T("Percentage of used swap space")
218 #define DCIDESC_SYSTEM_MSGQUEUE_BYTES _T("Message queue {instance}: bytes in queue")
219 #define DCIDESC_SYSTEM_MSGQUEUE_BYTES_MAX _T("Message queue {instance}: maximum allowed bytes in queue")
220 #define DCIDESC_SYSTEM_MSGQUEUE_CHANGE_TIME _T("Message queue {instance}: last change time")
221 #define DCIDESC_SYSTEM_MSGQUEUE_MESSAGES _T("Message queue {instance}: number of messages")
222 #define DCIDESC_SYSTEM_MSGQUEUE_RECV_TIME _T("Message queue {instance}: last receive time")
223 #define DCIDESC_SYSTEM_MSGQUEUE_SEND_TIME _T("Message queue {instance}: last send time")
224 #define DCIDESC_SYSTEM_UNAME _T("System uname")
225 #define DCIDESC_AGENT_ACCEPTEDCONNECTIONS _T("Number of connections accepted by agent")
226 #define DCIDESC_AGENT_ACCEPTERRORS _T("Number of accept() call errors")
227 #define DCIDESC_AGENT_ACTIVECONNECTIONS _T("Number of active connections to agent")
228 #define DCIDESC_AGENT_AUTHENTICATIONFAILURES _T("Number of authentication failures")
229 #define DCIDESC_AGENT_CONFIG_SERVER _T("Configuration server address set on agent startup")
230 #define DCIDESC_AGENT_DATACOLLQUEUESIZE _T("Agent data collector queue size")
231 #define DCIDESC_AGENT_FAILEDREQUESTS _T("Number of failed requests to agent")
232 #define DCIDESC_AGENT_GENERATED_TRAPS _T("Number of traps generated by agent")
233 #define DCIDESC_AGENT_IS_SUBAGENT_LOADED _T("Check if given subagent is loaded")
234 #define DCIDESC_AGENT_LAST_TRAP_TIME _T("Timestamp of last generated trap")
235 #define DCIDESC_AGENT_PROCESSEDREQUESTS _T("Number of requests processed by agent")
236 #define DCIDESC_AGENT_REGISTRAR _T("Registrar server address set on agent startup")
237 #define DCIDESC_AGENT_REJECTEDCONNECTIONS _T("Number of connections rejected by agent")
238 #define DCIDESC_AGENT_SENT_TRAPS _T("Number of traps successfully sent to server")
239 #define DCIDESC_AGENT_SOURCEPACKAGESUPPORT _T("Check if source packages are supported")
240 #define DCIDESC_AGENT_SUPPORTEDCIPHERS _T("List of ciphers supported by agent")
241 #define DCIDESC_AGENT_THREADPOOL_ACTIVEREQUESTS _T("Agent thread pool {instance}: active requests")
242 #define DCIDESC_AGENT_THREADPOOL_CURRSIZE _T("Agent thread pool {instance}: current size")
243 #define DCIDESC_AGENT_THREADPOOL_LOAD _T("Agent thread pool {instance}: current load")
244 #define DCIDESC_AGENT_THREADPOOL_LOADAVG _T("Agent thread pool {instance}: load average (1 minute)")
245 #define DCIDESC_AGENT_THREADPOOL_LOADAVG_5 _T("Agent thread pool {instance}: load average (5 minutes)")
246 #define DCIDESC_AGENT_THREADPOOL_LOADAVG_15 _T("Agent thread pool {instance}: load average (15 minutes)")
247 #define DCIDESC_AGENT_THREADPOOL_MAXSIZE _T("Agent thread pool {instance}: max size")
248 #define DCIDESC_AGENT_THREADPOOL_MINSIZE _T("Agent thread pool {instance}: min size")
249 #define DCIDESC_AGENT_THREADPOOL_USAGE _T("Agent thread pool {instance}: usage")
250 #define DCIDESC_AGENT_TIMEDOUTREQUESTS _T("Number of timed out requests to agent")
251 #define DCIDESC_AGENT_UNSUPPORTEDREQUESTS _T("Number of requests for unsupported parameters")
252 #define DCIDESC_AGENT_UPTIME _T("Agent's uptime")
253 #define DCIDESC_AGENT_VERSION _T("Agent's version")
254 #define DCIDESC_FILE_COUNT _T("Number of files {instance}")
255 #define DCIDESC_FILE_FOLDERCOUNT _T("Number of folders {instance}")
256 #define DCIDESC_FILE_HASH_CRC32 _T("CRC32 checksum of {instance}")
257 #define DCIDESC_FILE_HASH_MD5 _T("MD5 hash of {instance}")
258 #define DCIDESC_FILE_HASH_SHA1 _T("SHA1 hash of {instance}")
259 #define DCIDESC_FILE_SIZE _T("Size of file {instance}")
260 #define DCIDESC_FILE_TIME_ACCESS _T("Time of last access to file {instance}")
261 #define DCIDESC_FILE_TIME_CHANGE _T("Time of last status change of file {instance}")
262 #define DCIDESC_FILE_TIME_MODIFY _T("Time of last modification of file {instance}")
263 #define DCIDESC_SYSTEM_CURRENTTIME _T("Current system time")
264 #define DCIDESC_SYSTEM_PLATFORMNAME _T("Platform name")
265 #define DCIDESC_PROCESS_COUNT _T("Number of {instance} processes")
266 #define DCIDESC_PROCESS_COUNTEX _T("Number of {instance} processes (extended)")
267 #define DCIDESC_PROCESS_CPUTIME _T("Total execution time for process {instance}")
268 #define DCIDESC_PROCESS_GDIOBJ _T("GDI objects used by process {instance}")
269 #define DCIDESC_PROCESS_HANDLES _T("Number of handles in process {instance}")
270 #define DCIDESC_PROCESS_IO_OTHERB _T("")
271 #define DCIDESC_PROCESS_IO_OTHEROP _T("")
272 #define DCIDESC_PROCESS_IO_READB _T("")
273 #define DCIDESC_PROCESS_IO_READOP _T("")
274 #define DCIDESC_PROCESS_IO_WRITEB _T("")
275 #define DCIDESC_PROCESS_IO_WRITEOP _T("")
276 #define DCIDESC_PROCESS_KERNELTIME _T("Total execution time in kernel mode for process {instance}")
277 #define DCIDESC_PROCESS_PAGEFAULTS _T("Page faults for process {instance}")
278 #define DCIDESC_PROCESS_SYSCALLS _T("Number of system calls made by process {instance}")
279 #define DCIDESC_PROCESS_THREADS _T("Number of threads in process {instance}")
280 #define DCIDESC_PROCESS_USEROBJ _T("USER objects used by process {instance}")
281 #define DCIDESC_PROCESS_USERTIME _T("Total execution time in user mode for process {instance}")
282 #define DCIDESC_PROCESS_VMSIZE _T("Virtual memory used by process {instance}")
283 #define DCIDESC_PROCESS_WKSET _T("Physical memory used by process {instance}")
284 #define DCIDESC_PROCESS_ZOMBIE_COUNT _T("Number of {instance} zombie processes")
285 #define DCIDESC_SYSTEM_APPADDRESSSPACE _T("Address space available to applications (MB)")
286 #define DCIDESC_SYSTEM_CONNECTEDUSERS _T("Number of logged in users")
287 #define DCIDESC_SYSTEM_HANDLECOUNT _T("Total number of handles")
288 #define DCIDESC_SYSTEM_PROCESSCOUNT _T("Total number of processes")
289 #define DCIDESC_SYSTEM_SERVICESTATE _T("State of {instance} service")
290 #define DCIDESC_SYSTEM_THREADCOUNT _T("Total number of threads")
291 #define DCIDESC_PDH_COUNTERVALUE _T("Value of PDH counter {instance}")
292 #define DCIDESC_PDH_VERSION _T("Version of PDH.DLL")
293 #define DCIDESC_SYSTEM_UPTIME _T("System uptime")
294 #define DCIDESC_SYSTEM_CPU_LOADAVG _T("Average CPU load for last minute")
295 #define DCIDESC_SYSTEM_CPU_LOADAVG5 _T("Average CPU load for last 5 minutes")
296 #define DCIDESC_SYSTEM_CPU_LOADAVG15 _T("Average CPU load for last 15 minutes")
297
298
299 #define DCIDESC_SYSTEM_CPU_USAGE_EX _T("Average CPU {instance} utilization for last minute")
300 #define DCIDESC_SYSTEM_CPU_USAGE5_EX _T("Average CPU {instance} utilization for last 5 minutes")
301 #define DCIDESC_SYSTEM_CPU_USAGE15_EX _T("Average CPU {instance} utilization for last 15 minutes")
302 #define DCIDESC_SYSTEM_CPU_USAGE _T("Average CPU utilization for last minute")
303 #define DCIDESC_SYSTEM_CPU_USAGE5 _T("Average CPU utilization for last 5 minutes")
304 #define DCIDESC_SYSTEM_CPU_USAGE15 _T("Average CPU utilization for last 15 minutes")
305
306 #define DCIDESC_SYSTEM_CPU_USAGE_USER_EX _T("Average CPU {instance} utilization (user) for last minute")
307 #define DCIDESC_SYSTEM_CPU_USAGE5_USER_EX _T("Average CPU {instance} utilization (user) for last 5 minutes")
308 #define DCIDESC_SYSTEM_CPU_USAGE15_USER_EX _T("Average CPU {instance} utilization (user) for last 15 minutes")
309 #define DCIDESC_SYSTEM_CPU_USAGE_USER _T("Average CPU utilization (user) for last minute")
310 #define DCIDESC_SYSTEM_CPU_USAGE5_USER _T("Average CPU utilization (user) for last 5 minutes")
311 #define DCIDESC_SYSTEM_CPU_USAGE15_USER _T("Average CPU utilization (user) for last 15 minutes")
312
313 #define DCIDESC_SYSTEM_CPU_USAGE_NICE_EX _T("Average CPU {instance} utilization (nice) for last minute")
314 #define DCIDESC_SYSTEM_CPU_USAGE5_NICE_EX _T("Average CPU {instance} utilization (nice) for last 5 minutes")
315 #define DCIDESC_SYSTEM_CPU_USAGE15_NICE_EX _T("Average CPU {instance} utilization (nice) for last 15 minutes")
316 #define DCIDESC_SYSTEM_CPU_USAGE_NICE _T("Average CPU utilization (nice) for last minute")
317 #define DCIDESC_SYSTEM_CPU_USAGE5_NICE _T("Average CPU utilization (nice) for last 5 minutes")
318 #define DCIDESC_SYSTEM_CPU_USAGE15_NICE _T("Average CPU utilization (nice) for last 15 minutes")
319
320 #define DCIDESC_SYSTEM_CPU_USAGE_SYSTEM_EX _T("Average CPU {instance} utilization (system) for last minute")
321 #define DCIDESC_SYSTEM_CPU_USAGE5_SYSTEM_EX _T("Average CPU {instance} utilization (system) for last 5 minutes")
322 #define DCIDESC_SYSTEM_CPU_USAGE15_SYSTEM_EX _T("Average CPU {instance} utilization (system) for last 15 minutes")
323 #define DCIDESC_SYSTEM_CPU_USAGE_SYSTEM _T("Average CPU utilization (system) for last minute")
324 #define DCIDESC_SYSTEM_CPU_USAGE5_SYSTEM _T("Average CPU utilization (system) for last 5 minutes")
325 #define DCIDESC_SYSTEM_CPU_USAGE15_SYSTEM _T("Average CPU utilization (system) for last 15 minutes")
326
327 #define DCIDESC_SYSTEM_CPU_USAGE_IDLE_EX _T("Average CPU {instance} utilization (idle) for last minute")
328 #define DCIDESC_SYSTEM_CPU_USAGE5_IDLE_EX _T("Average CPU {instance} utilization (idle) for last 5 minutes")
329 #define DCIDESC_SYSTEM_CPU_USAGE15_IDLE_EX _T("Average CPU {instance} utilization (idle) for last 15 minutes")
330 #define DCIDESC_SYSTEM_CPU_USAGE_IDLE _T("Average CPU utilization (idle) for last minute")
331 #define DCIDESC_SYSTEM_CPU_USAGE5_IDLE _T("Average CPU utilization (idle) for last 5 minutes")
332 #define DCIDESC_SYSTEM_CPU_USAGE15_IDLE _T("Average CPU utilization (idle) for last 15 minutes")
333
334 #define DCIDESC_SYSTEM_CPU_USAGE_IOWAIT_EX _T("Average CPU {instance} utilization (iowait) for last minute")
335 #define DCIDESC_SYSTEM_CPU_USAGE5_IOWAIT_EX _T("Average CPU {instance} utilization (iowait) for last 5 minutes")
336 #define DCIDESC_SYSTEM_CPU_USAGE15_IOWAIT_EX _T("Average CPU {instance} utilization (iowait) for last 15 minutes")
337 #define DCIDESC_SYSTEM_CPU_USAGE_IOWAIT _T("Average CPU utilization (iowait) for last minute")
338 #define DCIDESC_SYSTEM_CPU_USAGE5_IOWAIT _T("Average CPU utilization (iowait) for last 5 minutes")
339 #define DCIDESC_SYSTEM_CPU_USAGE15_IOWAIT _T("Average CPU utilization (iowait) for last 15 minutes")
340
341 #define DCIDESC_SYSTEM_CPU_USAGE_IRQ_EX _T("Average CPU {instance} utilization (irq) for last minute")
342 #define DCIDESC_SYSTEM_CPU_USAGE5_IRQ_EX _T("Average CPU {instance} utilization (irq) for last 5 minutes")
343 #define DCIDESC_SYSTEM_CPU_USAGE15_IRQ_EX _T("Average CPU {instance} utilization (irq) for last 15 minutes")
344 #define DCIDESC_SYSTEM_CPU_USAGE_IRQ _T("Average CPU utilization (irq) for last minute")
345 #define DCIDESC_SYSTEM_CPU_USAGE5_IRQ _T("Average CPU utilization (irq) for last 5 minutes")
346 #define DCIDESC_SYSTEM_CPU_USAGE15_IRQ _T("Average CPU utilization (irq) for last 15 minutes")
347
348 #define DCIDESC_SYSTEM_CPU_USAGE_SOFTIRQ_EX _T("Average CPU {instance} utilization (softirq) for last minute")
349 #define DCIDESC_SYSTEM_CPU_USAGE5_SOFTIRQ_EX _T("Average CPU {instance} utilization (softirq) for last 5 minutes")
350 #define DCIDESC_SYSTEM_CPU_USAGE15_SOFTIRQ_EX _T("Average CPU {instance} utilization (softirq) for last 15 minutes")
351 #define DCIDESC_SYSTEM_CPU_USAGE_SOFTIRQ _T("Average CPU utilization (softirq) for last minute")
352 #define DCIDESC_SYSTEM_CPU_USAGE5_SOFTIRQ _T("Average CPU utilization (softirq) for last 5 minutes")
353 #define DCIDESC_SYSTEM_CPU_USAGE15_SOFTIRQ _T("Average CPU utilization (softirq) for last 15 minutes")
354
355 #define DCIDESC_SYSTEM_CPU_USAGE_STEAL_EX _T("Average CPU {instance} utilization (steal) for last minute")
356 #define DCIDESC_SYSTEM_CPU_USAGE5_STEAL_EX _T("Average CPU {instance} utilization (steal) for last 5 minutes")
357 #define DCIDESC_SYSTEM_CPU_USAGE15_STEAL_EX _T("Average CPU {instance} utilization (steal) for last 15 minutes")
358 #define DCIDESC_SYSTEM_CPU_USAGE_STEAL _T("Average CPU utilization (steal) for last minute")
359 #define DCIDESC_SYSTEM_CPU_USAGE5_STEAL _T("Average CPU utilization (steal) for last 5 minutes")
360 #define DCIDESC_SYSTEM_CPU_USAGE15_STEAL _T("Average CPU utilization (steal) for last 15 minutes")
361
362 #define DCIDESC_SYSTEM_CPU_USAGE_GUEST_EX _T("Average CPU {instance} utilization (guest) for last minute")
363 #define DCIDESC_SYSTEM_CPU_USAGE5_GUEST_EX _T("Average CPU {instance} utilization (guest) for last 5 minutes")
364 #define DCIDESC_SYSTEM_CPU_USAGE15_GUEST_EX _T("Average CPU {instance} utilization (guest) for last 15 minutes")
365 #define DCIDESC_SYSTEM_CPU_USAGE_GUEST _T("Average CPU utilization (guest) for last minute")
366 #define DCIDESC_SYSTEM_CPU_USAGE5_GUEST _T("Average CPU utilization (guest) for last 5 minutes")
367 #define DCIDESC_SYSTEM_CPU_USAGE15_GUEST _T("Average CPU utilization (guest) for last 15 minutes")
368
369 #define DCIDESC_SYSTEM_IO_DISKQUEUE _T("Average disk queue length for last minute")
370 #define DCIDESC_SYSTEM_IO_DISKQUEUE_MIN _T("Minimum disk queue length for last minute")
371 #define DCIDESC_SYSTEM_IO_DISKQUEUE_MAX _T("Maximum disk queue length for last minute")
372 #define DCIDESC_SYSTEM_IO_DISKQUEUE_EX _T("Average disk queue length of device {instance} for last minute")
373 #define DCIDESC_SYSTEM_IO_DISKQUEUE_EX_MIN _T("Minimum disk queue length of device {instance} for last minute")
374 #define DCIDESC_SYSTEM_IO_DISKQUEUE_EX_MAX _T("Maximum disk queue length of device {instance} for last minute")
375 #define DCIDESC_SYSTEM_IO_DISKTIME _T("Percent of CPU time spent on I/O for last minute")
376 #define DCIDESC_SYSTEM_IO_DISKTIME_EX _T("Percent of CPU time spent on I/O on device {instance} for last minute")
377 #define DCIDESC_SYSTEM_IO_WAITTIME _T("Average I/O request wait time")
378 #define DCIDESC_SYSTEM_IO_WAITTIME_EX _T("Average I/O request wait time for device {instance}")
379 #define DCIDESC_SYSTEM_IO_READS _T("Average number of read operations for last minute")
380 #define DCIDESC_SYSTEM_IO_READS_MIN _T("Minimum number of read operations for last minute")
381 #define DCIDESC_SYSTEM_IO_READS_MAX _T("Maximum number of read operations for last minute")
382 #define DCIDESC_SYSTEM_IO_READS_EX _T("Average number of read operations on device {instance} for last minute")
383 #define DCIDESC_SYSTEM_IO_READS_EX_MIN _T("Minimum number of read operations on device {instance} for last minute")
384 #define DCIDESC_SYSTEM_IO_READS_EX_MAX _T("Maximum number of read operations on device {instance} for last minute")
385 #define DCIDESC_SYSTEM_IO_WRITES _T("Average number of write operations for last minute")
386 #define DCIDESC_SYSTEM_IO_WRITES_MIN _T("Minimum number of write operations for last minute")
387 #define DCIDESC_SYSTEM_IO_WRITES_MAX _T("Maximum number of write operations for last minute")
388 #define DCIDESC_SYSTEM_IO_WRITES_EX _T("Average number of write operations on device {instance} for last minute")
389 #define DCIDESC_SYSTEM_IO_WRITES_EX_MIN _T("Minimum number of write operations on device {instance} for last minute")
390 #define DCIDESC_SYSTEM_IO_WRITES_EX_MAX _T("Maximum number of write operations on device {instance} for last minute")
391 #define DCIDESC_SYSTEM_IO_XFERS _T("Average number of I/O transfers for last minute")
392 #define DCIDESC_SYSTEM_IO_XFERS_MIN _T("Minimum number of I/O transfers for last minute")
393 #define DCIDESC_SYSTEM_IO_XFERS_MAX _T("Maximum number of I/O transfers for last minute")
394 #define DCIDESC_SYSTEM_IO_XFERS_EX _T("Average number of I/O transfers on device {instance} for last minute")
395 #define DCIDESC_SYSTEM_IO_XFERS_EX_MIN _T("Minimum number of I/O transfers on device {instance} for last minute")
396 #define DCIDESC_SYSTEM_IO_XFERS_EX_MAX _T("Maximum number of I/O transfers on device {instance} for last minute")
397 #define DCIDESC_SYSTEM_IO_BYTEREADS _T("Average number of bytes read for last minute")
398 #define DCIDESC_SYSTEM_IO_BYTEREADS_MIN _T("Minimum number of bytes read for last minute")
399 #define DCIDESC_SYSTEM_IO_BYTEREADS_MAX _T("Maximum number of bytes read for last minute")
400 #define DCIDESC_SYSTEM_IO_BYTEREADS_EX _T("Average number of bytes read on device {instance} for last minute")
401 #define DCIDESC_SYSTEM_IO_BYTEREADS_EX_MIN _T("Minimum number of bytes read on device {instance} for last minute")
402 #define DCIDESC_SYSTEM_IO_BYTEREADS_EX_MAX _T("Maximum number of bytes read on device {instance} for last minute")
403 #define DCIDESC_SYSTEM_IO_BYTEWRITES _T("Average number of bytes written for last minute")
404 #define DCIDESC_SYSTEM_IO_BYTEWRITES_MIN _T("Minimum number of bytes written for last minute")
405 #define DCIDESC_SYSTEM_IO_BYTEWRITES_MAX _T("Maximum number of bytes written for last minute")
406 #define DCIDESC_SYSTEM_IO_BYTEWRITES_EX _T("Average number of bytes written on device {instance} for last minute")
407 #define DCIDESC_SYSTEM_IO_BYTEWRITES_EX_MIN _T("Minimum number of bytes written on device {instance} for last minute")
408 #define DCIDESC_SYSTEM_IO_BYTEWRITES_EX_MAX _T("Maximum number of bytes written on device {instance} for last minute")
409 #define DCIDESC_SYSTEM_IO_OPENFILES _T("Number of open files")
410
411
412 #define DCIDESC_DEPRECATED _T("<deprecated>")
413
414
415 #define DCTDESC_AGENT_SESSION_AGENTS _T("Registered session agents")
416 #define DCTDESC_AGENT_SUBAGENTS _T("Loaded subagents")
417 #define DCTDESC_FILESYSTEM_VOLUMES _T("File system volumes")
418 #define DCTDESC_SYSTEM_INSTALLED_PRODUCTS _T("Installed products")
419 #define DCTDESC_SYSTEM_OPEN_FILES _T("Open files")
420 #define DCTDESC_SYSTEM_PROCESSES _T("Processes")
421
422 /**
423 * API for CommSession
424 */
425 class AbstractCommSession : public RefCountObject
426 {
427 public:
428 virtual bool isMasterServer() = 0;
429 virtual bool isControlServer() = 0;
430 virtual bool canAcceptData() = 0;
431 virtual bool canAcceptTraps() = 0;
432 virtual bool canAcceptFileUpdates() = 0;
433 virtual UINT64 getServerId() = 0;
434 virtual const InetAddress& getServerAddress() = 0;
435
436 virtual bool isIPv6Aware() = 0;
437
438 virtual void sendMessage(NXCPMessage *msg) = 0;
439 virtual void sendRawMessage(NXCP_MESSAGE *msg) = 0;
440 virtual bool sendFile(UINT32 requestId, const TCHAR *file, long offset) = 0;
441 virtual UINT32 doRequest(NXCPMessage *msg, UINT32 timeout) = 0;
442 virtual NXCPMessage *doRequestEx(NXCPMessage *msg, UINT32 timeout) = 0;
443 virtual UINT32 generateRequestId() = 0;
444 virtual UINT32 openFile(TCHAR* nameOfFile, UINT32 requestId) = 0;
445 };
446
447 /**
448 * Subagent's parameter information
449 */
450 typedef struct
451 {
452 TCHAR name[MAX_PARAM_NAME];
453 LONG (* handler)(const TCHAR *, const TCHAR *, TCHAR *, AbstractCommSession *);
454 const TCHAR *arg;
455 int dataType; // Use DT_DEPRECATED to indicate deprecated parameter
456 TCHAR description[MAX_DB_STRING];
457 } NETXMS_SUBAGENT_PARAM;
458
459 /**
460 * Subagent's push parameter information
461 */
462 typedef struct
463 {
464 TCHAR name[MAX_PARAM_NAME];
465 int dataType;
466 TCHAR description[MAX_DB_STRING];
467 } NETXMS_SUBAGENT_PUSHPARAM;
468
469 /**
470 * Subagent's list information
471 */
472 typedef struct
473 {
474 TCHAR name[MAX_PARAM_NAME];
475 LONG (* handler)(const TCHAR *, const TCHAR *, StringList *, AbstractCommSession *);
476 const TCHAR *arg;
477 TCHAR description[MAX_DB_STRING];
478 } NETXMS_SUBAGENT_LIST;
479
480 /**
481 * Subagent's table column information
482 */
483 typedef struct
484 {
485 TCHAR name[MAX_COLUMN_NAME];
486 TCHAR displayName[MAX_COLUMN_NAME];
487 int dataType;
488 bool isInstance;
489 } NETXMS_SUBAGENT_TABLE_COLUMN;
490
491 /**
492 * Subagent's table information
493 */
494 typedef struct
495 {
496 TCHAR name[MAX_PARAM_NAME];
497 LONG (* handler)(const TCHAR *, const TCHAR *, Table *, AbstractCommSession *);
498 const TCHAR *arg;
499 TCHAR instanceColumns[MAX_COLUMN_NAME * MAX_INSTANCE_COLUMNS];
500 TCHAR description[MAX_DB_STRING];
501 int numColumns;
502 NETXMS_SUBAGENT_TABLE_COLUMN *columns;
503 } NETXMS_SUBAGENT_TABLE;
504
505 /**
506 * Subagent's action information
507 */
508 typedef struct
509 {
510 TCHAR name[MAX_PARAM_NAME];
511 LONG (* handler)(const TCHAR *, StringList *, const TCHAR *, AbstractCommSession *);
512 const TCHAR *arg;
513 TCHAR description[MAX_DB_STRING];
514 } NETXMS_SUBAGENT_ACTION;
515
516 #define NETXMS_SUBAGENT_INFO_MAGIC ((UINT32)0x20150626)
517
518 class NXCPMessage;
519
520 /**
521 * Subagent initialization structure
522 */
523 typedef struct
524 {
525 UINT32 magic; // Magic number to check if subagent uses correct version of this structure
526 TCHAR name[MAX_SUBAGENT_NAME];
527 TCHAR version[32];
528 BOOL (* init)(Config *); // Called to initialize subagent. Can be NULL.
529 void (* shutdown)(); // Called at subagent unload. Can be NULL.
530 BOOL (* commandHandler)(UINT32 command, NXCPMessage *request, NXCPMessage *response, AbstractCommSession *session);
531 UINT32 numParameters;
532 NETXMS_SUBAGENT_PARAM *parameters;
533 UINT32 numLists;
534 NETXMS_SUBAGENT_LIST *lists;
535 UINT32 numTables;
536 NETXMS_SUBAGENT_TABLE *tables;
537 UINT32 numActions;
538 NETXMS_SUBAGENT_ACTION *actions;
539 UINT32 numPushParameters;
540 NETXMS_SUBAGENT_PUSHPARAM *pushParameters;
541 } NETXMS_SUBAGENT_INFO;
542
543 /**
544 * Inline functions for returning parameters
545 */
546 inline void ret_string(TCHAR *rbuf, const TCHAR *value)
547 {
548 nx_strncpy(rbuf, value, MAX_RESULT_LENGTH);
549 }
550
551 inline void ret_wstring(TCHAR *rbuf, const WCHAR *value)
552 {
553 #ifdef UNICODE
554 nx_strncpy(rbuf, value, MAX_RESULT_LENGTH);
555 #else
556 WideCharToMultiByte(CP_ACP, WC_COMPOSITECHECK | WC_DEFAULTCHAR, value, -1, rbuf, MAX_RESULT_LENGTH, NULL, NULL);
557 rbuf[MAX_RESULT_LENGTH - 1] = 0;
558 #endif
559 }
560
561 inline void ret_mbstring(TCHAR *rbuf, const char *value)
562 {
563 #ifdef UNICODE
564 MultiByteToWideChar(CP_ACP, MB_PRECOMPOSED, value, -1, rbuf, MAX_RESULT_LENGTH);
565 rbuf[MAX_RESULT_LENGTH - 1] = 0;
566 #else
567 nx_strncpy(rbuf, value, MAX_RESULT_LENGTH);
568 #endif
569 }
570
571 inline void ret_int(TCHAR *rbuf, LONG value)
572 {
573 #if defined(_WIN32) && (_MSC_VER >= 1300)
574 _sntprintf_s(rbuf, MAX_RESULT_LENGTH, _TRUNCATE, _T("%ld"), (long)value);
575 #else
576 _sntprintf(rbuf, MAX_RESULT_LENGTH, _T("%ld"), (long)value);
577 #endif
578 }
579
580 inline void ret_uint(TCHAR *rbuf, UINT32 value)
581 {
582 #if defined(_WIN32) && (_MSC_VER >= 1300)
583 _sntprintf_s(rbuf, MAX_RESULT_LENGTH, _TRUNCATE, _T("%lu"), (unsigned long)value);
584 #else
585 _sntprintf(rbuf, MAX_RESULT_LENGTH, _T("%lu"), (unsigned long)value);
586 #endif
587 }
588
589 inline void ret_double(TCHAR *rbuf, double value)
590 {
591 #if defined(_WIN32) && (_MSC_VER >= 1300)
592 _sntprintf_s(rbuf, MAX_RESULT_LENGTH, _TRUNCATE, _T("%f"), value);
593 #else
594 _sntprintf(rbuf, MAX_RESULT_LENGTH, _T("%f"), value);
595 #endif
596 }
597
598 inline void ret_int64(TCHAR *rbuf, INT64 value)
599 {
600 #if defined(_WIN32) && (_MSC_VER >= 1300)
601 _sntprintf_s(rbuf, MAX_RESULT_LENGTH, _TRUNCATE, _T("%I64d"), value);
602 #else /* _WIN32 */
603 _sntprintf(rbuf, MAX_RESULT_LENGTH, INT64_FMT, value);
604 #endif /* _WIN32 */
605 }
606
607 inline void ret_uint64(TCHAR *rbuf, QWORD value)
608 {
609 #if defined(_WIN32) && (_MSC_VER >= 1300)
610 _sntprintf_s(rbuf, MAX_RESULT_LENGTH, _TRUNCATE, _T("%I64u"), value);
611 #else /* _WIN32 */
612 _sntprintf(rbuf, MAX_RESULT_LENGTH, UINT64_FMT, value);
613 #endif /* _WIN32 */
614 }
615
616 /**
617 * API for subagents
618 */
619 bool LIBNXAGENT_EXPORTABLE AgentGetParameterArgA(const TCHAR *param, int index, char *arg, int maxSize, bool inBrackets = true);
620 bool LIBNXAGENT_EXPORTABLE AgentGetParameterArgW(const TCHAR *param, int index, WCHAR *arg, int maxSize, bool inBrackets = true);
621 #ifdef UNICODE
622 #define AgentGetParameterArg AgentGetParameterArgW
623 #else
624 #define AgentGetParameterArg AgentGetParameterArgA
625 #endif
626
627 void LIBNXAGENT_EXPORTABLE AgentWriteLog(int logLevel, const TCHAR *format, ...)
628 #if !defined(UNICODE) && (defined(__GNUC__) || defined(__clang__))
629 __attribute__ ((format(printf, 2, 3)))
630 #endif
631 ;
632 void LIBNXAGENT_EXPORTABLE AgentWriteLog2(int logLevel, const TCHAR *format, va_list args);
633 void LIBNXAGENT_EXPORTABLE AgentWriteDebugLog(int level, const TCHAR *format, ...)
634 #if !defined(UNICODE) && (defined(__GNUC__) || defined(__clang__))
635 __attribute__ ((format(printf, 2, 3)))
636 #endif
637 ;
638 void LIBNXAGENT_EXPORTABLE AgentWriteDebugLog2(int level, const TCHAR *format, va_list args);
639
640 void LIBNXAGENT_EXPORTABLE AgentSendTrap(UINT32 dwEvent, const TCHAR *eventName, const char *pszFormat, ...);
641 void LIBNXAGENT_EXPORTABLE AgentSendTrap2(UINT32 dwEvent, const TCHAR *eventName, int nCount, TCHAR **ppszArgList);
642
643 bool LIBNXAGENT_EXPORTABLE AgentEnumerateSessions(EnumerationCallbackResult (* callback)(AbstractCommSession *, void *), void *data);
644 AbstractCommSession LIBNXAGENT_EXPORTABLE *AgentFindServerSession(UINT64 serverId);
645
646 bool LIBNXAGENT_EXPORTABLE AgentSendFileToServer(void *session, UINT32 requestId, const TCHAR *file, long offset);
647
648 bool LIBNXAGENT_EXPORTABLE AgentPushParameterData(const TCHAR *parameter, const TCHAR *value);
649 bool LIBNXAGENT_EXPORTABLE AgentPushParameterDataInt32(const TCHAR *parameter, LONG value);
650 bool LIBNXAGENT_EXPORTABLE AgentPushParameterDataUInt32(const TCHAR *parameter, UINT32 value);
651 bool LIBNXAGENT_EXPORTABLE AgentPushParameterDataInt64(const TCHAR *parameter, INT64 value);
652 bool LIBNXAGENT_EXPORTABLE AgentPushParameterDataUInt64(const TCHAR *parameter, QWORD value);
653 bool LIBNXAGENT_EXPORTABLE AgentPushParameterDataDouble(const TCHAR *parameter, double value);
654
655 CONDITION LIBNXAGENT_EXPORTABLE AgentGetShutdownCondition();
656 bool LIBNXAGENT_EXPORTABLE AgentSleepAndCheckForShutdown(UINT32 sleepTime);
657 const TCHAR LIBNXAGENT_EXPORTABLE *AgentGetDataDirectory();
658
659 DB_HANDLE LIBNXAGENT_EXPORTABLE AgentGetLocalDatabaseHandle();
660
661 TCHAR LIBNXAGENT_EXPORTABLE *ReadRegistryAsString(const TCHAR *attr, TCHAR *buffer = NULL, int bufSize = 0, const TCHAR *defaultValue = NULL);
662 INT32 LIBNXAGENT_EXPORTABLE ReadRegistryAsInt32(const TCHAR *attr, INT32 defaultValue);
663 INT64 LIBNXAGENT_EXPORTABLE ReadRegistryAsInt64(const TCHAR *attr, INT64 defaultValue);
664 bool LIBNXAGENT_EXPORTABLE WriteRegistry(const TCHAR *attr, const TCHAR *value);
665 bool LIBNXAGENT_EXPORTABLE WriteRegistry(const TCHAR *attr, INT32 value);
666 bool LIBNXAGENT_EXPORTABLE WriteRegistry(const TCHAR *attr, INT64 value);
667 bool LIBNXAGENT_EXPORTABLE DeleteRegistryEntry(const TCHAR *attr);
668
669 #endif /* _nms_agent_h_ */