Class: IControl::Management::TACACSConfiguration

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

Overview

The TACACSConfiguration interface enables you to manage TACACS 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

#accounting_to_all_stateEnabledState

Gets the states such that if enabled and if multiple servers are defined, send accounting start/stop packets to all servers (if session accounting has been enabled in the PAM service configuration).

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.



66
67
68
# File 'lib/icontrol/management/tacacs_configuration.rb', line 66

def accounting_to_all_state
  super
end

#add_server(opts) ⇒ Object

Adds/associates servers to this TACACS configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[])

    The servers to add to the TACACS 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/tacacs_configuration.rb', line 16

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

#create(opts) ⇒ Object

Creates this TACACS configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :secrets (String)

    The secret keys used to encrypt/decrypt packets sent/received from the servers.

  • :service_names (String)

    The TACACS+ servers' listening service names used by the configurations.

  • :protocol_names (String)

    The TACACS+ servers' listening protocol names used by the configurations.

  • :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.



32
33
34
35
# File 'lib/icontrol/management/tacacs_configuration.rb', line 32

def create(opts)
  opts = check_params(opts,[:secrets,:service_names,:protocol_names,:servers])
  super(opts)
end

#debug_stateEnabledState

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.



77
78
79
# File 'lib/icontrol/management/tacacs_configuration.rb', line 77

def debug_state
  super
end

#delete_all_configurationsObject

Deletes all TACACS 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.



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

def delete_all_configurations
  super
end

#delete_configurationObject

Deletes this TACACS 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/tacacs_configuration.rb', line 53

def delete_configuration
  super
end

#encryption_stateEnabledState

Gets the states indicating whether encryption on TACACS+ packets 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.



88
89
90
# File 'lib/icontrol/management/tacacs_configuration.rb', line 88

def encryption_state
  super
end

#first_hit_stateEnabledState

Gets the states such that if enabled and if multiple servers are defined, try to authenticate the user on all servers until the first authentication succeeds, or until all servers have been queried. The first success response results in the auth succeeding.

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.



102
103
104
# File 'lib/icontrol/management/tacacs_configuration.rb', line 102

def first_hit_state
  super
end

#listString

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



113
114
115
# File 'lib/icontrol/management/tacacs_configuration.rb', line 113

def list
  super
end

#protocol_nameString

Gets the names of the TACACS+ servers' listening protocols used by the 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.



124
125
126
# File 'lib/icontrol/management/tacacs_configuration.rb', line 124

def protocol_name
  super
end

#remove_server(opts) ⇒ Object

Removes servers from this TACACS configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[])

    The servers to remove from the TACACS 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.



177
178
179
180
# File 'lib/icontrol/management/tacacs_configuration.rb', line 177

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

#secretString

Gets the secret keys used to encrypt/decrypt packets sent/received from the 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.



135
136
137
# File 'lib/icontrol/management/tacacs_configuration.rb', line 135

def secret
  super
end

#serverString[]

Gets the lists of servers this TACACS 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.



146
147
148
# File 'lib/icontrol/management/tacacs_configuration.rb', line 146

def server
  super
end

#service_nameString

Gets the names of the TACACS+ servers' listening services used by the 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.



157
158
159
# File 'lib/icontrol/management/tacacs_configuration.rb', line 157

def service_name
  super
end

#set_accounting_to_all_state(opts) ⇒ Object

Sets the states such that if enabled and if multiple servers are defined, send accounting start/stop packets to all servers (if session accounting has been enabled in the PAM service configuration).

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.



192
193
194
195
# File 'lib/icontrol/management/tacacs_configuration.rb', line 192

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

#set_debug_state(opts) ⇒ Object

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.



205
206
207
208
# File 'lib/icontrol/management/tacacs_configuration.rb', line 205

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

#set_encryption_state(opts) ⇒ Object

Sets the states indicating whether encryption on TACACS+ packets 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.



218
219
220
221
# File 'lib/icontrol/management/tacacs_configuration.rb', line 218

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

#set_first_hit_state(opts) ⇒ Object

Sets the states such that if enabled and if multiple servers are defined, try to authenticate the user on all servers until the first authentication succeeds, or until all servers have been queried. The first success response results in the auth succeeding.

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.



234
235
236
237
# File 'lib/icontrol/management/tacacs_configuration.rb', line 234

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

#set_protocol_name(opts) ⇒ Object

Sets the names of the TACACS+ servers' listening protocols used by the configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :protocol_names (String)

    The service names 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.



247
248
249
250
# File 'lib/icontrol/management/tacacs_configuration.rb', line 247

def set_protocol_name(opts)
  opts = check_params(opts,[:protocol_names])
  super(opts)
end

#set_secret(opts) ⇒ Object

Sets the secret keys used to encrypt/decrypt packets sent/received from the server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :secrets (String)

    The secrets 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.



260
261
262
263
# File 'lib/icontrol/management/tacacs_configuration.rb', line 260

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

#set_service_name(opts) ⇒ Object

Sets the names of the TACACS+ servers' listening services used by the configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :service_names (String)

    The service names 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.



273
274
275
276
# File 'lib/icontrol/management/tacacs_configuration.rb', line 273

def set_service_name(opts)
  opts = check_params(opts,[:service_names])
  super(opts)
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


165
166
167
# File 'lib/icontrol/management/tacacs_configuration.rb', line 165

def version
  super
end