Class: IControl::Management::RADIUSConfiguration

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/management/radius_configuration.rb,
lib/icontrol/management.rb

Overview

The RADIUSConfiguration interface enables you to manage RADIUS PAM configuration.

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

- (EnabledState) accounting_validation_state

Gets the states indicating whether to enable/disable validation of the accounting response vector. This option should only be set necessary for older servers, i.e. Livingston 1.16.

Returns:

  • (EnabledState)

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/management/radius_configuration.rb', line 76

def accounting_validation_state
  super
end

- (Object) add_server(opts)

Adds/associates servers to this RADIUS configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[])

    The servers to add to the RADIUS configurations.

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.



16
17
18
19
# File 'lib/icontrol/management/radius_configuration.rb', line 16

def add_server(opts)
  check_params(opts,[:servers])
  super
end

- (String) client_id

Gets the the NAS-Identifier RADIUS attribute with client_ids. If the client_id option is not specified, the PAM service type is used instead. This feature may be disabled by using empty strings for client_ids.

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.



89
90
91
# File 'lib/icontrol/management/radius_configuration.rb', line 89

def client_id
  super
end

- (Object) create(opts)

Creates this RADIUS configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[])

    The list of servers to be assigned to each of the configurations.

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.



29
30
31
32
# File 'lib/icontrol/management/radius_configuration.rb', line 29

def create(opts)
  check_params(opts,[:servers])
  super
end

- (Object) create_default_authentication_radius_configuration(opts)

Creates the default authentication RADIUS configuration.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String)

    The list of servers to be assigned to the configurations.

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.



42
43
44
45
# File 'lib/icontrol/management/radius_configuration.rb', line 42

def create_default_authentication_radius_configuration(opts)
  check_params(opts,[:servers])
  super
end

- (EnabledState) debug_state

Gets the states indicating whether syslog debugging is enabled/disabled.

Returns:

  • (EnabledState)

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.



100
101
102
# File 'lib/icontrol/management/radius_configuration.rb', line 100

def debug_state
  super
end

- (Object) delete_all_configurations

Deletes all RADIUS configurations.

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/management/radius_configuration.rb', line 53

def delete_all_configurations
  super
end

- (Object) delete_configuration

Deletes this RADIUS configurations.

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/management/radius_configuration.rb', line 63

def delete_configuration
  super
end

- (String) list

Gets a list of all RADIUS configurations.

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.



111
112
113
# File 'lib/icontrol/management/radius_configuration.rb', line 111

def list
  super
end

- (Object) remove_all_servers

Removes all servers from this RADIUS configurations.

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/management/radius_configuration.rb', line 152

def remove_all_servers
  super
end

- (Object) remove_server(opts)

Removes servers from this RADIUS configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[])

    The servers to remove from the RADIUS configurations.

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
167
# File 'lib/icontrol/management/radius_configuration.rb', line 164

def remove_server(opts)
  check_params(opts,[:servers])
  super
end

- (long) retry

Gets the number of attempts to communicate with the server before concluding that the server has failed.

Returns:

  • (long)

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.



123
124
125
# File 'lib/icontrol/management/radius_configuration.rb', line 123

def retry
  super
end

- (String[]) server

Gets the lists of servers this RADIUS configurations are associated with.

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.



134
135
136
# File 'lib/icontrol/management/radius_configuration.rb', line 134

def server
  super
end

- (Object) set_accounting_validation_state(opts)

Sets the states indicating whether to enable/disable validation of the accounting response vector. This option should only be set necessary for older servers, i.e. Livingston 1.16.

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.



179
180
181
182
# File 'lib/icontrol/management/radius_configuration.rb', line 179

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

- (Object) set_client_id(opts)

Sets the NAS-Identifier RADIUS attribute with client_ids. If the client_id option is not specified, the PAM service type is used instead. This feature may be disabled by using empty strings for client_ids.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :client_ids (String)

    The client ids used by the configurations.

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/management/radius_configuration.rb', line 194

def set_client_id(opts)
  check_params(opts,[:client_ids])
  super
end

- (Object) set_debug_state(opts)

Sets the states indicating whether syslog debugging is enabled/disabled.

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/management/radius_configuration.rb', line 207

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

- (Object) set_retry(opts)

Sets the number of attempts to communicate with the server before concluding that the server has failed.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :retries (long)

    The retry values used by the configurations.

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
224
# File 'lib/icontrol/management/radius_configuration.rb', line 221

def set_retry(opts)
  check_params(opts,[:retries])
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


142
143
144
# File 'lib/icontrol/management/radius_configuration.rb', line 142

def version
  super
end