puppet_x_eos_eapi 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a352c49c584998cfbb646599f4b466df8d337682
+  data.tar.gz: 618f0683af4bc6e6eb95b4555c0e11bfab0a77c7
+SHA512:
+  metadata.gz: b44235dcc678fada446474a370d557e8afe60d5550652e43e242a7181f7e14aadf3938288a79d0235dadbfd87b3716e7ceaf25a700b5feb2ad7c4278b230df69
+  data.tar.gz: c319f1db4c39716a5ff0851b815a084ce613daa993b339d76ace9316ae84169d29eb232407bbc61b722dd391319471194e5cee89f4cc05e5adf5c34f78c52b64

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,24 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+gem 'net_http_unix'
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'guard-shell'
+end
+
+group :development, :test do
+  gem 'rake', '~> 10.1.0'
+  gem 'rspec', '~> 3.0.0'
+  gem 'rspec-mocks', '~> 3.0.0'
+  gem 'simplecov'
+  gem 'yard'
+  gem 'redcarpet', '~> 3.1.2'
+  gem 'pry',                     require: false
+  gem 'pry-doc',                 require: false
+  gem 'pry-stack_explorer',      require: false
+end
+
+# vim:ft=ruby

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Puppet Labs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,87 @@
+# Arista eAPI Ruby Library
+
+This ruby gem library implements configuration tasks using the Arista EOS eAPI.
+The goal if this library is to provide a reusable set of classes and methods
+for use with Puppet types and providers.
+
+## Installation for Development
+
+First, clone the repository to your local development system:
+
+    $ cd /workspace
+    $ git clone git@github.com:puppetlabs/puppet_x_eos_eapi.git
+
+Then add these lines to your module's Gemfile in order to use your development
+copy of the Gem library:
+
+```ruby
+puppet_x_eos_eapi_version = ENV['GEM_PUPPET_X_EOS_EAPI_VERSION']
+if puppet_x_eos_eapi_version
+  gem 'puppet_x_eos_eapi', *location_for(puppet_x_eos_eapi_version)
+else
+  gem 'puppet_x_eos_eapi'
+end
+```
+
+And then execute:
+
+    $ export GEM_PUPPET_X_EOS_EAPI_VERSION=file:///workspace/puppet_x_eos_eapi
+    $ bundle install --path .bundle/gems/
+
+## Usage
+
+Provider's extend themselves by including the API methods into the provider
+class.  For example,
+
+```ruby
+# encoding: utf-8
+
+require 'puppet/type'
+require 'puppet_x_eos_eapi'
+Puppet::Type.type(:network_snmp).provide(:eos) do
+
+  # Create methods that set the @property_hash for the #flush method
+  mk_resource_methods
+
+  # Mix in the api as instance methods
+  include PuppetX::Eos::ProviderMethods
+  # Mix in the api as class methods
+  extend PuppetX::Eos::ProviderMethods
+  # Mix in common provider class methods (e.g. self.prefetch)
+  extend PuppetX::Eos::ProviderClassMethods
+
+  def initialize(resource = {})
+    super(resource)
+    @property_flush = {}
+  end
+end
+```
+
+## Behavior tests
+
+When making changes to this Gem, please check the spec tests, code coverage,
+documentation coverage, and rubocop warnings:
+
+Behavior Tests:
+
+    bundle exec rspec spec
+
+Code Coverage is automatically generated after the spec tests are run:
+
+    open coverage/index.html
+
+Documentation:
+
+    bundle exec yard
+
+Rubocop warnings:
+
+    bundle exec rubocop
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/puppet_x/eos/autoload.rb

@@ -0,0 +1,57 @@
+#
+# 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.
+#
+
+require 'puppet_x/eos/module_base'
+
+##
+# PuppetX namespace
+module PuppetX
+  ##
+  # Eos namespace
+  module Eos
+    autoload :Vlan, 'puppet_x/eos/modules/vlan'
+    autoload :Extension, 'puppet_x/eos/modules/extension'
+    autoload :Daemon, 'puppet_x/eos/modules/daemon'
+    autoload :Interface, 'puppet_x/eos/modules/interface'
+    autoload :Switchport, 'puppet_x/eos/modules/switchport'
+    autoload :Ipinterface, 'puppet_x/eos/modules/ipinterface'
+    autoload :Snmp, 'puppet_x/eos/modules/snmp'
+    autoload :Vxlan, 'puppet_x/eos/modules/vxlan'
+    autoload :Mlag, 'puppet_x/eos/modules/mlag'
+    autoload :Ntp, 'puppet_x/eos/modules/ntp'
+    autoload :Ospf, 'puppet_x/eos/modules/ospf'
+    autoload :Portchannel, 'puppet_x/eos/modules/portchannel'
+    autoload :System, 'puppet_x/eos/modules/system'
+    autoload :Radius, 'puppet_x/eos/modules/radius'
+    autoload :Tacacs, 'puppet_x/eos/modules/tacacs'
+  end
+end

data/lib/puppet_x/eos/eapi.rb

@@ -0,0 +1,259 @@
+#
+# 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.
+#
+require 'net/http'
+require 'net_http_unix'
+require 'json'
+require 'syslog'
+
+require 'puppet_x/eos/version'
+require 'puppet_x/eos/autoload'
+
+##
+# PuppetX namespace
+module PuppetX
+  ##
+  # Eos namespace
+  module Eos
+    ##
+    # Eapi class
+    class Eapi
+      attr_reader :hostname
+      attr_reader :port
+      attr_reader :username
+      attr_reader :password
+      attr_reader :enable_pwd
+      attr_reader :use_ssl
+      attr_reader :uri
+      attr_reader :socket
+
+      # The default path to the EOS command api unix domain socket.
+      SOCKET_PATH = '/var/run/command-api.sock'
+
+      # ApiError is raised when there are errors in the REST API repsonse.
+      class ApiError < Exception; end
+
+      ##
+      # Initialize an instance of Eapi.  This class provides direct API
+      # connectivity to command API running on Arista EOS switches.  This class
+      # will send and receive eAPI calls using JSON-RPC over HTTP/S.  Each
+      # option has a corresponding environment variable which will override the
+      # options hash if defined.
+      #
+      # @param [Hash] opts The eAPI configuration options
+      #
+      # @option opts [String] :hostname (EOS_HOSTNAME) Hostname or IP address
+      #   of eAPI endpoint.
+      # @option opts [String] :username (EOS_USERNAME) eAPI username
+      # @option opts [String] :password (EOS_PASSWORD) eAPI password
+      # @option opts [String] :enable_pwd (EOS_ENABLE_PASSWORD) Enable mode
+      #   password
+      # @option opts [Boolean] :use_ssl (EOS_USE_SSL) eAPI protocol
+      # @option opts [Integer] :port (EOS_PORT) eAPI port
+      # @option opts [String] :socket ('/var/run/command-api.sock') Initialize
+      #   an HTTP client using a unix domain socket.  This option will negate
+      #   the :hostname, :port, :username, :password, :port, and :use_ssl
+      #   options
+      #
+      # @return [Eos::Eapi] instance of Eos::Eapi
+      def initialize(opts = {})
+        @hostname = ENV['EOS_HOSTNAME'] || opts[:hostname] || 'localhost'
+        @username = ENV['EOS_USERNAME'] || opts[:username] || 'admin'
+        @password = ENV['EOS_PASSWORD'] || opts[:password] || ''
+        @enable_pwd = ENV['EOS_ENABLE_PASSWORD'] || opts[:enable_pwd] || ''
+        use_ssl = (ENV['EOS_USE_SSL'] || opts[:use_ssl]) ? true : false
+        @protocol = use_ssl ? 'https' : 'http'
+        port = (ENV['EOS_PORT'] || opts[:port]) || (use_ssl ? '443' : '80')
+        @port = port.to_i
+        unless ENV['EOS_DISABLE_SOCKET']
+          @socket = ENV['EOS_SOCKET_PATH'] || opts[:socket]
+          unless @socket
+            sock_path = Pathname.new(SOCKET_PATH)
+            if sock_path.socket? && sock_path.readable? && sock_path.writable?
+              @socket = SOCKET_PATH
+            end
+          end
+        end
+      end
+
+      ##
+      # uri returns a URI object
+      #
+      # @return [Uri]
+      def uri
+        return @uri if @uri
+        @uri = URI("#{@protocol}://#{@hostname}:#{@port}")
+      end
+
+      ##
+      # http returns a memoized HTTP object instance
+      #
+      # @return [Net::Http] http client
+      def http
+        return @http if @http
+        if @socket
+          @http = NetX::HTTPUnix.new("unix://#{@socket}")
+        else
+          @http = Net::HTTP.new(uri.host, uri.port)
+        end
+      end
+
+      ##
+      # Autloads an eAPI provider module for working with EOS objects
+      #
+      # @return [Object]
+      def method_missing(name)
+        name = "PuppetX::Eos::#{name}"
+        klass = name.split('::').inject(Object) { |a, e| a.const_get e }
+        klass.new self
+      end
+
+      ##
+      # The request method converts an array of commands to a valid
+      # eAPI request hash.  The request message can be then sent to the eAPI
+      # end point using JSON-RPC over HTTP/S.  eAPI exposes a single method,
+      # runCmds.
+      #
+      # @param [Array<String>] command An array of commands to be inserted
+      #
+      # @return [Hash] returns a hash that can be serialized to JSON and sent
+      #   to the command API end point
+      def request(command, params = {})
+        # id = params[:id] || SecureRandom.uuid
+        id = 1
+        format = params[:format] || 'json'
+        cmds = [*command]
+        params = { 'version' => 1, 'cmds' => cmds, 'format' => format }
+        { 'jsonrpc' => '2.0', 'method' => 'runCmds',
+          'params' => params, 'id' => id }
+      end
+
+      ##
+      # The invoke method takes the JSON formatted message and sends it
+      # to the eAPI end point.   The response return value from command API
+      # is parsed from JSON and returned as an array of hashes with the output
+      # for each command
+      #
+      # @param [Array<String>] ordered list of commands to send to the host
+      #
+      # return [Array<Hash>] ordered list of ouput from the command execution
+      def invoke(body)
+        request = Net::HTTP::Post.new('/command-api')
+        request.body = JSON.dump(body)
+        request.basic_auth @username, @password
+        response = http.request(request)
+        JSON(response.body)
+      end
+
+      ##
+      # The execute method takes the array of commands and inserts
+      # the 'enable' command to make certain the commands are executed in
+      # priviledged mode.   If an enable password is needed, it is inserted
+      # into the command stack as well.  Since the enable command will generate
+      # an empty hash on the response, it is popped off before returning the
+      # array of hashes
+      #
+      # @param [Array<String>] ordered list of commands to insert into the
+      #   POST request
+      #
+      # @return [Array<Hash>] ordered list of output from the command
+      #
+      # @raise [Eos::Eapi::CommandError] if the response from invoke contains
+      #   the key error
+      def execute(commands, options = {})
+        modified_commands = [{cmd: 'enable', input: @enable_pwd}, *commands]
+        resp = invoke(request(modified_commands, options))
+        if resp['error']
+          data = resp['error']['data']
+          fail ApiError, "command #{commands.inspect} failed: #{format_error(data)}"
+        end
+        result = resp['result']
+        result.shift
+        result
+      end
+
+      ##
+      # The enable method is a convenience method that will handling putting
+      # the switch into priviledge mode prior to executing commands.
+      #
+      # @param [Array<String>] commands An ordered list of commands to execute
+      #
+      # @return [Array<Hash>] ordered list of output from commands
+      def enable(commands, options = {})
+        execute([*commands], options)
+      end
+
+      ##
+      # The config method is a convenience method that will handling putting
+      # the switch into config mode prior to executing commands.  The method
+      # will insert 'config' at the top of the command stack and then pop
+      # the empty hash from the response output before return the array
+      # to the caller
+      #
+      # @param [Array<String>] commands An ordered list of commands to execute
+      #
+      # @return [Array<Hash>] ordered list of output from commands
+      def config(commands)
+        commands = [*commands] unless commands.respond_to?('each')
+        commands.insert(0, 'configure')
+        begin
+          result = enable(commands)
+          result.shift
+          result
+        rescue
+          return nil
+        end
+      end
+
+      ##
+      # format_error takes the value of the 'error' key from the EOS API
+      # response and formats the error strings into a string suitable for error
+      # messages.
+      #
+      # @param [Array<Hash>] data Array of data from the API response, this
+      #   will be lcoated in the sub-key api_response['error']['data']
+      #
+      # @api private
+      #
+      # @return [String] the human readable error message
+      def format_error(data)
+        if data
+          data.each_with_object([]) do |i, ary|
+            ary.push(*i['errors']) if i['errors']
+          end.join(', ')
+        else
+          'unknown error'
+        end
+      end
+      private :format_error
+    end
+  end
+end