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

Returns a new instance of 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

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#state_default ⇒ Object (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_vlan ⇒ Object

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
 
# File 'lib/cisco_node_utils/interface.rb', line 194

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

#access_vlan=(vlan) ⇒ Object 



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

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

#bfd_echo ⇒ Object 



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

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 



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

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 



1949
1950
1951
1952
1953
 
# File 'lib/cisco_node_utils/interface.rb', line 1949

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 



1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/cisco_node_utils/interface.rb', line 1423

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

#create ⇒ Object 



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

Returns:

  • (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_vlan ⇒ Object 



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

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

#default_bfd_echo ⇒ Object 



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

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

#default_description ⇒ Object 



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

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

#default_duplex ⇒ Object 



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

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

#default_encapsulation_dot1q ⇒ Object 



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

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

#default_fabric_forwarding_anycast_gateway ⇒ Object 



294
295
296
 
# File 'lib/cisco_node_utils/interface.rb', line 294

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

#default_hsrp_bfd ⇒ Object 



312
313
314
 
# File 'lib/cisco_node_utils/interface.rb', line 312

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

#default_hsrp_delay ⇒ Object 



323
324
325
 
# File 'lib/cisco_node_utils/interface.rb', line 323

def default_hsrp_delay
  [default_hsrp_delay_minimum, default_hsrp_delay_reload]
end

#default_hsrp_delay_minimum ⇒ Object 



340
341
342
 
# File 'lib/cisco_node_utils/interface.rb', line 340

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

#default_hsrp_delay_reload ⇒ Object 



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

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

#default_hsrp_mac_refresh ⇒ Object 



373
374
375
 
# File 'lib/cisco_node_utils/interface.rb', line 373

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

#default_hsrp_use_bia ⇒ Object 



411
412
413
 
# File 'lib/cisco_node_utils/interface.rb', line 411

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

#default_hsrp_version ⇒ Object 



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

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

#default_ipv4_acl_in ⇒ Object 



445
446
447
 
# File 'lib/cisco_node_utils/interface.rb', line 445

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

#default_ipv4_acl_out ⇒ Object 



466
467
468
 
# File 'lib/cisco_node_utils/interface.rb', line 466

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

#default_ipv4_address ⇒ Object 



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

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

#default_ipv4_address_secondary ⇒ Object 



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

def default_ipv4_address_secondary
  default_ipv4_address
end

#default_ipv4_arp_timeout ⇒ Object 



578
579
580
 
# File 'lib/cisco_node_utils/interface.rb', line 578

def default_ipv4_arp_timeout
  config_get_default('interface', ipv4_arp_timeout_lookup_string)
end

#default_ipv4_dhcp_relay_addr ⇒ Object 



602
603
604
 
# File 'lib/cisco_node_utils/interface.rb', line 602

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

#default_ipv4_dhcp_relay_info_trust ⇒ Object 



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

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

#default_ipv4_dhcp_relay_src_addr_hsrp ⇒ Object 



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

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

#default_ipv4_dhcp_relay_src_intf ⇒ Object 



652
653
654
 
# File 'lib/cisco_node_utils/interface.rb', line 652

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

#default_ipv4_dhcp_relay_subnet_broadcast ⇒ Object 



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

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

#default_ipv4_dhcp_smart_relay ⇒ Object 



682
683
684
 
# File 'lib/cisco_node_utils/interface.rb', line 682

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

#default_ipv4_forwarding ⇒ Object 



696
697
698
 
# File 'lib/cisco_node_utils/interface.rb', line 696

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

#default_ipv4_netmask_length ⇒ Object 



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

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

#default_ipv4_netmask_length_secondary ⇒ Object 



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

def default_ipv4_netmask_length_secondary
  default_ipv4_netmask_length
end

#default_ipv4_pim_sparse_mode ⇒ Object 



711
712
713
 
# File 'lib/cisco_node_utils/interface.rb', line 711

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

#default_ipv4_proxy_arp ⇒ Object 



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

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

#default_ipv4_redirects ⇒ Object 



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

def default_ipv4_redirects
  config_get_default('interface', ipv4_redirects_lookup_string)
end

#default_ipv6_acl_in ⇒ Object 



769
770
771
 
# File 'lib/cisco_node_utils/interface.rb', line 769

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

#default_ipv6_acl_out ⇒ Object 



789
790
791
 
# File 'lib/cisco_node_utils/interface.rb', line 789

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

#default_ipv6_dhcp_relay_addr ⇒ Object 



813
814
815
 
# File 'lib/cisco_node_utils/interface.rb', line 813

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

#default_ipv6_dhcp_relay_src_intf ⇒ Object 



833
834
835
 
# File 'lib/cisco_node_utils/interface.rb', line 833

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

#default_load_interval_counter_1_delay ⇒ Object 



858
859
860
861
862
863
864
865
866
 
# File 'lib/cisco_node_utils/interface.rb', line 858

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_delay ⇒ Object 



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

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

#default_load_interval_counter_3_delay ⇒ Object 



898
899
900
 
# File 'lib/cisco_node_utils/interface.rb', line 898

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

#default_mtu ⇒ Object 



921
922
923
 
# File 'lib/cisco_node_utils/interface.rb', line 921

def default_mtu
  config_get_default('interface', mtu_lookup_string)
end

#default_negotiate_auto ⇒ Object 



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

def default_negotiate_auto
  config_get_default('interface', negotiate_auto_lookup_string)
end

#default_pim_bfd ⇒ Object 



1030
1031
1032
 
# File 'lib/cisco_node_utils/interface.rb', line 1030

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

#default_pvlan_mapping ⇒ Object 



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

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

#default_shutdown ⇒ Object 



983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/cisco_node_utils/interface.rb', line 983

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_speed ⇒ Object 



933
934
935
 
# File 'lib/cisco_node_utils/interface.rb', line 933

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

#default_storm_control_broadcast ⇒ Object 



1045
1046
1047
 
# File 'lib/cisco_node_utils/interface.rb', line 1045

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

#default_storm_control_multicast ⇒ Object 



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

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

#default_storm_control_unicast ⇒ Object 



1075
1076
1077
 
# File 'lib/cisco_node_utils/interface.rb', line 1075

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

#default_stp_bpdufilter ⇒ Object 



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

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

#default_stp_bpduguard ⇒ Object 



1114
1115
1116
 
# File 'lib/cisco_node_utils/interface.rb', line 1114

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

#default_stp_cost ⇒ Object 



1128
1129
1130
 
# File 'lib/cisco_node_utils/interface.rb', line 1128

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

#default_stp_guard ⇒ Object 



1148
1149
1150
 
# File 'lib/cisco_node_utils/interface.rb', line 1148

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

#default_stp_link_type ⇒ Object 



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

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

#default_stp_mst_cost ⇒ Object 



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

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

#default_stp_mst_port_priority ⇒ Object 



1218
1219
1220
 
# File 'lib/cisco_node_utils/interface.rb', line 1218

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

#default_stp_port_priority ⇒ Object 



1174
1175
1176
 
# File 'lib/cisco_node_utils/interface.rb', line 1174

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

#default_stp_port_type ⇒ Object 



1238
1239
1240
 
# File 'lib/cisco_node_utils/interface.rb', line 1238

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

#default_stp_vlan_cost ⇒ Object 



1260
1261
1262
 
# File 'lib/cisco_node_utils/interface.rb', line 1260

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

#default_stp_vlan_port_priority ⇒ Object 



1282
1283
1284
 
# File 'lib/cisco_node_utils/interface.rb', line 1282

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

#default_svi_autostate ⇒ Object 



1895
1896
1897
 
# File 'lib/cisco_node_utils/interface.rb', line 1895

def default_svi_autostate
  system_default_svi_autostate
end

#default_svi_management ⇒ Object 



1923
1924
1925
 
# File 'lib/cisco_node_utils/interface.rb', line 1923

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

#default_switchport_autostate_exclude ⇒ Object 



1312
1313
1314
 
# File 'lib/cisco_node_utils/interface.rb', line 1312

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

#default_switchport_mode ⇒ Object 



1379
1380
1381
1382
1383
1384
 
# File 'lib/cisco_node_utils/interface.rb', line 1379

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_host ⇒ Object 



1454
1455
1456
 
# File 'lib/cisco_node_utils/interface.rb', line 1454

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

#default_switchport_pvlan_host_association ⇒ Object 



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

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

#default_switchport_pvlan_mapping ⇒ Object 



1507
1508
1509
 
# File 'lib/cisco_node_utils/interface.rb', line 1507

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

#default_switchport_pvlan_mapping_trunk ⇒ Object 



1572
1573
1574
 
# File 'lib/cisco_node_utils/interface.rb', line 1572

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

#default_switchport_pvlan_promiscuous ⇒ Object 



1470
1471
1472
 
# File 'lib/cisco_node_utils/interface.rb', line 1470

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

#default_switchport_pvlan_trunk_allowed_vlan ⇒ Object 



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

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

#default_switchport_pvlan_trunk_association ⇒ Object 



1646
1647
1648
 
# File 'lib/cisco_node_utils/interface.rb', line 1646

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

#default_switchport_pvlan_trunk_native_vlan ⇒ Object 



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

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

#default_switchport_pvlan_trunk_promiscuous ⇒ Object 



1662
1663
1664
 
# File 'lib/cisco_node_utils/interface.rb', line 1662

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

#default_switchport_pvlan_trunk_secondary ⇒ Object 



1678
1679
1680
 
# File 'lib/cisco_node_utils/interface.rb', line 1678

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

#default_switchport_trunk_allowed_vlan ⇒ Object 



1404
1405
1406
 
# File 'lib/cisco_node_utils/interface.rb', line 1404

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

#default_switchport_trunk_native_vlan ⇒ Object 



1822
1823
1824
 
# File 'lib/cisco_node_utils/interface.rb', line 1822

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

#default_switchport_vtp ⇒ Object 



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

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

#default_vlan_mapping ⇒ Object

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’]]



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

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

#default_vlan_mapping_enable ⇒ Object

cli: switchport vlan mapping enable



1809
1810
1811
 
# File 'lib/cisco_node_utils/interface.rb', line 1809

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

#default_vpc_id ⇒ Object 



1969
1970
1971
 
# File 'lib/cisco_node_utils/interface.rb', line 1969

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

#default_vpc_peer_link ⇒ Object 



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

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

#default_vrf ⇒ Object 



2012
2013
2014
 
# File 'lib/cisco_node_utils/interface.rb', line 2012

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

#description ⇒ Object 



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

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

#description=(desc) ⇒ Object 



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

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

#destroy ⇒ Object 



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

#duplex ⇒ Object 



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

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

#duplex=(val) ⇒ Object 



941
942
943
 
# File 'lib/cisco_node_utils/interface.rb', line 941

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

#encapsulation_dot1q ⇒ Object 



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

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

#encapsulation_dot1q=(val) ⇒ Object 



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

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_gateway ⇒ Object 



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

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

#fabric_forwarding_anycast_gateway=(state) ⇒ Object 



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

def 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_feature ⇒ Object 



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

def fabricpath_feature
  FabricpathGlobal.fabricpath_feature
end

#fabricpath_feature_set(fabricpath_set) ⇒ Object 



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

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

#feature_lacp? ⇒ Boolean

Returns:

  • (Boolean) 


837
838
839
 
# File 'lib/cisco_node_utils/interface.rb', line 837

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

#feature_lacp_set(val) ⇒ Object 



841
842
843
844
 
# File 'lib/cisco_node_utils/interface.rb', line 841

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

#feature_vlan? ⇒ Boolean

Returns:

  • (Boolean) 


1899
1900
1901
 
# File 'lib/cisco_node_utils/interface.rb', line 1899

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

#feature_vlan_set(val = true) ⇒ Object 



1903
1904
1905
1906
1907
1908
 
# File 'lib/cisco_node_utils/interface.rb', line 1903

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_bfd ⇒ Object 



298
299
300
 
# File 'lib/cisco_node_utils/interface.rb', line 298

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

#hsrp_bfd=(val) ⇒ Object 



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

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_delay ⇒ Object

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



318
319
320
321
 
# File 'lib/cisco_node_utils/interface.rb', line 318

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

#hsrp_delay_minimum ⇒ Object 



327
328
329
330
 
# File 'lib/cisco_node_utils/interface.rb', line 327

def hsrp_delay_minimum
  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



334
335
336
337
338
 
# File 'lib/cisco_node_utils/interface.rb', line 334

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_reload ⇒ Object 



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

def hsrp_delay_reload
  _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



351
352
353
354
355
 
# File 'lib/cisco_node_utils/interface.rb', line 351

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_refresh ⇒ Object 



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

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

#hsrp_mac_refresh=(val) ⇒ Object 



365
366
367
368
369
370
371
 
# File 'lib/cisco_node_utils/interface.rb', line 365

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_bia ⇒ Object 



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

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 



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

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_version ⇒ Object 



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

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

#hsrp_version=(val) ⇒ Object 



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

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

#ipv4_acl_in ⇒ Object 



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

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

#ipv4_acl_in=(val) ⇒ Object 



432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/cisco_node_utils/interface.rb', line 432

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_out ⇒ Object 



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

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

#ipv4_acl_out=(val) ⇒ Object 



453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/cisco_node_utils/interface.rb', line 453

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_mask ⇒ Object 



491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/cisco_node_utils/interface.rb', line 491

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 



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/cisco_node_utils/interface.rb', line 470

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_address ⇒ Object 



525
526
527
 
# File 'lib/cisco_node_utils/interface.rb', line 525

def ipv4_address
  select_ipv4_attribute(:v4_addr)
end

#ipv4_address_secondary ⇒ Object 



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

def ipv4_address_secondary
  select_ipv4_attribute(:v4_addr_secondary)
end

#ipv4_arp_timeout ⇒ Object 



566
567
568
 
# File 'lib/cisco_node_utils/interface.rb', line 566

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

#ipv4_arp_timeout=(timeout) ⇒ Object 



570
571
572
573
574
575
576
 
# File 'lib/cisco_node_utils/interface.rb', line 570

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_string ⇒ Object 



557
558
559
560
561
562
563
564
 
# File 'lib/cisco_node_utils/interface.rb', line 557

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_addr ⇒ Object 



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

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

#ipv4_dhcp_relay_addr=(list) ⇒ Object 



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/cisco_node_utils/interface.rb', line 586

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_trust ⇒ Object 



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

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

#ipv4_dhcp_relay_info_trust=(state) ⇒ Object 



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

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_hsrp ⇒ Object 



621
622
623
 
# File 'lib/cisco_node_utils/interface.rb', line 621

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 



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

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_intf ⇒ Object 



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

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 



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

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_broadcast ⇒ Object 



656
657
658
 
# File 'lib/cisco_node_utils/interface.rb', line 656

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

#ipv4_dhcp_relay_subnet_broadcast=(state) ⇒ Object 



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

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_relay ⇒ Object 



671
672
673
 
# File 'lib/cisco_node_utils/interface.rb', line 671

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

#ipv4_dhcp_smart_relay=(state) ⇒ Object 



675
676
677
678
679
680
 
# File 'lib/cisco_node_utils/interface.rb', line 675

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_forwarding ⇒ Object 



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

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

#ipv4_forwarding=(state) ⇒ Object 



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

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

#ipv4_netmask_length ⇒ Object 



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

def ipv4_netmask_length
  select_ipv4_attribute(:v4_mask)
end

#ipv4_netmask_length_secondary ⇒ Object 



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

def ipv4_netmask_length_secondary
  select_ipv4_attribute(:v4_mask_secondary)
end

#ipv4_pim_sparse_mode ⇒ Object 



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

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

#ipv4_pim_sparse_mode=(state) ⇒ Object 



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

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_arp ⇒ Object 



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

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

#ipv4_proxy_arp=(proxy_arp) ⇒ Object 



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

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_redirects ⇒ Object 



738
739
740
 
# File 'lib/cisco_node_utils/interface.rb', line 738

def ipv4_redirects
  config_get('interface', ipv4_redirects_lookup_string, name: @name)
end

#ipv4_redirects=(redirects) ⇒ Object 



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

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_string ⇒ Object 



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

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

#ipv6_acl_in ⇒ Object 



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

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

#ipv6_acl_in=(val) ⇒ Object 



757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/cisco_node_utils/interface.rb', line 757

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_out ⇒ Object 



773
774
775
 
# File 'lib/cisco_node_utils/interface.rb', line 773

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

#ipv6_acl_out=(val) ⇒ Object 



777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/cisco_node_utils/interface.rb', line 777

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_addr ⇒ Object 



793
794
795
 
# File 'lib/cisco_node_utils/interface.rb', line 793

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

#ipv6_dhcp_relay_addr=(list) ⇒ Object 



797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
 
# File 'lib/cisco_node_utils/interface.rb', line 797

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_intf ⇒ Object 



817
818
819
820
821
822
 
# File 'lib/cisco_node_utils/interface.rb', line 817

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 



824
825
826
827
828
829
830
831
 
# File 'lib/cisco_node_utils/interface.rb', line 824

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

#load_interval_counter_1_delay ⇒ Object 



846
847
848
849
 
# File 'lib/cisco_node_utils/interface.rb', line 846

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 



851
852
853
854
855
856
 
# File 'lib/cisco_node_utils/interface.rb', line 851

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_delay ⇒ Object 



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

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 



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

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_delay ⇒ Object 



884
885
886
887
 
# File 'lib/cisco_node_utils/interface.rb', line 884

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 



889
890
891
892
893
894
895
896
 
# File 'lib/cisco_node_utils/interface.rb', line 889

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

#mtu ⇒ Object 



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

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

#mtu=(val) ⇒ Object 



915
916
917
918
919
 
# File 'lib/cisco_node_utils/interface.rb', line 915

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

#mtu_lookup_string ⇒ Object 



902
903
904
905
906
907
908
909
 
# File 'lib/cisco_node_utils/interface.rb', line 902

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

#negotiate_auto ⇒ Object 



960
961
962
 
# File 'lib/cisco_node_utils/interface.rb', line 960

def negotiate_auto
  config_get('interface', negotiate_auto_lookup_string, name: @name)
end

#negotiate_auto=(negotiate_auto) ⇒ Object 



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

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_string ⇒ Object 



949
950
951
952
953
954
955
956
957
958
 
# File 'lib/cisco_node_utils/interface.rb', line 949

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_bfd ⇒ Object 



1016
1017
1018
 
# File 'lib/cisco_node_utils/interface.rb', line 1016

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

#pim_bfd=(val) ⇒ Object 



1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/cisco_node_utils/interface.rb', line 1020

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_config ⇒ Object 



2039
2040
2041
2042
 
# File 'lib/cisco_node_utils/interface.rb', line 2039

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

#purge_config=(val) ⇒ Object 



2031
2032
2033
2034
2035
2036
2037
 
# File 'lib/cisco_node_utils/interface.rb', line 2031

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_enable ⇒ Object 



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

def pvlan_enable
  switchport_enable
  Feature.private_vlan_enable
end

#pvlan_mapping ⇒ Object

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



1728
1729
1730
1731
1732
 
# File 'lib/cisco_node_utils/interface.rb', line 1728

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 



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

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 



1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/cisco_node_utils/interface.rb', line 1744

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 



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/cisco_node_utils/interface.rb', line 1629

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 



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/cisco_node_utils/interface.rb', line 505

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 



2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
 
# File 'lib/cisco_node_utils/interface.rb', line 2016

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

#shutdown ⇒ Object 



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

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

#shutdown=(state) ⇒ Object 



978
979
980
981
 
# File 'lib/cisco_node_utils/interface.rb', line 978

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

#speed ⇒ Object 



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

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

#speed=(val) ⇒ Object 



929
930
931
 
# File 'lib/cisco_node_utils/interface.rb', line 929

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

#storm_control_broadcast ⇒ Object 



1034
1035
1036
 
# File 'lib/cisco_node_utils/interface.rb', line 1034

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

#storm_control_broadcast=(val) ⇒ Object 



1038
1039
1040
1041
1042
1043
 
# File 'lib/cisco_node_utils/interface.rb', line 1038

def storm_control_broadcast=(val)
  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_multicast ⇒ Object 



1049
1050
1051
 
# File 'lib/cisco_node_utils/interface.rb', line 1049

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

#storm_control_multicast=(val) ⇒ Object 



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

def storm_control_multicast=(val)
  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_unicast ⇒ Object 



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

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

#storm_control_unicast=(val) ⇒ Object 



1068
1069
1070
1071
1072
1073
 
# File 'lib/cisco_node_utils/interface.rb', line 1068

def storm_control_unicast=(val)
  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_bpdufilter ⇒ Object 



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

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

#stp_bpdufilter=(val) ⇒ Object 



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

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_bpduguard ⇒ Object 



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

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

#stp_bpduguard=(val) ⇒ Object 



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

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_cost ⇒ Object 



1118
1119
1120
1121
 
# File 'lib/cisco_node_utils/interface.rb', line 1118

def stp_cost
  cost = config_get('interface', 'stp_cost', name: @name)
  cost == 'auto' ? cost : cost.to_i
end

#stp_cost=(val) ⇒ Object 



1123
1124
1125
1126
 
# File 'lib/cisco_node_utils/interface.rb', line 1123

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

#stp_guard ⇒ Object 



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

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

#stp_guard=(val) ⇒ Object 



1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/cisco_node_utils/interface.rb', line 1136

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

#stp_link_type ⇒ Object 



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

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

#stp_link_type=(val) ⇒ Object 



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

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

#stp_mst_cost ⇒ Object

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’]]



1184
1185
1186
 
# File 'lib/cisco_node_utils/interface.rb', line 1184

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

#stp_mst_cost=(list) ⇒ Object 



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

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_priority ⇒ Object

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’]]



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

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

#stp_mst_port_priority=(list) ⇒ Object 



1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/cisco_node_utils/interface.rb', line 1210

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_priority ⇒ Object 



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

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

#stp_port_priority=(val) ⇒ Object 



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

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

#stp_port_type ⇒ Object 



1222
1223
1224
 
# File 'lib/cisco_node_utils/interface.rb', line 1222

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

#stp_port_type=(val) ⇒ Object 



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

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_cost ⇒ Object

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’]]



1248
1249
1250
 
# File 'lib/cisco_node_utils/interface.rb', line 1248

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

#stp_vlan_cost=(list) ⇒ Object 



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

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_priority ⇒ Object

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’]]



1270
1271
1272
 
# File 'lib/cisco_node_utils/interface.rb', line 1270

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

#stp_vlan_port_priority=(list) ⇒ Object 



1274
1275
1276
1277
1278
1279
1280
 
# File 'lib/cisco_node_utils/interface.rb', line 1274

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_autostate ⇒ Object

svi_autostate is exclusive to svi interfaces



1883
1884
1885
1886
 
# File 'lib/cisco_node_utils/interface.rb', line 1883

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

#svi_autostate=(val) ⇒ Object 



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

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

Returns:

  • (Boolean) 


1877
1878
1879
1880
 
# File 'lib/cisco_node_utils/interface.rb', line 1877

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

#svi_management ⇒ Object

svi_management is exclusive to svi interfaces



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

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

#svi_management=(val) ⇒ Object 



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

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

#switchport ⇒ Object 



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

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

#switchport_autostate_exclude ⇒ Object

switchport_autostate_exclude is exclusive to switchport interfaces



1296
1297
1298
1299
 
# File 'lib/cisco_node_utils/interface.rb', line 1296

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

#switchport_autostate_exclude=(val) ⇒ Object 



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
 
# File 'lib/cisco_node_utils/interface.rb', line 1301

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 



1291
1292
1293
 
# File 'lib/cisco_node_utils/interface.rb', line 1291

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

#switchport_enable_and_mode(mode_set) ⇒ Object 



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

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_mode ⇒ Object 



1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/cisco_node_utils/interface.rb', line 1327

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 



1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/cisco_node_utils/interface.rb', line 1353

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_string ⇒ Object 



1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'lib/cisco_node_utils/interface.rb', line 1316

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_host ⇒ Object

<state> switchport mode private-vlan host



1444
1445
1446
 
# File 'lib/cisco_node_utils/interface.rb', line 1444

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

#switchport_pvlan_host=(state) ⇒ Object 



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

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

#switchport_pvlan_host_association ⇒ Object

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



1477
1478
1479
 
# File 'lib/cisco_node_utils/interface.rb', line 1477

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’]



1482
1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'lib/cisco_node_utils/interface.rb', line 1482

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_mapping ⇒ Object

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



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

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’]



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

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



1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
 
# File 'lib/cisco_node_utils/interface.rb', line 1516

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

Returns:

  • (Boolean) 


1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'lib/cisco_node_utils/interface.rb', line 1548

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_trunk ⇒ Object

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



1562
1563
1564
 
# File 'lib/cisco_node_utils/interface.rb', line 1562

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’]


1568
1569
1570
 
# File 'lib/cisco_node_utils/interface.rb', line 1568

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']



1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
 
# File 'lib/cisco_node_utils/interface.rb', line 1584

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_promiscuous ⇒ Object

<state> switchport mode private-vlan promiscuous



1460
1461
1462
 
# File 'lib/cisco_node_utils/interface.rb', line 1460

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

#switchport_pvlan_promiscuous=(state) ⇒ Object 



1464
1465
1466
1467
1468
 
# File 'lib/cisco_node_utils/interface.rb', line 1464

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

#switchport_pvlan_trunk_allowed_vlan ⇒ Object

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



1686
1687
1688
1689
1690
1691
1692
 
# File 'lib/cisco_node_utils/interface.rb', line 1686

def switchport_pvlan_trunk_allowed_vlan
  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 



1694
1695
1696
1697
1698
1699
1700
1701
1702
 
# File 'lib/cisco_node_utils/interface.rb', line 1694

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_association ⇒ Object

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



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

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’]


1619
1620
1621
1622
1623
1624
1625
1626
1627
 
# File 'lib/cisco_node_utils/interface.rb', line 1619

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_vlan ⇒ Object

<state> switchport trunk native vlan <vlan>



1710
1711
1712
 
# File 'lib/cisco_node_utils/interface.rb', line 1710

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

#switchport_pvlan_trunk_native_vlan=(vlan) ⇒ Object 



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

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_promiscuous ⇒ Object

<state> switchport mode private-vlan trunk promiscuous



1652
1653
1654
 
# File 'lib/cisco_node_utils/interface.rb', line 1652

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

#switchport_pvlan_trunk_promiscuous=(state) ⇒ Object 



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

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

#switchport_pvlan_trunk_secondary ⇒ Object

<state> switchport mode private-vlan trunk secondary



1668
1669
1670
 
# File 'lib/cisco_node_utils/interface.rb', line 1668

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

#switchport_pvlan_trunk_secondary=(state) ⇒ Object 



1672
1673
1674
1675
1676
 
# File 'lib/cisco_node_utils/interface.rb', line 1672

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

Returns:

  • (Boolean) 


1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
 
# File 'lib/cisco_node_utils/interface.rb', line 1936

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_vlan ⇒ Object 



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

def switchport_trunk_allowed_vlan
  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 



1394
1395
1396
1397
1398
1399
1400
1401
1402
 
# File 'lib/cisco_node_utils/interface.rb', line 1394

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_vlan ⇒ Object 



1408
1409
1410
 
# File 'lib/cisco_node_utils/interface.rb', line 1408

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

#switchport_trunk_native_vlan=(val) ⇒ Object 



1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/cisco_node_utils/interface.rb', line 1412

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_vtp ⇒ Object 



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

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

#switchport_vtp=(vtp_set) ⇒ Object 



1868
1869
1870
1871
1872
1873
1874
1875
 
# File 'lib/cisco_node_utils/interface.rb', line 1868

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

Returns:

  • (Boolean) 


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

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

#switchport_vtp_mode_capable? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#system_default_svi_autostate ⇒ Object 



1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
 
# File 'lib/cisco_node_utils/interface.rb', line 1844

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_switchport ⇒ Object 



1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/cisco_node_utils/interface.rb', line 1826

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_shutdown ⇒ Object 



1839
1840
1841
1842
 
# File 'lib/cisco_node_utils/interface.rb', line 1839

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

#to_s ⇒ Object 



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

def to_s
  "interface #{name}"
end

#vlan_mapping ⇒ Object 



1781
1782
1783
1784
1785
 
# File 'lib/cisco_node_utils/interface.rb', line 1781

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

#vlan_mapping=(should_list) ⇒ Object 



1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
 
# File 'lib/cisco_node_utils/interface.rb', line 1787

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_enable ⇒ Object 



1813
1814
1815
 
# File 'lib/cisco_node_utils/interface.rb', line 1813

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

#vlan_mapping_enable=(state) ⇒ Object 



1817
1818
1819
1820
 
# File 'lib/cisco_node_utils/interface.rb', line 1817

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

#vpc_id ⇒ Object 



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

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

#vpc_id=(num) ⇒ Object 



1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'lib/cisco_node_utils/interface.rb', line 1959

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

#vpc_peer_link ⇒ Object 



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

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

#vpc_peer_link=(state) ⇒ Object 



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

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

#vrf ⇒ Object 



1986
1987
1988
 
# File 'lib/cisco_node_utils/interface.rb', line 1986

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

#vrf=(v) ⇒ Object 



1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
 
# File 'lib/cisco_node_utils/interface.rb', line 1990

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