TANDBERG Gatekeeper/Border Controller API User Guide D14172.
TANDBERG Gatekeeper/Border Controller API User Guide Table of Contents 1 1.1 1.2 1.3 1.4 1.5 1.6 The TANDBERG API ................................................................................................................. 3 Introduction to XML..................................................................................................................... 4 Introduction to XML Path Language (XPath) ..............................................................................
TANDBERG Gatekeeper/Border Controller API User Guide 1 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.
TANDBERG Gatekeeper/Border Controller API User Guide 1.1 Introduction to XML XML is a markup language for documents containing structured information. All information elements in an XML document are marked by a tag and a corresponding end-tag. The end-tag has the same name as the tag, but is prefixed with a slash ( / ). All tags are put within angular brackets ( < > ). Example 1.1 Below is an example of how the configuration for SNMP could be represented using XML.
TANDBERG Gatekeeper/Border Controller API User Guide Example 1.3 If we now look at the NTP element once NTP has been correctly configured we see that it now contains more sub-structure: 10.0.0.
TANDBERG Gatekeeper/Border Controller API User Guide 1.2 Introduction to XML Path Language (XPath) XPath is a comprehensive language to address data in XML documents. It is, however, very simple to understand the basics. If you are able to specify the path to a file on your computer, you are able to specify the path to an element in a XML structure. Example 1.5 Let us go back to the SNMP configuration of Example 1.
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. To show all the aliases registered on the system, the complete path would be: Status/Registrations/Registration/Aliases/Alias Using the “double slash" syntax this can be simplified to: Status//Alias Example 1.
TANDBERG Gatekeeper/Border Controller API User Guide 1.3 The TANDBERG XML Engine The TANDBERG XML engine is optimized for advanced machine-machine interaction between a TANDBERG system and an external control application. The main features can be summarized as: • Structuring of information • Addressing using XPath • Feedback 1.3.
TANDBERG Gatekeeper/Border Controller API User Guide monitor by using XPath. The user/control application can therefore limit the amount of information it receives from the target system to only those parts being of interest for the given application. 1.4 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: 1.
TANDBERG Gatekeeper/Border Controller API User Guide Example 1.9 The element Zone will contain different sub elements depending on the zone status: No gatekeeper reachable MyNeighbor DNS Resolution Failed baddns.example.
TANDBERG Gatekeeper/Border Controller API User Guide Example 1.10 From the XML structure below we see that the Speed element of Ethernet[1] is configured to Auto. The Speed element references the EthernetSpeed element in the ValueSpace document, showing the value domain for this configuration.
TANDBERG Gatekeeper/Border Controller API User Guide Example 1.11 The command Dial is defined to take five parameters. Only the callSrc and callDst parameters are required; this is specified by the attribute required. The value domain for the parameters is referenced by the attribute valueSpaceRef.
TANDBERG Gatekeeper/Border Controller API User Guide Example 1.13 The Dial command in the above example may return the following response structure: alice@example.com bob@example.
TANDBERG Gatekeeper/Border Controller API User Guide 1.5 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: • bare-bone HTTP requests where URLs uniquely identify the request, and • SOAP, where a single URI is used but the request itself is encoded with XML. 1.5.
TANDBERG Gatekeeper/Border Controller API User Guide Like getxml, it has the data URL form-data encoded with one single parameter. The Content-Type of the document must be of type “application/x-www-form-urlencoded" and the body must be encoded accordingly (e.g. first line will be xmldoc=). Example 1.
TANDBERG Gatekeeper/Border Controller API User Guide putxml Request URI: /putxml Request parameter: HTTP BODY as argument Putxml is like formputxml, but uses the complete BODY as the argument (i.e. the content of the xmldoc parameter). The Content-type should be set to either "text/xml", "application/xml" or "text/plain". 1.5.2 SOAP The command and configuration interface is also available over SOAP. The syntax for the interface is specified using the Web Services Description Language (WSDL).
TANDBERG Gatekeeper/Border Controller API User Guide The SOAP interface has a number of operations for dealing with Status and Configuration: GetXML Returns status or configuration information for a specified XPath expression. The returned value is an XML document. GetConfiguration Returns configuration information for a specified XPath expression. The returned value is a strongly typed SOAP value as defined in the WSDL document.
TANDBERG Gatekeeper/Border Controller API User Guide Example 1.22 The example below performs the same task as Example 1.21 but uses GetConfiguration: '', 'password' => '')); $result = $client->GetConfiguration( array('Location' => '/SNMP') ); echo $result->GetConfigurationResult->Configuration->SNMP->SystemContact; ?> Example 1.
TANDBERG Gatekeeper/Border Controller API User Guide 1.6 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. Exercise 1 The example in this exercise shows how to read the supported XML documents from the system using a web browser.
TANDBERG Gatekeeper/Border Controller API User Guide Exercise 4 The address: http://10.0.0.1/xmlput.ssi contains an editor where XML data can be edited and then posted to the system by pressing the save button. Below are examples of XML structures to be posted to the system: Administrator -- Administrator 10.0.0.
TANDBERG Gatekeeper/Border Controller API User Guide 2 The XML-based Advanced Command Line Interface The XML-based Advanced Command Line Interface, XACLI, is a very flexible interface optimized for both machine-machine interaction and man-machine interaction. It is based on the powerful TANDBERG XML engine and offers many of the same features as the TANDBERG XML interface. The main distinction between XACLI and the TANDBERG XML interface is the input format.
TANDBERG Gatekeeper/Border Controller API User Guide If the instance number of a given element is omitted, the expression addresses all instances of this element Example 2.1 To address the Address sub-element of DNS Server 2: XPath: SimplePath: IP/DNS/Server[2]/Address IP DNS Server 2 Address To address the Address sub-element of all DNS Server elements: XPath: SimplePath: IP/DNS/Server/Address IP DNS Server Address 2.1.
TANDBERG Gatekeeper/Border Controller API User Guide 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.
TANDBERG Gatekeeper/Border Controller API User Guide 2.2 The Status-type root commands – xstatus / xhistory The information accessible through these commands is the exact same information that is available in the corresponding XML documents. To get an overview of accessible top-level elements within a status-type root command, type ? or help after the status-type root command. Example 2.3 xstatus ? - Status Calls Ethernet ExternalManager Feedback [1..
TANDBERG Gatekeeper/Border Controller API User Guide 2.2.1 Format Status information is presented by a mark-up notation, similar to XML.
TANDBERG Gatekeeper/Border Controller API User Guide 2.3 The Configuration-type root commands xconfiguration The information accessible through these commands is exactly the same information that is available in the corresponding XML documents. To get an overview of accessible top-level configuration elements, type ? or help after the configuration-type root command: ? Example 2.
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 configurations supported by the system, type: // ? or ?? 2.3.
TANDBERG Gatekeeper/Border Controller API User Guide Example 2.9 User wants to set IP address: ip address: "10.0.0.1" or ip/address: "10.0.0.1" D14172.
TANDBERG Gatekeeper/Border Controller API User Guide 2.4 The Command-type root commands xcommand To get an overview of the supported commands within a command-type root command, type ? or help after the command-type root command. ? Example 2.
TANDBERG Gatekeeper/Border Controller API User Guide 2.4.1 Command help To get help on a specific command, type the command-type root command, followed by a command name, followed by ? or help: ? Example 2.12 xcommand Dial ? xcomm dial ? *h xCommand Dial callSrc(r): callDst(r): Bandwidth: <1..
TANDBERG Gatekeeper/Border Controller API User Guide Sequence notation ... When using this notation, the parameter values must be entered in the sequence as stated in the help text: Example 2.16 xcommand dial alice bob 384 Combination A combination of mark-up notation and sequence are also supported.
TANDBERG Gatekeeper/Border Controller API User Guide 2.5 XML Output - xgetxml As an alternative to the standard XACLI output format, XML format is supported through the root command xgetxml. xgetxml takes an XPath expression as parameter and the elements (or complete document) matching the expression will be returned. Example 2.19 xgetxml status/ntp 10.0.0.
TANDBERG Gatekeeper/Border Controller API User Guide 2.6 Special Commands In addition to the root commands described above, XACLI support a set of root commands that only applies to the Telnet session or RS232 session from where they are issued. This lets the user/control application individually configure the session(s) in use. Supported special commands: • xfeedback (not supported on all platforms) • xpreferences 2.6.
TANDBERG Gatekeeper/Border Controller API User Guide Alias 2 (type=E164, origin=Endpoint): "441184960001" *s/end Example 2.21 User wants to monitor for when a zone fails: xfeedback register status/zones/zone[@status="Failed"] OK When a problem with a zone occurs: *s Zones: Zone 1 (status=Failed): Cause: No gatekeeper reachable Name: "MyNeighbor" Gatekeeper (status=Failed): Cause: No response from gatekeeper Address: "10.0.0.
TANDBERG Gatekeeper/Border Controller API User Guide 2.6.2 xpreferences The special command xpreferences lets the user/control application individually configure the Telnet/RS-232 session in use. xpreferences ? usage: or: or: or: or: xpreferences xpreferences xpreferences xpreferences xpreferences xpathwrite detaillevel <1..
TANDBERG Gatekeeper/Border Controller API User Guide xpreferences xmlstatusfeedback If xmlstatusfeedback is set to on, all status feedback will be returned in XML-format instead of the standard XACLI status format. Example 2.26 XACLI-format: *s NTP (status=Active): Address: "10.0.0.2" Port: 123 LastUpdate: "2008-01-01 12:00:00" LastCorrection: 1 *s/end XML-format: 10.0.0.
TANDBERG Gatekeeper/Border Controller API User Guide 3 API - Configurations This section gives an overview of the Configuration Information available in the Configuration XML document (configuration.xml). All examples are presented using the standard XACLI format. 3.1 configuration.xml – xconfiguration SystemUnit Name: Defines the name of the system. Choose a name that uniquely identifies the system. SystemUnit Password: Defines the password of the system.
TANDBERG Gatekeeper/Border Controller API User Guide IP DNS Server [1..5] Address: Sets the IP Address of up to 5 DNS servers to be queried when resolving domain names. IP DNS Domain Name: Specifies the name to be appended to the host name before a query to the DNS server is executed. Used only when attempting to resolve a domain name which is not fully qualified. NTP Address: Sets the IP Address or FQDN of the NTP server to be used when synchronizing system time.
TANDBERG Gatekeeper/Border Controller API User Guide SSH Mode: Determines whether the system can be accessed via SSH and SCP. Note: You must restart the system for any changes to take effect. HTTP Mode: Determines whether the system can be accessed via the web server over HTTP. Note: You must restart the system for any changes to take effect. HTTPS Mode: Determines whether the system can be accessed via the web server over HTTPS.
TANDBERG Gatekeeper/Border Controller API User Guide Gatekeeper ForwardLocationRequests: Determines the behavior of the system when it receives from another Gatekeeper a location request (LRQ) that it cannot resolve locally. On: the request will be forwarded to neighbor Gatekeepers. Off: the request will not be forwarded. Gatekeeper DNSResolution Mode: Determines whether or not DNS lookup of H.323 URIs is enabled on this system.
TANDBERG Gatekeeper/Border Controller API User Guide Gatekeeper Downspeed PerCall Mode: Determines whether or not the system will attempt to downspeed a call if there is insufficient per-call bandwidth available to fulfill the request. On: the system will attempt to place the call at a lower bandwidth. Off: the call will be rejected.
TANDBERG Gatekeeper/Border Controller API User Guide Traversal UDPProbe RetryCount: <1..65534> (Applies only if the system is a Border Controller.) Specifies the number of attempts at reestablishing a failed UDP channel. Traversal UDPProbe KeepAliveInterval: <1..65534> (Applies only if the system is a Border Controller.) Specifies the interval with which a UDP channel should be refreshed. Traversal TCPProbe RetryInterval: <1..65534> (Applies only if the system is a Border Controller.
TANDBERG Gatekeeper/Border Controller API User Guide Authentication Database: Selects between a local database and a remote LDAP repository for the storage of password information for authentication. Authentication LDAP BaseDN: Specifies the Distinguished Name to use when connecting to an LDAP server. Authentication LDAP AliasOrigin: Determines which aliases (i.e.
TANDBERG Gatekeeper/Border Controller API User Guide Zones Zone [1..100] Match [1..5] Pattern Type: (Applies only if the Match mode is Pattern Match.) Determines the way in which the string must match the alias. 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. Zones Zone [1..100] Match [1..
TANDBERG Gatekeeper/Border Controller API User Guide Zones TraversalZone [1..50] Match [1..5] Pattern Type: (Applies only if the Match mode is Pattern Match.) Determines the way in which the string must match the alias. 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. Zones TraversalZone [1..50] Match [1..
TANDBERG Gatekeeper/Border Controller API User Guide SubZones TraversalSubZone Bandwidth PerCall Mode: Determines whether there is a limit on the bandwidth of any one traversal call being handled by the system. SubZones TraversalSubZone Bandwidth PerCall Limit: <1..100000000> Specifies the bandwidth limit (in kbps) applied to any one traversal call being handled by the system (applies only if Mode is set to Limited). SubZones SubZone [1..
TANDBERG Gatekeeper/Border Controller API User Guide Pipes Pipe [1..100] Bandwidth Total Limit: <1..100000000> If this pipe has limited bandwidth, sets the maximum bandwidth (in kbps) available at any one time on the pipe. Pipes Pipe [1..100] Bandwidth PerCall Mode: Determines whether or not this pipe is limiting the bandwidth of individual calls. None: no bandwidth available. Pipes Pipe [1..100] Bandwidth PerCall Limit: <1..
TANDBERG Gatekeeper/Border Controller API User Guide 4 API - Commands This section gives an overview of the supported system Commands. All examples are presented using the standard XACLI format. 4.1 command.xml – xcommand AdHocConference Transfers all calls for the specified endpoint to the configured ad hoc conference. Registration(r): <1..3750> The index of the registration to be transferred. AllowListAdd Adds an entry to the Allow List.
TANDBERG Gatekeeper/Border Controller API User Guide Bandwidth(r): <1..100000000> The requested bandwidth of the call (in kbps). CallType(r): Whether the call type is Traversal, Routed or Direct. CredentialAdd Adds an entry to the local authentication database. CredentialName(r): Defines the name for this entry in the local authentication database. CredentialPassword(r): Defines the password for this entry in the local authentication database.
TANDBERG Gatekeeper/Border Controller API User Guide EncryptionType: The type of encryption that will be used for the call. DisconnectCall Disconnects a call. Call: <1..900> The index of the call to be disconnected.. CallSerialNumber: The serial number of the call to be disconnected. FeedbackRegister Activates notifications on the event or status change(s) described by the Expression(s). Notifications are sent in XML format to the specified URL.
TANDBERG Gatekeeper/Border Controller API User Guide Locate Runs the system's location algorithm to locate the endpoint identified by the given alias, searching locally, on neighbors, and on systems discovered through the DNS system, within the specified number of 'hops'. Results are reported back through the xFeedback mechanism, which must therefore be activated before issuing this command (e.g. xFeedback register event/locate).
TANDBERG Gatekeeper/Border Controller API User Guide RegistrationSerialNumber: The serial number of the registration to be removed. SubZoneAdd Adds and configures a new subzone. SubZoneName(r): Assigns a name to this subzone. Address1: Specifies an IP Address used (in conjunction with the IP Prefix Length) to identify a subnet to be assigned to this subzone. PrefixLength1: <0..
TANDBERG Gatekeeper/Border Controller API User Guide PerCallIntraMode: Determines whether there is a limit on the bandwidth for any one call between two endpoints within this subzone. PerCallIntra: <1..100000000> Specifies the bandwidth limit (in kbps) for any one call between two endpoints within this subzone (applies only if Mode is set to Limited). SubZoneDelete Deletes a subzone. SubZoneId(r): <1..100> The index of the subzone to be deleted.
TANDBERG Gatekeeper/Border Controller API User Guide Gatekeeper2Address: Specifies the IP Address or FQDN of the traversal server. Up to five alternate traversal servers can also be specified. Gatekeeper2Port: <1..65534> (Applies only if the system is a Gatekeeper.) Specifies the port on the traversal server to connect to. Gatekeeper3Address: Specifies the IP Address or FQDN of the traversal server. Up to five alternate traversal servers can also be specified. Gatekeeper3Port: <1..
TANDBERG Gatekeeper/Border Controller API User Guide Match1PatternReplace: (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. Match2Mode: 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.
TANDBERG Gatekeeper/Border Controller API User Guide Match4PatternType: (Applies only if the Match mode is Pattern Match.) Determines the way in which the string must match the alias. 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. Match4PatternBehavior: (Applies only if the Match mode is Pattern Match.
TANDBERG Gatekeeper/Border Controller API User Guide Gatekeeper2Port: <1..65534> Specifies the port on the neighbor to be used. Gatekeeper3Address: Specifies the IP Address or FQDN of this neighbor. Gatekeeper3Port: <1..65534> Specifies the port on the neighbor to be used. Gatekeeper4Address: Specifies the IP Address or FQDN of this neighbor. Gatekeeper4Port: <1..65534> Specifies the port on the neighbor to be used.
TANDBERG Gatekeeper/Border Controller API User Guide Match2PatternString: (Applies only if the Match mode is Pattern Match.) Specifies the pattern against which the alias is compared. Match2PatternType: (Applies only if the Match mode is Pattern Match.) Determines the way in which the string must match the alias. Prefix: the string must appear at the beginning of the alias. Suffix: the string must appear at the end of the alias.
TANDBERG Gatekeeper/Border Controller API User Guide Match4PatternBehavior: (Applies only if the Match mode is Pattern Match.) Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone. Leave: the alias will be unmodified. 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.
TANDBERG Gatekeeper/Border Controller API User Guide 5 API - Status This section gives an overview of the Status Information available in the Status XML documents (status.xml / history.xml / event.xml) and the Status root commands (xstatus / xhistory) of the XACLI interface. All examples are presented using the standard XACLI format. 5.1 status.xml – xstatus SystemUnit SystemUnit Product: Shows the product name. SystemUnit Uptime: Shows the uptime in seconds.
TANDBERG Gatekeeper/Border Controller API User Guide SystemUnit Software Configuration TraversalCalls: Shows the systems traversal call capacity. SystemUnit Software Configuration Registrations: Shows the systems registration capacity. SystemUnit Software Configuration Encryption: Shows whether AES encryption is present. SystemUnit Software Configuration Multiway: Shows whether Multiway is available.
TANDBERG Gatekeeper/Border Controller API User Guide IP IPv6 Gateway: Shows the IPv6 address of the default gateway. Only present if the Protocol is IPv6 or Both. IP DNS Server [1..5] Address: Shows the IP address of a configured DNS server. IP DNS Domain Name: Shows the DNS domain to which the system belongs. NTP NTP [status = ] Shows the status of the connection to the NTP server.
TANDBERG Gatekeeper/Border Controller API User Guide ExternalManager ExternalManager [status = ] Shows the status of the connection to the external manager. ExternalManager Cause: Shows an error reason for a failure to connect to the external manager. Only present if the external manager status is Failed. ExternalManager Address: Shows the address of the external manager. Only present if the external manager status is Active.
TANDBERG Gatekeeper/Border Controller API User Guide ResourceUsage TotalNonTraversalCalls: Shows the total number of non traversal calls that have been placed on the system. Only present if the system is a Gatekeeper. ResourceUsage TraversalCalls: Shows the current number of traversal calls on the system. ResourceUsage MaxTraversalCalls: Shows the maximum number of concurrent traversal calls on the system.
TANDBERG Gatekeeper/Border Controller API User Guide Calls Call [1..900] Leg [1..2] RegistrationID: Shows the registration ID of the call party if it is locally registered. Calls Call [1..900] Leg [1..2] SerialNumber: Shows the serial number of the call party registration. Only present if the call party is locally registered. Calls Call [1..900] Leg [1..2] Alias [type = ] Shows the type of the call party alias. Calls Call [1..900] Leg [1..
TANDBERG Gatekeeper/Border Controller API User Guide Registrations Registrations Registration [1..3750] CallSignalAddresses Address [1..10]: Shows the IP address and port to use for call signaling. Registrations Registration [1..3750] RASAddresses Address [1..10]: Shows the IP address and port to use for RAS signaling. Registrations Registration [1..3750] Endpoint: Shows that the registration is an endpoint. Only present if the registration is an endpoint. Registrations Registration [1..
TANDBERG Gatekeeper/Border Controller API User Guide Zones Zones DefaultZone Calls Call [1..900]: Shows the index of a call in the Default Zone. Zones DefaultZone Bandwidth Total: Shows the total bandwidth in kbps allowed in the Default Zone. Zones DefaultZone Bandwidth PerCall: Shows the bandwidth in kbps allowed per call in the Default Zone. Zones DefaultZone Bandwidth Used: Shows the bandwidth in kbps being used in the Default Zone. Zones TraversalZone [1..
TANDBERG Gatekeeper/Border Controller API User Guide Zones TraversalZone [1..50] Bandwidth PerCall: Shows the bandwidth in kbps allowed per call in the traversal zone. Zones TraversalZone [1..50] Bandwidth Used: Shows the bandwidth in kbps being used in the traversal zone. Zones Zone [1..50] [status = ] Shows the status of the connection to the zone. Zones Zone [1..50] Cause: Shows an error reason for a failure to communicate with the zone.
TANDBERG Gatekeeper/Border Controller API User Guide Subzones SubZones DefaultSubZone Registrations Registration [1..3750]: Shows the index of a registration in the Default SubZone. SubZones DefaultSubZone Calls Call [1..900]: Shows the index of a call in the Default SubZone. SubZones DefaultSubZone Bandwidth Total: Shows the total bandwidth in kbps allowed in the Default SubZone.
TANDBERG Gatekeeper/Border Controller API User Guide Links Links Link [1..100] Name: Shows the name of the link. Links Link [1..100] Calls Call [1..900]: Shows the index of a call using the link. Links Link [1..100] Bandwidth Total: Shows the total bandwidth in kbps allowed on the link. Links Link [1..100] Bandwidth PerCall: Shows the bandwidth in kbps allowed per call on the link. Links Link [1..
TANDBERG Gatekeeper/Border Controller API User Guide 5.2 history.xml – xhistory Calls Calls Call [1..255] SerialNumber: Shows the unique serial number of the call. Calls Call [1..255] State: Shows the state of the call. Calls Call [1..255] CallType: Shows the type of the call. Calls Call [1..255] Bandwidth: Shows the bandwidth in kbps for the call. Calls Call [1..255] Leg [1..
TANDBERG Gatekeeper/Border Controller API User Guide Registrations Registrations Registration [1..255] CallSignalAddresses Address [1..10]: Shows the IP address and port used for call signaling. Registrations Registration [1..255] RASAddresses Address [1..10]: Shows the IP address and port used for RAS signaling. Registrations Registration [1..255] Endpoint: Shows that the registration was endpoint. Only present if the registration was an endpoint. Registrations Registration [1..
TANDBERG Gatekeeper/Border Controller API User Guide Registrations Registration [1..255] RegistrationRejectionCause: Shows the cause for the registration being rejected. Only present if the reason is RegistrationRejected. Registrations Registration [1..255] RegistrationRejectionDescription: Shows a description of the cause for the registration being rejected. Only present if the reason is RegistrationRejected. D14172.
TANDBERG Gatekeeper/Border Controller API User Guide 5.3 event.xml – xevent CallAttempt CallAttempt Call [1..900] SerialNumber: Shows the unique serial number of the call. CallAttempt Call [1..900] State: Shows the state of the call. CallAttempt Call [1..900] CallType: Shows the type of the call. CallAttempt Call [1..900] Transferable: Shows whether this call is capable of being transferred. CallAttempt Call [1..
TANDBERG Gatekeeper/Border Controller API User Guide CallAttempt Call [1..900] Duration: Shows the duration of the call in seconds. CallAttempt Call [1..900] SourceAlias: Shows the alias of the source call party. CallAttempt Call [1..900] SourceAddress: Shows the IP address and port of the source call party. CallAttempt Call [1..900] DestinationAlias: Shows the alias of the destination call party. CallAttempt Call [1..
TANDBERG Gatekeeper/Border Controller API User Guide Connected Call [1..900] Leg [1..2] Address: Shows the IP address and port of the call party. Connected Call [1..900] Leg [1..2] Encryption [status = ] Shows the status of encryption on the call leg. Connected Call [1..900] Leg [1..2] Encryption CheckCode: Shows the check code for the encrypted call leg. Only present if encryption status is On. Connected Call [1..
TANDBERG Gatekeeper/Border Controller API User Guide Disconnected Call [1..900] StartTime: Shows the time at which the call was initiated. Disconnected Call [1..900] Duration: Shows the duration of the call in seconds. Disconnected Call [1..900] DisconnectCauseValue: Shows the reason the call was disconnected. Disconnected Call [1..900] DisconnectCause: Shows a description of the reason the call was disconnected. Disconnected Call [1..
TANDBERG Gatekeeper/Border Controller API User Guide ConnectionFailure Call [1..900] StartTime: Shows the time at which the call was initiated. ConnectionFailure Call [1..900] Duration: Shows the duration of the call in seconds. ConnectionFailure Call [1..900] DisconnectCauseValue: Shows the reason the call failed. ConnectionFailure Call [1..900] DisconnectCause: Shows a description of the reason the call failed. ConnectionFailure Call [1..
TANDBERG Gatekeeper/Border Controller API User Guide Registration Registration [1..3750] MCU Prefix [1..200]: Shows the prefix of a registered MCU service. Only present if the registration is an MCU. Registration Registration [1..3750] OutOfResources: Shows the resource usage of a gateway or an MCU. Only present if the registered system is a gateway or an MCU. Registration Registration [1..3750] Traversal: Shows the traversal type of the registration.
TANDBERG Gatekeeper/Border Controller API User Guide Unregistration Registration [1..3750] MCU: Shows that the registration was an MCU. Only present if the registration was an MCU. Unregistration Registration [1..3750] MCU Prefix [1..200]: Shows the prefix of a registered MCU service. Only present if the registration was an MCU. Unregistration Registration [1..3750] Aliases Alias [1..200] [type = ] Shows the type of the alias.
TANDBERG Gatekeeper/Border Controller API User Guide RegistrationFailure Registration [1..3750] Gateway Prefix [1..200]: Shows the prefix of a registered gateway service. Only present if the registration was a gateway. RegistrationFailure Registration [1..3750] MCU: Shows that the registration was an MCU. Only present if the registration was an MCU. RegistrationFailure Registration [1..3750] MCU Prefix [1..200]: Shows the prefix of a registered MCU service.
TANDBERG Gatekeeper/Border Controller API User Guide Bandwidth Bandwidth Call [1..900] SerialNumber: Shows the unique serial number of the call. Bandwidth Call [1..900] State: Shows the state of the call. Bandwidth Call [1..900] CallType: Shows the type of the call. Bandwidth Call [1..900] Transferable: Shows whether this call is capable of being transferred.
TANDBERG Gatekeeper/Border Controller API User Guide Bandwidth Call [1..900] Duration: Shows the duration of the call in seconds. Bandwidth Call [1..900] SourceAlias: Shows the alias of the source call party. Bandwidth Call [1..900] SourceAddress: Shows the IP address and port of the source call party. Bandwidth Call [1..900] DestinationAlias: Shows the alias of the destination call party. Bandwidth Call [1..
TANDBERG Gatekeeper/Border Controller API User Guide ResourceUsage ResourceUsage Registrations: Shows the current number of registrations on the system. ResourceUsage MaxRegistrations: Shows the maximum number of concurrent registrations on the system. ResourceUsage NonTraversalCalls: Shows the current number of non traversal calls on the system. Only present if the system is a Gatekeeper.
