LocalLB::ProfileSCTP¶
Introduced : BIG-IP_v9.2.1
The ProfileSCTP interface enables you to manipulate a local load
balancer&aposs SCTP profile.
Methods¶
| Method | Description | Introduced |
| add_multi_homing_address | Adds client-side multi-homing destination addresses used with this SCTP profile. If the allowed clients is restricted, a separate API call needs to be made to set the source prefix subnet value to something different than the default which allows all source IPs. | BIG-IP_v12.0.0 |
| create | Creates the specified SCTP profiles. | BIG-IP_v9.2.1 |
| delete_all_profiles | Deletes all SCTP profiles. | BIG-IP_v9.2.1 |
| delete_profile | Deletes the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_all_statistics | Gets the statistics for all the SCTP profiles. | BIG-IP_v9.2.1 |
| get_client_side_multi_homing_state | Gets the client side multi-homing state for the specified profiles. | BIG-IP_v12.0.0 |
| get_connect_maximum_retry | Gets the maximum number of retries to establish the connection for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_cookie_expiration | Gets the valid duration of cookies for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| 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.1 |
| get_description | Gets the descriptions for a set of SCTP profiles. | BIG-IP_v11.0.0 |
| get_emulate_tcp_shutdown_state | Gets the state that if true, SCTP will emulate TCP closing. | BIG-IP_v9.2.1 |
| get_heartbeat_interval | Gets the intervals (in seconds) between heartbeats. | BIG-IP_v9.2.1 |
| get_heartbeat_max_burst | Gets the maximum heartbeat burst size. This is the HB.Max.Burst protocol parameter as described in RFC 4960 Section 15 and Section 5.4. | BIG-IP_v11.6.0 |
| get_idle_timeout | Gets the number of seconds without traffic before the connection is eligible for deletion. | BIG-IP_v9.2.1 |
| get_inbound_stream | Gets the number of inbound streams used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_ip_tos_to_peer | Gets the IP ToS values in packets sent to peer. | BIG-IP_v9.2.1 |
| get_link_qos_to_peer | Gets the link QoS values in packets sent to peer. | BIG-IP_v9.2.1 |
| get_list | Gets a list of all SCTP profiles. | BIG-IP_v9.2.1 |
| get_max_burst | Gets the maximum data burst size. This is the Max.Burst protocol parameter as described in RFC 4960 Section 15 and Section 6.1. | BIG-IP_v11.6.0 |
| get_maximum_communication_paths | Gets the maximum number of communication paths. | BIG-IP_v12.0.0 |
| get_maximum_path_retransmit_limit | Gets the maximum path retransmit limit. | BIG-IP_v12.0.0 |
| get_multi_homing_address | Gets the list of client-side multi-homing destination addresses used with this SCTP profile. | BIG-IP_v12.0.0 |
| get_order_receive_message_state | Gets the state that if true, SCTP will order the received messages before delivering them to upper layer. | BIG-IP_v9.2.1 |
| get_outbound_stream | Gets the number of outbound streams used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_proxy_buffer_high | Gets the proxy buffer level at which the receive window is closed (not advanced) for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_proxy_buffer_low | Gets the proxy buffer level at which the receive window is opened for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_receive_chunk_buffer | Gets the number of RX chunk buffers used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_receive_window_size | Gets the receive window sizes used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_reset_on_timeout_state | Gets the state that if true, SCTP will reset the connection when a timeout occurs. | BIG-IP_v9.2.1 |
| get_secret | Gets the internal secret strings used to HMAC cookies. | BIG-IP_v9.2.1 |
| get_send_buffer_size | Gets the send buffer sizes (in bytes) used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_send_maximum_retry | Gets the maximum number of retries to send data for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_send_partial_data_state | Gets the state that indicates whether SCTP will accept and send partial application data. | BIG-IP_v9.2.1 |
| get_server_side_multi_homing_state | Gets the server side multi-homing state for the specified profiles. | BIG-IP_v12.0.0 |
| get_statistics | Gets the statistics for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_statistics_by_virtual | Gets the statistics for the specified profiles, by virtual server. | BIG-IP_v11.0.0 |
| get_transmit_chunk_buffer | Gets the number of TX chunk buffers used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.2.1 |
| is_base_profile | Determines whether the specified SCTP 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.1 |
| is_system_profile | Determines whether the specified SCTP 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 |
| remove_all_multi_homing_addresses | Removes all client-side multi-homing addresses used with this SCTP profile. | BIG-IP_v12.0.0 |
| remove_multi_homing_address | Removes client-side multi-homing addresses used with this SCTP profile. | BIG-IP_v12.0.0 |
| reset_statistics | Resets the statistics for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| reset_statistics_by_virtual | Resets the statistics for the specified profiles, for specified virtual servers. | BIG-IP_v11.0.0 |
| set_client_side_multi_homing_state | Sets the client side multi-homing state for the specified profiles. When enabled, the virtual server source address translation mode is used for SCTP traffic. | BIG-IP_v12.0.0 |
| set_connect_maximum_retry | Sets the maximum number of retries to establish the connection for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| set_cookie_expiration | Sets the valid duration of cookies for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| 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.1 |
| set_description | Sets the description for a set of SCTP profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_emulate_tcp_shutdown_state | Sets the state that if true, SCTP will emulate TCP closing. | BIG-IP_v9.2.1 |
| set_heartbeat_interval | Sets the intervals (in seconds) between heartbeats. | BIG-IP_v9.2.1 |
| set_heartbeat_max_burst | Sets the maximum heartbeat burst size. This is the HB.Max.Burst protocol parameter as described in RFC 4960 Section 15 and Section 5.4. | BIG-IP_v11.6.0 |
| set_idle_timeout | Sets the number of seconds without traffic before the connection is eligible for deletion. | BIG-IP_v9.2.1 |
| set_inbound_stream | Sets the number of inbound streams used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| set_ip_tos_to_peer | Sets the IP ToS values in packets sent to peer. | BIG-IP_v9.2.1 |
| set_link_qos_to_peer | Sets the link QoS values in packets sent to peer. | BIG-IP_v9.2.1 |
| set_max_burst | Sets the maximum data burst size. This is the Max.Burst protocol parameter as described in RFC 4960 Section 15 and Section 6.1. | BIG-IP_v11.6.0 |
| set_maximum_communication_paths | Sets the maximum number of communication paths. A communication path is a set of a local address and remote address used to send and receive traffic between endpoints. This parameters sets the maximum number of paths allowed between the local and remote endpoints to establish the multi-homing association for alternate failover paths. The default is 16, and the value is stored as a 16 bit value. | BIG-IP_v12.0.0 |
| set_maximum_path_retransmit_limit | Sets the maximum path retransmit limit. This the number of retries attempted before failing over a particular path between local and remote endpoints. When a path is not responsive anymore, one of the alternate paths that has established the association as a multi-homing endpoint is chosen to take over the traffic. The default number of retries to declare a path unusable is 5. | BIG-IP_v12.0.0 |
| set_order_receive_message_state | Sets the state that if true, SCTP will order the received messages before delivering them to upper layer. | BIG-IP_v9.2.1 |
| set_outbound_stream | Sets the number of outbound streams used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| set_proxy_buffer_high | Sets the proxy buffer level at which the receive window is closed (not advanced) for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| set_proxy_buffer_low | Sets the proxy buffer level at which the receive window is opened for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| set_receive_chunk_buffer | Sets the number of RX chunk buffers used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| set_receive_window_size | Sets the receive window sizes used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| set_reset_on_timeout_state | Sets the state that if true, SCTP will reset the connection when a timeout occurs. | BIG-IP_v9.2.1 |
| set_secret | Sets the internal secret strings used to HMAC cookies. | BIG-IP_v9.2.1 |
| set_send_buffer_size | Sets the send buffer sizes (in bytes) used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
| set_send_maximum_retry | Sets the maximum number of retries to send data for the specified SCTP profiles. | BIG-IP_v9.2.1 |
| set_send_partial_data_state | Sets the state that indicates whether SCTP will accept and send partial application data. | BIG-IP_v9.2.1 |
| set_server_side_multi_homing_state | Sets the server side multi-homing state for the specified profiles. When enabled, the virtual server source address translation mode is used for SCTP traffic. | BIG-IP_v12.0.0 |
| set_transmit_chunk_buffer | Sets the number of TX chunk buffers used by the specified SCTP profiles. | BIG-IP_v9.2.1 |
Structures¶
Structure
Description
A struct that describes statistics for a particular SCTP profile.
A struct that describes profile statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| ProfileSCTPStatisticEntrySequence | ProfileSCTPStatisticEntry [] | A sequence of ProfileSCTP 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.