SupportResource CenterH3C XE 200 2000 IP PBXCommand
Chapters Download(123 KB)
Table of Contents
1.1.1 debugging process-server
1.1.2 display debugging process-server
1.1.3 display process-server call-information
1.1.4 display process-server location-server status
1.1.5 display process-server statistics
1.1.12 policy call-interrupt-by-long-time
1.1.13 policy call-interrupt-time
1.1.16 reset process-server statistics
Syntax
debugging process-server { adapter | all | bkm | cdp | cm | csm | hadpt | hrm | hsm | hstack | om | rm | sm | stack | tucl } level level
undo debugging process-server { adapter | all | bkm | cdp | cm | csm | hadpt | hrm | hsm | hstack | om | rm | sm | stack | tucl }
View
User view
Parameter
adapter: Enables adapter layer debugging.
all: Enables all debugging.
bkm: Enables backup management (BKM) module debugging.
cdp: Enables call distribute process (CDP) module debugging.
cm: Enables call management (CM) module debugging.
hadpt: Enables H.323 adapter module debugging.
hrm: Enables H.323 registration management (HRM) module debugging.
hsm: Enables H.323 subscriber management (HSM) module debugging.
hstack: Enables H.323 stack debugging.
rm: Enables SIP register management (RM) module debugging.
sm: Enables SIP subscriber management (SM) module debugging.
om: Enables operation management (OM) module debugging.
stack: Enables SIP protocol stack debugging.
tucl: Enables TCP/UDP control layer (TUCL) module debugging.
csm: Enables CSM module debugging.
level level: Debugging information level.
Description
Use the debugging process-server command to debug the process server (PS).
Use the undo debugging process-server command to restore the default level of output debugging information.
The argument level can take on a value in the range 0 to 7. By default, the debugging at all levels is disabled. If it is set to 4, the debugging information at levels 1 through 4 is output. If it is set to 0, no debugging information is output.
The following table describes levels of debugging information.
Table 1-1 Debugging information levels
|
Level |
Description |
|
0 |
No debugging information |
|
1: DEBUG_LEVEL_EMERGENCY |
Memory block request failures Timer request failures |
|
2: DEBUG_LEVEL_ALERT |
Void pointer, invalid memory operation PS-LS connection state switch |
|
3: DEBUG_LEVEL_ERROR |
Control block state anomalies/mismatches Invalid/unexpected control block index Invalid/unexpected PID/module ID Function returns failure, affecting the main calling function Invalid message type |
|
4: DEBUG_LEVEL_WARNING |
Function returns failure, without affecting the main calling function Header information of the received messages Abnormal timer timeout State transition |
|
5: DEBUG_LEVEL_NOTIFICATION |
Environment anomalies without affecting operation Key service procedures Header information of the sent messages |
|
6: DEBUG_LEVEL_INFORMATIONAL |
Key processing procedures of the module/function Memory block request/release Normal timer timeout Crucial information in the MD5 algorithm Crucial information in the Hash algorithm |
|
7: DEBUG_LEVEL_DEBUGGING |
Generic procedures Related processing functions, such as extraction and addition of optional IE Contents of the IE list in messages; message contents Description on function entry calling and the returned value |
Example
# Debug the SM module and output the debugging information at levels 1 through 5.
<XE> debugging process-server sm level 5
Syntax
display debugging process-server
View
Any view
Parameter
None
Description
Use the display debugging process-server command to display information about PS debugging levels.
Example
# Display information about PS debugging levels.
<XE2000> display debugging process-server
CM debugging level 3
SM debugging level 3
HSM debugging level 3
RM debugging level 3
HRM debugging level 3
OM debugging level 3
CDP debugging level 3
TUCL debugging level 3
ADPT debugging level 3
STACK debugging level 3
HADPT debugging level 3
HSTACK debugging level 3
CSM debugging level 3
BKM debugging level 3
Syntax
display process-server call-information
View
Any view
Parameter
None
Description
Use the display process-server call-information command to display information about the calls being processed on the PS.
Example
# Display information about the calls being processed on the PS.
[XE] display process-server call-information
NO. CCB-mode CM-CCB Information Caller Callee
------------------------------------------------------------
0 NORMAL 0 TYPE: H323-DEVICE H323-DEVICE
SM/HSM CCB: 0 1
Syntax
display process-server location-server status
View
Any view
Parameter
None
Description
Use the display process-server location-server status command to display state information of the LS (LS) administering this PS.
Example
# Display state information of the LS administering this PS.
[XE] display process-server location-server status
----------- Location Server Information -----------
Location Server index: 0
Mode Local
Connected Process Server: xe200
PS HeartBeat Key: xe200
Heartbeat Status: Authorized
Syntax
display process-server statistics { adapter | all | bkm | cdp | cm | csm | hadpt | hrm | hsm | hstack | rm | sm | stack | tucl }
View
Any view
Parameter
adapter: Displays statistics about the adapter layer.
all: Displays all statistics.
bkm: Displays statistics about the BKM module.
cdp: Displays statistics about the CDP module.
cm: Displays statistics about the CM module.
csm: Displays statistics about the CSM module.
hadpt: Displays statistics about the H.323 adapter module.
hrm: Displays statistics about the HRM module.
hsm: Displays statistics about the HSM module.
hstack: Displays statistics about the H.323 stack.
rm: Displays statistics about the SIP RM module.
sm: Displays statistics about the SIP SM module.
stack: Displays statistics about the SIP protocol stack.
tucl: Displays statistics about the TUCL module.
Description
Use the display process-server statistics command to display statistics about the gatekeeper or process server, such as SIP and H.323 messages sent and received, messages exchanged between internal modules, and timer messages.
Example
# Display statistics about the SM module
<XE> display process-server statistics sm
SAI Message Statistics of SM:
SAI Message total rcv send err dupr dups disc
--------------------------------------------------------------------------
RINGING: 0 0 0 0 0 0 0
REDIRECT: 0 0 0 0 0 0 0
OK: 0 0 0 0 0 0 0
REGISTER: 0 0 0 0 0 0 0
INVITE: 0 0 0 0 0 0 0
ACK: 0 0 0 0 0 0 0
Bye: 0 0 0 0 0 0 0
CANCEL: 0 0 0 0 0 0 0
INFO: 0 0 0 0 0 0 0
PRACK: 0 0 0 0 0 0 0
INVALID SAI: 0 0 0 0 0 0 0
Q931 Message Statistics of SM:
Q931 Message total rcv send err dupr dups disc
--------------------------------------------------------------------------
Setup: 0 0 0 0 0 0 0
Setup Ack: 0 0 0 0 0 0 0
Callproceeding: 0 0 0 0 0 0 0
Progress: 0 0 0 0 0 0 0
Alerting: 0 0 0 0 0 0 0
Connect: 0 0 0 0 0 0 0
Connect Ack: 0 0 0 0 0 0 0
Release: 0 0 0 0 0 0 0
Release Complete: 0 0 0 0 0 0 0
Information: 0 0 0 0 0 0 0
Facility: 0 0 0 0 0 0 0
Status: 0 0 0 0 0 0 0
Redirect: 0 0 0 0 0 0 0
Notify: 0 0 0 0 0 0 0
H245Info: 0 0 0 0 0 0 0
BearInfo: 0 0 0 0 0 0 0
Inter Check: 0 0 0 0 0 0 0
Pre Setup: 0 0 0 0 0 0 0
Pre Ack: 0 0 0 0 0 0 0
BW Request: 0 0 0 0 0 0 0
BW Response: 0 0 0 0 0 0 0
Invalid Q931: 0 - - - - - -
The following table describes the fields on the display process-server statistics sm command.
Table 1-2 Description on the fields of display process-server statistics sm
|
Field |
Description |
|
SAI Message |
Stack application interface (SAI) messages |
|
RINGING |
Ringing messages |
|
REDIRECT |
Redirect messages |
|
OK |
OK messages |
|
REGISTER |
Register messages |
|
INVITE |
Call request messages |
|
ACK |
Acknowledgement messages |
|
Bye |
Call ending messages |
|
CANCEL |
Call cancel messages |
|
INFO |
Information messages |
|
PRACK |
Provisional response acknowledgement messages |
|
INVALID SAI |
Invalid SAI messages |
|
Q931 Message |
Q.931 messages |
|
Setup |
Call setup messages |
|
Setup Ack |
Call setup acknowledgement messages |
|
Callproceeding |
Callproceeding messages |
|
Progress |
Progress messages |
|
Alerting |
Alerting messages |
|
Connect |
Connect messages |
|
Connect Ack |
Connect acknowledgement messages |
|
Release |
Release messages |
|
Release Complete |
Release complete messages |
|
Information |
Information messages |
|
Facility |
Facility messages |
|
Status |
Status messages |
|
Redirect |
Redirect messages |
|
Notify |
Notify messages |
|
H245Info |
H245Info messages |
|
BearInfo |
BearInfo messages |
|
Inter Check |
Inter Check messages |
|
Pre Setup |
Pre Setup messages |
|
Pre Ack |
Pre Ack messages |
|
BW Request |
BW Request messages |
|
BW Response |
BW Response messages |
|
Invalid Q931 |
Invalid Q.931 messages |
|
total |
Total number of messages |
|
rcv |
Number of received messages |
|
send |
Number of sent messages |
|
err |
Number of errors |
|
dupr |
Number of received message duplicates |
|
dups |
Number of resent messages |
|
disc |
Number of discarded messages |
Syntax
gatekeeper
View
PS view
Parameter
None
Description
Use the gatekeeper command to enter PS-GK view.
Example
# Enter PS-GK view.
[XE-ps] gatekeeper
[XE-ps-gk]
Syntax
gk-config { rasport | q931port | 2nd-port } port-number
undo gk-config { rasport | q931port | 2nd-port }
View
PS-GK view
Parameter
rasport: Specifies the RAS port on the gatekeeper.
q931port: Specifies the Q931 port on the gatekeeper.
2nd-port: Specifies the backup RAS port on the gatekeeper. The backup RAS port is used to assist the RAS port for RAS signaling transmission and receiving.
port-number: Port number. The default RAS port is 1719. The default Q931 port is 1720.
Description
Use the gk-config command to configure the port used by the gatekeeper to transmit and receive RAS signaling, the backup port used by the gatekeeper to transmit or receive RAS signaling, and the port used by the PS to listen the TCP connection requests for call control signaling channel (that is, the Q931 port).
Use the undo gk-config rasport command to restore the default port used to transmit and receive RAS signaling.
Use the undo gk-config q931port command to restore the default port used to transmit and receive Q931 signaling.
Use the undo gk-config 2nd-port command to delete the backup RAS port configuration of the gatekeeper.
Example
# Configure the gatekeeper to use port 1111 for transmitting and receiving RAS signaling.
[XE-ps-gk] gk-config rasport 1111
Syntax
heartbeat password password
undo heartbeat password
View
PS view
Parameter
password: Heartbeat password, 1 to 16 characters. It defaults to XEngine.
Description
Use the heartbeat password command to configure a password for heartbeat authentication.
Use the undo heartbeat password command to restore the default heartbeat password.
Example
# Set the heartbeat password for the PS to hb1234.
[XE-ps] heartbeat password hb1234
Syntax
lrq-mode { forward | terminated }
undo lrq-mode
View
PS-GK view
Parameter
forward: LRQ forward mode.
Terminated: LRQ terminated mode.
Description
Use the lrq-mode command to set the LRQ signaling processing method of the gatekeeper.
Use the undo lrq-mode command to restore the default LRQ signaling processing method of the gatekeeper.
By default, the terminated mode is used.
Example
# Set the LRQ signaling processing method of the gatekeeper as forward.
[xe-ps-gk]lrq-mode forward
Syntax
irr-frequency irr-frequency-value
undo irr-frequency
View
PS-GK view
Parameter
irr-frequency-value: Interval for reporting Info_Request_Response (IRR) messages. It defaults to 60 seconds.
Description
Use the irr-frequency command to configure the interval at which gateways report their state information to the gatekeeper regularly. If the interval is set to 0, gateways do not report IRR regularly.
Use the undo irr-frequency command to restore the default interval at which gateways report their state information to the gatekeeper regularly.
Example
# Enable gateways to report IRR at 120-second intervals.
[XE-ps-gk] irr-frequency 120
Syntax
ls-mode id-priority { local | { remote ip-address ip-address [ port port ] } }
undo ls-mode { id-priority | all }
View
PS view
Parameter
id-priority: ID of the LS used by the PS. This ID ranges from 0 to 4, representing the LS priority in an ascending order.
local: Uses the co-located LS.
remote: Uses an LS that resides on a different device.
ip-address: Specifies the IP address of the remote LS. It defaults to 0.0.0.0.
port: Port number of the remote LS. It defaults to 13579.
Description
Use the ls-mode command to configure an LS table entry for the PS. The LS table can contain up to five entries, with at most one local LS. LS IDs must be non-identical.
Use the undo ls-mode command to delete a specified entry or all entries from the LS table.
Example
# Assign the remote LS at 10.1.5.6 to the PS. Adopt the default port number and specify the LS priority as 1.
[XE-ps] ls-mode 1 remote 10.1.5.6
& Note:
If this is not the first time that you specify a remote LS, the port number that you configured last time for the LS, instead of the default port number, applies.
Syntax
policy call-interrupt-by-long-time {enable | disable}
undo policy call-interrupt-by-long-time
View
PS view
Parameter
Enable: Enables a long-time call interruption function.
Disable: Disables a long-time call interruption function.
Description
Use the policy call-interrupt-by-long-time command to enable or disable the long-time call interruption function.
Use the undo policy call-interrupt-by-long-time command to restore the default.
By default, the long-time call interruption function is disabled.
Example
# Enable the long-time call interruption function.
[XE-ps]policy call-interrupt-by-long-time enable
Syntax
policy call-interrupt-time call-interrupt-time
undo policy call-interrupt-time
View
PS view
Parameter
call-interrupt-time: The timeout interval for the long-time call interruption, ranging from 1440 to 14400 seconds. The timeout interval defaults to 2880 seconds.
Description
Use the policy call-interrupt-time command to set the timeout interval for the long-time call interruption. If the call-interrupt-time expires, the conversation will stop.
Use the undo policy call-interrupt-time command to restore the default timeout interval.
By default, the timeout interval for the long-time call interruption is 2880 minutes.
Example
# Configure the timeout interval to 1440 minutes.
[XE-ps] policy call-interrupt-time 1440
Syntax
ps-config identifier interface interface-type interface-number
undo ps-config
View
PS view
Parameter
identifier: Identifier of the PS.
interface-type: Interface type.
interface-number: Interface number.
Description
Use the ps-config command to configure the basic information about the process server.
Use the undo ps-config command to delete the basic information about the process server.
By default, the identifier of the process server is PS.
Example
# Configure a gatekeeper, setting its ID to ps1@h3c and its interface to Ethernet0/0.
[XE-ps] ps-config ps1@h3c interface ethernet 0/0
Syntax
repair-tcp { enable | disable }
undo repair-tcp
View
PS-SIP view
Parameter
enable: Enables TCP connection repair.
disable: Disables TCP connection repair.
Description
Use the repair-tcp command to enable or disable TCP connection repair.
Use the undo repair-tcp command to restore the default.
By default, TCP connection repair is enabled.
Example
# Enable TCP connection repair.
[XE-ps-sip] repair-tcp enable
Syntax
reset process-server statistics { adapter | all | bkm | cdp | cm | csm | hadpt | hrm | hsm | hstack | rm | sm | stack | tucl }
View
User view
Parameter
adapter: Clears statistics about the adapter layer.
all: Clears all statistics.
bkm: Clears statistics about the BKM module.
cdp: Clears statistics about the CDP module.
cm: Clears statistics about the CM module.
csm: Clears statistics about the CSM module.
hadpt: Clears statistics about the H.323 adapter module.
hrm: Clears statistics about the HRM module.
hsm: Clears statistics about the HSM module.
hstack: Clears statistics about the H.323 stack.
rm: Clears statistics about the RM module.
sm: Clears statistics about the SM module.
stack: Clears statistics about the SIP protocol stack.
tucl: Clears statistics about the TUCL module.
Description
Use the reset process-server statistics command to clear statistics for the PS, such as SIP and H.323 messages sent and received, messages exchanged between internal modules, and timer messages.
Example
# Clear all statistics for the PS.
<XE> reset process-server statistics all
Syntax
response-irr { off | on }
undo response-irr
View
PS-GK view
Parameter
off: Disables the gatekeeper to respond with IACK messages to IRR messages.
on: Enables the gatekeeper to respond with IACK messages to IRR messages.
Description
Use the response-irr command to disable or enable the gatekeeper to respond with IACK messages to IRR messages.
Use the undo response-irr command to restore the default setting of the IRR response switch.
By default, the on parameter applies.
Example
# Disable the gatekeeper to respond with IACK messages to IRR messages.
[XE-ps-gk] response-irr off
Syntax
sip
View
PS view
Parameter
None
Description
Use the sip command to enter SIP view.
Example
# Enter SIP view.
[XE-ps] sip
[XE-ps-sip]
Syntax
sip-config port sip-port-number
View
PS-SIP view
Parameter
port: Specifies the SIP signaling port of the PS.
sip-port-number: Port number. It defaults to 5060.
Description
Use the sip-config command to configure the port where the PS receives/transmits SIP signaling.
Example
# Set the SIP signaling port number of the PS to 2222.
[XE-ps-sip] sip-config port 2222
Syntax
start
View
PS view
Parameter
None
Description
Use the start command to enable the PS. Enabling the PS will enable the gatekeeper and the SIP server.
By default, the PS is disabled.
Example
# Start the PS.
[XE-ps] start
Syntax
start
View
PS-GK view
Parameter
None
Description
Use the start command to enable the gatekeeper.
By default, the gatekeeper is disabled.
Example
# Start the gatekeeper.
[XE-ps-gk] start
Syntax
start
View
PS-SIP view
Parameter
None
Description
Use the start command to enable the SIP server.
By default, the SIP server is disabled.
Example
# Enable the SIP server.
[XE-ps-sip] start
Syntax
stop
View
PS-GK view
Parameter
None
Description
Use the stop command to disable the gatekeeper.
Disabling the gatekeeper will not disable the PS.
By default, the gatekeeper is disabled.
Example
# Disable the gatekeeper.
[XE-ps-gk] stop
Syntax
stop
View
PS-SIP view
Parameter
None
Description
Use the stop command to disable the SIP Server.
Disabling the SIP server will not disable the PS.
By default, the SIP server is disabled.
Example
# Disable the SIP server.
[XE-ps-sip] stop
Syntax
stop
View
PS view
Parameter
None
Description
Use the stop command to disable the PS.
Disabling the PS will disable the gatekeeper and the SIP server.
Example
# Disable the PS.
[XE-ps] stop
SIP Server stopped.
Gatekeeper stopped.
Process Server stopped.
Syntax
timeout callee ringing-time time
undo timeout callee ringing-time
View
PS view
Parameter
ringing-time: Configures the maximum ringing duration allowed for each called party.
time: Maximum ringing duration for each called party, in the range of 25 to 50 seconds. It defaults to 40 seconds.
Description
Use the timeout callee ringing-time command to configure the maximum ringing duration allowed for each called party.
Use the undo timeout callee ringing-time command to restore the default maximum ringing duration allowed for each called party.
Example
# Configure the maximum ringing duration for a single called party to 50 seconds.
[XE200-ps] timeout callee ringing-time 50
Syntax
timeout caller wait-connect time
undo timeout caller wait-connect
View
PS view
Parameter
wait-connect: Configures the maximum duration that the calling party waits for the called party to pick up the phone.
time: Maximum waiting time, in the range of 30 to 100 seconds. It defaults to 90 seconds.
Description
Use the timeout caller wait-connect command to configure the maximum duration that the calling party waits for the called party to pick up the phone.
Use the undo timeout caller wait-connect command to restore the default.
Example
# Set the maximum duration that the calling party waits for the called party to pick up the phone to 60 seconds.
[XE200-ps] timeout caller wait-connect 60
Syntax
tracecall number
undo tracecall
View
PS view
Parameter
number: Number to be traced, ranging within 31 bits.
Description
Use the tracecall command to trace calls related to the specified number and print the debugging information on the caller and callee related to the number.
Use the undo tracecall command to disable call tracing.
By default, the related debugging information at levels 1 through 7 is printed.
& Note:
Before using the tracecall command, turn on the debugging information output display switch with the terminal debugging command and the terminal monitor command.
Example
# Trace the calls related to number 4000.
<XE> terminal debugging
<XE> terminal monitor
<XE> system-view
[XE] process-server
[XE-ps] tracecall 4000
*0.1234730 XE2000 XE/8/XEngine:
[ HSM >-< Handle = 0 >-< Informational >-< 2005-05-13 09:05:51 ]
>> HSMGetCMIndex : After receive LRQ or caller ARQ , HSM allocate new CM CR.
File:ps_hsm_core.c, 1235
