Class: IControl::LocalLB::ProfileClientSSL

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

Overview

The ProfileClientSSL interface enables you to manipulate a local load balancer's client SSL profile.

Defined Under Namespace

Classes: ProfileClientSSLStatisticEntry, ProfileClientSSLStatisticEntrySequence, ProfileClientSSLStatistics

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 client 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.



53
54
55
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 53

def alert_timeout
  super
end

#all_statisticsProfileClientSSLStatistics

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



64
65
66
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 64

def all_statistics
  super
end

#allow_nonssl_stateProfileEnabledState

Gets the states to indicate whether to allow non-SSL connections to pass through as cleartext.

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.



76
77
78
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 76

def allow_nonssl_state
  super
end

#authenticate_depthProfileULong

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



87
88
89
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 87

def authenticate_depth
  super
end

#authenticate_once_stateProfileEnabledState

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



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

def authenticate_once_state
  super
end

#ca_fileProfileString

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



109
110
111
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 109

def ca_file
  super
end

#cache_sizeProfileULong

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



120
121
122
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 120

def cache_size
  super
end

#cache_timeoutProfileULong

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



131
132
133
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 131

def cache_timeout
  super
end

#certificate_fileProfileString

Gets the certificate filenames to be used by BIG-IP acting as an SSL server.

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.



142
143
144
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 142

def certificate_file
  super
end

#chain_fileProfileString

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



153
154
155
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 153

def chain_file
  super
end

#cipher_listProfileStringArray

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



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

def cipher_list
  super
end

#client_certificate_ca_fileProfileString

Gets the client certificate CA filenames for this client 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.



175
176
177
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 175

def client_certificate_ca_file
  super
end

#create(opts) ⇒ Object

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



20
21
22
23
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 20

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

#crl_fileProfileString

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



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

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.



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

def default_profile
  super
end

#delete_all_profilesObject

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



31
32
33
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 31

def delete_all_profiles
  super
end

#delete_profileObject

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



41
42
43
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 41

def delete_profile
  super
end

#handshake_timeoutProfileULong

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



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

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.



386
387
388
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 386

def is_base_profile
  super
end

#key_fileProfileString

Gets the key filenames to be used by BIG-IP acting as an SSL server.

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.



221
222
223
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 221

def key_file
  super
end

#listString

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



232
233
234
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 232

def list
  super
end

#modssl_emulation_stateProfileEnabledState

Gets the states to emulate modSSL for this client 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.



243
244
245
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 243

def modssl_emulation_state
  super
end

#passphraseProfileString

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



254
255
256
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 254

def passphrase
  super
end

#peer_certification_modeProfileClientSSLCertificateMode

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



265
266
267
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 265

def peer_certification_mode
  super
end

#profile_modeProfileProfileMode

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



276
277
278
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 276

def profile_mode
  super
end

#renegotiation_maximum_record_delayProfileULong

Gets the SSL renegotiation maximum record delay for this client 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.



287
288
289
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 287

def renegotiation_maximum_record_delay
  super
end

#renegotiation_periodProfileULong

Gets the SSL renegotiation periods for this client 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.



298
299
300
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 298

def renegotiation_period
  super
end

#renegotiation_stateProfileEnabledState

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



310
311
312
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 310

def renegotiation_state
  super
end

#renegotiation_throughputProfileULong

Gets the SSL renegotiation throughputs for this client 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.



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

def renegotiation_throughput
  super
end

#reset_statisticsObject

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



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

def reset_statistics
  super
end

#set_alert_timeout(opts) ⇒ Object

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



409
410
411
412
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 409

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

#set_allow_nonssl_state(opts) ⇒ Object

Sets the states to indicate whether to allow non-SSL connections to pass through as cleartext.

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.



423
424
425
426
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 423

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

#set_authenticate_depth(opts) ⇒ Object

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



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

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

#set_authenticate_once_state(opts) ⇒ Object

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



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

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 client 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_client_ssl.rb', line 464

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 client 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_client_ssl.rb', line 477

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

#set_cache_timeout(opts) ⇒ Object

Sets the SSL session cache timeouts for this client 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_client_ssl.rb', line 490

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 BIG-IP acting as an SSL server.

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_client_ssl.rb', line 503

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 client 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_client_ssl.rb', line 516

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

#set_cipher_list(opts) ⇒ Object

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



529
530
531
532
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 529

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

#set_client_certificate_ca_file(opts) ⇒ Object

Sets the client certificate CA filenames for this client 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.



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

def set_client_certificate_ca_file(opts)
  opts = check_params(opts,[:client_cert_cas])
  super(opts)
end

#set_crl_file(opts) ⇒ Object

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



555
556
557
558
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 555

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.



569
570
571
572
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 569

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 client 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_client_ssl.rb', line 583

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 BIG-IP acting as an SSL server.

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_client_ssl.rb', line 596

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 client 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_client_ssl.rb', line 609

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 client 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_client_ssl.rb', line 622

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 client 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.



635
636
637
638
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 635

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

#set_profile_mode(opts) ⇒ Object

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



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

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

#set_renegotiation_maximum_record_delay(opts) ⇒ Object

Sets the SSL renegotiation maximum record delay for this client 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.



661
662
663
664
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 661

def set_renegotiation_maximum_record_delay(opts)
  opts = check_params(opts,[:delays])
  super(opts)
end

#set_renegotiation_period(opts) ⇒ Object

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



674
675
676
677
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 674

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 client 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 server, we will abort the connection. For ClientSSL, renegotiations are disabled 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.



691
692
693
694
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 691

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 client 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.



704
705
706
707
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 704

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

#set_ssl_option(opts) ⇒ Object

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



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

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 client 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.



732
733
734
735
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 732

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 client 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.



746
747
748
749
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 746

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

#ssl_optionProfileSSLOption

Gets the SSL options for this client 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.



332
333
334
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 332

def ssl_option
  super
end

#statisticsProfileClientSSLStatistics

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



343
344
345
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 343

def statistics
  super
end

#strict_resume_stateProfileEnabledState

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



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

def strict_resume_state
  super
end

#unclean_shutdown_stateProfileEnabledState

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



366
367
368
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 366

def unclean_shutdown_state
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


374
375
376
# File 'lib/icontrol/local_lb/profile_client_ssl.rb', line 374

def version
  super
end