LocalLB::ProfileRTSP¶
Introduced : BIG-IP_v9.2.0
The ProfileRTSP interface enables you to manipulate a local load
balancer&aposs RTSP profile.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified RTSP profiles. | BIG-IP_v9.2.0 |
| delete_all_profiles | Deletes all RTSP profiles. | BIG-IP_v9.2.0 |
| delete_profile | Deletes the specified RTSP profiles. | BIG-IP_v9.2.0 |
| get_all_statistics | Gets the statistics for all the RTSP profiles. | BIG-IP_v9.2.0 |
| get_check_source_state | Gets the states to indicate how the RTSP filter handles the source attribute in the transport header. If true, the system will use the source attribute in the transport header to establish the target address of the RTP stream, and will update the value of the source attribute to be the virtual address (VIP) before the response is forwarded to the client. If false, the system leaves the source attribute alone. | BIG-IP_v10.1.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_v9.2.0 |
| get_description | Gets the descriptions for a set of RTSP profiles. | BIG-IP_v11.0.0 |
| get_idle_timeout | Gets the idle timeouts (seconds) for the specified RTSP profiles. This is the number of seconds that the UDP data connections are allowed to idle before they are closed. | BIG-IP_v9.2.0 |
| get_list | Gets a list of all RTSP profiles. | BIG-IP_v9.2.0 |
| get_log_profile | Gets the ALG log profiles for a set of RTSP profiles. | BIG-IP_v11.6.0 |
| get_log_publisher | Gets the log publishers for a set of RTSP profiles. | BIG-IP_v11.6.0 |
| get_maximum_header_size | Gets the maximum header sizes for the specified RTSP profiles. This is the largest RTSP request or response header that the RTSP filter (control channel) will allow before aborting the connection. | BIG-IP_v9.2.0 |
| get_maximum_queued_data_size | Gets the maximum queued data sizes for the specified RTSP profiles. This is the maximum amount of data that the RTSP filter (control channel) will buffer before assuming the connection is dead and subsequently aborting the connection. | BIG-IP_v9.2.0 |
| get_multicast_redirect_state | Gets the states to indicate whether to allow redirection of multicasts for the specified RTSP profiles. If enabled, the client is allowed to select the destination where data will be streamed. | BIG-IP_v9.2.0 |
| get_proxy_header | Gets the names of the headers that are passed from the client side VIP to the server side VIP in an RTSP proxy configuration. The name of the header should begin with “X-“. | BIG-IP_v9.2.0 |
| get_proxy_type | Gets the proxy types that the specified RTSP filters are associated with. | BIG-IP_v9.2.0 |
| get_rtcp_port | Gets the RTCP port for the specified RTSP profiles. | BIG-IP_v9.2.1 |
| get_rtp_port | Gets the RTP port for the specified RTSP profiles. | BIG-IP_v9.2.1 |
| get_rtsp_over_http_persistence_state | Gets the states to indicate whether the RTSP filter will automatically handle persisting Real Networks tunneled RTSP over HTTP, over the RTSP port. The default value is enabled. Disabling this value allows the user to override the default behavior with a rule. | BIG-IP_v9.2.0 |
| get_session_reconnect_state | The RTSP specification allows a control connection to be resumed after it has become disconnected. Gets the states to indicate whether the RTSP filter will persist the control connection that is being resumed to the correct server. | BIG-IP_v9.2.0 |
| get_statistics | Gets the statistics for the specified RTSP profiles. | BIG-IP_v9.2.0 |
| get_statistics_by_virtual | Gets the statistics for the specified profiles, by virtual server. | BIG-IP_v11.0.0 |
| get_unicast_redirect_state | Gets the states to indicate whether to allow redirection of unicasts for the specified RTSP profiles. If enabled, the client is allowed to select the destination where data will be streamed. | BIG-IP_v9.2.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.2.0 |
| is_base_profile | Determines whether the specified RTSP 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.2.0 |
| is_system_profile | Determines whether the specified RTSP 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 RTSP profiles. | BIG-IP_v9.2.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified profiles, for specified virtual servers. | BIG-IP_v11.0.0 |
| set_check_source_state | Sets the states to indicate how the RTSP filter handles the source attribute in the transport header. If true, the system will use the source attribute in the transport header to establish the target address of the RTP stream, and will update the value of the source attribute to be the virtual address (VIP) before the response is forwarded to the client. If false, the system leaves the source attribute alone. | BIG-IP_v10.1.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.2.0 |
| set_description | Sets the description for a set of RTSP profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_idle_timeout | Sets the idle timeouts (seconds) for the specified RTSP profiles. This is the number of seconds that the UDP data connections are allowed to idle before they are closed. | BIG-IP_v9.2.0 |
| set_log_profile | Sets the Application-Level Gateway log profiles for a set of RTSP 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 RTSP 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 RTSP 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_maximum_header_size | Sets the maximum header sizes for the specified RTSP profiles. This is the largest RTSP request or response header that the RTSP filter (control channel) will allow before aborting the connection. | BIG-IP_v9.2.0 |
| set_maximum_queued_data_size | Sets the maximum queued data sizes for the specified RTSP profiles. This is the maximum amount of data that the RTSP filter (control channel) will buffer before assuming the connection is dead and subsequently aborting the connection. | BIG-IP_v9.2.0 |
| set_multicast_redirect_state | Sets the states to indicate whether to allow redirection of multicasts for the specified RTSP profiles. If enabled, the client is allowed to select the destination where data will be streamed. | BIG-IP_v9.2.0 |
| set_proxy_header | Sets the names of the headers that are passed from the client side VIP to the server side VIP in an RTSP proxy configuration. The name of the header should begin with “X-“. | BIG-IP_v9.2.0 |
| set_proxy_type | Sets the proxy types that the specified RTSP filters are associated with. | BIG-IP_v9.2.0 |
| set_rtcp_port | Sets the RTCP port for the specified RTSP profiles. | BIG-IP_v9.2.1 |
| set_rtp_port | Sets the RTP port for the specified RTSP profiles. | BIG-IP_v9.2.1 |
| set_rtsp_over_http_persistence_state | Sets the states to indicate whether the RTSP filter will automatically handle persisting Real Networks tunneled RTSP over HTTP, over the RTSP port. The default value is enabled. Disabling this value allows the user to override the default behavior with a rule. | BIG-IP_v9.2.0 |
| set_session_reconnect_state | The RTSP specification allows a control connection to be resumed after it has become disconnected. This sets the states to indicate whether the RTSP filter will persist the control connection that is being resumed to the correct server. | BIG-IP_v9.2.0 |
| set_unicast_redirect_state | Sets the states to indicate whether to allow redirection of unicasts for the specified RTSP profiles. If enabled, the client is allowed to select the destination where data will be streamed. | BIG-IP_v9.2.0 |
Structures¶
Structure
Description
A struct that describes statistics for a particular RTSP profile.
A struct that describes profile statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| ProfileRTSPStatisticEntrySequence | ProfileRTSPStatisticEntry [] | A sequence of ProfileRTSP 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.