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_trap_raise_std_trap()


Raise the standard PATROL trap.

Syntax

snmp_trap_raise_std_trap(text)

Parameter

Parameter

Definition

text

character string that is to be included in the packet sent by the snmp_trap_raise_std_trap() function

Description

The snmp_trap_raise_std_trap() function sends the patrolTrapV1Raised trap with text in a packet to all entities registered with the piV1mTable. The piV1mTable is the table within the PATROL MIB that can be set by the external SNMP manager.

The snmp_trap_raise_std_trap() function returns the characters "OK" if successful and the NULL string otherwise.

Example

The following is an example of the snmp_trap_raise_std_trap() function:

opstatus = snmp_trap_raise_std_trap();
if (opstatus != "OK") {
# raise standard trap operation failed
# diagnosis and recovery statements here
}