Home

TANDBERG D14172.01 Network Card User Manual

1. When using this notation the sequence in which the parameters are entered is not essential Example 2 13 xcommand dial Bandwidth 384 callDst bob callSrc alice Abbreviations can be used for the parameter names as long as the parameter names are unique within the command Example 2 14 xcommand dial B 384 callD bob callS alice D14172 01 page 30 of 84 TANDBERG Gatekeeper Border Controller API User Guide Sequence notation lt command type root command gt lt command gt lt value gt lt value gt When using this notation the parameter values must be entered in the sequence as stated in the help text Example 2 16 xcommand dial alice bob 384 Combination A combination of mark up notation and sequence are also supported The marked parameters will be assigned the user entered values first and then the system will assign the sequence entered parameters for the parameters not yet having been assigned a value Example 2 17 xcommand dial alice B 384 bob Command response When issuing a command the system will return a set of return values refer to the section TANDBERG XML API The response will be on the same format as the standard XACLI Status format Example 2 18 xcommand dial alice bob r Result status OK ceallsies alias callDst bob Bandwidth 384 CallSerialNumber 1 EncryptionMode Auto EncryptionType Auto r end OK NOTE When using XACLI as a machine machine interface it
2. D14172 01 page 5 of 84 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 lt Configuration gt lt SNMP item 1 gt lt Mode item 1 gt 0n lt Mode gt lt CommunityName item 1 gt public lt Communit yName gt lt SystemContact item 1 gt Administrator lt SystemContact gt lt SystemLocation item 1 gt lt SystemLocation gt lt SNMP gt lt Configuration gt To specify the path to the snmp element we simply start at the root level and separate the levels in the tree structure by a slash Configuration SNMP The path to the Communit yName element is Configuration SNMP CommunityName Example 1 6 To address a specific item of an element the item number is added within brackets after the element name The path to the Address element of Server item 2 in Example 1 4 is Configuration IP DNS Server 2 Address If the item number is omitted for an element all items of this element will be addressed The following expression addresses the Address element of all DNS servers Configuration IP DNS Server Address D14172 01 page 6 of
3. EncryptionType lt DES AES 128 Auto gt The type of encryption that will be used for the call DisconnectCall Disconnects a call Call lt 1 900 gt The index of the call to be disconnected CallSerialNumber lt S 0 255 gt The serial number of the call to be disconnected FeedbackRegister Activates notifications on the event or status change s described by the Expression s Notifications are sent in XML format to the specified URL Up to 15 Expressions may be registered for each of 3 feedback IDs ID lt 1 3 gt The ID of this particular feedback request URL r lt S 1 256 gt The URL to which notifications are to be sent Expression 1 15 lt S 1 256 gt The events or status change to be notified See the Administrator Guide for a full list of valid Expressions FeedbackDeregister Deactivates a particular feedback request ID lt 1 3 gt The ID of the feedback request to be deactivated FindRegistration Returns information about the registration associated with the specified alias The alias must be registered on the system on which the command is issued Alias r lt S 1 60 gt The alias that you wish to find out about LinkAdd Adds and configures a new link LinkName r lt S 1 50 gt Assigns a name to this link Node1 lt S 1 50 gt Specifies the first zone or subzone to which this link will be applied Node2 lt S 1 50 gt Specifies the second zone or subzone to which
4. LDAP Cause lt String gt Shows an error reason for a failure to connect to the LDAP server Only present if the LDAP status is Failed or Inactive and the Reason is not Not configured LDAP Address lt String gt Shows the address of the LDAP server Only present if the LDAP status is Active or Failed LDAP Port lt String gt Shows the port of the LDAP server Only present if the LDAP status is Active or Failed D14172 01 page 62 of 84 TANDBERG Gatekeeper Border Controller API User Guide ExternalManager ExternalManager status lt Inactive Active Failed gt Shows the status of the connection to the external manager ExternalManager Cause lt String gt Shows an error reason for a failure to connect to the external manager Only present if the external manager status is Failed ExternalManager Address lt String gt Shows the address of the external manager Only present if the external manager status is Active ExternalManager Protocol lt String gt Shows the protocol being used to communicate with the external manager Only present if the external manager status is Active ExternalManager URL lt String gt Shows the URL on the external manager being connected to Only present if the external manager status is Active or Failed Feedback Feedback 1 3 status lt On Off gt Shows whether feedback is configured Feedback 1 3 URL lt String gt Shows the URL
5. Services CallTransfer Mode lt On Off gt Controls whether or not third party call transfer is enabled Note The Gatekeeper must be operating in call routed mode in order for calls to be transfered Services AdHocConferencing Mode lt On Off gt Controls whether or not Multiway is enabled Services AchiocComrermemeiine IDs lt Sg 3 3 gt Specifies the unique 3 digit ID for this system This ID is used by the MCU to distinguish between conference requests from different gatekeepers Services AdHocConferencing Prefix lt S 0 30 gt Specifies the prefix to be used for unencrypted conference requests Semele smACHOC COnme mem cin Rin Gta poe SS Om 0 Specifies the prefix to be used for encrypted conference requests D14172 01 page 47 of 84 TANDBERG Gatekeeper Border Controller API User Guide 4 API Commands This section gives an overview of the supported system Commands All examples are presented using the standard XACLI format 4 1 command xml xcommand AdHocConference Transfers all calls for the specified endpoint to the configured ad hoc conference Registration r lt 1 3750 gt The index of the registration to be transferred AllowListAdd Adds an entry to the Allow List Pattern r lt S 1 60 gt Specifies an entry to be added to the Allow List If one of an endpoint s aliases matches one of the patterns in the Allow List the registration will be permitted AllowListDelete Deletes an e
6. Applies only if the system is a Gatekeeper Specifies the interval in seconds with which a failed attempt to establish a connection to the traversal server should be retried Traversal AllowMediaDirect lt On Off gt Applies only if the system is a Gatekeeper Determines whether endpoints must route their media through the Gatekeeper or may if capable send media directly to the Border Controller Traversal UDPProbe RetryInterval lt 1 65534 gt Applies only if the system is a Border Controller Sets the interval with which a failed attempt to establish a UDP channel should be repeated D14172 01 page 41 of 84 TANDBERG Gatekeeper Border Controller API User Guide Traversal UDPProbe RetryCount lt 1 65534 gt Applies only if the system is a Border Controller Specifies the number of attempts at re establishing a failed UDP channel Traversal UDPProbe KeepAlivelnterval lt 1 65534 gt Applies only if the system is a Border Controller Specifies the interval with which a UDP channel should be refreshed Traversal TCPProbe RetryInterval lt 1 65534 gt Applies only if the system is a Border Controller Specifies the interval with which a failed attempt to establish a TCP channel should be repeated Traversal TCPProbe RetryCount lt 1 65534 gt Applies only if the system is a Border Controller Specifies the number of attempts at re establishing a failed TCP channel Traversal TCPProbe KeepAlivelnterval lt 1
7. lt String gt Shows the bandwidth in kbps being used in the Default Zone Zones TraversalZone 1 50 status lt Warning Active Failed gt Shows the status of the connection to the traversal zone Zones TraversalZone 1 50 Cause lt String gt Shows an error reason for a failure to communicate with the traversal zone Only present if the traversal zone status is Failed or Warning Zones TraversalZone 1 50 Name lt String gt Shows the name of the traversal zone Zones TraversalZone 1 50 Traversal lt Assent H46018 gt Shows the traversal type of the traversal zone Zones TraversalZone 1 50 AccountName lt String gt Shows the account name for the traversal zone Zones TraversalZone 1 50 Gatekeeper 1 6 status lt Unknown Active Failed gt Shows the status of the connection to the gatekeeper in the traversal zone Zones TraversalZone 1 50 Gatekeeper 1 6 Cause lt String gt Shows an error reason for a failure to communicate with the gatekeeper Only present if the gatekeeper status is Failed Zones TraversalZone 1 50 Gatekeeper 1 6 Address lt String gt Shows the address for a gatekeeper in the traversal zone Zones TraversalZone 1 50 Gatekeeper 1 6 Port lt String gt Shows the port for a gatekeeper in the traversal zone Zones TraversalZone 1 50 Calls Call 1 900 lt Integer gt Shows the index of a call in the trav
8. 1 3750 OutOfResources lt On Off gt Shows the resource usage of a gateway or an MCU Only present if the registered system is a gateway or an MCU Registrations Registration 1 3750 Traversal lt Assent H46018 gt Shows the traversal type of the registration Only present if the registered system supports firewall traversal Registrations Registration 1 3750 Aliases Alias 1 200 type lt IPAddress E164 H3231d Email Url Prefix Suffix gt Shows the type of the alias Registrations Registration 1 3750 Aliases Alias 1 200 lt String gt Shows the alias value Registrations Registration 1 3750 SubZone lt String gt Shows the subzone to which this registration belongs Registrations Registration 1 3750 SerialNumber lt String gt Shows the unique serial number of the registration Registrations Registration 1 3750 StartTime lt String gt Shows the time at which this registration was created D14172 01 page 66 of 84 TANDBERG Gatekeeper Border Controller API User Guide Zones Zones DefaultZone Calls Call 1 900 lt Integer gt Shows the index of a call in the Default Zone Zones DefaultZone Bandwidth Total lt String gt Shows the total bandwidth in kbps allowed in the Default Zone Zones DefaultZone Bandwidth PerCall lt String gt Shows the bandwidth in kbps allowed per call in the Default Zone Zones DefaultZone Bandwidth Used
9. 65534 gt Applies only if the system is a Border Controller Specifies the interval with which a TCP channel should be refreshed Traversal Media RTP Port lt 1 65534 gt Applies only if the system is a Border Controller Specifies the UDP port to which media should be sent Traversal Media RTCP Port lt 1 65534 gt Applies only if the system is a Border Controller Specifies the UDP port to which media control information should be sent Traversal AssentEnabled lt On Off gt Applies only if the system is a Border Controller Determines whether or not the Border Controller will allow firewall traversal using TANDBERG s proprietary Assent protocol Traversal H46018Enabled lt On Off gt Applies only if the system is a Border Controller Determines whether or not the Border Controller will allow firewall traversal using the ITU H 460 18 19 protocols Traversal Preference lt Assent H46018 gt Applies only if the system is a Border Controller Determines which of the two protocols to use when given a choice Traversal H46019Demultiplexing lt On Off gt Applies only if the system is a Border Controller H 460 19 optionally allows all media to be sent to the same ports on the Border Controller and demultiplexed there Authentication Mode lt On Off gt Determines whether or not to enforce authentication for registrations Authentication UserName lt S 0 25 gt Specifies the user name to be used
10. 900 SerialNumber lt String gt Shows the unique serial number of the call Disconnected Call 1 900 State lt Disconnected gt Shows the state of the call Disconnected Call Shows the type of the call Disconnected Call Shows the bandwidth in kbps for the call 1 900 Bandwidth lt Integer gt Email Url Prefix Suffix gt Shows the type of the call party alias Diseomacscicecl ic ci RO O tec A Ailes lt Sieiiines Shows the alias of the call party Discomnaccecl Call 1 9001 Lee 1 2 Acderesse lt Sicienime gt Shows the IP address and port of the call party 1 900 CallType lt Traversal Direct Routed gt Disconnected Call 1 900 Leg 1 2 Alias type lt IPAddress E164 H3231Id D14172 01 page 76 of 84 TANDBERG Gatekeeper Border Controller API User Guide Disconnected Call 1 900 StartTime Shows the time at which the call was initiated Disconnected Call 1 900 Duration Shows the duration of the call in seconds Disconnected Call 1 900 SourceAlias Shows the alias of the source call party Disconnected Call 1 900 SourceAddress Disconnected Call 1 900 Shows the alias of the destination call party Disconnected Call 1 900 DestinationAlias DestinationAddress lt String gt lt String gt Disconnected Call 1 900 DisconnectCauseValue lt String gt Shows the reason the call
11. Active gt lt Address item 1 gt 10 0 0 2 lt Address gt lt Port item 1 gt 123 lt Port gt lt LastUpdate item 1 gt 2008 01 01 12 00 00 lt LastUpdate gt lt LastCorrection item 1 gt 1 lt LastCorrection gt lt NTP gt lt Status gt XACLI s NTP status Active Address WO O02 Rome 123 haste datee ss 2 0 08 Ok OOO ROO LastCorrection 1 s end NOTE To write a parser for the XACLI format the parser must keep track of the levels by counting white spaces The indent is increased by two whitespaces for each level D14172 01 page 25 of 84 TANDBERG Gatekeeper Border Controller API User Guide 2 3 The Configuration type root commands xconfiguration The information accessible through these commands is exactly the same information that is available in the corresponding XML documents To get an overview of accessible top level configuration elements type or help after the configuration type root command lt configuration type root command gt Example 2 6 R User Comt teica ionns Authentication LDAP SNMP Ethernet Links SSH ExternalManager Log SubZones Gatekeeper NTP SystemUnit ENE Option 1 64 Telnet EAS Pipes TimeZone ie Services Traversal TEBEO toco Session Zones OK 2 3 1 Configuration help To get help on configurations type the configuration type root command followed by an address expression followed by or help The possible values for the element
12. Uniamired Used 0 s end D14172 01 page 34 of 84 TANDBERG Gatekeeper Border Controller API User Guide 2 6 2 xpreferences The special command xpreferences lets the user control application individually configure the Telnet RS 232 session in use xpreferences usage xpreferences xpathwrite lt on off gt SHE 8 xpreferences detaillevel lt 1 2 gt Or xpreferences xmlconfigfeedback lt on off gt Om xpreferences xmlstatusfeedback lt on off gt ORE xpreferences xmlcommandresult lt on off gt OK xpreferences xpathwrite lt on off gt This command disables enables the XPath engine when issuing configurations When the XPath engine is disabled the user control application must supply the complete path to the configurations to be set no double slashes allowed This will improve the performance of the system when issuing many consecutive configurations NOTE It is always recommended to supply the complete path for configurations to be set when issuing commands from an external control application xpreferences detaillevel lt 1 2 gt This command has no effect on the Gatekeeper and Border Controller xpreferences xmlconfigfeedback lt on off gt If xmiconfigfeedback is set to on feedback on configurations will be returned in XML format instead of the standard XACLI configuration format Example 2 25 XACLI format c SNMP SystemContact Administrator XML format lt Configuration gt lt SNMP it
13. array login gt lt username gt password gt lt password gt Soliene Dlal array eallszeo gt Alica callilnsu gt 130o je 2 gt D14172 01 page 16 of 84 TANDBERG Gatekeeper Border Controller API User Guide The SOAP interface has a number of operations for dealing with Status and Configuration Get XML 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 information for a specified XPath expression The returned value is an XML document SetConfiguration Sets configuration The configuration parameter is passed as an XML document SetConfigurationXML Sets configuration The configuration parameter is passed as strongly typed SOAP parameters as defined in the WSDL document Example 1 20 The example below shows how to use GetXML to retrieve information about the system unit from the status document and extract the up time lt php Sclient new SoapClient http 10 0 0 1 webservices wsdl array login gt lt username gt password gt lt password gt Sresult client gt GetXML array Location gt Status SystemUnit Sxml_result SimpleXMLElement result gt GetXMLResult
14. gt 1 lt CallSerialNumber gt lt EncryptionMode item 1 gt Auto lt EncryptionMode gt lt EncryptionType item 1 gt Auto lt EncryptionType gt lt DialResult gt lt Command gt D14172 01 page 36 of 84 TANDBERG Gatekeeper Border Controller API User Guide 3 API Configurations This section gives an overview of the Configuration Information available in the Configuration XML document configuration xml All examples are presented using the standard XACLI format 3 1 configuration xml xconfiguration SystemUnit Name lt S 0 50 gt Defines the name of the system Choose a name that uniquely identifies the system SystemUnit Password lt S 0 16 gt Defines the password of the system The password is used to login with Telnet HTTP S SSH SCP and on the serial port Option la 04 eyes lt Se 0 YN Specifies the option key of the option you wish to add Option keys are added to the system in order to add extra functionality such as increasing the system s capacity Contact your TANDBERG representative for further information Ethernet Speed lt Auto 10half 10full 100half 100ful1 gt Specifies the setting of the Ethernet link Use Auto to automatically configure the speed Note You must restart the system for any changes to take effect IPProtocol lt Both IPv4 IPv6 gt Selects whether the system is operating in IPv4 IPv6 or dual stack mode Note You must restart the system for any changes
15. lt AlwaysMatch PatternMatch Disabled gt Determines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Match5PatternString lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared Match5PatternType lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Match5PatternBehavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Match5PatternReplace lt S 0 60 gt Applies only if the Pattern Behavior is Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern ZoneDelete Deletes a zone Zoneld r lt 1 100 gt The index of the zone to be deleted D1
16. lt Cause item 1 gt No gatekeeper reachable lt Cause gt lt Name item 1 gt MyNeighbor lt Name gt lt Gatekeeper item 1 status Failed gt lt Cause item 1 gt DNS Resolution Failed lt Cause gt lt Address gt baddns example com lt Address gt lt Port item 1 gt 1719 lt Port gt lt Gatekeeper gt lt Calls item 1 gt lt Bandwidth item 1 gt lt Total item 1 gt Unlimited lt Total gt lt PerCall item 1 gt Unlimited lt PerCall gt lt Used item 1 gt 0 lt Used gt lt Bandwidth gt lt Zone gt lt Zones gt lt Status gt lt Status gt lt Zones item 1 gt lt Zone item 1 status Active gt lt Name item 1 gt MyNeighbor lt Name gt lt Gatekeeper item 1 status Active gt lt Address gt 10 0 0 10 lt Address gt lt Port item 1 gt 1719 lt Port gt lt Gatekeeper gt lt Calls item 1 gt lt Bandwidth item 1 gt lt Total item 1 gt Unlimited lt Total gt lt PerCall item 1 gt Unlimited lt PerCall gt lt Used item 1 gt 0 lt Used gt lt Bandwidth gt lt Zone gt lt Zones gt lt Status gt In the above example we see that the Cause element is only present if the zone status is Failed 1 4 3 Configuration documents rw The structure of the Configuration documents is independent of system state e the structure will be constant in time In addition to holding the values for the various configurations each configuration value element includes an
17. lt String gt Shows the time at which this registration ended Registrations Registration 1 255 Reason lt String gt Shows the reason for the registration ending D14172 01 page 72 of 84 TANDBERG Gatekeeper Border Controller API User Guide Registrations Registration 1 255 RegistrationRejectionCause lt String gt Shows the cause for the registration being rejected Only present if the reason is RegistrationRejected Registrations Registration 1 255 RegistrationRejectionDescription lt String gt Shows a description of the cause for the registration being rejected Only present if the reason is RegistrationRejected D14172 01 page 73 of 84 5 3 TANDBERG Gatekeeper Border Controller API User Guide event xml xevent Call Attempt CallAttempt Call 1 900 SerialNumber lt String gt Shows the unique serial number of the call CallAttempt Call 1 900 State lt Initializing gt Shows the state of the call CallAttempt Call 1 900 CallType lt Traversal Direct Routed gt Shows the type of the call CallAttempt Call 1 900 Transferable lt On Off gt Shows whether this call is capable of being transferred CallAttempt Call 1 900 Bandwidth lt Integer gt Shows the bandwidth in kbps for the call CallAttempt Call 1 900 Route Zone lt String gt S
18. 28 gt Sets the IP Address or FQDN of the LDAP server to be used when making LDAP queries LDAP Server Port lt 1 65534 gt Sets the IP port of the LDAP server to be used when making LDAP queries LDAP UserDN lt S 0 255 gt Sets the user distinguished name to be used when binding to the LDAP server LDAP Password lt S 0 25 gt Sets the password to be used when binding to the LDAP server DAP Encryption lt Off TLS gt Sets the encryption to be used for the connection to the LDAP server Off no encryption is used TLS TLS encryption is used SNMP Mode lt On Off gt Enables or disables SNMP support Note You must restart the system for any changes to take effect SNMP CommunityName lt S 0 16 gt Specifies the system s SNMP community name SNMP SystemContact lt S 0 70 gt Specifies the name of the person who can be contacted regarding issues with the system SNMP SystemLocation lt S 0 70 gt Specifies the physical location of the system Session TimeOut lt 0 65534 gt Sets the number of minutes that an administration session HTTPS Telnet or SSH may be inactive before the session is timed out A value of 0 turns session time outs off Telnet Mode lt On Off gt Determines whether the system can be accessed via telnet Note You must restart the system for any changes to take effect D14172 01 page 38 of 84 TANDBERG Gatekeeper Border Controller API User Guide
19. 84 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 Example 1 8 XPath also supports addressing by putting constraints on element attributes The below expression will address the Name element of all Failed zones in a system Status Zones Zone status Failed Name D14172 01 page 7 of 84 TANDBERG Gatekeeper Border Controller API User Guide 13 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 application and a target system The control application transmits instructions to the target system while the target system supplies information about how these instructions are executed in addition to other system related information Th
20. Address 2 1 4 Exposure options By adding an exposure option after the address XPath or SimplePath expression the system can be instructed to return only parts of the information within an element structure lt root command gt lt address expression gt lt exposure option gt Supported exposure options e hides all value elements hides all sub elements Example 2 2 Request for Zone 7 element with no exposure option xstatus zones zone 1 s Zones Zone 1 status Active Name MyNeighbor Gatekeeper status Active Address 10 00 19 Bozeg 1718 CAES Bandwidth Toa ted Perea ME EET UES Used 0 s end Request for Zone1 element with exposure option xstatus zones zone 1 s Zones Zone 1 status Active Gatekeeper status Active Calles Bandwidth s end D14172 01 page 22 of 84 Request for Zone1 element with exposure option xstatus zones zone 1 s Zones Zone 1 status Active s end 2 1 5 Misc The XACLI interface is not case sensitive XACLI allows using only partial names TANDBERG Gatekeeper Border Controller API User Guide D14172 01 page 23 of 84 TANDBERG Gatekeeper Border Controller API User Guide 2 2 The Status type root commands xstatus xhistory The information accessible through these commands is the exact same information that is available in the corresponding XML documents To get an overview of accessible top level elements w
21. Deletes an entry from the local authentication database Credentialld r lt 1 2500 gt The index of the credential to be deleted DefaultLinksAdd Restores links between the Default Subzone Traveral Subzone and the Default Zone DefaultValuesSet Resets system parameters to default values Level 1 will reset most parameters There are currently no level 2 parameters so setting that level has the same effect as setting level 1 Level 3 resets all level 1 and 2 parameters as well as additional parameters See the Administrator Guide for full details Level r lt 1 3 gt The level of system parameters to be reset DenyListAdd Adds an entry to the Deny List Pattern r lt S 1 60 gt Specifies an entry to be added to the Deny List If one of an endpoint s aliases matches one of the patterns in the Deny List the registration will not be permitted DenyListDelete Deletes an entry from the Deny List DenyListld r lt 1 2500 gt The index of the entry to be deleted Dial Places a call between two endpoints callSrc r lt S 1 60 gt The alias of the first endpoint to be placed in the call callDst r lt S 1 60 gt The alias of the second endpoint to be placed in the call Bandwidth lt 1 100000000 gt The requested bandwidth of the call in kbps EncryptionMode lt Auto On Off gt Specifies whether the call will be encrypted D14172 01 page 49 of 84 TANDBERG Gatekeeper Border Controller API User Guide
22. H 323 URIs is enabled on this system Gatekeeper ENUM Mode lt On Off gt Specifies whether the system will attempt ENUM resolution for E 164 numbers Gatekeeper ENUM DNSSuffix 1 5 lt S 0 128 gt Specifies a DNS domain to use when attempting ENUM resolution Gatekeeper LocalDomain DomainName lt S 0 128 gt Specifies the DNS name of the domain that the system is responsible for Used when searching for matching endpoint registrations Gatekeeper Registration RestrictionPolicy lt None AllowList DenyList gt Specifies the policy to be used when determining which endpoints may register with the system Gatekeeper Registration AllowList 1 2500 Pattern lt S 0 60 gt Specifies an entry to be added to the Allow List If one of an endpoint s aliases matches one of the patterns in the Allow List the registration will be permitted Gatekeeper Registration DenyList 1 2500 Pattern lt S 0 60 gt Specifies an entry to be added to the Deny List If one of an endpoint s aliases matches one of the patterns in the Deny List the registration will not be permitted Gatekeeper Registration ConflictMode lt Overwrite Reject gt Determines how the system will behave if an endpoint attempts to register an alias currently registered from another IP Address Reject denies the registration Overwrite deletes the original registration and replaces it with the new registration Gatekeeper Alternates Moni
23. an MCU Unregistration Registration 1 3750 Aliases Alias 1 200 type lt IPAddress E164 H3231d Email Url Prefix Suffix gt Shows the type of the alias Unregistration Registration 1 3750 Aliases Alias 1 200 lt String gt Shows the alias value Unregistration Registration 1 3750 SubZone lt String gt Shows the subzone to which this registration belonged Unregistration Registration 1 3750 SerialNumber lt String gt Shows the unique serial number of the registration nregistration Registration 1 3750 StartTime lt String gt Shows the time at which this registration was created nregisera MoniRSg sirios OEE S E C Shows the time at which this registration ended Unregistration Registration 1 3750 Reason lt String gt Shows the reason for the registration ending RegistrationFailure RegistrationFailure Registration 1 3750 CallSignalAddresses Address oe 10 8 lt Surimegs gt Shows the IP address and port used for call signaling RegistrationFailure Registration 1 3750 RASAddresses Address 1 10 lt String gt Shows the IP address and port used for RAS signaling RegistrationFailure Registration 1 3750 Endpoint Shows that the registration was endpoint Only present if the registration was an endpoint RegistrationFailure Registration 1 3750 Gatekeeper Shows that the registration
24. be used as a substitution for the part of the alias that matched the pattern Match3Mode lt AlwaysMatch PatternMatch Disabled gt Determines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Match3PatternString lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared Match3PatternType lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Match3PatternBehavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Match3PatternReplace lt S 0 60 gt Applies only if the Pattern Behavior is Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern Match4M
25. by the system when authenticating with another system Authentication Password lt S 0 25 gt Specifies the password to be used by the system when authenticating with another system D14172 01 page 42 of 84 TANDBERG Gatekeeper Border Controller API User Guide Authentication Database lt LocalDatabase LDAPDatabase gt Selects between a local database and a remote LDAP repository for the storage of password information for authentication Authentication LDAP BaseDN lt S 0 255 gt Specifies the Distinguished Name to use when connecting to an LDAP server Authentication LDAP AliasOrigin lt LDAP Endpoint Combined gt Determines which aliases i e from the LDAP database or the endpoint should be used to register the endpoint Combined the endpoint will be registered both with the aliases which it has presented and with those configured in the LDAP repository Authentication Credential 1 2500 Name lt S 0 25 gt Defines the name for this entry in the local authentication database Authentication Credential 1 2500 Password lt S 0 25 gt Defines the password for this entry in the local authentication database Zones DefaultZone HopCount lt 1 255 gt Specifies the hop count to be used when sending an alias search request to a system that is not configured as a neighbor zone or traversal zone Zones Zone 1 100 Name lt S 1 50 gt Assigns a name to this zone Zones Zone 1
26. call party is locally registered Connected Call 1 900 Leg 1 2 Alias type lt IPAddress E164 H323I1d Email Url Prefix Suffix gt Shows the type of the call party alias Conecte are oi OS A ASS SPAN gt Shows the alias of the call party D14172 01 page 75 of 84 TANDBERG Gatekeeper Border Controller API User Guide Connected Call 1 900 Leg 2 Address lt String gt Shows the IP address and port of the call party Connected Call 1 900 Leg 2 Encryption status lt On Off gt Shows the status of encryption on the call leg Connected Call 1 900 Leg 2 Encryption CheckCode lt String gt Shows the check code for the encrypted call leg Only present if encryption status is On Connected Call 1 900 StartTime lt String gt Shows the time at which the call was initiated ConnecEeds Call 1 900 Ditecicateome lt Sitriliae gt Shows the duration of the call in seconds Connected Call 1 900 SourceAlias lt String gt Shows the alias of the source call party Connected Call 1 900 SourceAddress lt String gt Shows the IP address and port of the source call party Connected Call 1 900 DestinationAlias lt String gt Shows the alias of the destination call party Connected Call 1 900 DestinationAddress lt String gt Shows the IP address and port of the destination call party Disconnected Disconnected Call 1
27. gt any echo xml_result gt SystemUnit gt Uptime RE Example 1 21 The example below shows how to use GetConfigurationXML to retrieve information about the SNMP configuration and extract the system contact lt php Sclient new SoapClient http 10 0 0 1 webservices wsdl array login gt lt username gt password gt lt password gt Sresult client gt GetConfigurationXML array Location gt SNMP xml_result new SimpleXMLElement Sresult gt GetConfigurationXMLResult gt any echo xml_result gt SNMP gt SystemContact RE D14172 01 page 17 of 84 TANDBERG Gatekeeper Border Controller API User Guide Example 1 22 The example below performs the same task as Example 1 21 but uses GetConfiguration lt php Sclient new SoapClient http 10 0 0 1 webservices wsdl array login gt lt username gt password gt lt password gt result client gt GetConfiguration array Location gt SNMP echo result gt GetConfigurationResult gt Configuration gt SNMP gt SystemContact 2 gt Example 1 23 The example below shows how to use SetConfigurationXML to modify the SNMP system contact configuration lt php Sclient new SoapClient http 10 0 0 1 webservices wsdl array login gt lt username gt password gt lt password gt Sconfig_xml lt Configuration xmlns http www tandberg no XML CUIL 1 0 gt lt
28. incoming calls from endpoints that are not registered to any other system Gatekeeper Unregistered Caller Fallback lt S 0 60 gt Specifies the alias to which incoming calls are placed for calls where the IP Address or domain name of the system has been given but no callee alias has been specified Gatekeeper Transform 1 200 Pattern lt S 0 60 gt Specifies the pattern against which the alias is compared Gatekeeper Transform 1 200 Priority lt 0 65534 gt Assigns a priority to the specified transform Transforms are applied in order of priority and the priority must be unique for each transform Gatekeeper Transform 1 200 Type lt Prefix Suffix Regex gt Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Gatekeeper Transform 1 200 Behavior lt Strip Replace gt Determines how the matched part of the alias will be modified Strip the matching prefix or suffix will removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Gatekeeper Transform 1 200 Replace lt S 0 60 gt Applies only if pattern behavior is set to Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern Traversal RetryInterval lt 1 65534 gt
29. is recommended to use markup notation and always supply complete tag names D14172 01 page 31 of 84 TANDBERG Gatekeeper Border Controller API User Guide 2 5 XML Output xgetxml As an alternative to the standard XACLI output format XML format is supported through the root command xgetxml xgetxmltakes an XPath expression as parameter and the elements or complete document matching the expression will be returned Example 2 19 xgetxml status ntp lt Status gt lt NTP item 1 status Active gt lt Address item 1 gt 10 0 0 2 lt Address gt lt Port item 1 gt 123 lt Port gt lt LastUpdate item 1 gt 2008 01 01 12 00 00 lt LastUpdate gt lt LastCorrection item 1 gt 1 lt LastCorrection gt lt NTP gt lt Status gt OK D14172 01 page 32 of 84 TANDBERG Gatekeeper Border Controller API User Guide 2 6 Special Commands In addition to the root commands described above XACLI support a set of root commands that only applies to the Telnet session or RS232 session from where they are issued This lets the user control application individually configure the session s in use Supported special commands xfeedback not supported on all platforms xpreferences 2 6 1 xfeedback The special command xfeedback lets the user register user defined XPath expressions with possible exposure options to monitor changes in the XML XACLI data Whenever there is a change in one or more elements addressed by a re
30. of POSTing form data getxml Request URI getxml Request parameter location XPath expression The getxml request returns an XML document based on the location parameter passed to the request The elements or complete document matching the expression will be returned If an invalid XPath expression is supplied a lt Fault gt element with a lt xPathError gt element will be returned Example 1 15 Using the Unix curl command the up time of a system can be retrieved from the Status document curl k u admin lt password gt https 10 0 0 1 getxml location Status SystemUnit Uptime lt xml version 1 0 gt lt Status gt lt SystemUnit item 1 gt lt Uptime item 1 gt 604800 lt Uptime gt lt SystemUnit gt lt Status gt formputxml Request URI formputxm Request parameter xmldoc an XML document of Configuration or a Command This is most useful in a POST to extend character limit of 255 of GET urls It posts a Configuration or Command document to set some configuration values or issue a command D14172 01 page 14 of 84 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 lt then the document gt Example 1 16 Using the Unix curl command the systems SNMP c
31. of a system which has registered for feedback Only present if the Feedback status is On weecloaclk 3 Exoressatom ills lt Sicielings gt Shows the URL of a system which has registered for feedback Only present if the Feedback status is On ResourceUsage ResourceUsage Registrations lt Integer gt Shows the current number of registrations on the system ResourceUsage MaxRegistrations lt Integer gt Shows the maximum number of concurrent registrations on the system ResourceUsage NonTraversalCalls lt Integer gt Shows the current number of non traversal calls on the system Only present if the system is a Gatekeeper ResourceUsage MaxNonTraversalCalls lt Integer gt Shows the maximum number of concurrent non traversal calls on the system Only present if the system is a Gatekeeper D14172 01 page 63 of 84 TANDBERG Gatekeeper Border Controller API User Guide ResourceUsage TotalNonTraversalCalls lt Integer gt Shows the total number of non traversal calls that have been placed on the system Only present if the system is a Gatekeeper ResourceUsage TraversalCalls lt integer gt Shows the current number of traversal calls on the system ResourceUsage MaxTraversalCalls lt Integer gt Shows the maximum number of concurrent traversal calls on the system ResourceUsage TotalTraversalCalls lt Integer gt Shows the total number of traversal calls placed on the
32. of calls being used by its endpoints at any one time SubZones SubZone 1 100 Bandwidth Total Limit lt 1 100000000 gt Sets the total bandwidth limit in kbps of this subzone applies only if Mode is set to Limited SubZones SubZone 1 100 Bandwidth PerCall Inter Mode lt None Limited Unlimited gt Determines whether there is a limit on the bandwidth for any one call to or from an endpoint in this subzone SubZones SubZone 1 100 Bandwidth PerCall Inter Limit lt 1 100000000 gt Specifies the bandwidth limit in kbps on any one call to or from an endpoint in this subzone applies only if Mode is set to Limited SubZones SubZone 1 100 Bandwidth PerCall Intra Mode lt None Limited Unlimited gt Determines whether there is a limit on the bandwidth for any one call between two endpoints within this subzone SubZones SubZone 1 100 Bandwidth PerCall Intra Limit lt 1 100000000 gt Specifies the bandwidth limit in kops for any one call between two endpoints within this subzone applies only if Mode is set to Limited SubZones SubZone 1 100 Subnet 1 5 IP Address lt S 0 128 gt Specifies an IP Address used in conjunction with the IP Prefix Length to identify a subnet to be assigned to this subzone SubZones SubZone 1 100 Subnet 1 5 IP PrefixLength lt 0 128 gt Specifies the number of bits of the Subnet IP Address which must match for an IP Address to belong in this subzone Pipes Pipe 1 1
33. the alias of the source call party Bandwidth Call 1 900 SourceAddress lt String gt Shows the IP address and port of the source call party Bandwidth Call 1 900 DestinationAlias lt String gt Shows the alias of the destination call party Bandwidth Call 1 900 DestinationAddress lt String gt Shows the IP address and port of the destination call party Locate LocateResult Result lt Success Failed gt Shows the result of the search LocateResult Alias type lt IPAddress E164 H323Id Emai1 Ur1 gt Shows the type of the alias being searched for LocateResult Alias lt String gt Shows the value of the alias being searched for LocateResult CallSerialNumber lt String gt Shows the unique serial number of the call LocateResult Location Type lt Local Database Neighbor Traversal gt Shows the type of location being searched LocateResult Location Alias type lt IPAddress E164 H323Id Email Url gt Shows the type of the alias this location is being searched with LocateResult Location Alias lt String gt 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 lt String gt Shows the IP address and port of the location being searched Only present if the Location Type is Neighbor or Traversal LocateResult Locati
34. to take effect IP Address lt IPAddr gt Specifies the IPv4 address of the system Note You must restart the system for any changes to take effect IP SubnetMask lt IPAddr gt Specifies the IPv4 subnet mask of the system Note You must restart the system for any changes to take effect IP Gateway lt IPAddr gt Specifies the IPv4 gateway of the system Note You must restart the system for any changes to take effect ee ViGm AC mess SS OS oe Specifies the IPv6 address of the system Note You must restart the system for any changes to take effect IP V6 Gateway lt S 0 39 gt Specifies the IPv6 gateway of the system Note You must restart the system for any changes to take effect D14172 01 page 37 of 84 TANDBERG Gatekeeper Border Controller API User Guide 2 IDINS o ervoer AS cn SS SES SS gt Sets the IP Address of up to 5 DNS servers to be queried when resolving domain names IP DNS Domain Name lt S 0 128 gt Specifies the name to be appended to the host name before a query to the DNS server is executed Used only when attempting to resolve a domain name which is not fully qualified NGEwAddisesisi lt S Ole Sets the IP Address or FQDN of the NTP server to be used when synchronizing system time TimeZone Name lt S 0 64 gt Sets the local time zone of the system Time zone names follow the POSIX naming convention e g Europe London or America New_York EDAPLE Server Address lt S 0
35. was disconnected Disconnected Call 1 900 DisconnectCause lt String gt Shows a description of the reason the call was disconnected SSA lt String gt Shows the IP address and port of the source call party SSA gt lt String gt Shows the IP address and port of the destination call party ConnectionFailure ConnectionFailure Call 1 900 SerialNumber lt String gt Shows the unique serial number of the call ConnectionFailure Call 900 State lt ConnectionFailed gt Shows the state of the call ConnectionFailure Call 900 CallType lt Traversal Direct Routed gt Shows the type of the call ConnectionFailure Call 1 900 Bandwidth lt Integer gt Shows the bandwidth in kbps for the call ConnectionFailure Call 1 900 Leg 1 2 Alias type lt IPAddress E164 4323Id Email Url Prefix Suffix gt Shows the type of the call party alias ConnectionFailure Call 1 900 Leg 1 2 Alias lt String gt Shows the alias of the call party ConnectionFailure Call 1 900 Leg 1 2 Address lt String gt Shows the IP address and port of the call party determined Only present if the address could be D14172 01 page 77 of 84 TANDBERG Gatekeeper Border Controller API User Guide ConnectionFailure Call 1 900 StartTime lt String gt Shows the time at which the call was initiated ConnectionFailure Call 1 900 Duration lt String gt Shows the duration of th
36. 00 Name lt S 1 50 gt Assigns a name to this pipe Pipes Pipe 1 100 Bandwidth Total Mode lt None Limited Unlimited gt Determines whether or not this pipe is enforcing total bandwidth restrictions None no bandwidth available D14172 01 page 46 of 84 TANDBERG Gatekeeper Border Controller API User Guide Pipes Pipe 1 100 Bandwidth Total Limit lt 1 100000000 gt If this pipe has limited bandwidth sets the maximum bandwidth in kbps available at any one time on the pipe Pipes Pipe 1 100 Bandwidth PerCall Mode lt None Limited Unlimited gt Determines whether or not this pipe is limiting the bandwidth of individual calls None no bandwidth available Pipes Pipe 1 100 Bandwidth PerCall Limit lt 1 100000000 gt If this pipe has limited per call bandwidth sets the maximum amount of bandwidth in kbps available for any one call mies Tanak Ll 100 Memes lt Se i SWS Assigns a name to this link sinks Link 1 100 Nodel Name lt S 0 50 gt Specifies the first zone or subzone to which this link will be applied sinks Link 1 100 Node2 Name lt S 0 50 gt Specifies the second zone or subzone to which this link will be applied Amko iink Lo 0101 epe Memes lt ss O SWS Specifies the first pipe to be associated with this link NS fil i0 0 Pajxe2 Nemes lt S2e DAS OS Specifies the second pipe to be associated with this link
37. 100 Gatekeeper 1 6 Address lt S 0 128 gt Specifies the IP Address or FQDN of this neighbor Zones Zone 1 100 Gatekeeper 1 6 Port lt 1 65534 gt Specifies the port on the neighbor to be used MOOS HONS lo LOO op Counte lt il 255 gt Specifies the hop count to be used when sending an alias search request to this zone Note If the search request was received from another zone and already has a hop count assigned the lower of the two values will be used Zones Zone Lla 200 Monitor lt On OfE gt If Zone monitoring is enabled an LRQ will be periodically sent to the zone gatekeeper If it fails to respond that gatekeeper will be marked as inactive Zones Zone 1 100 Match 1 5 Mode lt AlwaysMatch PatternMatch Disabled gt Determines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Lomas Zoe il ON l 5 Patreco Serias lt S 0 GOS Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared D14172 01 page 43 of 84 TANDBERG Gatekeeper Border Controller API User Guide Zones Zone 1 100 Match 1 5 Pattern Type lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefi
38. 4172 01 page 59 of 84 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 1 status xml xstatus SystemUnit SystemUnit Product lt String gt Shows the product name SystemUnit Uptime lt Integer gt Shows the uptime in seconds SystemUnit SystemTime lt String gt Shows the system time SystemUnit TimeZone lt String gt Shows the time zone SystemUnit TimeZone lt String gt Shows the time zone SystemUnit LocalTime lt String gt Shows the local time SystemUnit Software Version lt String gt Shows the software version SystemUnit Software Build lt String gt Shows the software build SystemUnit Software Name lt String gt Shows the software name SystemUnit Software ReleaseDate lt String gt Shows the software release date SystemUnit Software ReleaseKey lt String gt Shows the software release key SystemUnit Software Configuration NonTraversalCalls Shows the systems non traversal call capacity lt Integer gt D14172 01 page 60 of 84 TANDBERG Gatekeeper Border Controller API User Guide SystemUnit Software Configuration T
39. C ADN SS Sa e AG Clise SSA a IE DNS Sermweie y Aolrecsss WW c IP DNS Domain Name example com OK 2 3 3 Configuration set write To set configurations the address expression following the configuration type root command must end with a colon The value to be set must be added after the colon lt configuration type root command gt lt address expr gt value D14172 01 page 27 of 84 TANDBERG Gatekeeper Border Controller API User Guide Example 2 9 User wants to set IP address ipraddress e On On Ora or ip address OOO D14172 01 page 28 of 84 TANDBERG Gatekeeper Border Controller API User Guide 2 4 The Command type root commands xcommand To get an overview of the supported commands within a command type root command type or help after the command type root command lt command type root command gt Example 2 10 xcommand User Commands AdHocConference DenyListDelete PipeAdd AllowListAdd Dial PipeDelete AllowListDelete DisconnectCall RemoveRegistration Boot FeedbackDeregister SubZoneAdd CallTransfer FeedbackRegister SubZoneDelete CheckBandwidth FindRegistration TransformAdd CredentialAdd LinkAdd TransformDelete CredentialDelete LinkDelete TraversalZoneAdd DefaultLinksAdd Locate TraversalZoneDelete DefaultValuesSet Opt ionKeyAdd ZoneAdd DenyListAdd OptionKeyDelete ZoneDelete OK To list usage for all commands with parameters type a double question mark after the com
40. Gatekeeper Specifies the port on the traversal server to connect to Zones TraversalZone 1 50 HopCount lt 1 255 gt Specifies the hop count to be used when sending an alias search request to this zone Note If the search request was received from another zone and already has a hop count assigned the lower of the two values will be used Zones TraversalZone 1 50 Match 1 5 Mode lt AlwaysMatch PatternMatch Disabled gt Determines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Zones TraversalZone 1 50 Match 1 5 Pattern String lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared D14172 01 page 44 of 84 TANDBERG Gatekeeper Border Controller API User Guide Zones TraversalZone 1 50 Match 1 5 Pattern Type lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Zones TraversalZone 1 50 Match 1 5 Pattern Behavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match D
41. I User Guide TL 9001 meg le 2 RegistrationID lt String gt Shows the registration ID of the call party if it is locally registered Calls Call 1 900 Leg 1 2 SerialNumber lt String gt Shows the serial number of the call party registration Only present if the call party is locally registered Calls Call 1 900 Leg 1 2 Alias type lt IPAddress E164 H323Id Email Url Prefix Suffix gt Shows the type of the call party alias Calls Call 1 900 Leg cA Milstasss SSEL Shows the alias of the call party Calle Calil l 9900 isc 2 Address lt String gt Shows the IP address and port of the call party Calls Call 1 900 Leg 2 Encryption status lt On Off gt Shows the status of encryption on the call leg Calls Calli 1 900 Leg 2 Encryption CheckCode lt String gt Shows the check code for the encrypted call leg Only present if encryption status is On Calls Calil 1 900 Scarciimes lt Sterzilag gt Shows the time at which the call was initiated Calles Calli PAS OO O e to SS Pine Shows the duration of the call in seconds Calile Cala ee 9001 SoauzesMiitass lt Stisilae gt Shows the alias of the source call party Calls Call 1 900 SourceAddress lt String gt Shows the IP address and port of the source call party Calle Calil ARAS OO Destination ata SeSS tieiina gt Shows the alias of the destination call party Calls Call 1 900 Desti
42. SNMP gt lt SystemContact gt Alice lt SystemContact gt lt SNMP gt lt Configuration gt Sparams array Document gt array any gt config_xml Sclient gt SetConfigurationXML params 22 gt Example 1 24 The example below shows performs the same task as Example 1 23 but uses SetConfiguration lt php Sclient new SoapClient http 10 0 0 1 webservices wsdl array login gt lt username gt password gt lt password gt Sparams gt Document gt Configuration gt SNMP gt SystemContact Alice Sclient gt SetConfiguration params gt gt D14172 01 page 18 of 84 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 the following address in the browsers address field car 10 00 1 starus sami mios 10 00 1 Mulsicoray o al ass 10 00 1 Comrncmicatc lola o http 10 0 0 1 command xml http 10 0 0 1 valuespace xml Exercise 2 This exercise shows how to use getxm to read the supported XML documents from the system Enter the following expressions in
43. SSH Mode lt On Off gt Determines whether the system can be accessed via SSH and SCP Note You must restart the system for any changes to take effect HTTP Mode lt On Off gt Determines whether the system can be accessed via the web server over HTTP Note You must restart the system for any changes to take effect HTTPS Mode lt On Off gt Determines whether the system can be accessed via the web server over HTTPS Note You must restart the system for any changes to take effect ExternalManager Address lt S 0 128 gt Sets the IP Address or FQDN of the External Manager ExternalManager Path lt S 0 255 gt Sets the URL of the External Manager Log Level lt 1 3 gt Controls the granularity of event logging 1 is the least verbose 3 the most Log Server Address lt S 0 128 gt Specifies the IP Address or FQDN of the server to which the log will be written Gatekeeper CallRouted lt On Off gt Specifies whether the signaling of a non traversal call will be routed via the system On Call signaling is routed via the system Off Call signaling goes directly between endpoints Note Applies only to non traversal calls the signaling of traversal calls will always be routed via the system regardless of this setting Gatekeeper LocalPrefix lt S 0 60 gt Sets the local zone prefix of the system Gatekeeper TimeToLive lt 60 65534 gt Specifies the interval in seconds at which an endpoin
44. TANDBERG Gatekeeper Border Controller API User Guide D14172 01 July 2008 1 1 1 2 1 3 1 4 15 1 6 2 1 2 2 2 3 2 4 2 5 2 6 TANDBERG Gatekeeper Border Controller API User Guide Table of Contents The TANDBERG API iisas Eae eraann aeaaaee a aar AE suas adeuede Eaa aaaea Esaa aaa Eanna EEan 3 Introduction to XML cccccccccceeeeeceeeeeeeeeeeeecaeeceeeeeaaeeeeecaeeeceeeseaeeeeeeaaeeeeeeeeaeeeseeeeeeeeeeenseteeeenees 4 Introduction to XML Path Language XPath oooooconcccnococccoonononnnononcnnnnnnc nano cnn non nnnnn nora nnrnnnncnnnn non 6 The TANDBERG XML Engine i ren neonan aae e naa Ea EEEa Ei 8 The XML DOCUMONS ii ba e 9 Introduction to TANDBERG XML API Service TXAS ccceeeecceceeeeeeeeeeeeeeeeseeeeeeseesennees 14 gt O 19 The XML based Advanced Command Line Interface scssscssssssseesesseeesseeeeseeeeseeesenes 21 O e ce Meee sualania tars eat valu said tiers shure a a a E e aa E 21 The Status type root commands xstatus XNIStOIY ccccceceeeeeeeceeeeeeeeeeeeeeeeeeeeeeeneeeeeeenees 24 The Configuration type root commands XCONFIQUratiON ee eects eeeeeeeeeeeeeeeeeeeeeeeeeteneeeaes 26 The Command type root commands XCOMMANA 0 eee eee eee eeeeeeeeeeeeteeeeeeeneeeeaeeseeeeeeeneeeaes 29 XAML Output De ici s2tustenelenedsd cet comeegossarteesaesdesenedse AIRE oi 32 Special COMMANAS terco aa e duetacedsves wedeceoealun dee a eaea 33 API COnfiQuratiOn oi
45. and gt lt Command gt lt Boot gt lt Command gt D14172 01 page 20 of 84 TANDBERG Gatekeeper Border Controller API User Guide 2 The XML based Advanced Command Line Interface The XML based Advanced Command Line Interface XACLI is a very flexible interface optimized for both machine machine interaction and man machine interaction lt is based on the powerful TANDBERG XML engine and offers many of the same features as the TANDBERG XML interface The main distinction between XACLI and the TANDBERG XML interface is the input format As XACLI is a command line interface all inputs from the user control application have to be put on one line as opposed to the XML interface where a complete XML document can be posted to the system in one operation A basic understanding of the information structuring in the TANDBERG XML engine is important in order to get the most out of the XACLI interface We therefore recommend you read the TANDBERG XML API section of this document prior to reading this section 2 1 XACLI 2 1 1 Accessing XACLI XACLI can be accessed through Telnet via the LAN interface or through RS 232 by connecting a serial cable to the serial interface connector referred to as the Dataport UP to 48 Telnet sessions can be active at the same time in addition to the RS 232 connection 2 1 2 Root commands For each of the XML documents supported by the system there is a corresponding XACLI root command The root comm
46. and has the same name as the corresponding XML document except that the root command is prefixed by an x XML document XACLI root command status xml xstatus history xml xhistory configuration xml xconfiguration command xml xcommand The information in the TANDBERG XML engine is divided into three main types Status Information Configuration Information and Command Information ref the documentation of the TANDBERG XML API As there is a fundamental difference in these three main types of information there is also three different ways of working with the information using XACLI 2 1 3 Addressing XACLI supports XPath for addressing Status Information and Configuration Information In addition there is support for the proprietary TANDBERG SimplePath notation With SimplePath notation an element or a group of elements are addressed by supplying a space separated list of element names elemName and optional element instance numbers item lt elemName gt item lt elemName gt item D14172 01 page 21 of 84 TANDBERG Gatekeeper Border Controller API User Guide If the instance number of a given element is omitted the expression addresses all instances of this element Example 2 1 To address the Address sub element of DNS Server 2 XPath IP DNS Server 2 Address SimplePath TP DNS Server 2 Address To address the Address sub element of all DNS Server elements XPath IP DNS Server Address SimplePath IP DNS Server
47. ation is a gateway Only present if the registration is a gateway Registration Registration 1 3750 Gateway Prefix 1 200 lt String gt Shows the prefix of a registered gateway service Only present if the registration is a gateway Registration Registration 1 3750 MCU Shows that the registration is an MCU Only present if the registration is an MCU D14172 01 page 78 of 84 TANDBERG Gatekeeper Border Controller API User Guide Registration Recaecwacaom iL 3750 MCU Riasizis lt AO A Sito Shows the prefix of a registered MCU service Only present if the registration is an MCU Registration Registration 1 3750 OutOfResources lt On Off gt Shows the resource usage of a gateway or an MCU Only present if the registered system is a gateway or an MCU Registration Registration 1 3750 Traversal lt Assent H46018 gt Shows the traversal type of the registration Only present if the registered system supports firewall traversal Registration Registration 1 3750 Aliases Alias 1 200 type lt IPAddress E164 H3231d Email Url Prefix Suffix gt Shows the type of the alias Registration Registration 1 3750 Aliases Alias 1 200 lt String gt Shows the alias value Registration Registration 1 3750 SubZone lt String gt Shows the subzone to which this registration belongs Registration Registration 1 3750 SerialNumber lt String gt Shows the unique serial n
48. attribute valueSpaceRef referencing the value domain for the configuration D14172 01 page 10 of 84 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 Ethernet Speed element in the ValueSpace document showing the value domain for this configuration lt Configuration gt lt Ethernet item 1 gt lt Speed item 1 valueSpaceRef ValueSpace EthernetSpeed item 1 gt Auto lt Speed gt lt Ethernet gt lt Configuration gt lt ValueSpace gt lt EthernetSpeed item 1 type Literal gt lt Value gt Auto lt Value gt lt Value gt 10half lt Value gt lt Value gt 10full lt Value gt lt Value gt 100half lt Value gt lt Value gt 100full lt Value gt lt Ethernet Speed gt lt ValueSpace gt To change configurations the part s of the document containing the configurations to be updated should be posted back to the system with the new values Posting configuration to the system is described in section 1 5 Introduction to TANDBERG XML API Service TXAS 1 4 4 Command documents w Command documents contain descriptions of the supported commands for the system A Command consists of a Command name and a set of Command parameters The parameter elements have attributes to denote whether the parameter is optional or required in addition to r
49. cccscie secescnedesceccts satedssoecenaebexeates cuodeseacees sated stsenesun ssdatesstnerecaeessateutstacerseens 37 configuration xml xconfiguration eee eee eee eee tees teense eeeeeeeeaeeeeeaeeeeaeeseeaeeeeeneeeeaeeseeeeeeeneeeeaes 37 API COMMA nd wii csc cecsccinesicnc ect cca ii e ii asrus 48 COMMANA XM XCOMMANA 2eecccceeceeeceeeeeeeceeeeseeeeeceseeaneeeeseaneneeseaeaeeesseaneeeseeeeceeeeseeeeeeennees 48 APIS SAUS a acia 60 Status xXMl DS 60 history xml XAISTONY ii aaa a a a a a tebe deus beens 71 OVENE XM X VeNi ssas enina innia naaa dada da 74 D14172 01 page 2 of 84 TANDBERG Gatekeeper Border Controller API User Guide 1 The TANDBERG API This document is a guide to the API interface of the TANDBERG Gatekeeper and Border Controller products All rights reserved This document contains information that is proprietary to TANDBERG No part of this publication may be reproduced stored in a retrieval system or transmitted in any form or by any means electronically mechanically by photocopying or otherwise without the prior written permission of TANDBERG Nationally and internationally recognized trademarks and trade names are the property of their respective holders and are hereby acknowledged Disclaimer The information in this document is furnished for informational purposes only is subject to change without prior notice and should not be construed as a commitment by TANDBERG The information i
50. ccepted the Dial command returns the element CallSerialNumber This lets the user identify trace the call in the Status documents status xml and history xml Example 1 14 Below is an example of the Dial command not being accepted by the system because the same alias has been specified for both the callSrc and callDst lt Command gt lt DialResult item 1 status Error gt lt Cause item 1 gt 89 lt Cause gt lt Description item 1 gt callSrc and callDst must have different aliases lt Description gt lt DialResult gt lt Command gt D14172 01 page 13 of 84 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 with XML 1 5 1 Bare bone HTTP S access The bare bone HTTP S mode uses a unique URL to identify the specific request The contents of the HTTP body will be a XML document or part of it Bare bone HTTP S access is accomplished by passing arguments in the query string after in a URI in a GET request or using the application x www form urlencoded content type method
51. d RegistrationFailure Registration 1 3750 EndTime lt String gt Shows the time at which this registration ended RegistrationFailure Registration 1 3750 Reason lt String gt Shows the reason for the registration ending RegistrationFailure Registration 1 3750 RegistrationRejectionCause SST ELICE Shows the cause for the registration being rejected RegistrationFailure Registration 1 3750 RegistrationRejectionDescription lt String gt Shows a description of the cause for the registration being rejected D14172 01 page 81 of 84 TANDBERG Gatekeeper Border Controller API User Guide Bandwidth Bandwidth Call 1 900 SerialNumber lt String gt Shows the unique serial number of the call Bandwidth Call 1 900 State lt Unknown Connecting Connected Disconnected Connec tionFailed Parked Parking Unparking ParkFailed gt Shows the state of the call Bandwidth Call 1 900 CallType lt Traversal Direct Routed gt Shows the type of the call Bandwidth Call 1 900 Transferable lt On Off gt Shows whether this call is capable of being transferred Bandwidth Call 1 900 Bandwidth lt Integer gt Bandwid Bandwid Bandwid Bandwid Bandwid Email Shows the updated bandwidth in kbps for the call ula Cala fil 900 Rovte Zones lt Sieielicc Shows the name of a zone that is part of the route the call takes de Call
52. e alias of the source call party CallAttempt Call 1 900 SourceAddress lt String gt Shows the IP address and port of the source call party CallAttempt Call 1 900 DestinationAlias lt String gt Shows the alias of the destination call party CallAttempt Call 1 900 DestinationAddress lt String gt Shows the IP address and port of the destination call party Connected Connected Call 1 900 SerialNumber lt String gt Shows the unique serial number of the call Connected Call 1 900 State lt Connected gt Shows the state of the call Connected Call 1 900 CallType lt Traversal Direct Routed gt Shows the type of the call Connected Call 1 900 Transferable lt On Off gt Shows whether this call is capable of being transferred Connected Call 1 900 Bandwidth lt Integer gt Shows the bandwidth in kbps for the call Connected Call 1 900 Route Zone lt String gt Connected Call 1 900 Route Link lt String gt Connected Call 1 900 Leg 1 2 RegistrationID Connected Call 1 900 Leg 1 2 SerialNumber lt String gt Shows the name of a zone that is part of the route the call takes Shows the name of a link that is part of the route the call takes Shows the registration ID of the call party if it is locally registered Shows the serial number of the call party registration Only present if the
53. e call in seconds ConnectionFailure Call 1 900 DisconnectCauseValue lt String gt Shows the reason the call failed ConnectionFailure Call 1 900 DisconnectCause lt String gt Shows a description of the reason the call failed ConnectionFailure Call 1 900 SourceAlias lt String gt Shows the alias of the source call party ConnectionFailure Call 1 900 SourceAddress lt String gt Shows the IP address and port of the source call party ConnectionFailure Call 1 900 DestinationAlias lt String gt Shows the alias of the destination call party ConnectionFailure Call 1 900 DestinationAddress lt String gt Shows the IP address and port of the destination call party Only present if the destination address could be determined Registration Registration Registration 1 3750 CallSignalAddresses Address 1 10 lt String gt Shows the IP address and port to use for call signaling Registration Registration 1 3750 RASAddresses Address 1 10 lt String gt Shows the IP address and port to use for RAS signaling Registration Registration 1 3750 Endpoint Shows that the registration is an endpoint Only present if the registration is an endpoint Registration Registration 1 3750 Gatekeeper Shows that the registration is a gatekeeper Only present if the registration is a gatekeeper Registration Registration 1 3750 Gateway Shows that the registr
54. e total number of traversal calls placed on the system D14172 01 page 84 of 84
55. eferencing the value domain for the given parameter Command parameters do not contain any values when read from the system D14172 01 page 11 of 84 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 lt Command gt lt Dial item 1 gt lt oolis cren recita en valueSpaceRef ValueSpace MandatoryAlias ftitem 1 gt lt callSrc gt lt callDst item 1 required True valueSpaceRef ValueSpace MandatoryAlias item 1 gt lt callDst gt lt Bandwidth item 1 required False valueSpaceRef ValueSpace BandwidthPerCall item 1 gt lt Bandwidth gt ls Fan Ge Tray lt EncryptionMode item 1 required Fal 5 valueSpaceRef ValueSpace EncryptionModes item 1 gt lt EncryptionMode gt lt EncryptionType item 1 required False valueSpaceRef ValueSpace EncryptionTypesSpace item 1 gt lt EncryptionType gt lt Dial gt lt Command gt To issue a command the command structure is posted back to the system together with values for the various parameters Optional parameters can be omitted when posting the structure back to the system Example 1 12 To place a call from Alice to Bob the user can simply post the followi
56. ekeeper2Port lt 1 65534 gt Applies only if the system is a Gatekeeper Specifies the port on the traversal server to connect to Gatekeeper3Address lt S 1 128 gt Specifies the IP Address or FQDN of the traversal server Up to five alternate traversal servers can also be specified Gatekeeper3Port lt 1 65534 gt Applies only if the system is a Gatekeeper Specifies the port on the traversal server to connect to Gatekeeper4Address lt S 1 128 gt Specifies the IP Address or FQDN of the traversal server Up to five alternate traversal servers can also be specified Gatekeeper4Port lt 1 65534 gt Applies only if the system is a Gatekeeper Specifies the port on the traversal server to connect to Gatekeeper5Address lt S 1 128 gt Specifies the IP Address or FQDN of the traversal server Up to five alternate traversal servers can also be specified Gatekeeper5Port lt 1 65534 gt Applies only if the system is a Gatekeeper Specifies the port on the traversal server to connect to Gatekeeper6Address lt S 1 128 gt Specifies the IP Address or FQDN of the traversal server Up to five alternate traversal servers can also be specified Gatekeeper6Port lt 1 65534 gt Applies only if the system is a Gatekeeper Specifies the port on the traversal server to connect to HopCount lt 1 255 gt Specifies the hop count to be used when sending an alias search request to this zone Note If the search req
57. em 1 gt lt SystemContact item 1 gt Administrator lt SystemContact gt lt SNMP gt lt Configuration gt D14172 01 page 35 of 84 TANDBERG Gatekeeper Border Controller API User Guide xpreferences xmlstatusfeedback lt on off gt If xmlstatusfeedback is set to on all status feedback will be returned in XML format instead of the standard XACLI status format Example 2 26 XACLI format s NTP status Active Alles YLIO 0 0 20 Borte LastUpdate 2008 01 01 12 00 00 LastCorrection 1 s end XML format lt Status gt lt NTP item 1 status Active gt lt Address item 1 gt 10 0 0 2 lt Address gt lt Port item 1 gt 123 lt Port gt lt LastUpdate item 1 gt 2008 01 01 12 00 00 lt LastUpdate gt lt LastCorrection item 1 gt 1 lt LastCorrection gt lt NTP gt lt Status gt xpreferences xmlcommandresult lt on off gt If xmicommandresult is set to on response for commands will be returned in XML format Example 2 27 XACLI format xcommand dial alice bob r Result status 0K callszes alias calles odo Bandwidth 384 CallSerialNumber 1 EncryptionMode Auto EncryptionType Auto r end XML format xcommand dial alice bob lt Command gt lt DialResult item 1 status OK gt lt callSrc item 1 gt alice example com lt callSrc gt lt callDst item 1 gt bob example com lt callDst gt lt Bandwidth item 1 gt 384 lt Bandwidth gt lt CallSerialNumber item 1
58. eplace the matching part of the alias will be substituted with the text in the Replace string Replace lt S 1 60 gt Applies only if pattern behavior is set to Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern Priority lt 0 65534 gt Assigns a priority to the specified transform Transforms are applied in order of priority and the priority must be unique for each transform TransformDelete Deletes a transform Transformld r lt 1 200 gt The index of the transform to be deleted TraversalZoneAdd Adds a new traversal zone TraversalZoneName r lt S 1 50 gt Assigns a name to this traversal zone Mode r lt Assent H46018 gt Determines which H 323 traversal protocol to use either Assent or H 460 18 AccountName lt S 1 50 gt Specifies the account name to be used when connecting to an Assent Traversal Zone Gatekeeper1 Address lt S 1 128 gt Specifies the IP Address or FQDN of the traversal server Up to five alternate traversal servers can also be specified Gatekeeper 1Port lt 1 65534 gt Applies only if the system is a Gatekeeper Specifies the port on the traversal server to connect to D14172 01 page 53 of 84 TANDBERG Gatekeeper Border Controller API User Guide Gatekeeper2Address lt S 1 128 gt Specifies the IP Address or FQDN of the traversal server Up to five alternate traversal servers can also be specified Gat
59. ersal zone Zones TraversalZone 1 50 Bandwidth Total lt String gt Shows the total bandwidth in kbps allowed in the traversal zone D14172 01 page 67 of 84 Zones Zones Zones Zones Zones Zones Zones Zones Zones Zones Zones Zones Zones TANDBERG Gatekeeper Border Controller API User Guide TraversalZone 1 50 Bandwidth PerCall lt String gt Shows the bandwidth in kbps allowed per call in the traversal zone TraversalZone 1 50 Bandwidth Used lt String gt Shows the bandwidth in kbps being used in the traversal zone Zone 1 50 status lt Warning Active Failed gt Shows the status of the connection to the zone Zone Lo Ol Catises lt Sitieime gt Shows an error reason for a failure to communicate with the zone Only present if the zone status is Failed or Warning Zone 1 50 Name lt String gt Shows the name of the zone Zone 1 50 Gatekeeper 1 6 status lt Unknown Active Failed gt Shows the status of the connection to the gatekeeper Zone 1 50 Gatekeeper 1 6 Cause lt String gt Shows an error reason for a failure to communicate with the gatekeeper Only present if the gatekeeper status is Failed Zone 1 50 Gatekeeper 1 6 Address lt String gt Shows the address for a gatekeeper in the zone Zone 1 50 Gatekeeper 1 6 Port lt String gt Shows the port for a gatekeeper in the zone mo
60. et to be configured There is no further relevant information when the NTP status is inactive therefore the sub structure of the NTP element is empty D14172 01 page 4 of 84 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 lt Status gt lt NTP item 1 status Active gt lt Address item 1 gt 10 0 0 2 lt Address gt POR SAS BOE E lt LastUpdate item 1 gt 2008 01 01 12 00 00 lt LastUpdate gt lt LastCorrection item 1 gt 1 lt LastCorrection gt lt NTP gt lt Status gt In this example the attributes are used to provide valuable information in addition to establishing a dependency to the underlying sub structure of the element Example 1 4 In the above examples all elements have an attribute named item This attribute specifies the instance number of the element If we examine the DNS configuration for a system which has two DNS servers configured then the XML structure would look like this lt Configuration gt lt IP item 1 gt lt DNS item 1 gt lt Server item 1 gt lt Address item 1 gt 10 0 0 3 lt Address gt lt Server gt lt Server item 2 gt lt Address item 1 gt 10 0 0 4 lt Address gt lt Server gt lt Domain item 1 gt lt Name item 1 gt example com lt Name gt lt Domain gt lt DNS gt lt IP gt lt Configuration gt
61. etermines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Zones TraversalZone 1 50 Match 1 5 Pattern Replace lt S 0 60 gt Applies only if the Pattern Behavior is Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern SubZones DefaultSubZone Bandwidth Total Mode lt None Limited Unlimited gt Determines whether the Default Subzone has a limit on the total bandwidth being used by its endpoints at any one time None corresponds to no bandwidth available SubZones DefaultSubZone Bandwidth Total Limit lt 1 100000000 gt Sets the total bandwidth limit in kbps of the Default Subzone applies only if Mode is set to Limited SubZones DefaultSubZone Bandwidth PerCall Inter Mode lt None Limited Unlimited gt Determines whether there is a limit on the bandwidth for any one call to or from an endpoint in the Default Subzone SubZones DefaultSubZone Bandwidth PerCall Inter Limit lt 1 100000000 gt Specifies the bandwidth limit in kbps for any one call to or from an endpoint in the Default Subzone applies only if Mode is set to Limited SubZones DefaultSubZone Bandwidth PerCall Intra Mode lt None Limited Unlimited gt De
62. fil 900 Rovce Link lt Suiibas gt Shows the name of a link that is part of the route the call takes de Call fil 900 eg 1 2 Registrar LloniD lt Sivraling gt Shows the registration ID of the call party if it is locally registered n Calil A A A SN SE ao Shows the serial number of the call party registration Only present if the call party is locally registered th Call 1 900 Leg 1 2 Alias type lt IPAddress E164 H323Id Url Prefix Suffix gt Bandwid Bandwid Bandwid Bandwid Bandwid Shows the type of the call party alias de Call Tl J00 eg 1 4 2 Aliases SST nes Shows the alias of the call party el Galil fil YOO mec 1 2 Aceliresess lt Sicicalige gt Shows the IP address and port of the call party th Call 1 900 Leg 1 2 Encryption status lt On Off gt Shows the status of encryption on the call leg th Call 1 900 Leg 1 2 Encryption CheckCode lt String gt Shows the check code for the encrypted call leg Only present if encryption status is On cin Call 1 900 Scarce timas lt Sttialmej gt Shows the time at which the call was initiated D14172 01 page 82 of 84 TANDBERG Gatekeeper Border Controller API User Guide Seno yalcica Calil 1 900 Durations lt Sieiesdine gt Shows the duration of the call in seconds Bandwidth Call 1 900 SourceAlias lt String gt Shows
63. gistered XPath expression the part of the element structure containing these changes will be returned The system supports a total of 20 registered expressions with a total of 15 expressions for one session xfeedback usage xfeedback register lt XPathExpression gt Owes xfeedback deregister lt index gt e 3 xfeedback list Ome xfeedback paths note deregistration with index 0 will deregister all registered expressions OK Example 2 20 User wants to monitor changes in the aliases registered to the system xfeedback register status Registrations Registration Aliases Alias To view registered expressions xfeedback list xf 1 status Registrations Registration Aliases Alias OK When the endpoint for Alice registers s Registrations Registration 1 Aliases Alias 1 type H323Id origin Endpoint alice example com s end s Registrations Registration 1 Aliases D14172 01 page 33 of 84 TANDBERG Gatekeeper Border Controller API User Guide Alias 2 type E164 origin Endpoint 441184960001 s end Example 2 21 User wants to monitor for when a zone fails xfeedback register status zones zone status Failed OK When a problem with a zone occurs s Zones Zone 1 status Failed Cause No gatekeeper reachable Name MyNeighbor Gatekeeper status Failed Cause No response from gatekeeper Actes VIO 0 0 Lo Powmes 1719 Callss Bandwidth Totals Urilbmistee cit Perea
64. he alias of the call party Call Mo s2991 tes l 2 Achleossy lt HEN Shows the IP address and port of the call party Call 1 255 Startitiaes lt Stillag gt Shows the time at which the call was initiated Call 1 255 Dusariomas lt Siticima gt Shows the duration of the call in seconds Call 1 255 DisconnectCauseValue lt String gt Shows the reason the call was disconnected Calo Disconnect Callsecm lt Sivirilaej gt Shows a description of the reason the call was disconnected Call 1 255 Soumestliags lt ST lne Shows the alias of the source call party Call 1 255 SourceAddress lt String gt Shows the IP address and port of the source call party Calil ew 2991 Destacadas lt Suicilag gt Shows the alias of the destination call party Call 1 255 DestinationAddress lt String gt Shows the IP address and port of the destination call party D14172 01 page 71 of 84 TANDBERG Gatekeeper Border Controller API User Guide Registrations Registrations Registration 1 255 CallSignalAddresses Address 1 10 lt String gt Shows the IP address and port used for call signaling Registrations Registration 1 255 RASAddresses Address 1 10 lt String gt Shows the IP address and port used for RAS signaling Registrations Registration 1 255 Endpoint Shows that the registration was endpoint Only present if the registration was an endpoin
65. he bandwidth in kbps allowed per call in the Traversal SubZone SubZones TraversalSubZone Bandwidth Used lt String gt Shows the bandwidth in kbps being used in the Traversal SubZone SubZones SubZone 1 100 Name lt Integer gt Shows the name of the SubZone SubZones SubZone 1 100 Registrations Registration 1 3750 lt Integer gt Shows the index of a registration in the SubZone SubZones SubZone 1 100 Calls Call 1 9001 lt Integer gt Shows the index of a call in the SubZone SubZones SubZone 1 100 Bandwidth Total lt String gt Shows the total bandwidth in kbps allowed in the SubZone SubZones SubZone 1 100 Bandwidth PerCall lt String gt Shows the bandwidth in kbps allowed per call in the SubZone SubZones SubZone 1 100 Bandwidth Used lt String gt Shows the bandwidth in kbps being used in the SubZone D14172 01 page 69 of 84 Links sinks Link Shows LIM eS laine Shows sinks Link Shows inks Link Shows sinks Link Leo LOW Ls o LOO Lo LOO Leo LOO the nam the total Le o LOG TANDBERG Gatekeeper Border Controller API User Guide Name lt Integer gt e of the link Calles Call AOS EGELS the index of a call using the link Bandwidth Total lt String gt bandwidth in kbps allowed on the link Bandwidth PerCall lt String gt the bandwidth in kbps allowed per call on t
66. he link Bandwidth Used lt String gt Shows the bandwidth in kbps being used on the link Pipes Pipes Pipe Shows Pipes Pipe Shows Pipes Pipe Shows Pipes Pipe Shows Pipes Pipe Toa LOW the nam Leo LOW the inde Ls o LOG the total Ls o LOO Name lt Integer gt e of the pipe Calls Call 1 900 lt Integer gt x of a call using the pipe Bandwidth Total lt String gt bandwidth in kbps allowed on the pipe Bandwidth PerCall lt String gt the bandwidth in kbps allowed per call on the pipe Loo LOG Bandwidth Used lt String gt Shows the bandwidth in kbps being used on the pipe D14172 01 page 70 of 84 5 2 TANDBERG Gatekeeper Border Controller API User Guide history xml xhistory Call i255 SerialNumber lt Strineg Shows the unique serial number of the call Call 1 255 State lt Disconnected ConnectionFailed gt Shows the state of the call Call 1 255 CallType lt Traversal Direct Routed gt Shows the type of the call Call 1 255 Bandwidth lt Integer gt Shows the bandwidth in kbps for the call Call 1 255 Leg 1 2 Alias type lt IPAddress E164 H323Id Email Url Prefix Suffix gt Calls Calls Calis Calls conal s Calls cantis Camis Caulils Calls Calls CMS Calls Camis CNIS Calls Shows the type of the call party alias Cali 1 255 es Il 2 Allas lt Suirlag gt Shows t
67. hows the name of a zone that is part of the route the call takes CallAttempt Call 1 900 Route Link lt String gt Shows the name of a link that is part of the route the call takes CallAttempt Call 1 900 Leg 1 2 RegistrationID lt String gt Shows the registration ID of the call party if it is locally registered CallAttempt Call 1 900 Leg 1 2 SerialNumber lt String gt Shows the serial number of the call party registration Only present if the call party is locally registered CallAttempt Call 1 900 Leg 1 2 Alias type lt IPAddress E164 H323I1d Email Url Prefix Suffix gt Shows the type of the call party alias CAMARO A Pec OIL SA nl Pl ASS SEMEN Pa Shows the alias of the call party CallAttempt Call 1 900 Leg 1 2 Address lt String gt Shows the IP address and port of the call party CallAttempt Call 1 900 Leg 1 2 Encryption status lt On Off gt Shows the status of encryption on the call leg CallAttempt Call 1 900 Leg 1 2 Encryption CheckCode lt String gt Shows the check code for the encrypted call leg Only present if encryption status is On CallAttempt Call 1 900 StartTime lt String gt Shows the time at which the call was initiated D14172 01 page 74 of 84 TANDBERG Gatekeeper Border Controller API User Guide CallNceenoe Cadi Lo 90001 Diuteaicaioms lt Sieietiae gt Shows the duration of the call in seconds CallAttempt Call 1 900 SourceAlias lt String gt Shows th
68. ithin a status type root command type or help after the status type root command Example 2 3 xstatus Sracus Callge NTP Ethernet Options ExternalManager Pipes Feedback 1 3 Registrations Gatekeeper Resourceusage IP SubZones LDAP SystemUnit Links Zones OK xhistory ESTO Callas Registrations OK To access status type data simply type the status type root command xstatus or xhistory and then an XPath address expression or a TANDBERG SimplePath expression lt status type root command gt lt address expression gt Example 2 4 xstatus registrations registration 1 aliases alias 1 s Registrations Registration 1 Aliases Alias 1 type H323Id origin Endpoint alice example com s end OK D14172 01 page 24 of 84 TANDBERG Gatekeeper Border Controller API User Guide 2 2 1 Format Status information is presented by a mark up notation similar to XML The main differences are all braces are removed in the XACLI format XACLI does not use end tags except for a tag to mark end of the top element XACLI does not use indent spaces to present the data structure XACLI hides the instance number item number in XML of an element if only one instance of a given element exists A status top level element starts with s Example 2 5 shows XML formatting and XACLI formatting for the same status element NTP Example 2 5 XML lt Status gt lt NTP item 1 status
69. lt S 0 39 gt Specifies an IP Address used in conjunction with the IP Prefix Length to identify a subnet to be assigned to this subzone PrefixLength2 lt 0 128 gt Specifies the number of bits of the Subnet IP Address which must match for an IP Address to belong in this subzone Address3 lt S 0 39 gt Specifies an IP Address used in conjunction with the IP Prefix Length to identify a subnet to be assigned to this subzone PrefixLength3 lt 0 128 gt Specifies the number of bits of the Subnet IP Address which must match for an IP Address to belong in this subzone Address4 lt S 0 39 gt Specifies an IP Address used in conjunction with the IP Prefix Length to identify a subnet to be assigned to this subzone PrefixLength4 lt 0 128 gt Specifies the number of bits of the Subnet IP Address which must match for an IP Address to belong in this subzone Address5 lt S 0 39 gt Specifies an IP Address used in conjunction with the IP Prefix Length to identify a subnet to be assigned to this subzone PrefixLength5 lt 0 128 gt Specifies the number of bits of the Subnet IP Address which must match for an IP Address to belong in this subzone TotalMode lt None Limited Unlimited gt Determines whether this subzone has a limit on the total bandwidth of calls being used by its endpoints at any one time Total lt 1 100000000 gt Sets the total bandwidth limit in kbps of this subzone applies only if Mode is
70. mand type root command lt command root command gt Example 2 11 xcommand dial h xCommand AdHocConference Reguseraicion ie 8 lt l 3 70S h xCommand AllowListAdd Barrera i 2 lt Se i woe h xCommand AllowListDelete Adios ee lt 1 25002 h xCommand Boot h xCommand CallTransfer Call 3 lt 1 9Q0 gt Leg 12 8 Silke z Alias 2 s lt 59 1 60 gt D14172 01 page 29 of 84 TANDBERG Gatekeeper Border Controller API User Guide 2 4 1 Command help To get help on a specific command type the command type root command followed by a command name followed by or help lt command type root command gt lt command name gt Example 2 12 xcommand Dial xcomm dial h xCommand Dial callsre ie s lt se 1 60 gt calme e lt Se i 60 gt Bandwidth lt 1 100000000 gt EncryptionMode lt Auto On Off gt EncryptionType lt DES AES 128 Auto gt OK NOTE Required parameters are identified by an r behind the parameter name 2 4 2 Issuing a command A command must start with a command type root commana followed by a command name followed by a set of parameters Parameters values can either be specified by a mark up notation or by placing the parameter values in the sequence specified by the help text or a combination of these methods Markup notation lt command type root command gt lt command gt lt parameter value gt lt parameter value gt
71. mines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Match5PatternString lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared Match5PatternType lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Match5PatternBehavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Match5PatternReplace lt S 0 60 gt Applies only if the Pattern Behavior is Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern TraversalZoneDelete Deletes a traversal zone TraversalZoneld r lt 1 50 gt The index of the traversal zone to be deleted ZoneAdd Adds a new z
72. n 1 Status documents r Documents holding all available Status Information in the system Supported documents a Status xml b history xml 2 Configuration documents rw Documents holding all system configurations Supported documents a configuration xml 3 Command documents w Documents defining the supported system commands used to initiate system processes This is write data e the parameter values for a given command are defined by the user and posted to the system The posted values will not be returned when reading the document from the system Reading a command document from the system returns descriptions of the supported commands with empty parameter values Supported documents a command xml 4 Meta Documents Meta documents contain information that can be referenced by other documents e g value domains of configurations or command parameters Supported Meta Documents a Valuespace xml 1 4 2 Status Documents r The Status Documents are characterised by an extensive use of XML attributes In addition to holding information the attributes are used to reflect the structure of the sub elements which are dependent on the state of the system D14172 01 page 9 of 84 TANDBERG Gatekeeper Border Controller API User Guide Example 1 9 The element Zone will contain different sub elements depending on the zone status lt Status gt lt Zones item 1 gt lt Zone item 2 status Failed gt
73. n this document is believed to be accurate and reliable however TANDBERG assumes no responsibility or liability for any errors or inaccuracies that may appear in this document nor for any infringements of patents or other rights of third parties resulting from its use No license is granted under any patents or patent rights of TANDBERG This document was written by the Research and Development Department of TANDBERG United Kingdom We are committed to maintaining a high level of quality in all our documentation Towards this effort we welcome your comments and suggestions regarding the content and structure of this document Please fax or mail your comments and suggestions to the attention of Research and Development Department TANDBERG Philip Pedersen vei 22 1366 Lysaker Norway Tel 47 67 125 125 Fax 47 67 125 234 COPYRIGHT O 2008 TANDBERG D14172 01 page 3 of 84 TANDBERG Gatekeeper Border Controller API User Guide 1 1 Introduction to XML XML is a markup language for documents containing structured information All information elements in an XML document are marked by a tag and a corresponding end tag The end tag has the same name as the tag but is prefixed with a slash All tags are put within angular brackets lt gt Example 1 1 Below is an example of how the configuration for SNMP could be represented using XML lt Configuration gt lt SNMP item 1 gt lt Mode item 1 gt 0On lt Mode g
74. n Off gt If zone monitoring is enabled an LRQ will be periodically sent to the zone gatekeeper If it fails to respond that gatekeeper will be marked as inactive Match1 Mode lt AlwaysMatch PatternMatch Disabled gt Determines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Match1 PatternString lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared Match1PatternType lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Match1 PatternBehavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Match1PatternReplace lt S 0 60 gt Applies only if the Pattern Behavior is Replace Specifies the string t
75. nationAddress lt String gt Shows the IP address and port of the destination call party D14172 01 page 65 of 84 TANDBERG Gatekeeper Border Controller API User Guide Registrations Registrations Registration 1 3750 CallSignalAddresses Address 1 10 lt String gt Shows the IP address and port to use for call signaling Registrations Registration 1 3750 RASAddresses Address 1 10 lt String gt Shows the IP address and port to use for RAS signaling Registrations Registration 1 3750 Endpoint Shows that the registration is an endpoint Only present if the registration is an endpoint Registrations Registration 1 3750 Gatekeeper Shows that the registration is a gatekeeper Only present if the registration is a gatekeeper Registrations Registration 1 3750 Gateway Shows that the registration is a gateway Only present if the registration is a gateway Registrations Registration 1 3750 Gateway Prefix 1 200 lt String gt Shows the prefix of a registered gateway service Only present if the registration is a gateway Registrations Registration 1 3750 MCU Shows that the registration is an MCU Only present if the registration is an MCU NeGplisicieche ops INeoalsicieciesein il 0 Mew asirios o 20013 lt Sicestiave Shows the prefix of a registered MCU service Only present if the registration is an MCU Registrations Registration
76. ne i oS0 E ISE UA ARAS 001 Ente q el Shows the index of a call in the zone Zone 1 50 Bandwidth Total lt String gt Shows the total bandwidth in kbps allowed in the zone Zone 1 50 Bandwidth PerCall lt String gt Shows the bandwidth in kbps allowed per call in the zone Zone 1 50 Bandwidth Used lt String gt Shows the bandwidth in kbps being used in the zone D14172 01 page 68 of 84 TANDBERG Gatekeeper Border Controller API User Guide Subzones SubZones DefaultSubZone Registrations Registration 1 3750 lt Integer gt Shows the index of a registration in the Default SubZone SubZones DefaultSubZone Calls Call 1 900 lt Integer gt Shows the index of a call in the Default SubZone SubZones DefaultSubZone Bandwidth Total lt String gt Shows the total bandwidth in kbps allowed in the Default SubZone SubZones DefaultSubZone Bandwidth PerCall lt String gt Shows the bandwidth in kbps allowed per call in the Default SubZone SubZones DefaultSubZone Bandwidth Used lt String gt Shows the bandwidth in kbps being used in the Default SubZone SubZones TraversalSubZone Calls Call 1 9001 lt Integer gt Shows the index of a call in the Traversal SubZone SubZones TraversalSubZone Bandwidth Total lt String gt Shows the total bandwidth in kbps allowed in the Traversal SubZone SubZones TraversalSubZone Bandwidth PerCall lt String gt Shows t
77. ng XML structure to the system lt Command gt lt Dial item 1 gt lt callSre item 1 gt aliceltexample com lt CallSrc gt lt callDst item 1 gt bob example com lt CallDst gt lt Dial gt lt Command gt When issuing commands the system will return an XML structure in response The response structure will have the same name as the command issued but it will be suffixed with Result All commands will have an attribute named status stating whether the command was accepted or not If a command is not accepted the response structure will contain a Cause code If the command is accepted the response structure may contain information relevant for the specific command D14172 01 page 12 of 84 TANDBERG Gatekeeper Border Controller API User Guide Example 1 13 The Dial command in the above example may return the following response structure lt Command gt lt DialResult item 1 status OK gt lt callSrc item 1 gt alice example com lt callSrc gt lt callDst item 1 gt bob example com lt callDst gt lt Bandwidth item 1 gt 384 lt Bandwidth gt lt CallSerialNumber item 1 gt 1 lt CallSerialNumber gt lt EncryptionMode item 1 gt Auto lt EncryptionMode gt lt EncryptionType item 1 gt Auto lt EncryptionType gt lt DialResult gt lt Command gt The response structure for the Dial command DialResult states that the command was accepted by the system In addition to stating that the command was a
78. nly present if the Protocol is IPv6 or Both D14172 01 page 61 of 84 TANDBERG Gatekeeper Border Controller API User Guide IP IPv6 Gateway lt IPv4Addr gt Shows the IPv6 address of the default gateway Only present if the Protocol is IPv6 or Both TERDNSES Sven RES Addresses italia Shows the IP address of a configured DNS server IP DNS Domain Name lt IPv4Addr gt Shows the DNS domain to which the system belongs NTP NTP status lt Inactive Active Failed gt Shows the status of the connection to the NTP server NTP Cause lt String gt Shows an error reason for a failure to connect to the NTP server Only present if the NTP status is Failed NTP Address lt String gt Shows the address of the NTP server Only present if the NTP status is Active or Failed INE Ports lt Sieraline Shows the port of the NTP server Only present if the NTP status is Active or Failed NTP LastUpdate lt String gt Shows the time at which the last NTP update occurred Only present if the NTP status is Active NTP LastCorrection lt String gt Shows the last correction to the time that occurred Only present if the NTP status is Active LDAP LDAP status lt Inactive Active Failed gt Shows the status of the connection to the LDAP server LDAP Reason lt String gt Shows an error reason for a failure to connect to the LDAP server Only present if the LDAP status is Failed or Inactive
79. ntry from the Allow List AllowListld r lt 1 2500 gt The index of the entry to be deleted Boot Reboots the system This command has no parameters CallTransfer Transfers the specified call from one call party to the endpoint specified by the supplied alias Call r lt 1 900 gt The index of the call to be transferred Leg r lt 1 2 gt The index of the call leg to be transferred Alias r lt S 1 60 gt The alias for the call to be transferred to CheckBandwidth A diagnostic tool that returns the status and route as a list of nodes and links that a call of the specified type and bandwidth would take between two nodes Note that this command does not change any existing system configuration Node1 r lt S 1 50 gt The subzone or zone from which the call originates Node2 r lt S 1 50 gt The subzone or zone at which the call terminates D14172 01 page 48 of 84 TANDBERG Gatekeeper Border Controller API User Guide Bandwidth r lt 1 100000000 gt The requested bandwidth of the call in kbps CallType r lt Traversal Routed Direct gt Whether the call type is Traversal Routed or Direct CredentialAdd Adds an entry to the local authentication database CredentialName r lt S 1 25 gt Defines the name for this entry in the local authentication database CredentialPassword r lt S 1 25 gt Defines the password for this entry in the local authentication database CredentialDelete
80. o be used as a substitution for the part of the alias that matched the pattern Match2Mode lt AlwaysMatch PatternMatch Disabled gt Determines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried D14172 01 page 57 of 84 TANDBERG Gatekeeper Border Controller API User Guide Match2PatternString lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared Match2PatternType lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Match2PatternBehavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Match2PatternReplace lt S 0 60 gt Applies only if the Pattern Behavior is Replace Specifies the string to
81. ode lt AlwaysMatch PatternMatch Disabled gt Determines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Match4PatternString lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared Match4PatternType lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression D14172 01 page 58 of 84 TANDBERG Gatekeeper Border Controller API User Guide Match4PatternBehavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Match4PatternReplace lt S 0 60 gt Applies only if the Pattern Behavior is Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern Match5Mode
82. on Result lt Success Failed gt Shows the result of searching this location LocateResult Location Reason lt Success Failed gt 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 TANDBERG Gatekeeper Border Controller API User Guide ResourceUsage ResourceUsage Registrations lt Integer gt Shows the current number of registrations on the system ResourceUsage MaxRegistrations lt Integer gt Shows the maximum number of concurrent registrations on the system ResourceUsage NonTraversalCalls lt Integer gt Shows the current number of non traversal calls on the system Only present if the system is a Gatekeeper ResourceUsage MaxNonTraversalCalls lt Integer gt Shows the maximum number of concurrent non traversal calls on the system Only present if the system is a Gatekeeper ResourceUsage TotalNonTraversalCalls lt Integer gt Shows the total number of non traversal calls that have been placed on the system Only present if the system is a Gatekeeper ResourceUsage TraversalCalls lt Integer gt Shows the current number of traversal calls on the system ResourceUsage MaxTraversalCalls lt Integer gt Shows the maximum number of concurrent traversal calls on the system ResourceUsage TotalTraversalCalls lt Integer gt Shows th
83. one ZoneName r lt S 1 50 gt Assigns a name to this zone Gatekeeper1 Address r lt S 1 128 gt Specifies the IP Address or FQDN of this neighbor Gatekeeper 1Port lt 1 65534 gt Specifies the port on the neighbor to be used Gatekeeper2Address lt S 1 128 gt Specifies the IP Address or FQDN of this neighbor D14172 01 page 56 of 84 TANDBERG Gatekeeper Border Controller API User Guide Gatekeeper2Port lt 1 65534 gt Specifies the port on the neighbor to be used Gatekeeper3Address lt S 1 128 gt Specifies the IP Address or FQDN of this neighbor Gatekeeper3Port lt 1 65534 gt Specifies the port on the neighbor to be used Gatekeeper4Address lt S 1 128 gt Specifies the IP Address or FQDN of this neighbor Gatekeeper4Port lt 1 65534 gt Specifies the port on the neighbor to be used Gatekeeper5Address lt S 1 128 gt Specifies the IP Address or FQDN of this neighbor Gatekeeper5Port lt 1 65534 gt Specifies the port on the neighbor to be used Gatekeeper6Address lt S 1 128 gt Specifies the IP Address or FQDN of this neighbor Gatekeeper6Port lt 1 65534 gt Specifies the port on the neighbor to be used HopCount lt 1 255 gt Specifies the hop count to be used when sending an alias search request to this zone Note If the search request was received from another zone and already has a hop count assigned the lower of the two values will be used Monitor lt O
84. only be updated by the user control application 1 3 2 Addressing using XPath To address information in the hierarchic structure of Status and Configuration information the TANDBERG systems support abbreviated XML Path Language XPath This allows the user control application to address everything from a single element of data for example the source address of a specific call to larger parts of the hierarchy for example all information available for a given call The structuring of information together with XPath for addressing makes up powerful features like searching and setting of multiple instances of a configuration 1 3 3 Feedback Feedback is an extremely powerful feature where the TANDBERG system actively returns updated status and configuration information to the user control application whenever changes occur The user control application can specify what parts of the status and configuration hierarchies it wants to D14172 01 page 8 of 84 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
85. ontact can be set in the Configuration document curl k u admin lt password gt d lt Configuration gt lt SNMP gt lt SystemContact gt Alice lt SystemContact gt lt SNMP gt lt Configur Aeon aE metos 10 0 0 1 crore utes lt xml version 1 0 7 gt lt Configuration gt lt Success gt lt Configuration gt The new configuration value can be confirmed using the getxml request curl k u admin lt password gt https 10 0 0 1 getxml location Configuration SNMP SystemContact lt xml version 1 0 gt lt Configuration gt lt SNMP item 1 gt lt SystemContact item 1 gt Alice lt SystemContact gt lt SNMP gt lt Configuration gt Example 1 17 Using the Unix curl command the dial command can be invoked on the target system to place a call between Alice and Bob curl k u admin lt password gt d lt Command gt lt Dial gt lt callSrc gt Alice lt callSrc gt lt callDst gt Bob lt callDst gt lt Dial gt lt Comm and gt https 10 0 0 1 formputxml lt xml version 1 0 gt lt Command gt lt DialResult item 1 status OK gt lt callSre item 1 gt Alice lt callSre gt lt callDst item 1 gt Bob lt callDst gt lt Bandwidth item 1 gt 384 lt Bandwidth gt lt CallSerialNumber item 1 gt 00000000 0000 0000 0000 000000000000 lt CallSerialNumber gt lt EncryptionMode item 1 gt Auto lt EncryptionMode gt lt EncryptionType item 1 gt Auto lt EncryptionType gt lt DialRe
86. r is Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern Match2Mode lt AlwaysMatch PatternMatch Disabled gt Determines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Match2PatternString lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared Match2PatternType lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Match2PatternBehavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Match2PatternReplace lt S 0 60 gt Applies only if the Pattern Behavior is Replace Specifies the string to be used as a substitution for the part of the alia
87. raversalCalls lt Integer gt Shows the systems traversal call capacity SystemUnit Software Configuration Registrations lt Integer gt Shows the systems registration capacity SystemUnit Software Configuration Encryption lt True False gt Shows whether AES encryption is present SystemUnit Software Configuration Multiway lt True False gt Shows whether Multiway is available SystemUnit Hardware Version lt String gt Shows the hardware version SystemUnit Hardware SerialNumber lt String gt Shows the serial number Options Options Ojea il 64 Keys lt Sicieilings Shows an installed option key Options Option 1 64 Description lt String gt Shows a description of the option key Ethernet Ethernet MacAddress lt String gt Shows the MAC address of the Ethernet interface Ethernet Speed lt 10hal1f 10fu11 100ha1f 100fu11 gt Shows the speed of the Ethernet interface IP IP Protocol lt Both IPv4 IPv6 gt Shows the IP protocols IP Address lt IPv4Addr gt Shows the systems IPv4 address Only present if the Protocol is IPv4 or Both IP SubnetMask lt IPv4Addr gt Shows the systems IPv4 subnet mask Only present if the Protocol is IPv4 or Both IP Gateway lt IPv4Addr gt Shows the IPv4 address of the default gateway Only present if the Protocol is IPv4 or Both IP IPv6 Address lt IPv4Addr gt Shows the IPv6 address of the system O
88. rmines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Match4PatternString lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared D14172 01 page 55 of 84 TANDBERG Gatekeeper Border Controller API User Guide Match4PatternType lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Match4PatternBehavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Match4PatternReplace lt S 0 60 gt Applies only if the Pattern Behavior is Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern Match5Mode lt AlwaysMatch PatternMatch Disabled gt Deter
89. s matching the address expression will be returned lt configuration type root command gt lt address expr gt help Example 2 7 User wants to configure IP a g h IPProtocol lt Both IPv4 IPv6 gt h IP Address lt IPAddr gt h IP SubnetMask lt IPAddr gt h IP Gateway lt IPAddr gt la IE We Acloltesss lt S3 O BO win Le WG Gaicewenys lt S 0 39 gt win 112 DNS Sermwe Il ol Acoresses lt Se O 39 gt h IP DNS Domain Name lt S 0 128 gt D14172 01 page 26 of 84 TANDBERG Gatekeeper Border Controller API User Guide NOTE Only typing actually addresses all configuration elements within the root command One would therefore expect that help on all configurations would be returned But as described above this is a special case and only listings of the top level elements are returned To get help on all configurations supported by the system type Vi Gie RR 2 3 2 Configuration read To read configurations type the configuration type root command followed by an address expression lt configuration type root command gt lt address expr gt Example 2 8 User wants to read IP configurations ip BE IUPIPCOEOCOLS IRTENA a 19 Meleheesag 0 0 0 1 e IP Sulomecvesi s Y25309 253 2550 wel I Gencewesys ViILO 0 25a wel IP We occ Wu c IP V6 Gateway se IP INS Sewer 1 Mewlieesss VILO O 0 34 se IP DIS Servez 2 Melesse ViILO O 0 4w a 12 DNS Server Add resons WU A
90. s that matched the pattern Match3Mode lt AlwaysMatch PatternMatch Disabled gt Determines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Match3PatternString lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared Match3PatternType lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Match3PatternBehavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string Match3PatternReplace lt S 0 60 gt Applies only if the Pattern Behavior is Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern Match4Mode lt AlwaysMatch PatternMatch Disabled gt Dete
91. set to Limited PerCalllnterMode lt None Limited Unlimited gt Determines whether there is a limit on the bandwidth for any one call to or from an endpoint in this subzone PerCalllnter lt 1 100000000 gt Specifies the bandwidth limit in kbps on any one call to or from an endpoint in this subzone applies only if Mode is set to Limited D14172 01 page 52 of 84 TANDBERG Gatekeeper Border Controller API User Guide PerCalllntraMode lt None Limited Unlimited gt Determines whether there is a limit on the bandwidth for any one call between two endpoints within this subzone PerCalllntra lt 1 100000000 gt Specifies the bandwidth limit in kbps for any one call between two endpoints within this subzone applies only if Mode is set to Limited SubZoneDelete Deletes a subzone SubZoneld r lt 1 100 gt The index of the subzone to be deleted TransformAdd Adds a new destination alias transform Pattern r lt S 1 60 gt Specifies the pattern against which the alias is compared Type lt Prefix Suffix Regex gt Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Behavior lt Strip Replace gt Determines how the matched part of the alias will be modified Strip the matching prefix or suffix will removed from the alias R
92. sult gt lt Command gt D14172 01 page 15 of 84 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 Language WSDL The WSDL file is located at the root of the system s web server at the URL webservices wsdl e g http 10 0 0 1 webservices wsdl Most programming environments have built in support for developing web service clients or else third party libraries are available The following examples use the PHP scripting language to illustrate how to develop a client web service for the Gatekeeper and Border Controller Example 1 18 The example below shows how to reboot the system using the boot command lt php Sclient new SoapClient http 10 0 0 1 webservices wsdl array login gt lt username gt password gt lt password gt Sclient gt Boot 7 gt Example 1 19 The example below shows how to use the dial command which requires parameters to be passed as part of the operation lt php Sclient new SoapClient http 10 0 0 1 webservices wsdl
93. system Gatekeeper Gatekeeper Alternates Alternate 1 5 status lt Unknown Active Failed gt Shows the status of the connection to an alternate system Gatekeeper Alternates Alternate 1 5 Cause lt String gt Shows an error reason for a failure to connect to the alternate system Only present if the alternate status if Failed Gatekeeper Alternates Alternate 1 5 Address lt String gt Shows the address of the alternate system Gatekeeper Alternates Alternate 1 5 Port lt String gt Shows the port of the alternate system Calls Calls Call 1 900 SerialNumber lt String gt Shows the unique serial number of the call Calls Call 1 900 State lt Unknown Connecting Connected Disconnected ConnectionFailed Parked Parking Unparking ParkFailed gt Shows the state of the call Calls Call 1 900 CallType lt Traversal Direct Routed gt Shows the type of the call Calls Call 1 900 Transferable lt On Off gt Shows whether this call is capable of being transferred Calls Call 1 900 Bandwidth lt Integer gt Shows the bandwidth in kbps for the call Calls Call 1900 Route zons lt Sieieiling gt Shows the name of a zone that is part of the route the call takes Calls Calil 1 900 Route mies lt Stibtag gt Shows the name of a link that is part of the route the call takes D14172 01 page 64 of 84 Calls Call TANDBERG Gatekeeper Border Controller AP
94. t Registrations Registration 1 255 Gatekeeper Shows that the registration was a gatekeeper Only present if the registration was a gatekeeper Registrations Registration 1 255 Gateway Shows that the registration was a gateway Only present if the registration was a gateway Registrations Registration 1 255 Gateway Prefix 1 200 lt String gt Shows the prefix of a registered gateway service Only present if the registration was a gateway Registrations Registration 1 255 MCU Shows that the registration was an MCU Only present if the registration was an MCU Regis tina LoOnsmReGustrctlonm Ie 5S MCU St OO SEN Shows the prefix of a registered MCU service Only present if the registration was an MCU Registrations Registration 1 255 Aliases Alias 1 200 type lt IPAddress E164 H3231d Email Url Prefix Suffix gt Shows the type of the alias Reqistratilons Registration MAS Aras es Allias ZOO lt Strang Shows the alias value Registrations Registration 1 255 Subzone lt String gt Shows the subzone to which this registration belonged Registrations Registration 1 255 SerialNumber lt String gt Shows the unique serial number of the registration Registrations Registration 1 255 StartTime lt String gt Shows the time at which this registration was created Registrations Registration 1 255 EndTime
95. t lt CommunityName item 1 gt public lt CommunityName gt lt SystemContact item 1 gt Administrator lt SystemContact gt lt SystemLocation item 1 gt lt SystemLocation gt lt SNMP gt lt Configuration gt From the tree structure of this example we can see that Mode CommunityName SystemContact and SystemLocation are properties of the SNMP configuration We can distinguish between container elements and value elements Container elements contain one or more sub elements while value elements contain a value This is analogous to files and folders on a computer Container elements are folders that can contain sub folders and files while value elements are files containing data In the XML structure for the SNMP configuration we see that the container element SNMP contains four sub elements All these sub elements are value elements each holding values for the properties Mode CommunityName SystemContact and SystemLocation Example 1 2 In this example we will look at element attributes Attributes are used to add meta information to an element Attributes are placed within the start tag of an element and different attributes are separated by space An XML structure representing the status of a connection to an NTP server is shown below lt Status gt lt NEP atem I status Inactive gt lt Status gt We can see from the status attribute of the NTP element that the NTP connection is Inactive This is because it has y
96. t must re register with the system in order to confirm that it is still functioning Gatekeeper CallTimeToLive lt 60 65534 gt Specifies the interval in seconds at which the system polls the endpoints in a call to verify that they are still in the call Gatekeeper AutoDiscovery lt On Off gt Determines whether or not the system responds to gatekeeper discovery requests from endpoints Gatekeeper CallsToUnknownIPAddresses lt Off Direct Indirect gt Determines the way in which the system will attempt to call systems which are not registered with it or one of its neighbors Direct Allows an endpoint to make a call to an unknown IP Address without the system querying any neighbors Indirect Upon receiving a call to an unknown IP Address the system will query its neighbors for the remote address and if permitted will route the call through the neighbor Off Endpoints registered directly to the system may only call an IP Address of a system also registered directly to that system D14172 01 page 39 of 84 TANDBERG Gatekeeper Border Controller API User Guide Gatekeeper ForwardLocationRequests lt On Off gt Determines the behavior of the system when it receives from another Gatekeeper a location request LRQ that it cannot resolve locally On the request will be forwarded to neighbor Gatekeepers Off the request will not be forwarded Gatekeeper DNSResolution Mode lt On Off gt Determines whether or not DNS lookup of
97. termines whether there is a limit on the bandwidth for any one call between two endpoints within the Default Subzone SubZones DefaultSubZone Bandwidth PerCall Intra Limit lt 1 100000000 gt Specifies the bandwidth limit in kops for any one call between two endpoints within the Default Subzone applies only if Mode is set to Limited SubZones TraversalSubZone Bandwidth Total Mode lt None Limited Unlimited gt Determines whether or not there is a limit to the total bandwidth of all traversal calls being handled by the system SubZones TraversalSubZone Bandwidth Total Limit lt 1 100000000 gt Specifies the total bandwidth in kbps allowed for all traversal calls being handled by the system applies only if Mode is set to Limited D14172 01 page 45 of 84 TANDBERG Gatekeeper Border Controller API User Guide SubZones TraversalSubZone Bandwidth PerCall Mode lt None Limited Unlimited gt Determines whether there is a limit on the bandwidth of any one traversal call being handled by the system SubZones TraversalSubZone Bandwidth PerCall Limit lt 1 100000000 gt Specifies the bandwidth limit in kbps applied to any one traversal call being handled by the system applies only if Mode is set to Limited SUbDZ ones SulbZone lie LOO AN ame SS OS Assigns a name to this subzone SubZones SubZone 1 100 Bandwidth Total Mode lt None Limited Unlimited gt Determines whether this subzone has a limit on the total bandwidth
98. the browser s address field NOTE The first letter in the document names is uppercase http 10 0 0 1 getxml location Status http 10 0 0 1 getxml location History http 10 0 0 1 getxml location Configuration http 10 0 0 1 getxml location Command http 10 0 0 1 getxml location Valuespace Exercise 3 This exercise shows how to use XPath expressions to read subsets of the XML documents http 10 0 0 1 getxml location Status SystemUnit http 10 0 0 1 getxml location Configuration SNMP SystemContact http 10 0 0 1 getxml location ValueSpace SNMPCommunityName item 1 http 10 0 0 1 getxml location Configuration IP Address http 10 0 0 1 getxml location Command Dial D14172 01 page 19 of 84 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 lt Configuration gt lt SNMP gt lt SystemContact gt Administrator lt SystemContact gt lt SNMP gt lt Configuration gt lt Configuration gt lt SNMP gt lt SystemContact gt Administrator lt SystemContact gt lt SNMP gt lt NTP gt lt Address gt 10 0 0 2 lt Address gt lt NTP gt lt Configuration gt lt Command gt lt Dial gt lt callSre gt Alice lt callSre gt lt callDst gt Bob lt callDst gt lt Dial gt lt Comm
99. this link will be applied Pipe1 lt S 1 50 gt Specifies the first pipe to be associated with this link Pipe2 lt S 1 50 gt Specifies the second pipe to be associated with this link LinkDelete Deletes a link Linkla r lt 1 100 gt The index of the link to be deleted D14172 01 page 50 of 84 TANDBERG Gatekeeper Border Controller API User Guide Locate Runs the system s location algorithm to locate the endpoint identified by the given alias searching locally on neighbors and on systems discovered through the DNS system within the specified number of hops Results are reported back through the xFeedback mechanism which must therefore be activated before issuing this command e g xFeedback register event locate Alias r lt S 1 60 gt The alias associated with the endpoint you wish to locate HopCount r lt 0 255 gt The hop count to be used in the search Opt ionKeyAdd Adds a new option key to the system Key r lt S 0 90 gt Specifies the option key of the option you wish to add Option keys are added to the system in order to add extra functionality such as increasing the system s capacity Contact your TANDBERG representative for further information OptionKeyDelete Deletes a software option key from the system OptionKeyld r lt 1 64 gt Specifies the ID of the software option to be deleted PipeAdd Adds and configures a new pipe PipeName r lt S 1 50 gt Assigns a name to
100. this pipe TotalMode lt None Limited Unlimited gt Determines whether or not this pipe is enforcing total bandwidth restrictions None no bandwidth available Total lt 1 100000000 gt If this pipe has limited bandwidth sets the maximum bandwidth in kbps available at any one time on the pipe PerCallMode lt None Limited Unlimited gt Determines whether or not this pipe is limiting the bandwidth of individual calls None no bandwidth available PerCall lt 1 100000000 gt If this pipe has limited per call bandwidth sets the maximum amount of bandwidth in kbps available for any one call PipeDelete Deletes a pipe Pipeld r lt 1 100 gt The index of the pipe to be deleted RemoveRegistration Removes a registration from the system Registration lt 1 3750 gt The index number of the registration to be removed D14172 01 page 51 of 84 TANDBERG Gatekeeper Border Controller API User Guide RegistrationSerialNumber lt S 0 255 gt The serial number of the registration to be removed SubZoneAdd Adds and configures a new subzone SubZoneName r lt S 1 50 gt Assigns a name to this subzone Address1 lt S 0 39 gt Specifies an IP Address used in conjunction with the IP Prefix Length to identify a subnet to be assigned to this subzone PrefixLength1 lt 0 128 gt Specifies the number of bits of the Subnet IP Address which must match for an IP Address to belong in this subzone Address2
101. tor lt On Off gt Controls whether or not alternate gatekeepers are periodically interrogated to ensure that they are still functioning In order to prevent delays during call setup non functional alternates will not receive Location Requests Gatekeeper Alternates Alternate 1 5 Address lt S 0 128 gt Specifies the IP Address of an alternate system Up to 5 Alternates may be configured When the system receives a Location Request all Alternates will also be queried Gatekeeper Alternates Alternate 1 5 Port lt 1 65534 gt Specifies the IP Port of an alternate system Gatekeeper Policy Mode lt On Off gt Enables and disables use of Administrator Policy D14172 01 page 40 of 84 TANDBERG Gatekeeper Border Controller API User Guide Gatekeeper Downspeed PerCall Mode lt On Off gt Determines whether or not the system will attempt to downspeed a call if there is insufficient per call bandwidth available to fulfill the request On the system will attempt to place the call at a lower bandwidth Off the call will be rejected Gatekeeper Downspeed Total Mode lt On Off gt Determines whether or not the system will attempt to downspeed a call if there is insufficient total bandwidth available to fulfill the request On the system will attempt to place the call at a lower bandwidth Off the call will be rejected Gatekeeper Unregistered Caller Mode lt On Off gt Specifies whether the system will accept
102. uest was received from another zone and already has a hop count assigned the lower of the two values will be used Match1 Mode lt AlwaysMatch PatternMatch Disabled gt Determines if and when a query will be sent to this zone Always the zone will always be queried Pattern the zone will only be queried if the alias queried for matches the corresponding pattern Disabled the zone will never be queried Match1PatternString lt S 0 60 gt Applies only if the Match mode is Pattern Match Specifies the pattern against which the alias is compared Match1PatternType lt Prefix Suffix Regex gt Applies only if the Match mode is Pattern Match Determines the way in which the string must match the alias Prefix the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Match1 PatternBehavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string D14172 01 page 54 of 84 TANDBERG Gatekeeper Border Controller API User Guide Match1PatternReplace lt S 0 60 gt Applies only if the Pattern Behavio
103. umber of the registration eg ise ra Ton Recalsutrzacion 1 S7 50 Steeciames lt Sutilnmes gt Shows the time at which this registration was created Unregistration Unregistration Registration 1 3750 CallSignalAddresses Address 1 10 lt String gt Shows the IP address and port used for call signaling Unregistration Registration 1 3750 RASAddresses Address 1 10 lt String gt Shows the IP address and port used for RAS signaling Unregistration Registration 1 3750 Endpoint Shows that the registration was endpoint Only present if the registration was an endpoint Unregistration Registration 1 3750 Gatekeeper Shows that the registration was a gatekeeper Only present if the registration was a gatekeeper Unregistration Registration 1 3750 Gateway Shows that the registration was a gateway Only present if the registration was a gateway Unregistration Registration 1 3750 Gateway Prefix 1 200 lt String gt Shows the prefix of a registered gateway service Only present if the registration was a gateway D14172 01 page 79 of 84 TANDBERG Gatekeeper Border Controller API User Guide Unregistration Registration 1 3750 MCU Shows that the registration was an MCU Only present if the registration was an MCU UnreqisieeatvOnmRe gust rat tones la Se SO MCUs Se OO SS Ein gt Shows the prefix of a registered MCU service Only present if the registration was
104. us the exchange of information can be divided into 1 information flowing from target hereby called read information r 2 information flowing to target hereby called write information w If we now look at the TANDBERG systems we can identify three main types of information either being read information r write information w or read write information rw 1 r Read information Status Information Information about the system and system processes i e information generated by the system For example status about registered systems ongoing calls network status etc All status information is structured in a hierarchy making up a database constantly being updated by the system to reflect process changes 2 w Write information Command Information Information supplied by the user to initiate an action For example instructing the system to place a call disconnect an existing call remove a registration etc A command is usually followed by a set of parameters to specify how the given action is to be executed 3 rw Read Write information Configuration Information Information defining system settings This information can both be supplied and read by the user For example IP settings bandwidth settings enabling disabling of various features etc All configuration information is structured in a hierarchy making up a database of system settings But for the Configuration information the data in the database can
105. was a gatekeeper Only present if the registration was a gatekeeper RegistrationFailure Registration 1 3750 Gateway Shows that the registration was a gateway Only present if the registration was a gateway D14172 01 page 80 of 84 TANDBERG Gatekeeper Border Controller API User Guide RegistrationFailure Registration 1 3750 Gateway Prefix 1 200 lt String gt Shows the prefix of a registered gateway service Only present if the registration was a gateway RegistrationFailure Registration 1 3750 MCU Shows that the registration was an MCU Only present if the registration was an MCU RegistrationFailure Registration 1 3750 MCU Prefix 1 200 lt String gt Shows the prefix of a registered MCU service Only present if the registration was an MCU RegistrationFailure Registration 1 3750 Aliases Alias 1 200 type lt IPAddress E164 H3231d Email Url Prefix Suffix gt Shows the type of the alias RegistrationFailure Registration 1 3750 Aliases Alias 1 200 lt String gt Shows the alias value RegistrationFailure Registration 1 3750 SubZone lt String gt Shows the subzone to which this registration belonged RegistrationFailure Registration 1 3750 SerialNumber lt String gt Shows the unique serial number of the registration RegistrationFailure Registration 1 3750 StartTime lt String gt Shows the time at which this registration was create
106. x the string must appear at the beginning of the alias Suffix the string must appear at the end of the alias Regex the string will be treated as a regular expression Zones Zone 1 100 Match 1 5 Pattern Behavior lt Strip Leave Replace gt Applies only if the Match mode is Pattern Match Determines whether the matched part of the alias should be modified before an LRQ is sent to this zone Leave the alias will be unmodified Strip the matching prefix or suffix will be removed from the alias Replace the matching part of the alias will be substituted with the text in the Replace string ANAIS A UN AA EI IS Applies only if the Pattern Behavior is Replace Specifies the string to be used as a substitution for the part of the alias that matched the pattern Zones TraversalZone 1 50 Name lt S 1 50 gt Assigns a name to this traversal zone Zones TraversalZone 1 50 Mode lt Assent H46018 gt Determines which H 323 traversal protocol to use either Assent or H 460 18 Zones TraversalZone 1 50 AccountName lt S 0 50 gt Specifies the account name to be used when connecting to an Assent Traversal Zone Zones TraversalZone 1 50 Gatekeeper 1 6 Address lt S 0 128 gt Specifies the IP Address or FQDN of the traversal server Up to five alternate traversal servers can also be specified Zones TraversalZone 1 50 Gatekeeper 1 6 Port lt 1 65534 gt Applies only if the system is a

TANDBERG D14172.01 Network Card User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents