Manuals / TANDBERG / Computer Equipment / Network Card

TANDBERG D14172.01 manual API - Configurations, configuration.xml - xconfiguration

Models: D14172.01

1 84

Download 84 pages 8.98 Kb

Page 37

3 API - Configurations

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.1configuration.xml – xconfiguration

SystemUnit Name: <S: 0, 50>

Defines the name of the system. Choose a name that uniquely identifies the system.

SystemUnit Password: <S: 0, 16>

Defines the password of the system. The password is used to login with Telnet, HTTP(S), SSH, SCP, and on the serial port.

Option [1..64] Key: <S: 0, 90>

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: <Auto/10half/10full/100half/100full>

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: <Both/IPv4/IPv6>

Selects whether the system is operating in IPv4, IPv6 or dual stack mode.

Note: You must restart the system for any changes to take effect.

IP Address: <IPAddr>

Specifies the IPv4 address of the system.

Note: You must restart the system for any changes to take effect.

IP SubnetMask: <IPAddr>

Specifies the IPv4 subnet mask of the system.

Note: You must restart the system for any changes to take effect.

IP Gateway: <IPAddr>

Specifies the IPv4 gateway of the system.

Note: You must restart the system for any changes to take effect.

IP V6 Address: <S: 0, 39>

Specifies the IPv6 address of the system.

Note: You must restart the system for any changes to take effect.

IP V6 Gateway: <S: 0, 39>

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

Image 37

TANDBERG D14172.01 manual API - Configurations, configuration.xml - xconfiguration

Contents

D14172.01 July TANDBERG Gatekeeper/Border Controller API User GuideThe XML-based Advanced Command Line Interface Table of ContentsAPI - Configurations API - CommandsDisclaimer 1 The TANDBERG APIExample 1.1 Introduction to XMLSNMP Configuration Mode item=1On/ModeExample DNS IP ConfigurationStatus NTP StatusExample 1.2 Introduction to XML Path Language XPathExample Example Using the “double slash syntax this can be simplified toExample 1.3 The TANDBERG XML Engine 1.3.2 Addressing using XPath1.3.1 Structuring of Information 1.3.3 Feedback1.4.1 Documents 1.4 The XML Documents1.4.2 Status Documents r Example 1.4.3 Configuration documents rwStatus Zones item=1 Zone item=2 status=Failed Gatekeeper item=1 status=FailedEthernet Configuration 1.4.4 Command documents wExample ValueSpaceExample Examplepage 12 of Example DialResult item=1 status=Error Cause item=189/CauseExample page 13 of1.5.1 Bare-bone HTTPS access 1.5 Introduction to TANDBERG XML API Service TXASgetxml formputxmlExample The new configuration value can be confirmed using the getxml requestExample putxml 1.5.2 SOAPhttp//10.0.0.1/webservices.wsdl ExampleExample Examplepage 17 of Example ExampleExample page 18 ofExercise 1.6 ExercisesExercise Exercisepage 20 of Exercise2.1.1 Accessing XACLI 2 The XML-based Advanced Command Line Interface2.1.2 Root commands XACLI root commandSupported exposure options 2.1.4 Exposure optionsxstatus zones zone Examplexstatus zones zone 2.1.5 MiscTANDBERG Gatekeeper/Border Controller API User Guide D14172.01xstatus ? 2.2 The Status-type root commands - xstatus / xhistoryOK xhistory ? - History xstatus registrations registration 1 aliases aliasExample XML 2.2.1 FormatXACLI 2.3.1 Configuration help 2.3 The Configuration-type root commands - xconfigurationExample Example2.3.3 Configuration set write 2.3.2 Configuration readExample User wants to set IP address Exampleip address ip/addressExample 2.4 The Command-type root commands - xcommandExample 2.4.2 Issuing a command 2.4.1 Command helpMarkup notation ExampleSequence notation Command responseCombination ExampleExample 2.5 XML Output - xgetxmlxgetxml status/ntp Status NTP Status OK2.6.1 xfeedback 2.6 Special CommandsExample When a problem with a zone occurs User wants to monitor for when a zone failsExample 2.6.2 xpreferences xpreferences xmlconfigfeedback on/offxpreferences xpathwrite on/off xpreferences detaillevelxpreferences xmlstatusfeedback on/off xpreferences xmlcommandresult on/offExample XACLI-format3.1 configuration.xml - xconfiguration 3 API - ConfigurationsIP DNS Server 1..5 Address S 0 SSH Mode On/Off Specifies a DNS domain to use when attempting ENUM resolution Specifies the pattern against which the alias is compared Determines whether or not to enforce authentication for registrations Defines the name for this entry in the local authentication database Zones Zone 1..100 Match 1..5 Pattern Type Prefix/Suffix/Regex Zones TraversalZone 1..50 Match 1..5 Pattern Type Prefix/Suffix/Regex Assigns a name to this subzone Assigns a name to this link 4.1 command.xml - xcommand 4 API - Commandspage 49 of page 50 of page 51 of page 52 of page 53 of page 54 of page 55 of page 56 of page 57 of page 58 of page 59 of 5.1 status.xml - xstatus 5 API - StatusSystemUnit Ethernet OptionsLDAP Feedback ExternalManagerResourceUsage Calls GatekeeperShows the type of the call party alias Registrations Zones Zones TraversalZone 1..50 Bandwidth PerCall String Subzones Pipes LinksCalls 5.2 history.xml - xhistoryRegistrations Registration 1..255 RASAddresses Address 1..10 String Registrationspage 73 of Registrations Registration 1..255 RegistrationRejectionCause StringCallAttempt 5.3 event.xml - xeventConnected Disconnected ConnectionFailure Registration Unregistration RegistrationFailure RegistrationFailure Registration 1..3750 Gateway Prefix 1..200 String Bandwidth Locate page 84 of ResourceUsage