monitoring.sgml

H.323网守实现

<p>Find details of a registered endpoint by an alias or a prefix.
<descrip>
<tag/Format:/
<tscreen><verb>
FindVerbose Alias
RCF|IP:Port|Aliases|Terminal_Type|EndpointID
Registration_Time C(Active_Call/Connected_Call/Total_Call) &lt;r&gt;
[Prefixes: ##] (gateway only)
;
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
fv 02
RCF|10.0.1.100:1720|TFN:h323_ID|gateway|4037_CGK1
Wed, 26 Jun 2002 17:47:29 +0800 C(0/84/120) &lt;1&gt;
Prefixes: 02,09
;
</verb></tscreen>
</descrip>

<item><tt/UnregisterIP/
<p>Forcedly unregister an endpoint by IP and call signalling port.
<descrip>
<tag/Format:/
<tscreen><verb>
UnregisterIP IP[:Port]
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
UnregisterIP 10.0.1.31:1720
URQ|10.0.1.31:1032|1326_endp|maintenance;
SoftPBX: Endpoint 10.0.1.31:1720 unregistered!
</verb></tscreen>
</descrip>

<item><tt/UnregisterAlias/
<p>Forcedly unregister an endpoint by one of its aliases.
<descrip>
<tag/Format:/
<tscreen><verb>
UnregisterAlias Alias
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
UnregisterAlias 601
URQ|10.0.1.31:1032|1326_endp|maintenance;
SoftPBX: Endpoint 601 unregistered!
</verb></tscreen>
</descrip>

<item><tt/UnregisterAllEndpoints/
<p>Forcedly unregister all registered endpoints.
<descrip>
<tag/Format:/
<tscreen><verb>
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
UnregisterAllEndpoints
URQ|10.0.1.7:1024|1325_endp|maintenance;
URQ|10.0.1.8:1024|1322_endp|maintenance;
URQ|10.0.1.32:1032|1324_endp|maintenance;
URQ|10.0.1.36:1032|1323_endp|maintenance;
URQ|10.0.1.42:1032|1318_endp|maintenance;
Done
;
</verb></tscreen>
</descrip>

<item><tt/DisconnectCall/
<p>Disconnect a call with given number.
<descrip>
<tag/Format:/
<tscreen><verb>
DisconnectCall Number
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
DisconnectCall 1533
</verb></tscreen>
</descrip>

<item><tt/DisconnectIP/
<p>Disconnect all calls of an endpoint by IP and call signalling port.
<descrip>
<tag/Format:/
<tscreen><verb>
DisconnectIP IP[:Port]
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
DisconnectIP 10.0.1.31:1720
</verb></tscreen>
</descrip>

<item><tt/DisconnectAlias/
<p>Disconnect all calls of an endpoint by one of its aliases.
<descrip>
<tag/Format:/
<tscreen><verb>
DisconnectAlias Alias
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
DisconnectAlias 601
</verb></tscreen>
</descrip>

<item><tt/ClearCalls/
<p>Disconnect all calls on the gatekeeper.

<item><tt/GK/
<p>Show the information of the parent gatekeeper.

<item><tt/Trace/
<p>Set the status interface output trace level. It controls which messages
are sent to this client:
<itemize>
<item><tt/trace 0/ or <tt/trace min/
	<p>Only direct responses to commands and reload notifications.
<item><tt/trace 1/
	<p>CDRs, direct responses to commands and reload notifications.
<item><tt/trace 2/ or <tt/trace max/
	<p>Show all (RAS, CDRs, direct responses to commands, reload notifications, etc).
</itemize>

<item><tt/Debug/
<p>Only used for debug purpose. Options:
<itemize>
<item><tt/trc [+|-|n]/
<p>Show/modify trace level.
<item><tt/cfg SEC PAR/
<p>Read and print a config parameter in a section.
<item><tt/set SEC PAR VAL/
<p>Write a config value parameter in a section.
<item><tt/remove SEC PAR/
<p>Remove a config value parameter in a section.
<item><tt/remove SEC/
<p>Remove a section.
<item><tt/printrm VERBOSE/
<p>Print all removed endpoint records.
</itemize>
<descrip>
<tag/Example:/
<tscreen><verb>
debug trc 3
debug set RoutedMode H245Routed 1
</verb></tscreen>
</descrip>

<item><tt/Who/
<p>Show all people on the status port.

<item><tt/RouteReject/
<p>Terminate this call on a virtual queue.
This command is used as a response to a RouteRequest event (see below).
<descrip>
<tag/Format:/
<tscreen><verb>
RouteReject CallingEndpointID CallRef
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
RouteReject endp_4711 1234
</verb></tscreen>
</descrip>

<item><tt/RouteToAlias/, <tt/rta/
<p>Route this call on a virtual queue to the specified alias.
This command is used as a response to a RouteRequest event (see below).
<descrip>
<tag/Format:/
<tscreen><verb>
RouteToAlias Alias CallingEndpointID CallRef
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
RouteToAlias Suzi endp_4711 1234
</verb></tscreen>
</descrip>

<item><tt/RouteToGateway/, <tt/rtg/
<p>Route this call on a virtual queue to the specified alias and set the destinationSignallAddress.
This command is used as a response to a RouteRequest event (see below).
You can use this command to route calls to out-of-zone gateways or MCUs not registered with the gatekeeper. Make sure that the 'vqueue' and 'explicit' policy is in effect for these calls.
<descrip>
<tag/Format:/
<tscreen><verb>
RouteToGateway Alias IP:Port CallingEndpointID CallRef
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
RouteToGateway Suzi 192.168.0.50 endp_4711 1234
</verb></tscreen>
</descrip>

<item><tt/Exit/, <tt/q/
<p>Quit the status port.

<item><tt/TransferCall/
<p>Transfer an established call from alias A to alias B. When before alias A is talking with alias X, then alias A is talking with alias B after the TransferCall.
<p>Currently this works only with endpoints that properly support
Q.931 Facility messages (so it doesn't work with Netmeeting).
<descrip>
<tag/Format:/
<tscreen><verb>
TransferCall Source-Alias New-Destination-Alias
</verb></tscreen>
<tag/Example:/
<tscreen><verb>
TransferCall Frank Peter
</verb></tscreen>
</descrip>

</itemize>

<sect1>Messages (Reference)
<p>The section describes the messages output to the status interface.

<itemize>
<item><tt/GCF|IP|Aliases|Endpoint_Type;/
<p>The gatekeeper receives a GatekeeperRequest (GRQ) and responds with
a GatekeeperConfirm (GCF).

<item><tt/GRJ|IP|Aliases|Endpoint_Type|RejectReason;/
<p>The gatekeeper receives a GatekeeperRequest (GRQ) and responds with
a GatekeeperReject (GRJ).

<item><tt/RCF|IP:Port|Aliases|Endpoint_Type|EndpointID;/
<p>The gatekeeper receives a RegistrationRequest (RRQ) and responds with
a RegistrationConfirm (RCF).

<item><tt/RRJ|IP|Aliases|Endpoint_Type|RejectReason;/
<p>The gatekeeper receives a RegistrationRequest (RRQ) and responds with
a RegistrationReject (RRJ).

<item><tt/ACF|Caller_IP:Port|Caller_EndpointID|CRV|DestinationInfo|SrcInfo|IsAnswered[|CallID];/
<p>The gatekeeper receives an AdmissionRequest (ARQ) and responds with
an AdmissionConfirm (ACF).
The CallID is only sent when SignalCallId=1 is set.

<item><tt/ARJ|Caller_IP:Port|DestinationInfo|SrcInfo|IsAnswered|RejectReason[|CallID];/
<p>The gatekeeper receives an AdmissionRequest (ARQ) and responds with
an AdmissionReject (ARJ).
The CallID is only sent when SignalCallId=1 is set.

<item><tt/DCF|IP|EndpointID|CRV|DisengageReason[|CallID];/
<p>The gatekeeper receives a DisengageRequest (DRQ) and responds with
a DisengageConfirm (DCF).
The CallID is only sent when SignalCallId=1 is set.

<item><tt/DRJ|IP|EndpointID|CRV|RejectReason[|CallID];/
<p>The gatekeeper receives a DisengageRequest (DRQ) and responds with
a DisengageReject (DRJ).
The CallID is only sent when SignalCallId=1 is set.

<item><tt/LCF|IP|EndpointID|DestinationInfo|SrcInfo;/
<p>The gatekeeper receives a LocationRequest (LRQ) and responds with
a LocationConfirm (LCF).

<item><tt/LRJ|IP|DestinationInfo|SrcInfo|RejectReason;/
<p>The gatekeeper receives a LocationRequest (LRQ) and responds with
a LocationReject (LRJ).

<item><tt/BCF|IP|EndpointID|Bandwidth;/
<p>The gatekeeper receives a BandwidthRequest (BRQ) and responds with
a BandwidthConfirm (BCF).

<item><tt/BRJ|IP|EndpointID|Bandwidth|RejectReason;/
<p>The gatekeeper receives a BandwidthRequest (BRQ) and responds with
a BandwidthReject (BRJ).

<item><tt/UCF|IP|EndpointID;/
<p>The gatekeeper receives an UnregistrationRequest (URQ) and responds with
an UnregistrationConfirm (UCF).

<item><tt/URJ|IP|EndpointID|RejectReason;/
<p>The gatekeeper receives an UnregistrationRequest (URQ) and responds with
an UnregistrationReject (URJ).

<item><tt/IRQ|IP:Port|EndpointID;/
<p>The gatekeeper sends an InfoRequest (IRQ) to an endpoint to query if it
is still alive. The endpoint shall respond with an InfoRequestResponse (IRR)
immediately.

<item><tt/URQ|IP:Port|EndpointID|Reason;/
<p>The gatekeeper sends an UnregistrationRequest (URQ) to an endpoint to
cancel its registration. The endpoint shall respond with
an UnregistrationConfirm (UCF).

<item><tt/CDR|CallNo|CallId|Duration|Starttime|Endtime|CallerIP|CallerEndId|/ \
<newline><tt/CalledIP|CalledEndId|DestinationInfo|SrcInfo|GatekeeperID;/
<p>After a call disconnected, the call detail record is shown (in one line).

<item><tt/RouteRequest|CallerIP:Port|CallerEndpointId|CallRef|VirtualQueue|CallerAlias[|CallID];/
<p>Request for an external application to route an incomming call on a virtual queue.
This can be done with a RouteToAlias or RouteReject command.
The CallID is only sent when SignalCallId=1 is set.

</itemize>