You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > PPL Audit Configure 0x00DC
SwitchKit Name
PPLAuditConfig
Type
EXS API and SwitchKit API message
Description
This message configures the PPL auditing features on a card. Use the PPL Audit Query host message to retrieve the audit log.
Sent by
SwitchKit Code
Configuration
PPLAuditConfig (
Node = integer,
Slot = integer,
V5ID = integer,
ComponentID = integer,
AuditType = integer,
Span = integer,
Channel = integer);
C Structure
typedef struct {
UBYTE AddrInfo[30];
unsigned short ComponentID;
UBYTE AuditType;
} XL_PPLAuditConfig;
C++ Class
class XLC_PPLAuditConfig : public XLC_SlotMessage {
public:
const UBYTE *getAddrInfo() const;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
UBYTE getSlot() const;
void setSlot(UBYTE x);
XBYTE getV5ID() const;
void setV5ID(XBYTE x);
unsigned short getComponentID() const;
void setComponentID(unsigned short x);
UBYTE getAuditType() const;
void setAuditType(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 (0x00DC) |
3, 4 |
Message Type (0x00DC) |
|
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
|
6 |
Sequence Number |
6 |
Same Sequence Number |
|
7 |
Logical Node ID |
7 |
Logical Node ID |
|
: |
Address Method 0x00 - Individual AEs 0x01 - Slot |
8, 9 |
|
|
Number of AEs to follow |
|||
|
AE 0x0D Channel |
|||
|
: |
PPL Component ID MSB, LSB See PPL Component IDs in the |
10 |
Checksum |
|
: |
Audit Type This field is a bit mask that enables audit features. The bit values are 0=Disabled, 1=Enabled. (To enable a feature, set the bit to 1).
Bit 0 PPL Auditing Log 1 PPL Error Alarm Use this bit to inform the host of a PPL state machine error through an Alarm message. 2 PPL Individual Auditing Enable Use this bit to enable and disable individual PPL auditing, per component on the card containing the AIB entity. 3 PPL Individual Entity Auditing Configure Use this bit to enable and disable auditing for the specific entity of the component. 4 –7 Reserved, must be 0
Note: Bit 3 used in conjunction with Bit 2 enables auditing for the specific entity.
Audit Type Validation: 0x00, 0x01, 0x02, 0x04: Valid with Slot or Entity AIB 0x03: Valid with Slot AIB only 0x06, 0x08, 0x0A, 0x0C, 0x0E: Valid with Entity AIB only 0x05, 0x07, 0x09, 0x0B, 0x0D,0x0F - 0xFF: Not valid
Note: An invalid Audit Type will return a NACK (0x17) |
||
|
: |
Checksum |
||