Class: IControl::LocalLB::ProfileSCTP

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

Overview

The ProfileSCTP interface enables you to manipulate a local load balancer's SCTP profile.

Defined Under Namespace

Classes: ProfileSCTPStatisticEntry, ProfileSCTPStatisticEntrySequence, ProfileSCTPStatistics

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

#all_statisticsProfileSCTPStatistics

Gets the statistics for all the SCTP 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.



48
49
50
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 48

def all_statistics
  super
end

#connect_maximum_retryProfileULong

Gets the maximum number of retries to establish the connection for this SCTP 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.



59
60
61
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 59

def connect_maximum_retry
  super
end

Gets the valid duration of cookies for this SCTP 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.



70
71
72
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 70

def cookie_expiration
  super
end

#createObject

Creates this SCTP 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.



17
18
19
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 17

def create
  super
end

#default_profileString

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.



82
83
84
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 82

def default_profile
  super
end

#delete_all_profilesObject

Deletes all SCTP 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.



27
28
29
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 27

def delete_all_profiles
  super
end

#delete_profileObject

Deletes this SCTP 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.



37
38
39
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 37

def delete_profile
  super
end

#emulate_tcp_shutdown_stateProfileEnabledState

Gets the state that if true, SCTP will emulate TCP closing.

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.



93
94
95
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 93

def emulate_tcp_shutdown_state
  super
end

#heartbeat_intervalProfileULong

Gets the intervals (in seconds) between heartbeats.

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.



104
105
106
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 104

def heartbeat_interval
  super
end

#idle_timeoutProfileULong

Gets the number of seconds without traffic before the 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.



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

def idle_timeout
  super
end

#inbound_streamProfileULong

Gets the number of inbound streams used by this SCTP 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_sctp.rb', line 127

def inbound_stream
  super
end

#ip_tos_to_peerProfileULong

Gets the IP ToS values in packets sent to peer.

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.



138
139
140
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 138

def ip_tos_to_peer
  super
end

#is_base_profileboolean

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.



326
327
328
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 326

def is_base_profile
  super
end

Gets the link QoS values in packets sent to peer.

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.



149
150
151
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 149

def link_qos_to_peer
  super
end

#listString

Gets a list of all SCTP 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.



160
161
162
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 160

def list
  super
end

#order_receive_message_stateProfileEnabledState

Gets the state that if true, SCPT will order the received messages before delivering them to upper layer.

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.



172
173
174
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 172

def order_receive_message_state
  super
end

#outbound_streamProfileULong

Gets the number of outbound streams used by this SCTP 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.



183
184
185
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 183

def outbound_stream
  super
end

#proxy_buffer_highProfileULong

Gets the proxy buffer level at which the receive window is closed (not advanced) for this SCTP 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.



195
196
197
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 195

def proxy_buffer_high
  super
end

#proxy_buffer_lowProfileULong

Gets the proxy buffer level at which the receive window is opened for this SCTP 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.



206
207
208
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 206

def proxy_buffer_low
  super
end

#receive_chunk_bufferProfileULong

Gets the number of RX chunk buffers used by this SCTP 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.



217
218
219
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 217

def receive_chunk_buffer
  super
end

#receive_window_sizeProfileULong

Gets the receive window sizes used by this SCTP 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.



228
229
230
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 228

def receive_window_size
  super
end

#reset_on_timeout_stateProfileEnabledState

Gets the state that if true, SCTP will reset the connection when a timeout occurs.

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.



239
240
241
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 239

def reset_on_timeout_state
  super
end

#reset_statisticsObject

Resets the statistics for this SCTP 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.



336
337
338
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 336

def reset_statistics
  super
end

#secretProfileString

Gets the internal secret strings used to HMAC cookies.

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.



250
251
252
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 250

def secret
  super
end

#send_buffer_sizeProfileULong

Gets the send buffer sizes (in bytes) used by this SCTP 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.



261
262
263
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 261

def send_buffer_size
  super
end

#send_maximum_retryProfileULong

Gets the maximum number of retries to send data for this SCTP 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.



272
273
274
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 272

def send_maximum_retry
  super
end

#send_partial_data_stateProfileEnabledState

Gets the state that indicates whether SCTP will accept and send partial application data.

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.



284
285
286
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 284

def send_partial_data_state
  super
end

#set_connect_maximum_retry(opts) ⇒ Object

Sets the maximum number of retries to establish the connection for this SCTP 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.



348
349
350
351
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 348

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

Sets the valid duration of cookies for this SCTP 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.



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

def set_cookie_expiration(opts)
  opts = check_params(opts,[:durations])
  super(opts)
end

#set_default_profile(opts) ⇒ Object

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.



375
376
377
378
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 375

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

#set_emulate_tcp_shutdown_state(opts) ⇒ Object

Sets the state that if true, SCTP will emulate TCP closing.

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.



388
389
390
391
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 388

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

#set_heartbeat_interval(opts) ⇒ Object

Sets the intervals (in seconds) between heartbeats.

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.



401
402
403
404
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 401

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

#set_idle_timeout(opts) ⇒ Object

Sets the number of seconds without traffic before the 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.



415
416
417
418
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 415

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

#set_inbound_stream(opts) ⇒ Object

Sets the number of inbound streams used by this SCTP 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.



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

def set_inbound_stream(opts)
  opts = check_params(opts,[:streams])
  super(opts)
end

#set_ip_tos_to_peer(opts) ⇒ Object

Sets the IP ToS values in packets sent to peer.

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.



441
442
443
444
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 441

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

Sets the link QoS values in packets sent to peer.

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.



454
455
456
457
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 454

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

#set_order_receive_message_state(opts) ⇒ Object

Sets the state that if true, SCPT will order the received messages before delivering them to upper layer.

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.



468
469
470
471
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 468

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

#set_outbound_stream(opts) ⇒ Object

Sets the number of outbound streams used by this SCTP 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.



481
482
483
484
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 481

def set_outbound_stream(opts)
  opts = check_params(opts,[:streams])
  super(opts)
end

#set_proxy_buffer_high(opts) ⇒ Object

Sets the proxy buffer level at which the receive window is closed (not advanced) for this SCTP 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.



495
496
497
498
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 495

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

#set_proxy_buffer_low(opts) ⇒ Object

Sets the proxy buffer level at which the receive window is opened for this SCTP 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.



508
509
510
511
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 508

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

#set_receive_chunk_buffer(opts) ⇒ Object

Sets the number of RX chunk buffers used by this SCTP 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.



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

def set_receive_chunk_buffer(opts)
  opts = check_params(opts,[:buffers])
  super(opts)
end

#set_receive_window_size(opts) ⇒ Object

Sets the receive window sizes used by this SCTP 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.



534
535
536
537
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 534

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

#set_reset_on_timeout_state(opts) ⇒ Object

Sets the state that if true, SCTP will reset the connection when a timeout occurs.

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.



547
548
549
550
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 547

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

#set_secret(opts) ⇒ Object

Sets the internal secret strings used to HMAC cookies.

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.



560
561
562
563
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 560

def set_secret(opts)
  opts = check_params(opts,[:secrets])
  super(opts)
end

#set_send_buffer_size(opts) ⇒ Object

Sets the send buffer sizes (in bytes) used by this SCTP 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.



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

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

#set_send_maximum_retry(opts) ⇒ Object

Sets the maximum number of retries to send data for this SCTP 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.



586
587
588
589
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 586

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

#set_send_partial_data_state(opts) ⇒ Object

Sets the state that indicates whether SCTP will accept and send partial application data.

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.



600
601
602
603
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 600

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

#set_transmit_chunk_buffer(opts) ⇒ Object

Sets the number of TX chunk buffers used by this SCTP 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.



613
614
615
616
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 613

def set_transmit_chunk_buffer(opts)
  opts = check_params(opts,[:buffers])
  super(opts)
end

#statisticsProfileSCTPStatistics

Gets the statistics for this SCTP 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.



295
296
297
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 295

def statistics
  super
end

#transmit_chunk_bufferProfileULong

Gets the number of TX chunk buffers used by this SCTP 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.



306
307
308
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 306

def transmit_chunk_buffer
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


314
315
316
# File 'lib/icontrol/local_lb/profile_sctp.rb', line 314

def version
  super
end