train-vsphere 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45a888e0295c41d0f029a3b2ac2c84a966086a271587e3d7356d908300ced712
-  data.tar.gz: 9521236b5c908e91f98c7c5da50658deae442a67eaf93a9270b6792bb934702d
+  metadata.gz: d5a4dfe1f41d641b64ddfd74dcb679db53ab68df95e9886b50d7f99bba97b927
+  data.tar.gz: b6a248ca2c2b91bf48fb29a698a62a7d4c8236fa65bb471320b3088d1701fc38
 SHA512:
-  metadata.gz: 23a03cfacc2dfe55348ee40b34d4954e3d5efddc08ca1ed58feabff92e176ea92fdd1a0023d653dc4817e9c7e14293a6b79c6f86465cce5bb67584461e2261fe
-  data.tar.gz: 14de4e1f2e2756d0c9caaebae1d5b624ffe5ed0170601cf1025ac929b7340fe1fd8a4492dfef733aa15a3e132974b323cb3efb27b10becb77998238ef317c9a2
+  metadata.gz: fc81775655c57487849c65d3e8bbd76d949885a7f5723ab2c2e9b69f3261249eb18451dfff439879582a9c185bf74cb0f36293f7a864d11013c1c17e22bb50a2
+  data.tar.gz: eb04630f938006e85cf211a5a7045094926e000b02237d15263a01b20a06c82f57ea740f7f8f39000350b6f38ace59734c8bd26d84ef286504c003e7c0eb7afc

data/README.md

@@ -4,7 +4,7 @@
 
 ## To Install this as a User
 
-You will need InSpec v3.9 or later.
+You will need InSpec v3.9 or later. Note that while it will probably run on earlier releases this is what i built it on. 
 
 Simply run:
 
@@ -30,14 +30,30 @@ export VC_PASSWORD='notVMware1!'
 inspec exec -t vsphere://
 ```
 
-When connected, you can retrieve your API token in your resources or profiles as such:
+When connected, you can consume vsphere in the following ways: 
 
 ```ruby
-#This retrieves an authentication token
-@authtoken = inspec.backend.authenticate
+#This retrieves the class of name class
+@api_client = inspec.backend.api_client(class)
+
+#For example, the following will return the Console CLI status
+@api_client = inspec.backend.api_client(VSphereAutomation::Appliance::AccessConsolecliApi)
+status = @api_client.get.status
+
+#Or directly
+
+@status = inspec.backend.api_client(VSphereAutomation::Appliance::AccessConsolecliApi).get.status
+
+#You can also use the rbvomi libraries by calling a method. 
+
+@vsphere_client = inspec.backend.vsphere_client(method)
+
+#for example, the following will return the root folder which can then be consumed to find other objects such as VMs and hosts. 
+
+@dc = inspec.backend.vsphere_client(method).childEntity.grep(RbVmomi::VIM::Datacenter).find { |x| x.name == 'mydatacenter' }
+@vm = dc.vmFolder.childEntity.grep(RbVmomi::VIM::VirtualMachine).find { |x| x.name == 'my_vm' }
+
 
-#This authentication token can now be used to access all other APIs
-VSphereAutomation::Appliance::AccessConsolecliApi.new(@authtoken).get.value
 ```
 
 An example of a resource
@@ -47,18 +63,10 @@ class Vcsa < Inspec.resource(1)
 	supports platform: 'vsphere'
 	desc 'Use the vsphere audit resource to get information from the vSphere API'
 
-  def initialize
-    begin
-      @auth_token = inspec.backend.authenticate
-    rescue VSphereAutomation::ApiError => e
-          fail Train::ClientError
-    end
-  end
 
   def ssh
     begin
-     return VSphereAutomation::Appliance::AccessConsolecliApi.new(@auth_token).get.value
-        
+     return inspec.backend.api_client(VSphereAutomation::Appliance::AccessConsolecliApi).get.value     
     rescue VSphereAutomation::ApiError => e
           fail Train::ClientError
     end
@@ -108,7 +116,7 @@ Due to some unknown bug, libcurl4-gnutls-dev may be required on linux. I haven't
 1. Create your feature branch (git checkout -b my-new-feature)
 1. Commit your changes (git commit -sam 'Add some feature')
 1. Push to the branch (git push origin my-new-feature)
-1. Create new Pull Request
+1. Create new Pull Request against the development branch
 
 ## License
 

data/lib/train-vsphere/connection.rb

@@ -10,6 +10,7 @@ require 'vsphere-automation-appliance'
 require 'vsphere-automation-content'
 require 'vsphere-automation-vapi'
 require 'vsphere-automation-vcenter'
+require 'rbvmomi'
 
 module TrainPlugins
   module Vsphere
@@ -21,20 +22,112 @@ module TrainPlugins
 
         options = validate_options(options)
         super(options)
+
+        #force enable caching
         enable_cache :api_call
 
       end
 
-      def authenticate
+      def vsphere_client(function)
+        begin
+          if !defined? @vim 
+            @vim = RbVmomi::VIM.connect(host: options[:host], user: options[:user], password: options[:password], insecure: options[:insecure])
+          end
+          content = @vim.serviceInstance.content
+          @cache[:api_call][function.to_s.to_sym] ||= content.public_send(function) if content.respond_to? function
+        rescue
+          fail Train::ClientError
+        end
+      end
 
-        return api_client unless cache_enabled?(:api_call)
+      def api_client(klass)
+
+        configuration = VSphereAutomation::Configuration.new.tap do |c|
+          c.host = options[:host]
+          c.username = options[:user]
+          c.password = options[:password]
+          c.scheme = 'https'
+          c.verify_ssl = !options[:insecure]
+          c.verify_ssl_host = !options[:insecure]
+        end
+        begin
+          auth_token = VSphereAutomation::ApiClient.new(configuration)
+          auth_token.default_headers['Authorization'] = configuration.basic_auth_token
+          session_api = VSphereAutomation::CIS::SessionApi.new(auth_token)
+          session_id = session_api.create('').value
+          auth_token.default_headers['vmware-api-session-id'] = session_id  
+        
+        return klass.new(auth_token) unless cache_enabled?(:api_call)
+        @cache[:api_call][klass.to_s.to_sym] ||= klass.new(auth_token)
+
+        rescue VSphereAutomation::ApiError => e
+          fail Train::ClientError
 
-        @cache[:api_call][api_client.to_s.to_sym] ||= api_client
+        #puts "Exception when calling AccessConsolecliApi->get: #{e}"
+        end
       end
 
 
 
 
+
+
+
+
+ #       @cache[:api_call][resource.to_s.to_sym] ||= resource
+
+      # begin
+
+      #   return vim
+      #   rescue
+
+      #     #puts "Exception when calling AccessConsolecliApi->get: #{e}"
+      # end
+
+      # end
+      
+      # def 
+
+      # def authenticate(authtype)
+
+      # if authtype == "rbvmomi"
+      #   #Authenticates to the new open API using the vsphere automation SDK
+      #   return api_client unless cache_enabled?(:api_call)
+
+      #   configuration = VSphereAutomation::Configuration.new.tap do |c|
+      #     c.host = options[:host]
+      #     c.username = options[:user]
+      #     c.password = options[:password]
+      #     c.scheme = 'https'
+      #     c.verify_ssl = !options[:insecure]
+      #     c.verify_ssl_host = !options[:insecure]
+      #   end
+      #   begin
+      #     api_client = VSphereAutomation::ApiClient.new(configuration)
+      #     api_client.default_headers['Authorization'] = configuration.basic_auth_token
+      #     session_api = VSphereAutomation::CIS::SessionApi.new(api_client)
+      #     session_id = session_api.create('').value
+      #     api_client.default_headers['vmware-api-session-id'] = session_id  
+      #     return api_client
+      #   rescue VSphereAutomation::ApiError => e
+      #     fail Train::ClientError
+      #   #puts "Exception when calling AccessConsolecliApi->get: #{e}"
+      #   end
+      # elseif authtype == "openapi"
+
+      # if 
+      #   @cache[:api_call][api_client.to_s.to_sym] ||= api_client
+      # end
+
+      # def auth_rbvmomi
+      #   #Authenticates to the old API using rbvmomi
+      #   return rest_client unless cache_enabled(:api_call)
+      #   @cache[:api_call][api_client.to_s.to_sym] ||= rest_client
+        
+
+
+
+
       def uri
         #Report vsphere URI
         "vsphere://#{options[:host]}"
@@ -47,30 +140,6 @@ module TrainPlugins
 
     private
 
-    def api_client
-
-    
-
-      configuration = VSphereAutomation::Configuration.new.tap do |c|
-        c.host = options[:host]
-        c.username = options[:user]
-        c.password = options[:password]
-        c.scheme = 'https'
-        c.verify_ssl = !options[:insecure]
-        c.verify_ssl_host = !options[:insecure]
-      end
-      begin
-        api_client = VSphereAutomation::ApiClient.new(configuration)
-        api_client.default_headers['Authorization'] = configuration.basic_auth_token
-        session_api = VSphereAutomation::CIS::SessionApi.new(api_client)
-        session_id = session_api.create('').value
-        api_client.default_headers['vmware-api-session-id'] = session_id  
-        return api_client
-      rescue VSphereAutomation::ApiError => e
-        fail Train::ClientError
-        #puts "Exception when calling AccessConsolecliApi->get: #{e}"
-      end
-    end
 
     def validate_options(options)
       if options[:user].nil?

data/lib/train-vsphere/version.rb

@@ -2,6 +2,6 @@
 
 module TrainPlugins
   module Vsphere
-    VERSION = '1.0.2'
+    VERSION = '1.1.0'
   end
 end

data/train-vsphere.gemspec

@@ -6,10 +6,9 @@ require 'train-vsphere/version'
 
 Gem::Specification.new do |spec|
   # Importantly, all Train plugins must be prefixed with `train-`
-  spec.name          = 'train-aws'
+  spec.name          = 'train-vsphere'
 
   # It is polite to namespace your plugin under InspecPlugins::YourPluginInCamelCase
-  spec.name        = 'train-vsphere'
   spec.version     = TrainPlugins::Vsphere::VERSION
   spec.authors     = ['Sjors Robroek']
   spec.email       = ['s.robroek@vxsan.com']
@@ -31,4 +30,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'train', '~> 1.4'
   spec.add_dependency 'vsphere-automation-sdk', '~> 0.1.0'
+  spec.add_dependency 'rbvmomi', '~> 2.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: train-vsphere
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Sjors Robroek
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rbvmomi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 description: Allows applications using Train to speak to vSphere
 email:
 - s.robroek@vxsan.com
@@ -72,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Train Transport for vSphere