4.453 rtrv-appl-rtkey

Use this command to retrieve information from the Routing Key table. A routing key entry associates a routing key with up to 16 socket names with a limit of 2500 routing keys per system (if E5-ENET-B cards exist).

  • DPC, SI, SSN routing keys, which are used to route SCCP messages
  • DPC, SI routing keys, which are used to route non-SCCP and non-ISUP messages
  • DPC, SI, CIC routing keys, which are used to route ISUP messages

Parameters

Note:

See Point Code Formats and Conversion for a detailed description of point code formats, rules for specification, and examples.
asname (optional)
Application Server (AS) name assigned to this routing key.
Range:
ayyyyyyyyyyyyyy

Up to 15 alphanumeric characters; the first character must be a letter

cice (optional)
The end range of circuit identification codes assigned to the routing key.
Range:
0 - 4294967295

See Table A-4  for valid CIC values for specified SI and MSU types.

cics (optional)
The start range of circuit identification codes assigned to the routing key.
Range:
0 - 4294967295

See Table A-4  for valid CIC values for specified SI and MSU types.

display (optional)
The type of output to display.

Note:

Output includes the type of card, the data collection being audited, and a message indicating the overall status. This parameter applies only to STP databases.
Range:
all
The KEY and the ATTRIBUTE sections of the routing key are displayed
brief
Only the KEY section of the routing key is displayed
Default:
brief
dpc (optional)
ANSI destination point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm).
Synonym:
dpca
Range:
000-255

Specify a valid value for each subfield of the point code, and separate the subfields with a dash (-).

When chg-sid:pctype=ansi is specified, ni = 000 is not valid.

When chg-sid:pctype=ansi is specified, nc = 000 is not valid if ni = 001–005.

When chg-sid:pctype=ansi is specified, nc = 000 is valid if ni = 006–255.

The point code 000-000-000 is not a valid point code.

dpc/dpca/dpci/dpcn/dpcn24/dpcn16 (optional)
Destination point code.
dpci (optional)
ITU international destination point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id)
Range:
s-, 0-255

Specify a valid value for each subfield of the point code, and separate the subfields with a dash (-).

prefix—s

zone—0-7

area—000-255

id—0-7

The point code 0-000-0 is not a valid point code.

dpcn (optional)
ITU national destination point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members) separated by dashes (m1-m2-m3-m4) as defined by the chg-stpopts:npcfmti flexible point code option. A group code must be specified when the ITUDUPPC feature is turned on (nnnnn-gc, m1-m2-m3-m4-gc). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc).
Range:
s-, 0-16383, aa-zz

Specify a valid value for each subfield of the point code, and separate the subfields with a dash (-).

prefix—s-

nnnnn—0-16383

gc—aa-zz

m1-m2-m3-m4—0-14 for each member; values must sum to 14

dpcn24 (optional)
24-bit ITU national destination point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp).
Range:
000-255

Specify a valid value for each subfield of the point code, and separate the subfields with a dash (-).

msa—000–255

ssa—000–255

sp—000–255

dpcn16 (optional)
16-bit ITU national destination point code with subfields unit number sub number area main number area (un-sna-mna).
Range:
000---127
Specify a valid value for each subfield of the point code, and separate the subfields with a dash (-).
un---000---127
sna---000---15
mna---000---31
num (optional)
The number of entries to display.
Range:
1 - 10000
Default:
50
opc (optional)
ANSI originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm).
Synonym:
opca
Range:
000-255

Specify a valid value for each subfield of the point code, and separate the subfields with a dash (-).

When chg-sid:pctype=ansi is specified, ni = 000 is not valid.

When chg-sid:pctype=ansi is specified, nc = 000 is not valid if ni = 001–005.

When chg-sid:pctype=ansi is specified, nc = 000 is valid if ni = 006–255.

The point code 000-000-000 is not a valid point code.

opc/opca/opci/opcn/opcn24/opcn16 (optional)
Originating point code.
opci (optional)
ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id)
Range:
s-, 0-255

Specify a valid value for each subfield of the point code, and separate the subfields with a dash (-).

prefix—s

zone—0-7

area—000-255

id—0-7

The point code 0-000-0 is not a valid point code.

opcn (optional)
ITU national originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members) separated by dashes (m1-m2-m3-m4) as defined by the chg-stpopts:npcfmti flexible point code option. A group code must be specified when the ITUDUPPC feature is turned on (nnnnn-gc,m1-m2-m3-m4-gc). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc).
Range:
s-, 0-16383, aa-zz

Specify a valid value for each subfield of the point code, and separate the subfields with a dash (-).

prefix—s-

nnnnn—0-16383

gc—aa-zz

m1-m2-m3-m4—0-14 for each member; values must sum to 14

opcn24 (optional)
24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp).
Range:
000-255

Specify a valid value for each subfield of the point code, and separate the subfields with a dash (-).

msa—000–255

ssa—000–255

sp—000–255

opcn16 (optional)
16-bit ITU national originating point code with subfields unit number sub number area main number area (un-sna-mna).
Range:
000---127
Specify a valid value for each subfield of the point code, and separate the subfields with a dash (-).
un---000---127
sna---000---15
mna---000---31
rcontext (optional)
Routing Context. The routing key with the specified routing context.
Range:
0 - 4294967295
si (optional)
Service indicator.
Range:
0 - 15

The following equivalent text values can be specified:

Number = Text—Description

0=snm
Signaling network management messages
1=regtest
Signaling network testing and maintenance regular
2=spltest
Signaling network testing and maintenance special
3=sccp
SCCP
4=tup
Telephone user part
5=isup
ISDN user part
13=qbicc
ssn (optional)
Subsystem number.
Range:
0 - 255
type (optional)
The type of routing key.
Range:
all
full
partial
default
Default:
all

Example

rtrv-appl-rtkey

rtrv-appl-rtkey:dpc=123-234-255:si=3

rtrv-appl-rtkey:dpc=123-234-255

rtrv-appl-rtkey:cics=1:cice=1000:num=3

rtrv-appl-rtkey:cice=19

rtrv-appl-rtkey:opc=122-124-125

rtrv-appl-rtkey:type=partial

rtrv-appl-rtkey:display=all

rtrv-appl-rtkey:rcontext=7

rtrv-appl-rtkey:dpcn16=121-10-15

Dependencies

The ssn parameter must be specified and is valid only when the si=3 (sccp) parameter is specified.

The value specified for the cics parameter must be less than or equal to the value specified for the cice parameter.

A circuit identification code range (cics to cice) that overlaps an existing routing key cannot be specified.

The ssn parameter cannot be specified when opc, cics, and cice parameters are specified. See Table 4-2 for valid parameter combinations.

When the DPC is ANSI and the si=4 parameter is specified, a DPC/SI routing key must be specified (TUP is used only in an ITU network).

The opc, cics, and cice parameters can be specified with the si parameter only if the si parameter has a value of 4, 5, or 13 (or tup, isup, or qbicc).

Table A-4  shows valid CIC values for SI types 4, 5, and 13.

The following types of partial routing keys are supported:

  • The following types of partial routing keys are supported:
  • DPC/SI/OPC (ignore CIC) can be used as a partial match key for CIC- based traffic.
  • DPC/SI (ignore all other fields) can be used as a partial match key for CIC- based traffic or SCCP traffic.
  • DPC only (ignore all other fields) can be used as a partial match for any type of traffic.
  • SI only (ignore all other fields) can be used as a partial match for any type of traffic.

If the type=default parameter is specified, then the dpc, si, ssn, opc, cics, and cice parameters cannot be specified.

Notes

This command can be canceled using the F9 function key or the canc-cmd command. See canc-cmd for more information.

Static routing keys are stored on disk and a copy of the table is loaded to each SS7IPGW card.

Group codes are required for ITU-N point codes (DPCN/OPCN) when the Duplicate Point Code feature is turned on.

The display=all parameter must be specified to display the assigned routing context value for the routing key.

In this command, the point codes support only the spare point code subtype prefix (s-).

Output

rtrv-appl-rtkey

    rlghncxa03w 08-04-11 13:17:09 EST  EAGLE 38.0.0
    
    RCONTEXT        DPC       SI  ADPTR   ASNAME           TYPE
    ----------    008-008-008  *  M3UA    as5              PARTIAL
    ----------    002-002-002 10  M3UA    as2              FULL
    ----------    001-001-001  *  M3UA    as11             PARTIAL
    ----------    001-001-001 10  M3UA    as11             FULL
    ----------    001-001-001  3  M3UA    as12             FULL
    ----------    002-002-002  9  M3UA    as14             FULL
    10            002-002-002  *  M3UA    as8              PARTIAL

    RCONTEXT        DPCI      SI  ADPTR   ASNAME           TYPE
    ----------    7-007-7      *  M3UA    as14             PARTIAL
    ----------    7-007-7      4  M3UA    as15             FULL

    RCONTEXT        DPC       SI  ADPTR   ASNAME           TYPE
    ----------    *********** **  M3UA    as1              DEFAULT
    ----------    *********** 10  M3UA    as12             PARTIAL

    Route Key table is (11 of 1000) 1% full
    Route Key Socket Association table is (11 of 16000) 1% full

    END OF LOG REPORT 
;
rtrv-appl-rtkey:asname=as11

    rlghncxa03w 08-04-11 14:05:46 EST  EAGLE 38.0.0
    
    RCONTEXT        DPC       SI  ADPTR   ASNAME           TYPE
    ----------    001-001-001  *  M3UA    as11             PARTIAL
    ----------    001-001-001 10  M3UA    as11             FULL

    Route Key table is (10 of 1000) 1% full
    Route Key Socket Association table is (10 of 16000) 1% full

    END OF LOG REPORT 
;

This example shows a routing key with routing context that is assigned to an SUA Application Server and a routing key with routing context that is assigned to an M3UA Application Server.

rtrv-appl-rtkey:display=all

    rlghncxa03w 08-04-11 14:13:46 EST  EAGLE 38.0.0
   
    RCONTEXT        DPC       SI SSN      OPC       CICS       CICE
    ----------    008-008-008 ** *** ************** ********** **********

        ADPTR   TYPE      ASNAME
        M3UA    PARTIAL   as5

        ANAMES
        assoc5

    RCONTEXT        DPC       SI SSN      OPC       CICS       CICE
    20            002-002-002  3 *** -------------- ---------- ----------

        ADPTR   TYPE      ASNAME
        SUA     PARTIAL   as8

        ANAMES
        assoc8

    Route Key table is (2 of 1000) 1% full
    Route Key Socket Association table is (2 of 16000) 1% full

    END OF LOG REPORT 
;

This example shows output when the 2500 Routing Keys feature is enabled. The maximum number of routing keys allowed in the system is 2500. The maximum number of entries in the Static Route Key Socket Association table is 40,000.

rtrv-appl-rtkey

    rlghncxa03w 08-04-11 14:03:05 EST  EAGLE 38.0.0
   
    RCONTEXT        DPC       SI  ADPTR   ASNAME           TYPE
    ----------    008-008-008  *  M3UA    as5              PARTIAL
    ----------    002-002-002 10  M3UA    as2              FULL
    ----------    001-001-001  *  M3UA    as11             PARTIAL
    ----------    001-001-001 10  M3UA    as11             FULL
    ----------    001-001-001  3  M3UA    as12             FULL
    ----------    002-002-002  9  M3UA    as14             FULL

    RCONTEXT        DPCI      SI  ADPTR   ASNAME           TYPE
    ----------    7-007-7      *  M3UA    as14             PARTIAL
    ----------    7-007-7      4  M3UA    as15             FULL

    RCONTEXT        DPC       SI  ADPTR   ASNAME           TYPE
    ----------    *********** **  M3UA    as1              DEFAULT
    ----------    *********** 10  M3UA    as12             PARTIAL

    Route Key table is (10 of 2500) 1% full
    Route Key Socket Association table is (10 of 40000) 1% full

    END OF LOG REPORT 
;
rtrv-appl-rtkey

    rlghncxa03w 08-04-11 13:17:09 EST  EAGLE 38.0.0
    
    RCONTEXT        DPC       SI  ADPTR   ASNAME           TYPE
    ----------    008-008-008  *  M3UA    as5              PARTIAL
    ----------    002-002-002 10  M3UA    as2              FULL
    ----------    001-001-001  *  M3UA    as11             PARTIAL
    ----------    001-001-001 10  M3UA    as11             FULL
    ----------    001-001-001  3  M3UA    as12             FULL
    ----------    002-002-002  9  M3UA    as14             FULL
    10            002-002-002  *  M3UA    as8              PARTIAL

    RCONTEXT        DPCI      SI  ADPTR   ASNAME           TYPE
    ----------    7-007-7      *  M3UA    as14             PARTIAL
    ----------    7-007-7      4  M3UA    as15             FULL

    RCONTEXT        DPC       SI  ADPTR   ASNAME           TYPE
    ----------    *********** **  M3UA    as1              DEFAULT
    ----------    *********** 10  M3UA    as12             PARTIAL

    RCONTEXT        DPCN16    SI  ADPTR   ASNAME           TYPE
    ----------    121-007-10   *  M3UA    as14             PARTIAL
    ----------    121-007-11   4  M3UA    as15             FULL


    Route Key table is (11 of 1000) 1% full
    Route Key Socket Association table is (11 of 16000) 1% full

    END OF LOG REPORT 
;