SCCP Commands

NA_DBG_LVL - NA Debug Level
Permission: Writeable
Type: int
Description: SCCP NA Debug Level (0 - 255). System wide SCCP related events will be traced and logged to the Debug Log. Please do not change the NA Debug Level attribute unless instructed by support as increased logging beyond default setting may adversely impact performance. Default value: 0.

LDL_DBG_LVL - LDL Debug Level
Permission: Writeable
Type: int
Description: SCCP LDL Debug Level (0 - 255). Layer Distribution Library (LDL) related events will be traced and logged to the Debug Log. Please do not change the LDL Debug Level attribute unless instructed by support as increased logging beyond default setting may adversly impact performance. Default value: 2.

SCTP_DBG_LVL - SCTP Debug Level
Permission: Writeable
Type: int
Description: SCCP SCTP Debug Level (0 - 255). For Ribbon SCTP deployments, SCTP related events will be traced and logged to the Debug Log. Please do not change the SCTP Debug Level attribute unless instructed by support as increased logging beyond default setting may adversly impact performance. Default value: 0. Obsolete as of 15.1.0 for LK SCTP deployments.

CONTEXT - Context
Permissions: Read-only
Type: string
Description: This attribute contains system generated identifier that is used to identify this SCCP Network Appearance in log messages

LPC - Local Point Code
Permission: Read-only
Type: pointcode
Description: The local point code value is obtained from the MTP3 and is provided here for informational purposes only.

LPC_REG - LPC Registration
Permissions: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: This flag is used to control the registration of the LPC with MTP3. \By default, MTP3 LPC Registration is set to ENABLED. Disabling registration will not block users from registering the LPC with SCCP. These registrations will still work normally

SS7_VARIANT - SS7 Variant
Permission: Read-only
Type: SS7Variant={UNDEFINED,ANSI,ITU,CHINA,NTT,TTC}
Description: The SS7 Variant value is obtained from the MTP3.

NET_IND - Network Indicator
Permission: Read-only
Type: NetInd={UNDEFINED,NI_00,NI_01,NI_10,NI_11}
Description: The network indicator value is obtained from the MTP3.

MTP3_HOSTNAME - MTP3 Host Name
Permission: Read-only
Type: string
Description: This attribute provides the IP host name where this SCCP process will find its MTP Level 3 process. On current systems this is always the same CPU as the SCCP and this attribute is not modifiable. The default value is localhost.

NA - Network Appearance
Permissions: Createable
Type: int
Description: Each Network Appearance (NA) is given a number to distinguish it as you proceed through the various levels of the SS7 stack. Each NA is effectively a new node on the network with its own Local Point Code (LPC)

TRAFFIC_STATUS - Traffic Status
Permission: Read-only
Type: TrafficEnum={INACTIVE,ACTIVE,UNLICENSED}
Description: This attribute indicates the current status of this SCCP. It must read ACTIVE to process messages. Use the action button to change its status. There are certain initial configuration tasks that require traffic to be inactive, however these should not be required on a running system. There should be no operational task that required you to halt traffic, other than an action which would impact traffic by its nature. i.e. Changing the variant from ITU to ANSI.

ERRORS - Errors
Permission: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to Enable or Disable the logging of SCCP error messages to the Debug Log file. These error messages are sent to the SysLog file, regardless of the setting of this attribute. However having the Errors also in the debug log helps in providing context for other activity also logged in that file. The logging of SCCP errors should be set to LOGGED for all production systems.

SETUP_MGMT - Setup Management
Permission: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to Enable or Disable the logging of information concerning the process startup to the Debug Log. This data is only reported at process startup time, so has no impact on the performance of a running system. Most production systems should set this flag to LOGGED.

EXEC_TRACE - Execution Trace
Permission: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to Enable or Disable the logging of detailed information concerning internal execution of the SCCP software. The resultant messages are intended for Ribbon Networks Engineering staff and are not intended to be customer readable. \nThe Execution Trace debug flag should be set to NOT_LOGGED on all production systems so that the CPU is not unduly taxed by spurious log messages.

LAYER_COM - Layer Communication
Permission: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to Enable or Disable the logging of information concerning the library that handles peer interaction. The log messages will be sent to the Debug Log file. The resultant messages are intended for Ribbon Networks Engineering staff and are not intended for customer use. This debug flag should be set to NOT_LOGGED on all production systems so that the CPU is not unduly taxed by spurious log messages.

PEER_MGMT - Peer Management
Permission: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to Enable or Disable the sending of information concerning distribution management on the SCCP peer running on a different CPU. The resultant messages are intended for Ribbon Networks Engineering staff and are not intended for customer use. This debug flag should be set to NOT_LOGGED on all production systems so that the CPU is not unduly taxed by spurious log messages.

SS7_MSG - SS7 Messages
Permission: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to Enable or Disable the sending of the contents of all SS7 messages, in a hex-dump format, to the Debug Log. This flag, more so than other debug flags, can produce a very high volume of data and should be used with caution. Much of the resultant information is intended for Ribbon Networks Engineering staff and is not intended for customer use. This debug flag should be set to NOT_LOGGED on all production systems so that the CPU is not unduly taxed by spurious log messages.

MTP3_INC - MTP3 Incoming
Permission: Writeable
Type: ForcedRtg={NO OVERRIDE,SEND TO GT,SEND TO SSN}
Description: Routing override of incoming MTP3 traffic (NO OVERRIDE/SEND TO SSN/SEND TO GT). This flag allows you to override the setting of the Routing Indicator of the incoming message. By default, there is no override. Setting this feature to either SENT TO SSN or SENT TO GT will cause MTP3 messages to be routed on PC/SSN to a user connection or to the Global Title process. If this override for 'SEND TO GT' is used, the Routing Indicator bit of the Address Indicator will not be modified. The next flag on this screen (MTP3 Incoming GT AI) can be used to set the Routing Indicator bit of the Address Indicator to GT. The Default value is NO OVERRIDE.

MTP3_INC_GT_AI - MTP3 Incoming GT AI
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: This flag is used in conjunction with the previous flag (MTP3 Incoming) and only if that flag is set to 'SEND TO GT'. It will determine if the Routing Indicator will be modified per the forced routing of messages to Global Title processing. This flag will have no effect if the MTP3 Incoming flag is set to 'NO OVERRIDE', or to 'SEND TO SSN'. If the messages are being force sent to the Global Title for processing, and this flag is DISABLED, then the Address Indicator will NOT be modified. The Default value is Disabled

MTP3_INC_GT_ZERO_LEN - MTP3 Incoming GT Zero Length
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: This flag is used in conjunction with the previous flag (MTP3 Incoming) and only if that flag is set to 'SEND TO GT'. Normally messages without any global title information are not sent to Global Title. However with this flag ENABLED, messages of Zero Length can also be force routed to the Global Title process, even if they contain no Global Title information. The Default value is Disabled

MTP3_INC_DEST - MTP3 Incoming Destination
Permission: Writeable
Type: PCRoute={NO OVERRIDE DPC,CALLED PARTY PC}
Description: This flag is used for messages routed to a user connection. Normally the point code used for that determination is taken from the Destination PC of the routing label. However this flag can be set to CALLED and this will cause MTP3 messages to be routed to the User Connection based on their Called Party Address PC. \By default, Incoming MTP3 Destination is set to DPC.

USER_INC - User Incoming
Permission: Writeable
Type: UserForcedRtg={NO OVERRIDE,SEND TO GT}
Description: This flag is used to force messages coming from the Signaling Gateway SUA connection, to be GTT processed before sending to the SS7 Network. This is a very unusual requirement and this flag is only in place to support a legacy system. If you plan to use this feature, please inform Customer Support. The Default value is 'NO OVERRIDE.'

GTT_INC_CLG_PC - GTT Incoming CLG PC
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Enable or disable CLG PC addition on PC/SSN routing for incoming GTT traffic. If enabled and CLG is PC/SSN but has no PC, include the OPC in the CLG to conform with relay node requirements. By default, GTT Incoming CLG PC is set to ENABLED. Disable only for non-relay node deployments or GT routed applications such as PCE.

GTT_INC_REROUTING - GTT Incoming Rerouting
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Enable or disable rerouting of incoming GTT traffic back to GTT. If disabled, a UDTS will be returned on rerouting failure. NOTE: If enabled, special consideration on the GTT provisioning is required to make sure no circular routing is configured. By default, GTT Incoming Rerouting is set to DISABLED.

KEEP_ALIVE - Keep Alive
Permission: Writeable
Type: Timer1800={DISABLED, 1 to 1800}
Description: This timer sets the interval at which a check between the SCCP and its user connections and its GTT connections is sent over TCP. Having a Keep Alive Timer allows the SCCP to more quickly detect a lost connection. The connection check is not required if there is a current exchange of information, and is more useful in low traffic situations. The timer is seconds and the valid range is 0..1800. Setting the timer to 0 seconds disables the keep alive feature. The Default value is 5 seconds.

SST_DELAY - SST Delay
Permission: Writeable
Type: int(Range: [1..1800])
Description: The SST Delay Timer sets the time in seconds between subsystem test messages (SSTs) sent to remote switches with concerned prohibited SSNs. The valid range is [1..1800]. The Default value is 30 seconds.

XUDT_REASSEMBLY - XUDT Reassembly
Permission: Writeable
Type: int(Range: [1..1800])
Description: The XUDT Reassembly Timer sets the time in seconds that the system will tolerate for all the XUDT segments to arrive. The valid range is [1..1800 ]. The Default value is 10 seconds.

MTP_AUDIT - MTP Audit
Permission: Writeable
Type: Timer1800={DISABLED, 1 to 1800}
Description: The MTP Audit Timer sets the time in seconds between MTP_AUDIT messages sent to the MTP3 to probe a certain destination PC. The next flag on this screen is a lifetime Timer which will determine how long we will continue to send these checks before giving up. The MTP Audit Timer is seconds and the valid range is 0..1800. Setting the timer to 0 seconds disables the feature. The Default value is 30 seconds.

MTP_AUDIT_LIFETIME - MTP Audit Lifetime
Permission: Writeable
Type: MTPAuditLifetime={OFF,THIRTY_SECONDS,TWO_MINUTES,FIVE_MINUTES,TEN_MINUTES,THIRTY_MINUTES,ONE_HOUR,TWO_HOURS,THREE_HOURS,FOUR_HOURS,SIX_HOURS,TWELVE_HOURS,ONE_DAY,TWO_DAYS}
Description: The MTP Audit Lifetime Timer is used in conjunction with the MTP Audit Timer. The Audit Timer determines how often we will check for the availability of a point code. The Audit Lifetime Timer determines how long we will continue to send out those checks. No more audit checks are sent after expiration. The MTP Audit Lifetime Timer is seconds and the valid range is 0..1800. Setting the timer to 0 seconds disables the feature. The allowed values are:  - OFF (meaning no expiry),  - THIRTY_SECONDS,  - TWO_MINUTES,  - FIVE_MINUTES,  - TEN_MINUTES,  - THIRTY_MINUTES,  - ONE_HOUR,  - TWO_HOURS,  - THREE_HOURS,  - FOUR_HOURS,  - SIX_HOURS,  - TWELVE_HOURS,  - ONE_DAY,  - TWO_DAYS. The Default value is TWO_MINUTES.

CX_ESTABLISH - Connection Establish
Permission: Writeable
Type: int(Range: [1..1800])
Description: The Connection Establish Timer sets the time in seconds that the system will wait for a virtual SCCP connection to be established before it disconnects. This flag is valid for Connection Oriented SCCP only. The valid range is 1..1800 seconds and the default value is 180 seconds.

CX_RELEASE - Connection Release
Permission: Writeable
Type: int(Range: [1..1800])
Description: The Connection Release Timer sets the time in seconds that the system will wait for a connection to be released before it disconnects. This avoid hanging virtual SCCP connections due to lost messages. This flag is valid for Connection Oriented SCCP only. The valid range is 1..1800 seconds and the default value is 20 seconds.

RX_INACTIVE - Receive Inactive
Permission: Writeable
Type: int(Range: [1..1800])
Description: The Receive Inactivity Timer sets the time in seconds that the system will tolerate receiving no new messages before sending a test message to check the virtual SCCP conversation connection. This flag is valid for Connection Oriented SCCP only. The valid range is 1..1800 seconds and the default value is 660 seconds.

SEND_INACTIVE - Send Inactive
Permission: Writeable
Type: int(Range: [1..1800])
Description: The Send Inactivity Timer sets the time in seconds that the system will tolerate sending no messages out on a temporary virtual connection before sending a test message to check the connection. This flag is valid for Connection Oriented SCCP only. The valid range is 1..1800 seconds and the default value is 300 seconds.

REF_FREEZE - Reference Freeze
Permission: Writeable
Type: int(Range: [1..1800])
Description: The Reference Freeze Timer sets the time in seconds that the system will wait before another connection is allowed with the same local reference ID for a new virtual connection. This flag is valid for Connection Oriented SCCP only. The valid range is 1..1800 seconds and the default value is 20 seconds.

SLS_INCREMENT - SLS Incrementation
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Backward Compatibility of the SLS incrementation. By default, set to DISABLED. If enabled, the SLS inside a message will be incremented by one as that N-UNITDATA request is passed through the SCCP layer. This is only applied to messages of protocol class 0. In ANSI systems the SLS manipulation is a rotation and is performed by the MTP Layer 3. MTP Layer 3 is now the preferred location to deal with SLS values. Flags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

OLD_ENCODING_AI - Old Encoding of AI
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Backward Compatibility of Address Indicator encoding. This flag deals with settings of an older User Application Protocol (or API) between the SCCP layer and the User connection or the GTT connections. By default, set to DISABLED. If enabled, the calling and called party address indicators will be taken from the SS7 Variant used. This means that the SSN indicator and PC indicators can be in different positions from the current SCCP API. Flags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

OLD_ENCODING_CLG_PC - Old Encoding of CLG PA PC
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Obsolete as of 9.0. Backward Compatibility of the Calling Party Address Point Code. Only applicable for service messages (UDTS and XUDTS). By default, set to DISABLED. If enabled, the MTP routing label OPC is inserted in the Calling Party Address Point Code when that PC has not been included in the Global Title as per the Address Indicator. Flags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

OLD_MTP_AVAIL - Old MTP Availability
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Backward Compatibility of the MTP availability status information. By default, set to DISABLED. If enabled, PC_STATE_IND messages for the MTP local states (available and not available) are not sent to the user connections, because this information did not exist in the old SCCP API. Flags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

OLD_PC_FORMAT - Old Point Code Format
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Backward Compatibility of the Point Code Format for PC encoding. By default, set to DISABLED. If enabled, the PC values in the SCCP API are encoded in the old 8.8.8 encoding format. Flags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

SET_OPC_TO_LPC - Set OPC to LPC‘
Permissions: Writeable
Type: OPC2LPCEnum={DISABLED,ENABLED,ENABLED USER ONLY}
Description: Set OPC to LPC for SS7 destined messages. By default, set to DISABLED. If set to ENABLED, the OPC will be replaced with the Local Point Code rather than the virtual point code for all messages. If set to ENABLED USER ONLY, the OPC will be replaced with the LPC rather than the virtual point code for user traffic only (excluding management messages (SCMG). Formerly called Set OPC to LPC Non Mgmt prior to 9.0. Flags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

SET_APC_TO_LPC - Set Affected PC to LPC
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Set Affected PC to LPC for SCMG messages. By default, set to DISABLED. If enabled, the Affected PC in the SCMG messages will be replaced with the Local Point Code. Formerly called Set OPC to LPC Mgmt prior to 9.0. Flags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

SET_OPC_LPC - Set OPC to LPC Non Mgmt
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Obsolete as of 9.0. Set OPC to LPC for non-management messages. By default, set to DISABLED. If enabled, the OPC will be replaced with the Local Point Code rather than the virtual point code. This flag will affect all non-management messages. Flags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

SET_OPC_LPC_MGMT - Set OPC to LPC Mgmt
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Obsolete as of 9.0. Set OPC to LPC for SCMG management messages. By default, set to DISABLED. If enabled, the OPC will be replaced with the Local Point Code rather than the virtual point code. This will affect only SCMG Management Messages. Flags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

N_UNIT_DATA_QoS_FLAG - N_UNIT_DATA QoS Support
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Unit Data Indicator messages include Quality of Service parameter. By default, set to DISABLED. Must be enabled for SUA. If enabled, the N-UNIT-DATA-IND API messages to the User Connections include the Quality Of Service information. If disabled, the N-UNIT-DATA-IND API messages to the User Connections will exclude the Quality of Service only if the hop counter is 0. This exception is required to process UDT versus XUDT messages. Flags on this screen are used for interaction with specific legacy systems and features. If you plan on using them please inform Customer Support.

SSN_ZERO_USER_FLAG - SSN Zero User Support
Permission: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: User connections support SSN zero registration. By default, set to DISABLED as the SSN zero is reserved for management messages handled by SCCP. Registration to SSN zero is only allowed with this flag ENABLED. Flags on this screen are used for interaction with specific legacy systems and features. If you plan on using them please inform Customer Support.

SST_OPC_FROM_SSP - SST OPC From SSP
Permissions: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Set the SST OPC to the DPC from the original SSP message. \nBy default, set to DISABLED. \nIf enabled, the OPC will be set with the Destination Point Code that was received in the original SSP. This will affect only SST Management Messages. \nFlags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support

ENCODING_CLG_PC - Encoding of CLG PA PC
Permission: Writeable
Type: CLGPCEnum={DISABLED,ENABLED SERVICE ONLY,ENABLED XUDT ONLY,ENABLED SERVICE XUDT}
Description: Insert the MTP3 Routing Label OPC into the Calling Party Address Point Code. Only applicable for service messages (UDTS and XUDTS) and XUDT. By default, set to DISABLED. If enabled, the MTP3 routing label OPC is inserted in the Calling Party Address Point Code when that PC has not been included in the Global Title as per the Address Indicator. Flags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

UNEQUIPPED_USER - Unequipped User
Permissions: Writeable
Type: BooleanFeature={DISABLED,ENABLED}
Description: Return error UNEQUIPPED USER (4) if PC-SSN is unavailable. \nBy default, set to DISABLED to return SUBSYSTEM FAIL (3) as the backward compatible value. \nFlags on this screen are used for interaction with specific legacy systems and features. If you plan on using them please inform Customer Support.

FORCED_SEG - Forced Segmentation
Permissions: Writeable
Type: int(Range: [250..273])
Description: Max MSU size to MTP3, segment if MSU size exceeds maximum (default 273). \nOnly applicable for non-service messages (UDT and XUDT). \nSegment size cannot exceed the attribute value. \nBy default (273), no forced segmentation is applied. \nThis feature is useful if SCCP is deployed with L4Cvtr and conversion makes the MSU exceed standard MSU size. \nFlags on this screen are used for interaction with specific legacy systems and custom features. If you plan on using them please inform Customer Support.

CONTEXT - Context
Permission: Read-only
Type: string
Description: IP and port of this User Connection.

REASSEMBLY_SUPPORT - Reassembly Support
Permission: Read-only
Type: BooleanFeature={DISABLED,ENABLED}
Description: XUDT segment reassembly support feature.

REG_PC_SSNs - Registered PC SSNs
Permission: Read-only
Type: int
Description: Number of Registered PC-SSNs on this User Connection.

REG_APPIDs - Registered AppIDs
Permission: Read-only
Type: int
Description: Number of Registered AppIDs on this User Connection.

UAP_VERSION - UAP Version
Permission: Read-only
Type: int
Description: UAP protocol version received on this User Connection.

CONTEXT - Context
Permission: Read-only
Type: string
Description: IP and port of this GTT Connection.

REASSEMBLY_SUPPORT - Reassembly Support
Permission: Read-only
Type: BooleanFeature={DISABLED,ENABLED}
Description: XUDT segment reassembly support feature.

REG_PCs - Registered PCs
Permission: Read-only
Type: int
Description: Number of Registered PCs on this GTT Connection.

REG_APPIDs - Registered AppIDs
Permission: Read-only
Type: int
Description: Number of Registered AppIDs on this GTT Connection.

UAP_VERSION - UAP Version
Permission: Read-only
Type: int
Description: UAP protocol version received on this GTT Connection.

SSN - SSN
Permission: Createable
Type: SSNTTEnum={DEFAULT,NOT APPLICABLE, 0 to 255}
Description: TCAP Service Rule Subsystem Number. 

TT - TT
Permission: Createable
Type: SSNTTEnum={DEFAULT,NOT APPLICABLE, 0 to 255}
Description: TCAP Service Rule Translation Type.

TCAP_SERVICE - TCAP Service
Permission: Createable
Type: TCAPServiceEnum={UNSPECIFIED,MAP,CAP,GSM,IS41,AIN,INAP,WIN}
Description: TCAP Service Rule result.

PC - Point Code
Read-only
Type: pointcode
Description: Remote point code.

STATUS - Status
Permission: Read-only
Type: BooleanAvail={UNAVAILABLE,AVAILABLE}
Description: Remote PC status (AVAILABLE/UNAVAILABLE).

SSNs - Remote SSNs
Permission: Read-only
Type: int
Description: Number of Remote SSNs.

USERCREATED - User Created
Permissions: Createable
Type: YesNo={NO,YES}
Description: Remote PC created by user (or network).

AI_NI - AI NI
Permissions: Createable
Type: SGMGNI={INTERNATIONAL,NATIONAL}
Description: Remote PC address indicator network/reserved 8th bit. ANSI network typically use NATIONAL while all others use INTERNATIONAL.