Class: IControl::LocalLB::ProfileAuth

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

Overview

The ProfileAuth interface enables you to manipulate a local load balancer's authentication profile.

Defined Under Namespace

Classes: ProfileAuthStatisticEntry, ProfileAuthStatisticEntrySequence, ProfileAuthStatistics

Instance Method Summary collapse

Dynamic Method Handling

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

Instance Method Details

#all_statisticsProfileAuthStatistics

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



52
53
54
# File 'lib/icontrol/local_lb/profile_auth.rb', line 52

def all_statistics
  super
end

#authentication_methodProfileAuthenticationMethod

Gets the authentication methods that this profile will be using.

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.



63
64
65
# File 'lib/icontrol/local_lb/profile_auth.rb', line 63

def authentication_method
  super
end

#configuration_nameProfileString

Gets the names of the authentication configurations that this profile will be using.

Returns:

Raises:

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

    raised if the client credentials are not valid.

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

    raised if one of the arguments is invalid.

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

    raised if an operation error occurs.



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

def configuration_name
  super
end

#create(opts) ⇒ Object

Creates this auth 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_auth.rb', line 20

def create(opts)
  opts = check_params(opts,[:config_names,:auth_methods])
  super(opts)
end

#credential_sourceProfileCredentialSource

Gets the sources of the credentials that this profile will be using.

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.



85
86
87
# File 'lib/icontrol/local_lb/profile_auth.rb', line 85

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



97
98
99
# File 'lib/icontrol/local_lb/profile_auth.rb', line 97

def default_profile
  super
end

#delete_all_profilesObject

Deletes all auth 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_auth.rb', line 31

def delete_all_profiles
  super
end

#delete_profileObject

Deletes this auth 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_auth.rb', line 41

def delete_profile
  super
end

#idle_timeoutProfileULong

Gets the idle timeout for this auth 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.



108
109
110
# File 'lib/icontrol/local_lb/profile_auth.rb', line 108

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



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

def is_base_profile
  super
end

#listString

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



119
120
121
# File 'lib/icontrol/local_lb/profile_auth.rb', line 119

def list
  super
end

#profile_modeProfileProfileMode

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



130
131
132
# File 'lib/icontrol/local_lb/profile_auth.rb', line 130

def profile_mode
  super
end

#reset_statisticsObject

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



182
183
184
# File 'lib/icontrol/local_lb/profile_auth.rb', line 182

def reset_statistics
  super
end

#rule_nameProfileString

Gets the names of rules that this profile will be using.

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.



141
142
143
# File 'lib/icontrol/local_lb/profile_auth.rb', line 141

def rule_name
  super
end

#set_authentication_method(opts) ⇒ Object

Sets the authentication methods that this profile will be using.

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.



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

def set_authentication_method(opts)
  opts = check_params(opts,[:auth_methods])
  super(opts)
end

#set_configuration_name(opts) ⇒ Object

Sets the names of the authentication configurations that this profile will be using.

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.



207
208
209
210
# File 'lib/icontrol/local_lb/profile_auth.rb', line 207

def set_configuration_name(opts)
  opts = check_params(opts,[:config_names])
  super(opts)
end

#set_credential_source(opts) ⇒ Object

Sets the sources of the credentials that this profile will be using.

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.



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

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



234
235
236
237
# File 'lib/icontrol/local_lb/profile_auth.rb', line 234

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

#set_idle_timeout(opts) ⇒ Object

Sets the idle timeout for this auth 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.



247
248
249
250
# File 'lib/icontrol/local_lb/profile_auth.rb', line 247

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

#set_profile_mode(opts) ⇒ Object

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



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

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

#set_rule_name(opts) ⇒ Object

Sets the names of rules that this profile will be using.

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.



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

def set_rule_name(opts)
  opts = check_params(opts,[:rule_names])
  super(opts)
end

#statisticsProfileAuthStatistics

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



152
153
154
# File 'lib/icontrol/local_lb/profile_auth.rb', line 152

def statistics
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


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

def version
  super
end