TANDBERG Gatekeeper/Border Controller API D14172.01 - Manual (Page 30)

TANDBERG Gatekeeper/Border Controller API User 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, followed by ? or help:
?
Example 2.12
xcommand Dial ?
xcomm dial ?
*h xCommand Dial
callSrc(r):
callDst(r):
Bandwidth: <1..100000000>
EncryptionMode:
EncryptionType:
OK
NOTE! Required parameters are identified by an “(r)" behind the parameter name.
2.4.2 Issuing a command
A command must start with a command-type root command, followed by a command name, followed
by a set of parameters. Parameters values can either be specified by a mark-up notation or by placing
the parameter values in the sequence specified by the help text – or a combination of these methods.
Markup notation
...
When using this notation, the sequence in which the parameters are entered is not essential:
Example 2.13
xcommand dial Bandwidth:384 callDst:bob callSrc:alice
Abbreviations can be used for the parameter names as long as the parameter names are unique
within the command:
Example 2.14
xcommand dial B:384 callD:bob callS:alice