LocalLB::ProfileSIPSession¶
Introduced : BIG-IP_v11.6.0
The ProfileSIPSession interface configures the handling of message
routing SIP (Session Initiation Protocol) processing. This profile
includes settings which affect the SIP message processing. This
profile needs to be associated with each virtual server and each peer
(see LocalLB::MessageRoutingPeer) which is used in the routing
instance. The virtual server and peer(s) process the ingress/egress
messages per the settings of this profile. Multiple profiles can be in
use in a single routing instance.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified SIP session profiles. | BIG-IP_v11.6.0 |
| delete_all_profiles | Deletes all SIP session profiles. | BIG-IP_v11.6.0 |
| delete_profile | Deletes the specified SIP session profiles. | BIG-IP_v11.6.0 |
| get_all_statistics | Gets the statistics for all SIP session profiles. | BIG-IP_v11.6.0 |
| get_custom_via | Gets the custom value for the sent-by field of via. Only the sent-by component value is mentioned here not the complete header. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | 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 SIP session profiles. | BIG-IP_v11.6.0 |
| get_do_not_connect_back_state | Gets the states that if true, enable whether connection to a request originator is established (if it no longer exists) in order to deliver response. | BIG-IP_v11.6.0 |
| get_firewall_enabled_state | Gets the states of Application Firewall Security for the specified SIP session Profiles. When enabled, the configured AFM security features will apply to the virtual server(s) using the specified SIP session profiles. | BIG-IP_v11.6.0 |
| get_generate_response_on_failure_state | Gets the states that if true, enable sending failure response messages such as 4xx, 5xx and 6xx, when a SIP request is being dropped. | BIG-IP_v11.6.0 |
| get_honor_via_state | Gets the states that if true, enable honoring any via which is not inserted by the system for routing the response. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | BIG-IP_v11.6.0 |
| get_insert_record_route_header_state | Gets the states that if true, enable insertion of record-route header in requests that establish dialog. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | BIG-IP_v11.6.0 |
| get_insert_via_header_state | Gets the states that if true, enable insertion of top via. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | BIG-IP_v11.6.0 |
| get_list | Gets a list of all SIP session profiles. | BIG-IP_v11.6.0 |
| get_loop_detection_state | Gets the states that if true, enable loop-detection check. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | BIG-IP_v11.6.0 |
| get_maintenance_mode_state | Gets the states that if true, maintenance mode is enabled. | BIG-IP_v12.1.0 |
| get_max_forwards_check_state | Gets the states that if true, enable checking on max-forwards. If 0, the request is discarded. An error response is sent, if configured. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | BIG-IP_v11.6.0 |
| get_maximum_message_header_count | Gets the maximum count of expected SIP message header fields. | BIG-IP_v11.6.0 |
| get_maximum_message_header_size | Gets the maximum SIP message header size (in bytes). | BIG-IP_v11.6.0 |
| get_maximum_message_size | Gets the maximum acceptable SIP message size (in bytes). | BIG-IP_v11.6.0 |
| get_persist_key | Gets the method that extracts the value that will be used to persist on. | BIG-IP_v11.6.0 |
| get_persist_timeout | Gets the timeout value of persistence entries in seconds. | BIG-IP_v11.6.0 |
| get_persist_type | Gets the type of the persistence to be used for the specified “persist-key” attribute value. | BIG-IP_v11.6.0 |
| get_statistics | Gets the statistics for the specified SIP session profiles. | BIG-IP_v11.6.0 |
| get_statistics_by_virtual | Gets the statistics for the specified SIP session profiles, by virtual server. | 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 SIP session 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 SIP session 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 |
| reset_statistics | Resets the statistics for the specified SIP session profiles. | BIG-IP_v11.6.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified SIP session profiles, for the specified virtual servers. | BIG-IP_v11.6.0 |
| set_custom_via | Sets the custom value for the sent-by field of via. Only the sent-by component value is mentioned here not the complete header. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | 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 SIP session profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.6.0 |
| set_do_not_connect_back_state | Sets the states that if true, enable whether connection to a request originator is re-established (if it no longer exists) in order to deliver response. When disabled, responses that cannot be forwarded using an existing connection are dropped. | BIG-IP_v11.6.0 |
| set_firewall_enabled_state | Sets the states of Application Firewall Security for the specified SIP session profiles. When enabled, the configured AFM security features will apply to the virtual server(s) using the specified SIP session profiles. | BIG-IP_v11.6.0 |
| set_generate_response_on_failure_state | Sets the states that if true, enable sending failure response messages such as 4xx, 5xx and 6xx, when a SIP request is being dropped. Note: Where it is specfied “silently” discarded/dropped, no error response is generated. In any case, a dropped message (request/response) is tracked by the Messages Dropped Statistic. | BIG-IP_v11.6.0 |
| set_honor_via_state | Sets the states that if true, enable honoring any via which is not inserted by the system for routing the response. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | BIG-IP_v11.6.0 |
| set_insert_record_route_header_state | Sets the states that if true, enable insertion of record-route header in requests that establish dialog. When enabled, along with URI, the custom parameters may be added to facilitate the routing of subsequent requests within this call to avoid route lookup. The record route URI is the local-IP and port of flows that are used for forwarding the message. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | BIG-IP_v11.6.0 |
| set_insert_via_header_state | Sets the states that if true, enable insertion of top via. When enabled, custom parameters to help route the response back are inserted, along with sent-by field of via. The source address:port of the flow forwarding the request is filled as value for sent-by field of the via unless a custom via value is specified. The custom params inserted to help routing, helps improve performance as it facilitates routing without any lookup. The via is inserted at egress side of the flow, after the SIP_REQUEST_SEND event. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | BIG-IP_v11.6.0 |
| set_loop_detection_state | Sets the states that if true, enable loop-detection check. When a loop is detected, the request is discarded. An error response is sent, if configured. A request is detected as seen before (forwarded/spiraled/looped) only if self inserted via is found in the message and the value of its branch param plays a key role in detecting loop versus spiral. Hence enabling via insertion becomes a requirement to do loop detection check. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | BIG-IP_v11.6.0 |
| set_maintenance_mode_state | Sets the states that if true, enable maintenance mode for SIP. When enabled, received SIP Request is acknowledged with SIP Response “503 Server in maintenance mode”. | BIG-IP_v12.1.0 |
| set_max_forwards_check_state | Sets the states that if true, enable checking on max-forwards. The max-forwards header field serves to limit the number of hops a request can transit on the way to its destination. If 0, the request is discarded. An error response is sent, if configured. This attribute has no effect if the associated siprouter profile’s operation mode attribute is set to "application level gateway”. | BIG-IP_v11.6.0 |
| set_maximum_message_header_count | Sets the maximum count of expected SIP message header fields. A message that exceeds this limit is silently discarded. | BIG-IP_v11.6.0 |
| set_maximum_message_header_size | Sets the maximum SIP message header size (in bytes). A message which exceeds this size is silently discarded. | BIG-IP_v11.6.0 |
| set_maximum_message_size | Sets the maximum acceptable SIP message size (in bytes). A message which exceeds this size is silently discarded. | BIG-IP_v11.6.0 |
| set_persist_key | Sets the method to extract the key value that is used to persiston. See LocalLB::ProfileSIPSession::PersistKey for more details. | BIG-IP_v11.6.0 |
| set_persist_timeout | Sets the timeout value of persistence entries in seconds. Upon receiving of the response for the initial SIP Request message, the persistence record is updated with the persist-timeout value. | BIG-IP_v11.6.0 |
| set_persist_type | Sets the type of the persistence to be used for the specified “persist-key” attribute value. See LocalLB::ProfileSIPSession::PersistType for more details. | BIG-IP_v11.6.0 |
Structures¶
Structure
Description
A structure that specifies SIP session profile persist keys used in profile attributes.
A structure that specifies SIP session profile persist types used in profile attributes.
SIPSessionProfileStatisticEntry
A struct that describes statistics for a particular profile.
A struct that describes SIP session profile statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| PersistKey | A list of SIP session profile persist keys. The key specifies the method of extraction of persistence key to be used to persist on. |
| PersistType | A list of SIP session profile persist types. The type specifies the method of persistence to employ for eliminating the necessity for a route lookup load balancing decision for each message. |
Aliases¶
| Alias | Type | Description |
| ProfilePersistKeySequence | ProfilePersistKey [] | A sequence of profile persist keys. |
| ProfilePersistTypeSequence | ProfilePersistType [] | A sequence of profile persist types. |
| SIPSessionProfileStatisticEntrySequence | SIPSessionProfileStatisticEntry [] | A sequence of SIP session 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.