Summary of the content on the page No. 5
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.2 123 2008-01-01 12:00:00 1 In this example, the attributes are used to provi
Summary of the content on the page No. 6
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.1: On
Summary of the content on the page No. 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. 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
Summary of the content on the page No. 8
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.1 Structuring of Information An application programming interface can be seen as a gate where information is exchanged between two systems: a control
Summary of the content on the page No. 9
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 informatio
Summary of the content on the page No. 10
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.com 1719
Summary of the content on the page No. 11
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. Auto ---
Summary of the content on the page No. 12
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.
Summary of the content on the page No. 13
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.com 384 1 Auto Auto
Summary of the content on the page No. 14
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 wi
Summary of the content on the page No. 15
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.16 Using the Unix curl command, the systems SNMP contact can be set in the Configuration document: curl –k –u admin: -d \ '
Summary of the content on the page No. 16
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 Lan
Summary of the content on the page No. 17
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. GetConfigurationXML Returns configuration informatio
Summary of the content on the page No. 18
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.23 The example below shows how
Summary of the content on the page No. 19
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. Enter th
Summary of the content on the page No. 20
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
