ruby_nsx_cli 0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at daniel.cole@superchoice.com.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ruby_nsx_cli.gemspec
+
+gem 'rake', "~> 12.0.0"
+gem 'rest-client', '2.0.2'
+gem 'nokogiri', '1.8.1'
+gem 'minitest', '5.10.1'
+

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (2.99.3)
+    mini_portile2 (2.3.0)
+    minitest (5.10.1)
+    netrc (0.11.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rake (12.0.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (= 5.10.1)
+  nokogiri (= 1.8.1)
+  rake (~> 12.0.0)
+  rest-client (= 2.0.2)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Daniel Cole
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,130 @@
+# RubyNsxCli
+
+This gem is in early stages of development and has only a small set of VMWare's NSX
+API currently implemented.
+
+The main focus for developing this gem was to provide a simple way to automate network creation using the NSX API.
+
+## Features
+
+1. Creation and deletion of virtual wires
+2. Attaching interfaces an edge
+3. Adding DHCP relay agents to an edge
+4. Creating a DHCP IP pool on an edge (This is limited in that it only provides a subset of the available options)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_nsx_cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_nsx_cli
+
+## Usage
+
+Create a new virtual wire:
+```ruby
+virtualwire = RubyNsxCli::NSXVirtualWire.new
+
+virtualwire_args = {
+  :name => 'api-test-wire-1',
+  :scope_id => 'vdnscope-1',
+  :description => 'virtual wire for api testing',
+  :tenant_id => nil,
+  :control_plane_mode => nil
+}
+
+virtualwire.create(virtualwire_args)
+```
+
+Attach an interface to an edge:
+```ruby
+edge = RubyNsxCli::NSXEdge.new
+
+
+interface_args = {
+  :edge_id => 'edge-5',
+  :name => 'api-test-lif-1',
+  :primary_address => '10.250.30.1',
+  :subnet_mask => '255.255.255.0',
+  :mtu => '1500',
+  :connected_to_id => virtualwire_id,
+  :type => 'internal'
+}
+
+edge.attach_interface(interface_args)
+```
+
+Chain commands together to create a new virtualwire, attach the interface and create a DHCP pool:
+```ruby
+# First, create the virtual wire 
+virtualwire = RubyNsxCli::NSXVirtualWire.new
+virtualwire_args = {
+  :name => 'api-test-wire-attach-dhcp-1',
+  :scope_id => 'vdnscope-1',
+  :description => 'virtual wire for api testing',
+  :tenant_id => nil,
+  :control_plane_mode => nil
+}
+virtualwire_id = virtualwire.create(virtualwire_args)
+
+# Second, attach the interface to the specified edge
+edge = RubyNsxCli::NSXEdge.new
+gateway_address = '10.250.31.1'
+
+interface_args = {
+  :edge_id => 'edge-5',
+  :name => 'api-test-lif-dhcp-1',
+  :primary_address => gateway_address,
+  :subnet_mask => '255.255.255.0',
+  :mtu => '1500',
+  :connected_to_id => virtualwire_id,
+  :type => 'internal'
+}
+
+# The response from attaching the interface will contain the vnic index required for adding a DHCP relay
+response = edge.attach_interface(interface_args)
+
+# Parse the vNIC index from the response given when attaching the interface
+vnic_index = edge.get_attr_text_from_xml(response, 'index')
+
+# Finally, add the dhcp agent to the edge
+edge.add_dhcp_agent(edge_id, vnic_index, gateway_address)
+```
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Please note that you will need to set the following environment variables before running `rake test`:
+1. NSX_USERNAME
+2. NSX_PASSWORD
+3. NSX_MANAGER_URL
+4. NSX_TEST_ESG_ID
+5. NSX_TEST_DLR_ID
+
+How to run a single test using rake:
+```
+rake test TEST=test/nsx_edge_test.rb TESTOPTS="--name=test_add_dhcp_relay -v"
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/daniel-cole/ruby_nsx_cli. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby_nsx_cli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruby_nsx_cli/nsx_objects/nsx_edge.rb

@@ -0,0 +1,184 @@
+require_relative 'nsxobject'
+
+module RubyNsxCli
+  class NSXEdge < NSXObject
+
+    INTERFACE_TYPES = %w[internal uplink]
+
+
+    # Attaches an interface to the specified edge
+    #
+    # @param edge_id [String] Edge ID to
+    # @param name [String] Name of the interface
+    # @param primary_address [Integer] Primary IP address for the interface
+    # @param subnet_mask [String] Subnet mask for the network that the interface is attached to
+    # @param mtu [Integer] Maximum transmission unit for the interface
+    # @param connected_to_id [String] ID of the virtualwire or port group to attach the interface to
+    # @param type [Type] Network link type; either 'internal' or 'uplink'
+    # @return [String] Interface XML configuration from the NSX API
+    def attach_interface(edge_id:, name:, primary_address:, subnet_mask:, mtu:, connected_to_id:, type:)
+      api_endpoint = "/api/4.0/edges/#{edge_id}/interfaces/?action=patch"
+
+      interface_hash = {
+          :name => name,
+          :primary_address => primary_address,
+          :subnet_mask => subnet_mask,
+          :mtu => mtu || 1500,
+          :connected_to_id => connected_to_id,
+          :type => type
+      }
+
+      validate_edge_args(interface_hash, edge_id)
+      raise "The interface type must be one of: #{INTERFACE_TYPES.to_s}" if !INTERFACE_TYPES.include?(interface_hash[:type])
+
+      @logger.info("Checking if interface already exists on edge: #{edge_id}")
+      if (interface = check_interface_exists(edge_id, connected_to_id))
+        @logger.info("Skipping interface - interface already exists (edgeId: #{edge_id} connectedToId: #{connected_to_id})")
+        return interface
+      end
+
+
+      interface_obj = OpenStruct.new(interface_hash)
+      payload = render_template('/templates/interface/interfaces.xml.erb', interface_obj)
+
+      post(:api_endpoint => api_endpoint, :payload => payload)
+    end
+
+    # Adds a DHCP relay agent to the specified edge for the specified vNIC
+    # This method is not safe to run concurrently
+    #
+    # @param edge_id [String] Edge Id to add the DHCP agent to
+    # @param gi_address [String] Gateway IP address
+    # @param vnic_index [Integer] vNIC index of the interface on the specified edge to add the DHCP relay agent
+    # @return [RestClient::Response] Response from the NSX API
+    def add_dhcp_agent(edge_id, vnic_index, gi_address)
+
+      api_endpoint = "/api/4.0/edges/#{edge_id}/dhcp/config/relay"
+
+      dhcp_agent_hash = {
+          :vnic_index => vnic_index,
+          :gi_address => gi_address
+      }
+
+      validate_edge_args(dhcp_agent_hash, edge_id)
+
+      dhcp_agent_obj = OpenStruct.new(dhcp_agent_hash)
+      dhcp_agent_xml = render_template('/templates/dhcp/relayagent.xml.erb', dhcp_agent_obj)
+
+      # The DHCP configuration must be retrieved as the put operation overrides the current config
+      # There does not seem to be an alternative way of doing this
+      current_dhcp_config = get("/api/4.0/edges/#{edge_id}/dhcp/config/relay")
+
+      @logger.info("Checking if DHCP agent already exists on edge: #{edge_id}")
+      if check_dhcp_agent_exists(current_dhcp_config, vnic_index, gi_address)
+        @logger.info("Skipping Agent - DHCP agent already exists (vnicIndex: #{vnic_index} giAddress #{gi_address})")
+        return
+      end
+
+      @logger.info("Adding Agent (vnicIndex: #{vnic_index} giAddress #{gi_address})")
+
+      # Grandparent xml node must be provided in the case that the parent node does not exist
+      # i.e. <relayAgents /> does not exist if there are no current relay agents on the edge
+      payload = inject_xml(current_dhcp_config, 'relay', 'relayAgents', dhcp_agent_xml)
+
+      # Strip out XML pi at top of response to prevent 500 errors due to bad formatting of XML payload
+      payload = strip_xml_root_pi(payload)
+
+      put(:api_endpoint => api_endpoint, :payload => payload)
+    end
+
+
+    # Adds a DHCP IP pool agent to the specified edge
+    # This creates a simple dhcp pool as it only allows a small number of the available options to be specified
+    #
+    # @param edge_id [String] Edge ID to add the DHCP pool
+    # @param ip_range [String] Range of IP addresses to include in the DHCP pool. i.e. 192.168.10.2-192.168.10.62
+    # @param default_gateway [String] Default gateway for the network that the agent is providing DHCP to
+    # @param primary_name_server [String] Primary DNS
+    # @param secondary_name_server [String] Secondary DNS
+    # @param lease_time [Integer] DHCP lease time. Defaults to 3600
+    # @return [RestClient::Response] Response from the NSX API
+    def add_simple_dhcp_pool(edge_id:, ip_range:, default_gateway:, domain_name:, primary_name_server:, secondary_name_server:, lease_time:)
+
+      api_endpoint = "/api/4.0/edges/#{edge_id}/dhcp/config/ippools"
+
+      simple_dhcp_pool_hash = {
+          :ip_range => ip_range,
+          :default_gateway => default_gateway,
+          :domain_name => domain_name,
+          :primary_name_server => primary_name_server,
+          :secondary_name_server => secondary_name_server,
+          :lease_time => lease_time || 3600
+      }
+
+      validate_edge_args(simple_dhcp_pool_hash, edge_id)
+      @logger.info("Checking if DHCP IP pool already exists on edge: #{edge_id}")
+      if (ip_pool_id = check_simple_dhcp_pool_exists(edge_id, ip_range))
+        @logger.info("Skipping DHCP IP Pool - already exists (edgeId: #{edge_id} ipRange: #{ip_range})")
+        return ip_pool_id
+      end
+
+      simple_dhcp_pool_obj = OpenStruct.new(simple_dhcp_pool_hash)
+      payload = render_template('/templates/dhcp/simple-dhcp-pool.xml.erb', simple_dhcp_pool_obj)
+
+      post(:api_endpoint => api_endpoint, :payload => payload)
+    end
+
+    # Checks if the specified edge already has the DHCP IP pool by checking if the ip_range has already been specified
+    #
+    # @param edge_id [String] Edge ID to check if the IP pool already exists
+    # @param ip_range [String] IP range of the DHCP IP pool
+    # @return [String] the ID of the DHCP pool if it exists; otherwise nil
+    def check_simple_dhcp_pool_exists(edge_id, ip_range)
+      api_endpoint = "/api/4.0/edges/#{edge_id}/dhcp/config"
+      doc = Nokogiri::XML(get(api_endpoint))
+      ip_pools = doc.css('ipPool')
+      ip_pools.map {|ip_pool| return ip_pool.at('poolId').text if ip_pool.at('ipRange').text == ip_range}
+      return nil
+    end
+
+    # Checks if the specified edge already has the port group or virtualwire attached
+    #
+    # @param edge_id [String] Edge ID to check if the interface is attached to
+    # @param connected_to_id [String] ID of the virtualwire or port group of the interface
+    # @return [String] XML string containing the configuration for the interface if it exists; otherwise nil
+    def check_interface_exists(edge_id, connected_to_id)
+      api_endpoint = "/api/4.0/edges/#{edge_id}/interfaces"
+      doc = Nokogiri::XML(get(api_endpoint))
+      interfaces = doc.css('interface')
+      interfaces.map {|interface| return strip_xml_root_pi(interface) if interface.at('connectedToId').text == connected_to_id}
+      return nil
+    end
+
+
+    # Checks if a DHCP relay agent already exists within the specified XML document
+    #
+    # @param xml [String] XML document to check for the DHCP agent
+    # @param vnic_index [String] vNIC index of the DHCP agent on the edge it is attached to
+    # @param gi_address [String] Gateway IP address for the DHCP agent
+    # @return [Boolean] True if the agent exists; otherwise false
+    def check_dhcp_agent_exists(xml, vnic_index, gi_address)
+      doc = Nokogiri::XML(xml)
+      agents = doc.css('relayAgent')
+
+      agents.each do |agent|
+        agent_vnic_index = agent.css('vnicIndex').text
+        agent_gi_address = agent.css('giAddress').text
+        if vnic_index == agent_vnic_index && gi_address == agent_gi_address
+          return true
+        end
+      end
+
+      return false
+    end
+
+
+    def validate_edge_args(arg_hash, edge_id)
+      errors = []
+      errors << 'Error: Edge ID must be specified' if edge_id.nil?
+      arg_hash.map {|k, v| errors << "Error: Argument: #{arg.to_s} must be specified" if v.nil?}
+      raise errors.to_s if errors.length > 0
+    end
+
+  end
+end

data/lib/ruby_nsx_cli/nsx_objects/nsx_virtualwire.rb

@@ -0,0 +1,87 @@
+require_relative 'nsxobject'
+
+module RubyNsxCli
+
+  class NSXVirtualWire < NSXObject
+
+    CONTROL_PLANE_MODES = %w[
+        UNICAST_MODE
+        MULTICAST_MODE
+        HYBRID_MODE
+    ]
+
+
+    # Creates an NSX virtualwire with the provided arguments
+    #
+    # @param name [String] Name of the virtualwire
+    # @param scope_id [String] vdnscope on which the virtualwire will be added to
+    # @param description [String] Optional description for the virtualwire
+    # @param tenant_id [String]
+    # @param control_plane_mode [String] one of 'UNICAST_MODE', 'MULTICAST_MODE', 'HYBRID_MODE'. Defaults to 'UNICAST_MODE'
+    # @return [String] virtualwire ID.
+    def create(name:, scope_id:, description:, tenant_id:, control_plane_mode:)
+
+      @logger.info("Attempting to create new virtualwire (name: #{name}, scopeId: #{scope_id})")
+
+      virtual_wire_hash = {
+          :name => name,
+          :description => description,
+          :tenant_id => tenant_id || 'virtual wire tenant',
+          :control_plane_mode => control_plane_mode || 'UNICAST_MODE'
+      }
+
+      validate_create_args(virtual_wire_hash, scope_id)
+
+      @logger.info("Checking if virtualwire already exists (name: #{name}, scopeId: #{scope_id})")
+      if (vwire_id = check_virtual_wire_exists(name, scope_id))
+        @logger.info("Skipping virtualwire creation - virtual wire already exists (name: #{name}, scopeId: #{scope_id})")
+        return vwire_id
+      end
+
+      @logger.info("Adding virtual wire (name: #{name}, scopeId: #{scope_id})")
+
+      virtual_wire_obj = OpenStruct.new(virtual_wire_hash)
+      api_endpoint = "/api/2.0/vdn/scopes/#{scope_id}/virtualwires"
+      payload = render_template('/templates/virtualwire/virtualwire.xml.erb', virtual_wire_obj)
+
+      post(:api_endpoint => api_endpoint, :payload => payload)
+    end
+
+    # Deletes a virtualwire
+    #
+    # @param virtualwire_id [String] ID of the virtualwire
+    # @return [String] virtualwire ID if it exists; otherwise nil
+    def delete(virtualwire_id)
+      raise 'You must specify the virtual wire id to be deleted' if !virtualwire_id
+      api_endpoint = "/api/2.0/vdn/virtualwires/#{virtualwire_id}"
+      super(:api_endpoint => api_endpoint)
+    end
+
+    # Checks if a virtaul wire exists by querying the API for a list of virtual wires for the specified scope
+    #
+    # @param name [String] Name of the virtualwire
+    # @param scope_id [String] vdnscope to check for the virtualwire
+    # @return [String] virtualwire id if it exists; otherwise nil
+    def check_virtual_wire_exists(name, scope_id)
+      api_endpoint = "/api/2.0/vdn/scopes/#{scope_id}/virtualwires?startindex=0&pagesize=1000"
+      xml = get(api_endpoint)
+      doc = Nokogiri::XML(xml)
+      virtualwires = doc.css('virtualWire')
+      virtualwires.map {|vwire| return vwire.at('objectId').text if vwire.at('name').text == name}
+      return nil
+    end
+
+
+    def validate_create_args(virtual_wire_hash, scope_id)
+      errors = []
+      if !NSXVirtualWire::CONTROL_PLANE_MODES.include?(virtual_wire_hash[:control_plane_mode])
+        errors << "Error: Control Plane Mode must be one of [#{NSXVirtualWire::CONTROL_PLANE_MODES.to_s}]"
+      end
+
+      errors << 'Error: Scope ID must be specified' if scope_id.nil?
+      virtual_wire_hash.map {|k, v| errors << "Error: Argument: #{arg.to_s} must be specified" if v.nil?}
+      raise errors.to_s if errors.length > 0
+    end
+
+  end
+end