SYS_SNMP_ACTIVE

Use the SYS_SNMP_ACTIVE script function to check whether the SNMP (Simple Network Management Protocol) connection of the Automation Engine is active. For more information, see SNMP Support.

Thr function returns what is really configured in the ucsrv.ini file.

if snmp=0 is set in the ini file SYS_SNMP_ACTIVE will give 'N'.

The status of the SNMP agent is not considered, if the SNMP Subagent is configured but not running it will still give 'Y'

Syntax

SYS_SNMP_ACTIVE ()

Return Codes

The script function has the following return codes:

Y
The SNMP connection of the AE is active
N
The SNMP connection of the AE is inactive

The function returns the actual configuration in the AE INI file (ucsrv.ini). That means that, if the snmp= parameter in the INI file is set to 0, this function returns N.

The status of the SNMP agent is not considered. If the SNMP Subagent is configured but not running, it will still return Y.

Example

The following script checks if the SNMP connection is active, and prints the result in the activation report.

:SET &RET# = SYS_SNMP_ACTIVE()
:PRINT &RET#