Next Topic

Previous Topic

Book Contents

GetAlarm

Returns alarm detail for the submitted MonitorAlarmID.

A single record of the following fields is returned.

Machine_GroupID

string

A concatenated representation of the machine id and the group ID it is associated with

agentGuid

decimal

A globally unique identifier for a machine ID.group ID account and its corresponding agent.

MachineName

string

Machine Name used for each agent

GroupName

string

Group Name used for each agent

MonitorAlarmID

int

unique monitor alarm number

MonitorType

int

0=Counter

1=Service

2=Process

3=SNMP

4=Alert

5=System Check

6=EPS

AlarmType

string

0 -> Alarm

1 -> Trending

Message

string

Message created from alarm, email message body

AlarmSubject

string

Subject of alarm and email subject

AlarmEmail

string

Email Address(es) alarm is sent to

EventTime

string

Date and Time of alarm

TicketID

int

Ticket ID created from alarm

AdminName

string

Administrator who assigned monitor counter to machine

MonitorName

string

Name of monitor SNMP Get object

LogType

 

1 -> Application Log

2 -> Security Log

3 -> System Log

EventType

int

1 -> Error

2 -> Warning

4 -> Informational

8 -> Success Audit

16 -> Failure Audit

LogValue

decimal

Value causing alarm, if the return value of the SNMP Object Get command is a string the value will be the the Message

SNMPName

string

Name returned from SNMP Device on scan

SNMPCustomerName

string

Custom name for SNMP Device

SystemCheckParam1

string

First parameter used in system check

SystemCheckParam2

string

(Optional) Second parameter used by system check

Method

string

The operation that requested this response.

TransactionID

decimal

The unique message ID for this message.

ErrorMessage

string

If blank, no error was returned.

ErrorLocation

string

If blank, no error was returned.