Cluster.locate
From Yate Documentation
(Difference between revisions)
(Created page with " '''cluster.locate''' is used to locate or allocate a resource on cluster nodes. ===Mandatory parameters=== ;nodename : name of the node requesting the operation ;callto...") |
|||
| Line 21: | Line 21: | ||
A module should acknowledge the message if the node was located or allocated. The returned text value is the node name. If the message returns false then the node was not found and was not allocated. | A module should acknowledge the message if the node was located or allocated. The returned text value is the node name. If the message returns false then the node was not found and was not allocated. | ||
| + | |||
| + | |||
| + | '''See also''' | ||
| + | |||
| + | *[[cluster.send]] | ||
Latest revision as of 18:23, 21 January 2013
cluster.locate is used to locate or allocate a resource on cluster nodes.
[edit] Mandatory parameters
- nodename
- name of the node requesting the operation
- callto
- target resource whose node is to be located
[edit] Optional
- allocate
- set to true to allocate a new node for the callto resource if it cannot be located
- billid
- billing ID of the incoming call that triggered the resource location request
- username
- user ID of the incoming call leg, if any
[edit] Return value
A module should acknowledge the message if the node was located or allocated. The returned text value is the node name. If the message returns false then the node was not found and was not allocated.
See also
