Manuals / TANDBERG / Computer Equipment / Network Card

TANDBERG D14172.01 manual API - Status, status.xml - xstatus, SystemUnit

Models: D14172.01

1 84

Download 84 pages 8.98 Kb

Page 60

5 API - Status

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.1status.xml – xstatus

SystemUnit

SystemUnit Product: <String>

Shows the product name.

SystemUnit Uptime: <Integer>

Shows the uptime in seconds.

SystemUnit SystemTime: <String>

Shows the system time.

SystemUnit TimeZone: <String>

Shows the time zone.

SystemUnit TimeZone: <String>

Shows the time zone.

SystemUnit LocalTime: <String>

Shows the local time.

SystemUnit Software Version: <String>

Shows the software version.

SystemUnit Software Build: <String>

Shows the software build.

SystemUnit Software Name: <String>

Shows the software name.

SystemUnit Software ReleaseDate: <String>

Shows the software release date.

SystemUnit Software ReleaseKey: <String>

Shows the software release key.

SystemUnit Software Configuration NonTraversalCalls: <Integer>

Shows the systems non traversal call capacity.

D14172.01

page 60 of 84

Image 60

TANDBERG D14172.01 manual API - Status, status.xml - xstatus, SystemUnit

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 Status1.2 Introduction to XML Path Language XPath ExampleExample Using the “double slash syntax this can be simplified to ExampleExample 1.3.2 Addressing using XPath 1.3 The TANDBERG XML Engine1.3.1 Structuring of Information 1.3.3 Feedback1.4 The XML Documents 1.4.1 Documents1.4.2 Status Documents r 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 ValueSpaceExample Examplepage 12 of 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 formputxmlThe new configuration value can be confirmed using the getxml request ExampleExample 1.5.2 SOAP putxmlhttp//10.0.0.1/webservices.wsdl ExampleExample Examplepage 17 of 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 alias2.2.1 Format Example XMLXACLI 2.3 The Configuration-type root commands - xconfiguration 2.3.1 Configuration helpExample Example2.3.2 Configuration read 2.3.3 Configuration set writeExample Example User wants to set IP addressip address ip/address2.4 The Command-type root commands - xcommand ExampleExample 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 OK2.6 Special Commands 2.6.1 xfeedbackExample User wants to monitor for when a zone fails When a problem with a zone occursExample 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 5 API - Status 5.1 status.xml - xstatusSystemUnit Options EthernetLDAP ExternalManager FeedbackResourceUsage 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