Named properties

Named Check Properties

General information

Every check has a set of configuration properties. For example, it can be host address, description, etc.Sometimes you can use special macros to access special dynamic information in checks. Suppose you have a script alert and want it to perform some specific operation(s) on a remote host, if the IP ping check is failed. Apparently, inside your script alert you should access the 'Address' property of the check. Otherwise, you will have to change the address manually for every check after you paste the alert from the alert repository. It is not very convenient, especially in case you have to configure dozens of checks like that. In the above case you should specify the macro %Address% in your script alert in the alert repository it will be replaced with the value of the check property named Address each time the alert is actvated. Below you can find the complete description of all check properties you can use as macros.

Another way to determine what properties are supported by a particular check is to export its data to XML and see the name attribute in the property nodes of this check:

<Property id="4121" name="Description" type="bstr" value="Network Eagle Home Page"/>

Syntax definition

The general syntax of macros representing named properties is the following: <%Property-name%>. Note that Property-name is case-sensitive.

Common properties

These properties are common for all types of checks.
NameDescription
TypeIDIntegral type identifier. Each check has its own unique type identifier.
TypenameThe mnemonic name of the check. Unique.
 
AddressThe remote host address entered on the general page of check settings.
DescriptionThe check description provided by the user.
LastErrorThe description of the last check error.
IntervalInterval in seconds.
TimeoutCheck timeout.
RetryCountThe number of attempts.
 
ThreadAuthRequiredIndicates whether this check needs some special thread authentication to impersonate another user's privileges
UserDomainUser domain, for thread impersonation.
UserNameUser name, for thread impersonation. The check will be run with this user's privileges if authentication is successful.
UserPassUser password, for thread impersonation.

Type-specific check properties

Each type of checks has its own property set, which can be accessed as described in the general information section of this article.

Follow the link to jump directly to the corresponding check type.

Ping check

NameDescription
There are no special properties for ping checks.

TCP Port check

NameDescription
PortTCP Port Number
PortNameTCP Port name (if available). For example: POP3, IMAP4, etc.

FTP link check

NameDescription
SecuredA boolean value that indicates whether the FTP server accepts anonymous logins or not.
UsernameFTP server username.
PasswordFTP server password.
FilepathThe path component of the FTP URL. For example: /upload/test.zip
PortThe TCP port where the FTP server is installed.

HTTP link check

NameDescription
URLThe path component of the HTTP URL. For example: /cgi-bin/script.cgi
PortThe TCP port where HTTP server is installed.
SecuredIs the HTTP URL secured?
UsernameIf the HTTP URL is secured, this is the username for logging in.
PasswordIf the HTTP URL secured, this is the password for logging in.
UseProxyA boolean value that indicates if this check should use an HTTP proxy to connect to the target host.
ProxyAddressThe address of the HTTP proxy server.
ProxyPortThe TCP Port where the HTTP proxy is located.
ProxyUserIf the HTTP proxy needs authorization, this is the proxy username.
ProxyPassIf the HTTP proxy needs authorization, this is the proxy password.
Accept302Accept redirection replies (HTTP 302) as success.

Disk space check

NameDescription
SizeLowFloating-point size value. See also the SizeType property.
FailCondition Possible values:

  • 0 - Error if Less Then
  • 1 - Error if More Then
  • ResourceNameThe name of a network share or a local directory.
    SizeType Possible values:

  • 0 - Size in bytes.
  • 1 - Size in kilobytes.
  • 2 - Size in megabytes.
  • 3 - Size in gigabytes.
  • External command check

    NameDescription
    CommandThe external command that should be run when the check is activated.
    UseStartupDirShould the startup directory parameter be used?
    DirectoryThe startup directory where the command should be run.
    CheckType Possible values:

  • 0 - Fail if less than.
  • 1 - Fail if more than.
  • 2 - Fail if equal.
  • 3 - Fail if not equal.
  • ErrorLevelThe error level value to compare with the exit code returned by the command. See the CheckType property for more information.
    Priority Execute the command with this priority.

  • 0 - High priority.
  • 1 - Normal priority.
  • 2 - Idle priority.
  • WndShowStateApplication window status. See the documentation for the ShowWindow Windows API function to get more information.
    HideConsoleIndicates whether to hide the console window for console applications.
    TerminateOnStoppageIndicates whether to exit the external application when the check is stopped.

    Database check

    NameDescription
    EngineTypeDatabase engine type.
    DatabaseNameDatabase name.
    LoginNameThe username for logging into the database engine.
    PasswordThe password for logging into the database engine
    SQLThe SQL statement to be run in order to test the availability of the database engine. It can be empty if the user wants to test only the connection to the database.
    WindowsSecurityIndicates whether Windows security should be used when the user currently logged on connects to the database (for example, this option is valid for the MS SQL engine).
    RunSQLIndicates that the SQL property is not empty and the SQL query in it should be run after a connection to the database is established.
    FailIfNoRecordsIndicates whether the check should be failed if the returned result set is empty.
    CheckTypeThe check type for the first cell of the first row in the result set entered by user. Checking the result depends both on this property and on DBResult property.
    DBResultUser-defined value. Checking the result depends both on this property and on the CheckType property.

    Besides the above properties, you can use data from the database as named properties. For example, you run some database query and some result set is fetched by Network Eagle. In this case, regardless of checking the value in first column of the first row, the following named properties will be available in alerts:
    <%Field_result-set-field-name%>. Here result-set-field-name is the name of a column in the returned result set. Note that only the first row of the returned database result set is mapped as named properties.

    For example, you enter the query: select Name, LogMessage, TimeStamp from Log order by TimeStamp DESC.
    In this case you can access the first row of this rowset (the last log message) in your alerts using the following pseudo-macros:
    <%Field_Name%>
    <%Field_LogMessage%>
    <%Field_TimeStamp%>
    All values will be automatically converted into the string values using the rules of ODBC or the native database engine.

    Script check

    NameDescription
    ScriptLanguageScript language name.
    SourceCodeScript source code.
    MainFunctionScript main function.

    Process check

    NameDescription
    ProcessNameProcess image name.
    ProcessIDProcess identifier (PID).
    CheckByProcess check type. See the Process Check help page.

    Event Log check

    NameDescription
    FileNameThe file name of the source Event Log.
    UseEventIDUse Event ID as a filtering criterion.
    EventIDEvent Log message identifier.
    UseEventSrcUse Event source as a filtering criterion.
    EventSrcEvent Log message source.
    UseEventCatUse Event category as a filtering criterion.
    EventCatEvent Log message category.
    UseEventDescrUse Event description as a filtering criterion.
    EventDescrEvent Log message description
    DescrSearchTypeDescription search type. See the Event Log check section for more detailed information.
    TypeErrorInclude an event with the type Error into the search criteria.
    TypeSucessInclude event with type Success into the search criteria.
    TypeInfoInclude an event with the type Informational into the search criteria.
    TypeWarningInclude an event with the type Warning into the search criteria.
    TypeAFailInclude an event with the type Audit Failure into the search criteria.
    TypeASuccessInclude an event with the type Audit Success into the search criteria.

    Windows service check

    NameDescription
    ServiceNameThe name of the service that should be checked.
    FailCondition The check is failed if the service is:

  • 0 - Running.
  • 1 - Stopped.
  • 2 - Paused.
  • See Also

    Alert Environment Window,
    System Environment Variables,
    Global Variables,