puppet_x_eos_eapi 0.2.0

data/lib/puppet_x/eos/modules/snmp.rb

@@ -0,0 +1,177 @@
+#
+# Copyright (c) 2014, Arista Networks, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+#   Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+#   Neither the name of Arista Networks nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+##
+# PuppetX is the toplevel namespace for working with Arista EOS nodes
+module PuppetX
+  ##
+  # Eos is module namesapce for working with the EOS command API
+  module Eos
+    ##
+    # The Snmp class provides a base class instance for working with
+    # the global SNMP configuration
+    #
+    class Snmp
+      ##
+      # Initialize instance of Snmp
+      #
+      # @param [PuppetX::Eos::Eapi] api An instance of Eapi
+      #
+      # @return [PuppetX::Eos::Snmp]
+      def initialize(api)
+        @api = api
+      end
+
+      ##
+      # Returns the SNMP hash representing global snmp configuration
+      #
+      # Example
+      #   {
+      #     "contact": <String>,
+      #     "location": <String>,
+      #     "chassis_id": <String>,
+      #     "source_interface": <String>
+      #   }
+      #
+      # @return [Array<Hash>] returns an Array of Hashes
+      def get
+        result =  @api.enable(['show snmp contact',
+                               'show snmp location',
+                               'show snmp chassis',
+                               'show snmp source-interface'],
+                              format: 'text')
+
+        attr_hash = {}
+
+        (0..3).each do |i|
+          m = /(?<=:\s)(.*)$/.match(result[i]['output'])
+          case i
+          when 0
+            attr_hash[:contact] = !m.nil? ? m[0] : ''
+          when 1
+            attr_hash[:location] = !m.nil? ? m[0] : ''
+          when 2
+            attr_hash[:chassis_id] = !m.nil? ? m[0] : ''
+          when 3
+            attr_hash[:source_interface] = !m.nil? ? m[0] : ''
+          end
+        end
+        attr_hash
+      end
+
+      ##
+      # Configures the snmp contact
+      #
+      # @param [Hash] opts The configuration parameters for snmp
+      # @option opts [string] :value The value to set the contact to
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_contact(opts = {})
+        value = opts[:value] || false
+        default = opts[:default] || false
+
+        case default
+        when true
+          cmds = 'default snmp contact'
+        when false
+          cmds = (value ? "snmp contact #{value}" : 'no snmp contact')
+        end
+        @api.config(cmds) == [{}]
+      end
+
+      ##
+      # Configures the snmp location
+      #
+      # @param [Hash] opts The configuration parameters for snmp
+      # @option opts [string] :value The value to set the location to
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_location(opts = {})
+        value = opts[:value] || false
+        default = opts[:default] || false
+
+        case default
+        when true
+          cmds = 'default snmp location'
+        when false
+          cmds = (value ? "snmp location #{value}" : 'no snmp location')
+        end
+        @api.config(cmds) == [{}]
+      end
+
+      ##
+      # Configures the snmp chassis-id
+      #
+      # @param [Hash] opts The configuration parameters for snmp
+      # @option opts [string] :value The value to set the chassis-id to
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_chassis_id(opts = {})
+        value = opts[:value] || false
+        default = opts[:default] || false
+
+        case default
+        when true
+          cmds = 'default snmp chassis'
+        when false
+          cmds = (value ? "snmp chassis #{value}" : 'no snmp chassis')
+        end
+        @api.config(cmds) == [{}]
+      end
+
+      ##
+      # Configures the snmp source-interface
+      #
+      # @param [Hash] opts The configuration parameters for snmp
+      # @option opts [string] :value The value to set the source-interface to
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_source_interface(opts = {})
+        value = opts[:value] || false
+        default = opts[:default] || false
+
+        case default
+        when true
+          cmds = 'default snmp source-interface'
+        when false
+          cmds = (value ? "snmp source-interface #{value}" : \
+                          'no snmp source-interface')
+        end
+        @api.config(cmds) == [{}]
+      end
+    end
+  end
+end

data/lib/puppet_x/eos/modules/switchport.rb

@@ -0,0 +1,255 @@
+#
+# Copyright (c) 2014, Arista Networks, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+#   Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+#   Neither the name of Arista Networks nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+##
+# PuppetX is the toplevel namespace for working with Arista EOS nodes
+module PuppetX
+  ##
+  # Eos is module namesapce for working with the EOS command API
+  module Eos
+    ##
+    # The Switchport class provides a base class instance for working with
+    # logical layer-2 interfaces.
+    #
+    class Switchport
+      ##
+      # Initialize instance of Switchport
+      #
+      # @param [PuppetX::Eos::Eapi] api An instance of Eapi
+      #
+      # @return [PuppetX::Eos::Switchport]
+      def initialize(api)
+        @api = api
+      end
+
+      ##
+      # Retrieves the properies for a logical switchport from the
+      # running-config using eAPI
+      #
+      # Example
+      #   {
+      #     "name": <String>,
+      #     "mode": [access, trunk],
+      #     "trunk_allowed_vlans": [],
+      #     "trunk_native_vlan": <Integer>,
+      #     "access_vlan": <Integer>
+      #   }
+      #
+      # @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
+      def get(name)
+        result = @api.enable("show interfaces #{name} switchport",
+                             format: 'text')
+        output = result.first['output']
+        attr_hash = { name: name }
+        attr_hash[:mode] = mode_to_value output
+        attr_hash[:trunk_allowed_vlans] = trunk_vlans_to_value output
+        attr_hash[:trunk_native_vlan] = trunk_native_to_value output
+        attr_hash[:access_vlan] = access_vlan_to_value output
+        attr_hash
+      end
+
+      ##
+      # Retrieves all switchport interfaces from the running-config
+      #
+      # @return [Array] an array of switchport hashes
+      def getall
+        result = @api.enable('show interfaces')
+        switchports = []
+        result.first['interfaces'].map do |name, attrs|
+          switchports << get(name) if attrs['forwardingModel'] == 'bridged'
+        end
+        switchports
+      end
+
+      ##
+      # Creates a new logical switchport interface in EOS
+      #
+      # @param [String] name The name of the logical interface
+      #
+      # @return [Boolean] True if it succeeds otherwise False
+      def create(name)
+        @api.config(["interface #{name}", 'no ip address',
+                     'switchport']) == [{}, {}, {}]
+      end
+
+      ##
+      # Deletes a logical switchport interface from the running-config
+      #
+      # @param [String] name The name of the logical interface
+      #
+      # @return [Boolean] True if it succeeds otherwise False
+      def delete(name)
+        @api.config(["interface #{name}", 'no switchport']) == [{}, {}]
+      end
+
+      ##
+      # Defaults a logical switchport interface in the running-config
+      #
+      # @param [String] name The name of the logical interface
+      #
+      # @return [Boolean] True if it succeeds otherwise False
+      def default(name)
+        @api.config(["interface #{name}",
+                     'default switchport']) == [{}, {}]
+      end
+
+      ##
+      # Configures the switchport mode for the specified interafce.  Valid
+      # modes are access (default) or 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 to set the mode to
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_mode(name, opts = {})
+        value = opts[:value]
+        default = opts[:default] || false
+
+        cmds = ["interface #{name}"]
+        case default
+        when true
+          cmds << 'default switchport mode'
+        when false
+          cmds << (value.nil? ? 'no switchport mode' : \
+                                "switchport mode #{value}")
+        end
+        @api.config(cmds) == [{}, {}]
+      end
+
+      ##
+      # Configures the trunk port allowed vlans for the specified interface.
+      # 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 list of vlans to allow
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_trunk_allowed_vlans(name, opts = {})
+        value = opts[:value]
+        default = opts[:default] || false
+
+        cmds = ["interface #{name}"]
+        case default
+        when true
+          cmds << 'default switchport trunk allowed vlan'
+        when false
+          cmds << (value.nil? ? 'no switchport trunk allowed vlan' : \
+                                "switchport trunk allowed vlan #{value}")
+        end
+        @api.config(cmds) == [{}, {}]
+      end
+
+      ##
+      # Configures the trunk port native vlan for the specified interface.
+      # 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] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_trunk_native_vlan(name, opts = {})
+        value = opts[:value]
+        default = opts[:default] || false
+
+        cmds = ["interface #{name}"]
+        case default
+        when true
+          cmds << 'default switchport trunk native vlan'
+        when false
+          cmds << (value.nil? ? 'no switchport trunk native vlan' : \
+                                "switchport trunk native vlan #{value}")
+        end
+        @api.config(cmds) == [{}, {}]
+      end
+
+      ##
+      # Configures the access port vlan for the specified interface.
+      # 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] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_access_vlan(name, opts = {})
+        value = opts[:value]
+        default = opts[:default] || false
+
+        cmds = ["interface #{name}"]
+        case default
+        when true
+          cmds << 'default switchport access vlan'
+        when false
+          cmds << (value.nil? ? 'no switchport access vlan' : \
+                                "switchport access vlan #{value}")
+        end
+        @api.config(cmds) == [{}, {}]
+      end
+
+      private
+
+      def mode_to_value(config)
+        m = /(?<=Operational Mode:\s)(?<mode>[[:alnum:]|\s]+)\n/.match(config)
+        m['mode'] == 'static access' ? 'access' : 'trunk'
+      end
+
+      def trunk_vlans_to_value(config)
+        m = /(?<=Trunking VLANs Enabled:\s)(?<vlans>[[[:alnum:]]+|ALL])/
+            .match(config)
+        return m['vlans'] unless m.nil?
+      end
+
+      def trunk_native_to_value(config)
+        m = /(?<=Trunking Native Mode VLAN:\s)(?<trunk_vlan>\d+)/.match(config)
+        return m['trunk_vlan'] unless m.nil?
+      end
+
+      def access_vlan_to_value(config)
+        m = /(?<=Access Mode VLAN:\s)(?<access_vlan>\d+)/.match(config)
+        return m['access_vlan'] unless m.nil?
+      end
+    end
+  end
+end

data/lib/puppet_x/eos/modules/system.rb

@@ -0,0 +1,138 @@
+#
+# Copyright (c) 2014, Arista Networks, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+#   Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+#   Neither the name of Arista Networks nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+##
+# PuppetX is the toplevel namespace for working with Arista EOS nodes
+module PuppetX
+  ##
+  # Eos is module namesapce for working with the EOS command API
+  module Eos
+    ##
+    # The System class provides management of system level functions
+    #
+    class System
+      ##
+      # Initializes a new instance of System.
+      #
+      # @param [PuppetX::Eos::Eapi] api An instance of Eapi
+      #
+      # @return [PuppetX::Eos::System] instance
+      def initialize(api)
+        @api = api
+      end
+
+      ##
+      # Returns the configured system hostname from the running-config
+      #
+      # @return [String]  the configured system hostname
+      def get_hostname
+        result = @api.enable('show hostname')
+        result.first['hostname'].gsub("\n", '')
+      end
+
+      ##
+      # Returns the configured domain-name from the running-config
+      #
+      # @return [String] the configured domain-name
+      def get_domain_name
+        result = @api.enable('show ip domain-name', 'text')
+        result.first['output'].gsub("\n", '')
+      end
+
+      ##
+      # Returns the configure domain-list from the running-config.  If no
+      # domain-list has been created, then an empty array is returned
+      #
+      # @return [Array] the list of configured domain names
+      def get_domain_list
+        result = @api.enable('show running-config section ip\sdomain-list',
+                             'text')
+        result.first['output'].scan(/(?<=list\s).*$/)
+      end
+
+      ##
+      # Returns the list of configured name-servers from the running-config
+      #
+      # @return [Array] the list of configured name servers
+      def get_name_servers
+        result = @api.enable('show ip name-server', 'text')
+        result.first['output'].split("\n")
+      end
+
+      ##
+      # Configures the system hostname
+      #
+      # @param [String] name The name to configure the hostname to
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_hostname(name)
+        @api.config("hostname #{name}") == [{}]
+      end
+
+      ##
+      # Configures the system domain-name
+      #
+      # @param [String] name The name to configure the domain-name to
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_domain_name(name)
+        @api.config("ip domain-name #{name}")
+      end
+
+      ##
+      # Configures the system name servers
+      #
+      # @param [Array] list of name-server values
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_name_servers(servers)
+        servers.each do |srv|
+          resp = @api.config("ip name-server #{srv}")
+          return false unless resp == [{}]
+        end
+      end
+
+      ##
+      # Configures the list of domain suffixes to search
+      #
+      # @param[Array] list of domain-name values
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_domain_list(domains)
+        domains.each do |name|
+          resp = @api.config("ip domain-list #{name}")
+          return false unless resp == [{}]
+        end
+      end
+    end
+  end
+end