Manuals / TANDBERG / Computer Equipment / Network Card

TANDBERG D14172.01 manual Locate

Models: D14172.01

1 84

Download 84 pages 8.98 Kb

Page 83

Locate

TANDBERG Gatekeeper/Border Controller API User Guide

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

Shows the IP address and port of the source call party.

Bandwidth Call [1..900] DestinationAlias: <String>

Shows the alias of the destination call party.

Bandwidth Call [1..900] DestinationAddress: <String>

Shows the IP address and port of the destination call party.

Locate

LocateResult Result: <Success/Failed>

Shows the result of the search.

LocateResult Alias [type = <IPAddress/E164/H323Id/Email/Url>]

Shows the type of the alias being searched for.

LocateResult Alias: <String>

Shows the value of the alias being searched for.

LocateResult CallSerialNumber: <String>

Shows the unique serial number of the call

LocateResult Location Type: <Local Database/Neighbor/Traversal>

Shows the type of location being searched.

LocateResult Location Alias [type = <IPAddress/E164/H323Id/Email/Url>]

Shows the type of the alias this location is being searched with.

LocateResult Location Alias: <String>

Shows the alias this location is being searched with.

Note: The alias may be different from the original search alias if transforms have been applied.

LocateResult Location Address: <String>

Shows the IP address and port of the location being searched. Only present if the Location Type is Neighbor or Traversal.

LocateResult Location Result: <Success/Failed>

Shows the result of searching this location

LocateResult Location Reason: <Success/Failed>

Shows a description of the reason the search of this location failed. Only present if the Location Result is Failed and the Location Type is Neighbor or Traversal.

D14172.01

page 83 of 84

Image 83

TANDBERG D14172.01 manual Locate

Contents

D14172.01 July TANDBERG Gatekeeper/Border Controller API User GuideAPI - Commands Table of ContentsThe XML-based Advanced Command Line Interface API - ConfigurationsDisclaimer 1 The TANDBERG APIMode item=1On/Mode 1.1 Introduction to XMLExample SNMP ConfigurationNTP Status DNS IP ConfigurationExample StatusExample 1.2 Introduction to XML Path Language XPathExample Example Using the “double slash syntax this can be simplified toExample 1.3.3 Feedback 1.3.2 Addressing using XPath1.3 The TANDBERG XML Engine 1.3.1 Structuring of Information1.4.2 Status Documents r 1.4 The XML Documents1.4.1 Documents Gatekeeper item=1 status=Failed 1.4.3 Configuration documents rwExample Status Zones item=1 Zone item=2 status=FailedValueSpace 1.4.4 Command documents wEthernet Configuration Examplepage 12 of ExampleExample page 13 of DialResult item=1 status=Error Cause item=189/CauseExample Exampleformputxml 1.5 Introduction to TANDBERG XML API Service TXAS1.5.1 Bare-bone HTTPS access getxmlExample The new configuration value can be confirmed using the getxml requestExample Example 1.5.2 SOAPputxml http//10.0.0.1/webservices.wsdlpage 17 of ExampleExample page 18 of ExampleExample ExampleExercise 1.6 ExercisesExercise Exercisepage 20 of ExerciseXACLI root command 2 The XML-based Advanced Command Line Interface2.1.1 Accessing XACLI 2.1.2 Root commandsExample 2.1.4 Exposure optionsSupported exposure options xstatus zones zoneD14172.01 2.1.5 Miscxstatus zones zone TANDBERG Gatekeeper/Border Controller API User Guidexstatus registrations registration 1 aliases alias 2.2 The Status-type root commands - xstatus / xhistoryxstatus ? OK xhistory ? - HistoryXACLI 2.2.1 FormatExample XML Example 2.3 The Configuration-type root commands - xconfiguration2.3.1 Configuration help ExampleExample 2.3.2 Configuration read2.3.3 Configuration set write ip/address ExampleUser wants to set IP address ip addressExample 2.4 The Command-type root commands - xcommandExample Example 2.4.1 Command help2.4.2 Issuing a command Markup notationExample Command responseSequence notation CombinationNTP Status OK 2.5 XML Output - xgetxmlExample xgetxml status/ntp StatusExample 2.6 Special Commands2.6.1 xfeedback Example User wants to monitor for when a zone failsWhen a problem with a zone occurs xpreferences detaillevel xpreferences xmlconfigfeedback on/off2.6.2 xpreferences xpreferences xpathwrite on/offXACLI-format xpreferences xmlcommandresult on/offxpreferences xmlstatusfeedback on/off Example3.1 configuration.xml - xconfiguration 3 API - ConfigurationsIP 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.1 command.xml - xcommand 4 API - Commandspage 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 Ethernet OptionsLDAP ResourceUsage ExternalManagerFeedback Calls GatekeeperShows the type of the call party alias Registrations Zones Zones TraversalZone 1..50 Bandwidth PerCall String Subzones Pipes LinksCalls 5.2 history.xml - xhistoryRegistrations Registration 1..255 RASAddresses Address 1..10 String Registrationspage 73 of Registrations Registration 1..255 RegistrationRejectionCause StringCallAttempt 5.3 event.xml - xeventConnected Disconnected ConnectionFailure Registration Unregistration RegistrationFailure RegistrationFailure Registration 1..3750 Gateway Prefix 1..200 String Bandwidth Locate page 84 of ResourceUsage