TANDBERG Gatekeeper/Border Controller API User Guide
D14172.01
page 51 of 84
Locate
Runs the system's location algorithm to locate the endpoint identified by the given alias,
searching locally, on neighbors, and on systems discovered through the DNS system, within
the specified number of 'hops'. Results are reported back through the xFeedback
mechanism, which must therefore be activated before issuing this command (e.g. xFeedback
register event/locate).
Alias(r): <S: 1, 60>
The alias associated with the endpoint you wish to locate.
HopCount(r): <0..255>
The hop count to be used in the search.
OptionKeyAdd
Adds a new option key to the system.
Key(r): <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.
OptionKeyDelete
Deletes a software option key from the system.
OptionKeyId(r): <1..64>
Specifies the ID of the software option to be deleted.
PipeAdd
Adds and configures a new pipe.
PipeName(r): <S: 1, 50>
Assigns a name to this pipe.
TotalMode: <None/Limited/Unlimited>
Determines whether or not this pipe is enforcing total bandwidth restrictions. None: no
bandwidth available.
Total: <1..100000000>
If this pipe has limited bandwidth, sets the maximum bandwidth (in kbps) available at
any one time on the pipe.
PerCallMode: <None/Limited/Unlimited>
Determines whether or not this pipe is limiting the bandwidth of individual calls. None:
no bandwidth available.
PerCall: <1..100000000>
If this pipe has limited per-call bandwidth, sets the maximum amount of bandwidth (in
kbps) available for any one call.
PipeDelete
Deletes a pipe.
PipeId(r): <1..100>
The index of the pipe to be deleted.
RemoveRegistration
Removes a registration from the system.
Registration: <1..3750>
The index number of the registration to be removed.
