LocalLB::MessageRoutingSIPRoute¶
Introduced : BIG-IP_v11.6.0
The MessageRoutingSIPRoute interface specifies the static routes to
use for SIP message routing. A route specifies an ordered list of
peers to use for forwarding messages. See LocalLB::MessageRoutingPeer
for more details.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified SIP routes. | BIG-IP_v11.6.0 |
| delete_all_sip_routes | Deletes all SIP routes. | BIG-IP_v11.6.0 |
| delete_sip_route | Deletes the specified list of SIP routes. | BIG-IP_v11.6.0 |
| get_description | Gets the descriptions for a set of SIP routes. | BIG-IP_v11.6.0 |
| get_from_uri | Gets the patterns to be matched against the From field of a SIP message. | BIG-IP_v11.6.0 |
| get_list | Gets a list of all SIP routes. | BIG-IP_v11.6.0 |
| get_peer | Gets the list of message routing peers for the specified SIP routes. Peers are responsible for forwarding messages. See LocalLB::MessageRoutingPeer for more details about peers. See LocalLB::SelectionMode for more details about how the mode determines peer selection. | BIG-IP_v11.6.0 |
| get_request_uri | Gets the patterns to be matched against the request-uri field of a SIP message. | BIG-IP_v11.6.0 |
| get_selection_mode | Gets the modes of selecting a peer from a list of peers. See LocalLB::SelectionMode for more details. | BIG-IP_v11.6.0 |
| get_to_uri | Gets the patterns to be matched against the To field of a SIP message. | BIG-IP_v11.6.0 |
| get_version | Get the version information for this interface. | BIG-IP_v11.6.0 |
| get_virtual_server | Gets the virtual servers on which connections will be routed to the specified SIP routes. | BIG-IP_v11.6.0 |
| replace_peer | Replace the peer list associated with the specified SIP route with the specified list of peers. Peers are responsible for forwarding messages. See LocalLB::MessageRoutingPeer for more details about peers. See LocalLB::SelectionMode for more details about how the mode determines peer selection. | BIG-IP_v11.6.0 |
| set_description | Sets the description for a set of SIP routes. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.6.0 |
| set_from_uri | Sets the patterns to be matched against the From field of a SIP message. This URI will be matched as a case insignificant method. It should be in the form of user@domain. The “sip:” prefix should not be present. Any additional modifiers (for example port or transport) should also not be present. It may begin with a wildcard, “*”. If empty, it will be treated as if the entire URI was a wildcard (matching all From-URIs). | BIG-IP_v11.6.0 |
| set_request_uri | Sets the patterns to be matched against the request-uri field of a SIP message. This URI will be matched as a case insensitive method. It should be in the form of user@domain. The “sip:” prefix should not be present. Any additional modifiers (for example port or transport) should also not be present. It may begin with a wildcard, “*”. If empty, it will be treated as if the entire URI was a wildcard (matching all Request-URIs). | BIG-IP_v11.6.0 |
| set_selection_mode | Sets the modes of selecting a peer from a list of peers. See LocalLB::SelectionMode for more details. | BIG-IP_v11.6.0 |
| set_to_uri | Sets the patterns to be matched against the To field of a SIP message. This URI will be matched as a case insensitive method. It should be in the form of user@domain. The “sip:” prefix should not be present. Any additional modifiers (for example port or transport) should also not be present. It may begin with a wildcard, “*”. If empty, it will be treated as if the entire URI was a wildcard (matching all To-URIs). | BIG-IP_v11.6.0 |
| set_virtual_server | Sets the virtual servers on which connections will be routed to the specified SIP routes. If the virtual server is unset, messages originating on any connection may be routed to the SIP routes. | BIG-IP_v11.6.0 |
Enumerations¶
| Enumeration | Description |
| SelectionMode | A list of SIP route selection modes for selecting a peer from a list of peers. |
Aliases¶
| Alias | Type | Description |
| SelectionModeSequence | SelectionMode [] | A sequence of SIP route selection modes. |
| SelectionModeSequenceSequence | SelectionMode [] [] | A sequence of sequences of SIP route selection modes. |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.