Important This documentation space contains information about PATROL Agents when deployed in a TrueSight Operations Management environment. If you are a BMC Helix Operations Management user, see PATROL Agent 22.1 for BMC Helix Operations Management.

snmp_agent_stop()


Stop the PATROL SNMP Sub-Agent.

Syntax

snmp_agent_stop()

Parameter

This function does not accept any parameters.

Description

The snmp_agent_stop() function stops the PATROL SNMP Sub-Agent if it was running or performs no action if it was not. T he snmp_agent_stop() function returns the string OK if i t stops the PATROL SNMP Sub-Agent or finds it not running .

Example

The following example checks the output from snmp_agent_config() function for the text "not" starting in the 17th position. If the text "not" is not found, SNMP support is active, and the snmp_agent_stop() function is used to stop the PATROL SNMP Sub-Agent:

if (substr(snmp_agent_config(),17,3)!="not") {
snmp_agent_stop();
print("Patrol SNMP sub-agent stopped\n");
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*