vcloud-rest 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -1,13 +1,35 @@
 Changes
 ==
+2012-12-21 (0.2.0)
+--
+
+FEATURES:
+
+* Allow Task tracking for vApp startup & shutdown
+* Improve error message for operations on vApp not running
+* Improve error message for access forbidden
+* Extend vApp status codes handling
+* Add method to show VM's details
+* Basic vApp network configuration
+* Basic VM network configuration
+* Basic Guest Customization configuration
+
+FIXES:
+
+* Show catalog item: fix ID parsing
+
 2012-12-19 (0.1.1)
 --
 
+FIXES:
+
 * Fix gemspec URL
 
 2012-12-19 (0.1.0)
 --
 
+FEATURES:
+
 * Add support for main operations:
  * login/logout
  * organization _list/show_

data/lib/vcloud-rest/connection.rb

@@ -184,7 +184,7 @@ module VCloudClient
 
       items = {}
       response.css("Entity[type='application/vnd.vmware.vcloud.vAppTemplate+xml']").each do |item|
-        items[item['name']] = item['href'].gsub("#{@api_url}/vAppTemplate/", "")
+        items[item['name']] = item['href'].gsub("#{@api_url}/vAppTemplate/vappTemplate-", "")
       end
 
       [description, items]
@@ -211,7 +211,7 @@ module VCloudClient
       vapp_node = response.css('VApp').first
       if vapp_node
         name = vapp_node['name']
-        status = convert_status(vapp_node['status'])
+        status = convert_vapp_status(vapp_node['status'])
       end
 
       description = response.css("Description").first
@@ -225,7 +225,7 @@ module VCloudClient
       vms.each do |vm|
         addresses = vm.css('rasd|Connection').collect{|n| n['ipAddress']}
         vms_hash[vm['name']] = {:addresses => addresses,
-          :status => convert_status(vm['status']),
+          :status => convert_vapp_status(vm['status']),
           :id => vm['href'].gsub("#{@api_url}/vApp/vm-", '')
         }
       end
@@ -265,8 +265,8 @@ module VCloudClient
 
       response, headers = send_request(params, builder.to_xml,
                       "application/vnd.vmware.vcloud.undeployVAppParams+xml")
-
-      response
+      task_id = headers[:location].gsub("#{@api_url}/task/", "")
+      task_id
     end
 
     ##
@@ -278,8 +278,8 @@ module VCloudClient
       }
 
       response, headers = send_request(params)
-      # TODO: track Task using headers[:location]
-      [response, headers]
+      task_id = headers[:location].gsub("#{@api_url}/task/", "")
+      task_id
     end
 
     ##
@@ -290,7 +290,7 @@ module VCloudClient
     # - vapp_name: name of the target vapp
     # - vapp_description: description of the target vapp
     # - vapp_templateid: ID of the vapp template
-    def create_vapp_from_template(vdc, vapp_name, vapp_description, vapp_templateid)
+    def create_vapp_from_template(vdc, vapp_name, vapp_description, vapp_templateid, poweron=false)
       builder = Nokogiri::XML::Builder.new do |xml|
       xml.InstantiateVAppTemplateParams(
         "xmlns" => "http://www.vmware.com/vcloud/v1.5",
@@ -298,7 +298,7 @@ module VCloudClient
         "xmlns:ovf" => "http://schemas.dmtf.org/ovf/envelope/1",
         "name" => vapp_name,
         "deploy" => "true",
-        "powerOn" => "true") {
+        "powerOn" => poweron) {
         xml.Description vapp_description
         xml.Source("href" => "#{@api_url}/vAppTemplate/#{vapp_templateid}")
       }
@@ -355,6 +355,128 @@ module VCloudClient
       [status, errormsg, start_time, end_time]
     end
 
+    ##
+    # Set vApp Network Config
+    def set_vapp_network_config(vappid, network_name, config={})
+      builder = Nokogiri::XML::Builder.new do |xml|
+      xml.NetworkConfigSection(
+        "xmlns" => "http://www.vmware.com/vcloud/v1.5",
+        "xmlns:ovf" => "http://schemas.dmtf.org/ovf/envelope/1") {
+        xml['ovf'].Info "Network configuration"
+        xml.NetworkConfig("networkName" => network_name) {
+          xml.Configuration {
+            xml.FenceMode (config[:fence_mode] || 'isolated')
+            xml.RetainNetInfoAcrossDeployments (config[:retain_net] || true)
+          }
+        }
+      }
+      end
+
+      params = {
+        'method' => :put,
+        'command' => "/vApp/vapp-#{vappid}/networkConfigSection"
+      }
+
+      response, headers = send_request(params, builder.to_xml, "application/vnd.vmware.vcloud.networkConfigSection+xml")
+
+      task_id = headers[:location].gsub("#{@api_url}/task/", "")
+      task_id
+    end
+
+    ##
+    # Set VM Network Config
+    def set_vm_network_config(vmid, network_name, config={})
+      builder = Nokogiri::XML::Builder.new do |xml|
+      xml.NetworkConnectionSection(
+        "xmlns" => "http://www.vmware.com/vcloud/v1.5",
+        "xmlns:ovf" => "http://schemas.dmtf.org/ovf/envelope/1") {
+        xml['ovf'].Info "VM Network configuration"
+        xml.PrimaryNetworkConnectionIndex (config[:primary_index] || 0)
+        xml.NetworkConnection("network" => network_name, "needsCustomization" => true) {
+          xml.NetworkConnectionIndex (config[:network_index] || 0)
+          xml.IpAddress config[:ip] if config[:ip]
+          xml.IsConnected (config[:is_connected] || true)
+          xml.IpAddressAllocationMode config[:ip_allocation_mode] if config[:ip_allocation_mode]
+        }
+      }
+      end
+
+      params = {
+        'method' => :put,
+        'command' => "/vApp/vm-#{vmid}/networkConnectionSection"
+      }
+
+      response, headers = send_request(params, builder.to_xml, "application/vnd.vmware.vcloud.networkConnectionSection+xml")
+
+      task_id = headers[:location].gsub("#{@api_url}/task/", "")
+      task_id
+    end
+
+
+    ##
+    # Set VM Guest Customization Config
+    def set_vm_guest_customization(vmid, computer_name, config={})
+      builder = Nokogiri::XML::Builder.new do |xml|
+      xml.GuestCustomizationSection(
+        "xmlns" => "http://www.vmware.com/vcloud/v1.5",
+        "xmlns:ovf" => "http://schemas.dmtf.org/ovf/envelope/1") {
+          xml['ovf'].Info "VM Guest Customization configuration"
+          xml.Enabled config[:enabled] if config[:enabled]
+          xml.AdminPasswordEnabled config[:admin_passwd_enabled] if config[:admin_passwd_enabled]
+          xml.AdminPassword config[:admin_passwd] if config[:admin_passwd]
+          xml.ComputerName computer_name
+      }
+      end
+
+      params = {
+        'method' => :put,
+        'command' => "/vApp/vm-#{vmid}/guestCustomizationSection"
+      }
+
+      response, headers = send_request(params, builder.to_xml, "application/vnd.vmware.vcloud.guestCustomizationSection+xml")
+
+      task_id = headers[:location].gsub("#{@api_url}/task/", "")
+      task_id
+    end
+
+    ##
+    # Show details about a given VM
+    def show_vm(vmId)
+      params = {
+        'method' => :get,
+        'command' => "/vApp/vm-#{vmId}"
+      }
+
+      response, headers = send_request(params)
+
+      os_desc = response.css('ovf|OperatingSystemSection ovf|Description').first.text
+
+      networks = {}
+      response.css('NetworkConnection').each do |network|
+        ip = network.css('IpAddress').first
+        ip = ip.text if ip
+
+        networks[network['network']] = {
+          :index => network.css('NetworkConnectionIndex').first.text,
+          :ip => ip,
+          :is_connected => network.css('IsConnected').first.text,
+          :mac_address => network.css('MACAddress').first.text,
+          :ip_allocation_mode => network.css('IpAddressAllocationMode').first.text
+        }
+      end
+
+      guest_customizations = {
+        :enabled => response.css('GuestCustomizationSection Enabled').first.text,
+        :admin_passwd_enabled => response.css('GuestCustomizationSection AdminPasswordEnabled').first.text,
+        :admin_passwd_auto => response.css('GuestCustomizationSection AdminPasswordAuto').first.text,
+        :admin_passwd => response.css('GuestCustomizationSection AdminPassword').first.text,
+        :reset_passwd_required => response.css('GuestCustomizationSection ResetPasswordRequired').first.text,
+        :computer_name => response.css('GuestCustomizationSection ComputerName').first.text
+      }
+
+      [os_desc, networks, guest_customizations]
+    end
+
     private
       ##
       # Sends a synchronous request to the vCloud API and returns the response as parsed XML + headers.
@@ -394,23 +516,33 @@ module VCloudClient
           when /validation error on field 'id': String value has invalid format or length/
             raise WrongItemIDError, "Invalid ID specified. Please verify that the item exists and correctly typed."
           when /The requested operation could not be executed on vApp "(.*)". Stop the vApp and try again/
-            raise InvalidStateError, "Invalid request. Stop vApp '#{$1}' and try again."
+            raise InvalidStateError, "Invalid request because vApp is running. Stop vApp '#{$1}' and try again."
+          when /The requested operation could not be executed since vApp "(.*)" is not running/
+            raise InvalidStateError, "Invalid request because vApp is stopped. Start vApp '#{$1}' and try again."
           else
             raise UnhandledError, "BadRequest - unhandled error: #{message}.\nPlease report this issue."
           end
+        rescue RestClient::Forbidden => e
+          body = Nokogiri.parse(e.http_body)
+          message = body.css("Error").first["message"]
+          raise UnauthorizedAccess, "Operation not permitted: #{message}."
         end
       end
 
       ##
-      # Convert status codes into human readable description
-      def convert_status(status_code)
+      # Convert vApp status codes into human readable description
+      def convert_vapp_status(status_code)
         case status_code.to_i
-          when 3
+          when 0
             'suspended'
+          when 3
+            'paused'
           when 4
             'running'
           when 8
             'stopped'
+          when 10
+            'mixed'
           else
             "Unknown #{status_code}"
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-19 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri