Class: Cisco::Interface

Inherits:
InterfaceDeprecated show all
Defined in:
lib/cisco_node_utils/interface.rb

Overview

Interface - node utility class for general interface config management

Constant Summary collapse

ETHERNET =

Regexp to match various Ethernet interface variants:

       Ethernet
GigabitEthernet
             TenGigE
         HundredGigE
                     MgmtEth
Regexp.new('(Ethernet|GigE|MgmtEth)', Regexp::IGNORECASE)
PORTCHANNEL =

Regexp to match various link bundle interface variants

Regexp.new('(port-channel|Bundle-Ether)', Regexp::IGNORECASE)

Constants inherited from InterfaceDeprecated

Cisco::InterfaceDeprecated::PVLAN_PROPERTY

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from InterfaceDeprecated

#configure_private_vlan_host_property, #configure_private_vlan_trunk_property, #default_private_vlan_mapping, #default_switchport_mode_private_vlan_host, #default_switchport_mode_private_vlan_host_association, #default_switchport_mode_private_vlan_host_promisc, #default_switchport_mode_private_vlan_trunk_promiscuous, #default_switchport_mode_private_vlan_trunk_secondary, #default_switchport_private_vlan_association_trunk, #default_switchport_private_vlan_mapping_trunk, #default_switchport_private_vlan_trunk_allowed_vlan, #default_switchport_private_vlan_trunk_native_vlan, #deprecation_warning, #interf_vlan_list_delta, #prepare_array, #private_vlan_mapping, #private_vlan_mapping=, #switchport_enable_and_mode_private_vlan_host, #switchport_mode_private_vlan_host, #switchport_mode_private_vlan_host=, #switchport_mode_private_vlan_host_association, #switchport_mode_private_vlan_host_association=, #switchport_mode_private_vlan_host_promisc, #switchport_mode_private_vlan_host_promisc=, #switchport_mode_private_vlan_trunk_promiscuous, #switchport_mode_private_vlan_trunk_promiscuous=, #switchport_mode_private_vlan_trunk_secondary, #switchport_mode_private_vlan_trunk_secondary=, #switchport_private_vlan_association_trunk, #switchport_private_vlan_association_trunk=, #switchport_private_vlan_mapping_trunk, #switchport_private_vlan_mapping_trunk=, #switchport_private_vlan_trunk_allowed_vlan, #switchport_private_vlan_trunk_allowed_vlan=, #switchport_private_vlan_trunk_native_vlan, #switchport_private_vlan_trunk_native_vlan=

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(name, instantiate = true, default_state = false) ⇒ Interface


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/cisco_node_utils/interface.rb', line 56

def initialize(name, instantiate=true, default_state=false)
  fail TypeError unless name.is_a?(String)
  fail ArgumentError unless name.length > 0
  @name = name.downcase
  @smr = config_get('interface', 'stp_mst_range')
  @svr = config_get('interface', 'stp_vlan_range')
  @match_found = false
  # Keep track of default vs non-default state for
  # interfaces that cannot be created/destroyed.
  @state_default = nil
  # Track ethernet but not sub-interfaces
  if @name[/ethernet/] && !@name[/ethernet.*\.\d+/]
    @state_default = default_state
  end
  create if instantiate
end

Instance Attribute Details

#nameObject (readonly)

Returns the value of attribute name


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

def name
  @name
end

#state_defaultObject (readonly)

Returns the value of attribute state_default


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

def state_default
  @state_default
end

Class Method Details

.capabilities(intf, mode = :hash) ⇒ Object

'capabilities' is a getter-only helper for minitest and beaker. mode values:

:hash = Transform the output into a hash
:raw  = The raw output from 'show int capabilities'. Some multi-line
        values do not translate easily so this option allows the
        caller to extract the data it needs.

Sample cli output:

Model:                 N7K-M132XP-12L
Type (SFP capable):    10Gbase-SR
Speed:                 10,100,1000

Sample hash output: “Type”=>“10Gbase-SR”, “Speed”=>“10,100,1000”


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/cisco_node_utils/interface.rb', line 134

def self.capabilities(intf, mode=:hash)
  array = config_get('interface', 'capabilities', name: intf)
  return array if mode == :raw
  hash = {}
  if array
    array.delete('')
    array.each do |line|
      k, v = line.split(':')
      next if k.nil? || v.nil?
      k.gsub!(/ \(.*\)/, '') # Remove any parenthetical text from key
      v.strip!
      v.gsub!(%r{half/full}, 'half,full') if k == 'Duplex'
      hash[k] = v
    end
  end
  hash
end

.filter(filter, id) ⇒ Object

General-purpose filter for Interface.interfaces(). filter: This may be overloaded in the future to allow a hash of filters.

id: The interface name

Return: true if the interface should be filtered out, false to keep it.


107
108
109
110
111
112
113
114
115
116
117
# File 'lib/cisco_node_utils/interface.rb', line 107

def self.filter(filter, id)
  case filter
  when :pvlan_any
    return false if config_get('interface', 'pvlan_any', name: id)

  else
    # Just a basic pattern filter (:ethernet, :loopback, etc)
    return false if id.match(filter.to_s)
  end
  true
end

.interfaces(opt = nil) ⇒ Object


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/cisco_node_utils/interface.rb', line 77

def self.interfaces(opt=nil)
  hash = {}
  intf_list = config_get('interface', 'all_interfaces')
  return hash if intf_list.nil?

  # Massage intf_list data into an array that is easy
  # to work with.
  intf_list.collect! { |x| x.strip || x }
  intf_list.delete('')
  intf_list = intf_list.join(' ').split('interface')
  intf_list.delete('')

  intf_list.each do |id|
    int_data = id.strip.split(' ')
    next if int_data[0].nil?
    id = int_data[0].downcase
    next if opt && filter(opt, id)
    # If there are any additional options associated
    # with this interface then it's in a non-default
    # state.
    default_state = int_data.size > 1 ? false : true
    hash[id] = Interface.new(id, false, default_state)
  end
  hash
end

Instance Method Details

#access_vlanObject

For range based attributes, a new attribute purge will be added in future. When purge is set to true, all the ranges which are specified in the manifest will be set to the desired values and those which are not specified in the manifest will be set to default. When purge is false, only the ranges specified in the manifest will be set to the values given in the manifest and others are left untouched.


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

def access_vlan
  return nil if switchport_mode == :disabled
  config_get('interface', 'access_vlan', name: @name)
end

#access_vlan=(vlan) ⇒ Object


199
200
201
# File 'lib/cisco_node_utils/interface.rb', line 199

def access_vlan=(vlan)
  config_set('interface', 'access_vlan', name: @name, vlan: vlan)
end

#bfd_echoObject


207
208
209
210
211
# File 'lib/cisco_node_utils/interface.rb', line 207

def bfd_echo
  return nil unless Feature.bfd_enabled?
  return nil if @name[/loop/i]
  config_get('interface', 'bfd_echo', name: @name)
end

#bfd_echo=(val) ⇒ Object


213
214
215
216
217
218
219
220
221
# File 'lib/cisco_node_utils/interface.rb', line 213

def bfd_echo=(val)
  fail ArgumentError, 'Interface cannot be loopback' if
    @name[/loop/i]
  return if val == bfd_echo
  state = (val ? '' : 'no')
  Feature.bfd_enable
  config_set('interface', 'bfd_echo',
             name: @name, state: state)
end

#check_switchport(status) ⇒ Object


1998
1999
2000
2001
2002
# File 'lib/cisco_node_utils/interface.rb', line 1998

def check_switchport(status)
  return if switchport_status?(status)
  fail("#{caller[0][/`.*'/][1..-2]} cannot be set unless " \
       "switchport mode is #{status}")
end

#cli_error_check(result) ⇒ Object



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
# File 'lib/cisco_node_utils/interface.rb', line 1466

def cli_error_check(result)
  # Check for messages that can be safely ignored.
  # The NXOS interface private-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.
  # We must catch it by inspecting the "body" hash entry returned by NXAPI.
  # This vlan cli behavior is unlikely to change.

  errors = /(ERROR:|VLAN:|Eth)/
  return unless
    result[1].is_a?(Hash) && errors.match(result[1]['body'].to_s)
  # Split errors into a list, but keep the delimiter as part of the message.
  error_list =
    (result[1]['body'].split(errors) - ['']).each_slice(2).map(&:join)
  error_list.each do |_msg|
    fail result[1]['body']
  end
end

#createObject


152
153
154
155
156
157
158
159
160
161
# File 'lib/cisco_node_utils/interface.rb', line 152

def create
  feature_vlan_set(true) if @name[/(vlan|bdi)/i]
  config_set('interface', 'create', name: @name)
rescue Cisco::CliError
  # Some XR platforms do not support channel-group configuration
  # on some OS versions. Since this is an OS version difference and not
  # a platform difference, we can't handle this in the YAML.
  raise unless PORTCHANNEL =~ @name && platform == :ios_xr
  raise Cisco::UnsupportedError.new('interface', @name, 'create')
end

#default?Boolean


171
172
173
174
# File 'lib/cisco_node_utils/interface.rb', line 171

def default?
  state = config_get('interface', 'default', name: @name)
  state.nil? ? true : false
end

#default_access_vlanObject


203
204
205
# File 'lib/cisco_node_utils/interface.rb', line 203

def default_access_vlan
  config_get_default('interface', 'access_vlan')
end

#default_bfd_echoObject


223
224
225
226
227
# File 'lib/cisco_node_utils/interface.rb', line 223

def default_bfd_echo
  return nil unless Feature.bfd_enabled?
  return nil if @name[/loop/i]
  config_get_default('interface', 'bfd_echo')
end

#default_descriptionObject


244
245
246
# File 'lib/cisco_node_utils/interface.rb', line 244

def default_description
  config_get_default('interface', 'description')
end

#default_duplexObject


975
976
977
# File 'lib/cisco_node_utils/interface.rb', line 975

def default_duplex
  config_get_default('interface', 'duplex')
end

#default_encapsulation_dot1qObject


262
263
264
# File 'lib/cisco_node_utils/interface.rb', line 262

def default_encapsulation_dot1q
  config_get_default('interface', 'encapsulation_dot1q')
end

#default_fabric_forwarding_anycast_gatewayObject


296
297
298
# File 'lib/cisco_node_utils/interface.rb', line 296

def default_fabric_forwarding_anycast_gateway
  config_get_default('interface', 'fabric_forwarding_anycast_gateway')
end

#default_hsrp_bfdObject


314
315
316
# File 'lib/cisco_node_utils/interface.rb', line 314

def default_hsrp_bfd
  config_get_default('interface', 'hsrp_bfd')
end

#default_hsrp_delayObject


325
326
327
# File 'lib/cisco_node_utils/interface.rb', line 325

def default_hsrp_delay
  [default_hsrp_delay_minimum, default_hsrp_delay_reload]
end

#default_hsrp_delay_minimumObject


343
344
345
# File 'lib/cisco_node_utils/interface.rb', line 343

def default_hsrp_delay_minimum
  config_get_default('interface', 'hsrp_delay_minimum')
end

#default_hsrp_delay_reloadObject


361
362
363
# File 'lib/cisco_node_utils/interface.rb', line 361

def default_hsrp_delay_reload
  config_get_default('interface', 'hsrp_delay_reload')
end

#default_hsrp_mac_refreshObject


377
378
379
# File 'lib/cisco_node_utils/interface.rb', line 377

def default_hsrp_mac_refresh
  config_get_default('interface', 'hsrp_mac_refresh')
end

#default_hsrp_use_biaObject


415
416
417
# File 'lib/cisco_node_utils/interface.rb', line 415

def default_hsrp_use_bia
  config_get_default('interface', 'hsrp_use_bia')
end

#default_hsrp_versionObject


429
430
431
# File 'lib/cisco_node_utils/interface.rb', line 429

def default_hsrp_version
  config_get_default('interface', 'hsrp_version')
end

#default_ipv4_acl_inObject


450
451
452
# File 'lib/cisco_node_utils/interface.rb', line 450

def default_ipv4_acl_in
  config_get_default('interface', 'ipv4_acl_in')
end

#default_ipv4_acl_outObject


471
472
473
# File 'lib/cisco_node_utils/interface.rb', line 471

def default_ipv4_acl_out
  config_get_default('interface', 'ipv4_acl_out')
end

#default_ipv4_addressObject


546
547
548
# File 'lib/cisco_node_utils/interface.rb', line 546

def default_ipv4_address
  config_get_default('interface', 'ipv4_address')
end

#default_ipv4_address_secondaryObject


550
551
552
# File 'lib/cisco_node_utils/interface.rb', line 550

def default_ipv4_address_secondary
  default_ipv4_address
end

#default_ipv4_arp_timeoutObject


583
584
585
# File 'lib/cisco_node_utils/interface.rb', line 583

def default_ipv4_arp_timeout
  config_get_default('interface', ipv4_arp_timeout_lookup_string)
end

#default_ipv4_dhcp_relay_addrObject


607
608
609
# File 'lib/cisco_node_utils/interface.rb', line 607

def default_ipv4_dhcp_relay_addr
  config_get_default('interface', 'ipv4_dhcp_relay_addr')
end

#default_ipv4_dhcp_relay_info_trustObject


623
624
625
# File 'lib/cisco_node_utils/interface.rb', line 623

def default_ipv4_dhcp_relay_info_trust
  config_get_default('interface', 'ipv4_dhcp_relay_info_trust')
end

#default_ipv4_dhcp_relay_src_addr_hsrpObject


638
639
640
# File 'lib/cisco_node_utils/interface.rb', line 638

def default_ipv4_dhcp_relay_src_addr_hsrp
  config_get_default('interface', 'ipv4_dhcp_relay_src_addr_hsrp')
end

#default_ipv4_dhcp_relay_src_intfObject


658
659
660
# File 'lib/cisco_node_utils/interface.rb', line 658

def default_ipv4_dhcp_relay_src_intf
  config_get_default('interface', 'ipv4_dhcp_relay_src_intf')
end

#default_ipv4_dhcp_relay_subnet_broadcastObject


674
675
676
# File 'lib/cisco_node_utils/interface.rb', line 674

def default_ipv4_dhcp_relay_subnet_broadcast
  config_get_default('interface', 'ipv4_dhcp_relay_subnet_broadcast')
end

#default_ipv4_dhcp_smart_relayObject


690
691
692
# File 'lib/cisco_node_utils/interface.rb', line 690

def default_ipv4_dhcp_smart_relay
  config_get_default('interface', 'ipv4_dhcp_smart_relay')
end

#default_ipv4_forwardingObject


704
705
706
# File 'lib/cisco_node_utils/interface.rb', line 704

def default_ipv4_forwarding
  config_get_default('interface', 'ipv4_forwarding')
end

#default_ipv4_netmask_lengthObject


554
555
556
# File 'lib/cisco_node_utils/interface.rb', line 554

def default_ipv4_netmask_length
  config_get_default('interface', 'ipv4_netmask_length')
end

#default_ipv4_netmask_length_secondaryObject


558
559
560
# File 'lib/cisco_node_utils/interface.rb', line 558

def default_ipv4_netmask_length_secondary
  default_ipv4_netmask_length
end

#default_ipv4_pim_sparse_modeObject


720
721
722
# File 'lib/cisco_node_utils/interface.rb', line 720

def default_ipv4_pim_sparse_mode
  config_get_default('interface', 'ipv4_pim_sparse_mode')
end

#default_ipv4_proxy_arpObject


735
736
737
# File 'lib/cisco_node_utils/interface.rb', line 735

def default_ipv4_proxy_arp
  config_get_default('interface', 'ipv4_proxy_arp')
end

#default_ipv4_redirectsObject


760
761
762
# File 'lib/cisco_node_utils/interface.rb', line 760

def default_ipv4_redirects
  config_get_default('interface', ipv4_redirects_lookup_string)
end

#default_ipv6_acl_inObject


780
781
782
# File 'lib/cisco_node_utils/interface.rb', line 780

def default_ipv6_acl_in
  config_get_default('interface', 'ipv6_acl_in')
end

#default_ipv6_acl_outObject


800
801
802
# File 'lib/cisco_node_utils/interface.rb', line 800

def default_ipv6_acl_out
  config_get_default('interface', 'ipv6_acl_out')
end

#default_ipv6_dhcp_relay_addrObject


824
825
826
# File 'lib/cisco_node_utils/interface.rb', line 824

def default_ipv6_dhcp_relay_addr
  config_get_default('interface', 'ipv6_dhcp_relay_addr')
end

#default_ipv6_dhcp_relay_src_intfObject


844
845
846
# File 'lib/cisco_node_utils/interface.rb', line 844

def default_ipv6_dhcp_relay_src_intf
  config_get_default('interface', 'ipv6_dhcp_relay_src_intf')
end

#default_ipv6_redirectsObject


860
861
862
# File 'lib/cisco_node_utils/interface.rb', line 860

def default_ipv6_redirects
  config_get_default('interface', 'ipv6_redirects')
end

#default_load_interval_counter_1_delayObject


885
886
887
888
889
890
891
892
893
# File 'lib/cisco_node_utils/interface.rb', line 885

def default_load_interval_counter_1_delay
  # for vlan and bdi the default is 60
  if @name[/(vlan|bdi)/i]
    config_get_default('interface',
                       'load_interval_counter_1_delay_vlan_bdi')
  else
    config_get_default('interface', 'load_interval_counter_1_delay')
  end
end

#default_load_interval_counter_2_delayObject


907
908
909
# File 'lib/cisco_node_utils/interface.rb', line 907

def default_load_interval_counter_2_delay
  config_get_default('interface', 'load_interval_counter_2_delay')
end

#default_load_interval_counter_3_delayObject


925
926
927
# File 'lib/cisco_node_utils/interface.rb', line 925

def default_load_interval_counter_3_delay
  config_get_default('interface', 'load_interval_counter_3_delay')
end

#default_mtuObject


949
950
951
# File 'lib/cisco_node_utils/interface.rb', line 949

def default_mtu
  config_get_default('interface', mtu_lookup_string)
end

#default_negotiate_autoObject


1001
1002
1003
# File 'lib/cisco_node_utils/interface.rb', line 1001

def default_negotiate_auto
  config_get_default('interface', negotiate_auto_lookup_string)
end

#default_pim_bfdObject


1061
1062
1063
# File 'lib/cisco_node_utils/interface.rb', line 1061

def default_pim_bfd
  config_get_default('interface', 'pim_bfd')
end

#default_purge_configObject


2097
2098
2099
# File 'lib/cisco_node_utils/interface.rb', line 2097

def default_purge_config
  config_get_default('interface', 'purge_config')
end

#default_pvlan_mappingObject


1806
1807
1808
# File 'lib/cisco_node_utils/interface.rb', line 1806

def default_pvlan_mapping
  config_get_default('interface', 'pvlan_mapping')
end

#default_shutdownObject


1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/cisco_node_utils/interface.rb', line 1014

def default_shutdown
  case @name
  when ETHERNET
    def_sw = system_default_switchport
    def_shut = system_default_switchport_shutdown

    if def_sw && def_shut
      lookup = 'shutdown_ethernet_switchport_shutdown'
    elsif def_sw && !def_shut
      lookup = 'shutdown_ethernet_switchport_noshutdown'
    elsif !def_sw && def_shut
      lookup = 'shutdown_ethernet_noswitchport_shutdown'
    elsif !def_sw && !def_shut
      lookup = 'shutdown_ethernet_noswitchport_noshutdown'
    else
      fail "Error: def_sw #{def_sw}, def_shut #{def_shut}"
    end

  when /loopback/i
    lookup = 'shutdown_loopback'

  when PORTCHANNEL
    lookup = 'shutdown_ether_channel'

  when /Vlan/i
    lookup = 'shutdown_vlan'

  else
    lookup = 'shutdown_unknown'
  end
  config_get_default('interface', lookup)
end

#default_speedObject


962
963
964
# File 'lib/cisco_node_utils/interface.rb', line 962

def default_speed
  config_get_default('interface', 'speed')
end

#default_storm_control_broadcastObject


1078
1079
1080
# File 'lib/cisco_node_utils/interface.rb', line 1078

def default_storm_control_broadcast
  config_get_default('interface', 'storm_control_broadcast')
end

#default_storm_control_multicastObject


1095
1096
1097
# File 'lib/cisco_node_utils/interface.rb', line 1095

def default_storm_control_multicast
  config_get_default('interface', 'storm_control_multicast')
end

#default_storm_control_unicastObject


1112
1113
1114
# File 'lib/cisco_node_utils/interface.rb', line 1112

def default_storm_control_unicast
  config_get_default('interface', 'storm_control_unicast')
end

#default_stp_bpdufilterObject


1132
1133
1134
# File 'lib/cisco_node_utils/interface.rb', line 1132

def default_stp_bpdufilter
  config_get_default('interface', 'stp_bpdufilter')
end

#default_stp_bpduguardObject


1151
1152
1153
# File 'lib/cisco_node_utils/interface.rb', line 1151

def default_stp_bpduguard
  config_get_default('interface', 'stp_bpduguard')
end

#default_stp_costObject


1166
1167
1168
# File 'lib/cisco_node_utils/interface.rb', line 1166

def default_stp_cost
  config_get_default('interface', 'stp_cost')
end

#default_stp_guardObject


1186
1187
1188
# File 'lib/cisco_node_utils/interface.rb', line 1186

def default_stp_guard
  config_get_default('interface', 'stp_guard')
end

1200
1201
1202
# File 'lib/cisco_node_utils/interface.rb', line 1200

def default_stp_link_type
  config_get_default('interface', 'stp_link_type')
end

#default_stp_mst_costObject


1236
1237
1238
# File 'lib/cisco_node_utils/interface.rb', line 1236

def default_stp_mst_cost
  config_get_default('interface', 'stp_mst_cost')
end

#default_stp_mst_port_priorityObject


1258
1259
1260
# File 'lib/cisco_node_utils/interface.rb', line 1258

def default_stp_mst_port_priority
  config_get_default('interface', 'stp_mst_port_priority')
end

#default_stp_port_priorityObject


1214
1215
1216
# File 'lib/cisco_node_utils/interface.rb', line 1214

def default_stp_port_priority
  config_get_default('interface', 'stp_port_priority')
end

#default_stp_port_typeObject


1278
1279
1280
# File 'lib/cisco_node_utils/interface.rb', line 1278

def default_stp_port_type
  config_get_default('interface', 'stp_port_type')
end

#default_stp_vlan_costObject


1300
1301
1302
# File 'lib/cisco_node_utils/interface.rb', line 1300

def default_stp_vlan_cost
  config_get_default('interface', 'stp_vlan_cost')
end

#default_stp_vlan_port_priorityObject


1322
1323
1324
# File 'lib/cisco_node_utils/interface.rb', line 1322

def default_stp_vlan_port_priority
  config_get_default('interface', 'stp_vlan_port_priority')
end

#default_svi_autostateObject


1944
1945
1946
# File 'lib/cisco_node_utils/interface.rb', line 1944

def default_svi_autostate
  system_default_svi_autostate
end

#default_svi_managementObject


1972
1973
1974
# File 'lib/cisco_node_utils/interface.rb', line 1972

def default_svi_management
  config_get_default('interface', 'svi_management')
end

#default_switchport_autostate_excludeObject


1353
1354
1355
# File 'lib/cisco_node_utils/interface.rb', line 1353

def default_switchport_autostate_exclude
  config_get_default('interface', 'switchport_autostate_exclude')
end

#default_switchport_modeObject


1420
1421
1422
1423
1424
1425
# File 'lib/cisco_node_utils/interface.rb', line 1420

def default_switchport_mode
  return nil if platform == :ios_xr
  return :disabled unless system_default_switchport
  IF_SWITCHPORT_MODE.key(
    config_get_default('interface', switchport_mode_lookup_string))
end

#default_switchport_pvlan_hostObject


1498
1499
1500
# File 'lib/cisco_node_utils/interface.rb', line 1498

def default_switchport_pvlan_host
  config_get_default('interface', 'switchport_pvlan_host')
end

#default_switchport_pvlan_host_associationObject


1537
1538
1539
# File 'lib/cisco_node_utils/interface.rb', line 1537

def default_switchport_pvlan_host_association
  config_get_default('interface', 'switchport_pvlan_host_association')
end

#default_switchport_pvlan_mappingObject


1552
1553
1554
# File 'lib/cisco_node_utils/interface.rb', line 1552

def default_switchport_pvlan_mapping
  config_get_default('interface', 'switchport_pvlan_mapping')
end

#default_switchport_pvlan_mapping_trunkObject


1617
1618
1619
# File 'lib/cisco_node_utils/interface.rb', line 1617

def default_switchport_pvlan_mapping_trunk
  config_get_default('interface', 'switchport_pvlan_mapping_trunk')
end

#default_switchport_pvlan_promiscuousObject


1515
1516
1517
# File 'lib/cisco_node_utils/interface.rb', line 1515

def default_switchport_pvlan_promiscuous
  config_get_default('interface', 'switchport_pvlan_promiscuous')
end

#default_switchport_pvlan_trunk_allowed_vlanObject


1752
1753
1754
# File 'lib/cisco_node_utils/interface.rb', line 1752

def default_switchport_pvlan_trunk_allowed_vlan
  config_get_default('interface', 'switchport_pvlan_trunk_allowed_vlan')
end

#default_switchport_pvlan_trunk_associationObject


1691
1692
1693
# File 'lib/cisco_node_utils/interface.rb', line 1691

def default_switchport_pvlan_trunk_association
  config_get_default('interface', 'switchport_pvlan_trunk_association')
end

#default_switchport_pvlan_trunk_native_vlanObject


1769
1770
1771
# File 'lib/cisco_node_utils/interface.rb', line 1769

def default_switchport_pvlan_trunk_native_vlan
  config_get_default('interface', 'switchport_pvlan_trunk_native_vlan')
end

#default_switchport_pvlan_trunk_promiscuousObject


1708
1709
1710
# File 'lib/cisco_node_utils/interface.rb', line 1708

def default_switchport_pvlan_trunk_promiscuous
  config_get_default('interface', 'switchport_pvlan_trunk_promiscuous')
end

#default_switchport_pvlan_trunk_secondaryObject


1725
1726
1727
# File 'lib/cisco_node_utils/interface.rb', line 1725

def default_switchport_pvlan_trunk_secondary
  config_get_default('interface', 'switchport_pvlan_trunk_secondary')
end

#default_switchport_trunk_allowed_vlanObject


1446
1447
1448
# File 'lib/cisco_node_utils/interface.rb', line 1446

def default_switchport_trunk_allowed_vlan
  config_get_default('interface', 'switchport_trunk_allowed_vlan')
end

#default_switchport_trunk_native_vlanObject


1871
1872
1873
# File 'lib/cisco_node_utils/interface.rb', line 1871

def default_switchport_trunk_native_vlan
  config_get_default('interface', 'switchport_trunk_native_vlan')
end

#default_switchport_vtpObject


1976
1977
1978
1979
# File 'lib/cisco_node_utils/interface.rb', line 1976

def default_switchport_vtp
  return nil unless switchport_vtp_mode_capable?
  config_get_default('interface', 'vtp')
end

#default_vlan_mappingObject

Getter: Builds an array of vlan_mapping commands currently on the device.

cli: switchport vlan mapping 2 200
     switchport vlan mapping 4 400

array: [['2', '200'], ['4', '400']]


1826
1827
1828
# File 'lib/cisco_node_utils/interface.rb', line 1826

def default_vlan_mapping
  config_get_default('interface', 'vlan_mapping')
end

#default_vlan_mapping_enableObject

cli: switchport vlan mapping enable


1858
1859
1860
# File 'lib/cisco_node_utils/interface.rb', line 1858

def default_vlan_mapping_enable
  config_get_default('interface', 'vlan_mapping_enable')
end

#default_vpc_idObject


2018
2019
2020
# File 'lib/cisco_node_utils/interface.rb', line 2018

def default_vpc_id
  config_get_default('interface', 'vpc_id')
end

2033
2034
2035
# File 'lib/cisco_node_utils/interface.rb', line 2033

def default_vpc_peer_link
  config_get_default('interface', 'vpc_peer_link')
end

#default_vrfObject


2063
2064
2065
# File 'lib/cisco_node_utils/interface.rb', line 2063

def default_vrf
  config_get_default('interface', 'vrf')
end

#descriptionObject


229
230
231
# File 'lib/cisco_node_utils/interface.rb', line 229

def description
  config_get('interface', 'description', name: @name)
end

#description=(desc) ⇒ Object


233
234
235
236
237
238
239
240
241
242
# File 'lib/cisco_node_utils/interface.rb', line 233

def description=(desc)
  fail TypeError unless desc.is_a?(String)
  if desc.strip.empty?
    config_set('interface', 'description',
               name: @name, state: 'no', desc: '')
  else
    config_set('interface', 'description',
               name: @name, state: '', desc: desc)
  end
end

#destroyObject


163
164
165
166
167
168
169
# File 'lib/cisco_node_utils/interface.rb', line 163

def destroy
  if @name[/ethernet/] && !@name[/ethernet.*\.\d+/]
    config_set('interface', 'default', name: @name)
  else
    config_set('interface', 'destroy', name: @name)
  end
end

#duplexObject


966
967
968
969
# File 'lib/cisco_node_utils/interface.rb', line 966

def duplex
  return nil if @name[/loop|vlan/i]
  config_get('interface', 'duplex', name: @name)
end

#duplex=(val) ⇒ Object


971
972
973
# File 'lib/cisco_node_utils/interface.rb', line 971

def duplex=(val)
  config_set('interface', 'duplex', name: @name, duplex: val)
end

#encapsulation_dot1qObject


248
249
250
# File 'lib/cisco_node_utils/interface.rb', line 248

def encapsulation_dot1q
  config_get('interface', 'encapsulation_dot1q', name: @name)
end

#encapsulation_dot1q=(val) ⇒ Object


252
253
254
255
256
257
258
259
260
# File 'lib/cisco_node_utils/interface.rb', line 252

def encapsulation_dot1q=(val)
  if val.to_s.empty?
    config_set('interface', 'encapsulation_dot1q',
               name: @name, state: 'no', vlan: '')
  else
    config_set('interface', 'encapsulation_dot1q',
               name: @name, state: '', vlan: val)
  end
end

#fabric_forwarding_anycast_gatewayObject


274
275
276
# File 'lib/cisco_node_utils/interface.rb', line 274

def fabric_forwarding_anycast_gateway
  config_get('interface', 'fabric_forwarding_anycast_gateway', name: @name)
end

#fabric_forwarding_anycast_gateway=(state) ⇒ Object


278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/cisco_node_utils/interface.rb', line 278

def fabric_forwarding_anycast_gateway=(state)
  return if fabric_forwarding_anycast_gateway == state
  no_cmd = (state ? '' : 'no')
  config_set('interface',
             'fabric_forwarding_anycast_gateway',
             name: @name, state: no_cmd)
  fail if fabric_forwarding_anycast_gateway.to_s != state.to_s
rescue Cisco::CliError => e
  raise "#{e} 'fabric_forwarding_anycast_gateway' can only be " \
    'configured on a vlan interface' unless /vlan/.match(@name)
  anycast_gateway_mac = OverlayGlobal.new.anycast_gateway_mac
  if anycast_gateway_mac.nil? || anycast_gateway_mac.empty?
    raise "#{e} Anycast gateway mac must be configured " \
           'before configuring forwarding mode under interface'
  end
  raise
end

#fabricpath_featureObject


266
267
268
# File 'lib/cisco_node_utils/interface.rb', line 266

def fabricpath_feature
  FabricpathGlobal.fabricpath_feature
end

#fabricpath_feature_set(fabricpath_set) ⇒ Object


270
271
272
# File 'lib/cisco_node_utils/interface.rb', line 270

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

#feature_lacp?Boolean


864
865
866
# File 'lib/cisco_node_utils/interface.rb', line 864

def feature_lacp?
  config_get('interface', 'feature_lacp')
end

#feature_lacp_set(val) ⇒ Object


868
869
870
871
# File 'lib/cisco_node_utils/interface.rb', line 868

def feature_lacp_set(val)
  return if feature_lacp? == val
  config_set('interface', 'feature_lacp', state: val ? '' : 'no')
end

#feature_vlan?Boolean


1948
1949
1950
# File 'lib/cisco_node_utils/interface.rb', line 1948

def feature_vlan?
  config_get('interface', 'feature_vlan')
end

#feature_vlan_set(val = true) ⇒ Object


1952
1953
1954
1955
1956
1957
# File 'lib/cisco_node_utils/interface.rb', line 1952

def feature_vlan_set(val=true)
  # 'feature interface-vlan'
  # TBD: Replace this with Feature.interface_vlan_enable
  return if feature_vlan? == val
  config_set('interface', 'feature_vlan', state: val ? '' : 'no')
end

#hsrp_bfdObject


300
301
302
# File 'lib/cisco_node_utils/interface.rb', line 300

def hsrp_bfd
  config_get('interface', 'hsrp_bfd', name: @name)
end

#hsrp_bfd=(val) ⇒ Object


304
305
306
307
308
309
310
311
312
# File 'lib/cisco_node_utils/interface.rb', line 304

def hsrp_bfd=(val)
  return if val == hsrp_bfd
  state = val ? '' : 'no'
  if val
    Feature.hsrp_enable
    Feature.bfd_enable
  end
  config_set('interface', 'hsrp_bfd', name: @name, state: state)
end

#hsrp_delayObject

hsrp delay minimum and reload are in the same CLI hsrp delay minimum 0 reload 0


320
321
322
323
# File 'lib/cisco_node_utils/interface.rb', line 320

def hsrp_delay
  match = config_get('interface', 'hsrp_delay', name: @name)
  match.nil? ? default_hsrp_delay : match.collect(&:to_i)
end

#hsrp_delay_minimumObject


329
330
331
332
333
# File 'lib/cisco_node_utils/interface.rb', line 329

def hsrp_delay_minimum
  return nil if switchport_mode != :disabled || @name[/loop/i]
  minimum, _reload = hsrp_delay
  minimum.nil? ? default_hsrp_delay_minimum : minimum
end

#hsrp_delay_minimum=(val) ⇒ Object

hsrp delay minimum and reload are in the same CLI but both can be set independent of each other


337
338
339
340
341
# File 'lib/cisco_node_utils/interface.rb', line 337

def hsrp_delay_minimum=(val)
  Feature.hsrp_enable if val
  config_set('interface', 'hsrp_delay', name: @name,
             minimum: 'minimum', min: val, reload: '', rel: '')
end

#hsrp_delay_reloadObject


347
348
349
350
351
# File 'lib/cisco_node_utils/interface.rb', line 347

def hsrp_delay_reload
  return nil if switchport_mode != :disabled || @name[/loop/i]
  _minimum, reload = hsrp_delay
  reload.nil? ? default_hsrp_delay_reload : reload
end

#hsrp_delay_reload=(val) ⇒ Object

hsrp delay minimum and reload are in the same CLI but both can be set independent of each other


355
356
357
358
359
# File 'lib/cisco_node_utils/interface.rb', line 355

def hsrp_delay_reload=(val)
  Feature.hsrp_enable if val
  config_set('interface', 'hsrp_delay', name: @name,
             minimum: '', min: '', reload: 'reload', rel: val)
end

#hsrp_mac_refreshObject


365
366
367
# File 'lib/cisco_node_utils/interface.rb', line 365

def hsrp_mac_refresh
  config_get('interface', 'hsrp_mac_refresh', name: @name)
end

#hsrp_mac_refresh=(val) ⇒ Object


369
370
371
372
373
374
375
# File 'lib/cisco_node_utils/interface.rb', line 369

def hsrp_mac_refresh=(val)
  state = val ? '' : 'no'
  time = val ? val : ''
  Feature.hsrp_enable if val
  config_set('interface', 'hsrp_mac_refresh', name: @name,
             state: state, timeout: time)
end

#hsrp_use_biaObject


381
382
383
384
385
# File 'lib/cisco_node_utils/interface.rb', line 381

def hsrp_use_bia
  match = config_get('interface', 'hsrp_use_bia', name: @name)
  return default_hsrp_use_bia unless match
  match.include?('scope') ? :use_bia_intf : :use_bia
end

#hsrp_use_bia=(val) ⇒ Object


387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
# File 'lib/cisco_node_utils/interface.rb', line 387

def hsrp_use_bia=(val)
  # Return early if device already set to the correct value
  return if val == hsrp_use_bia
  # need to reset before set
  if val
    Feature.hsrp_enable
    if val == :use_bia
      config_set('interface', 'hsrp_use_bia', name: name,
                 state: 'no', scope: ' scope interface')
      config_set('interface', 'hsrp_use_bia', name: name,
                 state: '', scope: '')
    else
      config_set('interface', 'hsrp_use_bia', name: name,
                 state: 'no', scope: '')
      config_set('interface', 'hsrp_use_bia', name: name,
                 state: '', scope: ' scope interface')
    end
  else
    if hsrp_use_bia == :use_bia
      config_set('interface', 'hsrp_use_bia', name: name,
                 state: 'no', scope: '')
    else
      config_set('interface', 'hsrp_use_bia', name: name,
                 state: 'no', scope: ' scope interface')
    end
  end
end

#hsrp_versionObject


419
420
421
422
# File 'lib/cisco_node_utils/interface.rb', line 419

def hsrp_version
  return nil if switchport_mode != :disabled || @name[/loop/i]
  config_get('interface', 'hsrp_version', name: @name)
end

#hsrp_version=(val) ⇒ Object


424
425
426
427
# File 'lib/cisco_node_utils/interface.rb', line 424

def hsrp_version=(val)
  Feature.hsrp_enable if val
  config_set('interface', 'hsrp_version', name: name, ver: val)
end

#ipv4_acl_inObject


433
434
435
# File 'lib/cisco_node_utils/interface.rb', line 433

def ipv4_acl_in
  config_get('interface', 'ipv4_acl_in', name: @name)
end

#ipv4_acl_in=(val) ⇒ Object


437
438
439
440
441
442
443
444
445
446
447
448
# File 'lib/cisco_node_utils/interface.rb', line 437

def ipv4_acl_in=(val)
  if val != ''
    state = ''
  else
    state = 'no'
    val = ipv4_acl_in
  end

  return unless val && val != ''
  config_set('interface', 'ipv4_acl_in',
             name: @name, state: state, acl: val)
end

#ipv4_acl_outObject


454
455
456
# File 'lib/cisco_node_utils/interface.rb', line 454

def ipv4_acl_out
  config_get('interface', 'ipv4_acl_out', name: @name)
end

#ipv4_acl_out=(val) ⇒ Object


458
459
460
461
462
463
464
465
466
467
468
469
# File 'lib/cisco_node_utils/interface.rb', line 458

def ipv4_acl_out=(val)
  if val != ''
    state = ''
  else
    state = 'no'
    val = ipv4_acl_out
  end

  return unless val && val != ''
  config_set('interface', 'ipv4_acl_out',
             name: @name, state: state, acl: val)
end

#ipv4_addr_maskObject


496
497
498
499
500
501
502
503
504
505
506
507
508
# File 'lib/cisco_node_utils/interface.rb', line 496

def ipv4_addr_mask
  val = config_get('interface', 'ipv4_addr_mask', name: @name)
  if val && platform == :ios_xr
    # IOS XR reports address as <address> <bitmask> [secondary] but we
    # want <address>/<length> [secondary]
    val.each_with_index do |entry, i|
      mask = entry[1].split(' ')
      mask[0] = Utils.bitmask_to_length(mask[0])
      val[i][1] = mask.join(' ')
    end
  end
  val
end

#ipv4_addr_mask_set(addr, mask, secondary = false) ⇒ Object


475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
# File 'lib/cisco_node_utils/interface.rb', line 475

def ipv4_addr_mask_set(addr, mask, secondary=false)
  check_switchport(:disabled)
  sec = secondary ? 'secondary' : ''
  if addr.nil? || addr == default_ipv4_address
    state = 'no'
    if secondary
      return if ipv4_address_secondary == default_ipv4_address_secondary
      # We need address and mask to remove.
      am = "#{ipv4_address_secondary}/#{ipv4_netmask_length_secondary}"
    else
      return if ipv4_address == default_ipv4_address
      am = "#{ipv4_address}/#{ipv4_netmask_length}"
    end
  else
    state = ''
    am = "#{addr}/#{mask}"
  end
  config_set('interface', 'ipv4_addr_mask',
             name: @name, state: state, addr: am, secondary: sec)
end

#ipv4_addressObject


530
531
532
# File 'lib/cisco_node_utils/interface.rb', line 530

def ipv4_address
  select_ipv4_attribute(:v4_addr)
end

#ipv4_address_secondaryObject


534
535
536
# File 'lib/cisco_node_utils/interface.rb', line 534

def ipv4_address_secondary
  select_ipv4_attribute(:v4_addr_secondary)
end

#ipv4_arp_timeoutObject


571
572
573
# File 'lib/cisco_node_utils/interface.rb', line 571

def ipv4_arp_timeout
  config_get('interface', ipv4_arp_timeout_lookup_string, name: @name)
end

#ipv4_arp_timeout=(timeout) ⇒ Object


575
576
577
578
579
580
581
# File 'lib/cisco_node_utils/interface.rb', line 575

def ipv4_arp_timeout=(timeout)
  fail "'ipv4 arp timeout' can ony be configured on a vlan interface" unless
    /vlan/.match(@name)
  state = (timeout == default_ipv4_arp_timeout) ? 'no' : ''
  config_set('interface', 'ipv4_arp_timeout',
             name: @name, state: state, timeout: timeout)
end

#ipv4_arp_timeout_lookup_stringObject


562
563
564
565
566
567
568
569
# File 'lib/cisco_node_utils/interface.rb', line 562

def ipv4_arp_timeout_lookup_string
  case @name
  when /vlan/i
    return 'ipv4_arp_timeout'
  else
    return 'ipv4_arp_timeout_non_vlan_interfaces'
  end
end

#ipv4_dhcp_relay_addrObject


587
588
589
# File 'lib/cisco_node_utils/interface.rb', line 587

def ipv4_dhcp_relay_addr
  config_get('interface', 'ipv4_dhcp_relay_addr', name: @name)
end

#ipv4_dhcp_relay_addr=(list) ⇒ Object


591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'lib/cisco_node_utils/interface.rb', line 591

def ipv4_dhcp_relay_addr=(list)
  cur_list = ipv4_dhcp_relay_addr
  # remove the current addresses first
  unless cur_list.empty?
    cur_list.each do |addr|
      config_set('interface', 'ipv4_dhcp_relay_addr',
                 name:  @name, state: 'no', addr: addr)
    end
  end
  Feature.dhcp_enable unless list.empty?
  list.each do |addr|
    config_set('interface', 'ipv4_dhcp_relay_addr',
               name:  @name, state: '', addr: addr)
  end
end

#ipv4_dhcp_relay_info_trustObject


611
612
613
614
# File 'lib/cisco_node_utils/interface.rb', line 611

def ipv4_dhcp_relay_info_trust
  return nil if @name[/loop/i] || switchport_mode != :disabled
  config_get('interface', 'ipv4_dhcp_relay_info_trust', name: @name)
end

#ipv4_dhcp_relay_info_trust=(state) ⇒ Object


616
617
618
619
620
621
# File 'lib/cisco_node_utils/interface.rb', line 616

def ipv4_dhcp_relay_info_trust=(state)
  return false if !state && !Feature.dhcp_enabled?
  Feature.dhcp_enable if state
  config_set('interface', 'ipv4_dhcp_relay_info_trust',
             name:  @name, state: state ? '' : 'no')
end

#ipv4_dhcp_relay_src_addr_hsrpObject


627
628
629
# File 'lib/cisco_node_utils/interface.rb', line 627

def ipv4_dhcp_relay_src_addr_hsrp
  config_get('interface', 'ipv4_dhcp_relay_src_addr_hsrp', name: @name)
end

#ipv4_dhcp_relay_src_addr_hsrp=(state) ⇒ Object


631
632
633
634
635
636
# File 'lib/cisco_node_utils/interface.rb', line 631

def ipv4_dhcp_relay_src_addr_hsrp=(state)
  return false if !state && !Feature.dhcp_enabled?
  Feature.dhcp_enable if state
  config_set('interface', 'ipv4_dhcp_relay_src_addr_hsrp',
             name:  @name, state: state ? '' : 'no')
end

#ipv4_dhcp_relay_src_intfObject


642
643
644
645
646
647
# File 'lib/cisco_node_utils/interface.rb', line 642

def ipv4_dhcp_relay_src_intf
  intf = config_get('interface', 'ipv4_dhcp_relay_src_intf', name: @name)
  # Normalize by downcasing and removing white space
  intf = intf.downcase.delete(' ') if intf
  intf
end

#ipv4_dhcp_relay_src_intf=(val) ⇒ Object


649
650
651
652
653
654
655
656
# File 'lib/cisco_node_utils/interface.rb', line 649

def ipv4_dhcp_relay_src_intf=(val)
  state = val == default_ipv4_dhcp_relay_src_intf ? 'no' : ''
  return false if state == 'no' && !Feature.dhcp_enabled?
  Feature.dhcp_enable if state.empty?
  intf = val == default_ipv4_dhcp_relay_src_intf ? '' : val
  config_set('interface', 'ipv4_dhcp_relay_src_intf',
             name:  @name, state: state, intf: intf)
end

#ipv4_dhcp_relay_subnet_broadcastObject


662
663
664
665
# File 'lib/cisco_node_utils/interface.rb', line 662

def ipv4_dhcp_relay_subnet_broadcast
  return nil if @name[/loop/i] || switchport_mode != :disabled
  config_get('interface', 'ipv4_dhcp_relay_subnet_broadcast', name: @name)
end

#ipv4_dhcp_relay_subnet_broadcast=(state) ⇒ Object


667
668
669
670
671
672
# File 'lib/cisco_node_utils/interface.rb', line 667

def ipv4_dhcp_relay_subnet_broadcast=(state)
  return false if !state && !Feature.dhcp_enabled?
  Feature.dhcp_enable if state
  config_set('interface', 'ipv4_dhcp_relay_subnet_broadcast',
             name:  @name, state: state ? '' : 'no')
end

#ipv4_dhcp_smart_relayObject


678
679
680
681
# File 'lib/cisco_node_utils/interface.rb', line 678

def ipv4_dhcp_smart_relay
  return nil if @name[/loop/i] || switchport_mode != :disabled
  config_get('interface', 'ipv4_dhcp_smart_relay', name: @name)
end

#ipv4_dhcp_smart_relay=(state) ⇒ Object


683
684
685
686
687
688
# File 'lib/cisco_node_utils/interface.rb', line 683

def ipv4_dhcp_smart_relay=(state)
  return false if !state && !Feature.dhcp_enabled?
  Feature.dhcp_enable if state
  config_set('interface', 'ipv4_dhcp_smart_relay',
             name:  @name, state: state ? '' : 'no')
end

#ipv4_forwardingObject


694
695
696
# File 'lib/cisco_node_utils/interface.rb', line 694

def ipv4_forwarding
  config_get('interface', 'ipv4_forwarding', name: @name)
end

#ipv4_forwarding=(state) ⇒ Object


698
699
700
701
702
# File 'lib/cisco_node_utils/interface.rb', line 698

def ipv4_forwarding=(state)
  return if state == ipv4_forwarding
  config_set('interface', 'ipv4_forwarding',
             name:  @name, state: state ? '' : 'no')
end

#ipv4_netmask_lengthObject


538
539
540
# File 'lib/cisco_node_utils/interface.rb', line 538

def ipv4_netmask_length
  select_ipv4_attribute(:v4_mask)
end

#ipv4_netmask_length_secondaryObject


542
543
544
# File 'lib/cisco_node_utils/interface.rb', line 542

def ipv4_netmask_length_secondary
  select_ipv4_attribute(:v4_mask_secondary)
end

#ipv4_pim_sparse_modeObject


708
709
710
711
# File 'lib/cisco_node_utils/interface.rb', line 708

def ipv4_pim_sparse_mode
  return nil unless switchport_mode == :disabled
  config_get('interface', 'ipv4_pim_sparse_mode', name: @name)
end

#ipv4_pim_sparse_mode=(state) ⇒ Object


713
714
715
716
717
718
# File 'lib/cisco_node_utils/interface.rb', line 713

def ipv4_pim_sparse_mode=(state)
  check_switchport(:disabled)
  Feature.pim_enable unless platform == :ios_xr
  config_set('interface', 'ipv4_pim_sparse_mode',
             name: @name, state: state ? '' : 'no')
end

#ipv4_proxy_arpObject


724
725
726
727
# File 'lib/cisco_node_utils/interface.rb', line 724

def ipv4_proxy_arp
  return nil if @name[/loop/i] || switchport_mode != :disabled
  config_get('interface', 'ipv4_proxy_arp', name: @name)
end

#ipv4_proxy_arp=(proxy_arp) ⇒ Object


729
730
731
732
733
# File 'lib/cisco_node_utils/interface.rb', line 729

def ipv4_proxy_arp=(proxy_arp)
  check_switchport(:disabled)
  no_cmd = (proxy_arp ? '' : 'no')
  config_set('interface', 'ipv4_proxy_arp', name: @name, state: no_cmd)
end

#ipv4_redirectsObject


748
749
750
751
# File 'lib/cisco_node_utils/interface.rb', line 748

def ipv4_redirects
  return nil unless switchport_mode == :disabled
  config_get('interface', ipv4_redirects_lookup_string, name: @name)
end

#ipv4_redirects=(redirects) ⇒ Object


753
754
755
756
757
758
# File 'lib/cisco_node_utils/interface.rb', line 753

def ipv4_redirects=(redirects)
  check_switchport(:disabled)
  no_cmd = (redirects ? '' : 'no')
  config_set('interface', ipv4_redirects_lookup_string,
             name: @name, state: no_cmd)
end

#ipv4_redirects_lookup_stringObject


739
740
741
742
743
744
745
746
# File 'lib/cisco_node_utils/interface.rb', line 739

def ipv4_redirects_lookup_string
  case @name
  when /loopback/i
    return 'ipv4_redirects_loopback'
  else
    return 'ipv4_redirects_other_interfaces'
  end
end

#ipv6_acl_inObject


764
765
766
# File 'lib/cisco_node_utils/interface.rb', line 764

def ipv6_acl_in
  config_get('interface', 'ipv6_acl_in', name: @name)
end

#ipv6_acl_in=(val) ⇒ Object


768
769
770
771
772
773
774
775
776
777
778
# File 'lib/cisco_node_utils/interface.rb', line 768

def ipv6_acl_in=(val)
  if val != ''
    state = ''
  else
    state = 'no'
    val = ipv6_acl_in
  end
  return unless val && val != ''
  config_set('interface', 'ipv6_acl_in',
             name: @name, state: state, acl: val)
end

#ipv6_acl_outObject


784
785
786
# File 'lib/cisco_node_utils/interface.rb', line 784

def ipv6_acl_out
  config_get('interface', 'ipv6_acl_out', name: @name)
end

#ipv6_acl_out=(val) ⇒ Object


788
789
790
791
792
793
794
795
796
797
798
# File 'lib/cisco_node_utils/interface.rb', line 788

def ipv6_acl_out=(val)
  if val != ''
    state = ''
  else
    state = 'no'
    val = ipv6_acl_out
  end
  return unless val && val != ''
  config_set('interface', 'ipv6_acl_out',
             name: @name, state: state, acl: val)
end

#ipv6_dhcp_relay_addrObject


804
805
806
# File 'lib/cisco_node_utils/interface.rb', line 804

def ipv6_dhcp_relay_addr
  config_get('interface', 'ipv6_dhcp_relay_addr', name: @name)
end

#ipv6_dhcp_relay_addr=(list) ⇒ Object


808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
# File 'lib/cisco_node_utils/interface.rb', line 808

def ipv6_dhcp_relay_addr=(list)
  cur_list = ipv6_dhcp_relay_addr
  # remove the current addresses first
  unless cur_list.empty?
    cur_list.each do |addr|
      config_set('interface', 'ipv6_dhcp_relay_addr',
                 name:  @name, state: 'no', addr: addr)
    end
  end
  Feature.dhcp_enable unless list.empty?
  list.each do |addr|
    config_set('interface', 'ipv6_dhcp_relay_addr',
               name:  @name, state: '', addr: addr)
  end
end

#ipv6_dhcp_relay_src_intfObject


828
829
830
831
832
833
# File 'lib/cisco_node_utils/interface.rb', line 828

def ipv6_dhcp_relay_src_intf
  intf = config_get('interface', 'ipv6_dhcp_relay_src_intf', name: @name)
  # Normalize by downcasing and removing white space
  intf = intf.downcase.delete(' ') if intf
  intf
end

#ipv6_dhcp_relay_src_intf=(val) ⇒ Object


835
836
837
838
839
840
841
842
# File 'lib/cisco_node_utils/interface.rb', line 835

def ipv6_dhcp_relay_src_intf=(val)
  state = val == default_ipv6_dhcp_relay_src_intf ? 'no' : ''
  return false if state == 'no' && !Feature.dhcp_enabled?
  Feature.dhcp_enable if state.empty?
  intf = val == default_ipv6_dhcp_relay_src_intf ? '' : val
  config_set('interface', 'ipv6_dhcp_relay_src_intf',
             name:  @name, state: state, intf: intf)
end

#ipv6_redirectsObject


848
849
850
851
# File 'lib/cisco_node_utils/interface.rb', line 848

def ipv6_redirects
  return nil if @name[/loop/i] || switchport_mode != :disabled
  config_get('interface', 'ipv6_redirects', name: @name)
end

#ipv6_redirects=(redirects) ⇒ Object


853
854
855
856
857
858
# File 'lib/cisco_node_utils/interface.rb', line 853

def ipv6_redirects=(redirects)
  check_switchport(:disabled)
  no_cmd = (redirects ? '' : 'no')
  config_set('interface', 'ipv6_redirects',
             name: @name, state: no_cmd)
end

#load_interval_counter_1_delayObject


873
874
875
876
# File 'lib/cisco_node_utils/interface.rb', line 873

def load_interval_counter_1_delay
  return nil if @name[/loop/] || @name[/ethernet.*\S+\.\d+$/]
  config_get('interface', 'load_interval_counter_1_delay', name: @name)
end

#load_interval_counter_1_delay=(val) ⇒ Object


878
879
880
881
882
883
# File 'lib/cisco_node_utils/interface.rb', line 878

def load_interval_counter_1_delay=(val)
  fail ArgumentError, 'Interface cannot be sub-intf or loopback' if
    @name[/loop/] || @name[/ethernet.*\S+\.\d+$/]
  config_set('interface', 'load_interval_counter_1_delay',
             name: @name, delay: val)
end

#load_interval_counter_2_delayObject


895
896
897
898
# File 'lib/cisco_node_utils/interface.rb', line 895

def load_interval_counter_2_delay
  return nil if @name[/loop/] || @name[/ethernet.*\S+\.\d+$/]
  config_get('interface', 'load_interval_counter_2_delay', name: @name)
end

#load_interval_counter_2_delay=(val) ⇒ Object


900
901
902
903
904
905
# File 'lib/cisco_node_utils/interface.rb', line 900

def load_interval_counter_2_delay=(val)
  fail ArgumentError, 'Interface cannot be sub-intf or loopback' if
    @name[/loop/] || @name[/ethernet.*\S+\.\d+$/]
  config_set('interface', 'load_interval_counter_2_delay',
             name: @name, delay: val)
end

#load_interval_counter_3_delayObject


911
912
913
914
# File 'lib/cisco_node_utils/interface.rb', line 911

def load_interval_counter_3_delay
  return nil if @name[/loop/] || @name[/ethernet.*\S+\.\d+$/]
  config_get('interface', 'load_interval_counter_3_delay', name: @name)
end

#load_interval_counter_3_delay=(val) ⇒ Object


916
917
918
919
920
921
922
923
# File 'lib/cisco_node_utils/interface.rb', line 916

def load_interval_counter_3_delay=(val)
  fail ArgumentError, 'Interface cannot be sub-intf or loopback' if
    @name[/loop/] || @name[/ethernet.*\S+\.\d+$/]
  state = val ? '' : 'no'
  delay = val ? val : ''
  config_set('interface', 'load_interval_counter_3_delay',
             name: @name, state: state, delay: delay)
end

#mtuObject


938
939
940
# File 'lib/cisco_node_utils/interface.rb', line 938

def mtu
  config_get('interface', mtu_lookup_string, name: @name)
end

#mtu=(val) ⇒ Object


942
943
944
945
946
947
# File 'lib/cisco_node_utils/interface.rb', line 942

def mtu=(val)
  return if mtu == val
  check_switchport(:disabled)
  config_set('interface', mtu_lookup_string,
             name: @name, state: '', mtu: val)
end

#mtu_lookup_stringObject


929
930
931
932
933
934
935
936
# File 'lib/cisco_node_utils/interface.rb', line 929

def mtu_lookup_string
  case @name
  when /loopback/i
    return 'mtu_loopback'
  else
    return 'mtu_other_interfaces'
  end
end

#negotiate_autoObject


990
991
992
993
# File 'lib/cisco_node_utils/interface.rb', line 990

def negotiate_auto
  return nil if @name[/loop|vlan/]
  config_get('interface', negotiate_auto_lookup_string, name: @name)
end

#negotiate_auto=(negotiate_auto) ⇒ Object


995
996
997
998
999
# File 'lib/cisco_node_utils/interface.rb', line 995

def negotiate_auto=(negotiate_auto)
  lookup = negotiate_auto_lookup_string
  no_cmd = (negotiate_auto ? '' : 'no')
  config_set('interface', lookup, name: @name, state: no_cmd)
end

#negotiate_auto_lookup_stringObject


979
980
981
982
983
984
985
986
987
988
# File 'lib/cisco_node_utils/interface.rb', line 979

def negotiate_auto_lookup_string
  case @name
  when ETHERNET
    return 'negotiate_auto_ethernet'
  when PORTCHANNEL
    return 'negotiate_auto_portchannel'
  else
    return 'negotiate_auto_other_interfaces'
  end
end

#pim_bfdObject


1047
1048
1049
# File 'lib/cisco_node_utils/interface.rb', line 1047

def pim_bfd
  config_get('interface', 'pim_bfd', name: @name)
end

#pim_bfd=(val) ⇒ Object


1051
1052
1053
1054
1055
1056
1057
1058
1059
# File 'lib/cisco_node_utils/interface.rb', line 1051

def pim_bfd=(val)
  return if val == pim_bfd
  state = val ? '' : 'no'
  if val
    Feature.pim_enable
    Feature.bfd_enable
  end
  config_set('interface', 'pim_bfd', name: @name, state: state)
end

#purge_configObject


2090
2091
2092
2093
2094
2095
# File 'lib/cisco_node_utils/interface.rb', line 2090

def purge_config
  # This getter is only supported on ethernet interfaces
  return nil unless @name[/ethernet/]
  state = config_get('interface', 'purge_config', name: @name)
  state.nil? ? true : default_purge_config
end

#purge_config=(val) ⇒ Object


2082
2083
2084
2085
2086
2087
2088
# File 'lib/cisco_node_utils/interface.rb', line 2082

def purge_config=(val)
  return unless val
  fail ArgumentError,
       'purge_config is only supported on Ethernet interfaces' unless
    @name[/ethernet/]
  config_set('interface', 'purge_config', name: @name) if val
end

#pvlan_enableObject


176
177
178
179
# File 'lib/cisco_node_utils/interface.rb', line 176

def pvlan_enable
  switchport_enable
  Feature.private_vlan_enable
end

#pvlan_mappingObject


This is an SVI property. <state> private-vlan mapping <range> # ex. range = ['2-4,9'] Always returns an array.


1777
1778
1779
1780
1781
# File 'lib/cisco_node_utils/interface.rb', line 1777

def pvlan_mapping
  range = config_get('interface', 'pvlan_mapping', name: @name)
  return default_pvlan_mapping if range.nil?
  range.empty? ? range : [range.delete(' ')]
end

#pvlan_mapping=(range) ⇒ Object


1783
1784
1785
1786
1787
1788
1789
1790
1791
# File 'lib/cisco_node_utils/interface.rb', line 1783

def pvlan_mapping=(range)
  feature_vlan_set
  Feature.private_vlan_enable

  is = Utils.dash_range_to_elements(pvlan_mapping)
  should = Utils.dash_range_to_elements(range)

  pvlan_mapping_delta(is, should)
end

#pvlan_mapping_delta(is, should) ⇒ Object


1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
# File 'lib/cisco_node_utils/interface.rb', line 1793

def pvlan_mapping_delta(is, should)
  delta_hash = Utils.delta_add_remove(should, is)
  Cisco::Logger.debug("pvlan_mapping_delta: #{delta_hash}")
  [:remove, :add].each do |action|
    delta_hash[action].each do |vlan|
      state = (action == :add) ? '' : 'no'
      cli_error_check(
        config_set('interface', 'pvlan_mapping',
                   name: @name, state: state, vlan: vlan))
    end
  end
end

#pvlan_trunk_association_delta(is, should) ⇒ Object


1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'lib/cisco_node_utils/interface.rb', line 1674

def pvlan_trunk_association_delta(is, should)
  delta_hash = Utils.delta_add_remove(should, is)
  Cisco::Logger.debug("pvlan_trunk_association_delta: #{delta_hash}")
  [:remove, :add].each do |action|
    delta_hash[action].each do |pri_and_sec|
      state = (action == :add) ? '' : 'no'
      pri, sec = pri_and_sec

      # Cli does not like removals that specify the secondary
      sec = '' if action[/remove/]
      cli_error_check(
        config_set('interface', 'switchport_pvlan_trunk_association',
                   name: @name, state: state, pri: pri, sec: sec))
    end
  end
end

#select_ipv4_attribute(attribute) ⇒ Object


510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'lib/cisco_node_utils/interface.rb', line 510

def select_ipv4_attribute(attribute)
  d = ipv4_addr_mask.flatten unless ipv4_addr_mask.nil?
  # (d)ata format after flatten: ['addr', 'mask', 'addr', 'mask secondary']
  case attribute
  when :v4_addr
    v = d.nil? ? default_ipv4_address : d[0]
  when :v4_mask
    v = d.nil? ? default_ipv4_netmask_length : d[1].to_i
  when :v4_addr_secondary
    v = (d.nil? || d.size < 4) ? default_ipv4_address : d[2]
  when :v4_mask_secondary
    if d.nil? || d.size < 4
      v = default_ipv4_netmask_length
    else
      v = d[3][0, 2].to_i
    end
  end
  v
end

#set_range_based_params(list, param_name) ⇒ Object


2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'lib/cisco_node_utils/interface.rb', line 2067

def set_range_based_params(list, param_name)
  list.each do |range, property_value|
    # if a particular range is set to default, use 'no' cmd
    if property_value == 'default'
      config_set('interface', param_name,
                 name: @name, state: 'no',
                 range: range, val: '')
    else
      config_set('interface', param_name,
                 name: @name, state: '',
                 range: range, val: property_value)
    end
  end
end

#shutdownObject


1005
1006
1007
# File 'lib/cisco_node_utils/interface.rb', line 1005

def shutdown
  config_get('interface', 'shutdown', name: @name)
end

#shutdown=(state) ⇒ Object


1009
1010
1011
1012
# File 'lib/cisco_node_utils/interface.rb', line 1009

def shutdown=(state)
  no_cmd = (state ? '' : 'no')
  config_set('interface', 'shutdown', name: @name, state: no_cmd)
end

#speedObject


953
954
955
956
# File 'lib/cisco_node_utils/interface.rb', line 953

def speed
  return nil if @name[/loop|vlan/i]
  config_get('interface', 'speed', name: @name)
end

#speed=(val) ⇒ Object


958
959
960
# File 'lib/cisco_node_utils/interface.rb', line 958

def speed=(val)
  config_set('interface', 'speed', name: @name, speed: val)
end

#storm_control_broadcastObject


1065
1066
1067
1068
# File 'lib/cisco_node_utils/interface.rb', line 1065

def storm_control_broadcast
  return nil if @name[/loop|vlan/i]
  config_get('interface', 'storm_control_broadcast', name: @name)
end

#storm_control_broadcast=(val) ⇒ Object


1070
1071
1072
1073
1074
1075
1076
# File 'lib/cisco_node_utils/interface.rb', line 1070

def storm_control_broadcast=(val)
  return if val == storm_control_broadcast
  state = val == default_storm_control_broadcast ? 'no' : ''
  level = val == default_storm_control_broadcast ? '' : val
  config_set('interface', 'storm_control_broadcast',
             name: @name, state: state, level: level)
end

#storm_control_multicastObject


1082
1083
1084
1085
# File 'lib/cisco_node_utils/interface.rb', line 1082

def storm_control_multicast
  return nil if @name[/loop|vlan/i]
  config_get('interface', 'storm_control_multicast', name: @name)
end

#storm_control_multicast=(val) ⇒ Object


1087
1088
1089
1090
1091
1092
1093
# File 'lib/cisco_node_utils/interface.rb', line 1087

def storm_control_multicast=(val)
  return if val == storm_control_multicast
  state = val == default_storm_control_multicast ? 'no' : ''
  level = val == default_storm_control_multicast ? '' : val
  config_set('interface', 'storm_control_multicast',
             name: @name, state: state, level: level)
end

#storm_control_unicastObject


1099
1100
1101
1102
# File 'lib/cisco_node_utils/interface.rb', line 1099

def storm_control_unicast
  return nil if @name[/loop|vlan/i]
  config_get('interface', 'storm_control_unicast', name: @name)
end

#storm_control_unicast=(val) ⇒ Object


1104
1105
1106
1107
1108
1109
1110
# File 'lib/cisco_node_utils/interface.rb', line 1104

def storm_control_unicast=(val)
  return if val == storm_control_unicast
  state = val == default_storm_control_unicast ? 'no' : ''
  level = val == default_storm_control_unicast ? '' : val
  config_set('interface', 'storm_control_unicast',
             name: @name, state: state, level: level)
end

#stp_bpdufilterObject


1116
1117
1118
# File 'lib/cisco_node_utils/interface.rb', line 1116

def stp_bpdufilter
  config_get('interface', 'stp_bpdufilter', name: @name)
end

#stp_bpdufilter=(val) ⇒ Object


1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'lib/cisco_node_utils/interface.rb', line 1120

def stp_bpdufilter=(val)
  check_switchport([:access, :trunk])
  if val
    state = ''
  else
    state = 'no'
    val = ''
  end
  config_set('interface',
             'stp_bpdufilter', name: @name, state: state, filter: val)
end

#stp_bpduguardObject


1136
1137
1138
# File 'lib/cisco_node_utils/interface.rb', line 1136

def stp_bpduguard
  config_get('interface', 'stp_bpduguard', name: @name)
end

#stp_bpduguard=(val) ⇒ Object


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
# File 'lib/cisco_node_utils/interface.rb', line 1140

def stp_bpduguard=(val)
  if val
    state = ''
  else
    state = 'no'
    val = ''
  end
  config_set('interface',
             'stp_bpduguard', name: @name, state: state, guard: val)
end

#stp_costObject


1155
1156
1157
1158
1159
# File 'lib/cisco_node_utils/interface.rb', line 1155

def stp_cost
  return nil if switchport_mode == :disabled
  cost = config_get('interface', 'stp_cost', name: @name)
  cost == 'auto' ? cost : cost.to_i
end

#stp_cost=(val) ⇒ Object


1161
1162
1163
1164
# File 'lib/cisco_node_utils/interface.rb', line 1161

def stp_cost=(val)
  check_switchport([:access, :trunk])
  config_set('interface', 'stp_cost', name: @name, cost: val)
end

#stp_guardObject


1170
1171
1172
# File 'lib/cisco_node_utils/interface.rb', line 1170

def stp_guard
  config_get('interface', 'stp_guard', name: @name)
end

#stp_guard=(val) ⇒ Object


1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
# File 'lib/cisco_node_utils/interface.rb', line 1174

def stp_guard=(val)
  check_switchport([:access, :trunk])
  if val
    state = ''
  else
    state = 'no'
    val = ''
  end
  config_set('interface', 'stp_guard', name: @name, state: state,
             guard: val)
end

1190
1191
1192
1193
# File 'lib/cisco_node_utils/interface.rb', line 1190

def stp_link_type
  return nil if switchport_mode == :disabled
  config_get('interface', 'stp_link_type', name: @name)
end

1195
1196
1197
1198
# File 'lib/cisco_node_utils/interface.rb', line 1195

def stp_link_type=(val)
  check_switchport([:access, :trunk])
  config_set('interface', 'stp_link_type', name: @name, type: val)
end

#stp_mst_costObject

Getter: Builds an array of mst cost commands currently on the device.

cli: spanning-tree mst 0,2-4,6,8-12 cost 1000
     spanning-tree mst 4000-4020 cost 2568

array: [['0,2-4,6,8-12', '1000'], ['4000-4020', '2568']]


1224
1225
1226
# File 'lib/cisco_node_utils/interface.rb', line 1224

def stp_mst_cost
  config_get('interface', 'stp_mst_cost', name: @name)
end

#stp_mst_cost=(list) ⇒ Object


1228
1229
1230
1231
1232
1233
1234
# File 'lib/cisco_node_utils/interface.rb', line 1228

def stp_mst_cost=(list)
  check_switchport([:access, :trunk])
  config_set('interface', 'stp_mst_cost',
             name: @name, state: 'no', range: @smr,
             val: '') if list.empty?
  set_range_based_params(list, 'stp_mst_cost')
end

#stp_mst_port_priorityObject

Getter: Builds an array of mst port-priority commands currently on the device.

cli: spanning-tree mst 0,2-4,6,8-12 port-priority 64
     spanning-tree mst 4000-4020 port-priority 160

array: [['0,2-4,6,8-12', '64'], ['4000-4020', '160']]


1246
1247
1248
# File 'lib/cisco_node_utils/interface.rb', line 1246

def stp_mst_port_priority
  config_get('interface', 'stp_mst_port_priority', name: @name)
end

#stp_mst_port_priority=(list) ⇒ Object


1250
1251
1252
1253
1254
1255
1256
# File 'lib/cisco_node_utils/interface.rb', line 1250

def stp_mst_port_priority=(list)
  check_switchport([:access, :trunk])
  config_set('interface', 'stp_mst_port_priority',
             name: @name, state: 'no', range: @smr,
             val: '') if list.empty?
  set_range_based_params(list, 'stp_mst_port_priority')
end

#stp_port_priorityObject


1204
1205
1206
1207
# File 'lib/cisco_node_utils/interface.rb', line 1204

def stp_port_priority
  return nil if switchport_mode == :disabled
  config_get('interface', 'stp_port_priority', name: @name)
end

#stp_port_priority=(val) ⇒ Object


1209
1210
1211
1212
# File 'lib/cisco_node_utils/interface.rb', line 1209

def stp_port_priority=(val)
  check_switchport([:access, :trunk])
  config_set('interface', 'stp_port_priority', name: @name, pp: val)
end

#stp_port_typeObject


1262
1263
1264
# File 'lib/cisco_node_utils/interface.rb', line 1262

def stp_port_type
  config_get('interface', 'stp_port_type', name: @name)
end

#stp_port_type=(val) ⇒ Object


1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
# File 'lib/cisco_node_utils/interface.rb', line 1266

def stp_port_type=(val)
  if val
    state = ''
  else
    return unless stp_port_type
    state = 'no'
    val = stp_port_type
  end
  config_set('interface', 'stp_port_type', name: @name,
             state: state, type: val)
end

#stp_vlan_costObject

Getter: Builds an array of vlan cost commands currently on the device.

cli: spanning-tree vlan 1-4,6,8-12 cost 1000
     spanning-tree vlan 3000-3960 cost 2568

array: [['1-4,6,8-12', '1000'], ['3000-3960', '2568']]


1288
1289
1290
# File 'lib/cisco_node_utils/interface.rb', line 1288

def stp_vlan_cost
  config_get('interface', 'stp_vlan_cost', name: @name)
end

#stp_vlan_cost=(list) ⇒ Object


1292
1293
1294
1295
1296
1297
1298
# File 'lib/cisco_node_utils/interface.rb', line 1292

def stp_vlan_cost=(list)
  check_switchport([:access, :trunk])
  config_set('interface', 'stp_vlan_cost',
             name: @name, state: 'no',
             range: @svr, val: '') if list.empty?
  set_range_based_params(list, 'stp_vlan_cost')
end

#stp_vlan_port_priorityObject

Getter: Builds an array of vlan port-priority commands currently on the device.

cli: spanning-tree vlan 1-4,6,8-12 port-priority 64
     spanning-tree vlan 3000-3960 port-priority 160

array: [['1-4,6,8-12', '64'], ['3000-3960', '160']]


1310
1311
1312
# File 'lib/cisco_node_utils/interface.rb', line 1310

def stp_vlan_port_priority
  config_get('interface', 'stp_vlan_port_priority', name: @name)
end

#stp_vlan_port_priority=(list) ⇒ Object


1314
1315
1316
1317
1318
1319
1320
# File 'lib/cisco_node_utils/interface.rb', line 1314

def stp_vlan_port_priority=(list)
  check_switchport([:access, :trunk])
  config_set('interface', 'stp_vlan_port_priority',
             name: @name, state: 'no',
             range: @svr, val: '') if list.empty?
  set_range_based_params(list, 'stp_vlan_port_priority')
end

#svi_autostateObject

svi_autostate is exclusive to svi interfaces


1932
1933
1934
1935
# File 'lib/cisco_node_utils/interface.rb', line 1932

def svi_autostate
  return nil unless @name[/^vlan/i]
  config_get('interface', 'svi_autostate', name: @name)
end

#svi_autostate=(val) ⇒ Object


1937
1938
1939
1940
1941
1942
# File 'lib/cisco_node_utils/interface.rb', line 1937

def svi_autostate=(val)
  check_switchport(:disabled)
  svi_cmd_allowed?('autostate')
  config_set('interface', 'svi_autostate',
             name: @name, state: val ? '' : 'no')
end

#svi_cmd_allowed?(cmd) ⇒ Boolean


1926
1927
1928
1929
# File 'lib/cisco_node_utils/interface.rb', line 1926

def svi_cmd_allowed?(cmd)
  fail "[#{@name}] Invalid interface type for command [#{cmd}]" unless
    @name[/vlan/i]
end

#svi_managementObject

svi_management is exclusive to svi interfaces


1960
1961
1962
1963
# File 'lib/cisco_node_utils/interface.rb', line 1960

def svi_management
  return nil unless @name[/^vlan/i]
  config_get('interface', 'svi_management', name: @name)
end

#svi_management=(val) ⇒ Object


1965
1966
1967
1968
1969
1970
# File 'lib/cisco_node_utils/interface.rb', line 1965

def svi_management=(val)
  check_switchport(:disabled)
  svi_cmd_allowed?('management')
  config_set('interface', 'svi_management',
             name: @name, state: val ? '' : 'no')
end

#switchportObject


1326
1327
1328
1329
# File 'lib/cisco_node_utils/interface.rb', line 1326

def switchport
  # This is "switchport", not "switchport mode"
  config_get('interface', 'switchport', name: @name)
end

#switchport_autostate_excludeObject

switchport_autostate_exclude is exclusive to switchport interfaces


1336
1337
1338
1339
1340
# File 'lib/cisco_node_utils/interface.rb', line 1336

def switchport_autostate_exclude
  return nil if switchport_mode == :disabled
  config_get('interface',
             'switchport_autostate_exclude', name: @name)
end

#switchport_autostate_exclude=(val) ⇒ Object


1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
# File 'lib/cisco_node_utils/interface.rb', line 1342

def switchport_autostate_exclude=(val)
  if platform == :nexus
    # cannot configure autostate unless feature vlan is enabled
    fail('switchport mode must be configured before ' \
         'switchport autostate') unless switchport
    feature_vlan_set(true)
  end
  config_set('interface', 'switchport_autostate_exclude',
             name: @name, state: val ? '' : 'no')
end

#switchport_enable(val = true) ⇒ Object


1331
1332
1333
# File 'lib/cisco_node_utils/interface.rb', line 1331

def switchport_enable(val=true)
  config_set('interface', 'switchport', name: @name, state: val ? '' : 'no')
end

#switchport_enable_and_mode(mode_set) ⇒ Object


1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
# File 'lib/cisco_node_utils/interface.rb', line 1382

def switchport_enable_and_mode(mode_set)
  switchport_enable

  if :fabricpath == mode_set
    fabricpath_feature_set(:enabled) unless :enabled == fabricpath_feature
  elsif :fex_fabric == mode_set
    Feature.fex_enable
  end
  config_set('interface', switchport_mode_lookup_string,
             name: @name, state: '', mode: IF_SWITCHPORT_MODE[mode_set])
end

#switchport_modeObject


1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'lib/cisco_node_utils/interface.rb', line 1368

def switchport_mode
  return nil if platform == :ios_xr
  mode = config_get('interface', switchport_mode_lookup_string, name: @name)

  return mode.nil? ? :disabled : IF_SWITCHPORT_MODE.key(mode)

rescue IndexError
  # Assume this is an interface that doesn't support switchport.
  # Do not raise exception since the providers will prefetch this property
  # regardless of interface type.
  # TODO: this should probably be nil instead
  return :disabled
end

#switchport_mode=(mode_set) ⇒ Object


1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
# File 'lib/cisco_node_utils/interface.rb', line 1394

def switchport_mode=(mode_set)
  # no system default switchport
  # int e1/1
  #   switchport
  #   switchport mode [access|trunk|fex|...]
  fail ArgumentError unless IF_SWITCHPORT_MODE.keys.include? mode_set
  case mode_set
  when :disabled
    if switchport
      # Note: turn off switchport command, not switchport mode
      config_set('interface', 'switchport', name: @name, state: 'no')
    end

  when :default
    if :disabled == default_switchport_mode
      config_set('interface', switchport_mode_lookup_string,
                 name: @name, state: 'no', mode: '')
    else
      switchport_enable_and_mode(mode_set)
    end

  else
    switchport_enable_and_mode(mode_set)
  end # case
end

#switchport_mode_lookup_stringObject


1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
# File 'lib/cisco_node_utils/interface.rb', line 1357

def switchport_mode_lookup_string
  case @name
  when ETHERNET
    return 'switchport_mode_ethernet'
  when PORTCHANNEL
    return 'switchport_mode_port_channel'
  else
    return 'switchport_mode_other_interfaces'
  end
end

#switchport_pvlan_hostObject


<state> switchport mode private-vlan host


1487
1488
1489
1490
# File 'lib/cisco_node_utils/interface.rb', line 1487

def switchport_pvlan_host
  return nil if switchport_mode == :disabled
  config_get('interface', 'switchport_pvlan_host', name: @name)
end

#switchport_pvlan_host=(state) ⇒ Object


1492
1493
1494
1495
1496
# File 'lib/cisco_node_utils/interface.rb', line 1492

def switchport_pvlan_host=(state)
  pvlan_enable
  config_set('interface', 'switchport_pvlan_host',
             name: @name, state: state ? '' : 'no')
end

#switchport_pvlan_host_associationObject


<state> switchport private-vlan host-association <pri> <sec> Note this is NOT a multiple, unlike trunk association.


1522
1523
1524
# File 'lib/cisco_node_utils/interface.rb', line 1522

def switchport_pvlan_host_association
  config_get('interface', 'switchport_pvlan_host_association', name: @name)
end

#switchport_pvlan_host_association=(pri_and_sec) ⇒ Object

Input: An array of primary and secondary vlans: ['44', '244']


1527
1528
1529
1530
1531
1532
1533
1534
1535
# File 'lib/cisco_node_utils/interface.rb', line 1527

def switchport_pvlan_host_association=(pri_and_sec)
  pvlan_enable

  state = pri_and_sec.empty? ? 'no' : ''
  pri, sec = pri_and_sec
  cli_error_check(
    config_set('interface', 'switchport_pvlan_host_association',
               name: @name, state: state, pri: pri, sec: sec))
end

#switchport_pvlan_mappingObject


<state> switchport private-vlan mapping <primary> <vlan>


1543
1544
1545
# File 'lib/cisco_node_utils/interface.rb', line 1543

def switchport_pvlan_mapping
  config_get('interface', 'switchport_pvlan_mapping', name: @name)
end

#switchport_pvlan_mapping=(primary_and_range) ⇒ Object

Input: An array of primary vlan and range of vlans: ['44', '3-4,6']


1548
1549
1550
# File 'lib/cisco_node_utils/interface.rb', line 1548

def switchport_pvlan_mapping=(primary_and_range)
  switchport_pvlan_mapping_delta(primary_and_range)
end

#switchport_pvlan_mapping_delta(primary_and_range) ⇒ Object


Find the is/should delta and add/remove commands as needed.

Inputs: primary_and_range: An array of primary vlan and range of vlans


1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'lib/cisco_node_utils/interface.rb', line 1561

def switchport_pvlan_mapping_delta(primary_and_range)
  # Enable switchport mode and feature private-vlan
  pvlan_enable
  primary, should_range = primary_and_range

  # primary changes require removing the entire command first
  is_range = switchport_pvlan_mapping_remove?(primary)

  # convert ranges to individual elements
  is = Utils.dash_range_to_elements(is_range)
  should = Utils.dash_range_to_elements(should_range)

  # create the delta hash and apply the changes
  delta_hash = Utils.delta_add_remove(should, is)
  Cisco::Logger.debug('switchport_pvlan_mapping_delta: '\
                      "#{primary}: #{delta_hash}")
  [:add, :remove].each do |action|
    delta_hash[action].each do |vlan|
      state = (action == :add) ? '' : 'no'
      cli_error_check(
        config_set('interface', 'switchport_pvlan_mapping',
                   name: @name, state: state, primary: primary, vlan: vlan))
    end
  end
end

#switchport_pvlan_mapping_remove?(should_primary) ⇒ Boolean


switchport_pvlan_mapping_remove? This is a helper to check if command needs to be removed entirely.

should_primary: the new primary vlan value

Returns: the current vlan range

1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
# File 'lib/cisco_node_utils/interface.rb', line 1593

def switchport_pvlan_mapping_remove?(should_primary)
  is_primary, is_range = switchport_pvlan_mapping

  if (is_primary != should_primary) && !is_primary.nil?
    cli_error_check(
      config_set('interface', 'switchport_pvlan_mapping',
                 name: @name, state: 'no', primary: '', vlan: ''))
    is_range = []
  end
  is_range
end

#switchport_pvlan_mapping_trunkObject


<state> switchport private-vlan mapping trunk <primary> <vlan>


1607
1608
1609
# File 'lib/cisco_node_utils/interface.rb', line 1607

def switchport_pvlan_mapping_trunk
  config_get('interface', 'switchport_pvlan_mapping_trunk', name: @name)
end

#switchport_pvlan_mapping_trunk=(should) ⇒ Object

Input: A nested array of primary vlan and range of vlans:

['44', '3-4,6'], ['99', '199']

1613
1614
1615
# File 'lib/cisco_node_utils/interface.rb', line 1613

def switchport_pvlan_mapping_trunk=(should)
  switchport_pvlan_mapping_trunk_delta(should)
end

#switchport_pvlan_mapping_trunk_delta(should) ⇒ Object


switchport_pvlan_mapping_trunk_delta(should)

Find the is/should delta and add/remove commands as needed. The 'should' value is a nested array of primary vlan and secondary ranges; e.g.:

[['44', '144-145'], ['99', '199-201']

1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
# File 'lib/cisco_node_utils/interface.rb', line 1629

def switchport_pvlan_mapping_trunk_delta(should)
  # Enable switchport mode and feature private-vlan
  pvlan_enable

  # Handle single-level arrays if found: [pri, range] -> [[pri,range]]
  should = [should] if !should.empty? && (Utils.depth(should) == 1)

  is = switchport_pvlan_mapping_trunk
  delta_hash = Utils.delta_add_remove(should, is, :updates_not_allowed)
  Cisco::Logger.debug("switchport_pvlan_mapping_trunk_delta: #{delta_hash}")
  [:remove, :add].each do |action|
    delta_hash[action].each do |pri_and_range|
      pri, range = pri_and_range
      if action == :add
        state = ''
      else
        state = 'no'
        range = ''
      end
      cli_error_check(
        config_set('interface', 'switchport_pvlan_mapping_trunk',
                   name: @name, state: state, primary: pri, range: range))
    end
  end
end

#switchport_pvlan_promiscuousObject


<state> switchport mode private-vlan promiscuous


1504
1505
1506
1507
# File 'lib/cisco_node_utils/interface.rb', line 1504

def switchport_pvlan_promiscuous
  return nil if switchport_mode == :disabled
  config_get('interface', 'switchport_pvlan_promiscuous', name: @name)
end

#switchport_pvlan_promiscuous=(state) ⇒ Object


1509
1510
1511
1512
1513
# File 'lib/cisco_node_utils/interface.rb', line 1509

def switchport_pvlan_promiscuous=(state)
  pvlan_enable
  config_set('interface', 'switchport_pvlan_promiscuous',
             name: @name, state: state ? '' : 'no')
end

#switchport_pvlan_trunk_allowed_vlanObject


<state> switchport private-vlan trunk allowed vlan <range> Note that range is handled as a string because the entire range is replaced instead of individually adding or removing vlans from the range.


1733
1734
1735
1736
1737
1738
1739
1740
# File 'lib/cisco_node_utils/interface.rb', line 1733

def switchport_pvlan_trunk_allowed_vlan
  return nil if switchport_mode == :disabled
  vlans = config_get('interface', 'switchport_pvlan_trunk_allowed_vlan',
                     name: @name)
  vlans = vlans.join(',') if vlans.is_a?(Array)
  vlans = Utils.normalize_range_array(vlans, :string) unless vlans == 'none'
  vlans
end

#switchport_pvlan_trunk_allowed_vlan=(range) ⇒ Object


1742
1743
1744
1745
1746
1747
1748
1749
1750
# File 'lib/cisco_node_utils/interface.rb', line 1742

def switchport_pvlan_trunk_allowed_vlan=(range)
  pvlan_enable

  range = Utils.normalize_range_array(range, :string) unless
    range == default_switchport_pvlan_trunk_allowed_vlan

  config_set('interface', 'switchport_pvlan_trunk_allowed_vlan',
             name: @name, range: range)
end

#switchport_pvlan_trunk_associationObject


<state> switchport private-vlan association trunk <pri> <sec> Supports multiple.


1658
1659
1660
# File 'lib/cisco_node_utils/interface.rb', line 1658

def switchport_pvlan_trunk_association
  config_get('interface', 'switchport_pvlan_trunk_association', name: @name)
end

#switchport_pvlan_trunk_association=(should) ⇒ Object

Input: A nested array of primary and secondary vlans:

['44', '244'], ['99', '299']

1664
1665
1666
1667
1668
1669
1670
1671
1672
# File 'lib/cisco_node_utils/interface.rb', line 1664

def switchport_pvlan_trunk_association=(should)
  pvlan_enable

  # Handle single-level arrays if found: [pri, sec] -> [[pri,sec]]
  should = [should] if !should.empty? && (Utils.depth(should) == 1)

  is = switchport_pvlan_trunk_association
  pvlan_trunk_association_delta(is, should)
end

#switchport_pvlan_trunk_native_vlanObject


<state> switchport trunk native vlan <vlan>


1758
1759
1760
1761
# File 'lib/cisco_node_utils/interface.rb', line 1758

def switchport_pvlan_trunk_native_vlan
  return nil if switchport_mode == :disabled
  config_get('interface', 'switchport_pvlan_trunk_native_vlan', name: @name)
end

#switchport_pvlan_trunk_native_vlan=(vlan) ⇒ Object


1763
1764
1765
1766
1767
# File 'lib/cisco_node_utils/interface.rb', line 1763

def switchport_pvlan_trunk_native_vlan=(vlan)
  pvlan_enable
  config_set('interface', 'switchport_pvlan_trunk_native_vlan',
             name: @name, vlan: vlan)
end

#switchport_pvlan_trunk_promiscuousObject


<state> switchport mode private-vlan trunk promiscuous


1697
1698
1699
1700
# File 'lib/cisco_node_utils/interface.rb', line 1697

def switchport_pvlan_trunk_promiscuous
  return nil if switchport_mode == :disabled
  config_get('interface', 'switchport_pvlan_trunk_promiscuous', name: @name)
end

#switchport_pvlan_trunk_promiscuous=(state) ⇒ Object


1702
1703
1704
1705
1706
# File 'lib/cisco_node_utils/interface.rb', line 1702

def switchport_pvlan_trunk_promiscuous=(state)
  pvlan_enable
  config_set('interface', 'switchport_pvlan_trunk_promiscuous',
             name: @name, state: state ? '' : 'no')
end

#switchport_pvlan_trunk_secondaryObject


<state> switchport mode private-vlan trunk secondary


1714
1715
1716
1717
# File 'lib/cisco_node_utils/interface.rb', line 1714

def switchport_pvlan_trunk_secondary
  return nil if switchport_mode == :disabled
  config_get('interface', 'switchport_pvlan_trunk_secondary', name: @name)
end

#switchport_pvlan_trunk_secondary=(state) ⇒ Object


1719
1720
1721
1722
1723
# File 'lib/cisco_node_utils/interface.rb', line 1719

def switchport_pvlan_trunk_secondary=(state)
  pvlan_enable
  config_set('interface', 'switchport_pvlan_trunk_secondary',
             name: @name, state: state ? '' : 'no')
end

#switchport_status?(status) ⇒ Boolean


1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
# File 'lib/cisco_node_utils/interface.rb', line 1985

def switchport_status?(status)
  case status
  when :disabled
    return true if switchport_mode == status || switchport_mode.nil?
  when :access, :trunk
    return switchport_mode == status
  when Array
    return status.include?(switchport_mode)
  else
    return false
  end
end

#switchport_trunk_allowed_vlanObject


1427
1428
1429
1430
1431
1432
1433
1434
# File 'lib/cisco_node_utils/interface.rb', line 1427

def switchport_trunk_allowed_vlan
  return nil if switchport_mode == :disabled
  vlans = config_get('interface', 'switchport_trunk_allowed_vlan',
                     name: @name)
  vlans = vlans.join(',') if vlans.is_a?(Array)
  vlans = Utils.normalize_range_array(vlans, :string) unless vlans == 'none'
  vlans
end

#switchport_trunk_allowed_vlan=(val) ⇒ Object


1436
1437
1438
1439
1440
1441
1442
1443
1444
# File 'lib/cisco_node_utils/interface.rb', line 1436

def switchport_trunk_allowed_vlan=(val)
  if val.nil?
    config_set('interface', 'switchport_trunk_allowed_vlan',
               name: @name, state: 'no', vlan: '')
  else
    config_set('interface', 'switchport_trunk_allowed_vlan',
               name: @name, state: '', vlan: val)
  end
end

#switchport_trunk_native_vlanObject


1450
1451
1452
1453
# File 'lib/cisco_node_utils/interface.rb', line 1450

def switchport_trunk_native_vlan
  return nil if switchport_mode == :disabled
  config_get('interface', 'switchport_trunk_native_vlan', name: @name)
end

#switchport_trunk_native_vlan=(val) ⇒ Object


1455
1456
1457
1458
1459
1460
1461
1462
1463
# File 'lib/cisco_node_utils/interface.rb', line 1455

def switchport_trunk_native_vlan=(val)
  if val.nil?
    config_set('interface', 'switchport_trunk_native_vlan',
               name: @name, state: 'no', vlan: '')
  else
    config_set('interface', 'switchport_trunk_native_vlan',
               name: @name, state: '', vlan: val)
  end
end

#switchport_vtpObject


1912
1913
1914
1915
# File 'lib/cisco_node_utils/interface.rb', line 1912

def switchport_vtp
  return nil unless switchport_vtp_mode_capable?
  config_get('interface', 'vtp', name: @name)
end

#switchport_vtp=(vtp_set) ⇒ Object


1917
1918
1919
1920
1921
1922
1923
1924
# File 'lib/cisco_node_utils/interface.rb', line 1917

def switchport_vtp=(vtp_set)
  # TODO: throw UnsupportedError instead of returning false?
  return false unless switchport_vtp_mode_capable?
  return false if !vtp_set && !Feature.vtp_enabled?
  Feature.vtp_enable if vtp_set
  no_cmd = (vtp_set) ? '' : 'no'
  config_set('interface', 'vtp', name: @name, state: no_cmd)
end

#switchport_vtp_feature?Boolean


1981
1982
1983
# File 'lib/cisco_node_utils/interface.rb', line 1981

def switchport_vtp_feature?
  config_get('vtp', 'feature')
end

#switchport_vtp_mode_capable?Boolean


1908
1909
1910
# File 'lib/cisco_node_utils/interface.rb', line 1908

def switchport_vtp_mode_capable?
  !switchport_mode.to_s.match(/(access|trunk)/).nil?
end

#system_default_svi_autostateObject


1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
# File 'lib/cisco_node_utils/interface.rb', line 1893

def system_default_svi_autostate
  # This command is a user-configurable system default.
  #
  # This property behaves differently on an n7k vs ni(3|9)k and therefore
  # needs special handling.
  # N7K: When enabled, does not nvgen.
  #      When disabled, does nvgen, but differently then n(3|9)k.
  #      Return true for the disabled case, false otherwise.
  # N(3|9)K: When enabled, does nvgen.
  #          When disabled, does nvgen.
  #          Return true for the enabled case, false otherwise.
  result = config_get('interface', 'system_default_svi_autostate')
  /N7K/.match(node.product_id) ? !result : result
end

#system_default_switchportObject


1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'lib/cisco_node_utils/interface.rb', line 1875

def system_default_switchport
  # This command is a user-configurable system default.
  #
  # Note: This is a simple boolean state but there is a bug on some
  # platforms that causes the cli to nvgen twice; this causes config_get to
  # raise an error when it encounters the multiple. Therefore we define it
  # as a multiple to avoid the raise and handle the array if necessary.
  #
  val = config_get('interface', 'system_default_switchport')
  return (val[0][/^no /] ? false : true) if val.is_a?(Array)
  val
end

#system_default_switchport_shutdownObject


1888
1889
1890
1891
# File 'lib/cisco_node_utils/interface.rb', line 1888

def system_default_switchport_shutdown
  # This command is a user-configurable system default.
  config_get('interface', 'system_default_switchport_shutdown')
end

#to_sObject


73
74
75
# File 'lib/cisco_node_utils/interface.rb', line 73

def to_s
  "interface #{name}"
end

#vlan_mappingObject


1830
1831
1832
1833
1834
# File 'lib/cisco_node_utils/interface.rb', line 1830

def vlan_mapping
  match = config_get('interface', 'vlan_mapping', name: @name)
  match.each(&:compact!) unless match.nil?
  match
end

#vlan_mapping=(should_list) ⇒ Object


1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
# File 'lib/cisco_node_utils/interface.rb', line 1836

def vlan_mapping=(should_list)
  Feature.vni_enable

  # Process a hash of vlan_mapping cmds from delta_add_remove().
  # The vlan_mapping cli does not allow commands to be updated, they must
  # first be removed if there is a change.
  delta_hash = Utils.delta_add_remove(should_list, vlan_mapping,
                                      :updates_not_allowed)
  return if delta_hash.values.flatten.empty?
  # Process :remove first to ensure "update" commands will not fail.
  [:remove, :add].each do |action|
    Cisco::Logger.debug("vlan_mapping delta #{@get_args}\n"\
                        "#{action}: #{delta_hash[action]}")
    delta_hash[action].each do |original, translated|
      state = (action == :add) ? '' : 'no'
      config_set('interface', 'vlan_mapping', name: @name,
                 state: state, original: original, translated: translated)
    end
  end
end

#vlan_mapping_enableObject


1862
1863
1864
# File 'lib/cisco_node_utils/interface.rb', line 1862

def vlan_mapping_enable
  config_get('interface', 'vlan_mapping_enable', name: @name)
end

#vlan_mapping_enable=(state) ⇒ Object


1866
1867
1868
1869
# File 'lib/cisco_node_utils/interface.rb', line 1866

def vlan_mapping_enable=(state)
  config_set('interface', 'vlan_mapping_enable',
             name: @name, state: state ? '' : 'no')
end

#vpc_idObject


2004
2005
2006
# File 'lib/cisco_node_utils/interface.rb', line 2004

def vpc_id
  config_get('interface', 'vpc_id', name: @name)
end

#vpc_id=(num) ⇒ Object


2008
2009
2010
2011
2012
2013
2014
2015
2016
# File 'lib/cisco_node_utils/interface.rb', line 2008

def vpc_id=(num)
  if num
    config_set('interface', 'vpc_id', name: @name, state: '', id: num)
  else
    # 'no vpc' doesn't work for phy ports, so do a get
    num = vpc_id
    config_set('interface', 'vpc_id', name: @name, state: 'no', id: num)
  end
end

2022
2023
2024
2025
# File 'lib/cisco_node_utils/interface.rb', line 2022

def vpc_peer_link
  return nil unless @name[/port-channel/i] && switchport_mode != :disabled
  config_get('interface', 'vpc_peer_link', name: @name)
end

#vpc_peer_link=(state) ⇒ Object


2027
2028
2029
2030
2031
# File 'lib/cisco_node_utils/interface.rb', line 2027

def vpc_peer_link=(state)
  return if vpc_peer_link == state
  no_cmd = (state ? '' : 'no')
  config_set('interface', 'vpc_peer_link', name: @name, state: no_cmd)
end

#vrfObject


2037
2038
2039
# File 'lib/cisco_node_utils/interface.rb', line 2037

def vrf
  config_get('interface', 'vrf', name: @name)
end

#vrf=(v) ⇒ Object


2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
# File 'lib/cisco_node_utils/interface.rb', line 2041

def vrf=(v)
  fail TypeError unless v.is_a?(String)
  return if v == vrf
  # Changing the VRF can result in loss of IP address, so cache it
  addr_1 = ipv4_address
  mask_1 = ipv4_netmask_length
  addr_2 = ipv4_address_secondary
  mask_2 = ipv4_netmask_length_secondary
  # XR actually blocks you from changing the VRF if IP addr is present
  unless platform == :nexus
    ipv4_addr_mask_set(nil, nil, false) unless addr_1.nil?
    ipv4_addr_mask_set(nil, nil, true) unless addr_2.nil?
  end
  if v.empty?
    config_set('interface', 'vrf', name: @name, state: 'no', vrf: '')
  else
    config_set('interface', 'vrf', name: @name, state: '', vrf: v)
  end
  ipv4_addr_mask_set(addr_1, mask_1, false) unless addr_1.nil?
  ipv4_addr_mask_set(addr_2, mask_2, true) unless addr_2.nil?
end