LocalLB::ProfileSIPRouter¶
Introduced : BIG-IP_v11.6.0
The ProfileSIPRouter interface configures the router instance for
message routing SIP (Router Initiation Protocol) processing. It&aposs
used to define the set of static routes across the router instance.
See LocalLB::MessageRoutingSIPRoute for more details about static
routes.
Methods¶
| Method | Description | Introduced |
| add_sip_route | Adds the specified SIP routes to the specified SIPRouter profiles. See LocalLB::MessageRoutingSIPRoute for more details about SIP static routes. | BIG-IP_v11.6.0 |
| create | Creates the specified SIPRouter profiles. | BIG-IP_v11.6.0 |
| delete_all_profiles | Deletes all SIPRouter profiles. | BIG-IP_v11.6.0 |
| delete_profile | Deletes the specified SIPRouter profiles. | BIG-IP_v11.6.0 |
| get_all_statistics | Gets the statistics for all SIPRouter profiles. | BIG-IP_v11.6.0 |
| get_default_profile | Gets the names of the default profiles from which the specified profiles will derive default values for its attributes. | BIG-IP_v11.6.0 |
| get_description | Gets the descriptions for a set of SIPRouter profiles. | BIG-IP_v11.6.0 |
| get_ha_message_sweeper_interval | Gets the HA message sweeper interval | BIG-IP_v12.1.0 |
| get_list | Gets a list of all SIPRouter profiles. | BIG-IP_v11.6.0 |
| get_maximum_media_sessions | Gets the maximum media sessions. | BIG-IP_v12.1.0 |
| get_maximum_pending_bytes | Gets the maximum number of bytes contained within pending messages that will be held while waiting for a connection to a peer to be created. | BIG-IP_v11.6.0 |
| get_maximum_pending_messages | Gets the maximum number of pending messages that will be held while waiting for a connection to a peer to be created. | BIG-IP_v11.6.0 |
| get_maximum_session_timeout | Gets the maximum duration (in seconds) that media for a call remains active. | BIG-IP_v12.1.0 |
| get_media_inactivity_timeout | Gets the timeout (in seconds) that represents the media inactivity timeout. | BIG-IP_v12.1.0 |
| get_mirroring_state | Returns true if mirroring is enabled for the SIP router instance. | BIG-IP_v12.1.0 |
| get_sip_route | Gets the list of SIP routes for the specified SIPRouter profiles. See LocalLB::MessageRoutingSIPRoute for more details about SIP static routes. | BIG-IP_v11.6.0 |
| get_statistics | Gets the statistics for the specified SIPRouter profiles. | BIG-IP_v11.6.0 |
| get_statistics_by_virtual | Gets the statistics for the specified SIPRouter profiles, by virtual server. | BIG-IP_v11.6.0 |
| get_traffic_group | Gets the traffic group | BIG-IP_v12.1.0 |
| get_transaction_timeout | Gets the maximum time (in seconds) between request and its response. | BIG-IP_v11.6.0 |
| get_use_local_connection_state | Gets the states that if true, enable preference for local connections established by the ingress TMM over connections established by other TMM&aposs when selecting the egress connection to destination peer. | BIG-IP_v11.6.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.6.0 |
| is_base_profile | Determines whether the specified SIPRouter profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). | BIG-IP_v11.6.0 |
| is_system_profile | Determines whether the specified SIPRouter profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). | BIG-IP_v11.6.0 |
| remove_all_sip_routes | Removes all SIP routes from the specified SIPRouter profiles. | BIG-IP_v11.6.0 |
| remove_sip_route | Removes the specified SIP routes from the specified SIPRouter profiles. | BIG-IP_v11.6.0 |
| reset_statistics | Resets the statistics for the specified SIPRouter profiles. | BIG-IP_v11.6.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified SIPRouter profiles, for specified virtual servers. | BIG-IP_v11.6.0 |
| set_default_profile | Sets the names of the default profiles from which the specified profiles will derive default values for its attributes. | BIG-IP_v11.6.0 |
| set_description | Sets the description for a set of SIPRouter profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.6.0 |
| set_ha_message_sweeper_interval | Sets the HA message store sweeper interval in milliseconds. The HA message store stores messages on the standby device until the active device has routed them. Once the active device has routed a message it will send a notification to the standby device instructing the standby device to forward its held message to the its mirrored outgoing connection. If a message resides in the HA message store for longer than the configured sweeper interval, it will be dropped. | BIG-IP_v12.1.0 |
| set_maximum_media_sessions | Sets the maximum media sessions allowed. | BIG-IP_v12.1.0 |
| set_maximum_pending_bytes | Sets the maximum number of bytes contained within pending messages that will be held while waiting for a connection to a peer to be created. Once reached any additional messages to the peer will be flagged as undeliverable and returned to the originator. | BIG-IP_v11.6.0 |
| set_maximum_pending_messages | Sets the maximum number of pending messages that will be held while waiting for a connection to a peer to be created. Once reached any additional messages to the peer will be flagged as undeliverable and returned to the originator. | BIG-IP_v11.6.0 |
| set_maximum_session_timeout | Sets the maximum duration (in seconds) that media for a call remains active. After this configured duration the call media is automatically terminated by BIG-IP. | BIG-IP_v12.1.0 |
| set_media_inactivity_timeout | Sets the timeout (in seconds) that represents the media inactivity timeout. If no RTP packets are received on the media flow for this duration then the corresponding media flows are deleted. | BIG-IP_v12.1.0 |
| set_mirroring_state | Enables connection mirroring for the router instance. All virtual servers using this router instance will be mirror connections. This will override the mirroring flag of the virtual server. | BIG-IP_v12.1.0 |
| set_traffic_group | Sets the traffic group for the router instance. All virtual servers using this router instance will be using the traffic group of the SIP router profile attached to the virtual server. This will override the traffic group of the virtual address. | BIG-IP_v12.1.0 |
| set_transaction_timeout | Sets the maximum time (in seconds) between a request and its response. A provisional response restarts the timer. This may not affect all transactions. The scenarios where the system waits for response (eg. a final response for REGISTER request), are impacted by dropping any persistent data maintained for the request. | BIG-IP_v11.6.0 |
| set_use_local_connection_state | Sets the states that if true, enable preference for local connections established by the ingress TMM over connections established by other TMM&aposs when selecting the egress connection to destination peer. | BIG-IP_v11.6.0 |
Structures¶
Structure
Description
SIPRouterProfileStatisticEntry
A struct that describes statistics for a particular profile.
A struct that describes SIPRouter profile statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| SIPRouterProfileStatisticEntrySequence | SIPRouterProfileStatisticEntry [] | A sequence of SIPRouter profile statistics. |
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.