beautypg.com

TANDBERG Gatekeeper/Border Controller API D14172.01 User Manual

Page 2

background image

TANDBERG Gatekeeper/Border Controller API User Guide

D14172.01

page 2 of 84

Table of Contents

1

The TANDBERG API ................................................................................................................. 3

1.1

Introduction to XML..................................................................................................................... 4

1.2

Introduction to XML Path Language (XPath) .............................................................................. 6

1.3

The TANDBERG XML Engine .................................................................................................... 8

1.4

The XML Documents .................................................................................................................. 9

1.5

Introduction to TANDBERG XML API Service (TXAS).............................................................. 14

1.6

Exercises .................................................................................................................................. 19

2

The XML-based Advanced Command Line Interface........................................................... 21

2.1

XACLI ....................................................................................................................................... 21

2.2

The Status-type root commands – xstatus / xhistory................................................................ 24

2.3

The Configuration-type root commands - xconfiguration........................................................... 26

2.4

The Command-type root commands - xcommand .................................................................... 29

2.5

XML Output - xgetxml ............................................................................................................... 32

2.6

Special Commands................................................................................................................... 33

3

API - Configurations ............................................................................................................... 37

3.1

configuration.xml – xconfiguration ............................................................................................ 37

4

API - Commands ..................................................................................................................... 48

4.1

command.xml – xcommand ...................................................................................................... 48

5

API - Status ............................................................................................................................. 60

5.1

status.xml – xstatus .................................................................................................................. 60

5.2

history.xml – xhistory ................................................................................................................ 71

5.3

event.xml – xevent.................................................................................................................... 74