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