Class: IControl::Management::RADIUSServer

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

Overview

The RADIUSServer interface enables you to manage RADIUS Server configuration.

Defined Under Namespace

Classes: RADIUSServerDefinition, RADIUSServerDefinitionSequence

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

- (Object) create

Creates this RADIUS server.

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.



15
16
17
# File 'lib/icontrol/management/radius_server.rb', line 15

def create
  super
end

- (Object) delete_all_servers

Deletes all RADIUS server.

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.



25
26
27
# File 'lib/icontrol/management/radius_server.rb', line 25

def delete_all_servers
  super
end

- (Object) delete_server

Deletes this RADIUS server.

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.



35
36
37
# File 'lib/icontrol/management/radius_server.rb', line 35

def delete_server
  super
end

- (String) ip_or_hostname

Gets the IP addresses or hostnames of the RADIUS server.

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.



46
47
48
# File 'lib/icontrol/management/radius_server.rb', line 46

def ip_or_hostname
  super
end

- (String) list

Gets a list of all RADIUS server.

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.



57
58
59
# File 'lib/icontrol/management/radius_server.rb', line 57

def list
  super
end

- (long) port

Gets the ports of the RADIUS server.

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.



68
69
70
# File 'lib/icontrol/management/radius_server.rb', line 68

def port
  super
end

- (String) secret

Gets the secrets of the RADIUS server.

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.



79
80
81
# File 'lib/icontrol/management/radius_server.rb', line 79

def secret
  super
end

- (Object) set_ip_or_hostname(opts)

Sets the IP addresses or hostnames of the RADIUS server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ip_or_hostnames (String)

    The IP addresses or hostnames used by the servers.

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
113
# File 'lib/icontrol/management/radius_server.rb', line 110

def set_ip_or_hostname(opts)
  check_params(opts,[:ip_or_hostnames])
  super
end

- (Object) set_port(opts)

Sets the ports of the RADIUS server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ports (long)

    The ports used by the servers.

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
126
# File 'lib/icontrol/management/radius_server.rb', line 123

def set_port(opts)
  check_params(opts,[:ports])
  super
end

- (Object) set_secret(opts)

Sets the secrets of the RADIUS server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :secrets (String)

    The secrets used by the servers.

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.



136
137
138
139
# File 'lib/icontrol/management/radius_server.rb', line 136

def set_secret(opts)
  check_params(opts,[:secrets])
  super
end

- (Object) set_timeout(opts)

Sets the timeouts of the RADIUS server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :timeouts (long)

    The timeouts used by the servers.

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.



149
150
151
152
# File 'lib/icontrol/management/radius_server.rb', line 149

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

- (long) timeout

Gets the timeouts of the RADIUS server.

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.



90
91
92
# File 'lib/icontrol/management/radius_server.rb', line 90

def timeout
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


98
99
100
# File 'lib/icontrol/management/radius_server.rb', line 98

def version
  super
end