Class: IControl::LocalLB::ProfilePersistence

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

Overview

The ProfilePersistence interface enables you to manipulate a local load balancer's Persistence profile.

Defined Under Namespace

Classes: PersistenceHashMethod, PersistenceHashMethodSequence, ProfilePersistenceHashMethod, ProfilePersistenceHashMethodSequence

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

#across_pool_stateProfileEnabledState

Gets the states to indicate whether persistence entries added under this profile are available across pools.

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.


54
55
56
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 54

def across_pool_state
  super
end

#across_service_stateProfileEnabledState

Gets the states to indicate whether persistence entries added under this profile are available across services.

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.


66
67
68
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 66

def across_service_state
  super
end

#across_virtual_stateProfileEnabledState

Gets the states to indicate whether persistence entries added under this profile are available across virtuals.

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.


78
79
80
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 78

def across_virtual_state
  super
end

Gets the cookie expiration in seconds for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.

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.


90
91
92
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 90

def cookie_expiration
  super
end

Gets the cookie hash lengths for this profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.

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.


102
103
104
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 102

def cookie_hash_length
  super
end

Gets the cookie hash offsets for this profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.

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.


114
115
116
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 114

def cookie_hash_offset
  super
end

Gets the cookie names for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.

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.


126
127
128
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 126

def cookie_name
  super
end

Gets the cookie persistence methods to be used when in cookie persistence mode. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.

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_persistence.rb', line 138

def cookie_persistence_method
  super
end

#create(opts) ⇒ Object

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


21
22
23
24
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 21

def create(opts)
  opts = check_params(opts,[:modes])
  super(opts)
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.


150
151
152
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 150

def default_profile
  super
end

#delete_all_profilesObject

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


32
33
34
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 32

def delete_all_profiles
  super
end

#delete_profileObject

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


42
43
44
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 42

def delete_profile
  super
end

#ending_hash_patternProfileString

Gets the pattern marking the end of the section of payload data whose hashed value is used for the persistence value for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

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.


164
165
166
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 164

def ending_hash_pattern
  super
end

#hash_lengthProfileULong

Gets the length of payload data whose hashed value is used for the persistence value for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

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.


177
178
179
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 177

def hash_length
  super
end

#hash_methodProfilePersistenceHashMethod

Gets the hash method used to generate the persistence values for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH.

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.


189
190
191
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 189

def hash_method
  super
end

#hash_more_data_stateProfileEnabledState

Gets the enabled state whether to perform another hash operation after the current hash operation completes for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

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.


202
203
204
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 202

def hash_more_data_state
  super
end

#hash_offsetProfileULong

Gets the offset to the start of the payload data whose hashed value is used as the persistence value for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

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.


215
216
217
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 215

def hash_offset
  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.


367
368
369
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 367

def is_base_profile
  super
end

#listString

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


226
227
228
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 226

def list
  super
end

#map_proxy_stateProfileEnabledState

Gets the states to indicate whether to map known proxies when the persistence mode is source address affinity.

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.


238
239
240
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 238

def map_proxy_state
  super
end

#maskProfileIPAddress

Gets the masks used in either simple or sticky persistence mode.

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.


249
250
251
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 249

def mask
  super
end

#maximum_hash_buffer_sizeProfileULong

Gets the maximum size of the buffer used to hold the section of the payload data whose hashed value is used for the persistence value for a set of persistence values. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

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.


263
264
265
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 263

def maximum_hash_buffer_size
  super
end

#mirror_stateProfileEnabledState

Gets the mirror states for this Persistence 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.


274
275
276
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 274

def mirror_state
  super
end

#msrdp_without_session_directory_stateProfileEnabledState

Gets the states to indicate whether MS terminal services have been configured without a session directory for this Persistence 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.


286
287
288
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 286

def msrdp_without_session_directory_state
  super
end

#persistence_modeProfilePersistenceMode

Gets the persistence modes for this Persistence 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.


297
298
299
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 297

def persistence_mode
  super
end

#ruleProfileString

Gets the UIE rules for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_UIE.

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.


309
310
311
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 309

def rule
  super
end

#set_across_pool_state(opts) ⇒ Object

Sets the states to indicate whether persistence entries added under this profile are available across pools.

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.


380
381
382
383
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 380

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

#set_across_service_state(opts) ⇒ Object

Sets the states to indicate whether persistence entries added under this profile are available across services.

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.


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

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

#set_across_virtual_state(opts) ⇒ Object

Sets the states to indicate whether persistence entries added under this profile are available across virtuals.

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.


408
409
410
411
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 408

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

Sets the cookie expiration in seconds for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.

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.


422
423
424
425
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 422

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

Sets the cookie hash lengths for this profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.

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.


436
437
438
439
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 436

def set_cookie_hash_length(opts)
  opts = check_params(opts,[:lengths])
  super(opts)
end

Sets the cookie hash offsets for this profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.

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.


450
451
452
453
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 450

def set_cookie_hash_offset(opts)
  opts = check_params(opts,[:offsets])
  super(opts)
end

Sets the cookie names for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.

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.


464
465
466
467
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 464

def set_cookie_name(opts)
  opts = check_params(opts,[:cookie_names])
  super(opts)
end

Sets the cookie persistence methods to be used when in cookie persistence mode. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.

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.


478
479
480
481
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 478

def set_cookie_persistence_method(opts)
  opts = check_params(opts,[:methods])
  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.


492
493
494
495
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 492

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

#set_ending_hash_pattern(opts) ⇒ Object

Sets the pattern marking the end of the section of payload data whose hashed value is used for the persistence value for a set of persistence profile. The hash payload data is either delimited by this starting and ending string pattern or the offset and length, not both. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

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.


509
510
511
512
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 509

def set_ending_hash_pattern(opts)
  opts = check_params(opts,[:patterns])
  super(opts)
end

#set_hash_length(opts) ⇒ Object

Sets the length of payload data whose hashed value is used for the persistence value for a set of persistence profile. The start of the data is specified via set_hash_offset. The hash payload data is either delimited by this offset and length or the starting and ending string pattern, not both. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :lengths (IControl::LocalLB::ProfileULong)

    Hashed payload data length (bytes) for each specified persistence profile (default: 0). If zero, the hashed payload data is not specified by an offset and length.

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.


526
527
528
529
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 526

def set_hash_length(opts)
  opts = check_params(opts,[:lengths])
  super(opts)
end

#set_hash_method(opts) ⇒ Object

Sets the hash method used to generate the persistence values for a set of persistence profile. See PersistenceHashMethod for details. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH.

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.


541
542
543
544
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 541

def set_hash_method(opts)
  opts = check_params(opts,[:methods])
  super(opts)
end

#set_hash_more_data_state(opts) ⇒ Object

Sets the enabled state whether to perform another hash operation after the current hash operation completes for a set of persistence profile. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

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.


556
557
558
559
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 556

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

#set_hash_offset(opts) ⇒ Object

Sets the offset to the start of the payload data whose hashed value is used as the persistence value for a set of persistence profile. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. The hashed payload data length is specified via set_hash_length.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :offsets (IControl::LocalLB::ProfileULong)

    Payload data offset (bytes) to the start of the hashed data for each specified persistence profile (default: 0)

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.


572
573
574
575
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 572

def set_hash_offset(opts)
  opts = check_params(opts,[:offsets])
  super(opts)
end

#set_map_proxy_state(opts) ⇒ Object

Sets the states to indicate whether to map known proxies when the persistence mode is source address affinity.

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_persistence.rb', line 586

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

#set_mask(opts) ⇒ Object

Sets the masks used in either simple or sticky persistence mode.

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.


599
600
601
602
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 599

def set_mask(opts)
  opts = check_params(opts,[:masks])
  super(opts)
end

#set_maximum_hash_buffer_size(opts) ⇒ Object

Sets the maximum size of the buffer used to hold the section of the payload data whose hashed value is used for the persistence value for a set of persistence values. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

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.


615
616
617
618
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 615

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

#set_mirror_state(opts) ⇒ Object

Sets the mirror states for this Persistence 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.


628
629
630
631
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 628

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

#set_msrdp_without_session_directory_state(opts) ⇒ Object

Sets the states to indicate whether MS terminal services have been configured without a session directory for this Persistence 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.


642
643
644
645
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 642

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

#set_persistence_mode(opts) ⇒ Object

Sets the persistence modes for this Persistence 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.


655
656
657
658
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 655

def set_persistence_mode(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_rule(opts) ⇒ Object

Sets the UIE rules for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_UIE.

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.


669
670
671
672
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 669

def set_rule(opts)
  opts = check_params(opts,[:rules])
  super(opts)
end

#set_sip_info(opts) ⇒ Object

Sets the sip_info header for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_SIP.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :sip_info_headers (IControl::LocalLB::ProfileString)

    The sip_info headers for the specified Persistence profiles. Possible values are: 'Call-ID', 'To', 'From', 'SIP-ETag', 'Subject'.

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.


683
684
685
686
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 683

def set_sip_info(opts)
  opts = check_params(opts,[:sip_info_headers])
  super(opts)
end

#set_starting_hash_pattern(opts) ⇒ Object

Sets the pattern marking the start of the section of payload data whose hashed value is used for the persistence value for a set of persistence profile. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

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.


699
700
701
702
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 699

def set_starting_hash_pattern(opts)
  opts = check_params(opts,[:patterns])
  super(opts)
end

#set_timeout(opts) ⇒ Object

Sets the timeout for this Persistence profile. The number of seconds to timeout a persistence entry.

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.


713
714
715
716
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 713

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

#sip_infoProfileString

Gets the sip_info headers for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_SIP.

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.


321
322
323
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 321

def sip_info
  super
end

#starting_hash_patternProfileString

Gets the pattern marking the start of the section of payload data whose hashed value is used for the persistence value for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.

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.


335
336
337
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 335

def starting_hash_pattern
  super
end

#timeoutProfileULong

Gets the timeout for this Persistence profile. The number of seconds to timeout a persistence entry.

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.


347
348
349
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 347

def timeout
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

355
356
357
# File 'lib/icontrol/local_lb/profile_persistence.rb', line 355

def version
  super
end