cosmetic changes
[public/netxms.git] / include / nms_agent.h
CommitLineData
cc022855 1/*
7ac71e60 2** NetXMS - Network Management System
d02f6b92 3** Copyright (C) 2003-2013 Victor Kirhenshtein
cbcaf8c8
VK
4**
5** This program is free software; you can redistribute it and/or modify
68f384ea
VK
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
cbcaf8c8
VK
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**
68f384ea 15** You should have received a copy of the GNU Lesser General Public License
cbcaf8c8
VK
16** along with this program; if not, write to the Free Software
17** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18**
456d5d1c 19** File: nms_agent.h
cbcaf8c8
VK
20**
21**/
22
23#ifndef _nms_agent_h_
24#define _nms_agent_h_
25
adc00755 26#include <nms_common.h>
64584976 27#include <nms_util.h>
e6c91aac 28#include <nxconfig.h>
6827d635 29
acc04d96
VK
30/**
31 * Initialization function declaration macro
32 */
a0a945fb 33#if defined(_STATIC_AGENT) || defined(_NETWARE)
e6c91aac 34#define DECLARE_SUBAGENT_ENTRY_POINT(name) extern "C" BOOL NxSubAgentRegister_##name(NETXMS_SUBAGENT_INFO **ppInfo, Config *config)
a0a945fb 35#else
b5138dfb 36#ifdef _WIN32
a0a945fb 37#define DECLSPEC_EXPORT __declspec(dllexport) __cdecl
b5138dfb
VK
38#else
39#define DECLSPEC_EXPORT
40#endif
e6c91aac 41#define DECLARE_SUBAGENT_ENTRY_POINT(name) extern "C" BOOL DECLSPEC_EXPORT NxSubAgentRegister(NETXMS_SUBAGENT_INFO **ppInfo, Config *config)
b5138dfb
VK
42#endif
43
86c126f5
VK
44/**
45 * Constants
46 */
cbcaf8c8 47#define AGENT_LISTEN_PORT 4700
deaa4491 48#define AGENT_PROTOCOL_VERSION 2
cbcaf8c8 49#define MAX_RESULT_LENGTH 256
e22f1644
VK
50#define MAX_CMD_LEN 256
51#define COMMAND_TIMEOUT 60
47e0446b 52#define MAX_SUBAGENT_NAME 64
86c126f5 53#define MAX_INSTANCE_COLUMNS 8
cbcaf8c8 54
d02f6b92
VK
55/**
56 * Agent policy types
57 */
6ca3b41c 58#define AGENT_POLICY_CONFIG 1
f47c176c 59#define AGENT_POLICY_LOG_PARSER 2
6ca3b41c 60
d02f6b92
VK
61/**
62 * Error codes
63 */
967893bb
VK
64#define ERR_SUCCESS ((UINT32)0)
65#define ERR_UNKNOWN_COMMAND ((UINT32)400)
66#define ERR_AUTH_REQUIRED ((UINT32)401)
67#define ERR_ACCESS_DENIED ((UINT32)403)
68#define ERR_UNKNOWN_PARAMETER ((UINT32)404)
69#define ERR_REQUEST_TIMEOUT ((UINT32)408)
70#define ERR_AUTH_FAILED ((UINT32)440)
71#define ERR_ALREADY_AUTHENTICATED ((UINT32)441)
72#define ERR_AUTH_NOT_REQUIRED ((UINT32)442)
73#define ERR_INTERNAL_ERROR ((UINT32)500)
74#define ERR_NOT_IMPLEMENTED ((UINT32)501)
75#define ERR_OUT_OF_RESOURCES ((UINT32)503)
76#define ERR_NOT_CONNECTED ((UINT32)900)
77#define ERR_CONNECTION_BROKEN ((UINT32)901)
78#define ERR_BAD_RESPONSE ((UINT32)902)
79#define ERR_IO_FAILURE ((UINT32)903)
80#define ERR_RESOURCE_BUSY ((UINT32)904)
81#define ERR_EXEC_FAILED ((UINT32)905)
82#define ERR_ENCRYPTION_REQUIRED ((UINT32)906)
83#define ERR_NO_CIPHERS ((UINT32)907)
84#define ERR_INVALID_PUBLIC_KEY ((UINT32)908)
85#define ERR_INVALID_SESSION_KEY ((UINT32)909)
86#define ERR_CONNECT_FAILED ((UINT32)910)
87#define ERR_MALFORMED_COMMAND ((UINT32)911)
88#define ERR_SOCKET_ERROR ((UINT32)912)
89#define ERR_BAD_ARGUMENTS ((UINT32)913)
90#define ERR_SUBAGENT_LOAD_FAILED ((UINT32)914)
91#define ERR_FILE_OPEN_ERROR ((UINT32)915)
92#define ERR_FILE_STAT_FAILED ((UINT32)916)
93#define ERR_MEM_ALLOC_FAILED ((UINT32)917)
94#define ERR_FILE_DELETE_FAILED ((UINT32)918)
9c786c0f 95#define ERR_NO_SESSION_AGENT ((UINT32)919)
cbcaf8c8 96
d02f6b92
VK
97/**
98 * Parameter handler return codes
99 */
cbcaf8c8
VK
100#define SYSINFO_RC_SUCCESS 0
101#define SYSINFO_RC_UNSUPPORTED 1
102#define SYSINFO_RC_ERROR 2
103
d02f6b92
VK
104/**
105 * WinPerf features
106 */
967893bb
VK
107#define WINPERF_AUTOMATIC_SAMPLE_COUNT ((UINT32)0x00000001)
108#define WINPERF_REMOTE_COUNTER_CONFIG ((UINT32)0x00000002)
cbcaf8c8 109
74540dab
VK
110/**
111 * User session states (used by session agents)
112 */
113#define USER_SESSION_ACTIVE 0
114#define USER_SESSION_CONNECTED 1
115#define USER_SESSION_DISCONNECTED 2
116#define USER_SESSION_IDLE 3
117#define USER_SESSION_OTHER 4
118
d02f6b92
VK
119/**
120 * Descriptions for common parameters
121 */
bf3b7f79
VK
122#define DCIDESC_FS_AVAIL _T("Available space on file system {instance}")
123#define DCIDESC_FS_AVAILPERC _T("Percentage of available space on file system {instance}")
124#define DCIDESC_FS_FREE _T("Free space on file system {instance}")
125#define DCIDESC_FS_FREEPERC _T("Percentage of free space on file system {instance}")
126#define DCIDESC_FS_TOTAL _T("Total space on file system {instance}")
4a675f94 127#define DCIDESC_FS_TYPE _T("Type of file system {instance}")
bf3b7f79
VK
128#define DCIDESC_FS_USED _T("Used space on file system {instance}")
129#define DCIDESC_FS_USEDPERC _T("Percentage of used space on file system {instance}")
11b75b2e 130#define DCIDESC_NET_INTERFACE_64BITCOUNTERS _T("Is 64bit interface counters supported")
bf3b7f79
VK
131#define DCIDESC_NET_INTERFACE_ADMINSTATUS _T("Administrative status of interface {instance}")
132#define DCIDESC_NET_INTERFACE_BYTESIN _T("Number of input bytes on interface {instance}")
133#define DCIDESC_NET_INTERFACE_BYTESOUT _T("Number of output bytes on interface {instance}")
134#define DCIDESC_NET_INTERFACE_DESCRIPTION _T("Description of interface {instance}")
135#define DCIDESC_NET_INTERFACE_INERRORS _T("Number of input errors on interface {instance}")
136#define DCIDESC_NET_INTERFACE_LINK _T("Link status for interface {instance}")
137#define DCIDESC_NET_INTERFACE_MTU _T("MTU for interface {instance}")
138#define DCIDESC_NET_INTERFACE_OPERSTATUS _T("Operational status of interface {instance}")
139#define DCIDESC_NET_INTERFACE_OUTERRORS _T("Number of output errors on interface {instance}")
140#define DCIDESC_NET_INTERFACE_PACKETSIN _T("Number of input packets on interface {instance}")
141#define DCIDESC_NET_INTERFACE_PACKETSOUT _T("Number of output packets on interface {instance}")
142#define DCIDESC_NET_INTERFACE_SPEED _T("Speed of interface {instance}")
143#define DCIDESC_NET_IP_FORWARDING _T("IP forwarding status")
144#define DCIDESC_NET_IP6_FORWARDING _T("IPv6 forwarding status")
ecdf8898
VK
145#define DCIDESC_NET_RESOLVER_ADDRBYNAME _T("Resolver: address for name {instance}")
146#define DCIDESC_NET_RESOLVER_NAMEBYADDR _T("Resolver: name for address {instance}")
bf3b7f79
VK
147#define DCIDESC_PHYSICALDISK_FIRMWARE _T("Firmware version of hard disk {instance}")
148#define DCIDESC_PHYSICALDISK_MODEL _T("Model of hard disk {instance}")
149#define DCIDESC_PHYSICALDISK_SERIALNUMBER _T("Serial number of hard disk {instance}")
150#define DCIDESC_PHYSICALDISK_SMARTATTR _T("")
151#define DCIDESC_PHYSICALDISK_SMARTSTATUS _T("Status of hard disk {instance} reported by SMART")
152#define DCIDESC_PHYSICALDISK_TEMPERATURE _T("Temperature of hard disk {instance}")
153#define DCIDESC_SYSTEM_CPU_COUNT _T("Number of CPU in the system")
154#define DCIDESC_SYSTEM_HOSTNAME _T("Host name")
155#define DCIDESC_SYSTEM_MEMORY_PHYSICAL_FREE _T("Free physical memory")
156#define DCIDESC_SYSTEM_MEMORY_PHYSICAL_FREE_PCT _T("Percentage of free physical memory")
157#define DCIDESC_SYSTEM_MEMORY_PHYSICAL_TOTAL _T("Total amount of physical memory")
158#define DCIDESC_SYSTEM_MEMORY_PHYSICAL_USED _T("Used physical memory")
159#define DCIDESC_SYSTEM_MEMORY_PHYSICAL_USED_PCT _T("Percentage of used physical memory")
160#define DCIDESC_SYSTEM_MEMORY_PHYSICAL_AVAILABLE _T("Available physical memory")
161#define DCIDESC_SYSTEM_MEMORY_PHYSICAL_AVAILABLE_PCT _T("Percentage of available physical memory")
03a48429
VK
162#define DCIDESC_SYSTEM_MEMORY_VIRTUAL_ACTIVE _T("Active virtual memory")
163#define DCIDESC_SYSTEM_MEMORY_VIRTUAL_ACTIVE_PCT _T("Percentage of active virtual memory")
bf3b7f79
VK
164#define DCIDESC_SYSTEM_MEMORY_VIRTUAL_FREE _T("Free virtual memory")
165#define DCIDESC_SYSTEM_MEMORY_VIRTUAL_FREE_PCT _T("Percentage of free virtual memory")
166#define DCIDESC_SYSTEM_MEMORY_VIRTUAL_TOTAL _T("Total amount of virtual memory")
167#define DCIDESC_SYSTEM_MEMORY_VIRTUAL_USED _T("Used virtual memory")
168#define DCIDESC_SYSTEM_MEMORY_VIRTUAL_USED_PCT _T("Percentage of used virtual memory")
169#define DCIDESC_SYSTEM_MEMORY_VIRTUAL_AVAILABLE _T("Available virtual memory")
170#define DCIDESC_SYSTEM_MEMORY_VIRTUAL_AVAILABLE_PCT _T("Percentage of available virtual memory")
171#define DCIDESC_SYSTEM_MEMORY_SWAP_FREE _T("Free swap space")
172#define DCIDESC_SYSTEM_MEMORY_SWAP_FREE_PCT _T("Percentage of free swap space")
173#define DCIDESC_SYSTEM_MEMORY_SWAP_TOTAL _T("Total amount of swap space")
174#define DCIDESC_SYSTEM_MEMORY_SWAP_USED _T("Used swap space")
175#define DCIDESC_SYSTEM_MEMORY_SWAP_USED_PCT _T("Percentage of used swap space")
176#define DCIDESC_SYSTEM_UNAME _T("System uname")
177#define DCIDESC_AGENT_ACCEPTEDCONNECTIONS _T("Number of connections accepted by agent")
178#define DCIDESC_AGENT_ACCEPTERRORS _T("Number of accept() call errors")
179#define DCIDESC_AGENT_ACTIVECONNECTIONS _T("Number of active connections to agent")
180#define DCIDESC_AGENT_AUTHENTICATIONFAILURES _T("Number of authentication failures")
181#define DCIDESC_AGENT_CONFIG_SERVER _T("Configuration server address set on agent startup")
182#define DCIDESC_AGENT_FAILEDREQUESTS _T("Number of failed requests to agent")
183#define DCIDESC_AGENT_GENERATED_TRAPS _T("Number of traps generated by agent")
05db3127 184#define DCIDESC_AGENT_IS_SUBAGENT_LOADED _T("Check if given subagent is loaded")
bf3b7f79
VK
185#define DCIDESC_AGENT_LAST_TRAP_TIME _T("Timestamp of last generated trap")
186#define DCIDESC_AGENT_PROCESSEDREQUESTS _T("Number of requests processed by agent")
187#define DCIDESC_AGENT_REGISTRAR _T("Registrar server address set on agent startup")
188#define DCIDESC_AGENT_REJECTEDCONNECTIONS _T("Number of connections rejected by agent")
189#define DCIDESC_AGENT_SENT_TRAPS _T("Number of traps successfully sent to server")
05db3127 190#define DCIDESC_AGENT_SOURCEPACKAGESUPPORT _T("Check if source packages are supported")
bf3b7f79
VK
191#define DCIDESC_AGENT_SUPPORTEDCIPHERS _T("List of ciphers supported by agent")
192#define DCIDESC_AGENT_TIMEDOUTREQUESTS _T("Number of timed out requests to agent")
193#define DCIDESC_AGENT_UNSUPPORTEDREQUESTS _T("Number of requests for unsupported parameters")
194#define DCIDESC_AGENT_UPTIME _T("Agent's uptime")
195#define DCIDESC_AGENT_VERSION _T("Agent's version")
196#define DCIDESC_FILE_COUNT _T("Number of files {instance}")
197#define DCIDESC_FILE_HASH_CRC32 _T("CRC32 checksum of {instance}")
198#define DCIDESC_FILE_HASH_MD5 _T("MD5 hash of {instance}")
199#define DCIDESC_FILE_HASH_SHA1 _T("SHA1 hash of {instance}")
200#define DCIDESC_FILE_SIZE _T("Size of file {instance}")
201#define DCIDESC_FILE_TIME_ACCESS _T("Time of last access to file {instance}")
202#define DCIDESC_FILE_TIME_CHANGE _T("Time of last status change of file {instance}")
203#define DCIDESC_FILE_TIME_MODIFY _T("Time of last modification of file {instance}")
8ce7501b 204#define DCIDESC_SYSTEM_CURRENTTIME _T("Current system time")
bf3b7f79
VK
205#define DCIDESC_SYSTEM_PLATFORMNAME _T("Platform name")
206#define DCIDESC_PROCESS_COUNT _T("Number of {instance} processes")
207#define DCIDESC_PROCESS_COUNTEX _T("Number of {instance} processes (extended)")
545c3996 208#define DCIDESC_PROCESS_ZOMBIE_COUNT _T("Number of {instance} zombie processes")
bf3b7f79
VK
209#define DCIDESC_PROCESS_CPUTIME _T("Total execution time for process {instance}")
210#define DCIDESC_PROCESS_GDIOBJ _T("GDI objects used by process {instance}")
211#define DCIDESC_PROCESS_IO_OTHERB _T("")
212#define DCIDESC_PROCESS_IO_OTHEROP _T("")
213#define DCIDESC_PROCESS_IO_READB _T("")
214#define DCIDESC_PROCESS_IO_READOP _T("")
215#define DCIDESC_PROCESS_IO_WRITEB _T("")
216#define DCIDESC_PROCESS_IO_WRITEOP _T("")
217#define DCIDESC_PROCESS_KERNELTIME _T("Total execution time in kernel mode for process {instance}")
218#define DCIDESC_PROCESS_PAGEFAULTS _T("Page faults for process {instance}")
219#define DCIDESC_PROCESS_SYSCALLS _T("Number of system calls made by process {instance}")
220#define DCIDESC_PROCESS_THREADS _T("Number of threads in process {instance}")
221#define DCIDESC_PROCESS_USEROBJ _T("USER objects used by process {instance}")
222#define DCIDESC_PROCESS_USERTIME _T("Total execution time in user mode for process {instance}")
223#define DCIDESC_PROCESS_VMSIZE _T("Virtual memory used by process {instance}")
224#define DCIDESC_PROCESS_WKSET _T("Physical memory used by process {instance}")
225#define DCIDESC_SYSTEM_APPADDRESSSPACE _T("Address space available to applications (MB)")
226#define DCIDESC_SYSTEM_CONNECTEDUSERS _T("Number of logged in users")
227#define DCIDESC_SYSTEM_PROCESSCOUNT _T("Total number of processes")
228#define DCIDESC_SYSTEM_SERVICESTATE _T("State of {instance} service")
229#define DCIDESC_SYSTEM_PROCESSCOUNT _T("Total number of processes")
230#define DCIDESC_SYSTEM_THREADCOUNT _T("Total number of threads")
231#define DCIDESC_PDH_COUNTERVALUE _T("Value of PDH counter {instance}")
232#define DCIDESC_PDH_VERSION _T("Version of PDH.DLL")
233#define DCIDESC_SYSTEM_UPTIME _T("System uptime")
234#define DCIDESC_SYSTEM_CPU_LOADAVG _T("Average CPU load for last minute")
235#define DCIDESC_SYSTEM_CPU_LOADAVG5 _T("Average CPU load for last 5 minutes")
236#define DCIDESC_SYSTEM_CPU_LOADAVG15 _T("Average CPU load for last 15 minutes")
237
238
239#define DCIDESC_SYSTEM_CPU_USAGE_EX _T("Average CPU {instance} utilization for last minute")
240#define DCIDESC_SYSTEM_CPU_USAGE5_EX _T("Average CPU {instance} utilization for last 5 minutes")
241#define DCIDESC_SYSTEM_CPU_USAGE15_EX _T("Average CPU {instance} utilization for last 15 minutes")
242#define DCIDESC_SYSTEM_CPU_USAGE _T("Average CPU utilization for last minute")
243#define DCIDESC_SYSTEM_CPU_USAGE5 _T("Average CPU utilization for last 5 minutes")
244#define DCIDESC_SYSTEM_CPU_USAGE15 _T("Average CPU utilization for last 15 minutes")
245
246#define DCIDESC_SYSTEM_CPU_USAGE_USER_EX _T("Average CPU {instance} utilization (user) for last minute")
247#define DCIDESC_SYSTEM_CPU_USAGE5_USER_EX _T("Average CPU {instance} utilization (user) for last 5 minutes")
248#define DCIDESC_SYSTEM_CPU_USAGE15_USER_EX _T("Average CPU {instance} utilization (user) for last 15 minutes")
249#define DCIDESC_SYSTEM_CPU_USAGE_USER _T("Average CPU utilization (user) for last minute")
250#define DCIDESC_SYSTEM_CPU_USAGE5_USER _T("Average CPU utilization (user) for last 5 minutes")
251#define DCIDESC_SYSTEM_CPU_USAGE15_USER _T("Average CPU utilization (user) for last 15 minutes")
252
253#define DCIDESC_SYSTEM_CPU_USAGE_NICE_EX _T("Average CPU {instance} utilization (nice) for last minute")
254#define DCIDESC_SYSTEM_CPU_USAGE5_NICE_EX _T("Average CPU {instance} utilization (nice) for last 5 minutes")
255#define DCIDESC_SYSTEM_CPU_USAGE15_NICE_EX _T("Average CPU {instance} utilization (nice) for last 15 minutes")
256#define DCIDESC_SYSTEM_CPU_USAGE_NICE _T("Average CPU utilization (nice) for last minute")
257#define DCIDESC_SYSTEM_CPU_USAGE5_NICE _T("Average CPU utilization (nice) for last 5 minutes")
258#define DCIDESC_SYSTEM_CPU_USAGE15_NICE _T("Average CPU utilization (nice) for last 15 minutes")
259
260#define DCIDESC_SYSTEM_CPU_USAGE_SYSTEM_EX _T("Average CPU {instance} utilization (system) for last minute")
261#define DCIDESC_SYSTEM_CPU_USAGE5_SYSTEM_EX _T("Average CPU {instance} utilization (system) for last 5 minutes")
262#define DCIDESC_SYSTEM_CPU_USAGE15_SYSTEM_EX _T("Average CPU {instance} utilization (system) for last 15 minutes")
263#define DCIDESC_SYSTEM_CPU_USAGE_SYSTEM _T("Average CPU utilization (system) for last minute")
264#define DCIDESC_SYSTEM_CPU_USAGE5_SYSTEM _T("Average CPU utilization (system) for last 5 minutes")
265#define DCIDESC_SYSTEM_CPU_USAGE15_SYSTEM _T("Average CPU utilization (system) for last 15 minutes")
266
267#define DCIDESC_SYSTEM_CPU_USAGE_IDLE_EX _T("Average CPU {instance} utilization (idle) for last minute")
268#define DCIDESC_SYSTEM_CPU_USAGE5_IDLE_EX _T("Average CPU {instance} utilization (idle) for last 5 minutes")
269#define DCIDESC_SYSTEM_CPU_USAGE15_IDLE_EX _T("Average CPU {instance} utilization (idle) for last 15 minutes")
270#define DCIDESC_SYSTEM_CPU_USAGE_IDLE _T("Average CPU utilization (idle) for last minute")
271#define DCIDESC_SYSTEM_CPU_USAGE5_IDLE _T("Average CPU utilization (idle) for last 5 minutes")
272#define DCIDESC_SYSTEM_CPU_USAGE15_IDLE _T("Average CPU utilization (idle) for last 15 minutes")
273
274#define DCIDESC_SYSTEM_CPU_USAGE_IOWAIT_EX _T("Average CPU {instance} utilization (iowait) for last minute")
275#define DCIDESC_SYSTEM_CPU_USAGE5_IOWAIT_EX _T("Average CPU {instance} utilization (iowait) for last 5 minutes")
276#define DCIDESC_SYSTEM_CPU_USAGE15_IOWAIT_EX _T("Average CPU {instance} utilization (iowait) for last 15 minutes")
277#define DCIDESC_SYSTEM_CPU_USAGE_IOWAIT _T("Average CPU utilization (iowait) for last minute")
278#define DCIDESC_SYSTEM_CPU_USAGE5_IOWAIT _T("Average CPU utilization (iowait) for last 5 minutes")
279#define DCIDESC_SYSTEM_CPU_USAGE15_IOWAIT _T("Average CPU utilization (iowait) for last 15 minutes")
280
281#define DCIDESC_SYSTEM_CPU_USAGE_IRQ_EX _T("Average CPU {instance} utilization (irq) for last minute")
282#define DCIDESC_SYSTEM_CPU_USAGE5_IRQ_EX _T("Average CPU {instance} utilization (irq) for last 5 minutes")
283#define DCIDESC_SYSTEM_CPU_USAGE15_IRQ_EX _T("Average CPU {instance} utilization (irq) for last 15 minutes")
284#define DCIDESC_SYSTEM_CPU_USAGE_IRQ _T("Average CPU utilization (irq) for last minute")
285#define DCIDESC_SYSTEM_CPU_USAGE5_IRQ _T("Average CPU utilization (irq) for last 5 minutes")
286#define DCIDESC_SYSTEM_CPU_USAGE15_IRQ _T("Average CPU utilization (irq) for last 15 minutes")
287
288#define DCIDESC_SYSTEM_CPU_USAGE_SOFTIRQ_EX _T("Average CPU {instance} utilization (softirq) for last minute")
289#define DCIDESC_SYSTEM_CPU_USAGE5_SOFTIRQ_EX _T("Average CPU {instance} utilization (softirq) for last 5 minutes")
290#define DCIDESC_SYSTEM_CPU_USAGE15_SOFTIRQ_EX _T("Average CPU {instance} utilization (softirq) for last 15 minutes")
291#define DCIDESC_SYSTEM_CPU_USAGE_SOFTIRQ _T("Average CPU utilization (softirq) for last minute")
292#define DCIDESC_SYSTEM_CPU_USAGE5_SOFTIRQ _T("Average CPU utilization (softirq) for last 5 minutes")
293#define DCIDESC_SYSTEM_CPU_USAGE15_SOFTIRQ _T("Average CPU utilization (softirq) for last 15 minutes")
294
295#define DCIDESC_SYSTEM_CPU_USAGE_STEAL_EX _T("Average CPU {instance} utilization (steal) for last minute")
296#define DCIDESC_SYSTEM_CPU_USAGE5_STEAL_EX _T("Average CPU {instance} utilization (steal) for last 5 minutes")
297#define DCIDESC_SYSTEM_CPU_USAGE15_STEAL_EX _T("Average CPU {instance} utilization (steal) for last 15 minutes")
298#define DCIDESC_SYSTEM_CPU_USAGE_STEAL _T("Average CPU utilization (steal) for last minute")
299#define DCIDESC_SYSTEM_CPU_USAGE5_STEAL _T("Average CPU utilization (steal) for last 5 minutes")
300#define DCIDESC_SYSTEM_CPU_USAGE15_STEAL _T("Average CPU utilization (steal) for last 15 minutes")
301
302#define DCIDESC_SYSTEM_CPU_USAGE_GUEST_EX _T("Average CPU {instance} utilization (guest) for last minute")
303#define DCIDESC_SYSTEM_CPU_USAGE5_GUEST_EX _T("Average CPU {instance} utilization (guest) for last 5 minutes")
304#define DCIDESC_SYSTEM_CPU_USAGE15_GUEST_EX _T("Average CPU {instance} utilization (guest) for last 15 minutes")
305#define DCIDESC_SYSTEM_CPU_USAGE_GUEST _T("Average CPU utilization (guest) for last minute")
306#define DCIDESC_SYSTEM_CPU_USAGE5_GUEST _T("Average CPU utilization (guest) for last 5 minutes")
307#define DCIDESC_SYSTEM_CPU_USAGE15_GUEST _T("Average CPU utilization (guest) for last 15 minutes")
308
309#define DCIDESC_SYSTEM_IO_DISKQUEUE _T("Average disk queue length for last minute")
3e00a175
VK
310#define DCIDESC_SYSTEM_IO_DISKQUEUE_MIN _T("Minimum disk queue length for last minute")
311#define DCIDESC_SYSTEM_IO_DISKQUEUE_MAX _T("Maximum disk queue length for last minute")
bf3b7f79 312#define DCIDESC_SYSTEM_IO_DISKQUEUE_EX _T("Average disk queue length of device {instance} for last minute")
3e00a175
VK
313#define DCIDESC_SYSTEM_IO_DISKQUEUE_EX_MIN _T("Minimum disk queue length of device {instance} for last minute")
314#define DCIDESC_SYSTEM_IO_DISKQUEUE_EX_MAX _T("Maximum disk queue length of device {instance} for last minute")
bf3b7f79
VK
315#define DCIDESC_SYSTEM_IO_DISKTIME _T("Percent of CPU time spent on I/O for last minute")
316#define DCIDESC_SYSTEM_IO_DISKTIME_EX _T("Percent of CPU time spent on I/O on device {instance} for last minute")
317#define DCIDESC_SYSTEM_IO_WAITTIME _T("Average I/O request wait time")
318#define DCIDESC_SYSTEM_IO_WAITTIME_EX _T("Average I/O request wait time for device {instance}")
319#define DCIDESC_SYSTEM_IO_READS _T("Average number of read operations for last minute")
3e00a175
VK
320#define DCIDESC_SYSTEM_IO_READS_MIN _T("Minimum number of read operations for last minute")
321#define DCIDESC_SYSTEM_IO_READS_MAX _T("Maximum number of read operations for last minute")
bf3b7f79 322#define DCIDESC_SYSTEM_IO_READS_EX _T("Average number of read operations on device {instance} for last minute")
3e00a175
VK
323#define DCIDESC_SYSTEM_IO_READS_EX_MIN _T("Minimum number of read operations on device {instance} for last minute")
324#define DCIDESC_SYSTEM_IO_READS_EX_MAX _T("Maximum number of read operations on device {instance} for last minute")
bf3b7f79 325#define DCIDESC_SYSTEM_IO_WRITES _T("Average number of write operations for last minute")
3e00a175
VK
326#define DCIDESC_SYSTEM_IO_WRITES_MIN _T("Minimum number of write operations for last minute")
327#define DCIDESC_SYSTEM_IO_WRITES_MAX _T("Maximum number of write operations for last minute")
bf3b7f79 328#define DCIDESC_SYSTEM_IO_WRITES_EX _T("Average number of write operations on device {instance} for last minute")
3e00a175
VK
329#define DCIDESC_SYSTEM_IO_WRITES_EX_MIN _T("Minimum number of write operations on device {instance} for last minute")
330#define DCIDESC_SYSTEM_IO_WRITES_EX_MAX _T("Maximum number of write operations on device {instance} for last minute")
bf3b7f79 331#define DCIDESC_SYSTEM_IO_XFERS _T("Average number of I/O transfers for last minute")
3e00a175
VK
332#define DCIDESC_SYSTEM_IO_XFERS_MIN _T("Minimum number of I/O transfers for last minute")
333#define DCIDESC_SYSTEM_IO_XFERS_MAX _T("Maximum number of I/O transfers for last minute")
bf3b7f79 334#define DCIDESC_SYSTEM_IO_XFERS_EX _T("Average number of I/O transfers on device {instance} for last minute")
3e00a175
VK
335#define DCIDESC_SYSTEM_IO_XFERS_EX_MIN _T("Minimum number of I/O transfers on device {instance} for last minute")
336#define DCIDESC_SYSTEM_IO_XFERS_EX_MAX _T("Maximum number of I/O transfers on device {instance} for last minute")
bf3b7f79 337#define DCIDESC_SYSTEM_IO_BYTEREADS _T("Average number of bytes read for last minute")
3e00a175
VK
338#define DCIDESC_SYSTEM_IO_BYTEREADS_MIN _T("Minimum number of bytes read for last minute")
339#define DCIDESC_SYSTEM_IO_BYTEREADS_MAX _T("Maximum number of bytes read for last minute")
bf3b7f79 340#define DCIDESC_SYSTEM_IO_BYTEREADS_EX _T("Average number of bytes read on device {instance} for last minute")
3e00a175
VK
341#define DCIDESC_SYSTEM_IO_BYTEREADS_EX_MIN _T("Minimum number of bytes read on device {instance} for last minute")
342#define DCIDESC_SYSTEM_IO_BYTEREADS_EX_MAX _T("Maximum number of bytes read on device {instance} for last minute")
bf3b7f79 343#define DCIDESC_SYSTEM_IO_BYTEWRITES _T("Average number of bytes written for last minute")
3e00a175
VK
344#define DCIDESC_SYSTEM_IO_BYTEWRITES_MIN _T("Minimum number of bytes written for last minute")
345#define DCIDESC_SYSTEM_IO_BYTEWRITES_MAX _T("Maximum number of bytes written for last minute")
bf3b7f79 346#define DCIDESC_SYSTEM_IO_BYTEWRITES_EX _T("Average number of bytes written on device {instance} for last minute")
3e00a175
VK
347#define DCIDESC_SYSTEM_IO_BYTEWRITES_EX_MIN _T("Minimum number of bytes written on device {instance} for last minute")
348#define DCIDESC_SYSTEM_IO_BYTEWRITES_EX_MAX _T("Maximum number of bytes written on device {instance} for last minute")
bf3b7f79
VK
349#define DCIDESC_SYSTEM_IO_OPENFILES _T("Number of open files")
350
351
352#define DCIDESC_DEPRECATED _T("<deprecated>")
30c68fa1
AK
353
354
74540dab 355#define DCTDESC_AGENT_SESSION_AGENTS _T("Registered session agents")
ad12a86f 356#define DCTDESC_AGENT_SUBAGENTS _T("Loaded subagents")
a8799146 357#define DCTDESC_FILESYSTEM_VOLUMES _T("File system volumes")
ac60d715 358#define DCTDESC_SYSTEM_INSTALLED_PRODUCTS _T("Installed products")
ad12a86f 359#define DCTDESC_SYSTEM_PROCESSES _T("Processes")
cc8ce218 360
5944946e
VK
361/**
362 * API for CommSession
363 */
364class AbstractCommSession
365{
366public:
9319c166
VK
367 virtual bool isMasterServer() = 0;
368 virtual bool isControlServer() = 0;
8c75ad41 369 virtual const InetAddress& getServerAddress() = 0;
9319c166 370
ea3993c8
VK
371 virtual bool isIPv6Aware() = 0;
372
b368969c
VK
373 virtual void sendMessage(NXCPMessage *pMsg) = 0;
374 virtual void sendRawMessage(NXCP_MESSAGE *pMsg) = 0;
9319c166
VK
375 virtual bool sendFile(UINT32 requestId, const TCHAR *file, long offset) = 0;
376 virtual UINT32 openFile(TCHAR* nameOfFile, UINT32 requestId) = 0;
5944946e
VK
377};
378
0f506caa
VK
379/**
380 * Subagent's parameter information
381 */
6827d635
VK
382typedef struct
383{
4687826e 384 TCHAR name[MAX_PARAM_NAME];
060c5a11 385 LONG (* handler)(const TCHAR *, const TCHAR *, TCHAR *, AbstractCommSession *);
4687826e
VK
386 const TCHAR *arg;
387 int dataType; // Use DT_DEPRECATED to indicate deprecated parameter
388 TCHAR description[MAX_DB_STRING];
6827d635
VK
389} NETXMS_SUBAGENT_PARAM;
390
0f506caa
VK
391/**
392 * Subagent's push parameter information
393 */
f480bdd4
VK
394typedef struct
395{
396 TCHAR name[MAX_PARAM_NAME];
397 int dataType;
398 TCHAR description[MAX_DB_STRING];
399} NETXMS_SUBAGENT_PUSHPARAM;
400
0f506caa
VK
401/**
402 * Subagent's list information
403 */
901c96c7
VK
404typedef struct
405{
4687826e 406 TCHAR name[MAX_PARAM_NAME];
060c5a11 407 LONG (* handler)(const TCHAR *, const TCHAR *, StringList *, AbstractCommSession *);
4687826e
VK
408 const TCHAR *arg;
409} NETXMS_SUBAGENT_LIST;
410
0f506caa
VK
411/**
412 * Subagent's table information
413 */
4687826e
VK
414typedef struct
415{
416 TCHAR name[MAX_PARAM_NAME];
060c5a11 417 LONG (* handler)(const TCHAR *, const TCHAR *, Table *, AbstractCommSession *);
4687826e 418 const TCHAR *arg;
52f5ee00 419 TCHAR instanceColumns[MAX_COLUMN_NAME * MAX_INSTANCE_COLUMNS];
cc8ce218 420 TCHAR description[MAX_DB_STRING];
4687826e 421} NETXMS_SUBAGENT_TABLE;
901c96c7 422
0f506caa
VK
423/**
424 * Subagent's action information
425 */
37778a1d
VK
426typedef struct
427{
4687826e 428 TCHAR name[MAX_PARAM_NAME];
060c5a11 429 LONG (* handler)(const TCHAR *, StringList *, const TCHAR *, AbstractCommSession *);
4687826e
VK
430 const TCHAR *arg;
431 TCHAR description[MAX_DB_STRING];
37778a1d
VK
432} NETXMS_SUBAGENT_ACTION;
433
967893bb 434#define NETXMS_SUBAGENT_INFO_MAGIC ((UINT32)0x20110301)
ded831ac 435
b368969c 436class NXCPMessage;
d618c3ae 437
5944946e
VK
438/**
439 * Subagent initialization structure
440 */
6827d635
VK
441typedef struct
442{
967893bb 443 UINT32 magic; // Magic number to check if subagent uses correct version of this structure
4687826e
VK
444 TCHAR name[MAX_SUBAGENT_NAME];
445 TCHAR version[32];
446 BOOL (* init)(Config *); // Called to initialize subagent. Can be NULL.
447 void (* shutdown)(); // Called at subagent unload. Can be NULL.
b368969c 448 BOOL (* commandHandler)(UINT32 command, NXCPMessage *request, NXCPMessage *response, AbstractCommSession *session);
967893bb 449 UINT32 numParameters;
4687826e 450 NETXMS_SUBAGENT_PARAM *parameters;
967893bb 451 UINT32 numLists;
4687826e 452 NETXMS_SUBAGENT_LIST *lists;
967893bb 453 UINT32 numTables;
4687826e 454 NETXMS_SUBAGENT_TABLE *tables;
967893bb 455 UINT32 numActions;
4687826e 456 NETXMS_SUBAGENT_ACTION *actions;
967893bb 457 UINT32 numPushParameters;
4687826e 458 NETXMS_SUBAGENT_PUSHPARAM *pushParameters;
6827d635 459} NETXMS_SUBAGENT_INFO;
3b376ea0 460
0f506caa
VK
461/**
462 * Inline functions for returning parameters
463 */
a765d97c 464inline void ret_string(TCHAR *rbuf, const TCHAR *value)
cbcaf8c8 465{
a23d8e0d 466 nx_strncpy(rbuf, value, MAX_RESULT_LENGTH);
cbcaf8c8
VK
467}
468
f3387429
VK
469inline void ret_wstring(TCHAR *rbuf, const WCHAR *value)
470{
471#ifdef UNICODE
472 nx_strncpy(rbuf, value, MAX_RESULT_LENGTH);
473#else
474 WideCharToMultiByte(CP_ACP, WC_COMPOSITECHECK | WC_DEFAULTCHAR, value, -1, rbuf, MAX_RESULT_LENGTH, NULL, NULL);
475 rbuf[MAX_RESULT_LENGTH - 1] = 0;
476#endif
477}
478
479inline void ret_mbstring(TCHAR *rbuf, const char *value)
480{
481#ifdef UNICODE
482 MultiByteToWideChar(CP_ACP, MB_PRECOMPOSED, value, -1, rbuf, MAX_RESULT_LENGTH);
483 rbuf[MAX_RESULT_LENGTH - 1] = 0;
484#else
485 nx_strncpy(rbuf, value, MAX_RESULT_LENGTH);
486#endif
487}
488
0212dc5a 489inline void ret_int(TCHAR *rbuf, LONG value)
cbcaf8c8 490{
66d07089 491#if defined(_WIN32) && (_MSC_VER >= 1300)
6e38075b 492 _sntprintf_s(rbuf, MAX_RESULT_LENGTH, _TRUNCATE, _T("%ld"), (long)value);
a23d8e0d 493#else
6e38075b 494 _sntprintf(rbuf, MAX_RESULT_LENGTH, _T("%ld"), (long)value);
a23d8e0d 495#endif
cbcaf8c8
VK
496}
497
967893bb 498inline void ret_uint(TCHAR *rbuf, UINT32 value)
cbcaf8c8 499{
66d07089 500#if defined(_WIN32) && (_MSC_VER >= 1300)
6e38075b 501 _sntprintf_s(rbuf, MAX_RESULT_LENGTH, _TRUNCATE, _T("%lu"), (unsigned long)value);
a23d8e0d 502#else
6e38075b 503 _sntprintf(rbuf, MAX_RESULT_LENGTH, _T("%lu"), (unsigned long)value);
a23d8e0d 504#endif
cbcaf8c8
VK
505}
506
018fda4d 507inline void ret_double(TCHAR *rbuf, double value)
cbcaf8c8 508{
66d07089 509#if defined(_WIN32) && (_MSC_VER >= 1300)
a23d8e0d
VK
510 _sntprintf_s(rbuf, MAX_RESULT_LENGTH, _TRUNCATE, _T("%f"), value);
511#else
8b86c5dc 512 _sntprintf(rbuf, MAX_RESULT_LENGTH, _T("%f"), value);
a23d8e0d 513#endif
cbcaf8c8
VK
514}
515
018fda4d 516inline void ret_int64(TCHAR *rbuf, INT64 value)
cbcaf8c8 517{
66d07089 518#if defined(_WIN32) && (_MSC_VER >= 1300)
a23d8e0d 519 _sntprintf_s(rbuf, MAX_RESULT_LENGTH, _TRUNCATE, _T("%I64d"), value);
cbcaf8c8 520#else /* _WIN32 */
ccc34207 521 _sntprintf(rbuf, MAX_RESULT_LENGTH, INT64_FMT, value);
cbcaf8c8
VK
522#endif /* _WIN32 */
523}
524
018fda4d 525inline void ret_uint64(TCHAR *rbuf, QWORD value)
cbcaf8c8 526{
66d07089 527#if defined(_WIN32) && (_MSC_VER >= 1300)
a23d8e0d 528 _sntprintf_s(rbuf, MAX_RESULT_LENGTH, _TRUNCATE, _T("%I64u"), value);
cbcaf8c8 529#else /* _WIN32 */
ccc34207 530 _sntprintf(rbuf, MAX_RESULT_LENGTH, UINT64_FMT, value);
cbcaf8c8
VK
531#endif /* _WIN32 */
532}
533
6827d635 534//
6173bea8 535// API for subagents
6827d635 536//
f3387429
VK
537BOOL LIBNETXMS_EXPORTABLE AgentGetParameterArgA(const TCHAR *param, int index, char *arg, int maxSize);
538BOOL LIBNETXMS_EXPORTABLE AgentGetParameterArgW(const TCHAR *param, int index, WCHAR *arg, int maxSize);
539#ifdef UNICODE
540#define AgentGetParameterArg AgentGetParameterArgW
541#else
542#define AgentGetParameterArg AgentGetParameterArgA
543#endif
544
640b6719 545void LIBNETXMS_EXPORTABLE AgentWriteLog(int logLevel, const TCHAR *format, ...)
6e383343 546#if !defined(UNICODE) && (defined(__GNUC__) || defined(__clang__))
640b6719
VK
547 __attribute__ ((format(printf, 2, 3)))
548#endif
549;
c303351c 550void LIBNETXMS_EXPORTABLE AgentWriteLog2(int logLevel, const TCHAR *format, va_list args);
640b6719 551void LIBNETXMS_EXPORTABLE AgentWriteDebugLog(int level, const TCHAR *format, ...)
6e383343 552#if !defined(UNICODE) && (defined(__GNUC__) || defined(__clang__))
640b6719
VK
553 __attribute__ ((format(printf, 2, 3)))
554#endif
555;
c303351c 556void LIBNETXMS_EXPORTABLE AgentWriteDebugLog2(int level, const TCHAR *format, va_list args);
967893bb
VK
557void LIBNETXMS_EXPORTABLE AgentSendTrap(UINT32 dwEvent, const TCHAR *eventName, const char *pszFormat, ...);
558void LIBNETXMS_EXPORTABLE AgentSendTrap2(UINT32 dwEvent, const TCHAR *eventName, int nCount, TCHAR **ppszArgList);
23d3d35d 559bool LIBNETXMS_EXPORTABLE EnumerateSessions(bool (* callback)(AbstractCommSession *, void *), void *data);
cc022855 560BOOL LIBNETXMS_EXPORTABLE AgentSendFileToServer(void *session, UINT32 requestId, const TCHAR *file, long offset);
f480bdd4 561BOOL LIBNETXMS_EXPORTABLE AgentPushParameterData(const TCHAR *parameter, const TCHAR *value);
9309ac95 562BOOL LIBNETXMS_EXPORTABLE AgentPushParameterDataInt32(const TCHAR *parameter, LONG value);
967893bb 563BOOL LIBNETXMS_EXPORTABLE AgentPushParameterDataUInt32(const TCHAR *parameter, UINT32 value);
9309ac95
VK
564BOOL LIBNETXMS_EXPORTABLE AgentPushParameterDataInt64(const TCHAR *parameter, INT64 value);
565BOOL LIBNETXMS_EXPORTABLE AgentPushParameterDataUInt64(const TCHAR *parameter, QWORD value);
566BOOL LIBNETXMS_EXPORTABLE AgentPushParameterDataDouble(const TCHAR *parameter, double value);
53720bbf
VK
567CONDITION LIBNETXMS_EXPORTABLE AgentGetShutdownCondition();
568bool LIBNETXMS_EXPORTABLE AgentSleepAndCheckForShutdown(UINT32 sleepTime);
6827d635 569
23d3d35d 570void LIBNETXMS_EXPORTABLE InitSubAgentAPI(void (* writeLog)(int, int, const TCHAR *),
571 void (* sendTrap1)(UINT32, const TCHAR *, const char *, va_list),
572 void (* sendTrap2)(UINT32, const TCHAR *, int, TCHAR **),
573 bool (* enumerateSessions)(bool (*)(AbstractCommSession *, void *), void *),
574 bool (* sendFile)(void *, UINT32, const TCHAR *, long),
53720bbf
VK
575 bool (* pushData)(const TCHAR *, const TCHAR *, UINT32),
576 CONDITION shutdownCondition);
23d3d35d 577
cbcaf8c8 578#endif /* _nms_agent_h_ */