Class: IControl::LocalLB::ProfileTCP

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/local_lb/profile_tcp.rb,
lib/icontrol/local_lb.rb

Overview

The ProfileTCP interface enables you to manipulate a local load balancer's TCP profile.

Defined Under Namespace

Classes: ProfileTCPStatisticEntry, ProfileTCPStatisticEntrySequence, ProfileTCPStatistics

Instance Method Summary (collapse)

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

- (ProfileEnabledState) ack_on_push_state

Gets the states that if true, data-bearing in-order TCP segments will elicit immediate ACKs from us if they have the PUSH flag set, regardless of the setting of the delayed-ack profile option.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



49
50
51
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 49

def ack_on_push_state
  super
end

- (ProfileTCPStatistics) all_statistics

Gets the statistics for all the profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



60
61
62
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 60

def all_statistics
  super
end

- (ProfileEnabledState) appropriate_byte_counting_state

Gets the states that if true, count the number of bytes acked rather than the number of returning ACKs from the peer when in the linear congestion-window expansion phase of a TCP connection. This algorithm and its benefits are described in RFC3465 (Appropriate Byte Counting).

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



74
75
76
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 74

def appropriate_byte_counting_state
  super
end

- (ProfileEnabledState) bandwidth_delay_state

Gets the states that if true, attempt to calculate the optimal bandwidth to use to the peer based on throughput and round-trip time, and don't exceed it.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



86
87
88
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 86

def bandwidth_delay_state
  super
end

- (ProfileULong) close_wait_timeout

Gets the time (in seconds) to remain in LAST-ACK state before giving up. Zero is forever (or until max retransmission of FIN).

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



98
99
100
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 98

def close_wait_timeout
  super
end

- (ProfileEnabledState) cmetrics_cache_state

Gets the states that if true, use the route-metrics cache in order to jump-start congestion-control parameters. When this parameter is disabled, the system slow-starts to the peer every time (assuming, of course, that slow-start is enabled), resulting in a much more conservative ramp-up in bandwidth utilization. This may be required in cases where an intermediate device is NATing multiple distinct clients to the same IP address, yet each of these hosts has distinctly different bandwidth and jitter parameters. It may also be required when the link is heavily oversubscribed and dropping packets due to overdriving.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



116
117
118
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 116

def cmetrics_cache_state
  super
end

- (ProfileTCPCongestionControlMode) congestion_control_mode

Gets the TCP congestion control modes for this TCP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



127
128
129
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 127

def congestion_control_mode
  super
end

- (Object) create

Creates this TCP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



16
17
18
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 16

def create
  super
end

- (String) default_profile

Gets the names of the default profile from which this profile will derive default values for its attributes.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



139
140
141
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 139

def default_profile
  super
end

- (ProfileEnabledState) deferred_accept_state

Gets the states that if true, defer allocation of connection chain context until payload from the client has been seen.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



151
152
153
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 151

def deferred_accept_state
  super
end

- (ProfileEnabledState) delayed_ack_state

Gets the states that if true, enabled delayed ACK to allow coalescing of multiple ACK responses.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



163
164
165
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 163

def delayed_ack_state
  super
end

- (Object) delete_all_profiles

Deletes all TCP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



26
27
28
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 26

def delete_all_profiles
  super
end

- (Object) delete_profile

Deletes this TCP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



36
37
38
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 36

def delete_profile
  super
end

- (ProfileEnabledState) duplicate_selective_ack_state

Gets the states that if true, enable support for RFC2883 Duplicate Selective Acknowledgement.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



174
175
176
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 174

def duplicate_selective_ack_state
  super
end

- (ProfileEnabledState) ecn_state

Gets the states that if true, enable support for RFC3168 Extended Congestion Notification (ECN).

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



186
187
188
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 186

def ecn_state
  super
end

- (ProfileULong) fin_wait_timeout

Gets the time (in seconds) to remain in FIN-WAIT or CLOSING state before giving up. Zero is forever (or until max retransmission of FIN).

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



198
199
200
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 198

def fin_wait_timeout
  super
end

- (ProfileEnabledState) high_performance_tcp_extension_state

Gets the states that if true, enable support for RFC1323 timestamps and window scaling (high performance TCP extensions).

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



210
211
212
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 210

def high_performance_tcp_extension_state
  super
end

- (ProfileULong) idle_timeout

Gets the idle timeout for this TCP profile. The number of seconds without traffic before a connection is eligible for deletion.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



222
223
224
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 222

def idle_timeout
  super
end

- (ProfileULong) ip_tos_to_client

Gets the client-side IP TOS values for this TCP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



233
234
235
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 233

def ip_tos_to_client
  super
end

- (boolean) is_base_profile

Determines whether this profile are base/pre-configured profile, or user-defined profile.

Returns:

  • (boolean)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



533
534
535
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 533

def is_base_profile
  super
end

- (ProfileULong) keep_alive_interval

Gets the keep-alive intervals (in seconds) for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



244
245
246
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 244

def keep_alive_interval
  super
end

- (ProfileEnabledState) limited_transmit_recovery_state

Gets the states that if true, enable support for RFC3042 Limited Transmit Recovery.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



255
256
257
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 255

def limited_transmit_recovery_state
  super
end

- (ProfileULong) link_qos_to_client

Gets the client-side link QoS values for this TCP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



266
267
268
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 266

def link_qos_to_client
  super
end

- (String) list

Gets a list of all TCP profile.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



277
278
279
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 277

def list
  super
end

- (ProfileULong) maximum_data_retransmission

Gets the maximum number of retransmission of data segments for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



288
289
290
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 288

def maximum_data_retransmission
  super
end

- (ProfileULong) maximum_syn_retransmission

Gets the maximum number of retransmission of SYN segments for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



299
300
301
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 299

def maximum_syn_retransmission
  super
end

- (ProfileString) md5_signature_passphrase

Gets the plaintext passphrase which may be between 1 and 80 characters in length, and is used in a shared-secret scheme to implement the spoof-prevention parts of RFC2385.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



312
313
314
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 312

def md5_signature_passphrase
  super
end

- (ProfileEnabledState) md5_signature_state

Gets the states that if true, use RFC2385 TCP-MD5 signatures to protect tcp traffic against intermediate tampering.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



324
325
326
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 324

def md5_signature_state
  super
end

- (ProfileULong) packet_loss_ignore_burst

Gets values indicating the likelihood of performing congestion control when multiple packets in a row are lost even if the loss threshold has not been exceeded. Valid values from 0 to 32. Higher values decrease the likelihood of performing congestion control.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



338
339
340
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 338

def packet_loss_ignore_burst
  super
end

- (ProfileULong) packet_loss_ignore_rate

Gets the threshold of packets lost per million at which the system should perform congestion control. Measured in packets per million. Valid values are from 0 to 1000000.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



350
351
352
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 350

def packet_loss_ignore_rate
  super
end

- (ProfileULong) proxy_buffer_high

Gets the proxy buffer level at which the receive window is closed, i.e. not advanced.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



361
362
363
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 361

def proxy_buffer_high
  super
end

- (ProfileULong) proxy_buffer_low

Gets the proxy buffer level at which the receive window is opened.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



372
373
374
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 372

def proxy_buffer_low
  super
end

- (ProfileEnabledState) proxy_mss_state

Gets the states that if true, enable proxying of maximum segment size.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



383
384
385
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 383

def proxy_mss_state
  super
end

- (ProfileEnabledState) proxy_option_state

Gets the states that if true, enable proxying of an option (e.g. time-stamps) to the server only if it was negotiated with the client.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



395
396
397
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 395

def proxy_option_state
  super
end

- (ProfileULong) receive_window_size

Gets the receive window sizes (in bytes) for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



406
407
408
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 406

def receive_window_size
  super
end

- (ProfileEnabledState) reset_on_timeout_state

Gets the reset on timeout states for this TCP profile. If true and a TCP connection exceeds its idle timeout, send a reset in addition to deleting the connection.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



418
419
420
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 418

def reset_on_timeout_state
  super
end

- (Object) reset_statistics

Resets the statistics for this profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



543
544
545
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 543

def reset_statistics
  super
end

- (ProfileEnabledState) selective_ack_state

Gets the states that if true, enable support for RFC2018 Selective Acknowledgement.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



429
430
431
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 429

def selective_ack_state
  super
end

- (ProfileULong) send_buffer_size

Gets the send buffer sizes (in bytes) for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



440
441
442
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 440

def send_buffer_size
  super
end

- (Object) set_ack_on_push_state(opts)

Sets the states that if true, data-bearing in-order TCP segments will elicit immediate ACKs from us if they have the PUSH flag set, regardless of the setting of the delayed-ack profile option.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



557
558
559
560
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 557

def set_ack_on_push_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_appropriate_byte_counting_state(opts)

Sets the states that if true, count the number of bytes acked rather than the number of returning ACKs from the peer when in the linear congestion-window expansion phase of a TCP connection. This algorithm and its benefits are described in RFC3465 (Appropriate Byte Counting).

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



573
574
575
576
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 573

def set_appropriate_byte_counting_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_bandwidth_delay_state(opts)

Sets the states that if true, attempt to calculate the optimal bandwidth to use to the peer based on throughput and round-trip time, and don't exceed it.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



587
588
589
590
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 587

def set_bandwidth_delay_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_close_wait_timeout(opts)

Sets the time (in seconds) to remain in LAST-ACK state before giving up. Zero is forever (or until max retransmission of FIN).

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



601
602
603
604
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 601

def set_close_wait_timeout(opts)
  check_params(opts,[:timeouts])
  super
end

- (Object) set_cmetrics_cache_state(opts)

Sets the states that if true, use the route-metrics cache in order to jump-start congestion-control parameters. When this parameter is disabled, the system slow-starts to the peer every time (assuming, of course, that slow-start is enabled), resulting in a much more conservative ramp-up in bandwidth utilization. This may be required in cases where an intermediate device is NATing multiple distinct clients to the same IP address, yet each of these hosts has distinctly different bandwidth and jitter parameters. It may also be required when the link is heavily oversubscribed and dropping packets due to overdriving.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



621
622
623
624
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 621

def set_cmetrics_cache_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_congestion_control_mode(opts)

Sets the TCP congestion control modes for this TCP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



634
635
636
637
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 634

def set_congestion_control_mode(opts)
  check_params(opts,[:values])
  super
end

- (Object) set_default_profile(opts)

Sets the names of the default profile from which this profile will derive default values for its attributes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :defaults (String) —

    The default profiles from which the specified profiles will get default values.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



648
649
650
651
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 648

def set_default_profile(opts)
  check_params(opts,[:defaults])
  super
end

- (Object) set_deferred_accept_state(opts)

Sets the states that if true, defer allocation of connection chain context until payload from the client has been seen.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



662
663
664
665
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 662

def set_deferred_accept_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_delayed_ack_state(opts)

Sets the states that if true, enabled delayed ACK to allow coalescing of multiple ACK responses.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



676
677
678
679
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 676

def set_delayed_ack_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_duplicate_selective_ack_state(opts)

Sets the states that if true, enable support for RFC2883 Duplicate Selective Acknowledgement.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



689
690
691
692
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 689

def set_duplicate_selective_ack_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_ecn_state(opts)

Sets the states that if true, enable support for RFC3168 Extended Congestion Notification (ECN).

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



703
704
705
706
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 703

def set_ecn_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_fin_wait_timeout(opts)

Sets the time (in seconds) to remain in FIN-WAIT or CLOSING state before giving up. Zero is forever (or until max retransmission of FIN).

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



717
718
719
720
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 717

def set_fin_wait_timeout(opts)
  check_params(opts,[:timeouts])
  super
end

- (Object) set_high_performance_tcp_extension_state(opts)

Sets the states that if true, enable support for RFC1323 timestamps and window scaling (high performance TCP extensions).

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



731
732
733
734
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 731

def set_high_performance_tcp_extension_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_idle_timeout(opts)

Sets the idle timeout for this TCP profile. The number of seconds without traffic before a connection is eligible for deletion.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



745
746
747
748
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 745

def set_idle_timeout(opts)
  check_params(opts,[:timeouts])
  super
end

- (Object) set_ip_tos_to_client(opts)

Sets the client-side IP TOS values for this TCP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



758
759
760
761
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 758

def set_ip_tos_to_client(opts)
  check_params(opts,[:values])
  super
end

- (Object) set_keep_alive_interval(opts)

Sets the keep-alive intervals (in seconds) for this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



771
772
773
774
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 771

def set_keep_alive_interval(opts)
  check_params(opts,[:intervals])
  super
end

- (Object) set_limited_transmit_recovery_state(opts)

Sets the states that if true, enable support for RFC3042 Limited Transmit Recovery.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



784
785
786
787
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 784

def set_limited_transmit_recovery_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_link_qos_to_client(opts)

Sets the client-side link QoS values for this TCP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



797
798
799
800
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 797

def set_link_qos_to_client(opts)
  check_params(opts,[:values])
  super
end

- (Object) set_maximum_data_retransmission(opts)

Sets the maximum number of retransmission of data segments for this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



810
811
812
813
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 810

def set_maximum_data_retransmission(opts)
  check_params(opts,[:retries])
  super
end

- (Object) set_maximum_syn_retransmission(opts)

Sets the maximum number of retransmission of SYN segments for this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



823
824
825
826
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 823

def set_maximum_syn_retransmission(opts)
  check_params(opts,[:retries])
  super
end

- (Object) set_md5_signature_passphrase(opts)

Sets the plaintext passphrase which may be between 1 and 80 characters in length, and is used in a shared-secret scheme to implement the spoof-prevention parts of RFC2385.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



838
839
840
841
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 838

def set_md5_signature_passphrase(opts)
  check_params(opts,[:passphrases])
  super
end

- (Object) set_md5_signature_state(opts)

Sets the states that if true, use RFC2385 TCP-MD5 signatures to protect tcp traffic against intermediate tampering.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



852
853
854
855
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 852

def set_md5_signature_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_packet_loss_ignore_burst(opts)

Sets values indicating the likelihood of performing congestion control when multiple packets in a row are lost even if the loss threshold has not been exceeded. Valid values from 0 to 32. Higher values decrease the likelihood of performing congestion control.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



868
869
870
871
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 868

def set_packet_loss_ignore_burst(opts)
  check_params(opts,[:values])
  super
end

- (Object) set_packet_loss_ignore_rate(opts)

Sets the threshold of packets lost per million at which the system should perform congestion control. Measured in packets per million. Valid values are from 0 to 1000000.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



882
883
884
885
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 882

def set_packet_loss_ignore_rate(opts)
  check_params(opts,[:thresholds])
  super
end

- (Object) set_proxy_buffer_high(opts)

Sets the proxy buffer level at which the receive window is closed, i.e. not advanced.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



895
896
897
898
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 895

def set_proxy_buffer_high(opts)
  check_params(opts,[:levels])
  super
end

- (Object) set_proxy_buffer_low(opts)

Sets the proxy buffer level at which the receive window is opened.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



908
909
910
911
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 908

def set_proxy_buffer_low(opts)
  check_params(opts,[:levels])
  super
end

- (Object) set_proxy_mss_state(opts)

Sets the states that if true, enable proxying of maximum segment size.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



921
922
923
924
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 921

def set_proxy_mss_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_proxy_option_state(opts)

Sets the states that if true, enable proxying of an option (e.g. time-stamps) to the server only if it was negotiated with the client.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



935
936
937
938
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 935

def set_proxy_option_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_receive_window_size(opts)

Sets the receive window sizes (in bytes) for this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



948
949
950
951
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 948

def set_receive_window_size(opts)
  check_params(opts,[:sizes])
  super
end

- (Object) set_reset_on_timeout_state(opts)

Sets the reset on timeout states for this TCP profile. If true and a TCP connection exceeds its idle timeout, send a reset in addition to deleting the connection.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



962
963
964
965
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 962

def set_reset_on_timeout_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_selective_ack_state(opts)

Sets the states that if true, enable support for RFC2018 Selective Acknowledgement.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



975
976
977
978
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 975

def set_selective_ack_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_send_buffer_size(opts)

Sets the send buffer sizes (in bytes) for this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



988
989
990
991
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 988

def set_send_buffer_size(opts)
  check_params(opts,[:sizes])
  super
end

- (Object) set_slow_start_state(opts)

Sets the states that if true, enable support for RFC3390 TCP slow-start. BIG-IP uses RFC3390 TCP slow-start rather than traditional congestion avoidance mechanisms.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1002
1003
1004
1005
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 1002

def set_slow_start_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_time_wait_recycle_state(opts)

Sets the states that if true, recycle the connection when SYN is received in TIME-WAIT state.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1016
1017
1018
1019
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 1016

def set_time_wait_recycle_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_time_wait_timeout(opts)

Sets the time (in milliseconds) in TIME-WAIT state before entering CLOSED state.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1029
1030
1031
1032
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 1029

def set_time_wait_timeout(opts)
  check_params(opts,[:timeouts])
  super
end

- (Object) set_use_nagle_algorithm_state(opts)

Sets the states that if true, delay sending data that is less than MSS in size unless all prior data has been ACKed. This leads to less in-flight small-data, and less chance for drops, but can have poor effects for interactive protocols such as telnet over high latency links.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1045
1046
1047
1048
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 1045

def set_use_nagle_algorithm_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_verified_accept_state(opts)

Sets the states that if true, the system must not respond to the client's SYN with a SYN-ACK until it receives a SYN-ACK from the server, indicating that the port is open.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1060
1061
1062
1063
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 1060

def set_verified_accept_state(opts)
  check_params(opts,[:states])
  super
end

- (ProfileEnabledState) slow_start_state

Gets the states that if true, enable support for RFC3390 TCP slow-start. BIG-IP uses RFC3390 TCP slow-start rather than traditional congestion avoidance mechanisms.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



452
453
454
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 452

def slow_start_state
  super
end

- (ProfileTCPStatistics) statistics

Gets the statistics for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



463
464
465
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 463

def statistics
  super
end

- (ProfileEnabledState) time_wait_recycle_state

Gets the states that if true, recycle the connection when SYN is received in TIME-WAIT state.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



475
476
477
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 475

def time_wait_recycle_state
  super
end

- (ProfileULong) time_wait_timeout

Gets the time (in milliseconds) in TIME-WAIT state before entering CLOSED state.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



486
487
488
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 486

def time_wait_timeout
  super
end

- (ProfileEnabledState) use_nagle_algorithm_state

Gets the states that if true, delay sending data that is less than MSS in size unless all prior data has been ACKed. This leads to less in-flight small-data, and less chance for drops, but can have poor effects for interactive protocols such as telnet over high latency links.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



500
501
502
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 500

def use_nagle_algorithm_state
  super
end

- (ProfileEnabledState) verified_accept_state

Gets the states that if true, the system must not respond to the client's SYN with a SYN-ACK until it receives a SYN-ACK from the server, indicating that the port is open.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



513
514
515
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 513

def verified_accept_state
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


521
522
523
 
# File 'lib/icontrol/local_lb/profile_tcp.rb', line 521

def version
  super
end