Manuals / TANDBERG / Computer Equipment / Network Card

TANDBERG D14172.01 manual XML Output - xgetxml, Example, xgetxml status/ntp Status, NTP Status OK

Models: D14172.01

1 84

Download 84 pages 8.98 Kb

Page 32

2.5XML Output - xgetxml

TANDBERG Gatekeeper/Border Controller API User Guide

2.5XML 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

<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>

OK

D14172.01

page 32 of 84

Image 32

TANDBERG D14172.01 manual XML Output - xgetxml, Example, xgetxml status/ntp Status, NTP Status OK

Contents

TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 JulyTable of Contents The XML-based Advanced Command Line InterfaceAPI - Configurations API - Commands1 The TANDBERG API Disclaimer1.1 Introduction to XML ExampleSNMP Configuration Mode item=1On/ModeDNS IP Configuration ExampleStatus NTP StatusExample 1.2 Introduction to XML Path Language XPathExample Example Using the “double slash syntax this can be simplified toExample 1.3.2 Addressing using XPath 1.3 The TANDBERG XML Engine1.3.1 Structuring of Information 1.3.3 Feedback1.4.2 Status Documents r 1.4 The XML Documents1.4.1 Documents 1.4.3 Configuration documents rw ExampleStatus Zones item=1 Zone item=2 status=Failed Gatekeeper item=1 status=Failed1.4.4 Command documents w Ethernet ConfigurationExample ValueSpacepage 12 of ExampleExample DialResult item=1 status=Error Cause item=189/Cause ExampleExample page 13 of1.5 Introduction to TANDBERG XML API Service TXAS 1.5.1 Bare-bone HTTPS accessgetxml formputxmlExample The new configuration value can be confirmed using the getxml requestExample 1.5.2 SOAP putxmlhttp//10.0.0.1/webservices.wsdl Examplepage 17 of ExampleExample Example ExampleExample page 18 of1.6 Exercises ExerciseExercise ExerciseExercise page 20 of2 The XML-based Advanced Command Line Interface 2.1.1 Accessing XACLI2.1.2 Root commands XACLI root command2.1.4 Exposure options Supported exposure optionsxstatus zones zone Example2.1.5 Misc xstatus zones zoneTANDBERG Gatekeeper/Border Controller API User Guide D14172.012.2 The Status-type root commands - xstatus / xhistory xstatus ?OK xhistory ? - History xstatus registrations registration 1 aliases aliasXACLI 2.2.1 FormatExample XML 2.3 The Configuration-type root commands - xconfiguration 2.3.1 Configuration helpExample ExampleExample 2.3.2 Configuration read2.3.3 Configuration set write Example User wants to set IP addressip address ip/addressExample 2.4 The Command-type root commands - xcommandExample 2.4.1 Command help 2.4.2 Issuing a commandMarkup notation ExampleCommand response Sequence notationCombination Example2.5 XML Output - xgetxml Examplexgetxml status/ntp Status NTP Status OKExample 2.6 Special Commands2.6.1 xfeedback Example User wants to monitor for when a zone failsWhen a problem with a zone occurs xpreferences xmlconfigfeedback on/off 2.6.2 xpreferencesxpreferences xpathwrite on/off xpreferences detaillevelxpreferences xmlcommandresult on/off xpreferences xmlstatusfeedback on/offExample XACLI-format3 API - Configurations 3.1 configuration.xml - xconfigurationIP DNS Server 1..5 Address S 0 SSH Mode On/Off Specifies a DNS domain to use when attempting ENUM resolution Specifies the pattern against which the alias is compared Determines whether or not to enforce authentication for registrations Defines the name for this entry in the local authentication database Zones Zone 1..100 Match 1..5 Pattern Type Prefix/Suffix/Regex Zones TraversalZone 1..50 Match 1..5 Pattern Type Prefix/Suffix/Regex Assigns a name to this subzone Assigns a name to this link 4 API - Commands 4.1 command.xml - xcommandpage 49 of page 50 of page 51 of page 52 of page 53 of page 54 of page 55 of page 56 of page 57 of page 58 of page 59 of SystemUnit 5 API - Status5.1 status.xml - xstatus Options EthernetLDAP ResourceUsage ExternalManagerFeedback Gatekeeper CallsShows the type of the call party alias Registrations Zones Zones TraversalZone 1..50 Bandwidth PerCall String Subzones Links Pipes5.2 history.xml - xhistory CallsRegistrations Registrations Registration 1..255 RASAddresses Address 1..10 StringRegistrations Registration 1..255 RegistrationRejectionCause String page 73 of5.3 event.xml - xevent CallAttemptConnected Disconnected ConnectionFailure Registration Unregistration RegistrationFailure RegistrationFailure Registration 1..3750 Gateway Prefix 1..200 String Bandwidth Locate ResourceUsage page 84 of