Class: Cisco::Vlan

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

Overview

Vlan - node utility class for VLAN configuration management

Instance Attribute Summary collapse

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(vlan_id, instantiate = true) ⇒ Vlan

Returns a new instance of Vlan.



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

def initialize(vlan_id, instantiate=true)
  @vlan_id = vlan_id.to_s
  fail ArgumentError,
       'Invalid value(non-numeric Vlan id)' unless @vlan_id[/^\d+$/]

  create if instantiate
end

Instance Attribute Details

#vlan_id ⇒ Object (readonly)

Returns the value of attribute vlan_id.



29
30
31
 
# File 'lib/cisco_node_utils/vlan.rb', line 29

def vlan_id
  @vlan_id
end

Class Method Details

.vlans ⇒ Object 



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/cisco_node_utils/vlan.rb', line 43

def self.vlans
  hash = {}
  vlan_list = config_get('vlan', 'all_vlans')
  return hash if vlan_list.nil?

  vlan_list.each do |id|
    hash[id.to_s] = Vlan.new(id, false)
  end
  hash
end

Instance Method Details

#add_interface(interface) ⇒ Object 



198
199
200
 
# File 'lib/cisco_node_utils/vlan.rb', line 198

def add_interface(interface)
  interface.access_vlan = @vlan_id
end

#association_delta(is, should) ⇒ Object

association_delta is a helper function for the pvlan_association property. It walks the delta hash and adds/removes each target private vlan.



288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/cisco_node_utils/vlan.rb', line 288

def association_delta(is, should)
  delta_hash = Utils.delta_add_remove(should, is)
  Cisco::Logger.debug("association_delta: #{@vlan_id}: #{delta_hash}")
  [:add, :remove].each do |action|
    delta_hash[action].each do |vlans|
      state = (action == :add) ? '' : 'no'
      set_args_keys(state: state, vlans: vlans)
      result = config_set('vlan', 'pvlan_association', @set_args)
      cli_error_check(result)
    end
  end
end

#cli_error_check(result, ignore_message = nil) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/cisco_node_utils/vlan.rb', line 62

def cli_error_check(result, ignore_message=nil)
  # The NXOS vlan cli does not raise an exception in some conditions and
  # instead just displays a STDOUT error message; thus NXAPI does not detect
  # the failure and we must catch it by inspecting the "body" hash entry
  # returned by NXAPI. This vlan cli behavior is unlikely to change.
  # Check for messages that can be safely ignored.

  errors = /(ERROR:|VLAN:|Warning:)/

  return unless
    result[2].is_a?(Hash) && errors.match(result[2]['body'].to_s)
  # Split errors into a list, but keep the delimiter as part of the message.
  error_list =
    (result[2]['body'].split(errors) - ['']).each_slice(2).map(&:join)
  error_list.each do |msg|
    next if ignore_message && msg.to_s.include?(ignore_message)
    fail Cisco::CliError, result[2]['body']
  end
end

#create ⇒ Object 



54
55
56
 
# File 'lib/cisco_node_utils/vlan.rb', line 54

def create
  config_set('vlan', 'create', @vlan_id)
end

#default_fabric_control ⇒ Object 



103
104
105
 
# File 'lib/cisco_node_utils/vlan.rb', line 103

def default_fabric_control
  config_get_default('vlan', 'fabric_control')
end

#default_mapped_vni ⇒ Object 



238
239
240
 
# File 'lib/cisco_node_utils/vlan.rb', line 238

def default_mapped_vni
  config_get_default('vlan', 'mapped_vni')
end

#default_mode ⇒ Object 



138
139
140
 
# File 'lib/cisco_node_utils/vlan.rb', line 138

def default_mode
  config_get_default('vlan', 'mode')
end

#default_private_vlan_association ⇒ Object 



280
281
282
 
# File 'lib/cisco_node_utils/vlan.rb', line 280

def default_private_vlan_association
  config_get_default('vlan', 'pvlan_association')
end

#default_pvlan_type ⇒ Object 



263
264
265
 
# File 'lib/cisco_node_utils/vlan.rb', line 263

def default_pvlan_type
  config_get_default('vlan', 'pvlan_type')
end

#default_shutdown ⇒ Object 



194
195
196
 
# File 'lib/cisco_node_utils/vlan.rb', line 194

def default_shutdown
  config_get_default('vlan', 'shutdown')
end

#default_state ⇒ Object 



180
181
182
 
# File 'lib/cisco_node_utils/vlan.rb', line 180

def default_state
  config_get_default('vlan', 'state')
end

#default_vlan_name ⇒ Object 



156
157
158
 
# File 'lib/cisco_node_utils/vlan.rb', line 156

def default_vlan_name
  sprintf('VLAN%04d', @vlan_id)
end

#destroy ⇒ Object 



58
59
60
 
# File 'lib/cisco_node_utils/vlan.rb', line 58

def destroy
  config_set('vlan', 'destroy', @vlan_id)
end

#fabric_control ⇒ Object 



92
93
94
 
# File 'lib/cisco_node_utils/vlan.rb', line 92

def fabric_control
  config_get('vlan', 'fabric_control', vlan: @vlan_id)
end

#fabric_control=(val) ⇒ Object 



96
97
98
99
100
101
 
# File 'lib/cisco_node_utils/vlan.rb', line 96

def fabric_control=(val)
  no_cmd = (val) ? '' : 'no'
  result = config_set('vlan', 'fabric_control', vlan:  @vlan_id,
                                                state: no_cmd)
  cli_error_check(result)
end

#fabricpath_feature ⇒ Object 



107
108
109
 
# File 'lib/cisco_node_utils/vlan.rb', line 107

def fabricpath_feature
  FabricpathGlobal.fabricpath_feature
end

#fabricpath_feature_set(fabricpath_set) ⇒ Object 



111
112
113
 
# File 'lib/cisco_node_utils/vlan.rb', line 111

def fabricpath_feature_set(fabricpath_set)
  FabricpathGlobal.fabricpath_feature_set(fabricpath_set)
end

#interfaces ⇒ Object 



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/cisco_node_utils/vlan.rb', line 206

def interfaces
  all_interfaces = Interface.interfaces
  interfaces = {}
  all_interfaces.each do |name, i|
    next unless i.switchport_mode == :access
    next unless i.access_vlan.to_i == @vlan_id.to_i
    interfaces[name] = i
  end
  interfaces
end

#mapped_vni ⇒ Object 



217
218
219
 
# File 'lib/cisco_node_utils/vlan.rb', line 217

def mapped_vni
  config_get('vlan', 'mapped_vni', vlan: @vlan_id)
end

#mapped_vni=(vni) ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/cisco_node_utils/vlan.rb', line 225

def mapped_vni=(vni)
  # Some platforms require feature nv_overlay to be enabled first.
  Feature.nv_overlay_enable if requires_nv_overlay?
  Feature.vn_segment_vlan_based_enable
  # Remove the existing mapping first as cli doesn't support overwriting.
  config_set('vlan', 'mapped_vni', vlan: @vlan_id,
                     state: 'no', vni: vni) unless mapped_vni.to_s.empty?
  # Configure the new mapping
  state = vni == default_mapped_vni ? 'no' : ''
  config_set('vlan', 'mapped_vni', vlan: @vlan_id,
                      state: state, vni: vni)
end

#mode ⇒ Object 



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/cisco_node_utils/vlan.rb', line 115

def mode
  result = config_get('vlan', 'mode', @vlan_id)
  return default_mode if result.nil?
  # Note: The yaml definition for this property
  # uses 'multiple' as a workaround for a bug
  # in the N7k nxapi code which displays
  # the 'show vlan' output twice.
  result[0].downcase! if result[0][/FABRICPATH/]
  result[0]
end

#mode=(str) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/cisco_node_utils/vlan.rb', line 126

def mode=(str)
  if str == default_mode
    config_set('vlan', 'mode', @vlan_id, 'no', '')
  else
    if 'fabricpath' == str
      fabricpath_feature_set(:enabled) unless
        :enabled == fabricpath_feature
    end
    config_set('vlan', 'mode', @vlan_id, '', str)
  end
end

#pvlan_association ⇒ Object 



267
268
269
270
271
 
# File 'lib/cisco_node_utils/vlan.rb', line 267

def pvlan_association
  return nil unless Feature.private_vlan_enabled?
  range = config_get('vlan', 'pvlan_association', id: @vlan_id)
  Utils.normalize_range_array(range)
end

#pvlan_association=(range) ⇒ Object 



273
274
275
276
277
278
 
# File 'lib/cisco_node_utils/vlan.rb', line 273

def pvlan_association=(range)
  Feature.private_vlan_enable
  is = Utils.dash_range_to_elements(pvlan_association)
  should = Utils.dash_range_to_elements(range)
  association_delta(is, should)
end

#pvlan_type ⇒ Object 



242
243
244
245
 
# File 'lib/cisco_node_utils/vlan.rb', line 242

def pvlan_type
  return nil unless Feature.private_vlan_enabled?
  config_get('vlan', 'pvlan_type', id: @vlan_id)
end

#pvlan_type=(type) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/cisco_node_utils/vlan.rb', line 247

def pvlan_type=(type)
  Feature.private_vlan_enable
  fail TypeError unless type && type.is_a?(String)

  if type == default_pvlan_type
    return if pvlan_type.empty?
    set_args_keys(state: 'no', type: pvlan_type)
    ignore_msg = 'Warning: Private-VLAN CLI removed'
  else
    set_args_keys(state: '', type: type)
    ignore_msg = 'Warning: Private-VLAN CLI entered'
  end
  result = config_set('vlan', 'pvlan_type', @set_args)
  cli_error_check(result, ignore_msg)
end

#remove_interface(interface) ⇒ Object 



202
203
204
 
# File 'lib/cisco_node_utils/vlan.rb', line 202

def remove_interface(interface)
  interface.access_vlan = interface.default_access_vlan
end

#requires_nv_overlay? ⇒ Boolean

Returns:

  • (Boolean) 


221
222
223
 
# File 'lib/cisco_node_utils/vlan.rb', line 221

def requires_nv_overlay?
  config_get('vlan', 'mapped_vni_requires_nv_overlay')
end

#set_args_keys(hash = {}) ⇒ Object

rubocop:disable Style/AccessorMethodName



87
88
89
90
 
# File 'lib/cisco_node_utils/vlan.rb', line 87

def set_args_keys(hash={}) # rubocop:disable Style/AccessorMethodName
  set_args_keys_default
  @set_args = @set_args.merge!(hash) unless hash.empty?
end

#set_args_keys_default ⇒ Object 



82
83
84
85
 
# File 'lib/cisco_node_utils/vlan.rb', line 82

def set_args_keys_default
  keys = { vlan: @vlan_id }
  @set_args = keys
end

#shutdown ⇒ Object 



184
185
186
 
# File 'lib/cisco_node_utils/vlan.rb', line 184

def shutdown
  config_get('vlan', 'shutdown', vlanid: @vlan_id)
end

#shutdown=(val) ⇒ Object 



188
189
190
191
192
 
# File 'lib/cisco_node_utils/vlan.rb', line 188

def shutdown=(val)
  no_cmd = (val) ? '' : 'no'
  result = config_set('vlan', 'shutdown', @vlan_id, no_cmd)
  cli_error_check(result)
end

#state ⇒ Object 



160
161
162
163
164
165
166
167
168
 
# File 'lib/cisco_node_utils/vlan.rb', line 160

def state
  result = config_get('vlan', 'state', @vlan_id)
  case result
  when /act/
    return 'active'
  when /sus/
    return 'suspend'
  end
end

#state=(str) ⇒ Object 



170
171
172
173
174
175
176
177
178
 
# File 'lib/cisco_node_utils/vlan.rb', line 170

def state=(str)
  str = str.to_s
  if str.empty?
    result = config_set('vlan', 'state', @vlan_id, 'no', '')
  else
    result = config_set('vlan', 'state', @vlan_id, '', str)
  end
  cli_error_check(result)
end

#to_s ⇒ Object 



39
40
41
 
# File 'lib/cisco_node_utils/vlan.rb', line 39

def to_s
  "VLAN #{vlan_id}"
end

#vlan_name ⇒ Object 



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

def vlan_name
  config_get('vlan', 'name', vlanid: @vlan_id)
end

#vlan_name=(str) ⇒ Object 



146
147
148
149
150
151
152
153
154
 
# File 'lib/cisco_node_utils/vlan.rb', line 146

def vlan_name=(str)
  fail TypeError unless str.is_a?(String)
  if str.empty?
    result = config_set('vlan', 'name', @vlan_id, 'no', '')
  else
    result = config_set('vlan', 'name', @vlan_id, '', str)
  end
  cli_error_check(result)
end