Service State Configure 0x000A

SwitchKit Name

ServiceStateConfig

Type

EXS API and SwitchKit API message

Description

This message allows the host to bring an entity (a card, span, channel, range of channels, DSP SIMM, or SS7-controlled circuit) in and out of service. On the DSP Series 2 card, this message must use AIB 0x22 to take an individual DSP chip in and out of service.

• A card is automatically brought into service when the system is powered up. The host does not have to bring a card into service unless it has previously taken the card out of service using this message.

• The DS3 framer is automatically brought into service when the DS3 card is brought into service. Once in service, DS3 status changes are reported to the host in the Alarm messages (0x00B9). If the DS3 circuit is not ready for operation, the host can disable DS3 alarms by placing the DS3 framer out of service. To do this, have the host send a Service State Configure message with the DS3 Offset AIB (0x32) and an action of 0x0F (Take Out of Service).

If the host does take the DS3 Framer Out of Service, it is the host’s responsibility to bring it back in service. If the host does not bring the DS3 Framer back in service, the Excel platform will send a NACK 0x005A (DS3 Out of Service) when it receives the Service State Configure message to Brings Span In Service.

• For LAPD Super Rate, this message must address the first D channel (DS0). The other D channels in the Super Rate D channel do not need to be addressed in Service State Configure.

• You cannot use Service State Configure to take virtual cards out-of-service.

Sent by

Host

Example Message
(Socket Log Output)

The following example message (socket log output for SwitchKit) takes channels 0x01 through 0x05 on span 0x01 out of service.

00 13 00 0A 00 00 FF 01 02 0D 03 00 01 01 0D 03 00 01 05 0F 00

Configuration

ServiceStateConfig (

Node = Integer,

Range = StartSpan:StartChan - EndSpan:EndChan,

Span = Integer,

Slot = Integer,

SIMM = Integer,

StackID = Integer,

LinkID = Integer,

Ring = Integer,

V5ID = Integer,

DS3 = Integer,

Action = Integer,

ForcedFlag = Integer);

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE Action;

UBYTE ForcedFlag;

} XL_ServiceStateConfig;

C++ Class

class XLC_ServiceStateConfig : public XLC_ChanRangeMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getStartSpan() const;

void setStartSpan(XBYTE x);

UBYTE getStartChannel() const;

void setStartChannel(UBYTE x);

XBYTE getEndSpan() const;

void setEndSpan(XBYTE x);

UBYTE getEndChannel() const;

void setEndChannel(UBYTE x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getSIMM() const;

void setSIMM(UBYTE x);

UBYTE getDS3() const;

void setDS3(UBYTE x);

XBYTE getSpan() const;

void setSpan(XBYTE x);

XBYTE getV5ID() const;

void setV5ID(XBYTE x);

UBYTE getAction() const;

void setAction(UBYTE x);

UBYTE getForcedFlag() const;

void setForcedFlag(UBYTE x);

};

EXS API Hex Format

Invalid Responses

NOTE: These invalid responses apply to the V5 ID address type only

• 0x01- The host could be attempting to bring the V5 interface in
service or out of service when the V5 Interface ID (4 bytes)
has not been configured. The host could be attempting to bring the V5 interface in service or out of service when the V5 ID is not configured.

• 0x04- The host could be attempting to bring the V5 interface in
service when the V5 Variant ID has not been configured for
that interface.

• 0x07- The host could be attempting to bring the V5 interface in
service when no user ports are configured for the V5 ID.

• 0x0A- The host could be attempting to bring the V5 interface in
service when no C Channels are assigned to this V5 ID.

• 0x0B-The host was attempting to bring a V5 interface in service
when a C Channel was found on an unconfigured link.

• 0x0D RESERVED
0x0E RESERVED
0x0F RESERVED