rbeapi 0.5.0 → 0.5.1

data/lib/rbeapi/api/switchports.rb

@@ -32,10 +32,10 @@
 require 'rbeapi/api'
 
 ##
-# Rbeapi toplevel namespace
+# Rbeapi toplevel namespace.
 module Rbeapi
   ##
-  # Api is module namespace 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
@@ -44,7 +44,7 @@ module Rbeapi
     class Switchports < Entity
       ##
       # Retrieves the properties for a logical switchport from the
-      # running-config using eAPI
+      # running-config using eAPI.
       #
       # Example
       #   {
@@ -52,13 +52,14 @@ module Rbeapi
       #     "mode": [access, trunk],
       #     "trunk_allowed_vlans": array<strings>
       #     "trunk_native_vlan": <Integer>,
-      #     "access_vlan": <Integer>
+      #     "access_vlan": <Integer>,
+      #     "trunk_groups": array<strings>
       #   }
       #
-      # @param [String] :name The full name of the interface to get.  The
-      #   interface name must be the full interface (ie Ethernet, not Et)
+      # @param name [String] 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
+      # @return [Hash] Returns a hash that includes the switchport properties.
       def get(name)
         config = get_block("interface #{name}")
         return nil unless config
@@ -74,14 +75,14 @@ module Rbeapi
       end
 
       ##
-      # parse_mode parses switchport mode from the provided config
+      # parse_mode parses switchport mode from the provided config.
       #
       # @api private
       #
-      # @param [String] :config The configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The configuration block returned
+      #   from the node's running configuration.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_mode(config)
         mdata = /(?<=\s{3}switchport\smode\s)(.+)$/.match(config)
         { mode: mdata[1] }
@@ -90,14 +91,14 @@ module Rbeapi
 
       ##
       # parse_access_vlan parses access vlan from the provided
-      #   config
+      #   config.
       #
       # @api private
       #
-      # @param [String] :config The configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The configuration block returned
+      #   from the node's running configuration.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_access_vlan(config)
         mdata = /(?<=access\svlan\s)(.+)$/.match(config)
         { access_vlan: mdata[1] }
@@ -106,14 +107,14 @@ module Rbeapi
 
       ##
       # parse_trunk_native_vlan parses trunk native vlan from
-      #   the provided config
+      #   the provided config.
       #
       # @api private
       #
-      # @param [String] :config The configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The configuration block returned
+      #   from the node's running configuration.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_trunk_native_vlan(config)
         mdata = /(?<=trunk\snative\svlan\s)(.+)$/.match(config)
         { trunk_native_vlan: mdata[1] }
@@ -122,14 +123,14 @@ module Rbeapi
 
       ##
       # parse_trunk_allowed_vlans parses trunk allowed vlan from
-      #   the provided config
+      #   the provided config.
       #
       # @api private
       #
-      # @param [String] :config The configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The configuration block returned
+      #   from the node's running configuration.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_trunk_allowed_vlans(config)
         mdata = /(?<=trunk\sallowed\svlan\s)(.+)$/.match(config)
         return { trunk_allowed_vlans: [] } unless mdata[1] != 'none'
@@ -148,14 +149,14 @@ module Rbeapi
 
       ##
       # parse_trunk_groups parses trunk group values from the
-      #   provided config
+      #   provided config.
       #
       # @api private
       #
-      # @param [String] :config The configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The configuration block returned
+      #   from the node's running configuration.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_trunk_groups(config)
         mdata = config.scan(/(?<=trunk\sgroup\s)(.+)$/)
         mdata = mdata.flatten if mdata.length > 0
@@ -164,7 +165,7 @@ module Rbeapi
       private :parse_trunk_groups
 
       ##
-      # Retrieves all switchport interfaces from the running-config
+      # Retrieves all switchport interfaces from the running-config.
       #
       # @example
       #   {
@@ -185,7 +186,7 @@ module Rbeapi
       #     ...
       #   }
       #
-      # @return [Array] an array of switchport hashes
+      # @return [Array] Returns an array of switchport hashes.
       def getall
         interfaces = config.scan(/(?<=^interface\s)([Et|Po].+)$/)
         interfaces.each_with_object({}) do |port, hsh|
@@ -195,31 +196,31 @@ module Rbeapi
       end
 
       ##
-      # Creates a new logical switchport interface in EOS
+      # Creates a new logical switchport interface in EOS.
       #
-      # @param [String] name The name of the logical interface
+      # @param name [String] The name of the logical interface.
       #
-      # @return [Boolean] True if it succeeds otherwise False
+      # @return [Boolean] Returns True if it succeeds otherwise False.
       def create(name)
         configure ["interface #{name}", 'no ip address', 'switchport']
       end
 
       ##
-      # Deletes a logical switchport interface from the running-config
+      # Deletes a logical switchport interface from the running-config.
       #
-      # @param [String] name The name of the logical interface
+      # @param name [String] The name of the logical interface.
       #
-      # @return [Boolean] True if it succeeds otherwise False
+      # @return [Boolean] Returns True if it succeeds otherwise False.
       def delete(name)
         configure ["interface #{name}", 'no switchport']
       end
 
       ##
-      # Defaults a logical switchport interface in the running-config
+      # Defaults a logical switchport interface in the running-config.
       #
-      # @param [String] name The name of the logical interface
+      # @param name [String] The name of the logical interface.
       #
-      # @return [Boolean] True if it succeeds otherwise False
+      # @return [Boolean] Returns True if it succeeds otherwise False.
       def default(name)
         configure ["interface #{name}", 'default switchport']
       end
@@ -227,14 +228,18 @@ module Rbeapi
       ##
       # Configures the switchport mode for the specified interface.
       #
-      # @param [String] name The name of the interface to configure
-      # @param [Hash] opts The configuration parameters for the interface
-      # @option opts [string] :value The value to set the mode to
-      # @option opts [Boolean] :enable If false then the command is
+      # @param name [String] The name of the interface to configure.
+      #
+      # @param opts [Hash] The configuration parameters for the interface.
+      #
+      # @option opts value [string] The value to set the mode to.
+      #
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
-      # @option opts [Boolean] :default The value should be set to default
       #
-      # @return [Boolean] True if the commands succeed otherwise False
+      # @option opts default [Boolean] The value should be set to default.
+      #
+      # @return [Boolean] Returns True if the commands succeed otherwise False.
       def set_mode(name, opts = {})
         cmd = command_builder('switchport mode', opts)
         configure_interface(name, cmd)
@@ -242,31 +247,35 @@ module Rbeapi
 
       ##
       # set_trunk_allowed_vlans configures the list of vlan ids that are
-      # allowed on the specified trunk port.  If the enable option is set to
+      # allowed on the specified trunk port. If the enable option is set to
       # false, then the allowed trunks is configured using the no keyword.
       # If the default keyword is provided then the allowed trunks is configured
-      # using the default keyword  The default option takes precedence over the
-      # enable option if both are specified
+      # using the default keyword. The default option takes precedence over the
+      # enable option if both are specified.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   switchport trunk allowed vlan add <value>
       #   no switchport trunk allowed vlan
       #   default switchport trunk allowed vlan
       #
-      # @param [String] name The name of the interface to configure
-      # @param [Hash] opts The configuration parameters for the interface
-      # @option pts [Array] :value The list of vlan ids to configure on the
-      #   switchport to be allowed.  This value must be an array of valid vlan
-      #   ids
-      # @option opts [Boolean] :enable If false then the command is
+      # @param name [String] The name of the interface to configure.
+      #
+      # @param opts [Hash] The configuration parameters for the interface.
+      #
+      # @option ots value [Array] The list of vlan ids to configure on the
+      #   switchport to be allowed. This value must be an array of valid vlan
+      #   ids.
+      #
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
-      # @option [Boolean] :default Configures the switchport trunk allowed
+      #
+      # @option default [Boolean] Configures the switchport trunk allowed
       #     vlans command using the default keyword. Default takes precedence
       #     over enable.
       #
-      # @return [Boolean] returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def set_trunk_allowed_vlans(name, opts = {})
         value = opts[:value]
         enable = opts.fetch(:enable, true)
@@ -296,15 +305,19 @@ module Rbeapi
       # This value is only valid if the switchport mode is configure as
       # trunk.
       #
-      # @param [String] name The name of the interface to configure
-      # @param [Hash] opts The configuration parameters for the interface
-      # @option opts [string] :value The value of the trunk native vlan
-      # @option :opts [Boolean] :enable If false then the command is
+      # @param name [String] The name of the interface to configure.
+      #
+      # @param opts [Hash] The configuration parameters for the interface.
+      #
+      # @option opts value [string] The value of the trunk native vlan.
+      #
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
-      # @option opts [Boolean] :default The value should be set to default.
+      #
+      # @option opts default [Boolean] The value should be set to default.
       #   Default takes precedence over enable.
       #
-      # @return [Boolean] True if the commands succeed otherwise False
+      # @return [Boolean] Returns True if the commands succeed otherwise False.
       def set_trunk_native_vlan(name, opts = {})
         cmd = command_builder('switchport trunk native vlan', opts)
         configure_interface(name, cmd)
@@ -315,15 +328,19 @@ module Rbeapi
       # This value is only valid if the switchport mode is configure
       # in access mode.
       #
-      # @param [String] name The name of the interface to configure
-      # @param [Hash] opts The configuration parameters for the interface
-      # @option opts [string] :value The value of the access vlan
-      # @option opts [Boolean] :enable If false then the command is
+      # @param name [String] The name of the interface to configure.
+      #
+      # @param opts [Hash] The configuration parameters for the interface.
+      #
+      # @option opts value [string] The value of the access vlan.
+      #
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
-      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @option opts default [Boolean] The value should be set to default
       #   Default takes precedence over enable.
       #
-      # @return [Boolean] True if the commands succeed otherwise False
+      # @return [Boolean] Returns True if the commands succeed otherwise False.
       def set_access_vlan(name, opts = {})
         cmd = command_builder('switchport access vlan', opts)
         configure_interface(name, cmd)
@@ -334,15 +351,19 @@ module Rbeapi
       # 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
+      # @param name [String] The name of the interface to configure.
+      #
+      # @param opts [Hash] The configuration parameters for the interface.
+      #
+      # @option opts value [string] Set of values to configure the trunk group.
+      #
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
-      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @option opts default [Boolean] The value should be set to default
       #   Default takes precedence over enable.
       #
-      # @return [Boolean] True if the commands succeed otherwise False
+      # @return [Boolean] Returns True if the commands succeed otherwise False.
       def set_trunk_groups(name, opts = {})
         default = opts.fetch(:default, false)
         if default
@@ -361,12 +382,12 @@ module Rbeapi
         current_value = Set.new get(name)[:trunk_groups]
 
         cmds = []
-        # Add trunk groups that are not currently in the list
+        # 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
+        # Remove trunk groups that are not in the new list.
         current_value.difference(value).each do |group|
           cmds << "no switchport trunk group #{group}"
         end

data/lib/rbeapi/api/system.rb

@@ -35,39 +35,47 @@ require 'rbeapi/api'
 # Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Api is module namespace for working with the EOS command 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
+    # hostname and domain name.
     class System < Entity
+      def initialize(node)
+        super(node)
+        @banners_re = Regexp.new(/^banner\s+(login|motd)\s?$\n(.*?)$\nEOF$\n/m)
+      end
+
       ##
-      # Returns the system settings for hostname and iprouting
+      # Returns the system settings for hostname, iprouting, and banners.
       #
       # @example
       #   {
       #     hostname: <string>,
-      #     iprouting: <boolean>
+      #     iprouting: <boolean>,
+      #     banner_motd: <string>,
+      #     banner_login: <string>
       #   }
       #
-      # @return [Hash]  A Ruby hash object that provides the system settings as
+      # @return [Hash] A Ruby hash object that provides the system settings as
       #   key/value pairs.
       def get
         response = {}
         response.merge!(parse_hostname(config))
         response.merge!(parse_iprouting(config))
+        response.merge!(parse_banners(config))
         response
       end
 
       ##
-      # parse_hostname parses hostname values from the provided config
+      # parse_hostname parses hostname values from the provided config.
       #
       # @api private
       #
-      # @param [String] :config The configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The configuration block returned
+      #   from the node's running configuration.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] The resource hash attribute.
       def parse_hostname(config)
         mdata = /(?<=^hostname\s)(.+)$/.match(config)
         { hostname: mdata.nil? ? '' : mdata[1] }
@@ -75,14 +83,14 @@ module Rbeapi
       private :parse_hostname
 
       ##
-      # parse_iprouting parses ip routing from the provided config
+      # parse_iprouting parses ip routing from the provided config.
       #
       # @api private
       #
-      # @param [String] :config The configuration block returned
-      #   from the node's running configuration
+      # @param config [String] The configuration block returned
+      #   from the node's running configuration.
       #
-      # @return [Hash<Symbol, Object>] resource hash attribute
+      # @return [Hash<Symbol, Object>] The resource hash attribute.
       def parse_iprouting(config)
         mdata = /no\sip\srouting/.match(config)
         { iprouting: mdata.nil? ? true : false }
@@ -90,34 +98,94 @@ module Rbeapi
       private :parse_iprouting
 
       ##
-      # Configures the system hostname value in the running-config
+      # Parses the global config and returns the value for both motd
+      # and login banners.
+      #
+      # @api private
       #
-      # @param [Hash] opts The configuration parameters
-      # @option opts [string] :value The value to set the hostname to
-      # @option :opts [Boolean] :enable If false then the command is
+      # @param config [String] The configuration block returned
+      #   from the node's running configuration.
+      #
+      # @return [Hash<Symbol, Object>] The resource hash attribute. If the
+      #   banner is not set it will return a value of None for that key.
+      def parse_banners(config)
+        motd_value = login_value = ''
+        entries = config.scan(@banners_re)
+        entries.each do |type, value|
+          if type == 'motd'
+            motd_value = value
+          elsif type == 'login'
+            login_value = value
+          end
+        end
+        { banner_motd: motd_value, banner_login: login_value }
+      end
+      private :parse_banners
+
+      ##
+      # Configures the system hostname value in the running-config.
+      #
+      # @param opts [Hash] The configuration parameters.
+      #
+      # @option opts value [string] The value to set the hostname to.
+      #
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
-      # @option opts [Boolean] :default The value should be set to default
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @option opts default [Boolean] If true configure the command using
+      #   the default keyword. Default is false.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_hostname(opts = {})
         cmd = command_builder('hostname', opts)
         configure(cmd)
       end
 
       ##
-      # Configures the state of global ip routing
+      # Configures the state of global ip routing.
+      #
+      # @param opts [Hash] The configuration parameters.
       #
-      # @param [Hash] opts The configuration parameters
-      # @option :opts [Boolean] :enable True if ip routing should be enabled
+      # @option opts enable [Boolean] True if ip routing should be enabled
       #  or False if ip routing should be disabled. Default is true.
-      # @option opts [Boolean] :default Controls the use of the default
-      #  keyword. Default is false.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @option opts default [Boolean] If true configure the command using
+      #   the default keyword. Default is false.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_iprouting(opts = {})
         cmd = command_builder('ip routing', opts)
         configure(cmd)
       end
+
+      ##
+      # Configures system banners.
+      #
+      # @param banner_type [String] Banner to be changed (likely either
+      #   login or motd).
+      #
+      # @param opts [Hash] The configuration parameters.
+      #
+      # @option opts value [string] The value to set for the banner.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] If true configure the command using
+      #   the default keyword. Default is false.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_banner(banner_type, opts = {})
+        value = opts[:value]
+        cmd_string = "banner #{banner_type}"
+        if value
+          value += "\n" if value[-1, 1] != "\n"
+          cmd = [{ cmd: cmd_string, input: value }]
+        else
+          cmd = command_builder(cmd_string, opts)
+        end
+        configure(cmd)
+      end
     end
   end
 end