Manuals / TANDBERG / Computer Equipment / Network Card

TANDBERG D14172.01 manual The Command-type root commands - xcommand, Example

Models: D14172.01

1 84

Download 84 pages 8.98 Kb

Page 29

2.4The Command-type root commands - xcommand

TANDBERG Gatekeeper/Border Controller API User Guide

2.4The 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.

<command-type root command> ?

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	OptionKeyAdd	ZoneAdd
DenyListAdd	OptionKeyDelete	ZoneDelete
OK

To list usage for all commands with parameters, type a double question mark after the command-type root command.

<command root command> ??

Example 2.11

xcommand dial ??

*h xCommand AdHocConference Registration(r): <1..3750>

*h xCommand AllowListAdd Pattern(r): <S: 1, 60>

*h xCommand AllowListDelete AllowListId(r): <1..2500>

*h xCommand Boot

*h xCommand CallTransfer Call(r): <1..900> Leg(r): <1..2> Alias(r): <S: 1, 60>

…

D14172.01

page 29 of 84

Image 29

TANDBERG D14172.01 manual The Command-type root commands - xcommand, Example

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.2 Status Documents r 1.4 The XML Documents1.4.1 Documents 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 ValueSpacepage 12 of ExampleExample 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 Examplepage 17 of ExampleExample 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 aliasXACLI 2.2.1 FormatExample XML 2.3.1 Configuration help 2.3 The Configuration-type root commands - xconfigurationExample ExampleExample 2.3.2 Configuration read2.3.3 Configuration set write 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 OKExample 2.6 Special Commands2.6.1 xfeedback Example User wants to monitor for when a zone failsWhen a problem with a zone occurs 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 SystemUnit 5 API - Status5.1 status.xml - xstatus Ethernet OptionsLDAP ResourceUsage ExternalManagerFeedback Calls GatekeeperShows the type of the call party alias Registrations Zones Zones TraversalZone 1..50 Bandwidth PerCall String Subzones Pipes LinksCalls 5.2 history.xml - xhistoryRegistrations Registration 1..255 RASAddresses Address 1..10 String Registrationspage 73 of Registrations Registration 1..255 RegistrationRejectionCause StringCallAttempt 5.3 event.xml - xeventConnected Disconnected ConnectionFailure Registration Unregistration RegistrationFailure RegistrationFailure Registration 1..3750 Gateway Prefix 1..200 String Bandwidth Locate page 84 of ResourceUsage