ruby_nsx_cli 0.1.0

data/lib/ruby_nsx_cli/nsx_objects/nsxobject.rb

@@ -0,0 +1,189 @@
+require 'rest-client'
+require 'nokogiri'
+require 'erb'
+require 'yaml'
+require 'logger'
+
+module RubyNsxCli
+  class NSXObject
+
+    XML_HEADER = {'Content-Type': 'application/xml'}
+
+    def initialize(**args)
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::DEBUG
+
+      @nsx_manager_url = args[:nsx_manager_url] || ENV['NSX_MANAGER_URL'] || (raise 'NSX Manager URL not specified!')
+      @nsx_username = args[:nsx_username] || ENV['NSX_USERNAME'] || (raise 'NSX Username not specified!')
+      @nsx_password = args[:nsx_password] || ENV['NSX_PASSWORD'] || (raise 'NSX Password not specified!')
+      @ssl_check = args[:verify_ssl] ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+    end
+
+    # Deletes an NSX object using the NSX API.
+    #
+    # @param api_endpoint [String] NSX endpoint to send the request
+    # @return [RestClient::Response] Response from the NSX API.
+    def delete(api_endpoint:)
+
+      @logger.info("Deleting NSX object: #{self.class}...")
+      @logger.debug("Sending request to: #{@nsx_manager_url}...")
+      @logger.debug("API endpoint is: #{api_endpoint}")
+
+      begin
+        resp = create_new_request(api_endpoint, nil).delete
+
+        if resp.code >= 200 && resp.code < 300
+          @logger.info("Successfully deleted NSX object: #{self.class}")
+          return resp
+        else
+          raise "Unexpected return code during NSX object creation: #{self.class} returned #{resp.code}"
+        end
+
+      rescue RestClient::ExceptionWithResponse => err
+        puts "Failed to create NSX object: #{self.class}"
+        puts "Response code: #{err.http_code}"
+        puts "Response: #{err.message}"
+        return resp
+      end
+
+    end
+
+    # Sends a post request to the NSX API. Usually to update an object.
+    #
+    # @param api_endpoint [String] the NSX endpoint to send the request
+    # @param payload [String] the payload to send to the `api_endpoint`
+    # @return [RestClient::Response] the response from the NSX API.
+    def post(api_endpoint:, payload:)
+      @logger.info("Updating NSX object: #{self.class}...")
+      @logger.debug("Payload is: \n#{payload}")
+      @logger.debug("API endpoint is: #{api_endpoint}")
+      @logger.debug("Sending request to: #{@nsx_manager_url}...")
+
+      begin
+
+        resp = create_new_request(api_endpoint, XML_HEADER).post(payload)
+
+        if resp.code >= 200 && resp.code < 300
+          @logger.info("Successfully updated NSX object: #{self.class}")
+          return resp
+        else
+          raise "Unexpected return code during NSX object update: #{self.class} returned #{resp.code}"
+        end
+
+      rescue RestClient::ExceptionWithResponse => err
+        @logger.info("Failed to update NSX object: #{self.class}")
+        @logger.info("Response code: #{err.http_code}")
+        @logger.info("Response: #{err.message}")
+        return resp
+      end
+
+    end
+
+    # Sends a post request to the NSX API. Usually to update an object.
+    #
+    # @param api_endpoint [String] the NSX endpoint to send the request
+    # @param payload [String] the payload to send to the `api_endpoint`
+    # @return [RestClient::Response] the response from the NSX API.
+    def put(api_endpoint:, payload:)
+      @logger.info("Updating NSX object (HTTP put): #{self.class}")
+      @logger.debug("Payload is: \n#{payload}")
+      @logger.debug("API endpoint is: #{api_endpoint}")
+      @logger.debug("Sending request to: #{@nsx_manager_url}...")
+
+
+      begin
+        resp = create_new_request(api_endpoint, XML_HEADER).put(payload)
+
+        if resp.code >= 200 && resp.code < 300
+          @logger.info("Successfully put NSX object: #{self.class}")
+          return resp
+        else
+          raise "Unexpected return code during NSX object put: #{self.class} returned #{resp.code}"
+        end
+
+      rescue RestClient::ExceptionWithResponse => err
+        @logger.error("Failed to put NSX object: #{self.class}")
+        @logger.error("Response code: #{err.http_code}")
+        @logger.error("Response: #{err.message}")
+        return resp
+      end
+
+    end
+
+    # Sends a get request to the NSX API.
+    #
+    # @param api_endpoint [String] NSX endpoint to send the request
+    # @return [RestClient::Response] Response from the NSX API.
+    def get(api_endpoint)
+      resp = create_new_request(api_endpoint, nil).get
+      return resp
+    end
+
+    # Helper method that creates the initial RestClient::Request object.
+    #
+    # @param api_endpoint the NSX endpoint to send the request
+    # @param headers the headers to include in the request
+    # @return [RestClient::Request] the initial request object to be used to call REST methods.
+    def create_new_request(api_endpoint, headers)
+      return RestClient::Resource.new(
+          "https://#{@nsx_manager_url}/#{api_endpoint}",
+          :verify_ssl => @ssl_check,
+          :user => @nsx_username,
+          :password => @nsx_password,
+          :headers => headers
+      )
+    end
+
+    # Inserts an XML block into the provided XML at the parent node
+    # If the parent node does not exist, then the parent node will be created
+    # with the node injected into the grandparent node
+    # Returns the updated xml with the node injected
+    #
+    # @param xml [String] the NSX endpoint to send the request
+    # @param grandparent [String] the grandparent attribute of the node to insert;
+    # only required if the parent node is not included in the provided xml string
+    # @param parent [String] the parent attribute of the node to insert
+    # @param node [String] the payload to send to `:api_endpoint`
+    # @return [String] the original XML string including the inserted node.
+    def inject_xml(xml, grandparent, parent, node)
+      doc = Nokogiri::XML(xml)
+      parent_xml = doc.at_css(parent)
+      if parent_xml.nil?
+        grandparent_xml = doc.at_css(grandparent)
+        raise "No valid parent to insert XML block into with nodes provided: #{parent_xml}, #{grandparent_xml}" if grandparent_xml.nil?
+        parent_xml = Nokogiri::XML::Node.new(parent, doc)
+        grandparent_xml << parent_xml
+      end
+      parent_xml << node
+      return doc
+    end
+
+    # Removes the <?xml version="1.0" encoding="UTF-8"?> processing instruction from the start of an XML string
+    # The new line character left in place is also removed to prevent issues when sending a payload to the NSX API
+    # which includes this string
+    #
+    # @param xml [String] an XML string that includes the processing instruction '<?xml version="1.0" encoding="UTF-8"?>'
+    # @return [String] the XML string without the processing instruction
+    def strip_xml_root_pi(xml)
+      frag = Nokogiri::XML::DocumentFragment.parse(xml)
+      frag.xpath('processing-instruction()').remove
+      return frag.to_s.sub("\n", '') # remove new line generated from removing root pi
+    end
+
+    def get_attr_text_from_xml(xml, attr)
+      doc = Nokogiri::XML(xml)
+      return doc.at(attr).text
+    end
+
+    # Renders the specified erb file using the provided object
+    #
+    # @param template [String] the relative path to the template
+    # @param object [Object] the OpenStruct object that contains the key + values for rendering the template
+    # @return [Object] the rendered template
+    def render_template(template, object)
+      renderer = ERB.new(File.read(File.dirname(__FILE__) + template))
+      return renderer.result(object.instance_eval {binding})
+    end
+
+  end
+end

data/lib/ruby_nsx_cli/nsx_objects/templates/dhcp/relayagent.xml.erb

@@ -0,0 +1,4 @@
+<relayAgent>
+  <vnicIndex><%= vnic_index %></vnicIndex>
+  <giAddress><%= gi_address %></giAddress>
+</relayAgent>

data/lib/ruby_nsx_cli/nsx_objects/templates/dhcp/simple-dhcp-pool.xml.erb

@@ -0,0 +1,9 @@
+<ipPool>
+  <ipRange><%= ip_range %></ipRange>
+  <defaultGateway><%= default_gateway %></defaultGateway>
+  <domainName><%= domain_name %></domainName>
+  <primaryNameServer><%= primary_name_server %></primaryNameServer>
+  <secondaryNameServer><%= secondary_name_server %></secondaryNameServer>
+  <leaseTime><%= lease_time %></leaseTime>
+  <autoConfigureDNS>false</autoConfigureDNS>
+</ipPool>

data/lib/ruby_nsx_cli/nsx_objects/templates/interface/interfaces.xml.erb

@@ -0,0 +1,15 @@
+<interfaces>
+  <interface>
+    <name><%= name %></name>
+    <addressGroups>
+      <addressGroup>
+        <primaryAddress><%= primary_address %></primaryAddress>
+        <subnetMask><%= subnet_mask %></subnetMask>
+      </addressGroup>
+    </addressGroups>
+    <mtu><%= mtu %></mtu>
+    <type><%= type %></type>
+    <isConnected>true</isConnected>
+    <connectedToId><%= connected_to_id %></connectedToId>
+  </interface>
+</interfaces>

data/lib/ruby_nsx_cli/nsx_objects/templates/virtualwire/virtualwire.xml.erb

@@ -0,0 +1,6 @@
+<virtualWireCreateSpec>
+  <name><%= name %></name>
+  <description><%= description %></description>
+  <tenantId><%= tenant_id %></tenantId>
+  <controlPlaneMode><%= control_plane_mode %></controlPlaneMode>
+</virtualWireCreateSpec>

data/lib/ruby_nsx_cli/version.rb

@@ -0,0 +1,3 @@
+module RubyNsxCli
+  VERSION = "0.1.0"
+end

data/lib/ruby_nsx_cli.rb

@@ -0,0 +1,6 @@
+require "ruby_nsx_cli/version"
+
+module RubyNsxCli
+  require 'ruby_nsx_cli/nsx_objects/nsx_edge'
+  require 'ruby_nsx_cli/nsx_objects/nsx_virtualwire'
+end

data/ruby_nsx_cli.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby_nsx_cli/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_nsx_cli"
+  spec.version       = RubyNsxCli::VERSION
+  spec.authors       = ["Daniel Cole"]
+  spec.email         = ["dannycole12@gmail.com"]
+
+  spec.summary       = %q{Simple Ruby VMWare NSX API Client to create}
+  spec.homepage      = "https://github.com/daniel-cole"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0.0"
+  spec.add_development_dependency 'rest-client', '2.0.2'
+  spec.add_development_dependency 'nokogiri', '1.8.1'
+  spec.add_development_dependency 'minitest', '5.10.1'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: ruby_nsx_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Cole
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+description: 
+email:
+- dannycole12@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.rakeTasks"
+- ".idea/dictionaries/dancole.xml"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/ruby_nsx_cli.iml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_nsx_cli.rb
+- lib/ruby_nsx_cli/nsx_objects/nsx_edge.rb
+- lib/ruby_nsx_cli/nsx_objects/nsx_virtualwire.rb
+- lib/ruby_nsx_cli/nsx_objects/nsxobject.rb
+- lib/ruby_nsx_cli/nsx_objects/templates/dhcp/relayagent.xml.erb
+- lib/ruby_nsx_cli/nsx_objects/templates/dhcp/simple-dhcp-pool.xml.erb
+- lib/ruby_nsx_cli/nsx_objects/templates/interface/interfaces.xml.erb
+- lib/ruby_nsx_cli/nsx_objects/templates/virtualwire/virtualwire.xml.erb
+- lib/ruby_nsx_cli/version.rb
+- ruby_nsx_cli.gemspec
+homepage: https://github.com/daniel-cole
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Simple Ruby VMWare NSX API Client to create
+test_files: []