TANDBERG D14172.01 - Manuals

TANDBERG D14172.01 – Manual in PDF format online.

Manuals:

Manual

Manual TANDBERG D14172.01

Summary

Page 2 - Table of Contents

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 2 of 84 Table of Contents 1 The TANDBERG API ................................................................................................................. 3 1.1 Introduction to XML...................................................

Page 3 - TANDBERG

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 3 of 84 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 ...

Page 4 - to

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 4 of 84 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 ...

Page 6 - Introduction to XML Path Language (XPath)

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 6 of 84 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 co...

Page 8 - The TANDBERG XML Engine

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 8 of 84 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 o...

Page 9 - The XML Documents

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 9 of 84 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...

Page 21 - Advanced Command Line Interface

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 21 of 84 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 t...

Page 26 - xconfiguration

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 26 of 84 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 accessi...

Page 32 - XML Output - xgetxml

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 32 of 84 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 documen...

Page 33 - Commands

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 33 of 84 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 app...

Page 37 - Configurations

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 37 of 84 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 confi...

Page 48 - command.xml – xcommand

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 48 of 84 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 ...

Page 60 - Status; status.xml – xstatus; SystemUnit

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 60 of 84 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. ...

Page 61 - Options

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 61 of 84 SystemUnit Software Configuration TraversalCalls: <Integer> Shows the systems traversal call capacity. SystemUnit Software Configuration Registrations: <Integer> Shows the systems registration capacity. SystemUn...

Page 62 - LDAP

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 62 of 84 IP IPv6 Gateway: <IPv4Addr> Shows the IPv6 address of the default gateway. Only present if the Protocol is IPv6 or Both. IP DNS Server [1..5] Address: <String> Shows the IP address of a configured DNS server. IP...

Page 63 - ExternalManager; Feedback; ResourceUsage

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 63 of 84 ExternalManager ExternalManager [status = <Inactive/Active/Failed>] Shows the status of the connection to the external manager. ExternalManager Cause: <String> Shows an error reason for a failure to connect to t...

Page 64 - Gatekeeper

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 64 of 84 ResourceUsage TotalNonTraversalCalls: <Integer> 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: <Integer&...

Page 66 - Registrations

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 66 of 84 Registrations Registrations Registration [1..3750] CallSignalAddresses Address [1..10]: <String> Shows the IP address and port to use for call signaling. Registrations Registration [1..3750] RASAddresses Address [1..1...

Page 67 - Zones

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 67 of 84 Zones Zones DefaultZone Calls Call [1..900]: <Integer> Shows the index of a call in the Default Zone. Zones DefaultZone Bandwidth Total: <String> Shows the total bandwidth in kbps allowed in the Default Zone. Zo...

Page 69 - Subzones

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 69 of 84 Subzones SubZones DefaultSubZone Registrations Registration [1..3750]: <Integer> Shows the index of a registration in the Default SubZone. SubZones DefaultSubZone Calls Call [1..900]: <Integer> Shows the index o...

Page 70 - Links

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 70 of 84 Links Links Link [1..100] Name: <Integer> Shows the name of the link. Links Link [1..100] Calls Call [1..900]: <Integer> Shows the index of a call using the link. Links Link [1..100] Bandwidth Total: <String&...

Page 71 - history.xml – xhistory; Calls

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 71 of 84 5.2 history.xml – xhistory Calls Calls Call [1..255] SerialNumber: <String> Shows the unique serial number of the call. Calls Call [1..255] State: <Disconnected/ConnectionFailed> Shows the state of the call. Cal...

Page 74 - CallAttempt

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 74 of 84 5.3 event.xml – xevent CallAttempt CallAttempt Call [1..900] SerialNumber: <String> Shows the unique serial number of the call. CallAttempt Call [1..900] State: <Initializing> Shows the state of the call. CallAt...

Page 75 - Connected

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 75 of 84 CallAttempt Call [1..900] Duration: <String> Shows the duration of the call in seconds. CallAttempt Call [1..900] SourceAlias: <String> Shows the alias of the source call party. CallAttempt Call [1..900] SourceA...

Page 76 - Disconnected

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 76 of 84 Connected Call [1..900] Leg [1..2] Address: <String> Shows the IP address and port of the call party. Connected Call [1..900] Leg [1..2] Encryption [status = <On/Off>] Shows the status of encryption on the call ...

Page 77 - ConnectionFailure

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 77 of 84 Disconnected Call [1..900] StartTime: <String> Shows the time at which the call was initiated. Disconnected Call [1..900] Duration: <String> Shows the duration of the call in seconds. Disconnected Call [1..900] ...

Page 78 - Registration

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 78 of 84 ConnectionFailure Call [1..900] StartTime: <String> Shows the time at which the call was initiated. ConnectionFailure Call [1..900] Duration: <String> Shows the duration of the call in seconds. ConnectionFailure...

Page 79 - Unregistration

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 79 of 84 Registration Registration [1..3750] MCU Prefix [1..200]: <String> Shows the prefix of a registered MCU service. Only present if the registration is an MCU. Registration Registration [1..3750] OutOfResources: <On/Of...

Page 80 - RegistrationFailure

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 80 of 84 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]: <String> Shows the prefix of a...

Page 82 - Bandwidth

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 82 of 84 Bandwidth Bandwidth Call [1..900] SerialNumber: <String> Shows the unique serial number of the call. Bandwidth Call [1..900] State: <Unknown/Connecting/Connected/Disconnected /ConnectionFailed/Parked/Parking/Unpark...

Page 83 - Locate

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 83 of 84 Bandwidth Call [1..900] Duration: <String> Shows the duration of the call in seconds. Bandwidth Call [1..900] SourceAlias: <String> Shows the alias of the source call party. Bandwidth Call [1..900] SourceAddress...