Appendix
Cron format
Record has five fields, separated by spaces: minute, hour, day of month, month, and day of week. In DCI Collection Schedule only, an optional the sixth field can be specified for resolution in seconds (this is a non-standard extension which is not compatible with a regular cron format).
Allowed values and special characters for each field are:
Field |
Allowed values |
Allowed special characters |
---|---|---|
minute |
0 - 59 |
* , - / |
hour |
0 - 23 |
* , - / |
day of month |
1 - 31 |
* , - / L |
month |
1 - 12 |
* , - / |
day of week |
0 - 7 (0 and 7 is Sunday) |
* , - / L |
seconds (for DCI collection only, optional) |
0 - 59 (0 - unlimited for %) |
* , - / % |
A field may be an asterisk (*
), which always stands for “any”.
Commas (,
) are used to separate items of a list. For example, using 1,3,4
in the 5th field (day of week) means Mondays, Wednesdays and Fridays.
Hyphens (-
) define ranges. For example, using 6-8
in 4th field (month)
means June, July and August.
Slashes (/
) can be combined with ranges to specify step values.
For example, */5
in the minutes field indicates every 5 minutes.
If a step value does not evenly divide it’s range, there will be an
inconsistent “short” period at the end of time-unit.
L
stands for “last”. When used in the day-of-week field, it allows
to specify constructs such as “the last Friday” (“5L”) of a given month.
In the day-of-month field, it specifies the last day of the month.
The sixth field (but not others) supports additional stepping syntax with a
percent sign (%
), which means that the step in seconds calculated in
absolute seconds since the Unix epoch (00:00:00 UTC, 1st of January, 1970).
It’s not recommended to use seconds in custom schedules as your main data
collection strategy though. Use seconds only if it is absolutely necessary.
Examples
Run five minutes after midnight, every day:
5 0 * * *
Run at 14:15 on the first day of every month:
15 14 1 * *
Run every 5 minutes:
*/5 * * * *
Run every minute on 10th second:
* * * * * 10
Run twice a minute (on seconds 0 and 45):
* * * * * */45
Run every 45 seconds from Monday till Friday:
* * * * 1-5 *%45
SMS Drivers
Deprecated since version 3.0.
SMS driver functionality replaces by notification channel functionality. More can be found in Notification channels section.
Agent configuration file (nxagentd.conf)
Parameter |
Description |
Default Value |
---|---|---|
Action |
Define action, which can be later executed by management server.
Parameters to the action can be provided from the server. They can be
accessed as |
No defaults |
ActionShellExec |
Same as Action, but on Windows platform agent will use shell to execute
command instead of normal process creation. There is no difference
between Action and ActionShellExec on UNIX platforms. Parameters to the
action can be provided from the server. They can be accessed as |
No defaults |
AppAgent |
The registered name of application with built in subagent library that can be as subagent by agent. |
No defaults |
AutoStartUserAgent |
Enable (yes) or disable (no) automatic start of User Support Application (Windows only). If enabled, Agent will check on it’s start, if User Support Application is running in each user session and will start it if needed. For this to work, Agent should be started under local SYSTEM user. |
no |
BackgroundLogWriter |
Enable (yes) or disable (no) log writer as separate background thread. Has no effect if logging is done through syslog or Windows Event Log. |
no |
CodePage |
Code page used by NetXMS agent. Has no effect on Windows or if agent was compiled without iconv support. |
Depends on your system, usually ISO8859-1 |
ConfigIncludeDir |
Folder containing additional configuration files. This parameter can only be specified in master configuration file and will be ignored if found in additional configuration files or configuration policy. |
See Additional configuration files for information on default value. |
ControlServers |
A list of management servers, which can execute actions on agent and change agent’s config. Hosts listed in this parameter also have read access to the agent. Both IP addresses and DNS names can be used. Multiple servers can be specified in one line, separated by commas. If this parameter is used more than once, servers listed in all occurrences will have access to agent. |
Empty list |
CreateCrashDumps |
Enable (yes) or disable (no) creation of agent’s crash dumps. Windows only |
yes |
DataDirectory |
Directory where additional agent files (log file monitoring policy files, agent configuration policy files, user agent configuration, local agent database, etc) will be stored. This parameter can only be specified in master configuration file and will be ignored if found in additional configuration files or configuration policy. |
UNIX-like systems: If |
DailyLogFileSuffix |
Log file name suffix used when |
%Y%m%d |
DebugLevel |
Set agent debug logging level (0 - 9). Value of 0 turns off debugging, 9 enables very detailed logging. Can also be set with command line “-D<level>” option. |
0 |
DebugTags |
Set agent debug logging level (0 - 9) for exact log tag or log tag mask.
Value of 0 turns off debugging, 9 enables very detailed logging.
Configuration should look like |
|
DefaultExecutionTimeout |
Timeout in milliseconds for external metric and external command
execution. This value will be used for external metrics and external
commands if |
5000 |
DisableIPv4 |
Disables (yes) or enables(no) IPv4 support. |
no |
DisableIPv6 |
Disables (yes) or enables(no) IPv6 support. |
no |
DumpDirectory |
Directory for storing crash dumps (Windows only). |
C:\ |
EnableActions |
Enable (yes) or disable (no) action execution by agent. |
yes |
EnableArbitraryCommandExecution |
Not yet implemented. Enables server to run any shell command on the agent without specifying it as action in agent’s config file. Enabling this adds System.Execute action (and also System.ExecuteInAllSessions on Windows). |
no |
EnabledCiphers |
Controls what ciphers agent can use for connection encryption. A value for this parameter is a cipher code. To enable more than one cipher, the codes should be summed up. Possible cipher codes:
Example (enable AES-256 and IDEA): EnabledCiphers = 5 |
63 |
EnableControlConnector |
Enables named pipe used by the agent to receive shutdown and delayed restart commands. A command is sent by another instance of agent, launched with -k or -K parameter. Used on Windows during upgrade process. |
yes |
EnableProxy |
Enable (yes) or disable (no) agent proxy functionality. |
no |
EnableModbusProxy |
Enable (yes) or disable (no) Modbus-TCP proxy functionality. |
no |
EnablePushConnector |
Enables named pipe / unix socket used by the agent to receive data sent by nxapush command line tool. |
yes |
EnableSNMPProxy |
Enable (yes) or disable (no) SNMP proxy functionality. |
no |
EnableSNMPTrapProxy |
Enable (yes) or disable (no) SNMP Trap proxy functionality. |
no |
EnableSSLTrace |
Enable (yes) or disable (no) additional debug messages from SSL library. |
no |
EnableSubagentAutoload |
Enable (yes) or disable (no) automatic loading of subagent(s) depending on the platform on which the agent is running. |
yes |
EnableSyslogProxy |
Enable (yes) or disable (no) Syslog proxy functionality. |
no |
EnableTCPProxy |
Enable TCP proxy functionality that allows to forward TCP connections inside the connection between NetXMS server and agent. An example utility called TcpProxyApp that forwards local ports is provided. |
no |
EnableWatchdog |
Enable (yes) or disable (no) automatic agent restart in case of unexpected shutdown. |
no |
EnableWebServiceProxy |
Enable (yes) or disable (no) web service data collection proxy functionality. |
no |
ExecTimeout |
Deprecated, replaced by |
|
ExternalCommandTimeout |
External process execution timeout for external commands (actions) in
milliseconds. Value of |
|
ExternalList |
Add list handled by external command. To add multiple lists, you should use multiple``ExternalList`` entries. |
No defaults |
ExternalMasterAgent |
ID that is checked when external subagent connects to master agent.
Should have same value as |
No defaults |
ExternalMetric |
Adds metric handled by external command. To add multiple metrics, you
should use multiple |
No defaults |
ExternalMetricProvider |
Specifies external command and execution interval after semicolon (:). External command returns a number of metrics and their values. Metrics are cached by the agent and returned to server per request. Command should return data in metric=value format each pair in new line. |
No defaults |
ExternalMetricProviderTimeout |
Timeout in milliseconds for external metric provider and background-polled external table execution |
30000 |
ExternalMetricShellExec |
ExternalMetricShellExec has same meaning as ExternalMetric with exception that agent will use shell to execute specified command instead of system process execution API. This difference presented only on Windows system, on other systems ExternalMetric and ExternalMetricShellExec behaves identically. |
No defaults |
ExternalMetricTimeout |
Timeout in milliseconds for external metrics. Value of
|
|
ExternalParameter |
Deprecated, replaced by |
|
ExternalParameterProvider |
Deprecated, replaced by |
|
ExternalParametersProvider |
Deprecated, replaced by |
|
ExternalParameterProviderTimeout |
Deprecated, replaced by |
|
ExternalParameterShellExec |
Deprecated, replaced by |
|
ExternalSubagent |
ID of external subagent. Should be same as |
No defaults |
ExternalTable |
Adds table metric handled by external command. To add multiple
parameters, you should use multiple |
No defaults |
FileStore |
Directory to be used for storing files uploaded by management server(s). It’s value is set to environment variable NETXMS_FILE_STORE that is available to all processed launched by agent. |
|
FullCrashDumps |
Enable (yes) or disable (no) full crash dump generation. Windows only |
no |
GroupId |
GroupId under which NetXMS agent is started (Unix only). See also
|
No defaults |
ListenAddress |
IP address that the agent should listen on. If 0.0.0.0 or * is specified as listen address, agent will listen on all available IP addresses. |
0.0.0.0 |
ListenPort |
TCP port to be used for incoming requests. |
4700 |
LogFile |
Agent’s log file. To write log to syslog (or Event Log on Windows), use {syslog} as file name. |
|
LogHistorySize |
Defines how many old log files should be kept after log rotation. |
4 |
LogRotationMode |
Define log rotation mode. Possible values are:
|
2 |
LogUnresolvedSymbols |
If set to yes, all dynamically resolved symbols, which failed to be resolved, will be logged. |
no |
LongRunningQueryThreshold |
Expressed in milliseconds. If a query to agent’s local database or DBQuery subagent query takes longer then this time, the query will be logged to agent log file. |
250 |
MasterServers |
List of management servers, which have full access to agent. Hosts listed in this group can upload files to agent and initiate agent upgrade, as well as perform any task allowed for hosts listed in Servers and ControlServers. Both IP addresses and DNS names can be used. Multiple servers can be specified in one line, separated by commas. If this parameter is used more than once, servers listed in all occurrences will have access to agent. |
Empty list |
MaxLogSize |
Maximum log size, in bytes. When log file reaches this limit, log rotation occurs. Use 0 to disable log rotation. This parameter supports (K, M, G, T suffixes). |
16M |
MaxSessions |
Maximum number of simultaneous communication sessions. Possible value can range from 2 to 1024. |
32 |
OfflineDataExpirationTime |
Applicable only if Agent Cache Mode is on. Defines the duration (in days) for how collected data will be stored in agent’s database if there is no connection to NetXMS server. |
10 |
PlatformSuffix |
String to be added as suffix to the value of |
Empty string |
RequireAuthentication |
If set to yes, a host connected to an agent has to provide correct shared secret before issuing any command. |
no |
RequireEncryption |
If set to yes, a host connected to an agent will be forced to use encryption, and if encryption is not supported by a remote host, the connection will be dropped. If an agent was compiled without encryption support, this parameter has no effect. |
no |
ServerConnection |
IP address or host name of NetXMS server for tunnel agent connection. Several such parameters can be present, in this case agent will establish tunnel connection to more then one server. |
No defaults |
[ServerConnection] |
Section with parameters for for tunnel agent connection. Several such sections can be present. See Agent to server connection for more information. |
No defaults |
Servers |
A list of management servers, which have read access to this agent. Both IP addresses and DNS names can be used. Multiple servers can be specified in one line, separated by commas. If this parameter is used more than once, servers listed in all occurrences will have access to agent. |
Empty list |
SessionIdleTimeout |
Communication session idle timeout in seconds. If an agent will not receive any command from peer within the specified timeout, session will be closed. |
60 |
SharedSecret |
Agent’s shared secret used for remote peer authentication. If
|
admin |
EncryptedSharedSecret |
Agent’s shared secret used for remote peer authentication, encrypted
using “nxencpasswd -a”. If |
|
SNMPProxyThreadPoolSize |
SNMP proxy thread pool size |
128 |
SNMPTimeout |
Timeout in milliseconds for SNMP requests sent by agent |
3000 |
SNMPTrapListenAddress |
Interface address which should be used by server to listen for incoming SNMP trap connections. Use value 0.0.0.0 or * to use all available interfaces. |
|
SNMPTrapPort |
Port that will be used to listen SNMP traps |
162 |
StartupDelay |
Number of seconds that agent should wait on startup before start servicing requests. This parameter can be used to prevent false reports about missing processes or failed services just after monitored system startup. |
0 |
SubAgent |
Subagent to load. To load multiple subagents, you should use multiple SubAgent parameters. Subagents will be loaded in the same order as they appear in configuration file. |
No defaults |
SyslogListenPort |
Listening port number for syslog proxy functionality. |
514 |
SystemName |
If tunnel agent connection is used, the system appears in Agent Tunnel Manager under that name. |
|
TrustedRootCertificate |
Path to file or folder with root certificate used to verify certificate chain in tunnel connection. |
See Agent to server connection for information on default locations |
TunnelKeepaliveInterval |
Interval (in seconds) between keepalive packets over tunnel agent connection. |
30 |
UserAgentExecutable |
Name of User Support Application executable used by AutoStartUserAgent and UserAgentWatchdog parameters. |
nxuseragent.exe |
UserAgentWatchdog |
Enable (yes) or disable (no) automatic restart of User Support Application (Windows only). If enabled, Agent will check once per minute, if User Support Application is running in each user session and will start it if needed. For this to work, Agent should be started under local SYSTEM user. |
no |
UserId |
Username under which NetXMS agent is started (Unix only). See
also |
No defaults |
VerifyServerCertificate |
Perform server certificate chain verification when establishing tunnel connection. See Agent to server connection for more information. |
no |
WaitForProcess |
If specified, an agent will pause initialization until given process starts. |
No defaults |
WriteLogAsJson |
Enable (yes) or disable (no) writing log file in JSON format. |
no |
ZoneUIN |
Allows to set agent’s zone explicitly. This can be useful when agent forwards syslog or SNMP traps of devices, that belong to a particular zone. Agent will include zone UIN along with the trap message that will allow correct matching of traps. |
No defaults |
Note
All boolean parameters understand “Yes/No”, “On/Off” and “True/False” values.
Server configuration file (netxmsd.conf)
Parameter |
Description |
Default Value |
---|---|---|
CodePage |
Code page used by NetXMS server. Has no effect on Windows or if server was compiled without iconv support. |
Depends on your system, usually ISO8859-1 |
CreateCrashDumps |
Control creation of server’s crash dumps. Possible values: yes or no. Has effect only on Windows platforms. |
No |
DailyLogFileSuffix |
Log file name suffix used when |
%Y%m%d |
DataDirectory |
Directory where server looks for compiled MIB files, keep server encryption key, etc. |
On UNIX-like platforms: |
DBDriver |
Database driver to be used. |
No default value |
DBEncryptedPassword |
Hashed password, as produced by “nxencpass” |
none |
DBDriverOptions |
Additional driver-specific parameters. |
Empty string |
DBDrvParams |
Deprecated, replaced by |
Empty string |
DBLogin |
Database user name. |
netxms |
DBName |
Database name (not used by ODBC driver). |
netxms_db |
DBPassword |
Database user’s password. When using INI configuration file remember to enclose password in double qoutes (“password”) if it contains # character. |
Empty password |
DBSchema |
Schema name |
not set |
DBSessionSetupSQLScript |
Path to a plain text file containing a list of SQL commands which will be executed on every new database connection, including initial connection on server startup. |
Empty string |
DBServer |
Database server (ODBC source name for ODBC driver). |
localhost |
DebugLevel |
Set server debug logging level (0 - 9). Value of 0 turns off debugging, 9
enables very detailed logging. Can also be set with command line |
0 |
DebugTags |
Set server debug logging level (0 - 9) for exact log tag or log tag mask.
Value of 0 turns off debugging, 9 enables very detailed logging.
Configuration should look like |
|
DumpDirectory |
Directory for storing crash dumps. |
“/” or “C:" |
FullCrashDumps |
Write full crash dump instead of minidump (Windows only) |
no |
InternalCACertificate |
Path to file of server CA certificate. This certificate is used to issue agent certificates. InternalCACertificate parameter also implies that this certificate is trusted by the server when checking agent certificate validity. |
Empty string |
InternalCACertificateKey |
Private key of server CA certificate. Can be omitted if key is included in server certificate file. |
Empty string |
InternalCACertificatePassword |
Password of server CA certificate. Can be omitted if certificate does not use password. |
Empty string |
LibraryDirectory |
Defines location of library folder where drivers(ndd files) are stored. It’s highly recommended not to use this parameter. |
|
ListenAddress |
Interface address which should be used by server to listen for incoming connections. Use value 0.0.0.0 or * to use all available interfaces. |
0.0.0.0 |
LogFile |
Server’s log file. To write log to syslog (or Event Log on Windows), use {syslog} as file name. |
{syslog} |
LogHistorySize |
Number rotated files to keep, older will be discarded |
4 |
LogRotationMode |
Define log rotation mode. Possible values are:
|
2 |
MaxClientSessions |
Maximum number of client sessions. |
256 |
MaxLogSize |
Maximum log file size in bytes, used only if |
16777216 |
Module |
Additional server module to be loaded at server startup. To load multiple modules, add additional Module parameters. |
No default value |
PeerNode |
IP address of peer node in high availability setup. If there is lock in the database with this address indicated, server process will communicate to agent and server on that address to check if server is not running and will remove database lock. |
No default value |
PerfDataStorageDriver |
||
ProcessAffinityMask |
Sets a processor affinity mask for the netxmsd process (Windows only). A process affinity mask is a bit vector in which each bit represents a logical processor on which the threads of the process are allowed to run. See this MSDN article for more details. |
0xFFFFFFFF |
StartupSQLScript |
Path to a plain text file containing a list of SQL commands which will be executed on server startup. |
Empty string |
ServerCertificate |
Path to file of server certificate for agent tunnel connections. This certificate is used to issue agent certificates. ServerCertificate parameter also implies that this certificate is trusted by the server when checking agent certificate validity. |
Empty string |
ServerCertificateKey |
Private key of server certificate. Can be omitted if key is included in server certificate file. |
Empty string |
ServerCertificatePassword |
Password of server certificate. Can be omitted if certificate does not use password. |
Empty string |
TrustedCertificate |
Certificate issued by certificate authority or self-signed CA certificate. If certificate chain for server certificate is longer, all upper level certificates should be added to configuration file by adding multiple TrustedCertificate entries. |
Empty string |
TunnelCertificate |
Path to file of server certificate for agent tunnel connections. |
Empty string |
TunnelCertificateKey |
Private key of server tunnel certificate. Can be omitted if key is included in server certificate file. |
Empty string |
TunnelCertificatePassword |
Password of server tunnel certificate. Can be omitted if certificate does not use password. |
Empty string |
Note
All boolean parameters accept “Yes/No”, “On/Off” and “True/False” values.
Server configuration parameters
These parameters can be changed in
Parameter |
Description |
Default Value |
Restart Required |
---|---|---|---|
ActionExecutionLog.RetentionTime |
Retention time in days for the records in server action execution log. All records older then specified will be deleted by housekeeping process. |
90 |
No |
Agent.CommandTimeout |
Timeout in milliseconds for commands sent to agent. If agent did not respond to command within this time, command considered as failed. |
4000 |
Yes |
DefaultAgentCacheMode |
Default agent cache mode |
Off |
Yes |
Agent.DefaultEncryptionPolicy |
Set the default encryption policy for communications with agents: 0 - encryption disabled, 1 - allowed, 2 - preferred, 3 - required. |
Allowed |
Yes |
Agent.DefaultAgentProtocolCompressionMode |
Default agent protocol compression mode |
Enabled |
No |
Agent.EnableRegistration |
Enable/disable agents self-registration. |
true |
No |
Agent.RestartWaitTime |
Period of time (in seconds) after agent restart for which server will not perform status, congiration, and other polls on the agent. |
0 |
No |
Agent.Upgrade.NumberOfThreads |
The number of threads used to perform agent upgrades (i.e. maximum number of parallel upgrades). |
10 |
No |
Agent.Upgrade.WaitTime |
Maximum wait time in seconds for agent restart after upgrade. If agent cannot be contacted after this time period, upgrade process is considered as failed. |
600 |
No |
AgentPolicy.MaxFileSize |
Maximum file size for exported files in agent policies. Files larger then this size will not be included when exporting configuration to .xml. |
16777215 |
Yes |
AgentTunnels.Certificates.ReissueInterval |
Interval in days for newly issued agent certificates. |
30 |
Yes |
AgentTunnels.Certificates.ValidityPeriod |
Validity period in days for newly issued agent certificates. |
90 |
Yes |
AgentTunnels.ListenPort |
TCP port number to listen on for incoming agent tunnel connections |
4703 |
Yes |
AgentTunnels.NewNodesContainer |
Name of the container where nodes that were created automatically for unbound tunnels will be placed. If several containers with that name are present, it is not guaranteed, which container will be selected. If empty, such nodes will be created in infrastructure services root. |
No |
|
AgentTunnels.TLS.MinVersion |
Minimal version of TLS protocol used on agent tunnel connection. |
1.2 |
No |
AgentTunnels.UnboundTunnelTimeout |
Unbound agent tunnels inactivity timeout. If tunnel has not been bound or closed after that timeout, action defined by AgentTunnels.UnboundTunnelTimeoutAction parameter will be taken. |
3600 |
No |
AgentTunnels.UnboundTunnelTimeoutAction |
Action to be taken when unbound agent tunnel timeout expires. |
Reset Tunnel |
No |
Alarms.DeleteAlarmsOfDeletedObject |
Enable/disable automatic alarm removal of an object when it is deleted. |
true |
No |
Alarms.EnableTimedAck |
Enable/disable ability to acknowledge an alarm for a specific time. |
true |
Yes |
Alarm.HistoryRetentionTime |
Number of days the server keeps alarm history in the database. |
180 |
No |
Alarms.IgnoreHelpdeskState |
If set, alarm helpdesk state will be ignored when resolving or terminating. |
false |
No |
Alarms.ResolveExpirationTime |
Expiration time (in seconds) for resolved alarms. If set to non-zero, resolved and untouched alarms will be terminated automatically after given timeout. |
0 |
No |
Alarm.StrictStatusFlow |
This parameter describes if alarm status flow should be strict (alarm can be terminated only after it was resolved). |
false |
No |
Alarms.SummaryEmail.Enable |
Enable/disable alarm summary emails. Summary emails will be sent via notification channel specified in DefaultNotificationChannel.SMTP.Html server configuration parameter. |
false |
No |
Alarms.SummaryEmail.Recipients |
A semicolon separated list of e-mail addresses to which the alarm summary will be sent. |
No |
|
Alarms.SummaryEmail.Schedule |
Schedule for sending alarm summary e-mails in cron format. See Cron format for supported cron format options. |
0 0 * * * |
No |
AssetChangeLog.RetentionTime |
Retention time in days for the records in asset change log. All records older then specified will be deleted by housekeeping process. |
90 |
No |
AuditLog.External.Facility |
Syslog facility to be used in audit log records sent to external server. |
13 |
Yes |
AuditLog.External.Port |
UDP port of external syslog server to send audit records to. |
514 |
Yes |
AuditLog.External.Server |
External syslog server to send audit records to. If set to ‘’none’’, external audit logging is disabled. |
none |
Yes |
AuditLog.External.Severity |
Syslog severity to be used in audit log records sent to external server. |
5 |
Yes |
AuditLog.External.Tag |
Syslog tag to be used in audit log records sent to external server. |
netxmsd-audit |
Yes |
AuditLog.External.UseUTF8 |
Changes audit log encoding to UTF-8 |
false |
No |
AuditLog.RetentionTime |
Retention time in days for the records in audit log. All records older than specified will be deleted by housekeeping process. |
90 |
No |
Beacon.Hosts |
Comma-separated list of hosts to be used as beacons for checking NetXMS server network connectivity. Either DNS names or IP addresses can be used. This list is pinged by NetXMS server and if none of the hosts have responded, server considers that connection with network is lost and generates specific event. |
Yes |
|
Beacon.PollingInterval |
Interval in milliseconds between beacon hosts polls. |
1000 |
Yes |
Beacon.Timeout |
Timeout in milliseconds to consider beacon host unreachable. |
1000 |
Yes |
BlockInactiveUserAccounts |
Inactivity time after which user account will be blocked (0 to disable blocking). |
0 |
No |
BusinessServices.Check.AutobindClassFilter |
Class filter for automatic creation of business service checks. |
AccessPoint, Cluster, Interface, NetworkService, Node |
No |
BusinessServices.Check.Threshold.DataCollection |
Default threshold for business DCI service checks |
Warning |
No |
BusinessServices.Check.Threshold.Objects |
Defaule threshold for business service object checks |
Warning |
No |
BusinessServices.History.RetentionTime |
Retention time for business service historical data |
90 |
No |
CAS.AllowedProxies |
Comma-separated list of allowed CAS (Central Authentication Service) proxies. |
No |
|
CAS.Host |
CAS server DNS name or IP address. |
localhost |
No |
CAS.Port |
CAS server TCP port number. |
8443 |
No |
CAS.Service |
Service to validate (usually NetXMS web UI URL). |
No |
|
CAS.TrustedCACert |
File system path to CAS server trusted CA certificate. |
No |
|
CAS.ValidateURL |
URL for service validation on CAS server. |
/cas/serviceValidate |
No |
CertificateActionLog.RetentionTime |
Retention time in days for certificate action log. All records older then specified will be delete by housekeeping process. |
370 |
No |
Client.AlarmList.DisplayLimit |
Maximum alarm count that will be displayed on Alarm Browser page. Alarms that exceed this count will not be shown. |
4096 |
No |
Client.DashboardDataExport.EnableInterpolation |
Enable/disable data interpolation in dashboard data export. |
true |
Yes |
Client.DefaultConsoleDateFormat |
Default format to display date for GUI. |
dd.MM.yyyy |
No |
Client.DefaultConsoleShortTimeFormat |
Default short time display format for GUI. |
HH:mm |
No |
Client.DefaultConsoleTimeFormat |
Default long time display format for GUI. |
HH:mm:ss |
No |
Client.KeepAliveInterval |
Interval in seconds between sending keep alive packets to connected clients. |
60 |
Yes |
Client.ListenerPort |
The server port for incoming client connections (such as management client). |
4701 |
Yes |
Client.MinViewRefreshInterval |
Minimal interval between view refresh in milliseconds (hint for client). |
300 |
No |
Client.ObjectBrowser.AutoApplyFilter |
Enable/disable object browser’’s filter applying as user types (if disabled, user has to press ENTER to apply filter). |
true |
No |
Client.ObjectBrowser.FilterDelay |
Delay (in milliseconds) between typing in object browser’’s filter and applying it to object tree. |
300 |
No |
Client.ObjectBrowser.MinFilterStringLength |
Minimal length of filter string in object browser required for automatic apply. |
1 |
No |
Client.TileServerURL |
The base URL for the tile server used to draw maps. |
No |
|
DataCollection.ApplyDCIFromTemplateToDisabledDCI |
Enable applying all DCIs from a template to the node, including disabled ones. |
true |
Yes |
DataCollection.DefaultDCIPollingInterval |
Default polling interval for newly created DCI (in seconds). |
60 |
No |
DataCollection.DefaultDCIRetentionTime |
Default retention time for newly created DCI (in days). |
30 |
No |
DataCollection.InstancePollingInterval |
Instance polling interval (in seconds). |
600 |
Yes |
DataCollection.InstanceRetentionTime |
Default retention time (in days) for missing DCI instances. |
7 |
No |
DataCollection.OfflineDataRelevanceTime |
Time period in seconds within which received offline data still relevant for threshold validation |
86400 |
Yes |
DataCollection.OnDCIDelete.TerminateRelatedAlarms |
Enable/disable automatic termination of related alarms when data collection item is deleted. |
true |
No |
DataCollection.ScriptErrorReportInterval |
Minimal interval (seconds) between reporting errors in data collection related script. |
86400 |
No |
DataCollection.StartupDelay |
Enable/disable randomized data collection delays on server startup for more even server load distribution. |
false |
Yes |
DataCollection.TemplateRemovalGracePeriod |
Setting up grace period (in days) for removing templates from target. |
0 |
No |
DataCollection.ThresholdRepeatInterval |
System-wide interval in seconds for resending threshold violation events. Value of 0 disables event resending. |
0 |
Yes |
DBConnectionPool.BaseSize |
Number of connections to the database created on the server startup. |
10 |
Yes |
DBConnectionPool.CooldownTime |
Inactivity time (in seconds) after which database connection will be closed. |
300 |
Yes |
DBConnectionPool.MaxLifetime |
Maximum lifetime (in seconds) for a database connection. |
14400 |
Yes |
DBConnectionPool.MaxSize |
Maximum number of connections in the connection pool. |
30 |
Yes |
DBWriter.BackgroundWorkers |
Number of background workers for DCI data writer. |
1 |
Yes |
DBWriter.DataQueues |
Number of queues for DCI data writer. |
1 |
Yes |
DBWriter.HouseKeeperInterlock |
Controls if server should block background write of collected performance data while housekeeper deletes expired records. Auto enables this feature is server is running on MsSQL database. |
Auto |
No |
DBWriter.InsertParallelismDegree |
Degree of parallelism for INSERT statements executed by DCI data writer (only valid for TimescaleDB). |
1 |
Yes |
DBWriter.MaxQueueSize |
Maximum size for DCI data writer queue (0 to disable size limit). If writer queue size grows above that threshold any new data will be dropped until queue size drops below threshold again. |
0 |
No |
DBWriter.MaxRecordsPerStatement |
Maximum number of records per one SQL statement for delayed database writes |
100 |
Yes |
DBWriter.MaxRecordsPerTransaction |
Maximum number of records per one transaction for delayed database writes |
1000 |
Yes |
DBWriter.RawDataFlushInterval |
Interval between writes of accumulates war DCI data to database. |
30 |
Yes |
DBWriter.UpdateParallelismDegree |
Degree of parallelism for UPDATE statements executed by raw DCI data writer. |
1 |
Yes |
DefaultNotificationChannel.SMTP.Html |
Default notification channel for SMTP HTML formatted messages. |
SMTP-HTML |
No |
DefaultNotificationChannel.SMTP.Text |
Default notification channel for SMTP text formatted messages. |
SMTP-Text |
No |
EnableISCListener |
Enable/disable Inter-Server Communications Listener. |
false |
Yes |
Events.Correlation.TopologyBased |
Enable/disable topology based event correlation. |
true |
No |
Events.DeleteEventsOfDeletedObject |
Enable/disable automatic event removal of an object when it is deleted. |
true |
No |
Events.LogRetentionTime |
Retention time in days for the records in event log. All records older than specified will be deleted by housekeeping process. |
90 |
No |
Events.Processor.PoolSize |
Number of threads for parallel event processing. |
1 |
Yes |
Events.Processor.QueueSelector |
Queue selector for parallel event processing. In parallel processing server ensures that events having same queue selector will be processed in one queue. |
%z |
Yes |
Events.ReceiveForwardedEvents |
Enable/disable reception of events forwarded by another NetXMS server. Please note that for external event reception ISC listener should be enabled as well. |
false |
No |
EventStorm.Duration |
Time period for events per second to be above threshold that defines event storm condition. |
15 |
Yes |
EventStorm.EnableDetection |
Enable/disable event storm detection. |
false |
Yes |
EventStorm.EventsPerSecond |
Threshold for number of events per second that defines event storm condition. |
1000 |
Yes |
Geolocation.History.RetentionTime |
Retention time in days for object’s geolocation history. All records older then specified will be deleted by housekeeping process. |
90 |
No |
HelpDeskLink |
Helpdesk driver name. If ‘’none’’, then no helpdesk driver is in use. |
none |
Yes |
Housekeeper.DisableCollectedDataCleanup |
Disable automatic cleanup of collected DCI data during housekeeper run. |
false |
No |
Housekeeper.StartTime |
Time when housekeeper starts. Housekeeper deletes expired log recored and DCI data as well as cleans removed objects. |
02:00 |
Yes |
Housekeeper.Throttle.HighWatermark |
If database writer queue length (in queue elements) exceeds this number, housekeeper process is paused. |
250000 |
No |
Housekeeper.Throttle.LowWatermark |
If housekeeper got paused due to DB writer queue reaching Housekeeper.Throttle.HighWatermark, it will resume operation when DB writer queue becomes lower then this setting. |
50000 |
No |
ICMP.CollectPollStatistics |
Collect ICMP poll statistics for all nodes by default. See ICMP ping chapter for information. |
1 |
No |
ICMP.PingSize |
Size of ICMP packets (in bytes, excluding IP header size) used for status polls. |
46 |
Yes |
ICMP.PingTimeout |
Timeout for ICMP ping used for status polls (in milliseconds). |
1500 |
Yes |
ICMP.PollingInterval |
Interval between ICMP statistic collection polls (in seconds) |
60 |
No |
ICMP.StatisticPeriod |
Time period for collecting ICMP statistics (in number of polls). |
60 |
No |
Jira.IssueType |
Jira issue type |
Task |
No |
Jira.Login |
Jira login |
netxms |
No |
Jira.Password |
Jira password |
No |
|
Jira.ProjectCode |
Jira project code |
NETXMS |
No |
Jira.ProjectComponent |
Jira project component |
No |
|
Jira.ResolvedStatus |
Comma separated list of issue status codes indicating that issue is resolved. |
No |
|
Jira.ServerURL |
The URL of Jira server |
No |
|
Jira.Webhook.Path |
Path part of Jira webhook URL (must start with /). |
/jira-webhook |
Yes |
Jira.Webhook.Port |
Jira webhook listener port (0 to disable webhook). |
8008 |
Yes |
JobRetryCount |
Maximum number of job execution retries. |
5 |
No |
LDAP.ConnectionString |
The LdapConnectionString configuration parameter may be a comma- or whitespace-separated list of URIs containing only the schema, the host, and the port fields. Apart from ldap, other (non-standard) recognized values of the schema field are ldaps (LDAP over TLS), ldapi (LDAP over IPC), and cldap (connectionless LDAP). If other fields are present, the behavior is undefined. Format: schema://host:port. For more information refer to Integration with LDAP chapter. |
No |
|
LDAP.GroupClass |
Specifies which object class represents group objects. If found entry will not be of a user or group class, it will be ignored. |
No |
|
LDAP.GroupUniqueId |
Unique identifier for LDAP group object. If not set, LDAP users are identified by DN. |
No |
|
LDAP.Mapping.Description |
The name of an attribute whose value will be used as a user’s description. |
No |
|
LDAP.Mapping.Email |
The name of an attribute whose value will be used as a user’s email. |
displayName |
No |
LDAP.Mapping.FullName |
The name of an attribute whose value will be used as a user’s full name. |
displayName |
No |
LDAP.Mapping.GroupName |
The name of an attribute whose value will be used as group’s login name |
No |
|
LDAP.Mapping.PhoneNumber |
The name of an attribute whose value will be used as group’s phone number |
No |
|
LDAP.Mapping.UserName |
The name of an attribute whose value will be used as a user’s login name. |
displayName |
No |
LDAP.NewUserAuthMethod |
Authentication method to be set for user object created by LDAP synchronization process. |
LDAP password |
No |
LDAP.PageSize |
The maximum amount of records that can be returned in one search page. |
1000 |
No |
LDAP.SearchBase |
The DN of the entry at which to start the search. |
No |
|
LDAP.SearchFilter |
A string representation of the filter to apply in the search. |
No |
|
LDAP.SyncInterval |
The synchronization interval (in minutes) between the NetXMS server and the LDAP server. If the parameter is set to 0, no synchronization will take place. |
0 |
No |
LDAP.SyncUser |
User login for LDAP synchronization |
No |
|
LDAP.SyncUserPassword |
User password for LDAP synchronization |
No |
|
LDAP.UserClass |
The object class which represents user objects. If the found entry is not of user or group class, it will be ignored. |
No |
|
LDAP.UserDeleteAction |
This parameter specifies what should be done while synchronization with deleted from LDAP user/group. 0 - if user should be just deleted from NetXMS DB. 1 - if it should be disabled. If it is chosen to disable user, then on LDAP sync user will be disabled and it’s description will be change on “LDAP entry was deleted.” Afterwards this user/group can be detached from LDAP and enabled if it is required or just deleted manually. |
Disable user |
No |
LDAP.UserUniqueId |
Unique identifier for LDAP user object. If not set, LDAP users are identified by DN. |
No |
|
LongRunningQueryThreshold |
Threshold in milliseconds to report long running SQL queries (0 to disable). Queries are logged to NetXMS server log file on debug level 3. |
0 |
Yes |
MaintenanceJournal.RetentionTime |
Retention time in days for maintenance jourcal entries. All records older then specified will be deleted by housekeeping process. |
1826 |
No |
MobileDeviceListenerPort |
Listener port for connections from NetXMS mobile agent. |
4747 |
Yes |
NetworkDeviceDrivers.BlackList |
Comma separated list of blacklisted network device drivers. |
Yes |
|
NetworkDiscovery.ActiveDiscovery.BlockSize |
Size of address block to which ICMP ping requests are sent simultaneously during active discovery. |
1024 |
No |
NetworkDiscovery.ActiveDiscovery.EnableSNMPProbing |
Enable/disable SNMP probing during active network discovery. If enabled, server will send SNMP requests to detect devices that restpond to SNMP, but not to ICMP pings. |
true |
No |
NetworkDiscovery.ActiveDiscovery.EnableTCPProbing |
Enable/disable TCP probing during active network discovery. If enabled, server will try to establish TCP connection to list of well-known ports to detect devices that are not responding to ICMP pings. This setting is changed by Network Discovery Configuration GUI |
false |
No |
NetworkDiscovery.ActiveDiscovery.InterBlockDelay |
Pause in milliseconds between scanning of blocks during active discovery. Together with BlockSize this allows to slow down active discovery if network equipment treats large number of ICMP requests as flood. |
0 |
No |
NetworkDiscovery.ActiveDiscovery.Interval |
Interval in seconds between active network discovery polls. This setting is changed by Network Discovery Configuration GUI |
7200 |
No |
NetworkDiscovery.ActiveDiscovery.Schedule |
Active network discovery poll schedule in cron format. This setting is changed by Network Discovery Configuration GUI |
No |
|
NetworkDiscovery.DisableProtocolProbe.Agent |
Disable probing discovered addresses for NetXMS agent. |
false |
No |
NetworkDiscovery.DisableProtocolProbe.EtherNetIP |
Disable probing discovered addresses for Ethernet/IP support. |
false |
No |
NetworkDiscovery.DisableProtocolProbe.SNMP.V1 |
Disable SNMP version 1 when probing discovered addresses for SNMP support. |
false |
No |
NetworkDiscovery.DisableProtocolProbe.SNMP.V2 |
Disable SNMP version 2 when probing discovered addresses for SNMP support. |
false |
No |
NetworkDiscovery.DisableProtocolProbe.SNMP.V3 |
Disable SNMP version 3 when probing discovered addresses for SNMP support. |
false |
No |
NetworkDiscovery.DisableProtocolProbe.SSH |
Disable probing discovered addresses for SSH support. |
false |
No |
NetworkDiscovery.EnableParallelProcessing |
Enable/disable parallel processing of discovered addresses. |
false |
No |
NetworkDiscovery.Filter.Flags |
Discovery filter settings. This setting is changed by Network Discovery Configuration GUI |
0 |
No |
NetworkDiscovery.Filter.Script |
Name of discovery filter script from script library. This setting is changed by Network Discovery Configuration GUI |
none |
No |
NetworkDiscovery.MergeDuplicateNodes |
Enable/disable merging of duplicate nodes (that may be created due to parallel processing of discovered addresses). |
false |
No |
NetworkDiscovery.PassiveDiscovery.Interval |
Interval in seconds between passive network discovery polls. This setting is changed by Network Discovery Configuration GUI |
900 |
No |
NetworkDiscovery.Type |
Defines enabled modes of network discovery. This setting is changed by Network Discovery Configuration GUI |
Disabled |
No |
NetworkDiscovery.UseDNSNameForDiscoveredNodes |
Enable/disable the use of DNS name instead of IP address as primary name for newly discovered nodes. If enabled, server will do back resolve of IP address, and then resolve obtained name back to IP address. Only if this IP address will match the original one, DNS name will be used. |
false |
No |
NetworkDiscovery.UseFQDNForNodeNames |
Enable/disable the use of fully qualified domain names as primary names for newly discovered nodes. |
true |
Yes |
NetworkDiscovery.UseSNMPTraps |
This parameter defines if trap information should be used for new node discovery. |
false |
Yes |
NetworkDiscovery.UseSyslog |
Enable/disable use of syslog messages for new node discovery. |
false |
Yes |
NotificationChannels.MaxRetryCount |
Maximum count of retries to send a message for all notification channels. |
3 |
No |
NotificationLog.RetentionTime |
Retention time in days for the records in notification log. All records older then specified will be deleted by housekeeper process. |
90 |
No |
NXSL.EnableContainerFunctions |
Enable/disable server-side NSXL functions for containers (such as CreateContainer, BindObject, etc.). |
true |
No |
NXSL.EnableFileIOFunctions |
Enable/disable server-side NXSL functions for file I/O (such as OpenFile, DeleteFile, etc.). |
false |
No |
Objects.AccessPoints.ContainerAutoBind |
Enable/disable container auto binding for access points. |
false |
No |
Objects.AccessPoints.TemplateAutoApply |
Enable/disable template auto apply for access points. |
false |
No |
Objects.Assets.AllowDeleteIfLinked |
Enable/disable deletion of linked assets. |
false |
No |
Objects.AutobindOnConfigurationPoll |
Enable/disable automatic object binding on configuration polls. |
true |
No |
Objects.AutobindPollingInterval |
Interval in seconds between automatic object binding polls. |
3600 |
No |
Objects.Clusters.ContainerAutoBind |
Enable/disable container auto binding for clusters. |
false |
No |
Objects.Clusters.TemplateAutoApply |
Enable/disable template auto apply for clusters. |
false |
No |
Objects.Conditions.PollingInterval |
Interval in seconds between polling (re-evaluating) of condition objects. |
60 |
Yes |
Objects.ConfigurationPollingInterval |
Interval in seconds between configuration polls. |
3600 |
Yes |
Objects.DeleteUnreachableNodesPeriod |
Delete nodes which were unreachable for a number of days specified by this parameter. If this parameter is set to 0 then unreachable nodes will never be deleted. |
0 |
Yes |
Objects.EnableZoning |
Enable/disable zoning support. |
true |
Yes |
Objects.Interfaces.DefaultExpectedState |
Default expected state for new interface objects. |
AUTO |
No |
Objects.Interfaces.Enable8021xStatusPoll |
Globally enable or disable checking of 802.1x port state during status poll. |
true |
No |
Objects.Interfaces.NamePattern |
Custom name pattern for interface objects. This field supports macros.
E.g. if set to |
No |
|
Objects.Interfaces.UseAliases |
|
Don’t use aliases |
No |
Objects.Interfaces.UseIfXTable |
Enable/disable the use of SNMP ifXTable instead of ifTable for interface configuration polling. See SNMP for more information. |
true |
No |
Objects.MobileDevices.ContainerAutoBind |
Enable/disable container auto binding for mobile devices. |
false |
No |
Objects.MobileDevices.TemplateAutoApply |
Enable/disable template auto apply for mobile devices. |
false |
No |
Objects.NetworkMaps.DefaultBackgroundColor |
Default background color for new network map objects (as RGB value). |
0xffffff |
No |
Objects.Nodes.CapabilityExpirationGracePeriod |
Grace period (in seconds) for capability expiration after node recovered from unreachable state. |
3600 |
No |
Objects.Nodes.CapabilityExpirationTime |
Time (in seconds) before capability (NetXMS Agent, SNMP, EtherNet/IP, etc) expires if node is not responding for requests via appropriate protocol. |
604800 |
No |
Objects.Nodes.FallbackToLocalResolver |
Enable/disable fallback to server’’s local resolver if node address cannot be resolved via zone proxy. |
false |
No |
Objects.Nodes.ResolveDNSToIPOnStatusPoll |
Enable/disable resolve DNS to IP on status poll. |
Never |
No |
Objects.Nodes.ResolveDNSToIPOnStatusPoll.Interval |
Number of status polls between resolving primary host name to IP, if Objects.Nodes.ResolveDNSToIPOnStatusPoll set to “Always”. |
0 |
No |
Objects.Nodes.ResolveNames |
Resolve node name using DNS, SNMP system name, or host name if current node name is it’s IP address. |
true |
No |
Objects.Nodes.Resolver.AddressFamilyHint |
Address family hint for node DNS name resolver. |
None |
No |
Objects.Nodes.SyncNamesWithDNS |
Enable/disable synchronization of node names with DNS on each configuration poll. |
false |
No |
Objects.PollCountForStatusChange |
The number of consecutive unsuccessful polls required to declare interface as down. |
1 |
Yes |
Objects.ResponsibleUsers.AllowedTags |
Allowed tags for responsible users (Comma-separated list). |
No |
|
Objects.Security.CheckTrustedObjects |
Enable/disable trusted objects checks for cross-object access. |
false |
No |
Objects.Sensors.ContainerAutoBind |
Enable/disable container auto binding for sensors. |
false |
No |
Objects.Sensors.TemplateAutoApply |
Enable/disable template auto apply for sensors. |
false |
No |
Objects.StatusCalculation.CalculationAlgorithm |
Default alghorithm for calculation object status from it’s DCIs, alarms and child objects. Possible values are:
|
Most critical |
Yes |
Objects.StatusCalculation.FixedStatusValue |
Value for status propagation if ‘’StatusPropagationAlgorithm’’ server configuration parameter is set to ‘’2 - Fixed’’. |
0 |
Yes |
Objects.StatusCalculation.PropagationAlgorithm |
Default algorithm for status propagation (how object’s status is affected by it’s child object statuses). Possible values are:
|
Unchanged |
Yes |
Objects.StatusCalculation.Shift |
Status shift value for Relative propagation algorithm. |
0 |
Yes |
Objects.StatusCalculation.SingleThreshold |
Threshold value (in %) for Single threshold status calculation algorithm. |
75 |
Yes |
Objects.StatusCalculation.Thresholds |
Threshold values for Multiple thresholds status calculation algorithm. Every byte (from left to right) of this hex number express threshold values for warning, minor, major and critical statuses. |
503C2814 (80%, 60%, 40%, 20%) |
Yes |
Objects.StatusCalculation.Translation |
Values for Translated status propagation algorithm. Every byte (from left to right) of this hex number defines status translation for Warning, Minor, Major and Critical statuses. Status values are:
|
01020304 |
Yes |
Objects.StatusPollingInterval |
Interval in seconds between status polls. |
60 |
Yes |
Objects.Subnets.DefaultSubnetMaskIPv4 |
Default mask for synthetic IPv6 subnets. |
24 |
No |
Objects.Subnets.DefaultSubnetMaskIPv6 |
Default mask for synthetic IPv6 subnets. |
64 |
No |
Objects.Subnets.DeleteEmpty |
Enable/disable automatic deletion of subnet objects that have no nodes within. When enabled, empty subnets will be deleted by housekeeping process. |
false |
Yes |
Objects.SyncInterval |
Interval in seconds between writing object changes to the database. |
60 |
Yes |
RADIUS.AuthMethod |
RADIUS authentication method to be used (PAP, CHAP, MS-CHAPv1, MS-CHAPv2). |
PAP |
No |
RADIUS.NumRetries |
The number of retries for RADIUS authentication. |
5 |
No |
RADIUS.Port |
Port number used for connection to primary RADIUS server. |
1645 |
No |
RADIUS.SecondaryPort |
Port number used for connection to secondary RADIUS server. |
1645 |
No |
RADIUS.SecondarySecret |
Shared secret used for communication with secondary RADIUS server. |
netxms |
No |
RADIUS.SecondaryServer |
Host name or IP address of secondary RADIUS server. |
none |
No |
RADIUS.Secret |
Shared secret used for communication with primary RADIUS server. |
netxms |
No |
RADIUS.Server |
Host name or IP address of primary RADIUS server. |
none |
No |
RADIUS.Timeout |
Timeout in seconds for requests to RADIUS server |
3 |
No |
ReportingServer.Enable |
Enable/disable reporting server |
false |
Yes |
ReportingServer.Hostname |
The hostname of the reporting server. |
127.0.0.1 |
Yes |
ReportingServer.Port |
The port of the reporting server. |
4710 |
Yes |
Scheduler.TaskRetentionTime |
Period (in seconds) after which non-recurring scheduled tasks (e.g. Maintenance enter / Maintenance leave) are deleted. |
86400 |
No |
Server.AllowedCiphers |
A bitmask for encryption algorithms allowed in the server (sum of the values to allow multiple algorithms at once):
|
63 |
Yes |
Server.Color |
Identification color for this server. Used in status bar of management client. |
No |
|
Server.CommandOutputTimeout |
Time (in seconds) to wait for output of a local command object tool. |
60 |
No |
Server.EscapeLocalCommands |
Enable/disable TAB and new line characters replacement by t n r in execute command on management server action. |
false |
No |
Server.ImportConfigurationOnStartup |
Import configuration (templates, events, object tools, etc) on server startup. Configuration is imported from files located on NetXMS server in share/templates. Missing elements are identified by GUID. |
Only missing elements |
Yes |
Server.MessageOfTheDay |
Message to be shown when a user logs into the client. |
No |
|
ServerName |
Name of this server. Displayed in status bar of management client. |
No |
|
Server.RoamingMode |
Enable/disable roaming mode for server (when server can be disconnected from one network and connected to another or IP address of the server can change) |
true |
No |
Server.Security.2FA.TrustedDeviceTTL |
TTL (in seconds) for 2FA trusted device. |
0 |
No |
Server.Security.CaseInsensitiveLoginNames |
Enable/disable case insensitive login names. |
false |
Yes |
Server.Security.ExtendedLogQueryAccessControl |
Enable/disable extended access control in log queries. When enabled, server will check user’s access to objects and only select those log records where user has read access to related object. Please note that enabling this option can cause slow and inefficient SQL queries depending on number of objects and actual access right assignment. |
false |
No |
Server.Security.GraceLoginCount |
Number of times a user can login if password has been expired. |
5 |
No |
Server.Security.IntruderLockoutThreshold |
Number of incorrect password attempts after which a user account is temporarily locked. |
0 |
No |
Server.Security.IntruderLockoutTime |
Duration of user account temporarily lockout (in minutes) if allowed number of incorrect password attempts was exceeded. |
30 |
No |
Server.Security.MinPasswordLength |
Default minimum password length for a NetXMS user. The default applied only if per-user setting is not defined. |
0 |
No |
Server.Security.PasswordComplexity |
Set of flags to enforce password complexity (see Password Policy for more details). |
0 |
No |
Server.Security.PasswordExpiration |
Password expiration time in days. If set to 0, password expiration is disabled. |
0 |
No |
Server.Security.PasswordHistoryLength |
Number of previous passwords to keep. Users are not allowed to set password if it matches one from previous passwords list. |
0 |
No |
Server.Security.RestrictLocalConsoleAccess |
If enabled, restrict access to local server debug console (via nxagm command line tool) only to authenticated users with server debug console access rights. |
true |
No |
SNMP.Codepage |
Default server SNMP codepage |
No |
|
SNMP.Discovery.SeparateProbeRequests |
Use separate SNMP request for each test OID. |
0 |
No |
SNMP.EngineId |
Server SNMP engine ID. |
80:00:DF:4B:05:20:10:08:04:02:01:00 |
Yes |
SNMP.RequestTimeout |
Timeout in milliseconds for SNMP requests sent by NetXMS server. |
1500 |
Yes |
SNMP.RetryCount |
Number of retries for SNMP requests sent by NetXMS server. |
3 |
Yes |
SNMP.Traps.AllowVarbindsConversion |
Allows/disallows conversion of SNMP trap OCTET STRING varbinds into hex strings if they contain non-printable characters. |
1 |
No |
SNMP.Traps.Enable |
Enable/disable SNMP trap processing. A dedicated thread will be created if set to true. |
true |
Yes |
SNMP.Traps.ListenerPort |
Port used for SNMP traps. |
162 |
Yes |
SNMP.Traps.LogAll |
Log all SNMP traps (even those received from addresses not belonging to any known node). |
false |
No |
SNMP.TrapLogRetentionTime |
The time (in days) how long SNMP trap logs are retained. |
90 |
No |
SNMP.Traps.ProcessUnmanagedNodes |
Enable/disable processing of SNMP traps received from unmanaged nodes. |
false |
No |
SNMP.Traps.RateLimit.Duration |
Time period (in seconds) for SNMP traps per second to be above threshold that defines SNMP trap flood condition. |
15 |
No |
SNMP.Traps.RateLimit.Threshold |
Threshold for number of SNMP traps per second that defines SNMP trap flood condition. Detection is disabled if 0 is set. |
0 |
No |
SNMP.Traps.SourcesInAllZones |
Search all zones to match trap/syslog source address to node. |
false |
Yes |
Syslog.AllowUnknownSources |
Enable or disable processing of syslog messages from unknown sources. |
false |
No |
Syslog.Codepage |
Default server syslog codepage. |
No |
|
Syslog.EnableListener |
Enable/disable receiving of syslog messages. |
0 |
Yes |
Syslog.EnableStorage |
Enable/disable local storage of received syslog messages in NetXMS database. |
true |
No |
Syslog.IgnoreMessageTimestamp |
Ignore timestamp received in syslog messages and always use server time. |
false |
No |
Syslog.ListenPort |
UDP port used by built-in syslog server. |
514 |
Yes |
Syslog.NodeMatchingPolicy |
Node matching policy for built-in syslog daemon. Possible values are:
|
IP,then hostname |
Yes |
Syslog.RetentionTime |
Retention time in days for stored syslog messages. All messages older than specified will be deleted by housekeeping process. |
90 |
No |
ThreadPool.Agent.BaseSize |
This parameter represents base thread pool size for threads that receive data, traps, events, etc from agents. This is minimal number of threads that will always run. |
32 |
Yes |
ThreadPool.Agent.MaxSize |
This parameter represents maximum thread pool size for threads that receive data, traps, events, etc from agents. In case of high load on existing threads server will increase number of threads up to this value. When load come back to normal, number of threads will be automatically decreased to base size. |
256 |
Yes |
ThreadPool.DataCollector.BaseSize |
This parameter represents base thread pool size for data collector threads. This is minimal number of threads that will always run. |
10 |
Yes |
ThreadPool.DataCollector.MaxSize |
This parameter represents maximum thread pool size for data collector threads. In case of high load on existing threads server will increase number of threads up to this value. When load come back to normal, number of threads will be automatically decreased to base size. |
250 |
Yes |
ThreadPool.Discovery.BaseSize |
This parameter represents base thread pool size for network discovery threads. This is minimal number of threads that will always run. |
8 |
Yes |
ThreadPool.Discovery.MaxSize |
This parameter represents maximum thread pool size for network discovery threads. In case of high load on existing threads server will increase number of threads up to this value. When load come back to normal, number of threads will be automatically decreased to base size. |
64 |
Yes |
ThreadPool.Main.BaseSize |
This parameter represents base thread pool size for threads that perform general system tasks. This is minimal number of threads that will always run. |
8 |
Yes |
ThreadPool.Main.MaxSize |
This parameter represents maximum thread pool size for threads that perform general system tasks. In case of high load on existing threads server will increase number of threads up to this value. When load come back to normal, number of threads will be automatically decreased to base size. |
256 |
Yes |
ThreadPool.Poller.BaseSize |
This parameter represents base thread pool size for threads that perform all types of polls: Status poll, Configuration poll, etc. except DCI collection. This is minimal number of threads that will always run. |
10 |
Yes |
ThreadPool.Poller.MaxSize |
This parameter represents maximum thread pool size for threads that perform all types of polls: Status poll, Configuration poll, etc. except DCI collection. In case of high load on existing threads server will increase number of threads up to this value. When load come back to normal, number of threads will be automatically decreased to base size. |
250 |
Yes |
ThreadPool.Scheduler.BaseSize |
This parameter represents base thread pool size for scheduler threads. This is minimal number of threads that will always run. |
1 |
Yes |
ThreadPool.Scheduler.MaxSize |
This parameter represents maximum thread pool size for scheduler threads. In case of high load on existing threads server will increase number of threads up to this value. When load come back to normal, number of threads will be automatically decreased to base size. |
64 |
Yes |
ThreadPool.Syncer.BaseSize |
This parameter represents base thread pool size for threads that perform object synchronization to the database. This is minimal number of threads that will always run. |
1 |
Yes |
ThreadPool.Syncer.MaxSize |
This parameter represents maximum thread pool size for threads that perform object synchronization to the database. In case of high load on existing threads server will increase number of threads up to this value. When load come back to normal, number of threads will be automatically decreased to base size. Value of 1 will disable pool creation. |
1 |
Yes |
Topology.AdHocRequest.ExpirationTime |
Ad-hoc network topology request expiration time. Server will use cached result of previous request if it is newer than given interval. |
900 |
No |
Topology.DefaultDiscoveryRadius |
Default number of hops from seed node to be added to topology map. |
5 |
No |
Topology.PollingInterval |
Interval in seconds between topology polls. |
1800 |
Yes |
Topology.RoutingTableUpdateInterval |
Interval in seconds between reading routing table from node. |
300 |
Yes |
UserAgent.DefaultMessageRetentionTime |
Default user agent message retention time (in minutes). |
10800 |
No |
UserAgent.RetentionTime |
User agent message historical data retention time (in days). |
30 |
No |
WindowsEvents.EnableStorage |
Enable/disable local storage of received Windows events in NetXMS database. |
true |
No |
WindowsEvents.LogRetentionTime |
Retention time in days for records in Windows event log. All records older than specified will be deleted by housekeeping process. |
90 |
No |
Bundled Subagents
Command line tools
NetXMS provide some additional command line tools. Each tool serves its own purpose.
DB Manager
- This is tool used to make manipulations with NetXMS database.
Usage: nxdbmgr [<options>] <command>
Valid commands are:
batch <file> |
Run SQL batch file |
check |
Check database for errors |
export <file> |
Export database to file |
get <name> |
Get value of server configuration variable |
import <file> |
Import database from file |
init <file> |
Initialize database |
migrate <source> |
Migrate database from given source |
reset-system-account |
Unlock user “system” and reset it’s password to default (“netxms”). Warning: server (“netxmsd”) should be stopped while performing password reset operation! See Resetting “system” user password for detailed procedure. |
set <name> <value> |
Set value of server configuration variable |
unlock |
Forced database unlock |
upgrade |
Upgrade database to new version |
Valid options are:
-c <config> |
Use alternate configuration file. Default is {search} |
-d |
Check collected data (may take very long time). |
-D |
Migrate only collected data. |
-f |
Force repair - do not ask for confirmation. |
-h |
Display help and exit. |
-I |
MySQL only - specify TYPE=InnoDB for new tables. |
-M |
MySQL only - specify TYPE=MyISAM for new tables. |
-N |
Do not replace existing configuration value (“set” command only). |
-q |
Quiet mode (don’t show startup banner). |
-s |
Skip collected data during migration. |
-t |
Enable trace mode (show executed SQL queries). |
-v |
Display version and exit. |
-X |
Ignore SQL errors when upgrading (USE WITH CAUTION!!!) |
Database initialization
nxdbmgr init initialization.file
Is used to initialize first time database. Database and user should already exist. Credentials of connection are taken from server configuration file.
Database migration
nxdbmgr migrate old.configuration.file
Is used to migrate NetXMS database between different database management system from NetXMS supported list.
While migration nxdbmgr should use new configuration file(with new DB credentials) and as a parameter should be given the old configuration file.
In best practises of migration is to do database check with command “nxdbmgr check”.
nxaction
nxadm
nxalarm
nxap
nxappget
nxapush
This tool has same usage as nxpush, but it sends data through local agent.
When new version of NetXMS is released - version of server protocol is changed. Change of version affects on server communication with other tools like nxpush. So after each server update nxpush tool also should be updated. In case of usage nxapush - only agent should be updated as this tool uses agent protocol to send data.
nxdevcfg
nxencpasswd
This tool can be used to obfuscate passwords stored in server and agent configuration files as well as various places in the system, e.g. ssh passwords, notification channel passwords, etc.
nxevent
This tool can be used to push events to NetXMS server.
nxget
This tool is intended to get values of Metric from NetXMS agent.
Syntax:
nxget [options] host [metric [metric ...]]
Where host is the name or IP address of the host running NetXMS agent; and metric is a metric, list or table name, depending on given options. By default, nxget will attempt to retrieve the value of only one given metric, unless -b option is given.
Valid options for nxget
Option |
Description |
---|---|
-a auth |
|
-A auth |
Authentication method for proxy agent. |
-b |
Batch mode - get all parameters listed on command line. |
-C |
Get agent’s configuration file |
-d delimiter |
Print table content as delimited text. |
-D level |
Set debug level (default is 0). |
-e policy |
Set encryption policy. Possible values are:
|
-E file |
Take screenshot. First parameter is file name, second (optional) is session name. |
-h |
Display help and exit. |
-i seconds |
Get specified parameter(s) continuously with given interval. |
-I |
Get list of supported parameters. |
-K file |
|
-l |
Requested parameter is a list. |
-n |
Show parameter’s name in result. |
-o proto |
Protocol number to be used for service check. |
-O port |
Proxy agent’s port number. Default is 4700. |
-p port |
Agent’s port number. Default is 4700. |
-P port |
Network service port (to be used with -S option). |
-r string |
Service check request string. |
-R string |
Service check expected response string. |
-s secret |
Shared secret for authentication. |
-S addr |
Check state of network service at given address. |
-t type |
|
-T |
Requested parameter is a table. |
-v |
Display version and exit. |
-w seconds |
Set command timeout (default is 5 seconds). |
-W seconds |
Set connection timeout (default is 30 seconds). |
-X addr |
Use proxy agent at given address. |
-Z secret |
Shared secret for proxy agent authentication. |
Examples
Get value of Agent.Version metric from agent at host 10.0.0.2:
nxget 10.0.0.2 Agent.Version
Get list of supported parameters from agent at host 10.0.0.2:
nxget 10.0.0.2 -I
Get list of supported lists from agent at host 10.0.0.2:
nxget 10.0.0.2 Agent.SupportedLists -l
Get list of supported tables from agent at host 10.0.0.2:
nxget 10.0.0.2 Agent.SupportedTables -l
Get value of Agent.Uptime and System.Uptime metrics in one request, with output in metric = value form:
nxget –bn 10.0.0.2 Agent.Uptime System.Uptime
Get agent configuration file from agent at host 10.0.0.2:
nxget –C 10.0.0.2
Get value of System.PlatformName metric from agent at host 10.0.0.2, connecting via proxy agent at 172.16.1.1:
nxget –X 172.16.1.1 10.0.0.2 System.PlatformName
Get value of Agent.SupportedParameters enum from agent at host 10.0.0.10, forcing use of encrypted connection:
nxget –e 3 –l 10.0.0.10 Agent.SupportedParameters
Check POP3 service at host 10.0.0.4 via agent at host 172.16.1.1:
nxget –S 10.0.0.4 –t 2 –r user:pass 172.16.1.1
Useful lists for debugging purpose
List name |
Description |
---|---|
Agent.ActionList |
List of defined actions |
Agent.SubAgentList |
List of loaded subagents |
Agent.SupportedLists |
List of supported lists |
Agent.SupportedParameters |
List of supported parameters |
Agent.SupportedPushParameters |
List of supported push parameters |
Agent.SupportedTables |
List of supported table parameters |
Agent.ThreadPools |
List of thread pools |
nxmibc
nxpush
nxpush is a tool that allows to push DCI daca from command line.
- There are different options how this tool can be used:
with help of this tool data collected with different monitoring system can be pushed also to netxms
can be used on nodes where agent can not be installed(not the case for nxapush)
can be used on nodes behind NAT with no port forwarding option
Usage: ./nxapush [OPTIONS] [@batch_file] [values]
Options:
-h |
Display this help message. |
-o <id> |
Push data on behalf of object with given id. |
-q |
Suppress all messages. |
-v |
Enable verbose messages. Add twice for debug |
-V |
Display version information. |
- Notes:
Values should be given in the following format: dci=value where dci can be specified by it’s name
Name of batch file cannot contain character = (equality sign)
- Examples:
Push two values:
nxapush PushParam1=1 PushParam2=4
Push values from file:
nxapush @file
Required server configurations are described there: Push metrics
nxscript
nxsms
nxsnmpget
nxsnmpset
nxsnmpwalk
nxupload
List of supported metrics
In this chapter will be described Agent and OS Subagent provided metrics.
Single value metrics
Agent.AcceptedConnections
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, H$1-$3X, FreeBSD, NetBSD, OpenBSD
Cumulative counter of connections accepted by agent
Agent.AcceptErrors
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Cumulative counter of agent’s accept() system call errors
Agent.ActiveConnections
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Number of active connections to agent
Agent.AuthenticationFailures
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Cumulative counter of failed AUTH commands (due to invalid secret)
Agent.ConfigurationServer
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Configuration server address set on agent startup.
Agent.FailedRequests
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Cumulative counter of requests with errors in processing (others than unsupported metrics)
Agent.GeneratedTraps
Note
Depricated
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Nuber of traps generated by agent
Agent.IsSubagentLoaded(*)
Data type: Integer
- Parameters:
subagent name
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Check if given subagent is loaded. Return 1 if loaded and 0 if not.
Agent.LastTrapTime
Note
Depricated
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Timestamp of last generated trap
Agent.IsUserAgentInstalled
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Check if user support application is installed
Agent.LocalDatabase.FailedQueries
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Agent local database: failed queries
Agent.LocalDatabase.LongRunningQueries
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Agent local database: long running queries
Agent.LocalDatabase.Status
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Agent local database: status
Agent.LocalDatabase.TotalQueries
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Agent local database: total queries executed
Agent.LogFile.Status
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Agent log status
Agent.Notification.QueueSize
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Agent notification queue size
Agent.ProcessedRequests
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Cumulative counter of successfully processed requests
Agent.Registrar
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Registrar server address set on agent startup
Agent.RejectedConnections
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Cumulative counter of connections rejected due to authentication failure
Agent.SentTraps
Note
Depricated
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Number of traps successfully sent to server
Agent.SourcePackageSupport
Data type: Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Non-zero if system is capable of building agent from source
Agent.SupportedCiphers
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
List of ciphers supported by agent
Agent.SyslogProxy.IsEnabled
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Check if syslog proxy is enabled
Agent.SyslogProxy.ReceivedMessages
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Number of syslog messages received by agent
Agent.ThreadPool.ActiveRequests(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Thread pool name. Possible options: MAIN, AGENT, POLLERS, SCHEDULER
Count of active requests for specified agent thread pool.
Agent.ThreadPool.CurrSize(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Thread pool name. Possible options: MAIN, AGENT, POLLERS, SCHEDULER
Current size of specified agent thread pool.
Agent.ThreadPool.Load(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Thread pool name. Possible options: MAIN, AGENT, POLLERS, SCHEDULER
Current load of specified agent thread pool. It’s active requests divided by current thread count in precent.
Agent.ThreadPool.LoadAverage(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Thread pool name. Possible options: MAIN, AGENT, POLLERS, SCHEDULER
optional Normalization flag. If it is set to 1, then the value is divided to max thread count.
Active request moving average load of specified agent thread pool for last minute.
Agent.ThreadPool.LoadAverage5(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Thread pool name. Possible options: MAIN, AGENT, POLLERS, SCHEDULER
optional Normalization flag. If it is set to 1, then the value is divided to max thread count.
Active request moving average of specified agent thread pool for last 5 minutes.
Agent.ThreadPool.LoadAverage15(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Thread pool name. Possible options: MAIN, AGENT, POLLERS, SCHEDULER
optional Normalization flag. If it is set to 1, then the value is divided to max thread count.
Active request moving average load of specified agent thread pool for last 15 minutes.
Agent.ThreadPool.MaxSize(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Thread pool name. Possible options: MAIN, AGENT, POLLERS, SCHEDULER
Maximum size of specified agent thread pool.
Agent.ThreadPool.MinSize(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Thread pool name. Possible options: MAIN, AGENT, POLLERS, SCHEDULER
Maximum size of specified agent thread pool.
Agent.ThreadPool.Usage(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Thread pool name. Possible options: MAIN, AGENT, POLLERS, SCHEDULER
Current usage of specified agent thread pool. The value is equal to current thread count divided by max thread count in percent.
Agent.TimedOutRequests
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Cumulative counter of timed out requests
Agent.UnsupportedRequests
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Cumulative counter of requests for unsupported metrics
Agent.Uptime
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Number of seconds since agent start
Agent.Version
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Agent’s version
Disk.Avail(*)
TODO
Disk.AvailPerc(*)
TODO
Disk.Free(*)
TODO
Disk.FreePerc(*)
TODO
Disk.Total(*)
TODO
Disk.Used(*)
TODO
Disk.UsedPerc(*)
TODO
File.Content(*)
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path - it specifies path to file
Returns first line of file content (but no more then 255 characters). Only servers which are in MasterServers in agent configuration file have access to this metric.
The following macros are supported in path and pattern parameters:
Environment variables as ${ENV_VAR_NAME}
strftime(3C) macros
Text inside ` braces will be executed as a command and first line of output will be taken (only for servers which are in MasterServers in agent configuration file)
File.Count(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path is the only mandatory argument. It specifies base directory for search.
Pattern - If pattern is given, only files whose names matched against it will be counted. Since version 3.8.314 it’s possible to invert the mask by prefixing this parameter with “!”. In this case files NOT maching the mask will be counted.
Recursive - determines if agent should count files in subdirectories. To enable recursion, use values
1
ortrue
.Size filter. If parameter < 0, only files with size less than abs(value) will match. If parameter > 0, only files with size greater than value will match.
Age filter. If parameter < 0, only files created after now - abs(value) will match. If parameter > 0, only files created before now - value will match.
Number of files in directory
The following macros are supported in path and pattern parameters:
Environment variables as ${ENV_VAR_NAME}
strftime(3C) macros
Text inside ` braces will be executed as a command and first line of output will be taken (only for servers which are in MasterServers in agent configuration file)
File.FolderCount(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path is the only mandatory argument. It specifies base directory for search.
Pattern - If pattern is given, only folders whose names matched against it will be counted.
Recursive - determines if agent should count folders in subdirectories. To enable recursion, use values
1
ortrue
.Size filter. If parameter < 0, only folders with size less than abs(value) will match. If parameter > 0, only folders with size greater than value will match.
Age filter. If parameter < 0, only folders created after now - abs(value) will match. If parameter > 0, only folders created before now - value will match.
Number of folders in directory
File.Hash.CRC32(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path - it specifies path to file
CRC32 hash of given file
The following macros are supported in path parameter:
Environment variables as ${ENV_VAR_NAME}
strftime(3C) macros
Text inside ` braces will be executed as a command and first line of output will be taken (only for servers which are in MasterServers in agent configuration file)
File.Hash.MD5(*)
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path - it specifies path to file
MD5 hash of given file
The following macros are supported in path parameter:
Environment variables as ${ENV_VAR_NAME}
strftime(3C) macros
Text inside ` braces will be executed as a command and first line of output will be taken (only for servers which are in MasterServers in agent configuration file)
File.Hash.SHA1(*)
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path - it specifies path to file
SHA1 hash of given file
The following macros are supported in path parameter:
Environment variables as ${ENV_VAR_NAME}
strftime(3C) macros
Text inside ` braces will be executed as a command and first line of output will be taken (only for servers which are in MasterServers in agent configuration file)
File.Size(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path is the only mandatory argument. It specifies either single file or base directory for calculation.
If pattern is given, only files whose names matched against it will be counted.
Recursive determines if agent should count files in subdirectories. To enable recursion, use values
1
ortrue
.Size filter. If parameter < 0, only files with size less than abs(value) will match. If parameter > 0, only files with size greater than value will match.
Age filter. If parameter < 0, only files created after now - abs(value) will match. If parameter > 0, only files created before now - value will match.
Size in bytes of single file or all files in given directory.
The following macros are supported in path and pattern parameters:
Environment variables as ${ENV_VAR_NAME}
strftime(3C) macros
Text inside ` braces will be executed as a command and first line of output will be taken (only for servers which are in MasterServers in agent configuration file)
File.Time.Access(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path - it specifies path to file
File’s last access time in seconds since epoch (1 Jan 1970 00:00:00 UTC)
The following macros are supported in path parameter:
Environment variables as ${ENV_VAR_NAME}
strftime(3C) macros
Text inside ` braces will be executed as a command and first line of output will be taken (only for servers which are in MasterServers in agent configuration file)
File.Time.Change(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path - it specifies path to file
File’s last status change time in seconds since epoch (1 Jan 1970 00:00:00 UTC)
The following macros are supported in path parameter:
Environment variables as ${ENV_VAR_NAME}
strftime(3C) macros
Text inside ` braces will be executed as a command and first line of output will be taken (only for servers which are in MasterServers in agent configuration file)
File.Time.Modify(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path - it specifies path to file
File’s last modification time in seconds since epoch (1 Jan 1970 00:00:00 UTC)
The following macros are supported in path parameter:
Environment variables as ${ENV_VAR_NAME}
strftime(3C) macros
Text inside ` braces will be executed as a command and first line of output will be taken (only for servers which are in MasterServers in agent configuration file)
File.Type(*)
Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path - it specifies path to file
Type of a file or directory. Returns one of the following values:
0 - file does not exist
1 - file is a directory
2 - file is a device
3 - file is a regular file
4 - file is of other type
The following macros are supported in path parameter:
Environment variables as ${ENV_VAR_NAME}
strftime(3C) macros
Text inside ` braces will be executed as a command and first line of output will be taken (only for servers which are in MasterServers in agent configuration file)
FileSystem.Avail(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Mountpoint, device name (linux only) or disk name (for Windows)
Available space on file system in bytes
FileSystem.AvailInodes(*)
TODO
FileSystem.AvailInodesPerc(*)
TODO
FileSystem.AvailPerc(*)
Data type: Float
Supported Platforms: Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Mountpoint, device name (linux only) or disk name (for Windows)
Percentage of available space on file system
FileSystem.Free(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Mountpoint, device name (linux only) or disk name (for Windows)
Free space on file system in bytes
FileSystem.FreeInodes(*)
TODO
FileSystem.FreeInodesPerc(*)
TODO
FileSystem.FreePerc(*)
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Mountpoint, device name (linux only) or disk name (for Windows)
Percentage of free space on file system
FileSystem.Total(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Mountpoint, device name (linux only) or disk name (for Windows)
Total number of bytes on file system
FileSystem.TotalInodes(*)
TODO
FileSystem.Type(*)
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Mountpoint or disk name (for Windows)
Type of file system
FileSystem.Used(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Mountpoint, device name (linux only) or disk name (for Windows)
Used space on file system in bytes
FileSystem.UsedInodes(*)
TODO
FileSystem.UsedInodesPerc(*)
TODO
FileSystem.UsedPerc(*)
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Mountpoint, device name (linux only) or disk name (for Windows)
Percentage of used space on file system
DRBD.ConnState(*)
TODO
DRBD.DataState(*)
TODO
DRBD.DeviceState(*)
TODO
DRBD.PeerDataState(*)
TODO
DRBD.PeerDeviceState(*)
TODO
DRBD.Protocol(*)
TODO
DRBD.Version.API
TODO
DRBD.Version.Driver
TODO
DRBD.Version.Protocol
TODO
Hardware.Baseboard.Manufacturer
TODO
Hardware.Baseboard.Product
TODO
Hardware.Baseboard.SerialNumber
TODO
Hardware.Baseboard.Type
TODO
Hardware.Baseboard.Version
TODO
Hardware.Battery.Capacity(*)
TODO
Hardware.Battery.Chemistry(*)
TODO
Hardware.Battery.Location(*)
TODO
Hardware.Battery.ManufactureDate(*)
TODO
Hardware.Battery.Manufacturer(*)
TODO
Hardware.Battery.Name(*)
TODO
Hardware.Battery.SerialNumber(*)
TODO
Hardware.Battery.Voltage(*)
TODO
Hardware.MemoryDevice.Bank(*)
TODO
Hardware.MemoryDevice.ConfiguredSpeed(*)
TODO
Hardware.MemoryDevice.FormFactor(*)
TODO
Hardware.MemoryDevice.Location(*)
TODO
Hardware.MemoryDevice.Manufacturer(*)
TODO
Hardware.MemoryDevice.MaxSpeed(*)
TODO
Hardware.MemoryDevice.PartNumber(*)
TODO
Hardware.MemoryDevice.SerialNumber(*)
TODO
Hardware.MemoryDevice.Size(*)
TODO
Hardware.MemoryDevice.Type(*)
TODO
Hardware.Processor.Cores(*)
TODO
Hardware.Processor.CurrentSpeed(*)
TODO
Hardware.Processor.Family(*)
TODO
Hardware.Processor.Manufacturer(*)
TODO
Hardware.Processor.MaxSpeed(*)
TODO
Hardware.Processor.PartNumber(*)
TODO
Hardware.Processor.SerialNumber(*)
TODO
Hardware.Processor.Socket(*)
TODO
Hardware.Processor.Threads(*)
TODO
Hardware.Processor.Type(*)
TODO
Hardware.Processor.Version(*)
TODO
Hardware.System.MachineId
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD
Unique machine identifier.
Hardware.System.Manufacturer
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD
System manufacturer.
Hardware.System.Product
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD
Product name.
Hardware.System.ProductCode
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD
Product code.
Hardware.System.SerialNumber
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD
System serial number.
Hardware.System.Version
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD
System version.
Hardware.WakeUpEvent
TODO
Hypervisor.Type
TODO
Hypervisor.Version
TODO
Net.Interface.AdminStatus(*)
Data type: Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Network interface administrative status (1 = enabled, 2 = disabled, 3 = testing)
Net.Interface.BytesIn(*)
Data type: Counter32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of input bytes on interface
Net.Interface.BytesIn64(*)
Data type: Counter64
Supported Platforms: Windows, Linux, FreeBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of input bytes on interface
Net.Interface.BytesOut(*)
Data type: Counter32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of output bytes on interface
Net.Interface.BytesOut64(*)
Data type: Counter64
Supported Platforms: Windows, Linux, FreeBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of output bytes on interface
Net.Interface.Description(*)
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Description of interface
Net.Interface.InErrors(*)
Data type: Counter32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of input errors on interface
Net.Interface.InErrors64(*)
Data type: Counter64
Supported Platforms: Windows, Linux, FreeBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of input errors on interface
Net.Interface.Link(*)
Data type: Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Link status of interface
Net.Interface.MTU(*)
Data type: Integer
Supported Platforms: Windows, AIX, HP-UX
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Net.Interface.OperStatus(*)
Data type: Integer
Supported Platforms: Windows, Linux, Solaris, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Network interface operational status (0 = down, 1 = up)
Net.Interface.OutErrors(*)
Data type: Counter32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of output errors on interface
Net.Interface.OutErrors64(*)
Data type: Counter64
Supported Platforms: Windows, Linux, FreeBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of output errors on interface
Net.Interface.PacketsIn(*)
Data type: Counter32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of input packets on interface
Net.Interface.PacketsIn64(*)
Data type: Counter64
Supported Platforms: Windows, Linux, FreeBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of input packets on interface
Net.Interface.PacketsOut(*)
Data type: Counter32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of output packets on interface
Net.Interface.PacketsOut64(*)
Data type: Counter64
Supported Platforms: Windows, Linux, FreeBSD
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Number of output packets on interface
Net.Interface.Speed(*)
Current interface working speed in bits per second.
Data type: UInt32
Supported Platforms: Windows, Linux, FreeBSD, Solaris, AIX, HP-UX
- Parameters:
Interface name or interface index. Index can be obtained from
Net.InterfaceList
list.
Net.IP.Forwarding
Data type: Int32
Supported Platforms: Windows, Linux, HP-UX, FreeBSD, NetBSD, OpenBSD
IP forwarding status (1 = forwarding, 0 = not forwarding)
Net.IP6.Forwarding
Data type: Int32
Supported Platforms: Linux, HP-UX, FreeBSD, NetBSD, OpenBSD
IPv6 forwarding status (1 = forwarding, 0 = not forwarding)
Net.IP.NextHop(*)
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Next hop for given destination address according to host’s routing table
Net.Resolver.AddressByName(*)
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Name to resolve
Resolves host name to IP address
Net.Resolver.NameByAddress(*)
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Address to resolve
Resolves IP address to host name
PDH.CounterValue(*)
Data type: UInt32
Supported Platforms: Windows
- Parameters:
Counter path. It should start with single backslash character and not include machine name.
Optional second argument specifies if counter requires two samples to calculate value (typical example of such counters is CPU utilization). Two samples will be taken if this argument is set to 1.
Current value of given PDH counter.
PDH.Version
Data type: UInt32
Supported Platforms: Windows
Version of PDH.DLL (as returned by PdhGetDllVersion() call).
PhysicalDisk.Capacity(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Linux, Windows
- Parameters:
Physical disk name. Run
smartctl --scan
(on Linux) orC:\NetXMS\bin\smartctl.exe --scan
(on Windows) to see list of available disk names.
Capacity in bytes of provided hard disk.
PhysicalDisk.DeviceType(*)
Data type: String
Supported Platforms: Linux, Windows
- Parameters:
Physical disk name
Device type of provided hard disk.
PhysicalDisk.Firmware(*)
Data type: String
Supported Platforms: Linux, Windows
- Parameters:
Physical disk name
Firmware version of provided hard disk.
PhysicalDisk.Model(*)
Data type: String
Supported Platforms: Linux, Windows
- Parameters:
Physical disk name
Model of provided hard disk.
PhysicalDisk.PowerCycles(*)
Data type: Unsigned integer
Supported Platforms: Linux, Windows
- Parameters:
Physical disk name
Number of power cycles of provided hard disk.
PhysicalDisk.PowerOnTime(*)
Data type: Unsigned integer
Supported Platforms: Linux, Windows
- Parameters:
Physical disk name
Power on time of provided hard disk.
PhysicalDisk.SerialNumber(*)
Data type: String
Supported Platforms: Linux, Windows
- Parameters:
Physical disk name
Serial number of provided hard disk.
PhysicalDisk.SmartAttr(*)
Data type: String
Supported Platforms: Linxu, Windows
- Parameters:
Physical disk name
SMART attribute name
PhysicalDisk.SmartStatus(*)
Data type: Integer
Supported Platforms: Linux, Windows
- Parameters:
Physical disk name
Status of provided hard disk reported by SMART.
PhysicalDisk.Temperature(*)
Data type: Integer
Supported Platforms: Linux, Windows
- Parameters:
Physical disk name
Temperature of provided hard disk.
Process.Count(*)
Data type: Int32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Process name
Number of processes with given name
Process.CountEx(*)
Data type: Int32
Supported Platforms: Windows, Linux, Solaris, FreeBSD, NetBSD, AIX
- Parameters:
Process name.
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s owner username regular expression. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Number of processes matching filter
Process.CPUTime(*)
Data type: Counter64
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s owner username regular expression. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Total execution time for process
Process.GDIObjects(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
GDI objects used by process
Process.Handles(*)
Data type: Int32
Supported Platforms: Windows, Linux, Solaris, AIX
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s owner username regular expression. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Number of handles in process with given name
Process.IO.OtherB(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Process.IO.OtherOp(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Process.IO.ReadB(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Process.IO.ReadOp(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, AIX, HP-UX
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Process.IO.WriteB(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Process.IO.WriteOp(*)
Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, AIX, HP-UX
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Process.KernelTime(*)
Data type: Counter64
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, NetBSD
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s owner username regular expression. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Total execution time in kernel mode for process
Process.PageFaults(*)
Data type: Counter64
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, NetBSD
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s owner username regular expression. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Page faults for process
Process.Syscalls(*)
Data type: UInt64
Supported Platforms: Solaris
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Number of system calls made by process
Process.Threads(*)
Data type: Int32
Supported Platforms: Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s owner username regular expression. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Number of threads in process
Process.UserObjects(*)
Data type: UInt64
Supported Platforms: Windows
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
USER objects used by process
Process.UserTime(*)
Data type: Counter64
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, NetBSD
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s owner username regular expression. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Total execution time in user mode for process
Process.VMRegions(*)
Data type: Int32
Supported Platforms: Linux
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s owner username regular expression. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Number of mapped virtual memory regions within process with given name
Process.VMSize(*)
Data type: Int64
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s owner username regular expression. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Virtual memory used by process
Process.WkSet(*)
Data type: Int64
Supported Platforms: Windows, Linux, Solaris, HP-UX, FreeBSD, NetBSD
- Parameters:
Process name
Function - is the function that is used to measure data in case if there are more than one process with given name. By default it is used sum function. This parameter can have this options:
min - minimal value among all processes named proc
max - maximal value among all processes named proc
avg - average value for all processes named proc
sum - sum of values for all processes named proc
Optional parameter that accepts process’s command line regular expression, that should match cmd argument. If not set it means “match any”.
Optional parameter that accepts process’s owner username regular expression. If not set it means “match any”.
Optional parameter that accepts process’s main window title regular expression. If not set it means “match any”. Process’s window title can be checked only on Windows platform.
Physical memory used by process
System.AppAddressSpace
Data type: UInt32
Supported Platforms: Windows
Address space available to applications (MB)
System.BIOS.Date
Data type: String
Supported Platforms: Windows, Linux, Solaris, FreeBSD
BIOS date.
System.BIOS.Vendor
Data type: String
Supported Platforms: Windows, Linux, Solaris, FreeBSD
BIOS vendor.
System.BIOS.Version
Data type: String
Supported Platforms: Windows, Linux, Solaris, FreeBSD
BIOS version.
System.ConnectedUsers
Data type: Int32
Supported Platforms: Windows, Linux
Number of users connected to system
System.CPU.Count
Data type: Int32
Supported Platforms: Windows, Linux, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, MacOS
Number of CPUs in the system
System.CPU.LoadAvg
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD, MacOS
CPU load average for last minute
Note
On Windows this metric is provided by winperf subagent
System.CPU.LoadAvg5
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD, MacOS
CPU load average for last 5 minutes
Note
On Windows this metric is provided by winperf subagent
System.CPU.LoadAvg15
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD, MacOS
CPU load average for last 15 minutes
Note
On Windows this metric is provided by winperf subagent
System.CPU.Usage
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, MacOS
Average CPU usage for last minute (percents, all CPUs)
Note
On Windows this metric is provided by winperf subagent
System.CPU.Usage(*)
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage for last minute (percents, specific CPU)
Note
On Windows this metric is provided by winperf subagent
System.CPU.Usage5
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, MacOS
Average CPU usage for last 5 minutes (percents, all CPUs)
Note
On Windows this metric is provided by winperf subagent
System.CPU.Usage5(*)
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage for last 5 minutes (percents, specific CPU)
Note
On Windows this metric is provided by winperf subagent
System.CPU.Usage15
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, MacOS
Average CPU usage for last 15 minutes (percents, all CPUs)
Note
On Windows this metric is provided by winperf subagent
System.CPU.Usage15(*)
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage for last 15 minutes (percents, specific CPU)
Note
On Windows this metric is provided by winperf subagent
System.CPU.Usage.Idle
Data type: Float
Supported Platforms: Linux, AIX, MacOS
Average CPU usage (IDLE) for last minute (percents, all CPUs)
System.CPU.Usage.Idle(*)
Data type: Float
Supported Platforms: Linux, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (IDLE) for last minute (percents, specific CPU)
System.CPU.Usage5.Idle
Data type: Float
Supported Platforms: Linux, AIX, MacOS
Average CPU usage (IDLE) for last 5 minutes (percents, all CPUs)
System.CPU.Usage5.Idle(*)
Data type: Float
Supported Platforms: Linux, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (IDLE) for last 5 minutes (percents, specific CPU)
System.CPU.Usage15.Idle
Data type: Float
Supported Platforms: Linux, AIX, MacOS
Average CPU usage (IDLE) for last 15 minutes (percents, all CPUs)
System.CPU.Usage15.Idle(*)
Data type: Float
Supported Platforms: Linux, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (IDLE) for last 15 minutes (percents, specific CPU)
System.CPU.Usage.IOWait
Data type: Float
Supported Platforms: Linux, AIX
Average CPU usage (IOWAIT) for last minute (percents, all CPUs)
System.CPU.Usage.IOWait(*)
Data type: Float
Supported Platforms: Linux, AIX
- Parameters:
Zero-based index of CPU.
Average CPU usage (IOWAIT) for last minute (percents, specific CPU)
System.CPU.Usage5.IOWait
Data type: Float
Supported Platforms: Linux, AIX
Average CPU usage (IOWAIT) for last 5 minutes (percents, all CPUs)
System.CPU.Usage5.IOWait(*)
Data type: Float
Supported Platforms: Linux, AIX
- Parameters:
Zero-based index of CPU.
Average CPU usage (IOWAIT) for last 5 minutes (percents, specific CPU)
System.CPU.Usage15.IOWait
Data type: Float
Supported Platforms: Linux, AIX
Average CPU usage (IOWAIT) for last 15 minutes (percents, all CPUs)
System.CPU.Usage15.IOWait(*)
Data type: Float
Supported Platforms: Linux, AIX
- Parameters:
Zero-based index of CPU.
Average CPU usage (IOWAIT) for last 15 minutes (percents, specific CPU)
System.CPU.Usage.IRQ
Data type: Float
Supported Platforms: Linux
Average CPU usage (IRQ) for last minute (percents, all CPUs)
System.CPU.Usage.IRQ(*)
Data type: Float
Supported Platforms: Linux
- Parameters:
Zero-based index of CPU.
Average CPU usage (IRQ) for last minute (percents, specific CPU)
System.CPU.Usage5.IRQ
Data type: Float
Supported Platforms: Linux
Average CPU usage (IRQ) for last 5 minutes (percents, all CPUs)
System.CPU.Usage5.IRQ(*)
Data type: Float
Supported Platforms: Linux
- Parameters:
Zero-based index of CPU.
Average CPU usage (IRQ) for last 5 minutes (percents, specific CPU)
System.CPU.Usage15.IRQ
Data type: Float
Supported Platforms: Linux
Average CPU usage (IRQ) for last 15 minutes (percents, all CPUs)
System.CPU.Usage15.IRQ(*)
Data type: Float
Supported Platforms: Linux
- Parameters:
Zero-based index of CPU.
Average CPU usage (IRQ) for last 15 minutes (percents, specific CPU)
System.CPU.Usage.Nice
Data type: Float
Supported Platforms: Linux, MacOS
Average CPU usage (NICE) for last minute (percents, all CPUs)
System.CPU.Usage.Nice(*)
Data type: Float
Supported Platforms: Linux, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (NICE) for last minute (percents, specific CPU)
System.CPU.Usage5.Nice
Data type: Float
Supported Platforms: Linux, MacOS
Average CPU usage (NICE) for last 5 minutes (percents, all CPUs)
System.CPU.Usage5.Nice(*)
Data type: Float
Supported Platforms: Linux, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (NICE) for last 5 minutes (percents, specific CPU)
System.CPU.Usage15.Nice
Data type: Float
Supported Platforms: Linux, MacOS
Average CPU usage (NICE) for last 15 minutes (percents, all CPUs)
System.CPU.Usage15.Nice(*)
Data type: Float
Supported Platforms: Linux, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (NICE) for last 15 minutes (percents, specific CPU)
System.CPU.Usage.SoftIRQ
Data type: Float
Supported Platforms: Linux
Average CPU usage (SOFTIRQ) for last minute (percents, all CPUs)
System.CPU.Usage.SoftIRQ(*)
Data type: Float
Supported Platforms: Linux
- Parameters:
Zero-based index of CPU.
Average CPU usage (SOFTIRQ) for last minute (percents, specific CPU)
System.CPU.Usage5.SoftIRQ
Data type: Float
Supported Platforms: Linux
Average CPU usage (SOFTIRQ) for last 5 minutes (percents, all CPUs)
System.CPU.Usage5.SoftIRQ(*)
Data type: Float
Supported Platforms: Linux
- Parameters:
Zero-based index of CPU.
Average CPU usage (SOFTIRQ) for last 5 minutes (percents, specific CPU)
System.CPU.Usage15.SoftIRQ
Data type: Float
Supported Platforms: Linux
Average CPU usage (SOFTIRQ) for last 15 minutes (percents, all CPUs)
System.CPU.Usage15.SoftIRQ(*)
Data type: Float
Supported Platforms: Linux
- Parameters:
Zero-based index of CPU.
Average CPU usage (SOFTIRQ) for last 15 minutes (percents, specific CPU)
System.CPU.Usage.Steal
Data type: Float
Supported Platforms: Linux
Average CPU usage (STEAL) for last minute (percents, all CPUs)
System.CPU.Usage.Steal(*)
Data type: Float
Supported Platforms: Linux
- Parameters:
Zero-based index of CPU.
Average CPU usage (STEAL) for last minute (percents, specific CPU)
System.CPU.Usage5.Steal
Data type: Float
Supported Platforms: Linux
Average CPU usage (STEAL) for last 5 minutes (percents, all CPUs)
System.CPU.Usage5.Steal(*)
Data type: Float
Supported Platforms: Linux
- Parameters:
Zero-based index of CPU.
Average CPU usage (STEAL) for last 5 minutes (percents, specific CPU)
System.CPU.Usage15.Steal
Data type: Float
Supported Platforms: Linux
Average CPU usage (STEAL) for last 15 minutes (percents, all CPUs)
System.CPU.Usage15.Steal(*)
Data type: Float
Supported Platforms: Linux
- Parameters:
Zero-based index of CPU.
Average CPU usage (STEAL) for last 15 minutes (percents, specific CPU)
System.CPU.Usage.System
Data type: Float
Supported Platforms: Linux, AIX, MacOS
Average CPU usage (SYSTEM) for last minute (percents, all CPUs)
System.CPU.Usage.System(*)
Data type: Float
Supported Platforms: Linux, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (SYSTEM) for last minute (percents, specific CPU)
System.CPU.Usage5.System
Data type: Float
Supported Platforms: Linux, AIX, MacOS
Average CPU usage (SYSTEM) for last 5 minutes (percents, all CPUs)
System.CPU.Usage5.System(*)
Data type: Float
Supported Platforms: Linux, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (SYSTEM) for last 5 minutes (percents, specific CPU)
System.CPU.Usage15.System
Data type: Float
Supported Platforms: Linux, AIX, MacOS
Average CPU usage (SYSTEM) for last 15 minutes (percents, all CPUs)
System.CPU.Usage15.System(*)
Data type: Float
Supported Platforms: Linux, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (SYSTEM) for last 15 minutes (percents, specific CPU)
System.CPU.Usage.User
Data type: Float
Supported Platforms: Linux, AIX, MacOS
Average CPU usage (USER) for last minute (percents, all CPUs)
System.CPU.Usage.User(*)
Data type: Float
Supported Platforms: Linux, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (USER) for last minute (percents, specific CPU)
System.CPU.Usage5.User
Data type: Float
Supported Platforms: Linux, AIX, MacOS
Average CPU usage (USER) for last 5 minutes (percents, all CPUs)
System.CPU.Usage5.User(*)
Data type: Float
Supported Platforms: Linux, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (USER) for last 5 minutes (percents, specific CPU)
System.CPU.Usage15.User
Data type: Float
Supported Platforms: Linux, AIX, MacOS
Average CPU usage (USER) for last 15 minutes (percents, all CPUs)
System.CPU.Usage15.User(*)
Data type: Float
Supported Platforms: Linux, AIX, MacOS
- Parameters:
Zero-based index of CPU.
Average CPU usage (USER) for last 15 minutes (percents, specific CPU)
System.CPU.VendorId
Data type: String
Supported Platforms: Windows, Linux, FreeBSD
CPU vendor ID.
System.CurrentTime
Data type: Float
Supported Platforms: Windows, Linux
Current system time
System.CurrentTime.ISO8601.Local
Data type: String
Supported Platforms: Windows, Linux
Current system local time in ISO 8601 format
System.CurrentTime.ISO8601.UTC
Data type: String
Supported Platforms: Windows, Linux
Current system UTC time in ISO 8601 format
System.HandleCount
Data type: Int32
Supported Platforms: Windows, Linux, Solaris, AIX
Total handles count at the moment
System.Hostname
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Host name
System.IO.BytesReadRate
Data type: Int64
Supported Platforms: Linux, Solaris, AIX, HP-UX
Average number of bytes read per second for last minute
System.IO.BytesReadRate(*)
Data type: Int64
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Device name
Average number of bytes read per second on specific device for last minute
System.IO.BytesWriteRate
Data type: Int64
Supported Platforms: Linux, Solaris, AIX, HP-UX
Average number of bytes written per second for last minute
System.IO.BytesWriteRate(*)
Data type: Int64
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Device name
Average number of bytes written per second on specific device for last minute
System.IO.DiskQueue
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX
Average disk queue length for last minute
Note
On Windows this metric is provided by winperf subagent
System.IO.DiskQueue(*)
Data type: Float
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Device name
Average disk queue length for last minute for specific device
System.IO.DiskTime
Data type: Float
Supported Platforms: Windows, Linux
Average disk busy time for last minute (percents)
Note
On Windows this metric is provided by winperf subagent
System.IO.DiskTime(*)
Data type: Float
Supported Platforms: Linux
- Parameters:
Device name
Average disk busy time for last minute for specific device (percents)
System.IO.ReadRate
Data type: Float
Supported Platforms: Linux, Solaris, AIX, HP-UX
Average number of read operations per second for last minute
System.IO.ReadRate(*)
Data type: Float
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Device name
Average number of read operations per second on specific device for last minute
System.IO.TransferRate
Data type: Float
Supported Platforms: AIX, HP-UX
Average number of data transfers per second for last minute
System.IO.TransferRate(*)
Data type: Float
Supported Platforms: AIX, HP-UX
- Parameters:
Device name
Average number of data transfers per second on specific device for last minute
System.IO.OpenFiles
Data type: Int32
Supported Platforms: HP-UX
Number of open files
System.IO.WaitTime
Data type: UInt32
Supported Platforms: AIX, HP-UX
Average I/O wait time in milliseconds for last minute
System.IO.WaitTime(*)
Data type: UInt32
Supported Platforms: AIX, HP-UX
- Parameters:
Device name
Average I/O wait time on specific device in milliseconds for last minute
System.IO.WriteRate
Data type: Float
Supported Platforms: Linux, Solaris, AIX, HP-UX
Average number of write operations per second for last minute
System.IO.WriteRate(*)
Data type: Float
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Device name
Average number of write operations per second on specific device for last minute
System.IsVirtual
Data type: Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Virtual system indicator. Returns 1 if system is virtual, 0 if not.
System.KStat(*)
Data type: Undefined
Supported Platforms: Solaris
- Parameters:
Module
Instance
Name
Statistic
Solaris kstat data. More information can be found in kstat man.
System.Memory.Physical.Available
Data type: UInt64
Supported Platforms: Linux
Available physical memory in bytes
System.Memory.Physical.AvailablePerc
Data type: Float
Supported Platforms: Linux
Percentage of available physical memory
System.Memory.Physical.Buffers
Data type: UInt64
Supported Platforms: Linux
Physical memory used for buffers.
System.Memory.Physical.BuffersPerc
Data type: Float
Supported Platforms: Linux
Percentage of physical memory used for buffers.
System.Memory.Physical.Cached
Data type: UInt64
Supported Platforms: Linux
Physical memory used for cache.
System.Memory.Physical.CachedPerc
Data type: Float
Supported Platforms: Linux
Percentage of physical memory used for cache.
System.Memory.Physical.Free
Data type: UInt64
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Free physical memory in bytes
System.Memory.Physical.FreePerc
Data type: Uint
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD
Percentage of free physical memory
System.Memory.Physical.Total
Data type: UInt64
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Total amount of physical memory in bytes
System.Memory.Physical.Used
Data type: UInt64
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Used physical memory in bytes
System.Memory.Physical.UsedPerc
Data type: Float
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD
Percentage of used physical memory
System.Memory.Swap.Free
Data type: UInt64
Supported Platforms: Linux, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Free swap space in bytes
System.Memory.Swap.FreePerc
Data type: Float
Supported Platforms: Linux, AIX, HP-UX, FreeBSD
Percentage of free swap space
System.Memory.Swap.Total
Data type: UInt64
Supported Platforms: Linux, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Total amount of swap space in bytes
System.Memory.Swap.Used
Data type: UInt64
Supported Platforms: Linux, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Used swap space in bytes
System.Memory.Swap.UsedPerc
Data type: Float
Supported Platforms: Linux, AIX, HP-UX, FreeBSD
Percentage of used swap space
System.Memory.Virtual.Active
Data type: UInt64
Supported Platforms: AIX
Active virtual memory
System.Memory.Virtual.ActivePerc
Data type: Float
Supported Platforms: AIX
Percentage of active virtual memory
System.Memory.Virtual.Free
Data type: UInt64
Supported Platforms: Windows, Linux, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Free virtual memory in bytes
System.Memory.Virtual.FreePerc
Data type: Float
Supported Platforms: Windows, Linux, AIX, HP-UX, FreeBSD
Percentage of free virtual memory
System.Memory.Virtual.Total
Data type: UInt64
Supported Platforms: Windows, Linux, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Total amount of virtual memory in bytes
System.Memory.Virtual.Used
Data type: UInt64
Supported Platforms: Windows, Linux, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Used virtual memory in bytes
System.Memory.Virtual.UsedPerc
Data type: Float
Supported Platforms: Windows, Linux, AIX, HP-UX, FreeBSD
Percentage of used virtual memory
System.MsgQueue.Bytes(*)
Data type: UInt64
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Queue ID or key
Bytes in given message queue.
System.MsgQueue.BytesMax(*)
Data type: UInt64
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Queue ID or key
Maximum allowed bytes in given message queue.
System.MsgQueue.ChangeTime(*)
Data type: UInt64
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Queue ID or key
Time of the last change for given message queue.
System.MsgQueue.Messages(*)
Data type: UInt
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Queue ID or key
Number of messages in given message queue.
System.MsgQueue.RecvTime(*)
Data type: UInt64
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Queue ID or key
Last recieved message time in given message queue.
System.MsgQueue.SendTime(*)
Data type: UInt64
Supported Platforms: Linux, Solaris, AIX, HP-UX
- Parameters:
Queue ID or key
Last sent message time in given message queue.
System.OS.Build
Data type: String
Supported Platforms: Windows, Linux, FreeBSD
Operating system build.
Note
Might be not available on some Linux family platforms.
System.OS.LicenseKey
Data type: String
Supported Platforms: Windows
Operating system license key.
System.OS.ProductId
Data type: String
Supported Platforms: Windows
Operating system ID.
System.OS.ProductName
Data type: String
Supported Platforms: Windows, Linux, AIX, FreeBSD, Solaris
Operating system name.
System.OS.ProductType
Data type: String
Supported Platforms: Windows, Linux, FreeBSD
Operating system type.
Note
Might be not available on some Linux family platforms.
System.OS.ServicePack
Data type: String
Supported Platforms: Windows, AIX
Operating system service pack.
System.OS.Version
Data type: String
Supported Platforms: Windows, Linux, AIX, FreeBSD, Solaris
Operating system version.
System.PlatformName
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Unified platform name (used by agent upgrade component)
System.ProcessCount
Data type: UInt32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Total number of processes in system
System.ServiceState(*)
Data type: Int32
Supported Platforms: Windows
- Parameters:
Windows service name
- State of system service. Possible values:
0 - service running
1 - service paused
2 - service starting (start pending)
3 - service pausing (pause pending)
4 - service starting after pause (continue pending)
5 - service stopping (stop pending)
6 - service stopped
255 - unable to get current service state
System.ThreadCount
Data type: UInt32
Supported Platforms: Windows, Linux, AIX, FreeBSD, NetBSD
Total number of threads in system
System.TimeZone
Data type: String
Supported Platforms: Windows, Linux
System time zone offset and name
System.TimeZoneOffset
Data type: Int32
Supported Platforms: Windows, Linux
System time zone offset from UTC time
System.Uname
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Output of uname command
System.Uptime
Data type: Int32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Number of seconds since system boot
Note
On Windows this metric is provided by winperf subagent
X509.Certificate.ExpirationDate
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path to the certificate file.
Expiration date (YYYY-MM-DD) of X.509 certificate from provided file.
X509.Certificate.ExpirationTime
Data type: UInt64
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path to the certificate file.
Expiration date in UNIX timestamp format.
X509.Certificate.ExpiresIn
Data type: Int32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path to the certificate file.
Days until expiration of X.509 certificate from provided file.
X509.Certificate.Issuer
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path to the certificate file.
Issuer of X.509 certificate from provided file.
X509.Certificate.Subject
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path to the certificate file.
Subject of X.509 certificate from provided file.
X509.Certificate.TemplateID
Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
- Parameters:
Path to the certificate file.
Template ID of X.509 certificate from provided file.
List metrics
DRBD.DeviceList
Data type: List of String
Supported Platforms: Linux
List of configured DRBD devices
FileSystem.MountPoints
Data type: List of String
Supported Platforms: Linux, Windows, Solaris, AIX, FreeBSD
Currently available mount points
Hardware.Batteries
Data type: List of String
Supported Platforms: Linux, Windows, Solaris
Information about batteries installed on the device
Hardware.MemoryDevices
Data type: List of String
Supported Platforms: Linux, Windows, Solaris
Information about available memory devices
Hardware.Processors
Data type: List of String
Supported Platforms: Windows
Information about available processors
Hardware.StorageDevices
Data type: List of String
Supported Platforms: Windows
Information about available storage devices
LVM.LogicalVolumes
Data type: List of String
Supported Platforms: AIX
Logical Volume Manager information - all logical volumes
LVM.LogicalVolumes(*)
Data type: List of String
Supported Platforms: AIX
Logical Volume Manager information - logical volumes of the specified volume group
LVM.PhysicalVolumes
Data type: List of String
Supported Platforms: AIX
Logical Volume Manager information - all physical volumes
LVM.PhysicalVolumes(*)
Data type: List of String
Supported Platforms: AIX
- Parameters:
Volume group name.
Logical Volume Manager information - physical volumes of the specified volume group
LVM.VolumeGroups
Data type: List of String
Supported Platforms: AIX
Logical Volume Manager information - volume groups’ names
Net.ArpCache
Data type: List of String
Supported Platforms: Linux, Windows, FreeBSD
Local ARP cache
Net.InterfaceList
Data type: List of String
Supported Platforms: Linux, Windows, Solaris, AIX, FreeBSD
Interface index, IP address, subnet mask, type, maximum transmission unit, MAC address and name
The format is: [index] [IP]/[mask] [type]([MTU]) [MAC] [name]
Net.InterfaceNames
Data type: List of String
Supported Platforms: Linux, Windows, Solaris, AIX, FreeBSD
Names of available interfaces
Net.IP.RoutingTable
Data type: List of String
Supported Platforms: Linux, Windows, FreeBSD
IP routing table
System.ActiveUserSessions
Data type: List of String
Supported Platforms: Linux, Windows
Currently active user sessions
System.Desktops(*)
Data type: List of String
Supported Platforms: Windows
Currently active desktops
System.IO.Devices
Data type: List of String
Supported Platforms: Linux, Windows
Currently available input and output devices’ names
System.ProcessList
Data type: List of String
Supported Platforms: Linux, Windows, Solaris, AIX, FreeBSD
Running processes’ names
System.Services
Data type: List of String
Supported Platforms: Windows
Running services’ names
System.WindowStations
Supported Platforms: Windows
Window stations’ names
Table metrics
Note
Columns marked with * are instance columns (primary keys). Such columns (or combination of columns) are designated to uniquely identify each table record.
FileSystem.Volumes
Supported Platforms: Linux, Windows, Solaris, AIX
Column name |
Data type |
---|---|
Mount Point * |
String |
Volume |
String |
Label |
String |
FS Type |
String |
Total |
UInt64 |
Free |
UInt64 |
Free % |
Float |
Available |
UInt64 |
Available % |
Float |
Used |
UInt64 |
Used % |
Float |
Available file system volumes
Hardware.Batteries
Supported Platforms: Linux, Windows, Solaris
Column name |
Data type |
---|---|
Handle * |
Int32 |
Name |
String |
Location |
String |
Capacity |
Uint32 |
Voltage |
UInt32 |
Chemistry |
String |
Manufacturer |
String |
Manufacture Date |
String |
Serial Number |
String |
Hardware information about batteries installed on the device
Hardware.MemoryDevices
Supported Platforms: Linux, Windows, Solaris
Column name |
Data type |
---|---|
Handle * |
Int32 |
Location |
String |
Bank |
String |
Form factor |
String |
Type |
String |
Size |
Uint64 |
Max Speed |
Uint64 |
Configured Speed |
Uint64 |
Manufacturer |
String |
Part Number |
String |
Serial Number |
String |
Hardware information about available memory devices
Hardware.NetworkAdapters
Supported Platforms: Linux, Windows
Column name |
Data type |
---|---|
Index * |
UInt32 |
Product |
String |
Manufacturer |
String |
Description |
String |
Type |
String |
MAC address |
String |
Interface index |
UInt32 |
Speed |
UInt64 |
Availability |
UInt32 |
Hardware information about available network adapters
Hardware.Processors
Supported Platforms: Linux, Windows, Solaris
Column name |
Data type |
---|---|
Handle * |
Int32 |
Type |
String |
Family |
String |
Version |
String |
Socket |
String |
Cores |
UInt32 |
Threads |
UInt32 |
Max Speed |
UInt64 |
Current Speed |
UInt64 |
Manufacturer |
String |
Part Number |
String |
Serial Number |
String |
Hardware information about available processors
Hardware.StorageDevices
Supported Platforms: Linux, Windows
Column name |
Data type |
---|---|
Number * |
UInt32 |
Type |
UInt32 |
Type description |
String |
Bus type |
String |
Removable |
Int32 |
Size |
UInt64 |
Manufacturer |
String |
Product |
String |
Revision |
String |
Serial number |
String |
Hardware information about available storage devices
System.ActiveUserSessions
Supported Platforms: Windows
Column name |
Data type |
---|---|
ID * |
UInt32 |
User name |
String |
Terminal |
String |
State |
String |
Client name |
String |
Client address |
String |
Client display |
String |
Connect time |
UInt64 |
Logon time |
UInt64 |
Idle for |
UInt32 |
Currently active user sessions
System.InstalledProducts
Supported Platforms: Linux, Windows, Solaris, AIX, FreeBSD
Column name |
Data type |
---|---|
Name * |
String |
Version |
String |
Vendor |
String |
Install Date |
String |
URL |
String |
Description |
String |
Products installed on the system
System.OpenFiles
Supported Platforms: Linux
Column name |
Data type |
---|---|
PID * |
UInt32 |
Process |
String |
Handle * |
UInt32 |
Name |
String |
Files opened by processes
System.Processes
Supported Platforms: Linux, Windows, Solaris, AIX, FreeBSD
Column name |
Data type |
---|---|
PID * |
UInt32 |
Name |
String |
User |
String |
Threads |
UInt32 |
Handles |
UInt32 |
Kernel Time |
UInt64 |
User Time |
UInt64 |
VM Size |
UInt64 |
RSS |
UInt64 |
Page Faults |
UInt64 |
Command Line |
String |
Running processes information
System.Services
Supported Platforms: Windows
Column name |
Data type |
---|---|
Name * |
String |
Display name |
String |
Type |
String |
State |
String |
Startup |
String |
Run As |
String |
PID |
UInt32 |
Binary |
String |
Dependencies |
String |
Running services information