GKTOP - Topology Configuration for Gate Keeper


Overview
Administration of the network topology data comprises following topics:
- Resource Management/ Sector Administration
- IP Trunking Path Resolution (external master connection)
- IPDA Sector Path Resolution (internal master connection)
Resource Management
The sector attributes determine the kind of sector. Additional static data (especially the 'bandwidth' resource) is assigned to a sector with AMO GKTOP. When a new sector is added, the network node of the responsible resource manager is assigned with the network node number.
IP Trunking Path Resolution (external master connection)
A sector path description describes how each destination gateway can be reached in the network. It consists of sectors that have to be passed. These paths are needed for determining the available resources. A sector path sequence consists of at least one sector (for example a LAN or WAN sector). It must not contain the source and destination sector number. A sequence of up to 50 sectors can be added as a sector path for IP trunking. With CHANGE-GKTOP already added sector paths can be modified.
IPDA Sector Path Resolution (internal master connection)
Groups of subscribers or trunks that can be reached in the same way, are combined to a cluster (for example TDM devices on an access point or all subscriber on a HFA board). A HFA sector and/or a GW sector is assigned to a cluster. In the following, device or trunk AMOs assign these clusters to devices or trunks.

Cross Reference to Other AMOs:

AMO DIMSU : Memory Allocation
AMO STMIB : Configuration of HG35xx and HG35xx-2 boards
AMO GKREG : Gatekeeper Registry

Destination Processor: BP (Switching Unit)

Functions

ADD Add Gate Keeper Topology password class 5
CHANGE Change Gate Keeper Topology password class 5
DELETE Delete Gate Keeper Topology password class 5
DISPLAY Display Gate Keeper Topology password class 5
REGENERATE Regenerate Gate Keeper Topology password class 5

Procedure Overview

ADD-GKTOP

ADD-GKTOP
TYPE=RESMGMT1,[SECNO=<number>], SECATTR=<param>, PNNO=<number>, [BANDWI=<string>], [GWLAN=<number>], [SECPANO1=<number>], [SECPANO2=<number>], [SECPANO3=<number>], [INFO=<string>];
TYPE=RESMGMT2,SECNO=<number>, PNNO=<number>;
TYPE=SECPATH,[SECPANO=<number>], SECDE=<number>;
TYPE=IPDA,[CLUSTID=<number>], {(min 1) HFASEC=<number>, GWSEC=<number>};

With this action new sectors can be added. Additional resource managers can be assigned to a sector by means of their network nodes. The sector path resolution for IP trunking and IPDA can be defined.

Examples
  1. Adding a new sector path.

    2. Input: 

     ADD-GKTOP:TYPE=SECPATH,SECPANO=11,SECDE=7&8&9;

    Output: 

     ADD-GKTOP:TYPE=SECPATH,SECPANO=19,SECDE=7&8&9; 
     H500:  AMO GKTOP STARTED
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY 
     ADD COMPLETED;
  2. Adding a new sector.

    3. The parameter SECNO can remain unspecified. In this case the next free sector number is searched automatically. The sector attributes determine the kind of configured sector. The bandwidth is given in kBit/s. With AMO GKREG a reference on a sector is configured for a gateway. For NCUI/STMI a reference to a sector is configured with AMO STMIB/CGWB.

    Input: 

     ADD-GKTOP:TYPE=RESMGMT1,SECNO=10,SECATTR=OWN&LAN&EXCL,PNNO=1-10-234,SECPANO1=5;

    Output: 

     ADD-GKTOP:TYPE=RESMGMT1,SECNO=10,SECATTR=OWN&LAN&EXCL,PNNO=1-10-234,
     SECPANO1=5;
     H500:  AMO GKTOP STARTED
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY 
     ADD COMPLETED;
  3. Adding a new cluster.

    4. If the parameter CLUSTID is not specified a free cluster ID is automatically searched.

    Input: 

     ADD-GKTOP:TYPE=IPDA,GWSEC=12;

    Output: 

     EINR-GKTOP:TYP=IPDA,GWSEK=12;
     H500:  AMO GKTOP STARTED
     H03: CLUSTER ID 1 WAS CONFIGURED.
     H500:  AMO GKTOP STARTED
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY 
     ADD COMPLETED;

CHANGE-GKTOP

CHANGE-GKTOP
TYPE=RESMGMT1,SECNO=<number>, {(min 1) SECATTR=<param>, PNNO=<number>, BANDWI=<string>, GWLAN=<number>, SECPANO1=<number>, SECPANO2=<number>, SECPANO3=<number>, INFO=<string>};
TYPE=SECPATH,SECPANO=<number>, SECIDX=<number>, [SECNEW=<number>], MODE=<param>;
TYPE=IPDA,CLUSTID=<number>, {(min 1) HFASEC=<number>, GWSEC=<number>};

With this action it is possible to change data for existing sectors or the sector path resolution. Sectors can be changed (added/removed/overwritten) within existing sector paths.

Examples
  1. Changing a sector path.

    2. Adding sector 6 instead of sector with index 2 in sectorpath 11. With MODE=OVERW the sector number is overwritten.

    Input:

     CHANGE-GKTOP:TYPE=SECPATH,SECPANO=11,SECIDX=2,SECNEW=6,MODE=OVERW;

    Output:

     CHANGE-GKTOP:TYPE=SECPATH,SECPANO=11,SECIDX=2,SECNEW=6,MODE=OVERW; 
     H500:  AMO GKTOP STARTED 
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY  
     CHANGE COMPLETED;
  2. Changing sector data.

    3. Only the specified parameters are changed. Sector path number 0 is used for resetting the entry (e.g. SECPANO2=0).

    Input:

     CHANGE-GKTOP:TYPE=RESMGMT1,SECNO=10,BANDWI=42369;

    Output:

     CHANGE-GKTOP:TYPE=RESMGMT1,SECNO=10,BANDWI=42369;
     H500:  AMO GKTOP STARTED 
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY  
     CHANGE COMPLETED;
  3. Changing a cluster.

    4. Input:

     CHANGE-GKTOP:TYPE=IPDA,CLUSTID=1,GWSEC=13;

    Ausgabe:

     CHANGE-GKTOP:TYPE=IPDA,CLUSTID=1,GWSEC=13;
     H500:  AMO GKTOP STARTED 
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY  
     CHANGE COMPLETED;

DELETE-GKTOP

DELETE-GKTOP
TYPE=RESMGMT1,SECNO=<number>;
TYPE=RESMGMT2,SECNO=<number>, PNNO=<number>;
TYPE=SECPATH,SECPANO=<number>;
TYPE=IPDA,CLUSTID=<number>;

Sectors or sector paths for IP trunking or IPDA can be deleted with this action.

  1. Deleting a single resource manager assignment.

    2. Input:

     DELETE-GKTOP:TYPE=RESMGMT2,PNNO=1-10-235,SECNO=10;

    Output:

     DELETE-GKTOP:TYPE=RESMGMT2,PNNO=1-10-235,SECNO=10;
     H500:  AMO GKTOP STARTED
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY
     DELETE COMPLETED;
  2. Deleting a sector and all resource manager assignments.

    3. Input:

     DELETE-GKTOP:TYPE=RESMGMT1,SECNO=10;

    Output:

     DELETE-GKTOP:TYPE=RESMGMT1,SECNO=10; 
     H500:  AMO GKTOP STARTED
     H07: TAKE CARE TO REMOVE THIS SECTOR FROM SECTOR PATH DESCRIPTIONS.
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY
     DELETE COMPLETED;

DISPLAY-GKTOP

DISPLAY-GKTOP
TYPE=ALL,[SCOPE=<param>];
TYPE=RESMGMT1,[SECNO=<number>], [SCOPE=<param>], [INFO=<string>];
TYPE=RESMGMT2,[SECNO=<number>], [SCOPE=<param>];
TYPE=SECPATH,[SECPANO=<number>];
TYPE=IPDA,[CLUSTID=<number>];

With this action static and dynamic sector data as well as sector paths can be displayed.

Examples
  1. Display all sector data.

    Channels for master connections (GWCHAMC) are not administered, but only displayed, as long as unequal zero.
    Following dynamic data is displayed:

    2. Number of remaining channels is calculated by substracting the actual used channels from the number of available channels. This means also that it has no influence if the boards in this sector are active or just configured.

    Input:

     DISPLAY-GKTOP:TYPE=RESMGMT1,SECNO=7,SCOPE=ALL;

    Output:

     DISPLAY-GKTOP:TYPE=RESMGMT1,SECNO=7,SCOPE=ALL;
     H500:  AMO GKTOP STARTED
        -----------------------------------------------------------------------+
        10-05-2005   06:38:29                                                   
        ---------+-------------------------------------------------------------+
        SECTOR   |                 7                                           |
        ---------+-------------------------------------------------------------+
        INFO     |                                                             |
        PNNO     |         1- 10-235                                           |
        SECATTR  |      OWN     EXCL                                           |
        BANDWI   |             42000                                           |
        GWCHAMC  |                                                             |
        GWLAN    |                                                             |
        SECPANR1 |                                                             |
        SECPANR2 |                 5                                           |
        SECPANR3 |                                                             |
        ---------+-------------------------------------------------------------+
        S-BW     |             41990                                           |
        USED-BW  |                10                                           |
        R-GW-MC  |                                                             |
        R-GW-DMC |                                                             |
        ---------+-------------------------------------------------------------+
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY 
     DISPLAY COMPLETED;
  2. Display a sector path.

    3. Input: 

     DISPLAY-GKTOP:TYPE=SECPATH,SECPANO=11;

    Output: 

     DISPLAY-GKTOP:TYPE=SECPATH,SECPANO=11; 
     H500:  AMO GKTOP STARTED 
        -----------------------------------------------------------------------+
        10-05-2005   06:38:29                                                   
        ---------+-------------------------------------------------------------+
        SECPANO  |                11                                           |
        ---------+-------------------------------------------------------------+
        SECIDX   |     1     2     3     4     5     6     7     8     9     0 |
        SECPATH  |     7     6     9                                           |
        ---------+-------------------------------------------------------------+
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY 
     DISPLAY COMPLETED;
  3. Display cluster data.

    4. Input: 

     DISPLAY-GKTOP:TYPE=IPDA,CLUSTID=1;

    Ausgabe: 

     DISPLAY-GKTOP:TYPE=IPDA,CLUSTID=1; 
     H500:  AMO GKTOP STARTED  
        -----------------------------------------------------------------------+
        10-05-2005   06:38:29                                                   
        ---------+-------------------------------------------------------------+
        CLUSTID  |                 1                                           |
        ---------+-------------------------------------------------------------+
        HFASECNO |                                                             |
        GW-SECNO |                13                                           |
        ---------+-------------------------------------------------------------+
     AMO-GKTOP-62        GATE KEEPER TOPOLOGY 
     DISPLAY COMPLETED;

REGENERATE-GKTOP

REGENERATE-GKTOP
TYPE=ALL;
TYPE=RESMGMT1, {(max 1) SECNO=<number>, GWNO=<number>}, [INFO=<string>];
TYPE=RESMGMT2, {(max 1) SECNO=<number>, GWNO=<number>};
TYPE=SECPATH,[SECPANO=<number>];
TYPE=IPDA,[CLUSTID=<number>];

With this action sector data as well as sector paths can be regenerated.

Parameter description

BANDWI Bandwidth for master connection (kBit/s
Type of Input: single value, 3. parameter of a min-1-group (CHANGE,TYPE=RESMGMT1-sector data)
single value, optional (ADD,TYPE=RESMGMT1-sector and first nw node)
Possible Values: text, up to 10 characters
CLUSTID Cluster ID in the cluster sector table
Type of Input: single value, mandatory (CHANGE,TYPE=IPDA-IPDA Sector Path Resolution / DELETE,TYPE=IPDA-IPDA Sector Path Resolution)
single value, optional (ADD,TYPE=IPDA-IPDA Sector Path Resolution / DISPLAY,TYPE=IPDA-IPDA Sector Path Resolution / REGENERATE,TYPE=IPDA-IPDA Sector Path Resolution)
Possible Values: numeric, 1-512
GWLAN Sectornumber of the LAN, to which the gateway is connected.
Type of Input: single value, 4. parameter of a min-1-group (CHANGE,TYPE=RESMGMT1-sector data)
single value, optional (ADD,TYPE=RESMGMT1-sector and first nw node)
Possible Values: numeric, 0-2400
GWNO gateway number
Type of Input: 1 to 2 single values, concatenated with &&, 2. parameter of a max-1-group
Possible Values: numeric, 0-65535
GWSEC Gateway Sectornumber
Type of Input: single value, 2. parameter of a min-1-group
Possible Values: numeric, 1-2400
HFASEC HFA sectornumber
Type of Input: single value, 1. parameter of a min-1-group
Possible Values: numeric, 1-2400
INFO info text for the service
Type of Input: single value, 8. parameter of a min-1-group (CHANGE,TYPE=RESMGMT1-sector data)
single value, optional (ADD,TYPE=RESMGMT1-sector and first nw node / DISPLAY,TYPE=RESMGMT1-sector administration data / REGENERATE,TYPE=RESMGMT1-sector administration data)
Possible Values: text, up to 50 characters
MODE Insert / Overwrite / Remove sector
Type of Input: single value, mandatory
Possible Values: INS insert new sector behind index LI_MODE_EINFUEGEN
OVERW Overwrite sector at index LI_MODE_UEBERSCHREIBEN
REM Remove sector at index LI_MODE_ENTFERNEN
PNNO Physical node number for unambiguous identification in network (see AMO ZAND). The node number can have 1 to 3 levels. Form:
<level2>-<level1>-<level0> (e.g. 1-2-3 or 3-15 => corresponds to 0-3-15, or 222 => corresponds to 0-0-222).
The levels must be built up from low level to high level (not valid : e.g. 1-0-12 or 1-0-0).
All node numbers in net must be adapted to the top level. The allowed ranges for levels are:
Level0 = 0 - 999
Level1 = 0 - 253
Level2 = 0 - 29
Type of Input: 1 to 3 single values, concatenated with -, 2. parameter of a min-1-group (CHANGE,TYPE=RESMGMT1-sector data)
1 to 3 single values, concatenated with -, mandatory (ADD,TYPE=RESMGMT1-sector and first nw node / ADD,TYPE=RESMGMT2-additional nw nodes to sector / DELETE,TYPE=RESMGMT2-nw node from sector)
Possible Values: numeric, 0-999
SCOPE display scope
Type of Input: single value, optional
Possible Values: ALL all data (static and dynamic) LI_DISPLAY_SCOPE_ALL (DISPLAY,TYPE=ALL-all gate keeper administration data)
DYN dynamic data LI_DISPLAY_SCOPE_DYNAMIC (DISPLAY,TYPE=ALL-all gate keeper administration data)
STA configured static data LI_DISPLAY_SCOPE_STATIC (DISPLAY,TYPE=ALL-all gate keeper administration data)
SECATTR Sectorattributes
Type of Input: 1 to 14 single values, concatenated with &, 1. parameter of a min-1-group (CHANGE,TYPE=RESMGMT1-sector data)
1 to 14 single values, concatenated with &, mandatory (ADD,TYPE=RESMGMT1-sector and first nw node)
Possible Values: AP Sector situated in an AP DB_RESM_S_ATT_AP
EXCL Sector administered by only one resource manager DB_RESM_S_ATT_EXCLUSIVE
FOREIGN1 Sector of foreign node with own resource manager DB_RESM_S_FOREIGN
FOREIGN2 Sector represents IP trunking GW of a foreign node without resssource manager DB_RESM_S_FOREIGN_RESP
GW Sector represents one of the gateways DB_RESM_S_ATT_GW
HHS Sector situated in hhs DB_RESM_S_ATT_HHS
LAN Sector represents a LAN DB_RESM_S_ATT_LAN
NODMC Prevent DMC connection DB_RESM_S_ATT_NO_DMC
OWN sector belongs to own node DB_RESM_S_OWN
UPDATE Update bandwidth and counter values DB_RESM_S_ATT_UPD
WAN Router for WAN connection DB_RESM_S_ATT_WAN
SECDE Sectornumbers which describe a sector path . "
Type of Input: 1 to 50 single values, concatenated with &, mandatory
Possible Values: numeric, 1-2400
SECIDX Sectorindex behind which the new sector will be inserted
Type of Input: single value, mandatory
Possible Values: numeric, 1-50
SECNEW Sectornumber to be inserted
Type of Input: single value, optional
Possible Values: numeric, 1-2400
SECNO sector number
Type of Input: 1 to 10 single values, concatenated with & or &&, 1. parameter of a max-1-group (REGENERATE,TYPE=RESMGMT1-sector administration data / REGENERATE,TYPE=RESMGMT2-nw node from sector)
1 to 10 single values, concatenated with & or &&, optional (DISPLAY,TYPE=RESMGMT1-sector administration data / DISPLAY,TYPE=RESMGMT2-nw node from sector)
single value, mandatory (ADD,TYPE=RESMGMT2-additional nw nodes to sector / CHANGE,TYPE=RESMGMT1-sector data / DELETE,TYPE=RESMGMT1-sector and all connected nw nodes / DELETE,TYPE=RESMGMT2-nw node from sector)
single value, optional (ADD,TYPE=RESMGMT1-sector and first nw node)
Possible Values: numeric, 1-2400
SECPANO Sector pathnumber to IP sector path table
Type of Input: single value, mandatory (CHANGE,TYPE=SECPATH-Sector path description / DELETE,TYPE=SECPATH-Sector path description)
single value, optional (ADD,TYPE=SECPATH-Sector path description / DISPLAY,TYPE=SECPATH-Sector path description / REGENERATE,TYPE=SECPATH-Sector path description)
Possible Values: numeric, 1-65535
SECPANO1 Sector pathnumber of a path to the HHS (starting with the sector next to the HHS)
Type of Input: single value, 5. parameter of a min-1-group (CHANGE,TYPE=RESMGMT1-sector data)
single value, optional (ADD,TYPE=RESMGMT1-sector and first nw node)
Possible Values: numeric, 0-65535
SECPANO2 Sector pathnumber of a path leading to a foreign sector (for DMC connections) starting from the HHS
Type of Input: single value, 6. parameter of a min-1-group (CHANGE,TYPE=RESMGMT1-sector data)
single value, optional (ADD,TYPE=RESMGMT1-sector and first nw node)
Possible Values: numeric, 0-65535
SECPANO3 Sector path number of a path for back reference to the original gateway (for IP-trunking)
Type of Input: single value, 7. parameter of a min-1-group (CHANGE,TYPE=RESMGMT1-sector data)
single value, optional (ADD,TYPE=RESMGMT1-sector and first nw node)
Possible Values: numeric, 0-65535
TYPE Option
Type of Input: single value, mandatory
Possible Values: ALL all gate keeper administration data (DISPLAY / REGENERATE)
IPDA IPDA Sector Path Resolution
RESMGMT1 sector administration data (DISPLAY / REGENERATE)
RESMGMT1 sector and all connected nw nodes (DELETE)
RESMGMT1 sector and first nw node (ADD)
RESMGMT1 sector data (CHANGE)
RESMGMT2 additional nw nodes to sector (ADD)
RESMGMT2 nw node from sector (DELETE / DISPLAY / REGENERATE)
SECPATH Sector path description

Error Messages

F01
F01: COMBINATION OF FOLLOWING SECTORATTRIBUTES NOT PERMITTED:
     @@@@@@@@ - @@@@@@@@
F02
F02: ENTERED SECTOR IS ALREADY CONFIGURED.
F03
F03: ALL SECTORS ARE ALREADY CONFIGURED. NO MORE FREE SECTOR AVAILABLE.
F04
F04: ENTERED SECTOR IS NOT YET CONFIGURED.
F05
F05: NO MEMORY. INCREASE MEMORY WITH AMO DIMSU - PARAMETER SCTPATH
F06
F06: ENTERED SECTOR PATH IS ALREADY CONFIGURED.
F07
F07: ENTERED CLUSTER IS ALREADY CONFIGURED.
F08
F08: ENTERED SECTORINDEX IS INVALID.
F09
F09: SECTOR TABLE IS FULL. NO MORE ENTRY POSSIBLE.
F10
F10: REMOTE NODE COULD NOT BE DELETED.
F11
F11: ENTERED SECTORPATH COULD NOT BE DELETED.
F12
F12: ENTERED CLUSTER COULD NOT BE DELETED.
F13
F13: INTERNAL DATABASE READ ERROR.
F14
F14: INTERNAL DATABASE WRITE ERROR.
F15
F15: A COMMAND TYPE=RESMGMT2 IS NOT ALLOWED FOR SECTORS WITH ATTRIBUTE EXCL.
F16
F16: IF A SECTOR SHALL BE INSERTED OR OVERWRITTEN, A SECTOR NUMBER
     MUST BE ENTERED.
F17
F17: VALUE FOR BANDWIDTH IS NOT ALLOWED.
F18
F18: ENTERED CLUSTER IS NOT CONFIGURED.
F19
F19: ENTERED SECTOR PATH IS NOT CONFIGURED.
F20
F20: ENTERED NETWORK NODE NUMBER IS ALREADY CONFIGURED.
F21
F21: SECTOR ATTRIBUTE EXCL MUST BE ENTERED.
F22
F22: THE SECTOR IS STILL ASSIGNED TO A GATEWAY AT PEN @@-@@-@@@
     (AMO STMIB/AMO GKREG).
F23
F23: ENTERED CLUSTER ID IS INVALID.
F24
F24: FOLLWING SECTOR NUMBER(S) OCCURE(S) MORE THEN ONCE IN THE SECTOR-PATH:
F25
F25: PNNO LEVEL<level> = <nodenr> NOT ALLOWED. RANGE 0 TO <maxval>.

Advisory Messages

H01
H01: SECTOR @@@@ WAS CONFIGURED.
H02
H02: SECTOR PATH NUMBER @@@@ WAS CONFIGURED.
H03
H03: CLUSTER ID @@@@ WAS CONFIGURED.
H04
H04: SERVICEINFO COULD NOT BE WRITTEN.           
     POSSIBLE REASONS:                           
     - ALL INFO FIELDS IN DATAPOOL ARE IN USE.   
       AMOUNT MUST BE INCREASED.                 
     - NOT ENOUGH MEMORY FOR DATAPOOL.           
     INCREASE MEMORY BY MEANS OF                 
       ADD-DIMSU:INFO=;
H05
H05: SERVICEINFO COULD NOT BE DELETED.
H06
H06: VALUE OF PARAMETER @@@@@@@@ IS INVALID 
     (PATH @@@@@@@@ IS NOT CONFIGURED).
H07
H07: TAKE CARE TO REMOVE THIS SECTOR FROM SECTOR PATH DESCRIPTIONS.
H08
H08: THE SECTOR IS ASSIGNED TO A GATEWAY AT PEN @@-@@-@@@
     (AMO STMIB/AMO GKREG).
H09
H09: AT LEAST ONE SECTOR-NUMBER HAS TO BE EXIST.
H10
H10: THE ENTERED PHYSICAL NODE NUMBER @@@-@@@-@@@ IS NOT THE SAME 
     CONFIGURED IN CENTRAL SWITCH DATA ( DISPLAY-ZAND:ALLDATA)
H11
H11: 2400 RECORD CAN ONLY BE DISPLAYED AT ONE TIME.