Class: Cisco::InterfacePortChannel

Inherits:
NodeUtil
  • Object
show all
Defined in:
lib/cisco_node_utils/interface_portchannel.rb

Overview

InterfacePortChannel - node utility class for port channel config management

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from NodeUtil

config_get, #config_get, config_get_default, #config_get_default, #config_set, config_set, #node, node, #show

Constructor Details

#initialize(name, instantiate = true) ⇒ InterfacePortChannel

Returns a new instance of InterfacePortChannel.



26
27
28
29
30
31
32
33
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 26

def initialize(name, instantiate=true)
  fail TypeError unless name.is_a?(String)
  fail ArgumentError unless name.length > 0
  @name = name.downcase
  fail ArgumentError unless @name.start_with?('port-channel')

  create if instantiate
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



24
25
26
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 24

def name
  @name
end

Class Method Details

.interfaces ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 35

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

  intf_list.each do |id|
    id = id.downcase
    next unless id.start_with?('port-channel')
    hash[id] = InterfacePortChannel.new(id, false)
  end
  hash
end

Instance Method Details

#create ⇒ Object 



48
49
50
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 48

def create
  config_set('interface_portchannel', 'create', @name)
end

#default_lacp_graceful_convergence ⇒ Object 



72
73
74
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 72

def default_lacp_graceful_convergence
  config_get_default('interface_portchannel', 'lacp_graceful_convergence')
end

#default_lacp_max_bundle ⇒ Object 



86
87
88
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 86

def default_lacp_max_bundle
  config_get_default('interface_portchannel', 'lacp_max_bundle')
end

#default_lacp_min_links ⇒ Object 



100
101
102
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 100

def default_lacp_min_links
  config_get_default('interface_portchannel', 'lacp_min_links')
end

#default_lacp_suspend_individual ⇒ Object 



116
117
118
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 116

def default_lacp_suspend_individual
  config_get_default('interface_portchannel', 'lacp_suspend_individual')
end

#default_port_hash_distribution ⇒ Object 



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

def default_port_hash_distribution
  config_get_default('interface_portchannel', 'port_hash_distribution')
end

#default_port_load_defer ⇒ Object 



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

def default_port_load_defer
  config_get_default('interface_portchannel', 'port_load_defer')
end

#destroy ⇒ Object 



52
53
54
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 52

def destroy
  config_set('interface_portchannel', 'destroy', @name)
end

#lacp_graceful_convergence ⇒ Object

PROPERTIES #



60
61
62
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 60

def lacp_graceful_convergence
  config_get('interface_portchannel', 'lacp_graceful_convergence', @name)
end

#lacp_graceful_convergence=(state) ⇒ Object 



64
65
66
67
68
69
70
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 64

def lacp_graceful_convergence=(state)
  no_cmd = (state ? '' : 'no')
  config_set('interface_portchannel',
             'lacp_graceful_convergence', @name, no_cmd)
rescue Cisco::CliError => e
  raise "[#{@name}] '#{e.command}' : #{e.clierror}"
end

#lacp_max_bundle ⇒ Object 



76
77
78
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 76

def lacp_max_bundle
  config_get('interface_portchannel', 'lacp_max_bundle', @name)
end

#lacp_max_bundle=(val) ⇒ Object 



80
81
82
83
84
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 80

def lacp_max_bundle=(val)
  config_set('interface_portchannel', 'lacp_max_bundle', @name, val)
rescue Cisco::CliError => e
  raise "[#{@name}] '#{e.command}' : #{e.clierror}"
end

#lacp_min_links ⇒ Object 



90
91
92
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 90

def lacp_min_links
  config_get('interface_portchannel', 'lacp_min_links', @name)
end

#lacp_min_links=(val) ⇒ Object 



94
95
96
97
98
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 94

def lacp_min_links=(val)
  config_set('interface_portchannel', 'lacp_min_links', @name, val)
rescue Cisco::CliError => e
  raise "[#{@name}] '#{e.command}' : #{e.clierror}"
end

#lacp_suspend_individual ⇒ Object 



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

def lacp_suspend_individual
  config_get('interface_portchannel', 'lacp_suspend_individual', @name)
end

#lacp_suspend_individual=(state) ⇒ Object 



108
109
110
111
112
113
114
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 108

def lacp_suspend_individual=(state)
  no_cmd = (state ? '' : 'no')
  config_set('interface_portchannel',
             'lacp_suspend_individual', @name, no_cmd)
rescue Cisco::CliError => e
  raise "[#{@name}] '#{e.command}' : #{e.clierror}"
end

#port_hash_distribution ⇒ Object 



120
121
122
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 120

def port_hash_distribution
  config_get('interface_portchannel', 'port_hash_distribution', @name)
end

#port_hash_distribution=(val) ⇒ Object 



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

def port_hash_distribution=(val)
  if val
    state = ''
  else
    state = 'no'
    val = ''
  end
  config_set('interface_portchannel',
             'port_hash_distribution', @name, state, val)
rescue Cisco::CliError => e
  raise "[#{@name}] '#{e.command}' : #{e.clierror}"
end

#port_load_defer ⇒ Object 



141
142
143
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 141

def port_load_defer
  config_get('interface_portchannel', 'port_load_defer', @name)
end

#port_load_defer=(state) ⇒ Object 



145
146
147
148
149
150
151
 
# File 'lib/cisco_node_utils/interface_portchannel.rb', line 145

def port_load_defer=(state)
  no_cmd = (state ? '' : 'no')
  config_set('interface_portchannel',
             'port_load_defer', @name, no_cmd)
rescue Cisco::CliError => e
  raise "[#{@name}] '#{e.command}' : #{e.clierror}"
end