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