TANDBERG Gatekeeper/Border Controller API D14172.01 User Manual
  1. Manuals
  2. Brands
  3. TANDBERG Manuals
  4. Software
  5. Gatekeeper/Border Controller API D14172.01
  6. User manual
TANDBERG Gatekeeper/Border Controller API D14172.01 User Manual

TANDBERG Gatekeeper/Border Controller API D14172.01 User Manual

Tandberg gatekeeper/border controller api user guide
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
TANDBERG
Gatekeeper/Border Controller
API User Guide
D14172.01
July 2008

Advertisement

Table of Contents
loading

Related Manuals for TANDBERG Gatekeeper/Border Controller API D14172.01

Summary of Contents for TANDBERG Gatekeeper/Border Controller API D14172.01

  • Page 1 TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 July 2008...

  • Page 2: Table Of Contents

    Introduction to XML Path Language (XPath) ... 6 The TANDBERG XML Engine ... 8 The XML Documents ... 9 Introduction to TANDBERG XML API Service (TXAS)... 14 Exercises ... 19 The XML-based Advanced Command Line Interface... 21 XACLI ... 21 The Status-type root commands –...

  • Page 3: The Tandberg Api

    TANDBERG Gatekeeper/Border Controller API User Guide The TANDBERG API This document is a guide to the API interface of the TANDBERG Gatekeeper and Border Controller products. All rights reserved. This document contains information that is proprietary to TANDBERG. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form, or by any means, electronically, mechanically, by photocopying, or otherwise, without the prior written permission of TANDBERG.

  • Page 4: Introduction To Xml

    There is no further relevant information when the NTP status is inactive therefore the sub-structure of the NTP element is empty. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 4 of 84...
  • Page 5 DNS servers configured then the XML structure would look like this: <Configuration> <IP item="1"> <DNS item="1"> <Server item="1"> <Address item="1">10.0.0.3</Address> </Server> <Server item="2"> <Address item="1">10.0.0.4</Address> </Server> <Domain item="1"> <Name item="1">example.com</Name> </Domain> </DNS> </IP> </Configuration> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 5 of 84...

  • Page 6: Introduction To Xml Path Language (Xpath)

    If the item number is omitted for an element, all items of this element will be addressed. The following expression addresses the Address element of all DNS servers: Configuration/IP/DNS/Server/Address D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 6 of 84...
  • Page 7 TANDBERG Gatekeeper/Border Controller API User Guide Example 1.7 When using XPath it is possible to omit specifying intermediate levels in the address expression. By using the powerful “double slash" you can address elements without having to specify the complete path.

  • Page 8: The Tandberg Xml Engine

    (r) information flowing to target, hereby called write information (w) If we now look at the TANDBERG systems we can identify three main types of information, either being read information (r), write information (w) or read-write information (rw): (r) Read information –...

  • Page 9: The Xml Documents

    The XML Documents 1.4.1 Documents The XML Data in the TANDBERG systems are divided into three main types of documents. The division is based on whether the information is Read Information, Write Information or Read-Write information: Status documents (r): Documents holding all available Status Information in the system.
  • Page 10 The structure of the Configuration documents is independent of system state, i.e. the structure will be constant in time. In addition to holding the values for the various configurations, each configuration value-element includes an attribute, valueSpaceRef configuration. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide referencing the value domain for the page 10 of 84...
  • Page 11 Posting configuration to the system is described in section 1.5 Introduction to TANDBERG XML API Service (TXAS). 1.4.4 Command documents (w) Command documents contain descriptions of the supported commands for the system. A Command consists of a Command name and a set of Command parameters.
  • Page 12 If a command is not accepted, the response structure will contain a Cause code. If the command is accepted, the response structure may contain information relevant for the specific command. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 12 of 84...
  • Page 13 Below is an example of the Dial command not being accepted by the system because the same alias has been specified for both the callSrc and callDst: <Command> <DialResult item="1" status="Error"> <Cause item="1">89</Cause > <Description item="1"> callSrc and callDst must have different aliases</Description> </DialResult> </Command> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 13 of 84...

  • Page 14: Introduction To Tandberg Xml Api Service (Txas)

    Introduction to TANDBERG XML API Service (TXAS) TXAS is a service provided by TANDBERG units for transmitting and receiving information encoded in XML format. The API uses HTTP(S) as the transport mechanism and connects to the normal web port (80). TXAS can be accessed in two ways: •...
  • Page 15 –k –u admin:<password> -d \ '<Command><Dial><callSrc>Alice</callSrc><callDst>Bob</callDst></Dial></Comm and>' https://10.0.0.1/formputxml <?xml version=“1.0"?> <Command> <DialResult item="1" status="OK"> <callSrc item="1">Alice</callSrc> <callDst item="1">Bob</callDst> <Bandwidth item="1">384</Bandwidth> <CallSerialNumber item="1">00000000-0000-0000-0000-000000000000 </CallSerialNumber> <EncryptionMode item="1">Auto</EncryptionMode> <EncryptionType item="1">Auto</EncryptionType> </DialResult> </Command> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 15 of 84...
  • Page 16 The example below shows how to use the dial command which requires parameters to be passed as part of the operation: <?php $client = new SoapClient('http://10.0.0.1/webservices.wsdl', array('login' => '<username>', 'password' => '<password>')); $client->Dial( array('callSrc' => 'Alice', 'callDst' => 'Bob') ); ?> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 16 of 84...
  • Page 17 <?php $client = new SoapClient('http://10.0.0.1/webservices.wsdl', array('login' => '<username>', 'password' => '<password>')); $result = $client->GetConfigurationXML( array('Location' => '/SNMP') ); $xml_result = new SimpleXMLElement( $result->GetConfigurationXMLResult->any ); echo $xml_result->SNMP->SystemContact; ?> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 17 of 84...
  • Page 18 The example below shows performs the same task as Example 1.23 but uses SetConfiguration: <?php $client = new SoapClient('http://10.0.0.1/webservices.wsdl', array('login' => '<username>', 'password' => '<password>')); $params->Document->Configuration->SNMP->SystemContact = 'Alice'; $client->SetConfiguration( $params ); ?> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 18 of 84...

  • Page 19: Exercises

    TANDBERG Gatekeeper/Border Controller API User Guide Exercises The exercises in this section are based on using a TANDBERG Gatekeeper and Microsoft Internet Explorer. Some of the examples may however also apply to other systems and other browsers. NOTE! Replace the IP address 10.0.0.1 in the below examples with the IP address of your system.
  • Page 20 Below are examples of XML structures to be posted to the system: <Configuration> <SNMP> <SystemContact>Administrator</SystemContact> </SNMP> </Configuration> <Configuration> <SNMP> <SystemContact>Administrator</SystemContact> </SNMP> <NTP> <Address>10.0.0.2</Address> </NTP> </Configuration> <Command> <Dial> <callSrc>Alice</callSrc> <callDst>Bob</callDst> </Dial> </Command> <Command> <Boot/> </Command> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 20 of 84...

  • Page 21: The Xml-Based Advanced Command Line Interface

    A basic understanding of the information structuring in the TANDBERG XML engine is important in order to get the most out of the XACLI interface. We therefore recommend you read the TANDBERG XML API section of this document prior to reading this section.
  • Page 22 PerCall: "Unlimited" Used: 0 *s/end Request for Zone1 element with exposure option “-“: xstatus zones zone 1 - *s Zones: Zone 1 (status=Active): Gatekeeper (status=Active): Calls: / Bandwidth: *s/end D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 22 of 84...
  • Page 23 Request for Zone1 element with exposure option “--“: xstatus zones zone 1 -- *s Zones: Zone 1 (status=Active): *s/end 2.1.5 Misc • The XACLI interface is not case sensitive. • XACLI allows using only partial names. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 23 of 84...

  • Page 24: The Status-Type Root Commands - Xstatus / Xhistory

    Calls Registrations To access status-type data, simply type the status-type root command (xstatus or xhistory) and then an XPath address expression or a TANDBERG SimplePath expression: <status-type root command> <address expression> Example 2.4 xstatus registrations registration 1 aliases alias 1...
  • Page 25 NOTE! To write a parser for the XACLI format, the parser must keep track of the levels by counting white spaces. The indent is increased by two whitespaces for each level. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 25 of 84...

  • Page 26: The Configuration-Type Root Commands - Xconfiguration

    *h IP V6 Address: <S: 0, 39> *h IP V6 Gateway: <S: 0, 39> *h IP DNS Server [1..5] Address: <S: 0, 39> *h IP DNS Domain Name: <S: 0, 128> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide SNMP SubZones SystemUnit Telnet...
  • Page 27 TANDBERG Gatekeeper/Border Controller API User Guide NOTE! Only typing ? actually addresses all configuration elements within the root command. One would therefore expect that help on all configurations would be returned. But as described above, this is a special case and only listings of the top level elements are returned. To get help on all...
  • Page 28 TANDBERG Gatekeeper/Border Controller API User Guide Example 2.9 User wants to set IP address: ip address: "10.0.0.1" ip/address: "10.0.0.1" D14172.01 page 28 of 84...

  • Page 29: The Command-Type Root Commands - Xcommand

    Pattern(r): <S: 1, 60> *h xCommand AllowListDelete AllowListId(r): <1..2500> *h xCommand Boot *h xCommand CallTransfer Call(r): <1..900> Leg(r): <1..2> Alias(r): <S: 1, 60> … D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide PipeAdd PipeDelete RemoveRegistration SubZoneAdd SubZoneDelete TransformAdd TransformDelete TraversalZoneAdd TraversalZoneDelete...

  • Page 30: Command Help

    Bandwidth:384 callDst:bob callSrc:alice Abbreviations can be used for the parameter names as long as the parameter names are unique within the command: Example 2.14 xcommand dial B:384 callD:bob callS:alice D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 30 of 84...
  • Page 31 B:384 bob Command response When issuing a command, the system will return a set of return values (refer to the section TANDBERG XML API). The response will be on the same format as the standard XACLI Status format. Example 2.18...

  • Page 32: Xml Output - Xgetxml

    XPath expression as parameter and the elements (or complete document) matching the expression will be returned. Example 2.19 xgetxml status/ntp <Status> <NTP item="1" status="Active"> <Address item="1">10.0.0.2</Address> <Port item="1">123</Port> <LastUpdate item="1">2008-01-01 12:00:00</LastUpdate> <LastCorrection item="1">1</LastCorrection> </NTP> </Status> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 32 of 84...

  • Page 33: Special Commands

    To view registered expressions: xfeedback list *xf 1 status/Registrations/Registration/Aliases/Alias When the endpoint for Alice registers: *s Registrations: Registration 1: Aliases: Alias 1 (type=H323Id, origin=Endpoint): "alice@example.com" *s/end *s Registrations: Registration 1: Aliases: D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 33 of 84...
  • Page 34 Zone 1 (status=Failed): Cause: No gatekeeper reachable Name: "MyNeighbor" Gatekeeper (status=Failed): Cause: No response from gatekeeper Address: "10.0.0.10" Port: 1719 Calls: / Bandwidth: Total: "Unlimited" PerCall: "Unlimited" Used: 0 *s/end D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 34 of 84...
  • Page 35 If xmlconfigfeedback is set to on, feedback on configurations will be returned in XML-format instead of the standard XACLI configuration format. Example 2.25 XACLI-format: *c SNMP SystemContact: Administrator XML-format: <Configuration> <SNMP item="1"> <SystemContact item="1">Administrator</SystemContact> </SNMP> </Configuration> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 35 of 84...
  • Page 36 CallSerialNumber: 1 EncryptionMode: Auto EncryptionType: Auto *r/end XML-format: xcommand dial alice bob <Command> <DialResult item="1" status="OK"> <callSrc item="1">alice@example.com</callSrc> <callDst item="1">bob@example.com</callDst> <Bandwidth item="1">384</Bandwidth> <CallSerialNumber item="1">1</CallSerialNumber> <EncryptionMode item="1">Auto</EncryptionMode> <EncryptionType item="1">Auto</EncryptionType> </DialResult> </Command> D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 36 of 84...

  • Page 37: Api - Configurations

    Note: You must restart the system for any changes to take effect. IP V6 Gateway: <S: 0, 39> Specifies the IPv6 gateway of the system. Note: You must restart the system for any changes to take effect. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 37 of 84...
  • Page 38 A value of 0 turns session time outs off. Telnet Mode: <On/Off> Determines whether the system can be accessed via telnet. Note: You must restart the system for any changes to take effect. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 38 of 84...
  • Page 39 Off: Endpoints registered directly to the system may only call an IP Address of a system also registered directly to that system. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 39 of 84...
  • Page 40 When the system receives a Location Request, all Alternates will also be queried. Gatekeeper Alternates Alternate [1..5] Port: <1..65534> Specifies the IP Port of an alternate system. Gatekeeper Policy Mode: <On/Off> Enables and disables use of Administrator Policy. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 40 of 84...
  • Page 41 Traversal UDPProbe RetryInterval: <1..65534> (Applies only if the system is a Border Controller.) Sets the interval with which a failed attempt to establish a UDP channel should be repeated. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 41 of 84...
  • Page 42 Traversal AssentEnabled: <On/Off> (Applies only if the system is a Border Controller.) Determines whether or not the Border Controller will allow firewall traversal using TANDBERG's proprietary Assent protocol. Traversal H46018Enabled: <On/Off> (Applies only if the system is a Border Controller.) Determines whether or not the Border Controller will allow firewall traversal using the ITU H.460.18/19 protocols.
  • Page 43 Disabled: the zone will never be queried. Zones Zone [1..100] Match [1..5] Pattern String: <S: 0, 60> (Applies only if the Match mode is Pattern Match.) Specifies the pattern against which the alias is compared. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 43 of 84...
  • Page 44 Disabled: the zone will never be queried. Zones TraversalZone [1..50] Match [1..5] Pattern String: <S: 0, 60> (Applies only if the Match mode is Pattern Match.) Specifies the pattern against which the alias is compared. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 44 of 84...
  • Page 45 SubZones TraversalSubZone Bandwidth Total Limit: <1..100000000> Specifies the total bandwidth (in kbps) allowed for all traversal calls being handled by the system (applies only if Mode is set to Limited). D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 45 of 84...
  • Page 46 Pipes Pipe [1..100] Name: <S: 1, 50> Assigns a name to this pipe. Pipes Pipe [1..100] Bandwidth Total Mode: <None/Limited/Unlimited> Determines whether or not this pipe is enforcing total bandwidth restrictions. None: no bandwidth available. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 46 of 84...
  • Page 47 Services AdHocConferencing Prefix: <S: 0, 30> Specifies the prefix to be used for unencrypted conference requests. Services AdHocConferencing Encryption Prefix: <S: 0, 30> Specifies the prefix to be used for encrypted conference requests. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 47 of 84...

  • Page 48: Api - Commands

    Node1(r): <S: 1, 50> The subzone or zone from which the call originates. Node2(r): <S: 1, 50> The subzone or zone at which the call terminates. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 48 of 84...
  • Page 49 The alias of the second endpoint to be placed in the call. Bandwidth: <1..100000000> The requested bandwidth of the call (in kbps). EncryptionMode: <Auto/On/Off> Specifies whether the call will be encrypted. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 49 of 84...
  • Page 50 Specifies the first pipe to be associated with this link. Pipe2: <S: 1, 50> Specifies the second pipe to be associated with this link. LinkDelete Deletes a link. LinkId(r): <1..100> The index of the link to be deleted. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 50 of 84...
  • Page 51 Specifies the option key of the option you wish to add. Option keys are added to the system in order to add extra functionality, such as increasing the system's capacity. Contact your TANDBERG representative for further information. OptionKeyDelete Deletes a software option key from the system.
  • Page 52 PerCallInter: <1..100000000> Specifies the bandwidth limit (in kbps) on any one call to or from an endpoint in this subzone (applies only if Mode is set to Limited). D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 52 of 84...
  • Page 53 Specifies the IP Address or FQDN of the traversal server. Up to five alternate traversal servers can also be specified. Gatekeeper1Port: <1..65534> (Applies only if the system is a Gatekeeper.) Specifies the port on the traversal server to connect to. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 53 of 84...
  • Page 54 Strip: the matching prefix or suffix will be removed from the alias. Replace: the matching part of the alias will be substituted with the text in the Replace string. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 54 of 84...
  • Page 55 Disabled: the zone will never be queried. Match4PatternString: <S: 0, 60> (Applies only if the Match mode is Pattern Match.) Specifies the pattern against which the alias is compared. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 55 of 84...
  • Page 56 Specifies the IP Address or FQDN of this neighbor. Gatekeeper1Port: <1..65534> Specifies the port on the neighbor to be used. Gatekeeper2Address: <S: 1, 128> Specifies the IP Address or FQDN of this neighbor. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 56 of 84...
  • Page 57 Determines if and when a query will be sent to this zone. Always: the zone will always be queried. Pattern: the zone will only be queried if the alias queried for matches the corresponding pattern. Disabled: the zone will never be queried. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 57 of 84...
  • Page 58 Prefix: the string must appear at the beginning of the alias. Suffix: the string must appear at the end of the alias. Regex: the string will be treated as a regular expression. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 58 of 84...
  • Page 59 (Applies only if the Pattern Behavior is Replace.) Specifies the string to be used as a substitution for the part of the alias that matched the pattern. ZoneDelete Deletes a zone. ZoneId(r): <1..100> The index of the zone to be deleted. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 59 of 84...

  • Page 60: Api - Status

    SystemUnit Software ReleaseDate: <String> Shows the software release date. SystemUnit Software ReleaseKey: <String> Shows the software release key. SystemUnit Software Configuration NonTraversalCalls: <Integer> Shows the systems non traversal call capacity. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 60 of 84...
  • Page 61 Shows the IPv4 address of the default gateway. Only present if the Protocol is IPv4 or Both. IP IPv6 Address: <IPv4Addr> Shows the IPv6 address of the system. Only present if the Protocol is IPv6 or Both. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 61 of 84...
  • Page 62 Shows the address of the LDAP server. Only present if the LDAP status is Active or Failed. LDAP Port: <String> Shows the port of the LDAP server. Only present if the LDAP status is Active or Failed. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 62 of 84...
  • Page 63 Shows the current number of non traversal calls on the system. Only present if the system is a Gatekeeper. ResourceUsage MaxNonTraversalCalls: <Integer> Shows the maximum number of concurrent non traversal calls on the system. Only present if the system is a Gatekeeper. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 63 of 84...
  • Page 64 Shows the name of a zone that is part of the route the call takes. Calls Call [1..900] Route Link: <String> Shows the name of a link that is part of the route the call takes. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 64 of 84...
  • Page 65 Calls Call [1..900] DestinationAlias: <String> Shows the alias of the destination call party. Calls Call [1..900] DestinationAddress: <String> Shows the IP address and port of the destination call party. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 65 of 84...
  • Page 66 Shows the subzone to which this registration belongs. Registrations Registration [1..3750] SerialNumber: <String> Shows the unique serial number of the registration. Registrations Registration [1..3750] StartTime: <String> Shows the time at which this registration was created. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 66 of 84...
  • Page 67 Zones TraversalZone [1..50] Calls Call [1..900]: <Integer> Shows the index of a call in the traversal zone. Zones TraversalZone [1..50] Bandwidth Total: <String> Shows the total bandwidth in kbps allowed in the traversal zone. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 67 of 84...
  • Page 68 Zones Zone [1..50] Bandwidth PerCall: <String> Shows the bandwidth in kbps allowed per call in the zone. Zones Zone [1..50] Bandwidth Used: <String> Shows the bandwidth in kbps being used in the zone. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 68 of 84...
  • Page 69 SubZones SubZone [1..100] Bandwidth PerCall: <String> Shows the bandwidth in kbps allowed per call in the SubZone. SubZones SubZone [1..100] Bandwidth Used: <String> Shows the bandwidth in kbps being used in the SubZone. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 69 of 84...
  • Page 70 Pipes Pipe [1..100] Bandwidth PerCall: <String> Shows the bandwidth in kbps allowed per call on the pipe. Pipes Pipe [1..100] Bandwidth Used: <String> Shows the bandwidth in kbps being used on the pipe. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 70 of 84...

  • Page 71: History.xml - Xhistory

    Calls Call [1..255] DestinationAlias: <String> Shows the alias of the destination call party. Calls Call [1..255] DestinationAddress: <String> Shows the IP address and port of the destination call party. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 71 of 84...
  • Page 72 Shows the time at which this registration was created. Registrations Registration [1..255] EndTime: <String> Shows the time at which this registration ended. Registrations Registration [1..255] Reason: <String> Shows the reason for the registration ending. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 72 of 84...
  • Page 73 Shows the cause for the registration being rejected. Only present if the reason is RegistrationRejected. Registrations Registration [1..255] RegistrationRejectionDescription: <String> Shows a description of the cause for the registration being rejected. Only present if the reason is RegistrationRejected. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 73 of 84...

  • Page 74: Event.xml - Xevent

    Shows the check code for the encrypted call leg. Only present if encryption status is On. CallAttempt Call [1..900] StartTime: <String> Shows the time at which the call was initiated. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 74 of 84...
  • Page 75 Connected Call [1..900] Leg [1..2] Alias [type = <IPAddress/E164/H323Id/ Email/Url/Prefix/Suffix>] Shows the type of the call party alias. Connected Call [1..900] Leg [1..2] Alias: <String> Shows the alias of the call party. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 75 of 84...
  • Page 76 Disconnected Call [1..900] Leg [1..2] Alias: <String> Shows the alias of the call party. Disconnected Call [1..900] Leg [1..2] Address: <String> Shows the IP address and port of the call party. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 76 of 84...
  • Page 77 Shows the alias of the call party. ConnectionFailure Call [1..900] Leg [1..2] Address: <String> Shows the IP address and port of the call party. Only present if the address could be determined. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 77 of 84...
  • Page 78 Shows the prefix of a registered gateway service. Only present if the registration is a gateway. Registration Registration [1..3750] MCU: Shows that the registration is an MCU. Only present if the registration is an MCU. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 78 of 84...
  • Page 79 Shows that the registration was a gateway. Only present if the registration was a gateway. Unregistration Registration [1..3750] Gateway Prefix [1..200]: <String> Shows the prefix of a registered gateway service. Only present if the registration was a gateway. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 79 of 84...
  • Page 80 Shows that the registration was a gatekeeper. Only present if the registration was a gatekeeper. RegistrationFailure Registration [1..3750] Gateway: Shows that the registration was a gateway. Only present if the registration was a gateway. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 80 of 84...
  • Page 81 RegistrationFailure Registration [1..3750] RegistrationRejectionCause: <String> Shows the cause for the registration being rejected. RegistrationFailure Registration [1..3750] RegistrationRejectionDescription: <String> Shows a description of the cause for the registration being rejected. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 81 of 84...
  • Page 82 Shows the check code for the encrypted call leg. Only present if encryption status is On. Bandwidth Call [1..900] StartTime: <String> Shows the time at which the call was initiated. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 82 of 84...
  • Page 83 LocateResult Location Reason: <Success/Failed> Shows a description of the reason the search of this location failed. Only present if the Location Result is Failed and the Location Type is Neighbor or Traversal. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 83 of 84...
  • Page 84 Shows the current number of traversal calls on the system. ResourceUsage MaxTraversalCalls: <Integer> Shows the maximum number of concurrent traversal calls on the system. ResourceUsage TotalTraversalCalls: <Integer> Shows the total number of traversal calls placed on the system. D14172.01 TANDBERG Gatekeeper/Border Controller API User Guide page 84 of 84...

This manual is also suitable for:

Gatekeeper/border controller

Table of Contents