HostAlarm

Type

SwitchKit API message

Description

Use the SK_HostAlarm message to allow SwitchKit applications to generate alarms or events that can be sent to other SwitchKit applications. Receiving applications, such as SNMP processes will be able to register to receive this class of message.

Sent by

Application

Arguments

The following table shows the arguments you can change:

Argument

Description

AppName

A text string used to uniquely identify the application sending the message. (ASCII String 64 characters maximum)

AlarmTime

This is the number of seconds since January 1 1970.

IPAddrofSender

 

This field will contain the IP Address of the host system where the problem originated

AlarmMajor

See Table 1:Alarm Types

AlarmSubType

See Table 2: Alarm Sub-types/Probable Cause

AlarmSeverity

See Table 3:Alarm Severity

TLVCount

The number of data items associated with this message

TLVData

SeeTable 4: TLV Data Types

Configuration

Syntax, if able to send, is through SMgr

C Structure

typedef struct {

UBYTE IPAddrofSenderSize;

UBYTE reserved5[12];

char AppName[64];

int AlarmTime;

UBYTE IPAddrofSender[4];

UBYTE AlarmMajor;

UBYTE AlarmSubType;

UBYTE AlarmSeverity;

UBYTE TLVCount;

UBYTE TLVData[177];

} SK_HostAlarm;

C Structure Response

typedef struct {

int Status;

UBYTE reserved21[4];

} SK_HostAlarmAck;

C++ Class

class SKC_HostAlarm : public SKC_ToolkitMessage {

public:

UBYTE getIPAddrofSenderSize() const;

void setIPAddrofSenderSize(UBYTE x);

const char *getAppName() const;

void setAppName(const char *x);

int getAlarmTime() const;

void setAlarmTime(int x);

const UBYTE *getIPAddrofSender() const;

UBYTE *getIPAddrofSender();

void setIPAddrofSender(UBYTE *x);

UBYTE getAlarmMajor() const;

void setAlarmMajor(UBYTE x);

UBYTE getAlarmSubType() const;

void setAlarmSubType(UBYTE x);

UBYTE getAlarmSeverity() const;

void setAlarmSeverity(UBYTE x);

UBYTE getTLVCount() const;

void setTLVCount(UBYTE x);

const UBYTE *getTLVData() const;

UBYTE *getTLVData();

void setTLVData(UBYTE *x);

};

C++ Class Response

class SKC_HostAlarmAck : public SKC_ToolkitAck {

public:

int getStatus() const

void setStatus(int x)

};

Table 1:Alarm Types

Name

Value as Defined

Description

Communications Alarm Type

SK_COMMUNICATIONS 1

 

An alarm of this type is principally associated with the procedures and/or processes required to convey information from one point to another.

QOS Alarm Type

SK_QUALITYOFSERVICE 2

An alarm of this type is principally associated with degradation in the quality of a service.

Processing Error Alarm Type

SK_PROCESSINGERROR 3

An alarm of this type is principally associated with a software or processing fault.

Equipment Alarm Type

SK_EQUIPMENT 4

An alarm of this type is principally associated with an equipment fault

Environmental Alarm Type

SK_ENVIRONMENTAL 5

An alarm of this type is principally associated with a condition relating to an enclosure in which the equipment resides.it

Table 2: Alarm Sub-types/Probable Cause

Name

Value as Defined

Description

Adapter error

SK_ADAPTERERROR 1

 

Application subsystem failure:

 

SK_APPLICATIONSUBSYSTEMFAILURE 2

A failure in an application subsystem has occurred (an application subsystem may include software to support the Session, Presentation or Application layers)

Bandwidth reduced

SK_BANDWIDTHREDUCED 3

The available transmission bandwidth has decreased

Call establishment error

SK_CALLESTABLISHMENTERROR 4

An error occurred while attempting to establish a connection

Communications protocol error

SK_COMMUNICATIONPROTOCOLERROR 5

 

A communication protocol has been violated

Communications subsystem failure

SK_COMMUNICATIONSUBSYSTEMFAILURE 6

 

A failure in a subsystem that supports communications over telecommunications links, these may be implemented via leased telephone lines, by X.25 networks, token-ring LAN, or otherwise

Configuration or customization error:

 

SK_CONFIGURATIONORCUSTOMIZATIONERROR 7

A system or device generation or customization parameter has been specified incorrectly, or is inconsistent with the actual configuration

Congestion:

 

SK_CONGESTION 8

A system or network component has reached its capacity or is approaching it

Corrupt data:

 

SK_CORRUPTDATA 9

An error has caused data to be incorrect and thus unreliable

CPU cycles limit exceeded

SK_CPUCYCLESLIMITEXCEEDED 10

A Central Processing Unit has issued an unacceptable number of instructions to accomplish a task

Dataset or modem error

SK_DATASETORMODEMERROR 11

An internal error has occurred on a dataset or modem

Degraded signal

SK_DEGRADEDSIGNAL 12

The quality or reliability of transmitted data has decreased

DTE-DCE interface error:

SK_DTEDCEINTERFACEERROR 13

A problem in a DTE-DCE interface, which includes the interface between the DTE and DCE, any protocol used to communicate between the DTE and DCE and information provided by the DCE about the circuit

Enclosure door open

 

SK_ENCLOSUREDOOROPEN 14

 

Equipment malfunction

 

SK_EQUIPMENTMALFUNCTION 15

An internal machine error has occurred for which no more specific Probable cause has been identified

Excessive vibration:

 

SK_EXCESSIVEVIBRATION 16

Vibratory or seismic limits have been exceeded

File error:

 

SK_FILEERROR 17

The format of a file (or set of files) is incorrect and thus cannot be used reliably in processing

Fire detected

SK_FIREDETECTED 18

 

Flood detected

SK_FLOODDETECTED 19

 

Framing error

SK_FRAMINGERROR 20

An error in the information that delimits the bit groups within a continuous stream of bits

Heating/ventilation/cooling system problem

SK_HEATORVENTORCOOLSYSTEMPROBLEM

 

Humidity unacceptable

SK_HUMIDITYUNACCEPTABLE 22

The humidity is not within acceptable limits

I/O device error

SK_INPUTOUTPUTDEVICEERROR 23

An error has occurred on the I/O device

Input device error

SK_INPUTDEVICEERROR 24

An error has occurred on the input device

LAN error

SK_IANERROR 25

An error has been detected on a local area network

Leak detected:

SK_LEAKDETECTED 26

A leakage of (non-toxic) fluid or gas has been detected

Local node transmission error:

SK_LOCALNODETRANSMISSIONERROR 27

An error occurred on a communications channel between the local node and an adjacent node

Loss of frame

SK_LOSSOFFRAME 28

An inability to locate the information that delimits the bit grouping within a continuous stream of bits

Loss of signal

SK_LOSSOFSIGNAL 29

An error condition in which no data is present on a communications circuit or channel

Material supply exhausted

 

SK_MATERIALSUPPLYEXHAUSTED 30

A supply of needed material has been exhausted

Multiplexer problem

SK_MULTIPLEXERPROBLEM 31

An error has occurred while multiplexing communications signals

Out of memory

SK_OUTOFMEMORY 32

There is no program-addressable storage available.

Output device error

SK_OUTPUTDEVICEERROR 33

An error has occurred on the output device

Performance degraded

SK_PERFORMANCEDEGRADED 34

Service agreements or service limits are outside of acceptable limits

Power problem

SK_POWERPROBLEM 35

There is a problem with the power supply for one or more resources

Pressure unacceptable

SK_PRESSUREUNACCEPTABLE 36

A fluid or gas pressure is not within acceptable limits

Processor problem

SK_PROCESSORPROBLEM 37

An internal machine error has occurred on a Central Processing Unit

Pump failure

SK_PUMPFAILURE 38

Failure of mechanism that transports a fluid by inducing pressure differentials within the fluid

Queue size exceeded

SK_QUEUESIZEEXCEEDED 39

The number of items to be processed (configurable or not) has exceeded the maximum allowable

Receive failure

SK_RECEIVEFAILED 40

 

Receiver failure

SK_RECEIVERFAILED 41

 

Remote node transmission error

SK_REMOTENODETRANSMISSIONERROR 42

An error occurred on a communication channel beyond the adjacent node

Resource at or nearing capacity

SK_RESOURCEATORNEARINGCAPACITY 43

The usage of a resource is at or nearing the maximum allowable capacity

Response time excessive

SK_RESPONSETIMEEXCESSIVE 44

The elapsed time between the end of an inquiry and beginning of the answer to that inquiry is outside of acceptable limits

Retransmission rate excessive

SK_RETRANSMISSIONRATEEXCESSIVE 45

The number of repeat transmissions is outside of acceptable limits

Software error

SK_SOFTWAREERROR 46

A software error has occurred for which no more specific Probable cause can be identified

Software program abnormally terminated

SK_SOFTWAREPROGRAMABNORMALLYTERMINATED 47

A software program has abnormally terminated due to some unrecoverable error condition

Software program error

SK_SOFTWAREPROGRAMERROR 48

An error has occurred within a software program that has caused incorrect results

Storage capacity problem

SK_STORAGECAPACITYPROBLEM 49

A storage device has very little or no space available to store additional data

Temperature unacceptable

SK_TEMPERATUREUNACCEPTABLE 50

A temperature is not within acceptable limits

Threshold crossed

SK_THRESHOLDCROSSED 51

A limit (configurable or not) has been exceeded

Timing problem

SK_TIMINGPROBLEM 52

A process that requires timed execution and/or coordination cannot complete, or has completed but cannot be considered reliable

Toxic leak detected

SK_TOXICLEAKDETECTED 53

A leakage of toxic fluid or gas has been detected

Transmit failure

SK_TRANSMITFAILURE 54

 

Transmitter failure

SK_TRANSMITTERFAILURE 55

 

Underlying resource unavailable

SK_UNDERLYINGRESOURCEUNAVAILABLE 56

An entity upon which the reporting object depends has become unavailable

Version mismatch

SK_VERSIONMISMATCH 57

There is a conflict in the functionality of versions of two or more communicating entities which may affect any processing involving those entities

Table 3:Alarm Severity

Name

Value as Defined

Description

Cleared

SK_CLEARED 1

The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given). Multiple associated notifications may be cleared by using the Correlated notifications parameter (defined below).

Indeterminate

SK_INDETERMINATE 2

The Indeterminate severity level indicates that the severity level cannot be determined.

Major

SK_MAJOR 5

The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.

Critical

SK_CRITICAL 6

The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.

Minor

SK_MINOR 4

The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.

Warning

SK_WARNING 3

The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service-affecting fault.

Table 4: TLV Data Types

Name

Value as Defined

Description

DisplayString

SK_TLV_DISPLAYSTRING 1

ASCII text string. Characters greater then or equal to 0x20 and characters less then 0x7e, 64 characters max.

Integer

SK_TLV_INTEGER 2

Integer field

IpAddress

SK_TLV_IPADDRESS 3

This application-wide type represents a 32-bit internet address. It is represented as an OCTET STRING of length 4, in network byte-order.

PhysicalAddress

SK_TLV_PHYSICALADDRESS 4

This data type is used to model media addresses. For example, an ethernet address would be represented as a string of 6 octets.