You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > SNMP Configure 0x0092

SNMP Configure 0x0092

SwitchKit Name

SNMPConfig

Type

EXS API and SwitchKit API message

Description

SNMP Configure 0x0092

This message uses the Generic Report message (0x46) to send statistical information to the CSP.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

UBYTE Slot;

UBYTE DS3;

UBYTE Type;

UBYTE Action;

UBYTE Period;

} XL_SNMPConfig;

C++ Class

class XLC_SNMPConfig : public XLC_OutboundMessage {

public:

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getDS3() const;

void setDS3(UBYTE x);

UBYTE getType() const;

void setType(UBYTE x);

UBYTE getAction() const;

void setAction(UBYTE x);

UBYTE getPeriod() const;

void setPeriod(UBYTE x);

};

EXS API Hex Format

MESSAGE (White) | RESPONSE (Gray)
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0xNNNN) | 1, 2 | Length (0x0007)
3, 4 | Message Type (0x0092) | 3, 4 | Message Type (0x0092)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 : | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status MSB, LSB
Number of AEs to follow | 10 | Checksum
AE DS3 Offset: (0x32) 0x0C Logical Span |
: | Type This field instructs the CSP on how the report should be returned. 0x01 Return report using Generic Report Message
: | Action This field contains a bit mask that indicates what actions are to be taken. If this field is 0x00, periodic report will be turned off. Bit 0: Clear counters if set Bit 1: Send a report only once Bit 2: Send report periodically
: | Period This field contains the interval in minutes in which a periodic report should be sent. If this field is 0x00, it will be set to 0x0F (15 minutes).
: | Checksum

AIB

This AIB addresses a DS3 offset for a DS3 card. It is used to bring a DS3 in service and out of service:

Byte | AIB Field Description
--- | ---
2 | Address Type (0x32)
3 | Data Length (0x02)
4 | Data[0] – Slot Number
5 | Data[1] DS3 Offset

A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
See Address Information Block.
Most Significant Bit
Least Significant Bit