Français dropdown-ico

TANDBERG D14172.01 manuel d'utilisation

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

Aller à la page of

Les manuels d’utilisation similaires

Un bon manuel d’utilisation

Les règles imposent au revendeur l'obligation de fournir à l'acheteur, avec des marchandises, le manuel d’utilisation TANDBERG D14172.01. Le manque du manuel d’utilisation ou les informations incorrectes fournies au consommateur sont à la base d'une plainte pour non-conformité du dispositif avec le contrat. Conformément à la loi, l’inclusion du manuel d’utilisation sous une forme autre que le papier est autorisée, ce qui est souvent utilisé récemment, en incluant la forme graphique ou électronique du manuel TANDBERG D14172.01 ou les vidéos d'instruction pour les utilisateurs. La condition est son caractère lisible et compréhensible.

Qu'est ce que le manuel d’utilisation?

Le mot vient du latin "Instructio", à savoir organiser. Ainsi, le manuel d’utilisation TANDBERG D14172.01 décrit les étapes de la procédure. Le but du manuel d’utilisation est d’instruire, de faciliter le démarrage, l'utilisation de l'équipement ou l'exécution des actions spécifiques. Le manuel d’utilisation est une collection d'informations sur l'objet/service, une indice.

Malheureusement, peu d'utilisateurs prennent le temps de lire le manuel d’utilisation, et un bon manuel permet non seulement d’apprendre à connaître un certain nombre de fonctionnalités supplémentaires du dispositif acheté, mais aussi éviter la majorité des défaillances.

Donc, ce qui devrait contenir le manuel parfait?

Tout d'abord, le manuel d’utilisation TANDBERG D14172.01 devrait contenir:
- informations sur les caractéristiques techniques du dispositif TANDBERG D14172.01
- nom du fabricant et année de fabrication TANDBERG D14172.01
- instructions d'utilisation, de réglage et d’entretien de l'équipement TANDBERG D14172.01
- signes de sécurité et attestations confirmant la conformité avec les normes pertinentes

Pourquoi nous ne lisons pas les manuels d’utilisation?

Habituellement, cela est dû au manque de temps et de certitude quant à la fonctionnalité spécifique de l'équipement acheté. Malheureusement, la connexion et le démarrage TANDBERG D14172.01 ne suffisent pas. Le manuel d’utilisation contient un certain nombre de lignes directrices concernant les fonctionnalités spécifiques, la sécurité, les méthodes d'entretien (même les moyens qui doivent être utilisés), les défauts possibles TANDBERG D14172.01 et les moyens de résoudre des problèmes communs lors de l'utilisation. Enfin, le manuel contient les coordonnées du service TANDBERG en l'absence de l'efficacité des solutions proposées. Actuellement, les manuels d’utilisation sous la forme d'animations intéressantes et de vidéos pédagogiques qui sont meilleurs que la brochure, sont très populaires. Ce type de manuel permet à l'utilisateur de voir toute la vidéo d'instruction sans sauter les spécifications et les descriptions techniques compliquées TANDBERG D14172.01, comme c’est le cas pour la version papier.

Pourquoi lire le manuel d’utilisation?

Tout d'abord, il contient la réponse sur la structure, les possibilités du dispositif TANDBERG D14172.01, l'utilisation de divers accessoires et une gamme d'informations pour profiter pleinement de toutes les fonctionnalités et commodités.

Après un achat réussi de l’équipement/dispositif, prenez un moment pour vous familiariser avec toutes les parties du manuel d'utilisation TANDBERG D14172.01. À l'heure actuelle, ils sont soigneusement préparés et traduits pour qu'ils soient non seulement compréhensibles pour les utilisateurs, mais pour qu’ils remplissent leur fonction de base de l'information et d’aide.

Table des matières du manuel d’utilisation

  • Page 1

    TANDBERG Gatekeeper/Border Controller API User Guide D14172.01 July 20 08[...]

  • Page 2

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 2 of 84 Table of Contents 1 The TANDBERG API ................... ....................... ....................... ....................... ....................... .. 3 1.1 Introductio n to XML................... .................. .... ....................... ..................[...]

  • Page 3

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 3 of 84 1 The T ANDBERG API This document is a guide to the API interface of the TANDBERG Gatekeeper and Border Controller products. All rights reserved. This document contains informatio n that is proprietary to TANDBERG. No part of this publication may be reproduced, stored[...]

  • Page 4

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 4 of 84 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, b ut is prefixed with a slash ( / )[...]

  • Page 5

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 5 of 84 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: <Status> <NTP item="1" status="Active"> <Address item="1">10.0.0.2</Address> <[...]

  • Page 6

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 6 of 84 1.2 Introduction to XML Path Language (XP ath) XPath is a comprehensive la nguage to address data in XML documents. It is, howe ver, very simple to understand the basics. If you are able to specify th e path to a file on your computer, you are able to specify the path[...]

  • Page 7

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 7 of 84 Example 1.7 When using XPath it is possible to omit specifying inte rmediate 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 s[...]

  • Page 8

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 8 of 84 1.3 The TANDBERG XML Engine The TANDBERG XML engine is optimized for advanced machine-machine interaction between a TAND B ERG s ystem and an ex t ern al co nt rol a p plic at ion. The main features can be summarized as: • Structuring of information • Addr essi ng[...]

  • Page 9

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 9 of 84 monitor by using XPath. The user/con trol application can therefore limit the amount of information it recei ves f rom t he targ et s ys tem t o only th ose p a rts b eing of inter est for the give n appli cat ion. 1.4 The XML Documents 1.4.1 Documen ts The XML Data i[...]

  • Page 10

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 10 of 84 Example 1.9 The el eme nt Zone will contain dif f erent sub elements depending on the zone status: <Status> <Zones item="1"> <Zone item="2" status="Failed"> <Cause item="1">No gatekeeper reachable</Ca[...]

  • Page 11

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 11 of 84 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 EthernetSpeed ele ment i n th e ValueSpace document, showing the value domain for this configuration. <Configuration>[...]

  • Page 12

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 12 of 84 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 . <Command> &l[...]

  • Page 13

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 13 of 84 Example 1.13 The Dial command in the above example may return the following response structure: <Command> <DialResult item="1" status="OK"> <callSrc item="1">alice@example.com</callSrc> <callDst item="1&qu[...]

  • Page 14

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 14 of 84 1.5 Introduction to TANDBERG XML API Service (TXAS) TXAS is a service provided by TANDBERG un its 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 a[...]

  • Page 15

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 15 of 84 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 mus t be encoded accordingly (e.g. first lin e will be xmldoc=<then the document&[...]

  • Page 16

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 16 of 84 putxml Request URI: /putxml Request parameter: HTTP BODY as argument Putxml is like for mputxml, but use s the comp lete BODY as th e argument (i.e. the con tent of the xmldoc parameter). The Conte nt-type should be se t to either "text/xml", "applicat[...]

  • Page 17

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 17 of 84 The SOAP interface has a number of operations for dealing with Status and Configuration: GetXML Retu r ns st atus or conf igura tion infor m atio n for a s peci fie d X Pat h expres sio n. The retur ned value is an XML document. GetConfiguration Returns configuration[...]

  • Page 18

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 18 of 84 Example 1.22 The example below performs the same task as Example 1 .21 but uses GetConfiguration: <?php $client = new SoapClient('http://10.0.0.1/webservices .wsdl', array('login' => '< username >', 'passwo rd' =>[...]

  • Page 19

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 19 of 84 1.6 Exercises The exercises in this section are based on using a TANDBERG Gatekeeper and Microsoft Inter net Explorer. Some of the examples may howe ver also apply to other systems and other browsers. NOTE! Repl ace the IP addre ss 10.0.0.1 in the below examples with[...]

  • Page 20

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 20 of 84 Exercise 4 The address: http://10.0.0.1/xmlput.ssi contains an ed itor where XML data can be edited and the n posted to the system by pressing the save button. Below are examples of XML structures to be posted to the system: <Configuration> <SNMP> <Sys[...]

  • Page 21

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 21 of 84 2 The XML-based Advanced Command Line Interface The XML-based Advanced Command Line Inter face, XACLI, is a very flexible interface optimized for both machine-machine interaction and man-machine interaction. It is based on the powerful TANDBERG XML engine and offers [...]

  • Page 22

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 22 of 84 If th e ins t ance n umbe r of a gi ven el emen t is omitt ed, t he expr e ssi on addr ess es al l ins t anc es of t his element Example 2.1 To ad dr ess the Address s u b-el ement of DN S Server 2 : XPath: IP/DNS/Server[2]/Address SimplePath: IP DNS Server 2 Address[...]

  • Page 23

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 23 of 84 Request for Zone1 e lem ent w ith exp osur e op tion “-- “: 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.[...]

  • Page 24

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 24 of 84 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 c orres pon di ng X ML doc ument s. To get an overview of accessible top- level elements within a status-[...]

  • Page 25

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 25 of 84 2.2.1 Format Status information is pr esented by a mark-up notation, simila r to XML. The main differe nces are: • all br aces a re rem oved in the XA C LI for m at • XACLI does not use end-tags, except fo r a tag to mark end of the top element • XACLI does not[...]

  • Page 26

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 26 of 84 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 [...]

  • Page 27

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 27 of 84 NOTE! Only typing ? actual ly addr ess es all c onfi g urat ion el e ment s withi n the root comma nd . 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 ele[...]

  • Page 28

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 28 of 84 Example 2.9 User wants to s et IP address: ip address: "10.0.0.1" or ip/address: "10.0.0.1"[...]

  • Page 29

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 29 of 84 2.4 The Command-type root commands - xcommand To get an overview of the supported commands within a command- type root command, t ype ? or help after the command-type root command. <command-type root command> ? Example 2.10 xcommand ? - User Commands - AdHocCon[...]

  • Page 30

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 30 of 84 2.4.1 Command help To get help on a specific command, type the command-type root command, followed by a command name, follow ed by ? or help: <command-type root command> <command name> ? Example 2.12 xcommand Dial ? xcomm dial ? *h xCommand Dial callSrc(r[...]

  • Page 31

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 31 of 84 Sequence notation <command-type root command> <command> <value> <value> ... 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 combi[...]

  • Page 32

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 32 of 84 2.5 XML Output - xgetxml As an alternative to the standard XACLI ou tput format, XML format is sup ported through the root command xg etxm l . xgetxml ta kes an XPath exp ression as parameter and the elements (or complete document) matching the expressio n will be re[...]

  • Page 33

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 33 of 84 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 w here they are issued. This lets the user/control application individually configure the sess io[...]

  • Page 34

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 34 of 84 Alias 2 (type=E164, origin=Endpoint): "44118 4960001" *s/end Example 2.21 User wants to mo nitor for when a zone fails: xfeedback register status/zones/zone[@status="Failed" ] OK When a problem w ith a zone occurs: *s Zones: Zone 1 (status=Failed)[...]

  • Page 35

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 35 of 84 2.6.2 xprefer ences The special command xpreferen ces lets the user/control applica tion individually configure the Telnet/RS-232 session in use. xpreferences ? usage: xpreferences xpathwrite <on/off> or: xpreferences detaillevel <1..2> or: xpreferences x[...]

  • Page 36

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 36 of 84 xpreferences xmlstatusfeedback <on/off> 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): Address: "10.0.0.2" Port: 12[...]

  • Page 37

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 37 of 84 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 N[...]

  • Page 38

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 38 of 84 IP DNS Server [1..5] Address: <S: 0, 39> Sets the IP Address of up to 5 DNS servers to be queried when resolving domain names. IP DNS Domain Name: <S: 0, 128> Specifies the name to be appended to the host name before a query to the DNS server is executed.[...]

  • Page 39

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 39 of 84 SSH Mode: <On/Off> 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: <On/Off> Determines whether the system can be accessed via the web server over HTTP. Note : You[...]

  • Page 40

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 40 of 84 Gatekeeper ForwardLocationRequests: <On/Off> 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: th e request wil[...]

  • Page 41

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 41 of 84 Gatekeeper Downspeed PerCall Mode: <On/Off> Determines whether or not the system will attemp t to d ownspeed a call if there is insufficient per-call band width ava ilable to fu lfill the re quest. On : the syste m will a ttempt to pl ace the call at a lower ba[...]

  • Page 42

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 42 of 84 Traversal UDPProbe RetryCount: <1..65534> (Appl ies only if the s ystem is a Bord er Co nt rol ler. ) Spec ifie s the nu mber of at t empt s at re- establishing a failed UDP channel. Traversal UDPProbe KeepAliveInterval: <1..65534> (Appl ies only if the s[...]

  • Page 43

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 43 of 84 Authentication Database: <LocalDatabase/LDAPDatabase> Selects between a local database and a remote LDAP repository for the storage of password information for authentication . Authentication LDAP BaseDN: <S: 0, 255> Specifies the Distinguished Name to us[...]

  • Page 44

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 44 of 84 Zones Zone [1..100] Match [1..5] Pattern Type: <Prefi x/Suffix/Regex> (Applies only if the Match mode is Pattern Match.) Determines the way in which th e string must match the alias. Prefix: the string must appear at the be ginning of the alias. Suffix: the str[...]

  • Page 45

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 45 of 84 Zones TraversalZone [1..50] Match [1..5] Pattern Type : <Prefix/Suffix/Regex> (Applies only if the Match mode is Pattern Match.) Determines the way in which th e string must match the alias. Prefix: the string must appear at the beginning of the alias. Suffix: [...]

  • Page 46

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 46 of 84 SubZones TraversalSubZone Bandwidth PerCall Mode: <No ne/Limited/Unlimited> Determines whether there is a limit on the bandwidth of any one traversal call being handled by the system. SubZones TraversalSubZone Bandwidth PerCall Limit: <1 ..100000000> Spec[...]

  • Page 47

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 47 of 84 Pipes Pipe [1..100] Bandwidth Total Limit: <1..100000 000> If this pipe has limited bandwidth, sets the maximu m bandwidth (in kbps) available at any one time on the pipe. Pipes Pipe [1..100] Bandwidth PerCall Mode: <None/Lim ited/Unlimited> Determines wh[...]

  • Page 48

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 48 of 84 4 API - Commands This se ction g ives an overview of th e suppo rted syste m Comma nds. All examples are presented using the standard XACLI format. 4.1 command.xml – xcom mand AdHocConference Transfers all calls for the specified endpoint to the config ured ad hoc [...]

  • Page 49

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 49 of 84 Band widt h ( r ): < 1..1 00 0000 00> The requested bandwidth of the call (in kbps). CallType(r): <Traversal/Routed/Direct> Whether the call type is Traversal, Routed or Direct. CredentialAdd Adds an entry to the local au thentication database. Cred en t [...]

  • Page 50

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 50 of 84 EncryptionType: <DES/AES-128/Auto> The t ype of encr y pti on that will be us e d for the c all. DisconnectCall Dis c onnec ts a c all. Call: <1 ..900> The index of the call to be disconnected.. CallS erial Numbe r: <S: 0, 255> The serial number of [...]

  • Page 51

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 51 of 84 Locate Runs the system's lo cation algorithm to loca te the endpoint id entified by the given alias, searching locally , on neighb ors, and on systems discovere d through th e DNS sy stem, with in the specified number of 'hops'. Results are reported ba[...]

  • Page 52

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 52 of 84 RegistrationSerialNumber: <S: 0, 255> The serial number of the registration to be removed. SubZoneAdd Adds and configures a new subzone. SubZoneName(r): <S: 1, 5 0> Assigns a name to this subzone. Address1: <S: 0, 39> Specifies an IP Address used (i[...]

  • Page 53

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 53 of 84 PerCallIntraMode: <None/Limited/Unlimited > Determines whether there is a limit on the bandwidth for any one call between two endpo i nts wit hin t his s ubzone. PerC al l I n t r a: < 1. .1000 0 0 0 00 > Specifies the bandwidth limit (in kbps) f or any o[...]

  • Page 54

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 54 of 84 Gatekeeper2Address: <S: 1, 128> Specifies the IP Address or FQDN of the traversal server. Up to five alternate traversal servers ca n also be specifi ed. Gatekeeper2Port: <1..65534> (Applies only if the system is a Gatekeeper.) Specifies the port on the t[...]

  • Page 55

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 55 of 84 Match1PatternRe place: <S: 0, 60> (Applies only if the Pattern Beha vior is Replace.) Specifies the string to be used as a substitution for the part of the alias that ma tched the pattern. Match2Mode: <AlwaysMatch/PatternMatch/Disabled> Determines if and [...]

  • Page 56

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 56 of 84 Match4PatternType : <Prefix/Suffix/Regex> (Applies only if the Match mode is Pattern Match.) Determines the way in which th e string must match the alias. Prefix: the string must appear at the beginning of the alias. Suffix: the strin g must appear at the end o[...]

  • Page 57

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 57 of 84 Gatekeeper2Port: <1..65534> Specifies the port on the neighbor to be use d. Gatekeeper3Address: <S: 1, 128> Spec if ies t he IP Addr e ss or F QDN of this nei g hbor. Gatekeeper3Port: <1..65534> Specifies the port on the neighbor to be use d. Gateke[...]

  • Page 58

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 58 of 84 Matc h2 Patt ern Str ing : <S : 0, 6 0> (Applies only if the Match mode is Pattern Match.) Specifies the p attern against which the alias is compared. Match2PatternType : <Prefix/Suffix/Regex> (Applies only if the Match mode is Pattern Match.) Determines [...]

  • Page 59

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 59 of 84 Match4PatternBeha vior: <S tr ip/Leave/Rep lace> (Applies only if the Match mode is Pattern Match.) Determines whether the matched part of the alias should be modified before an LRQ is sen t to this zone. Lea ve: the alias will be unmodified. Strip: the matchin[...]

  • Page 60

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 60 of 84 5 API - S t atus This section gives an overview of the Status Information available in t he St atus X ML documents (status.xml / histo ry.xml / e vent.xml) and the Sta tus root comma nds (xstatus / xhi story) of the XACLI interface. All examples are presented using t[...]

  • Page 61

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 61 of 84 SystemUnit Software Configuration TraversalCalls: <Int eger> Show s the syste ms trave rsal cal l capacit y. SystemUnit Software Configuration Registrations: <Int eger> Shows the systems registratio n capacity. SystemUnit Software Configuration Encryption[...]

  • Page 62

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 62 of 84 IP IPv6 Gateway: <IPv4Addr> Shows the IPv6 address of the de fault gateway. On ly present if the Protocol is IPv6 or Both. IP DNS Server [1..5] Address: <String> Shows the IP address of a configured DNS server. IP DNS Domain Name: <IPv4Addr> Shows t[...]

  • Page 63

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 63 of 84 ExternalManager ExternalManager [status = <Inactive/Active/Failed>] Shows the status of the connection to the external manager. ExternalManager Cause: <String> Shows an error reason for a failure to connect to the e xternal manager. Only present if the ex[...]

  • Page 64

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 64 of 84 ResourceUsage TotalNonTraversalCalls: <Integer> Shows the total number of non traversal calls that have been placed o n the system. Only present if the system is a Gatekeeper. ResourceUsage TraversalCalls: <Integer> Sho ws the c urre nt num ber of tr av e[...]

  • Page 65

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 65 of 84 Calls Call [1..900] Leg [1..2] RegistrationID: <Strin g> Shows the registration ID of the ca ll party if it is locally register ed. Calls Call [1..900] Leg [1..2] SerialNumber: <String> Sho ws the s eria l numb er of the c all pa rty r eg ist ra tion. Onl[...]

  • Page 66

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 66 of 84 Registrations Registrations Registration [1..3750] CallSignalAddress es Address [1..10]: <String> Shows the IP address and port to use for call signaling. Registrations Registration [1..3750] RASAddresses Add ress [1..10]: <String> Shows the IP address an[...]

  • Page 67

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 67 of 84 Zones Zones DefaultZone Calls Call [1..900]: <Integer> Shows the index of a call i n the Defau lt Zone . Zones DefaultZone Bandwidth Total: <String> Shows the total bandwidth in kbps allowed in th e Default Zone. Zones DefaultZone Bandwidth PerCall: <S[...]

  • Page 68

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 68 of 84 Zones TraversalZone [1..50] Bandwidth PerCall: <String > Shows the bandwidth in kbps allow ed per call in the traversal zone. Zones TraversalZone [1..50] Bandwidth Used: <String> Sho ws the b a ndwid th in k bps being us ed in t he t r aver sal z one. Zon[...]

  • Page 69

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 69 of 84 Subzones SubZones DefaultSubZone Registrations Registration [1 ..3750]: <Integer> Shows the index of a registration in the Default SubZo ne. SubZones DefaultSubZone Calls Call [1..900]: <Integer > Shows the index of a call in the Default SubZone. SubZones[...]

  • Page 70

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 70 of 84 Links Links Link [1..100] Name: <Integer> Shows the name of the link. Links Link [1..100] Calls Call [1..900]: <Integer> Shows the index of a call usin g the link. Links Link [1..100] Bandwidth Total: <String> Shows the total bandwidth in kbps allow[...]

  • Page 71

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 71 of 84 5.2 history.xml – xhistory Calls Calls Call [1..255] SerialNumber: <String> Shows the unique serial number of the call. Calls Call [1..255] State: <Disconnected/ConnectionFa iled> Shows the state of the call. Calls Call [1..255] CallType: <Traversal/[...]

  • Page 72

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 72 of 84 Registrations Registrations Registration [1..255] CallSignalAddresse s Address [1..10]: <String> Shows the IP address and port used for call signaling. Registrations Registration [1..255] RASAddresses Addre ss [1..10]: <String> Shows the IP address and po[...]

  • Page 73

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 73 of 84 Registrations Registration [1..255] RegistrationRejec tionCause: <String> Sho ws the ca use f or th e regis trat ion b ei ng rej ect ed. On ly pres ent if the r eason i s Regi strat ion Rejec ted. Registrations Registration [1..255] RegistrationRejec tionDescri[...]

  • Page 74

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 74 of 84 5.3 event.xml – xevent CallAttempt CallAttempt Call [1..900] SerialNumber: <String> Shows the unique serial number of the call. CallAttempt Call [1..900] State: <Initializing> Shows the state of the call. CallAttempt Call [1..900] CallType: <Traversa[...]

  • Page 75

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 75 of 84 CallAttempt Call [1..900] Duration: <String> Shows the duration of the call in secon ds. CallAttempt Call [1..900] SourceAlias: <String> Show s the alia s of the source call party. CallAttempt Call [1..900] SourceAddress: <String> Shows the IP addre[...]

  • Page 76

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 76 of 84 Connected Call [1..900] Leg [1..2] Address: <String> Shows the IP address and port of the call par ty. Connected Call [1..900] Leg [1..2] Encryption [status = <On/Off>] Shows the status of encryptio n on the call leg. Connected Call [1..900] Leg [1..2] En[...]

  • Page 77

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 77 of 84 Disconnected Call [1..900] StartTime: <String> Shows the time at which the call was initiate d. Disconnected Call [1..900] Duration: <String> Shows the duration of the call in secon ds. Disconnected Call [1..900] DisconnectCauseValue: <Str ing> Show[...]

  • Page 78

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 78 of 84 ConnectionFailure Call [1..900] StartTime: <String> Shows the time at which the call was initiate d. ConnectionFailure Call [1..900] Duration: <String> Shows the duration of the call in secon ds. ConnectionFailure Call [1..900] DisconnectCauseValue: <S[...]

  • Page 79

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 79 of 84 Registration Registration [1..3750] MCU Prefix [1..20 0]: <String> Shows the prefix of a registered MCU service. Only present if the registration is an MCU. Registration Registration [1..3750] OutOfResources: < On/Off> Shows the resource usage of a gatewa[...]

  • Page 80

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 80 of 84 Unregistration Registration [1..3750] MCU: Shows that the registration was an MCU. Only present if the registration was an MCU. Unregistration Registration [1..3750] MCU Prefix [1.. 200]: <String> Shows the prefix of a registered MCU service. Only present if th[...]

  • Page 81

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 81 of 84 RegistrationFailure Registration [1..3750] Gateway Pre fix [1..200]: <String> 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 MC[...]

  • Page 82

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 82 of 84 Band widt h Bandwidth Call [1..900] SerialNumber: <String> Shows the unique serial number of the call. Bandwidth Call [1..900] State: <Unknown/Connecting/Con nected/Disconnected /ConnectionFailed/Parked/Parking/Unparking/ParkFailed > Shows the state of th[...]

  • Page 83

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 83 of 84 Bandwidth Call [1..900] Duration: <String> Shows the duration of the call in secon ds. Bandwidth Call [1..900] SourceAlias: <String> Show s the alia s of the source call party. Bandwidth Call [1..900] SourceAddress: <String> Shows the IP address and[...]

  • Page 84

    TANDBER G Gatekee per/Bord er Contro l ler API Us er Guide D14172.01 page 84 of 84 ResourceUsage ResourceUsage Registrations: <Integer> Show s the curren t number o f registra tions on the system. ResourceUsage MaxRegistrations: <Integer> Sho ws the m a ximu m num ber of conc urren t regi str ati ons on t he sy ste m . ResourceUsage Non[...]