Class: Cisco::TacacsServer

Inherits:
NodeUtil show all
Defined in:
lib/cisco_node_utils/tacacs_server.rb

Overview

TacacsServer - node utility class for TACACS+ server config management

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from NodeUtil

client, #client, config_get, #config_get, #config_get_default, config_get_default, config_set, #config_set, #get, #ios_xr?, #nexus?, #node, node, platform, #platform, supports?, #supports?

Constructor Details

#initialize(instantiate = true) ⇒ TacacsServer

Returns a new instance of TacacsServer.



27
28
29
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 27

def initialize(instantiate=true)
  enable if instantiate && !TacacsServer.enabled
end

Class Method Details

.default_deadtime ⇒ Object

Get default deadtime



84
85
86
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 84

def self.default_deadtime
  config_get_default('tacacs_server', 'deadtime')
end

.default_directed_request ⇒ Object

Get default directed_request



104
105
106
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 104

def self.default_directed_request
  config_get_default('tacacs_server', 'directed_request')
end

.default_encryption_password ⇒ Object

Get default encryption password



153
154
155
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 153

def self.default_encryption_password
  config_get_default('tacacs_server', 'encryption_password')
end

.default_encryption_type ⇒ Object

Get default encryption type



142
143
144
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 142

def self.default_encryption_type
  config_get_default('tacacs_server', 'encryption_type')
end

.default_source_interface ⇒ Object

Get default source interface



131
132
133
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 131

def self.default_source_interface
  config_get_default('tacacs_server', 'source_interface')
end

.default_timeout ⇒ Object

Get default timeout



67
68
69
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 67

def self.default_timeout
  config_get_default('tacacs_server', 'timeout')
end

.enabled ⇒ Object

Check feature enablement



32
33
34
35
36
37
38
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 32

def self.enabled
  config_get('tacacs_server', 'feature')
rescue Cisco::CliError => e
  # cmd will syntax reject when feature is not enabled
  raise unless e.clierror =~ /Syntax error/
  return false
end

Instance Method Details

#deadtime ⇒ Object

Get deadtime



79
80
81
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 79

def deadtime
  config_get('tacacs_server', 'deadtime')
end

#deadtime=(deadtime) ⇒ Object

Set deadtime



72
73
74
75
76
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 72

def deadtime=(deadtime)
  # 'no tacacs deadtime' will fail.
  # Just set it to the requested timeout value.
  config_set('tacacs_server', 'deadtime', '', deadtime)
end

#destroy ⇒ Object

Disable tacacs_server feature



46
47
48
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 46

def destroy
  config_set('tacacs_server', 'feature', 'no') unless platform == :ios_xr
end

#directed_request=(state) ⇒ Object

Set directed_request



89
90
91
92
93
94
95
96
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 89

def directed_request=(state)
  fail TypeError unless state == true || state == false
  if state == TacacsServer.default_directed_request
    config_set('tacacs_server', 'directed_request', 'no')
  else
    config_set('tacacs_server', 'directed_request', '')
  end
end

#directed_request? ⇒ Boolean

Check if directed request is enabled

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 99

def directed_request?
  config_get('tacacs_server', 'directed_request')
end

#enable ⇒ Object

Enable tacacs_server feature



41
42
43
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 41

def enable
  config_set('tacacs_server', 'feature', '') unless platform == :ios_xr
end

#encryption_key_set(enctype, password) ⇒ Object

Set encryption type and password



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 158

def encryption_key_set(enctype, password)
  # if enctype is TACACS_SERVER_ENC_UNKNOWN, we will unset the key
  if enctype == TACACS_SERVER_ENC_UNKNOWN
    # if current encryption type is not TACACS_SERVER_ENC_UNKNOWN, we
    # need to unset it. Otherwise the box is not configured with key, we
    # don't need to do anything
    if encryption_type != TACACS_SERVER_ENC_UNKNOWN
      config_set('tacacs_server', 'encryption', state:  'no',
                                                option: encryption_type,
                                                key:    encryption_password)
    end
  else
    config_set('tacacs_server', 'encryption', state: '', option: enctype,
                key: password)
  end
end

#encryption_password ⇒ Object

Get encryption password



147
148
149
150
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 147

def encryption_password
  match = config_get('tacacs_server', 'encryption_password')
  match.empty? ? TacacsServer.default_encryption_password : match[1]
end

#encryption_type ⇒ Object

Get encryption type used for the key



136
137
138
139
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 136

def encryption_type
  match = config_get('tacacs_server', 'encryption_type')
  match.nil? ? TACACS_SERVER_ENC_UNKNOWN : match[0].to_i
end

#source_interface ⇒ Object

Get source interface



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 119

def source_interface
  # Sample output
  # ip tacacs source-interface Ethernet1/1
  # no tacacs source-interface
  match = config_get('tacacs_server', 'source_interface')
  return TacacsServer.default_source_interface if match.empty?
  # match_data will contain one of the following
  # [nil, " Ethernet1/1"] or ["no", nil]
  match[0] == 'no' ? TacacsServer.default_source_interface : match[1]
end

#source_interface=(name) ⇒ Object

Set source interface



109
110
111
112
113
114
115
116
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 109

def source_interface=(name)
  fail TypeError unless name.is_a? String
  if name.empty?
    config_set('tacacs_server', 'source_interface', 'no', '')
  else
    config_set('tacacs_server', 'source_interface', '', name)
  end
end

#timeout ⇒ Object

Get timeout



62
63
64
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 62

def timeout
  config_get('tacacs_server', 'timeout')
end

#timeout=(timeout) ⇒ Object

Set timeout



55
56
57
58
59
 
# File 'lib/cisco_node_utils/tacacs_server.rb', line 55

def timeout=(timeout)
  # 'no tacacs timeout' will fail.
  # Just set it to the requested timeout value.
  config_set('tacacs_server', 'timeout', state: '', timeout: timeout)
end