rbeapi 0.4.0 → 0.5.0

data/lib/rbeapi/api/switchports.rb

@@ -35,7 +35,7 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Api is module namesapce for working with the EOS command API
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Switchport class provides a base class instance for working with
@@ -55,7 +55,7 @@ module Rbeapi
       #     "access_vlan": <Integer>
       #   }
       #
-      # @param [String] name The full name of the interface to get.  The
+      # @param [String] :name The full name of the interface to get.  The
       #   interface name must be the full interface (ie Ethernet, not Et)
       #
       # @return [Hash] a hash that includes the switchport properties
@@ -69,24 +69,67 @@ module Rbeapi
         response.merge!(parse_access_vlan(config))
         response.merge!(parse_trunk_native_vlan(config))
         response.merge!(parse_trunk_allowed_vlans(config))
+        response.merge!(parse_trunk_groups(config))
         response
       end
 
+      ##
+      # parse_mode parses switchport mode from the provided config
+      #
+      # @api private
+      #
+      # @param [String] :config The configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_mode(config)
         mdata = /(?<=\s{3}switchport\smode\s)(.+)$/.match(config)
         { mode: mdata[1] }
       end
+      private :parse_mode
 
+      ##
+      # parse_access_vlan parses access vlan from the provided
+      #   config
+      #
+      # @api private
+      #
+      # @param [String] :config The configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_access_vlan(config)
         mdata = /(?<=access\svlan\s)(.+)$/.match(config)
         { access_vlan: mdata[1] }
       end
+      private :parse_access_vlan
 
+      ##
+      # parse_trunk_native_vlan parses trunk native vlan from
+      #   the provided config
+      #
+      # @api private
+      #
+      # @param [String] :config The configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_trunk_native_vlan(config)
         mdata = /(?<=trunk\snative\svlan\s)(.+)$/.match(config)
         { trunk_native_vlan: mdata[1] }
       end
+      private :parse_trunk_native_vlan
 
+      ##
+      # parse_trunk_allowed_vlans parses trunk allowed vlan from
+      #   the provided config
+      #
+      # @api private
+      #
+      # @param [String] :config The configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_trunk_allowed_vlans(config)
         mdata = /(?<=trunk\sallowed\svlan\s)(.+)$/.match(config)
         return { trunk_allowed_vlans: [] } unless mdata[1] != 'none'
@@ -101,10 +144,47 @@ module Rbeapi
         end
         { trunk_allowed_vlans: values }
       end
+      private :parse_trunk_allowed_vlans
+
+      ##
+      # parse_trunk_groups parses trunk group values from the
+      #   provided config
+      #
+      # @api private
+      #
+      # @param [String] :config The configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
+      def parse_trunk_groups(config)
+        mdata = config.scan(/(?<=trunk\sgroup\s)(.+)$/)
+        mdata = mdata.flatten if mdata.length > 0
+        { trunk_groups: mdata }
+      end
+      private :parse_trunk_groups
 
       ##
       # Retrieves all switchport interfaces from the running-config
       #
+      # @example
+      #   {
+      #     <name>: {
+      #       mode: <string>,
+      #       access_vlan: <string>,
+      #       trunk_native_vlan: <string>,
+      #       trunk_allowed_vlans: <array>,
+      #       trunk_groups: <array>
+      #     },
+      #     <name>: {
+      #       mode: <string>,
+      #       access_vlan: <string>,
+      #       trunk_native_vlan: <string>,
+      #       trunk_allowed_vlans: <array>,
+      #       trunk_groups: <array>
+      #     },
+      #     ...
+      #   }
+      #
       # @return [Array] an array of switchport hashes
       def getall
         interfaces = config.scan(/(?<=^interface\s)([Et|Po].+)$/)
@@ -248,6 +328,50 @@ module Rbeapi
         cmd = command_builder('switchport access vlan', opts)
         configure_interface(name, cmd)
       end
+
+      ##
+      # Configures the trunk group vlans for the specified interface.
+      # Trunk groups not currently set are added and trunk groups
+      # currently configured but not in the passed in value array are removed.
+      #
+      # @param [String] name The name of the interface to configure
+      # @param [Hash] opts The configuration parameters for the interface
+      # @option opts [string] :value Set of values to configure the trunk group
+      # @option opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      # @option opts [Boolean] :default The value should be set to default
+      #   Default takes precedence over enable.
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_trunk_groups(name, opts = {})
+        default = opts.fetch(:default, false)
+        if default
+          return configure_interface(name, 'default switchport trunk group')
+        end
+
+        enable = opts.fetch(:enable, true)
+        unless enable
+          return configure_interface(name, 'no switchport trunk group')
+        end
+
+        value = opts.fetch(:value, [])
+        fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
+
+        value = Set.new value
+        current_value = Set.new get(name)[:trunk_groups]
+
+        cmds = []
+        # Add trunk groups that are not currently in the list
+        value.difference(current_value).each do |group|
+          cmds << "switchport trunk group #{group}"
+        end
+
+        # Remove trunk groups that are not in the new list
+        current_value.difference(value).each do |group|
+          cmds << "no switchport trunk group #{group}"
+        end
+        configure_interface(name, cmds) if cmds.length > 0
+      end
     end
   end
 end

data/lib/rbeapi/api/system.rb

@@ -35,18 +35,19 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Rbeapi::Api
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The System class configures the node system services such as
     # hostname and domain name
     class System < Entity
       ##
-      # Returns the system settings
+      # Returns the system settings for hostname and iprouting
       #
       # @example
       #   {
-      #     hostname: <string>
+      #     hostname: <string>,
+      #     iprouting: <boolean>
       #   }
       #
       # @return [Hash]  A Ruby hash object that provides the system settings as
@@ -58,15 +59,35 @@ module Rbeapi
         response
       end
 
+      ##
+      # parse_hostname parses hostname values from the provided config
+      #
+      # @api private
+      #
+      # @param [String] :config The configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_hostname(config)
         mdata = /(?<=^hostname\s)(.+)$/.match(config)
         { hostname: mdata.nil? ? '' : mdata[1] }
       end
+      private :parse_hostname
 
+      ##
+      # parse_iprouting parses ip routing from the provided config
+      #
+      # @api private
+      #
+      # @param [String] :config The configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_iprouting(config)
         mdata = /no\sip\srouting/.match(config)
         { iprouting: mdata.nil? ? true : false }
       end
+      private :parse_iprouting
 
       ##
       # Configures the system hostname value in the running-config

data/lib/rbeapi/api/tacacs.rb

@@ -35,7 +35,7 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Api is module namesapce for working with the EOS command API
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # Tacacs provides instance methods to retrieve and set tacacs configuration
@@ -63,15 +63,14 @@ module Rbeapi
       # This method is intended to be used by a provider's instances class
       # method.
       #
-      # The resource hash returned contains the following information:
-      #  * name: ('settings')
-      #  * enable: (true | false) if tacacs functionality is enabled.  This is
-      #    always true for EOS.
-      #  * key: (String) the key either in plain text or hashed format
-      #  * key_format: (Integer) e.g. 0 or 7
-      #  * timeout: (Integer) seconds before the timeout period ends
-      #
-      # @api public
+      # @example
+      #   {
+      #     name: <string>,
+      #     enable: <boolean>,
+      #     key: <string>,
+      #     key_format: <integer>,
+      #     timeout: <integer>
+      #   }
       #
       # @return [Array<Hash>] Single element Array of resource hashes
       def get

data/lib/rbeapi/api/users.rb

@@ -35,7 +35,7 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Api is module namesapce for working with the EOS command API
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Users class provides configuration of local user resources for
@@ -76,7 +76,7 @@ module Rbeapi
       #     sshkey: <string>
       #   }
       #
-      # @param [String] name The user name to return a resource for from the
+      # @param [String] :name The user name to return a resource for from the
       #   nodes configuration
       #
       # @return [nil, Hash<Symbol, Object>] Returns the user resource as a
@@ -94,7 +94,7 @@ module Rbeapi
                               (username\s+#{name}\s+
                                sshkey\s+(?<sshkey>.*)$)?/x)
         user = config.scan(user_re)
-        return nil unless user
+        return nil unless user && user[0]
         parse_user_entry(user[0])
       end
 
@@ -114,6 +114,15 @@ module Rbeapi
       #       secret: <string>,
       #       sshkey: <string>
       #     },
+      #     <username>: {
+      #       name: <string>,
+      #       privilege: <integer>,
+      #       role: <string>,
+      #       nopassword: <boolean>,
+      #       encryption: <'cleartext', 'md5', 'sha512'>
+      #       secret: <string>,
+      #       sshkey: <string>
+      #     },
       #     ...
       #   ]
       #

data/lib/rbeapi/api/varp.rb

@@ -35,7 +35,7 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Rbeapi::Api
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Varp class provides an instance for working with the global
@@ -44,10 +44,18 @@ module Rbeapi
       ##
       # Returns the global VARP configuration from the node
       #
-      # Example
+      # @example
       #   {
-      #     "mac_address": <string>,
-      #     "interfaces": {...}
+      #     mac_address: <string>,
+      #     interfaces: {
+      #       <name>: {
+      #         addresses: <array>
+      #       },
+      #       <name>: {
+      #         addresses: <array>
+      #       },
+      #       ...
+      #     }
       #   }
       #
       # @return [Hash]  A Ruby hash object that provides the Varp settings as
@@ -59,6 +67,15 @@ module Rbeapi
         response
       end
 
+      ##
+      # parse_mac_address parses mac-address values from the provided config
+      #
+      # @api private
+      #
+      # @param [String] :config The configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_mac_address(config)
         # ip virtual-router mac-address value will always
         #   be stored in aa:bb:cc:dd:ee:ff format
@@ -97,7 +114,7 @@ module Rbeapi
       ##
       # Returns a single VARP interface configuration
       #
-      # Example
+      # @example
       #   {
       #     "addresses": array<string>
       #   }
@@ -119,10 +136,15 @@ module Rbeapi
       # Returns the collection of MLAG interfaces as a hash index by the
       # interface name
       #
-      # Example
+      # @example
       #   {
-      #     "name": {...},
-      #     "name": {...}
+      #     <name>: {
+      #       addresses: <array>
+      #     },
+      #     <name>: {
+      #       addresses: <array>
+      #     },
+      #     ...
       #   }
       #
       # @return [nil, Hash<String, String>] A Ruby hash that represents the
@@ -138,6 +160,16 @@ module Rbeapi
         end
       end
 
+      ##
+      # parse_addresses parses ip virtual-router address from the provided
+      #   config
+      #
+      # @api private
+      #
+      # @param [String] :config The configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_addresses(config)
         addrs = config.scan(/(?<=\s{3}ip\svirtual-router\saddress\s).+$/)
         { addresses: addrs }

data/lib/rbeapi/api/vlans.rb

@@ -35,7 +35,7 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Api is module namesapce for working with the EOS command API
+  # Api is module namespace for working with the EOS command API
   module Api
     ##
     # The Vlan class provides a class implementation for working with the
@@ -50,12 +50,12 @@ module Rbeapi
       #
       # @example
       #   {
-      #     name: <string>
-      #     state: <string>
+      #     name: <string>,
+      #     state: <string>,
       #     trunk_groups: array[<string]
       #   }
       #
-      # @param [String] id The vlan id to return a resource for from the
+      # @param [String] :id The vlan id to return a resource for from the
       #   nodes configuration
       #
       # @return [nil, Hash<Symbol, Object>] Returns the vlan resource as a
@@ -78,7 +78,17 @@ module Rbeapi
       #
       # @example
       #   {
-      #     <vlanid>: {...}
+      #     <vlanid>: {
+      #       name: <string>,
+      #       state: <string>,
+      #       trunk_groups: array[<string]
+      #     },
+      #     <vlanid>: {
+      #       name: <string>,
+      #       state: <string>,
+      #       trunk_groups: array[<string]
+      #     },
+      #     ...
       #   }
       #
       # @see get Vlan resource example