LocalLB::ProfileSIP¶
Introduced : BIG-IP_v9.4.2
The ProfileSIP interface enables you to manipulate a local load
balancer&aposs SIP profile.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified SIP profiles. | BIG-IP_v9.4.2 |
| delete_all_profiles | Deletes all SIP profiles. | BIG-IP_v9.4.2 |
| delete_profile | Deletes the specified SIP profiles. | BIG-IP_v9.4.2 |
| get_alg_enabled_state | Gets the ALG enabled state for the specified profiles. | BIG-IP_v11.3.0 |
| get_alg_session_timeout | Gets the ALG session timeouts (seconds) for the specified SIP profiles. | BIG-IP_v11.3.0 |
| get_all_statistics | Gets the statistics for all the SIP profiles. | BIG-IP_v9.4.2 |
| get_default_profile | Gets the names of the default profiles from which the specified profiles will derive default values for its attributes. | BIG-IP_v9.4.2 |
| get_description | Gets the descriptions for a set of SIP profiles. | BIG-IP_v11.0.0 |
| get_dialog_aware_state | Gets whether the specified SIP profiles are dialog aware. | BIG-IP_v10.1.0 |
| get_dialog_establishment_timeout | Gets the dialog establishment timeouts (seconds) for the specified SIP profiles. | BIG-IP_v11.3.0 |
| get_firewall_state | Gets the SIP Firewall enabled state for the specified profiles. | BIG-IP_v11.4.0 |
| get_insert_record_route_state | Gets the insert Record-Route states for the specified SIP profiles. If true, insert a Record-Route header field value into the SIP message. | BIG-IP_v9.4.2 |
| get_insert_via_state | Gets the insert Via header states for the specified SIP profiles. If true, insert a Via header into the SIP message. | BIG-IP_v9.4.2 |
| get_list | Gets a list of all SIP profiles. | BIG-IP_v9.4.2 |
| get_log_profile | Gets the ALG log profiles for a set of SIP profiles. | BIG-IP_v11.6.0 |
| get_log_publisher | Gets the log publishers for a set of SIP profiles. | BIG-IP_v11.6.0 |
| get_max_message_size | Gets the maximum SIP message sizes for the specified SIP profiles. This indicates the maximum SIP header size the BIG-IP will accept. | BIG-IP_v9.4.2 |
| get_maximum_media_sessions | Gets the maximum media sessions for the specified SIP profiles. | BIG-IP_v11.3.0 |
| get_maximum_registrations | Gets the maximum registrations for the specified SIP profiles. | BIG-IP_v11.3.0 |
| get_maximum_sessions_per_registration | Gets the maximum sessions per registration for the specified SIP profiles. | BIG-IP_v11.3.0 |
| get_registration_timeout | Gets the registration timeouts (seconds) for the specified SIP profiles. | BIG-IP_v11.3.0 |
| get_rtp_proxy_style | Gets the RTP proxy style for the specified profiles. | BIG-IP_v11.3.0 |
| get_secure_via_state | Gets the secure Via states for the specified SIP profiles. If true, use “TLS” in the sent-protocol portion of an inserted Via header. | BIG-IP_v9.4.2 |
| get_sip_community | Gets the community name for the specified SIP profiles. | BIG-IP_v10.1.0 |
| get_statistics | Gets the statistics for the specified SIP profiles. | BIG-IP_v9.4.2 |
| get_statistics_by_virtual | Gets the statistics for the specified profiles, by virtual server. | BIG-IP_v11.0.0 |
| get_terminate_connection_after_bye_state | Gets the terminate connection after bye states for the specified SIP profiles. If true, terminate a connection after a (200 BYE) message. | BIG-IP_v9.4.2 |
| get_unique_usernames_state | This method is deprecated (immediately) and should not have been exposed. Gets the states to indicate whether the unique usernames validation is enabled. | BIG-IP_v11.3.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.4.2 |
| get_via_userdata | Gets the via userdata for the specified SIP profiles. | BIG-IP_v10.0.0 |
| is_base_profile | Determines whether the specified SIP 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_v9.4.2 |
| is_system_profile | Determines whether the specified SIP 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.0.0 |
| reset_statistics | Resets the statistics for the specified SIP profiles. | BIG-IP_v9.4.2 |
| reset_statistics_by_virtual | Resets the statistics for the specified profiles, for specified virtual servers. | BIG-IP_v11.0.0 |
| set_alg_enabled_state | Sets the ALG enabled state for the specified profiles. When ALG (Application Level Gateway) is enabled, BIG-IP functions as a NAT device allowing SIP calls to traverse the NAT by translating internal IP addresses to external IP addresses (SNAT ip) and forwarding traffic accordingly. | BIG-IP_v11.3.0 |
| set_alg_session_timeout | Sets the ALG session timeouts (seconds) for the specified SIP profiles. This is the number of seconds that the SIP connections are allowed to maintain SIP session before they are closed. The default value is 300. | BIG-IP_v11.3.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_v9.4.2 |
| set_description | Sets the description for a set of SIP profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_dialog_aware_state | Sets whether the specified SIP profiles should gather SIP dialog information and automatically forward SIP messages belonging to known SIP dialogs. | BIG-IP_v10.1.0 |
| set_dialog_establishment_timeout | Sets the dialog establishment timeouts (seconds) for the specified SIP profiles. This is the number of seconds that the SIP connections are allowed to establish dialog before they are closed. The default value is 10. | BIG-IP_v11.3.0 |
| set_firewall_state | Sets the SIP Firewall enabled state for the specified profiles. When enabled, BIG-IP functions as a firewall and detects any DoS attacks/anomalies based on user configuration (thresholds), does reporting (AVR) and logging with attack information. | BIG-IP_v11.4.0 |
| set_insert_record_route_state | Sets the insert Record-Route states for the specified SIP profiles. If true, insert a Record-Route header field value into the SIP message. | BIG-IP_v9.4.2 |
| set_insert_via_state | Sets the insert Via header states for the specified SIP profiles. If true, insert a Via header into the SIP message. | BIG-IP_v9.4.2 |
| set_log_profile | Sets the Application-Level Gateway log profiles for a set of SIP profiles. The ALG log profile controls the logging of ALG connection events. See LocalLB::ALGLogProfile for more details. | BIG-IP_v11.6.0 |
| set_log_publisher | Sets the log publishers for a set of SIP profiles. A log publisher is a set of log destinations for high-speed logging of formatted log messages. See Log::Publisher for more details. | BIG-IP_v11.6.0 |
| set_log_settings | Sets the log publisher and ALG log profiles for a set of SIP profiles. This is the convenience function for set_log_publisher and set_log_profile. It is a convenience function to help avoid using a transaction, because a log publisher must be use in conjunction with a log profile. Either a transaction or this method are good ways of satisfying this validation. | BIG-IP_v11.6.0 |
| set_max_message_size | Sets the maximum SIP message sizes for the specified SIP profiles. This indicates the maximum SIP header size the BIG-IP will accept. | BIG-IP_v9.4.2 |
| set_maximum_media_sessions | Sets the maximum media sessions for the specified SIP profiles. This indicates the maximum SDP media sessions the BIG-IP will accept. The default value is 6. | BIG-IP_v11.3.0 |
| set_maximum_registrations | Sets the maximum registrations for the specified SIP profiles. This indicates the maximum allowable REGISTER messages that can be recorded. The default value is 100. | BIG-IP_v11.3.0 |
| set_maximum_sessions_per_registration | Sets the maximum sessions per registration for the specified SIP profiles. This indicates the maximum number of calls or sessions that can be made by a user for a single registration. The default value is 50. | BIG-IP_v11.3.0 |
| set_registration_timeout | Sets the registration timeouts (seconds) for the specified SIP profiles. This is the number of seconds that the SIP clients are allowed to maintain SIP registration before they are expired. The default value is 3600. | BIG-IP_v11.3.0 |
| set_rtp_proxy_style | Sets the RTP proxy style for the specified profiles. Indicates the style in which RTP will proxy the data. The SDP data in the SIP signalling describes the location of the RTP flows. | BIG-IP_v11.3.0 |
| set_secure_via_state | Sets the secure Via states for the specified SIP profiles. If true, use “TLS” in the sent-protocol portion of an inserted Via header. | BIG-IP_v9.4.2 |
| set_sip_community | Sets a community name for the specified SIP profiles. For “dialog aware” SIP profiles with multiple SIP virtual server/profile pairings, this name groups the SIP profiles in the same SIP proxy functional group. | BIG-IP_v10.1.0 |
| set_terminate_connection_after_bye_state | Sets the terminate connection after bye states for the specified SIP profiles. If true, terminate a connection after a (200 BYE) message. | BIG-IP_v9.4.2 |
| set_unique_usernames_state | This method is deprecated (immediately) and should not have been exposed. Sets the states to indicate whether unique username validation is enabled. By default it is not enabled. When enabled, the username in the username | BIG-IP_v11.3.0 |
| set_via_userdata | Sets the via userdata for the specified SIP profiles. If insert via is enabled and this string is not empty, for a SIP request message the via header will be compiled using this string. | BIG-IP_v10.0.0 |
Structures¶
Structure
Description
A structure that specifies the RTP Proxy Style.
A struct that describes statistics for a particular SIP profile.
A struct that describes profile statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| RTPProxyStyle | A list of RTP proxy styles. Indicates the style in which the RTP will proxy the data. The RTP flows are directed to the location provided by the necessary SDP data in SIP signalling. |
Aliases¶
| Alias | Type | Description |
| ProfileRTPProxyStyleSequence | ProfileRTPProxyStyle [] | A sequence of RTP Proxy Style specifications. |
| ProfileSIPStatisticEntrySequence | ProfileSIPStatisticEntry [] | A sequence of ProfileSIP 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.