Class: IControl::LocalLB::ProfileRADIUS

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

Overview

The ProfileRADIUS interface enables you to manipulate a local load balancer's RADIUS profile.

Defined Under Namespace

Classes: ProfileRADIUSStatisticEntry, ProfileRADIUSStatisticEntrySequence, ProfileRADIUSStatistics

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

#add_client(opts) ⇒ Object

Adds to the lists of host and network addresses from which clients can connect. See get_client for more information on the client specification.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :clients (String[])

    The lists of clients.

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_radius.rb', line 20

def add_client(opts)
  opts = check_params(opts,[:clients])
  super(opts)
end

#all_statisticsProfileRADIUSStatistics

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



62
63
64
# File 'lib/icontrol/local_lb/profile_radius.rb', line 62

def all_statistics
  super
end

#clientProfileStringArray

Gets the list of host and network addresses from which clients can connect. An entry in the list can be a host or network address, for example: 10.10.10.0/24 or 10.10.10.10. An empty value indicates that any client can connect.

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.



75
76
77
# File 'lib/icontrol/local_lb/profile_radius.rb', line 75

def client
  super
end

#createObject

Creates this RADIUS 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_radius.rb', line 31

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



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

def default_profile
  super
end

#delete_all_profilesObject

Deletes all RADIUS 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_radius.rb', line 41

def delete_all_profiles
  super
end

#delete_profileObject

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



51
52
53
# File 'lib/icontrol/local_lb/profile_radius.rb', line 51

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



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

def is_base_profile
  super
end

#listString

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



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

def list
  super
end

#persist_avpProfileString

Gets the the RADIUS Attribute (Value Pair; AVP) on which to persist for each of the profile given. See set_persist_avp for more information on the AVP specification.

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.



110
111
112
# File 'lib/icontrol/local_lb/profile_radius.rb', line 110

def persist_avp
  super
end

#remove_client(opts) ⇒ Object

Removes entries from the lists of host and network addresses from which clients can connect. See get_client for more information on the client specification.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :clients (String[])

    The lists of clients.

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.



154
155
156
157
# File 'lib/icontrol/local_lb/profile_radius.rb', line 154

def remove_client(opts)
  opts = check_params(opts,[:clients])
  super(opts)
end

#reset_statisticsObject

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



165
166
167
# File 'lib/icontrol/local_lb/profile_radius.rb', line 165

def reset_statistics
  super
end

#set_default_clientObject

Resets the client list to the parent defaults.

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_radius.rb', line 175

def set_default_client
  super
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.



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

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

#set_persist_avp(opts) ⇒ Object

Sets the RADIUS Attribute (Value Pair; AVP) on which to persist for each of the profile given. The attribute specification can be a string or a numeric code (1-255), encoded as string. If the string is empty, or the code does not exist in the traffic coming to the system, then persist is disabled (if the name is not recognized, this method will produce an error). See RFC 2865, section 5, for valid base numeric codes. Valid names are as listed in section 5, in any mix of upper and lower case.

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.



206
207
208
209
# File 'lib/icontrol/local_lb/profile_radius.rb', line 206

def set_persist_avp(opts)
  opts = check_params(opts,[:avps])
  super(opts)
end

#statisticsProfileRADIUSStatistics

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



121
122
123
# File 'lib/icontrol/local_lb/profile_radius.rb', line 121

def statistics
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


129
130
131
# File 'lib/icontrol/local_lb/profile_radius.rb', line 129

def version
  super
end