You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > PPL Delete 0x00DA
SwitchKit Name
PPLDelete
Type
EXS API and SwitchKit API message
Description
This message allows the host to delete a protocol, a primitive table, or a state/event table. A primitive or state/event table is not be deleted if it is associated with a protocol in use. All channels must be out-of-service.
If the host sends this message to a Excel platform that has multiple line cards of the same type, the system deletes the protocol only if the protocol is not in use by every card. If the PPL protocol is in use by at least one card, the system returns a Channel In Service (0xD5) response and does not delete the channel.
You can delete all downloaded PPL components by specifying the PPL component 0xFFFF, which is valid for this message only. Using this value has the following effects:
• For E1 and T1 cards and matrices (L4PPL), the system deletes all downloaded PPLs and purges all channels using non-default protocols.
• For ISDN and SS7 cards, the system deletes all downloaded PPLs. If any channel (D/B channel, SS7 link, and so on) is using a non-default protocol and is in service, the system resets the card; however, if no channels are in service, the system does not reset the card.
Sent by
SwitchKit Code
Configuration
PPLDelete (
Node = integer,
ComponentID = integer,
Entity = integer,
EntityID = integer);
C Structure
typedef struct {
unsigned short ComponentID;
UBYTE Entity;
UBYTE EntityID;
} XL_PPLDelete;
C++ Class
class XLC_PPLDelete : public XLC_OutboundMessage {
public:
unsigned short getComponentID() const;
void setComponentID(unsigned short x);
UBYTE getEntity() const;
void setEntity(UBYTE x);
UBYTE getEntityID() const;
void setEntityID(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 (0x0009) |
1, 2 |
Length (0x0007) |
3, 4 |
Message Type (0x00DA) |
3, 4 |
Message Type (0x00DA) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8, 9 |
PPL Component ID MSB, LSB See PPL Component IDs in |
8, 9 |
Status MSB, LSB |
10 |
Checksum |
||
10 |
PPL Entity 0x01 Primitive Table 0x02 State/Event Table 0x03 Route Table 0x04 Resource Group Table 0xFF Protocol |
||
11 |
PPL Entity ID 0x01–0x0A Host-defined table/protocol |
||
12 |
Checksum |