Tandberg Gatekeeper/Border Controller API D14172.01 User Manual

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

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 10 of 84 Example 1.9 The element Zone will contain different sub elements de

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 11 of 84 Example 1.10 From the XML structure below we see that the Speed el

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 12 of 84 Example 1.11 The command Dial is defined to take five parameters. O

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 13 of 84 Example 1.13 The Dial command in the above example may return the f

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 14 of 84 1.5 Introduction to TANDBERG XML API Service (TXAS) TXAS is a serv

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 15 of 84 Like getxml, it has the data URL form-data encoded with one single pa

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 16 of 84 putxml Request URI: /putxml Request parameter: HTTP BODY as argumen

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 17 of 84 The SOAP interface has a number of operations for dealing with Status

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 18 of 84 Example 1.22 The example below performs the same task as Example 1

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 19 of 84 1.6 Exercises The exercises in this section are based on using a TAN

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 2 of 84 Table of Contents 1 The TANDBERG API...

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 20 of 84 Exercise 4 The address: http://10.0.0.1/xmlput.ssi contains an editor

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 21 of 84 2 The XML-based Advanced Command Line Interface The XML-based Advanc

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 22 of 84 If the instance number of a given element is omitted, the expression

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 23 of 84 Request for Zone1 element with exposure option “--“: xstatus zones

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 24 of 84 2.2 The Status-type root commands – xstatus / xhistory The informa

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 25 of 84 2.2.1 Format Status information is presented by a mark-up notation,

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 26 of 84 2.3 The Configuration-type root commands - xconfiguration The infor

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 27 of 84 NOTE! Only typing ? actually addresses all configuration elements w

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 28 of 84 Example 2.9 User wants to set IP address: ip addres

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 29 of 84 2.4 The Command-type root commands - xcommand To get an overview of

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 t

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 30 of 84 2.4.1 Command help To get help on a specific command, type the com

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 31 of 84 Sequence notation <command-type root command> <command>

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 ou

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 33 of 84 2.6 Special Commands In addition to the root commands described abov

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 34 of 84 Alias 2 (type=E164, origin=Endpoint): "441184960001&quo

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 35 of 84 2.6.2 xpreferences The special command xpreferences lets the user

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 36 of 84 xpreferences xmlstatusfeedback <on/off> If xmlstatusfeedback is

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 37 of 84 3 API - Configurations This section gives an overview of the Configu

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 38 of 84 IP DNS Server [1..5] Address: <S: 0, 39> Sets the IP Address of

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 39 of 84 SSH Mode: <On/Off> Determines whether the system can be accesse

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 contai

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 40 of 84 Gatekeeper ForwardLocationRequests: <On/Off> Determines the beh

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 41 of 84 Gatekeeper Downspeed PerCall Mode: <On/Off> Determines whether

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 42 of 84 Traversal UDPProbe RetryCount: <1..65534> (Applies only if the

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 43 of 84 Authentication Database: <LocalDatabase/LDAPDatabase> Selects b

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 44 of 84 Zones Zone [1..100] Match [1..5] Pattern Type: <Prefix/Suffix/Reg

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 45 of 84 Zones TraversalZone [1..50] Match [1..5] Pattern Type: <Prefix/Su

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 46 of 84 SubZones TraversalSubZone Bandwidth PerCall Mode: <None/Limited/Un

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 47 of 84 Pipes Pipe [1..100] Bandwidth Total Limit: <1..100000000> If th

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 48 of 84 4 API - Commands This section gives an overview of the supported sys

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 49 of 84 Bandwidth(r): <1..100000000> The requested bandwidth of the ca

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 5 of 84 Example 1.3 If we now look at the NTP element once NTP has been cor

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 50 of 84 EncryptionType: <DES/AES-128/Auto> The type of encryption that

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 51 of 84 Locate Runs the system's location algorithm to locate the endpoi

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 52 of 84 RegistrationSerialNumber: <S: 0, 255> The serial number of the

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 53 of 84 PerCallIntraMode: <None/Limited/Unlimited> Determines whether

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 54 of 84 Gatekeeper2Address: <S: 1, 128> Specifies the IP Address or FQ

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 55 of 84 Match1PatternReplace: <S: 0, 60> (Applies only if the Pattern

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 56 of 84 Match4PatternType: <Prefix/Suffix/Regex> (Applies only if the

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 57 of 84 Gatekeeper2Port: <1..65534> Specifies the port on the neighbor

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 58 of 84 Match2PatternString: <S: 0, 60> (Applies only if the Match mod

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 59 of 84 Match4PatternBehavior: <Strip/Leave/Replace> (Applies only if

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 6 of 84 1.2 Introduction to XML Path Language (XPath) XPath is a comprehensi

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 60 of 84 5 API - Status This section gives an overview of the Status Informat

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 61 of 84 SystemUnit Software Configuration TraversalCalls: <Integer> Sho

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 62 of 84 IP IPv6 Gateway: <IPv4Addr> Shows the IPv6 address of the defau

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 63 of 84 ExternalManager ExternalManager [status = <Inactive/Active/Failed&

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 64 of 84 ResourceUsage TotalNonTraversalCalls: <Integer> Shows the total

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 65 of 84 Calls Call [1..900] Leg [1..2] RegistrationID: <String> Shows t

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 66 of 84 Registrations Registrations Registration [1..3750] CallSignalAddresse

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 67 of 84 Zones Zones DefaultZone Calls Call [1..900]: <Integer> Shows th

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 68 of 84 Zones TraversalZone [1..50] Bandwidth PerCall: <String> Shows t

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 69 of 84 Subzones SubZones DefaultSubZone Registrations Registration [1..3750]

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 7 of 84 Example 1.7 When using XPath it is possible to omit specifying inter

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

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 71 of 84 5.2 history.xml – xhistory Calls Calls Call [1..255] SerialNumber:

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 72 of 84 Registrations Registrations Registration [1..255] CallSignalAddresses

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 73 of 84 Registrations Registration [1..255] RegistrationRejectionCause: <S

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 74 of 84 5.3 event.xml – xevent CallAttempt CallAttempt Call [1..900] Serial

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 75 of 84 CallAttempt Call [1..900] Duration: <String> Shows the duration

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 76 of 84 Connected Call [1..900] Leg [1..2] Address: <String> Shows the

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 77 of 84 Disconnected Call [1..900] StartTime: <String> Shows the time a

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 78 of 84 ConnectionFailure Call [1..900] StartTime: <String> Shows the t

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 79 of 84 Registration Registration [1..3750] MCU Prefix [1..200]: <String&g

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 fo

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 80 of 84 Unregistration Registration [1..3750] MCU: Shows that the registratio

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 81 of 84 RegistrationFailure Registration [1..3750] Gateway Prefix [1..200]: &

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 82 of 84 Bandwidth Bandwidth Call [1..900] SerialNumber: <String> Shows

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 83 of 84 Bandwidth Call [1..900] Duration: <String> Shows the duration o

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 84 of 84 ResourceUsage ResourceUsage Registrations: <Integer> Shows the

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 page 9 of 84 monitor by using XPath. The user/control application can therefore lim