Class: IControl::LocalLB::ProfileAuth

Inherits:

Base

• Object
• Base
• IControl::LocalLB::ProfileAuth

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

• #all_statistics ⇒ ProfileAuthStatistics

  Gets the statistics for all the Auth profile.

• #authentication_method ⇒ ProfileAuthenticationMethod

  Gets the authentication methods that this profile will be using.

• #configuration_name ⇒ ProfileString

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

• #create(opts) ⇒ Object

  Creates this auth profile.

• #credential_source ⇒ ProfileCredentialSource

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

• #default_profile ⇒ String

  Gets the names of the default profile from which this profile will derive default values for its attributes.

• #delete_all_profiles ⇒ Object

  Deletes all auth profile.

• #delete_profile ⇒ Object

  Deletes this auth profile.

• #idle_timeout ⇒ ProfileULong

  Gets the idle timeout for this auth profile.

• #is_base_profile ⇒ boolean

  Determines whether this profile are base/pre-configured profile, or user-defined profile.

• #list ⇒ String

  Gets a list of all auth profile.

• #profile_mode ⇒ ProfileProfileMode

  Gets the modes for this auth profile.

• #reset_statistics ⇒ Object

  Resets the statistics for this Auth profile.

• #rule_name ⇒ ProfileString

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

• #set_authentication_method(opts) ⇒ Object

  Sets the authentication methods that this profile will be using.

• #set_configuration_name(opts) ⇒ Object

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

• #set_credential_source(opts) ⇒ Object

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

• #set_default_profile(opts) ⇒ Object

  Sets the names of the default profile from which this profile will derive default values for its attributes.

• #set_idle_timeout(opts) ⇒ Object

  Sets the idle timeout for this auth profile.

• #set_profile_mode(opts) ⇒ Object

  Sets the modes for this auth profile.

• #set_rule_name(opts) ⇒ Object

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

• #statistics ⇒ ProfileAuthStatistics

  Gets the statistics for this Auth profile.

• #version ⇒ String

  Gets the version information for this interface.

Dynamic Method Handling

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

Instance Method Details

#all_statistics ⇒ ProfileAuthStatistics

Gets the statistics for all the Auth profile.

Returns:

• (ProfileAuthStatistics)

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.

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

def all_statistics
  super
end

#authentication_method ⇒ ProfileAuthenticationMethod

Gets the authentication methods that this profile will be using.

Returns:

• (ProfileAuthenticationMethod)

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.

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

def authentication_method
  super
end

#configuration_name ⇒ ProfileString

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

Returns:

• (ProfileString)

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.

# 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):

• :config_names (IControl::LocalLB::ProfileString) —

  The configuration used by the profile.

• :auth_methods (IControl::LocalLB::ProfileAuthenticationMethod) —

  The authentication method used by the 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.

# 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_source ⇒ ProfileCredentialSource

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

Returns:

• (ProfileCredentialSource)

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.

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

def credential_source
  super
end

#default_profile ⇒ String

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.

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

def default_profile
  super
end

#delete_all_profiles ⇒ Object

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.

# File 'lib/icontrol/local_lb/profile_auth.rb', line 31

def delete_all_profiles
  super
end

#delete_profile ⇒ Object

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.

# File 'lib/icontrol/local_lb/profile_auth.rb', line 41

def delete_profile
  super
end

#idle_timeout ⇒ ProfileULong

Gets the idle timeout for this auth profile.

Returns:

• (ProfileULong)

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.

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

def idle_timeout
  super
end

#is_base_profile ⇒ boolean

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.

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

def is_base_profile
  super
end

#list ⇒ String

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.

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

def list
  super
end

#profile_mode ⇒ ProfileProfileMode

Gets the modes for this auth profile.

Returns:

• (ProfileProfileMode)

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.

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

def profile_mode
  super
end

#reset_statistics ⇒ Object

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.

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

def reset_statistics
  super
end

#rule_name ⇒ ProfileString

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

Returns:

• (ProfileString)

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.

# 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):

• :auth_methods (IControl::LocalLB::ProfileAuthenticationMethod) —

  The authentication methods.

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.

# 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):

• :config_names (IControl::LocalLB::ProfileString) —

  The authentication configuration names.

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.

# 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):

• :sources (IControl::LocalLB::ProfileCredentialSource) —

  The sources of the credentials.

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.

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

# 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):

• :timeouts (IControl::LocalLB::ProfileULong) —

  The idle timeout for the specified auth profiles.

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.

# 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):

• :modes (IControl::LocalLB::ProfileProfileMode) —

  The modes of the specified auth profiles.

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.

# 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):

• :rule_names (IControl::LocalLB::ProfileString) —

  The rule names.

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.

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

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

#statistics ⇒ ProfileAuthStatistics

Gets the statistics for this Auth profile.

Returns:

• (ProfileAuthStatistics)

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.

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

def statistics
  super
end

#version ⇒ String

Gets the version information for this interface.

Returns:

• (String)

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

def version
  super
end