Class: Rbeapi::Api::BaseInterface

Inherits:
Entity
  • Object
show all
Defined in:
lib/rbeapi/api/interfaces.rb

Overview

The BaseInterface class extends Entity and provides an implementation that is common to all interfaces configured in EOS.

Constant Summary collapse

DEFAULT_INTF_DESCRIPTION = 
''

Instance Attribute Summary

Attributes inherited from Entity

#config, #error, #node

Instance Method Summary collapse

Methods inherited from Entity

#command_builder, #configure, #configure_interface, #get_block, #initialize, instance

Constructor Details

This class inherits a constructor from Rbeapi::Api::Entity

Instance Method Details

#create(value) ⇒ Boolean

create will create a new interface resource in the node’s current configuration with the specified interface name. If the create method is called and the interface already exists, this method will return successful

Parameters:

  • :value (String) —

    The interface name to create on the node. The interface name must be the full interface identifier (ie Loopback, not Lo)

Returns:

  • (Boolean) —

    returns true if the command completed successfully



175
176
177
 
# File 'lib/rbeapi/api/interfaces.rb', line 175

def create(value)
  configure("interface #{value}")
end

#default(value) ⇒ Boolean

default will configure the interface using the default keyword. For virtual interfaces this is equivalent to deleting the interface. For physical interfaces, the entire interface configuration will be set to defaults.

Parameters:

  • :value (String) —

    The interface name to default in the node. The interface name must be the full interface identifier (ie Loopback, not Lo)

Returns:

  • (Boolean) —

    returns true if the command completed successfully



209
210
211
 
# File 'lib/rbeapi/api/interfaces.rb', line 209

def default(value)
  configure("default interface #{value}")
end

#delete(value) ⇒ Boolean

delete will delete an existing interface resource in the node’s current configuration with the specified interface name. If the delete method is called and interface does not exist, this method will return successful

Parameters:

  • :value (String) —

    The interface name to delete from the node. The interface name must be the full interface identifier (ie Loopback, no Lo)

Returns:

  • (Boolean) —

    returns true if the command completed successfully



192
193
194
 
# File 'lib/rbeapi/api/interfaces.rb', line 192

def delete(value)
  configure("no interface #{value}")
end

#get(name) ⇒ nil, Hash<String, Object>

get returns the specified interface resource hash that represents the node’s current interface configuration. The BaseInterface class provides all the set of attributes that are common to all interfaces in EOS. This method will return an interface type of generic

Examples:

{
  name: <string>
  type: 'generic'
  description: <string>
  shutdown: [true, false]
}

Parameters:

  • :name (String) —

    The name of the interface to return from the running-configuration

Returns:

  • (nil, Hash<String, Object>) —

    Returns a hash of the interface properties if the interface name was found in the running configuration. If the interface was not found, nil is returned



120
121
122
123
124
125
126
127
128
 
# File 'lib/rbeapi/api/interfaces.rb', line 120

def get(name)
  config = get_block("^interface #{name}")
  return nil unless config

  response = { name: name, type: 'generic' }
  response.merge!(parse_description(config))
  response.merge!(parse_shutdown(config))
  response
end

#set_description(name, opts = {}) ⇒ Boolean

set_description configures the description value for the specified interface name in the nodes running configuration. If the enable keyword is false then the description value is negated using the no keyword. If the default keyword is set to true, then the description value is defaulted using the default keyword. The default keyword takes precedence over the enable keyword if both are provided.

Parameters:

  • :name (String) —

    The interface name to apply the configuration to. The name value must be the full interface identifier

  • :opts (hash) —

    Optional keyword arguments

Returns:

  • (Boolean) —

    returns true if the command completed successfully



238
239
240
241
 
# File 'lib/rbeapi/api/interfaces.rb', line 238

def set_description(name, opts = {})
  commands = command_builder('description', opts)
  configure_interface(name, commands)
end

#set_shutdown(name, opts = {}) ⇒ Boolean

set_shutdown configures the administrative state of the specified interface in the node. If the enable keyword is false, then the interface is administratively disabled. If the enable keyword is true, then the interface is administratively enabled. If the default keyword is set to true, then the interface shutdown value is configured using the default keyword. The default keyword takes precedence over the enable keyword if both are provided.

Parameters:

  • :name (String) —

    The interface name to apply the configuration to. The name value must be the full interface identifier

  • :opts (hash) —

    Optional keyword arguments

Returns:

  • (Boolean) —

    returns true if the command completed successfully



267
268
269
270
271
272
273
274
 
# File 'lib/rbeapi/api/interfaces.rb', line 267

def set_shutdown(name, opts = {})
  fail 'set_shutdown has the value option set' if opts[:value]
  # Shutdown semantics are opposite of enable semantics so invert enable
  value = !opts[:enable]
  opts.merge!(enable: value)
  commands = command_builder('shutdown', opts)
  configure_interface(name, commands)
end