TANDBERG D14172.01 manual API Commands, Command.xml xcommand

Page 48

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.1command.xml – xcommand

AdHocConference

Transfers all calls for the specified endpoint to the configured ad hoc conference.

Registration(r): <1..3750>

The index of the registration to be transferred.

AllowListAdd

Adds an entry to the Allow List.

Pattern(r): <S: 1, 60>

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 entry from the Allow List.

AllowListId(r): <1..2500>

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): <1..900>

The index of the call to be transferred.

Leg(r): <1..2>

The index of the call leg to be transferred.

Alias(r): <S: 1, 60>

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): <S: 1, 50>

The subzone or zone from which the call originates.

Node2(r): <S: 1, 50>

The subzone or zone at which the call terminates.

D14172.01

page 48 of 84

Image 48
Contents Tandberg Table of Contents Tandberg API Mode item=1On/Mode ConfigurationIntroduction to XML Status NTP item=1 status=Inactive/ /StatusDomain item=1 DNS Configuration StatusNTP Status Server item=2Configuration/SNMP Configuration/SNMP/CommunityNameConfiguration/IP/DNS/Server2/Address Configuration/IP/DNS/Server/AddressStatus/Registrations/Registration/Aliases/Alias Status//AliasStatus/Zones/Zone@status=Failed/Name Addressing using XPath Tandberg XML EngineStructuring of Information FeedbackXML Documents DocumentsStatus Documents r Configuration documents rw Status Zones item=1 Zone item=2 status=FailedGatekeeper item=1 status=Failed Bandwidth Zone Zones Status Zones item=1Command documents w EthernetSpeed ValueSpaceCommand Dial item=1 Dial CommandCommand DialResult item=1 status=OK Introduction to Tandberg XML API Service Txas Bare-bone Https accessSystemUnit item=1 Success Configuration DialResult CommandSoap ?php$client-Dial arraycallSrc = Alice, callDst = Bob ? GetConfiguration GetConfigurationXMLSetConfiguration SetConfigurationXMLExample Exercises ExerciseSystemContactAdministrator/SystemContact Snmp NTPAccessing Xacli Root commandsAddressing ElemName item elemName itemRoot command address expression exposure option Exposure optionsZones Zone 1 status=Active Misc Zones Zone 1 status=Active *s/endStatus-type root commands xstatus / xhistory LastUpdate 2008-01-01 LastCorrection 1 *s/end FormatConfiguration-type root commands xconfiguration Configuration helpConfiguration read Configuration set writeConfiguration-type root command address expr Configuration-type root command address expr valueIp address Ip/address Command-type root commands xcommand Command-type root command ?Command root command ?? Xcommand dial ??Command help Issuing a commandCommand-type root command command name ? Xcommand dial Bandwidth384 callDstbob callSrcaliceCommand-type root command command value value Xcommand dial alice bobXcommand dial alice B384 bob XML Output xgetxml Xgetxml status/ntp StatusSpecial Commands XfeedbackAliases Alias 2 type=E164, origin=Endpoint Xfeedback register status/zones/zone@status=FailedZones Zone 1 status=Failed Cause No gatekeeper reachable Snmp SystemContact Administrator SystemContact item=1Administrator/SystemContactXpreferences Xcommand dial alice bob Command DialResult item=1 status=OK Xpreferences xmlstatusfeedback on/offConfiguration.xml xconfiguration SystemUnit Password S 0SystemUnit Name S 0 Option 1..64 Key S 0Ldap Password S 0 Snmp Mode On/OffSession TimeOut Telnet Mode On/OffSSH Mode On/Off Http Mode On/OffHttps Mode On/Off ExternalManager Address S 0Gatekeeper DNSResolution Mode On/Off Gatekeeper Enum Mode On/OffGatekeeper Policy Mode On/Off Gatekeeper ForwardLocationRequests On/OffGatekeeper Downspeed PerCall Mode On/Off Gatekeeper Downspeed Total Mode On/OffGatekeeper Unregistered Caller Mode On/Off Gatekeeper Unregistered Caller Fallback S 0Traversal AssentEnabled On/Off Traversal H46018Enabled On/OffAuthentication Mode On/Off Authentication UserName S 0Authentication Database LocalDatabase/LDAPDatabase Authentication Ldap BaseDN S 0Authentication Ldap AliasOrigin LDAP/Endpoint/Combined Authentication Credential 1..2500 Name S 0Zones TraversalZone 1..50 Mode Assent/H46018 Zones Zone 1..100 Match 1..5 Pattern Replace S 0Zones TraversalZone 1..50 Name S 1 Zones TraversalZone 1..50 AccountName S 0SubZones DefaultSubZone Bandwidth Total Limit SubZones DefaultSubZone Bandwidth PerCall Inter LimitSubZones DefaultSubZone Bandwidth PerCall Intra Limit Zones TraversalZone 1..50 Match 1..5 Pattern Replace S 0SubZones TraversalSubZone Bandwidth PerCall Limit SubZones SubZone 1..100 Name S 1SubZones SubZone 1..100 Bandwidth Total Limit SubZones SubZone 1..100 Bandwidth PerCall Inter LimitServices CallTransfer Mode On/Off Services AdHocConferencing Mode On/OffServices AdHocConferencing ID S 3 Services AdHocConferencing Prefix S 0API Commands Command.xml xcommandAdds an entry to the Deny List Patternr S 1 Deletes a link LinkIdr Index of the link to be deleted Deletes a pipe PipeIdr Index of the pipe to be deleted SubZoneAdd SubZoneDelete Tandberg Gatekeeper/Border Controller API User Guide Tandberg Gatekeeper/Border Controller API User Guide ZoneAdd Tandberg Gatekeeper/Border Controller API User Guide Tandberg Gatekeeper/Border Controller API User Guide ZoneDelete Status.xml xstatus SystemUnitOptions EthernetNTP LastUpdate String IP IPv6 Gateway IPv4AddrIP DNS Server 1..5 Address String IP DNS Domain Name IPv4AddrExternalManager ResourceUsageGatekeeper CallsCalls Call 1..900 Leg 1..2 RegistrationID String Calls Call 1..900 Leg 1..2 SerialNumber StringCalls Call 1..900 Leg 1..2 Alias String Calls Call 1..900 Leg 1..2 Address StringRegistrations Zones Zones TraversalZone 1..50 Bandwidth PerCall String Zones TraversalZone 1..50 Bandwidth Used StringZones Zone 1..50 status = Warning/Active/Failed Zones Zone 1..50 Cause StringSubzones Links PipesHistory.xml xhistory Registrations Registration 1..255 Endpoint Registrations Registration 1..255 GatekeeperRegistrations Registration 1..255 Gateway Registrations Registration 1..255 MCUTandberg Gatekeeper/Border Controller API User Guide Event.xml xevent CallAttemptConnected Disconnected ConnectionFailure Registration Unregistration RegistrationFailure RegistrationFailure Registration 1..3750 MCU RegistrationFailure Registration 1..3750 SubZone StringRegistrationFailure Registration 1..3750 StartTime String RegistrationFailure Registration 1..3750 EndTime StringBandwidth Locate ResourceUsage

D14172.01 specifications

The TANDBERG D14172.01 is a sophisticated video conferencing solution designed to enhance communication for businesses and organizations. Renowned for its reliability and advanced features, the D14172.01 facilitates seamless interactions across different locations, promoting effective collaboration among teams.

One of the main features of the TANDBERG D14172.01 is its exceptional video quality. With high-definition resolution, it delivers crystal-clear visuals, making virtual meetings feel more personal and engaging. The system supports a wide range of codecs, ensuring compatibility with various devices and platforms, thereby streamlining the integration process into existing communication setups.

Another significant characteristic of the D14172.01 is its user-friendly interface. Designed with simplicity in mind, it allows users to initiate and manage video calls effortlessly. The intuitive controls enable both tech-savvy individuals and those less familiar with technology to navigate the system with ease, reducing the learning curve and enhancing user adoption.

The inclusion of advanced audio technologies further elevates the user experience. With noise suppression features and high-fidelity microphones, the TANDBERG D14172.01 ensures that participants can hear and be heard clearly, minimizing disruptions and allowing for more productive conversations. This feature is particularly beneficial in larger meeting rooms where background noise can be a concern.

Flexibility is another hallmark of the D14172.01. It supports multiple connectivity options, including Wi-Fi, Ethernet, and Bluetooth, enabling users to connect from virtually anywhere. This versatility is essential in today’s hybrid work environments, where team members may be working remotely or on-the-go.

Importantly, the system boasts robust security features, safeguarding sensitive information exchanged during video conferences. With encryption protocols and secure access controls, organizations can confidently communicate without the fear of privacy breaches.

In summary, the TANDBERG D14172.01 stands out in the realm of video conferencing solutions due to its high-definition video quality, user-friendly interface, advanced audio technologies, connectivity options, and strong security measures. These features make it an invaluable tool for businesses seeking to enhance their communication capabilities and foster greater collaboration among their teams, regardless of geographical barriers. With the D14172.01, organizations can significantly improve their virtual meeting experiences, driving productivity and innovation in an increasingly digital world.