Class: IControl::LocalLB::ProfileServerSSL

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

Overview

The ProfileServerSSL interface enables you to manipulate a local load balancer's server SSL profile.

Defined Under Namespace

Classes: ProfileServerSSLStatisticEntry, ProfileServerSSLStatisticEntrySequence, ProfileServerSSLStatistics

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

#alert_timeoutProfileULong

Gets the connection timeouts (in seconds) after sending an alert for this server SSL 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.



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

def alert_timeout
  super
end

#all_statisticsProfileServerSSLStatistics

Gets the statistics for all the server SSL 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_server_ssl.rb', line 60

def all_statistics
  super
end

#authenticate_depthProfileULong

Gets the client certificate chain maximum traversal depth for this server SSL 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.



71
72
73
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 71

def authenticate_depth
  super
end

#authenticate_nameProfileString

Gets the expected server certificate distinguished name (DN) for this server SSL 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.



83
84
85
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 83

def authenticate_name
  super
end

#authenticate_once_stateProfileEnabledState

Gets the states to request the client certificate once for this server SSL 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.



94
95
96
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 94

def authenticate_once_state
  super
end

#ca_fileProfileString

Gets the CA filenames for this server SSL 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.



105
106
107
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 105

def ca_file
  super
end

#cache_sizeProfileULong

Gets the SSL session cache sizes for this server SSL 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.



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

def cache_size
  super
end

#cache_timeoutProfileULong

Gets the SSL session cache timeouts for this server SSL 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_server_ssl.rb', line 127

def cache_timeout
  super
end

#certificate_fileProfileString

Gets the certificate filenames to be used by this server SSL 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.



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

def certificate_file
  super
end

#chain_fileProfileString

Gets the certificate chain filenames for this server SSL 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.



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

def chain_file
  super
end

#cipher_listProfileStringArray

Gets the cipher lists for this server SSL 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.



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

def cipher_list
  super
end

#createObject

Creates this server SSL 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_server_ssl.rb', line 17

def create
  super
end

#crl_fileProfileString

Gets the CRL filenames for this server SSL 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.



171
172
173
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 171

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



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

def default_profile
  super
end

#delete_all_profilesObject

Deletes all server SSL 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_server_ssl.rb', line 27

def delete_all_profiles
  super
end

#delete_profileObject

Deletes this server SSL 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_server_ssl.rb', line 37

def delete_profile
  super
end

#handshake_timeoutProfileULong

Gets the connection timeouts (in seconds) during handshake phase for this server SSL 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_server_ssl.rb', line 195

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



360
361
362
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 360

def is_base_profile
  super
end

#key_fileProfileString

Gets the key filenames to be used by this server SSL 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_server_ssl.rb', line 206

def key_file
  super
end

#listString

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



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

def list
  super
end

#modssl_emulation_stateProfileEnabledState

Gets the states to emulate modSSL for this server SSL 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_server_ssl.rb', line 228

def modssl_emulation_state
  super
end

#passphraseProfileString

Gets the key passphrases (if any) for this server SSL 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.



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

def passphrase
  super
end

#peer_certification_modeProfileServerSSLCertificateMode

Gets the peer certification modes for this server SSL 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.



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

def peer_certification_mode
  super
end

#profile_modeProfileProfileMode

Gets the modes for this server SSL 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_server_ssl.rb', line 261

def profile_mode
  super
end

#renegotiation_periodProfileULong

Gets the SSL renegotiation periods for this server SSL 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_server_ssl.rb', line 272

def renegotiation_period
  super
end

#renegotiation_stateProfileEnabledState

Gets the states controlling whether mid-stream renegotiation is allowed for this server SSL 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.



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

def renegotiation_state
  super
end

#renegotiation_throughputProfileULong

Gets the SSL renegotiation throughputs for this server SSL 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_server_ssl.rb', line 295

def renegotiation_throughput
  super
end

#reset_statisticsObject

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



370
371
372
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 370

def reset_statistics
  super
end

#set_alert_timeout(opts) ⇒ Object

Sets the connection timeouts (in seconds) after sending an alert for this server SSL 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.



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

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

#set_authenticate_depth(opts) ⇒ Object

Sets the client certificate chain maximum traversal depth for this server SSL 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.



396
397
398
399
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 396

def set_authenticate_depth(opts)
  opts = check_params(opts,[:depths])
  super(opts)
end

#set_authenticate_name(opts) ⇒ Object

Sets the expected server certificate distinguished name (DN) for this server SSL 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.



410
411
412
413
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 410

def set_authenticate_name(opts)
  opts = check_params(opts,[:dn_names])
  super(opts)
end

#set_authenticate_once_state(opts) ⇒ Object

Sets the states to request the client certificate once for this server SSL profile. If the state is false/disabled, client certificate is requested for each SSL session renegotiation.

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.



425
426
427
428
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 425

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

#set_ca_file(opts) ⇒ Object

Sets the CA filenames for this server SSL 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.



438
439
440
441
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 438

def set_ca_file(opts)
  opts = check_params(opts,[:cas])
  super(opts)
end

#set_cache_size(opts) ⇒ Object

Sets the SSL session cache sizes for this server SSL 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.



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

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

#set_cache_timeout(opts) ⇒ Object

Sets the SSL session cache timeouts for this server SSL 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.



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

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

#set_certificate_file(opts) ⇒ Object

Sets the certificate filenames to be used by this server SSL 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.



477
478
479
480
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 477

def set_certificate_file(opts)
  opts = check_params(opts,[:certs])
  super(opts)
end

#set_chain_file(opts) ⇒ Object

Sets the certificate chain filenames for this server SSL 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.



490
491
492
493
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 490

def set_chain_file(opts)
  opts = check_params(opts,[:chains])
  super(opts)
end

#set_cipher_list(opts) ⇒ Object

Sets the cipher lists for this server SSL 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.



503
504
505
506
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 503

def set_cipher_list(opts)
  opts = check_params(opts,[:ciphers])
  super(opts)
end

#set_crl_file(opts) ⇒ Object

Sets the CRL filenames for this server SSL 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.



516
517
518
519
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 516

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



530
531
532
533
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 530

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

#set_handshake_timeout(opts) ⇒ Object

Sets the connection timeouts (in seconds) during handshake phase for this server SSL 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.



544
545
546
547
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 544

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

#set_key_file(opts) ⇒ Object

Sets the key filenames to be used by this server SSL 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.



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

def set_key_file(opts)
  opts = check_params(opts,[:keys])
  super(opts)
end

#set_modssl_emulation_state(opts) ⇒ Object

Sets the states to emulate modSSL for this server SSL 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.



570
571
572
573
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 570

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

#set_passphrase(opts) ⇒ Object

Sets the key passphrases (if any) for this server SSL 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.



583
584
585
586
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 583

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

#set_peer_certificate_mode(opts) ⇒ Object

Sets the peer certification modes for this server SSL 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.



596
597
598
599
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 596

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

#set_profile_mode(opts) ⇒ Object

Sets the modes for this server SSL 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.



609
610
611
612
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 609

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

#set_renegotiation_period(opts) ⇒ Object

Sets the SSL renegotiation periods for this server SSL 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.



622
623
624
625
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 622

def set_renegotiation_period(opts)
  opts = check_params(opts,[:periods])
  super(opts)
end

#set_renegotiation_state(opts) ⇒ Object

Sets the states controlling whether mid-stream renegotiation is allowed for this server SSL profile. If renegotiations are enabled, the behavior is unchanged from previous releases, and mid-stream SSL renegotiations are allowed. If renegotiations are disabled, and we are acting as an SSL client, we ignore the server's HelloRequest messages. For ServerSSL, renegotiations are enabled by default.

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.



639
640
641
642
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 639

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

#set_renegotiation_throughput(opts) ⇒ Object

Sets the SSL renegotiation throughputs for this server SSL 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.



652
653
654
655
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 652

def set_renegotiation_throughput(opts)
  opts = check_params(opts,[:throughputs])
  super(opts)
end

#set_ssl_option(opts) ⇒ Object

Sets the SSL options for this server SSL 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.



665
666
667
668
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 665

def set_ssl_option(opts)
  opts = check_params(opts,[:options])
  super(opts)
end

#set_strict_resume_state(opts) ⇒ Object

Sets the states to enforce strict SSL session resumption per RFC2246 for this server SSL profile. If the state is true/enabled, don't send a close notify alert when closing 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.



680
681
682
683
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 680

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

#set_unclean_shutdown_state(opts) ⇒ Object

Sets the states to do an unclean shutdown for this server SSL profile. If the state is true/enabled, don't send a close notify alert when closing 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.



694
695
696
697
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 694

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

#ssl_optionProfileSSLOption

Gets the SSL options for this server SSL 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_server_ssl.rb', line 306

def ssl_option
  super
end

#statisticsProfileServerSSLStatistics

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



317
318
319
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 317

def statistics
  super
end

#strict_resume_stateProfileEnabledState

Gets the states to enforce strict SSL session resumption per RFC2246 for this server SSL 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.



329
330
331
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 329

def strict_resume_state
  super
end

#unclean_shutdown_stateProfileEnabledState

Gets the states to do an unclean shutdown for this server SSL 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.



340
341
342
# File 'lib/icontrol/local_lb/profile_server_ssl.rb', line 340

def unclean_shutdown_state
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


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

def version
  super
end