GKREG - Gatekeeper Registry

AMO GKREG is used to configure gatekeeper registration data for internal and external gateways.
The internal Gateways have to be configured with the AMO CGWB first, providing values for the Gateway IP address and the Gateway directory number. Those two parameters cannot be modified by the AMO GKREG.
During configuration the AMO GKREG will store some additional data for the digit analysis result gateway if it has been configured before with AMO WABE for the corresponding Gateway Directory Number. If AMO WABE will be called at a later time, the additional information (Gateway number) for the digit analysis result gateway will be configured by running any GKREG CHANGE command for the respective Gateway number.
The expression external Gateway is used for all Gateways configured on a remote PBX. The expression internal Gateway is used for all Gateways configured on the local PBX.

Cross Reference to Other AMOs:

AMO DIMSU: Dimensioning of features, switching unit
AMO ZANDE: System data - extended
AMO BCSU: Configuration of boards
AMO CGWB: Configuration of HG3500 board data
AMO WABE: dialing plans, feature access codes

Destination Processor: BP (Switching Unit)

Functions

ADD Add gateway registry data password class 2
CHANGE Change gateway registry data password class 2
DELETE Delete gateway registry data password class 2
DISPLAY Display gateway registry data password class 0
REGENERATE Regenerate gateway registry data password class 2

Procedure Overview

ADD-GKREG

ADD-GKREG GWNO=<number>, GWATTR=<param>, [GWIPADDR=<number>], [GWDIRNO=<key-num>], DIPLNUM=<number>, DPLN=<number>, LAUTH=<number>, [INFO=<string>], [SECLEVEL=<param>], [PORT=<number>];

This action is used to configure gatekeeper registration data for internal and external gateways.
The internal gateways have to be configured with the AMO CGWB before.

Input:

 ADD-GKREG:1,INTGW,,,12,123,840,8,2&6;
ADD-GKREG:2,EXTGW,210.12.75.134,4567,9,80,340,4,5&6;

CHANGE-GKREG

CHANGE-GKREG GWNO=<number>, {(min 1) GWATTR=<param>, GWIPADDR=<number>, GWDIRNO=<key-num>, DIPLNUM=<number>, DPLN=<number>, LAUTH=<number>, INFO=<string>, SECLEVEL=<param>, PORT=<number>};

This action is used to change gatekeeper registration data for internal and external gateways.
Changing of gateway attributes from internal to external and vice versa is not possible.

Example

Input:

 CHA-GKREG:1,INTGW&HG3550V2; 

DELETE-GKREG

DELETE-GKREG GWNO=<number>;

This action is used to delete gatekeeper registration data for internal and external gateways.
For internal Gateways the data configured with AMO GKREG and the data configured with AMO CGWB will both be removed.

Example

Input:

 DEL-GKREG:1&3&&6; 

DISPLAY-GKREG

DISPLAY-GKREG {(max 1) GWNO=<number>, GWATTR=<param>, GWIPADDR=<number>, PORT=<number>}, [INFO=<string>];

This action is used to display gatekeeper registration data for internal and external gateways.

Example

Input:

 DISP-GKREG; 

Output:

 +-----------------------------------------------------------------------------+ 
| GWNO 2 GWATTR INTGW SIP |
| GWIPADDR 139.25 .43 .80 GWDIRNO 1 |
| PORT 0 |
| DIPLNUM 840 DPLN 8 |
| LAUTH 2&6 |
| IP GATEWAY IS CONFIGURED BY GKREG |
| INFO: HG1_1_79SEV_2 |
+-----------------------------------------------------------------------------+
| GWNO 21 GWATTR EXTGW SIP |
| GWIPADDR 218.1 .63 .114 GWDIRNO 885591 |
| PORT 0 |
| DIPLNUM 0 DPLN 0 |
| LAUTH 5&6 |
| IP GATEWAY IS CONFIGURED BY GKREG |
| INFO: |
+-----------------------------------------------------------------------------+

REGENERATE-GKREG

REGENERATE-GKREG {(max 1) GWNO=<number>, GWATTR=<param>, GWIPADDR=<number>, PORT=<number>}, [INFO=<string>];

This action is used to regenerate gatekeeper registration data for internal and external gateways.

Example

Input:

 REGEN-GKREG; 

Output:

 ADD-GKREG:1,INTGW&HG3550V1,,,1234,12,23,;
ADD-GKREG:6,EXTGW,212.220.212.210,44,6,9,44,;

Parameter description

DIPLNUM lcr dialing plan number
Type of Input: single value, 4. parameter of a min-1-group (CHANGE)
single value, mandatory (ADD)
Possible Values: numeric, 0-2047
DPLN dial plan
Type of Input: single value, 5. parameter of a min-1-group (CHANGE)
single value, mandatory (ADD)
Possible Values: numeric, 0-63
GWATTR Gateway attribute
Type of Input: 1 to 4 single values, concatenated with &, 1. parameter of a min-1-group (CHANGE)
1 to 4 single values, concatenated with &, 2. parameter of a max-1-group (DISPLAY / REGENERATE)
1 to 4 single values, concatenated with &, mandatory (ADD)
Possible Values: EXTGW external gateway DB_AM_LEGK_GW_EXTERNAL
H323 Gateway has H323 Capability DB_AM_LEGK_GW_H323
H323ANN Gateway has H323ANN Capability DB_AM_LEGK_GW_H323ANN
HG3550V1 HG3550 V1 gateway DB_AM_LEGK_GW_HG3550_V1
HG3550V2 HG3550 V2 gateway DB_AM_LEGK_GW_HG3550_V2
INTGW internal gateway DB_AM_LEGK_GW_INTERNAL
REGGW gateway where registration is allowed DB_AM_LEGK_GW_REG_ALLOWED
SIP Gateway has SIP Capability DB_AM_LEGK_GW_SIP
SIPQ Gateway has SIPQ Capability DB_AM_LEGK_GW_SIPQ
GWDIRNO Gateway directory number
Type of Input: single value, 3. parameter of a min-1-group (CHANGE)
single value, optional (ADD)
Possible Values: 0-9,*,#,A-D, up to 22 characters
GWIPADDR Gateway IP address
Type of Input: 4 single values, concatenated with ., 2. parameter of a min-1-group (CHANGE)
4 single values, concatenated with ., 3. parameter of a max-1-group (DISPLAY / REGENERATE)
4 single values, concatenated with ., optional (ADD)
Possible Values: numeric, 0-255
GWNO HG3550 Gateway Number
Type of Input: 1 to 10 single values, concatenated with & or &&, 1. parameter of a max-1-group (DISPLAY / REGENERATE)
1 to 10 single values, concatenated with & or &&, mandatory (DELETE)
single value, mandatory (ADD / CHANGE)
Possible Values: numeric, 1-9999
INFO service info
Type of Input: single value, 7. parameter of a min-1-group (CHANGE)
single value, optional (ADD / DISPLAY / REGENERATE)
Possible Values: text, up to 50 characters
LAUTH lcr authorisation level
Type of Input: 1 to 16 single values, concatenated with &, 6. parameter of a min-1-group (CHANGE)
1 to 16 single values, concatenated with &, mandatory (ADD)
Possible Values: numeric, 1-64
PORT PORT for external gateways
Type of Input: single value, 4. parameter of a max-1-group (DISPLAY / REGENERATE)
single value, 9. parameter of a min-1-group (CHANGE)
single value, optional (ADD)
Possible Values: numeric, 0-65535
SECLEVEL security level of the gateway
Type of Input: single value, 8. parameter of a min-1-group (CHANGE)
single value, optional (ADD)
Possible Values: SECURE SECURE gateway DB_SPE_SEC_LEV_SECURE
STANDARD STANDARD gateway DB_SPE_SEC_LEV_STANDARD
TRADITIO Traditional gateway DB_SPE_SEC_LEV_TRADITIONAL

Error Messages

F01
F01: THERE IS NO GATEKEEPER SET UP ON THE SWITCH (AMO ZANDE, GATEKPR)
F02
F02: THE VALUES 0.0.0.0 AND 255.255.255.255 ARE NOT ALLOWED AS INPUT 
     FOR THE GATEWAY IP ADDRESS
F03
F03: THE GATEWAY IP ADDRESS AND THE GATEWAY DIRECTORY NUMBER FOR AN INTERNAL
     GATEWAY HAVE TO BE ADMINISTERED WITH THE AMO CGWB
F04
F04: GATEWAY ATTRIBUTE INTGW AND EXTGW MUST NOT BE USED TOGETHER
F05
F05: THE PARAMTERS GWIPADDR AND GWDIRNO ARE MANDATORY FOR EXTERNAL
     GATEWAY CONFIGURATION
F06
F06: GWATTR TYPE CANNOT BE CHANGED FROM INTERNAL TO EXTERNAL OR VICE VERSA
F07
F07: THE PARAMETER GWATTR HAS TO CONTAIN ONE OF THE VALUES INTGW OR EXTGW
F08
F08: GWNR @@@@ IS ALREADY CONFIGURED
F09
F09: GWNR @@@@ IS NOT CONFIGURED
F10
F10: GATEWAY HAS BEEN CONFIGURED ALREADY AS INTERNAL WITH THE AMO CGWB
F11
F11: INSUFFICIENT MEMORY SPACE (AMO DIMSU: PARAMETER GWREG)
F12
F12: THE SECTOR IS STILL ASSIGNED TO A GATEWAY AT PEN @@-@@-@@@
     (AMO CGWB/AMO GKREG).
F13
F13: THE SECTOR IS STILL ASSIGNED AT GWNO = @@@@ (AMO GKREG).
F14
F14: THE GATEWAY DIRECTORY NUMBER ENTERED IN PARAMETER GWDIRNO IS ALREADY
     CONFIGURED FOR GATEWAY @@@@. 
F15
F15: THE GATEWAY IP-ADDRESS AND THE GATEWAY PORT NUMBER 
     ARE ALREADY CONFIGURED FOR GATEWAY @@@@.
F16
F16: 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=;                          
F17
F17: GATEWAY ATTRIBUTE H323, H323ANN, SIP AND SIPQ MUST NOT BE USED TOGETHER
F19
F19: ENTERED GATEWAY ATTRIBUTE  FOR TRUNK  PROTOCOL (GWATTR = @@@@@@@)
     DOES NOT MATCH WITH CONFIGURED PROTOCOL IN AMO CGWB
     (@@@@@@@@ = 0).

Advisory Messages

H01
H01: GATEWAY ATTRIBUTE INTERNAL IS ENTERED, THE VALUES FOR THE  GATEWAY
     IP ADDRESS , THE GATEWAY DIRECTORY NUMBER AND SECLEVEL ARE IGNORED
H02
H02: THE ADDITIONAL DATA HAS BEEN CONFIGURED FOR DIGIT ANALYSIS RESULT GATEWAY
H03
H03: ELEMENT @@@@ HAS BEEN DELETED
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: FOR AN EXTERNAL GATEWAY THE TRUNK PROTOCOL IN PARAMETER GWATTR 
     CANNOT BE CHECKED FOR VALIDITY.MAKE SURE THAT THE MATCHING ATTRIBUTE
     IS CONFIGURED, OTHERWISE NO CONNECTION CAN BE ESTABLISHED TO THE GATEWAY!
H06
H06: EXTERNAL GATEWAY IS REGISTERED, PLEASE CHECK SECURITY LEVEL OF THE
     ASSIGNED TRUNKS TO PREVENT FROM INCONSISTENCY.
H07
H07: DHCP IS ACTIVATED. LEGK CONFIGURATIONS ARE SUSPENDED
     FOR THE ACTUAL GATEWAY.
H08
H08: REGGW IS NOT TAKEN IN CONSIDERATION.