cvprac 1.0.0

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2016, Arista Networks EOS+
+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 Arista 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.

data/README.md

@@ -0,0 +1,152 @@
+# Cvprac - CloudVision Portal RESTful API Client
+
+#### Table of Contents
+
+1. [Overview](#overview)
+2. [Installation](#installation)
+3. [Usage](#usage)
+4. [Development](#development)
+5. [Contributing](#contributing)
+6. [Support](#support)
+
+[![Gem Version](https://badge.fury.io/rb/cvprac)](https://badge.fury.io/rb/cvprac)
+[![Unittest Status](https://revproxy.arista.com/eosplus/ci/buildStatus/icon?job=Pipeline_jerearista_test/cvprac-rb/develop&style=plastic)](https://revproxy.arista.com/eosplus/ci/job/Pipeline_jerearista_test/cvprac-rb/develop)
+
+## Overview
+
+The cvprac rubygem is a Ruby RESTful API Client for Arista CloudVision®
+Portal (CVP) which can be used for building applications that work with Arista
+CVP. If you are looking for a Python version, see [cvprac on
+PyPI](https://pypi.python.org/pypi/cvprac) or
+[GitHub](https://pypi.python.org/pypi/cvprac).
+
+When the class is instantiated the logging is configured. Either syslog,
+file logging, both, or none can be enabled. If neither syslog nor
+filename is specified then no logging will be performed.
+
+This class supports creating a connection to a CVP node and then issuing
+subsequent GET and POST requests to CVP. A GET or POST request will be
+automatically retried on the same node if the request times out. A GET or POST
+request will be automatically retried on the same node if the request receives
+a CvpSessionLogOutError. For this case a login will be performed before the
+request is retried. For either case, the maximum number of times a request will
+be retried on the same node is specified by the class attribute
+NUM\_RETRY\_REQUESTS.
+
+If more than one CVP node is specified when creating a connection, and a GET or
+POST request receives a ConnectionError, HTTPError, or TooManyRedirects it will
+be retried on the next CVP node in the list. If a GET or POST request receives
+a Timeout or CvpSessionLogOutError and the retries on the same node exceed
+NUM\_RETRY\_REQUESTS, then the request will be retried on the next node on the
+list.
+
+If any of the errors persists across all nodes then the GET or POST
+request will fail and the last error that occurred will be raised.
+
+The class provides connect, get, and post methods that allow the user to
+make RESTful API calls to CVP. See the example below using the get
+method.
+
+The class provides a wrapper function around the CVP RESTful API
+operations. Each API method takes the RESTful API parameters as method
+parameters to the operation method. The API class was added to the
+client class because the API functions are required when using the CVP
+RESTful API and placing them in this library avoids duplicating the
+calls in every application that uses this class. See the examples below
+using the API methods.
+
+## Requirements
+
+- Ruby 1.9.3 or later
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cvprac'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cvprac
+
+## Usage
+
+Basic usage:
+
+```
+require ‘cvprac’
+cvp = CvpClient.new
+cvp.connect(['192.0.2.101', '192.0.2.102, '192.0.2.103'],
+            'cvpadmin', 'arista123')
+result = cvp.get('/cvpInfo/getCvpInfo.do')
+print result
+{“appVersion”=>”Phase_2_Sprint_34_HF09”, “version”=>”2017.1.0.1”}
+
+result = cvp.get('/user/getUsers.do',
+                 data: { queryparam: nil, startIndex: 0, endIndex: 0 })
+
+cvp.post('/some/endpoint.do', body: '{"some":"data"}')
+```
+
+Modifying logging settings:
+
+```
+require ‘cvprac’
+
+# Log to Syslog
+cvp = CvpClient.new(syslog: true)
+
+# Log to a file or ‘STDOUT’ and increase the logging level
+cvp = CvpClient.new(filename: 'STDOUT', file_log_level: Logger::DEBUG)
+
+```
+
+API Class example:
+
+```
+require ‘cvprac’
+cvp = CvpClient.new
+cvp.connect(['192.0.2.101', '192.0.2.102, '192.0.2.103'],
+            'cvpadmin', 'arista123')
+
+result = cvp.api.get_cvp_info
+print result
+=> {“appVersion”=>”Phase_2_Sprint_34_HF09”, “version”=>”2017.1.0.1”}
+```
+
+### Notes for API Class Usage
+
+#### Containers
+
+With the API the containers are added for all cases. If you add the container
+to the original root container ‘Tenant’ then you have to do a refresh from the
+GUI to see the container after it is added or deleted. If the root container
+has been renamed or the parent container is not the root container then an add
+or delete will update the GUI without requiring a manual refresh.
+
+## Development
+
+See [CONTRIBUTING](CONTRUBUTING.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on
+[GitHub](https://github.com/arista-aristanetworks/cvprac-rb). Pull-requests
+must include relevant unittests and updated docstrings to be accepted.
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor
+Covenant](http://contributor-covenant.org) code of conduct.
+
+## Support
+
+For support, please open an
+[issue](https://github.com/arista-aristanetworks/cvprac-rb) on GitHub or
+contact eosplus@arista.com.  Commercial support agreements are available
+through your Arista account team.

data/Rakefile

@@ -0,0 +1,55 @@
+# Rakefile
+require 'bump/tasks'
+require 'bundler/gem_tasks'
+require 'ci/reporter/rake/rspec'
+require 'github_changelog_generator/task'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'cvprac/version'
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.future_release = Cvprac::VERSION
+end
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |task|
+    task.pattern = 'spec/unit/**/*_spec.rb'
+    task.rspec_opts = ['--color', '--format', 'documentation']
+  end
+
+  RSpec::Core::RakeTask.new(:system) do |task|
+    task.pattern = 'spec/system/**/*_spec.rb'
+    task.rspec_opts = ['--color', '--format', 'documentation']
+  end
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+desc 'Prep CI RSpec tests'
+task :ci_prep do
+  require 'rubygems'
+  begin
+    gem 'ci_reporter'
+    require 'ci/reporter/rake/rspec'
+    ENV['CI_REPORTS'] = 'results'
+  rescue LoadError
+    puts 'Missing ci_reporter gem. You must have the ci_reporter gem ' \
+         'installed to run the CI spec tests'
+  end
+end
+
+desc 'Run the CI RSpec tests'
+task ci_spec: [:ci_prep, 'ci:setup:rspec', 'spec:unit']
+
+task checks: %I[rubocop spec:unit yard]
+task default: %I[rubocop spec:unit yard]

data/cvprac.gemspec

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cvprac/version'
+
+# rubocop:disable Style/UnneededPercentQ
+Gem::Specification.new do |spec|
+  spec.name          = 'cvprac'
+  spec.version       = Cvprac::VERSION
+  spec.authors       = ['Arista Networks']
+  spec.email         = ['eosplus-dev@arista.com']
+  spec.summary       = %q(Arista REST API Client for CloudVision Portal)
+  spec.description   = %q(Arista REST API Client for CloudVision Portal)
+  spec.homepage      = 'https://github.com/arista-aristanetworks/cvprac-rb'
+  spec.license       = 'BSD-3-Clause'
+
+  # NOTE: This may cause issues on Jenkins in detached head
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(bin|test|spec|features)/})
+  end
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
+
+  # spec.add_runtime_dependency 'inifile', '~> 0'
+  spec.add_runtime_dependency 'http-cookie'
+  spec.add_runtime_dependency 'require_all'
+
+  spec.add_development_dependency 'bump'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'ci_reporter'
+  spec.add_development_dependency 'ci_reporter_rspec'
+  spec.add_development_dependency 'fuubar'
+  spec.add_development_dependency 'github_changelog_generator'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'json'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-remote'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rb-readline'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-core'
+  spec.add_development_dependency 'rspec-expectations'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'rspec-nc'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
+
+  spec.required_ruby_version = '>= 1.9.3'
+end

data/lib/cvprac.rb

@@ -0,0 +1,41 @@
+# BSD 3-Clause License
+#
+# Copyright (c) 2016, Arista Networks EOS+
+# 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 Arista 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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 'cvprac/version'
+require 'cvprac/client_errors'
+require 'cvprac/client'
+require 'cvprac/api'
+
+# Top level definition of Cvprac
+#
+module Cvprac
+  # Your code goes here...
+  true
+end

data/lib/cvprac/api.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+# BSD 3-Clause License
+#
+# Copyright (c) 2017, Arista Networks EOS+
+# 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 Arista 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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 'json'
+require 'pp'
+require 'require_all'
+require_rel 'api/*.rb'
+
+# Abstract methods for interacting with Arista CloudVision
+#
+# CvpApi provides high-level, convenience methods which utilize CvpClient for
+# handling communications with CVP.
+#
+# @example Basic usage
+#   require 'cvprac'
+#   cvp = CvpClient.new
+#   cvp.connect(['cvp1', 'cvp2', 'cvp3'], 'cvpadmin', 'arista123')
+#   api = CvpApi.new(cvp)
+#   result = api.get_cvp_info
+#   print result
+#   {"version"=>"2016.1.1"}
+#
+# @author Arista EOS+ Consulting Services <eosplus-dev@arista.com>
+class CvpApi
+  # Methods are split into modules by subject.  Pull mothods back into the
+  #   main class here.  New modules in lib/cvprac/api/ must be added.
+  include Cvprac::Api::Info
+  include Cvprac::Api::Configlet
+  include Cvprac::Api::Provisioning
+  include Cvprac::Api::Inventory
+  include Cvprac::Api::Task
+
+  # Initialize a new CvpClient object
+  #
+  # @param [CvpClient] clnt CvpClient object
+  # @param opts [Hash] optional parameters
+  # @option opts [Fixnum] :request_timeout (30) Max seconds for a request
+  def initialize(clnt, **opts)
+    opts = { request_timeout: 30 }.merge(opts)
+    @clnt = clnt
+    @request_timeout = opts[:request_timeout]
+  end
+
+  # @see #CvpClient.log
+  def log(severity = Logger::INFO, msg = nil)
+    msg = yield if block_given?
+    @clnt.log(severity, msg)
+  end
+end

data/lib/cvprac/api/configlet.rb

@@ -0,0 +1,309 @@
+# encoding: utf-8
+
+# BSD 3-Clause License
+#
+# Copyright (c) 2017, Arista Networks EOS+
+# 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 Arista 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
+#
+
+# @author Arista EOS+ Consulting Services <eosplus-dev@arista.com>
+module Cvprac
+  # Cvprac::Api namespace
+  module Api
+    # CVP Configlet api methods
+    # rubocop:disable Metrics/ModuleLength
+    module Configlet
+      # @!group Configlet Method Summary
+
+      # Add configlet
+      #
+      # @param [String] name The name of the desired configlet
+      # @param [String] config Multiline string of EOS configuration
+      #
+      # @return [String, nil] The key for the new configlet. nil on failure
+      #
+      # @raise CvpApiError on failure.  Common: errorCode: 132518: Data already
+      #   exists in Database.
+      #
+      # @example
+      #    result = api.add_configlet('api_test_3',
+      #                               "interface Ethernet1\n   shutdown")
+      def add_configlet(name, config)
+        log(Logger::DEBUG) do
+          "add_configlet: #{name} Config: #{config.inspect}"
+        end
+        resp = @clnt.post('/configlet/addConfiglet.do',
+                          body: { name: name, config: config.to_s }.to_json)
+        log(Logger::DEBUG) do
+          "add_configlet: #{name} Response: #{resp.inspect}"
+        end
+        resp['data']
+      end
+
+      # Update configlet
+      #
+      # @param [String] name The name of the desired configlet
+      # @param [String] key The configlet key
+      # @param [Hash] config The configlet definition
+      #
+      # @return [String] The key for the new configlet
+      #
+      # @example
+      #    result = api.update_configlet('api_test_3', configlet_new['key'],
+      #                                  "interface Ethernet1\n   shutdown")
+      def update_configlet(name, key, config)
+        log(Logger::DEBUG) do
+          "update_configlet: #{name} Key: #{key} Config: #{config.inspect}"
+        end
+        data = @clnt.post('/configlet/updateConfiglet.do',
+                          body: { name: name, key: key,
+                                  config: config }.to_json)
+        data['data']
+      end
+
+      # Delete configlet
+      #
+      # @param [String] name The name of the desired configlet
+      # @param [String] key The configlet key
+      #
+      # @return [String] The request result
+      #
+      # @raise CvpApiError on failure.  Common when name or key is invalid:
+      #   errorCode: 132718: Invalid input parameters.
+      def delete_configlet(name, key)
+        log(Logger::DEBUG) { "delete_configlet: #{name} Key: #{key}" }
+        resp = @clnt.post('/configlet/deleteConfiglet.do',
+                          body: [{ name: name, key: key }].to_json)
+        resp['data']
+      end
+
+      # Get all configlet definitions
+      #
+      # @param [Fixnum] start_i (0) Start index of pagination
+      # @param [Fixnum] end_i (0) End index for pagination. 0 will get all
+      # @param [String] type ('Configlet') Possible types are All, Configlet,
+      #   Builder, Draft, Builderwithoutdraft, Generated, IgnoreDraft
+      #
+      # @return [Hash] configlet definitions with keys: total and data (a list
+      #   of definitions)
+      #
+      # @example
+      #    configlet = api.get_configlets()
+      def get_configlets(start_i = 0, end_i = 0, type = 'Configlet')
+        log(Logger::DEBUG) do
+          "get_configlets: start=#{start_i}, end=#{end_i}, type=#{type}"
+        end
+        @clnt.get('/configlet/getConfiglets.do', data: { startIndex: start_i,
+                                                         endIndex: end_i,
+                                                         type: type })
+      end
+
+      # Get configlet definition by configlet name
+      #
+      # @param [String] name The name of the desired configlet
+      #
+      # @return [Hash] configlet definition
+      #
+      # @example
+      #    configlet = api.get_configlet_by_name('api_test_3')
+      def get_configlet_by_name(name)
+        log(Logger::DEBUG) { "get_configlet_by_name: #{name}" }
+        @clnt.get('/configlet/getConfigletByName.do', data: { name: name })
+      end
+
+      # Get devices associated with a configlet name
+      #
+      # @param [String] name The name of the desired configlet
+      # @param opts [Hash] Optional arguments
+      # @option opts [String] :queryparam Search string
+      # @option opts [Fixnum] :start_index (0) Start index for pagination
+      # @option opts [Fixnum] :end_index (0) End index for pagination
+      #
+      # @return [Hash] configlet definition
+      #
+      # @example
+      #    configlet = api.get_configlet_by_name('api_test_3')
+      #
+      def get_devices_by_configlet_name(name, **opts)
+        opts = { queryparam: nil,
+                 start_index: 0,
+                 end_index: 0 }.merge(opts)
+        log(Logger::DEBUG) { "get_configlet_by_name: #{name}" }
+        @clnt.get('/configlet/getAppliedDevices.do',
+                  data: { configletName: name,
+                          queryparam: opts[:queryparam],
+                          startIndex: opts[:start_index],
+                          endIndex: opts[:end_index] })
+      end
+
+      # Apply configlets to a device
+      #
+      # @param [String] app_name The name to use in the info field
+      # @param [Hash] device Device definition from #get_device_by_id()
+      # @param [Hash] new_configlets List of configlet name & key pairs
+      #
+      # @return [Hash] Hash including status and a list of task IDs created,
+      #   if any
+      #
+      # @example
+      #    result = api.apply_configlets_to_device('test',
+      #                                            {...},
+      #                                            [{'name' => 'new_configlet',
+      #                                              'key' => '...'}])
+      #    => {"data"=>{"taskIds"=>["8"], "status"=>"success"}}
+      #
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def apply_configlets_to_device(app_name, device, new_configlets)
+        log(Logger::DEBUG) { "apply_configlets_to_device: #{app_name}" }
+
+        # get the list of existing configlets
+        configlets = get_configlets_by_device_id(device['systemMacAddress'])
+
+        # Get a list of the configlet names and keys
+        cnames = []
+        ckeys = []
+        configlets.each do |configlet|
+          cnames << configlet['name']
+          ckeys << configlet['key']
+        end
+
+        new_configlets.each do |configlet|
+          cnames << configlet['name']
+          ckeys << configlet['key']
+        end
+
+        info = "#{app_name}: Configlet Assign: to Device #{device['fqdn']}"
+        info_preview = "<b>Configlet Assign:</b> to Device #{device['fqdn']}"
+        data = { data: [{ id: 1,
+                          info: info,
+                          infoPreview: info_preview,
+                          note: '',
+                          action: 'associate',
+                          nodeType: 'configlet',
+                          nodeId: '',
+                          configletList: ckeys,
+                          configletNamesList: cnames,
+                          ignoreConfigletNamesList: [],
+                          ignoreConfigletList: [],
+                          configletBuilderList: [],
+                          configletBuilderNamesList: [],
+                          ignoreConfigletBuilderList: [],
+                          ignoreConfigletBuilderNamesList: [],
+                          toId: device['systemMacAddress'],
+                          toIdType: 'netelement',
+                          fromId: '',
+                          nodeName: '',
+                          fromName: '',
+                          toName: device['fqdn'],
+                          nodeIpAddress: device['ipAddress'],
+                          nodeTargetIpAddress: device['ipAddress'],
+                          childTasks: [],
+                          parentTask: '' }] }
+        log(Logger::DEBUG) do
+          "#{__method__}: saveTopology data #{data['data']}"
+        end
+        add_temp_action(data)
+        save_topology_v2([])
+      end
+
+      # Remove configlets from a device
+      #
+      # @param [String] app_name The name to use in the info field
+      # @param [Hash] device Device definition from #get_device_by_id()
+      # @param [Hash] configlets List of configlet name & key pairs to remove
+      #
+      # @return [Hash] Hash including status and a list of task IDs created,
+      #   if any
+      #
+      # @example
+      #    result = api.remove_configlets_from_device('test',
+      #                                               {...},
+      #                                               [{'name' => 'configlet',
+      #                                                 'key' => '...'}])
+      #    => {"data"=>{"taskIds"=>["8"], "status"=>"success"}}
+      #
+      def remove_configlets_from_device(app_name, device, configlets)
+        log(Logger::DEBUG) { "#{__method__}: #{app_name}" }
+
+        # get the list of existing configlets
+        curr_cfglts = get_configlets_by_device_id(device['systemMacAddress'])
+
+        # Get a list of the configlet names and keys
+        keep_cnames = []
+        keep_ckeys = []
+        curr_cfglts.each do |configlet|
+          next if configlets.include?('name' => configlet['name'],
+                                      'key' => configlet['key'])
+          keep_cnames << configlet['name']
+          keep_ckeys << configlet['key']
+        end
+
+        del_cnames = []
+        del_ckeys = []
+        configlets.each do |configlet|
+          del_cnames << configlet['name']
+          del_ckeys << configlet['key']
+        end
+
+        info = "#{app_name}: Configlet Remove from Device #{device['fqdn']}"
+        info_preview = "<b>Configlet Remove:</b> from Device #{device['fqdn']}"
+        data = { data: [{ id: 1,
+                          info: info,
+                          infoPreview: info_preview,
+                          note: '',
+                          action: 'associate',
+                          nodeType: 'configlet',
+                          nodeId: '',
+                          configletList: keep_ckeys,
+                          configletNamesList: keep_cnames,
+                          ignoreConfigletNamesList: del_cnames,
+                          ignoreConfigletList: del_ckeys,
+                          configletBuilderList: [],
+                          configletBuilderNamesList: [],
+                          ignoreConfigletBuilderList: [],
+                          ignoreConfigletBuilderNamesList: [],
+                          toId: device['systemMacAddress'],
+                          toIdType: 'netelement',
+                          fromId: '',
+                          nodeName: '',
+                          fromName: '',
+                          toName: device['fqdn'],
+                          nodeIpAddress: device['ipAddress'],
+                          nodeTargetIpAddress: device['ipAddress'],
+                          childTasks: [],
+                          parentTask: '' }] }
+        log(Logger::DEBUG) do
+          "#{__method__}: saveTopology data #{data['data']}"
+        end
+        add_temp_action(data)
+        save_topology_v2([])
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+    end
+  end
+end