fog-vcloud-director 0.1.0

data/lib/fog/vcloud_director/requests/compute/post_upload_media.rb

@@ -0,0 +1,120 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Upload a media image.
+        #
+        # The response includes an upload link for the media image.
+        #
+        # @param [String] vdc_id Object identifier of the vDC.
+        # @param [String] name The name of the media image.
+        # @param [String] image_type Media image type. One of: iso, floppy.
+        # @param [Integer] size Size of the media file, in bytes.
+        # @param [Hash] options
+        # @option options [String] :operationKey Optional unique identifier to
+        #   support idempotent semantics for create and delete operations.
+        # @option options [String] :Description Optional description.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @raise [Fog::Compute::VcloudDirector::BadRequest]
+        # @raise [Fog::Compute::VcloudDirector::Forbidden]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/POST-UploadMedia.html
+        # @since vCloud API version 0.9
+        # @todo Support vDC Storage Profiles.
+        def post_upload_media(vdc_id, name, image_type, size, options={})
+          body = Nokogiri::XML::Builder.new do
+            attrs = {
+              :xmlns => 'http://www.vmware.com/vcloud/v1.5',
+              :name => name,
+              :imageType => image_type,
+              :size => size
+            }
+            attrs[:operationKey] = options[:operationKey] if options.key?(:operationKey)
+            Media(attrs) {
+              if options.key?(:Description)
+                Description options[:Description]
+              end
+            }
+          end.to_xml
+
+          response = request(
+            :body    => body,
+            :expects => 201,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.media+xml'},
+            :method  => 'POST',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vdc/#{vdc_id}/media"
+          )
+          ensure_list! response.body, :Files, :File
+          response
+        end
+      end
+
+      class Mock
+        def post_upload_media(vdc_id, name, image_type, size, options={})
+          unless ['iso','floppy'].include?(image_type)
+            raise Fog::Compute::VcloudDirector::BadRequest.new(
+              'The value of parameter imageType is incorrect.'
+            )
+          end
+          unless size.to_s =~ /^\d+$/
+            raise Fog::Compute::VcloudDirector::BadRequest.new(
+              'validation error on field \'size\': must be greater than or equal to 0'
+            )
+          end
+          unless data[:vdcs][vdc_id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"(com.vmware.vcloud.entity.vdc:#{vdc_id})\"."
+            )
+          end
+
+          media_id = uuid
+          file_id = uuid
+
+          owner = {
+            :href => make_href("media/#{media_id}"),
+            :type => 'application/vnd.vmware.vcloud.media+xml'
+          }
+          task_id = enqueue_task(
+            "Importing Media File #{name}(#{file_id})", 'vdcUploadMedia', owner,
+            :on_success => lambda do
+              media = data[:medias][media_id]
+              media[:file][:bytes_transferred] = media[:size]
+              media[:status] = 1
+            end
+          )
+
+          media = {
+            :description => options[:Description],
+            :file => {
+              :bytes_transferred => 0,
+              :uuid => file_id
+            },
+            :image_type => image_type,
+            :name => name,
+            :size => size.to_i,
+            :status => 0,
+            :tasks => [task_id],
+            :vdc_id => vdc_id,
+            :vdc_storage_class => data[:vdc_storage_classes].find {|k,v| v[:default]}.first
+          }
+          data[:medias][media_id] = media
+
+          body = {
+            :xmlns => xmlns,
+            :xmlns_xsi => xmlns_xsi,
+            :xsi_schemaLocation => xsi_schema_location
+          }.merge(media_body(media_id))
+
+          Excon::Response.new(
+            :status => 201,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/post_upload_vapp_template.rb

@@ -0,0 +1,46 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Upload an OVF package to create a vApp template
+        #
+        # The response includes an upload link for the OVF descriptor.
+        #
+        # @param [String] vdc_id Object identifier of the vDC.
+        # @param [String] name The name of the vApp template.
+        # @param [Hash] options
+        # @option options [Boolean] :manifestRequired True if an OVF manifest
+        #   is included in the upload. Default value is false.
+        # @option options [String] :Description Optional description.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/POST-UploadVAppTemplate.html
+        # @since vCloud API version 0.9
+        def post_upload_vapp_template(vdc_id, name, options={})
+          body = Nokogiri::XML::Builder.new do
+            attrs = {
+              :xmlns => 'http://www.vmware.com/vcloud/v1.5',
+              :name => name
+            }
+            attrs[:manifestRequired] = options[:manifestRequired] if options.key?(:manifestRequired)
+            UploadVAppTemplateParams(attrs) {
+              if options.key?(:Description)
+                Description options[:Description]
+              end
+            }
+          end.to_xml
+
+          request(
+            :body    => body,
+            :expects => 201,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml'},
+            :method  => 'POST',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vdc/#{vdc_id}/action/uploadVAppTemplate"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/put_catalog_item_metadata_item_metadata.rb

@@ -0,0 +1,50 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Set the metadata value for the specified key to the value provided,
+        # overwriting any existing value.
+        #
+        # @param [String] id Object identifier of the catalog item.
+        # @param [String] key Key of the metadata item.
+        # @param [Boolean,DateTime,Fixnum,String] value Value of the metadata
+        #   item.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/PUT-CatalogItemMetadataItem-metadata.html
+        # @since vCloud API version 1.5
+        def put_catalog_item_metadata_item_metadata(id, key, value)
+          body = Nokogiri::XML::Builder.new do
+            attrs = {
+              :xmlns => 'http://www.vmware.com/vcloud/v1.5',
+              'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+            }
+            MetadataValue(attrs) {
+              if api_version.to_f < 5.1
+                Value value
+              else
+                type = case value
+                       when TrueClass, FalseClass then 'MetadataBooleanValue';
+                       when DateTime then 'MetadataDateTimeValue';
+                       when Fixnum then 'MetadataNumberValue';
+                       else 'MetadataStringValue'
+                       end
+                TypedValue('xsi:type' => type) { Value value }
+              end
+            }
+          end.to_xml
+
+          request(
+            :body    => body,
+            :expects => 202,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.metadata.value+xml'},
+            :method  => 'PUT',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "catalogItem/#{id}/metadata/#{URI.escape(key)}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/put_cpu.rb

@@ -0,0 +1,88 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :put_vm_cpu, :put_cpu
+
+        # Update the RASD item that specifies CPU properties of a VM.
+        #
+        # This operation is asynchronous and returns a task that you can
+        # monitor to track the progress of the request.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @param [Integer] num_cpus
+        # @return [Excon:Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/PUT-Cpu.html
+        # @since vCloud API version 0.9
+        def put_cpu(id, num_cpus)
+          data = <<EOF
+          <Item 
+            xmlns="http://www.vmware.com/vcloud/v1.5" 
+            xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData" 
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+            xmlns:ns12="http://www.vmware.com/vcloud/v1.5" 
+            ns12:href="#{end_point}vApp/#{id}/virtualHardwareSection/cpu" 
+            ns12:type="application/vnd.vmware.vcloud.rasdItem+xml" 
+            xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 #{end_point}v1.5/schema/master.xsd http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2.22.0/CIM_ResourceAllocationSettingData.xsd">
+            <rasd:AllocationUnits>hertz * 10^6</rasd:AllocationUnits>
+            <rasd:Description>Number of Virtual CPUs</rasd:Description>
+            <rasd:ElementName>#{num_cpus} virtual CPU(s)</rasd:ElementName>
+            <rasd:InstanceID>4</rasd:InstanceID>
+            <rasd:Reservation>0</rasd:Reservation>
+            <rasd:ResourceType>3</rasd:ResourceType>
+            <rasd:VirtualQuantity>#{num_cpus}</rasd:VirtualQuantity>
+            <rasd:Weight>0</rasd:Weight>
+            <Link rel="edit" type="application/vnd.vmware.vcloud.rasdItem+xml" href="#{end_point}vApp/#{id}/virtualHardwareSection/cpu"/>
+          </Item>
+EOF
+
+          request(
+            :body    => data,
+            :expects => 202,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.rasdItem+xml'},
+            :method  => 'PUT',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vApp/#{id}/virtualHardwareSection/cpu"
+          )
+        end
+      end
+
+      class Mock
+
+        def put_cpu(id, num_cpus)
+          unless vm = data[:vms][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          owner = {
+            :href => make_href("vApp/#{id}"),
+            :type => 'application/vnd.vmware.vcloud.vm+xml'
+          }
+          task_id = enqueue_task(
+            "Updating Virtual Machine #{data[:vms][id][:name]}(#{id})", 'vappUpdateVm', owner,
+            :on_success => lambda do
+              data[:vms][id][:cpu_count] = num_cpus
+            end
+          )
+          body = {
+            :xmlns => xmlns,
+            :xmlns_xsi => xmlns_xsi,
+            :xsi_schemaLocation => xsi_schema_location,
+          }.merge(task_body(task_id))
+
+          Excon::Response.new(
+            :status => 202,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/put_disk_metadata_item_metadata.rb

@@ -0,0 +1,46 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Set the value for the specified metadata key to the value provided,
+        # overwriting any existing value.
+        #
+        # @param [String] id Object identifier of the disk.
+        # @param [String] key Key of the metadata item.
+        # @param [Boolean,DateTime,Fixnum,String] value Value of the metadata
+        #   item.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/PUT-DiskMetadataItem-metadata.html
+        # @since vCloud API version 5.1
+        def put_disk_metadata_item_metadata(id, key, value)
+          body = Nokogiri::XML::Builder.new do
+            attrs = {
+              :xmlns => 'http://www.vmware.com/vcloud/v1.5',
+              'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+            }
+            MetadataValue(attrs) {
+              type = case value
+                     when TrueClass, FalseClass then 'MetadataBooleanValue';
+                     when DateTime then 'MetadataDateTimeValue';
+                     when Fixnum then 'MetadataNumberValue';
+                     else 'MetadataStringValue'
+                     end
+              TypedValue('xsi:type' => type) { Value value }
+            }
+          end.to_xml
+
+          request(
+            :body    => body,
+            :expects => 202,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.metadata.value+xml'},
+            :method  => 'PUT',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "disk/#{id}/metadata/#{URI.escape(key)}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/put_disks.rb

@@ -0,0 +1,39 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :put_vm_disks, :put_disks
+
+        require 'fog/vcloud_director/generators/compute/disks'
+
+        # Update all RASD items that specify hard disk and hard disk controller
+        # properties of a VM.
+        #
+        # This operation is asynchronous and returns a task that you can
+        # monitor to track the progress of the request.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @param [Array] disks
+        #   * disks is the body of #get_vm_disks
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/PUT-Disks.html
+        # @since vCloud API version 0.9
+        def put_disks(id, disks=[])
+          data = Fog::Generators::Compute::VcloudDirector::Disks.new(disks)
+
+          request(
+            :body    => data.generate_xml,
+            :expects => 202,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.rasdItemsList+xml'},
+            :method  => 'PUT',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vApp/#{id}/virtualHardwareSection/disks"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/put_guest_customization_section_vapp.rb

@@ -0,0 +1,141 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :put_vm_customization, :put_guest_customization_section_vapp
+
+        # Updates the guest customization section of a VM.
+        #
+        # This operation is asynchronous and returns a task that you can
+        # monitor to track the progress of the request.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @param [Hash] options
+        # @option options [Boolean] :Enabled True if guest customization is
+        #   enabled.
+        # @option options [Boolean] :ChangeSid True if customization can change
+        #   the Windows SID of this virtual machine.
+        # @option options [Boolean] :JoinDomainEnabled True if this virtual
+        #   machine can join a Windows Domain.
+        # @option options [Boolean] :UseOrgSettings True if customization
+        #   should use organization settings (OrgGuestPersonalizationSettings)
+        #   when joining a Windows Domain.
+        # @option options [String] :DomainName The name of the Windows Domain
+        #   to join.
+        # @option options [String] :DomainUserName User name to specify when
+        #   joining a Windows Domain.
+        # @option options [String] :DomainUserPassword Password to use with
+        #   :DomainUserName.
+        # @option options [String] :MachineObjectOU The name of the Windows
+        #   Domain Organizational Unit (OU) in which the computer account for
+        #   this virtual machine will be created.
+        # @option options [Boolean] :AdminPassword_enabled True if guest
+        #   customization can modify administrator password settings for this
+        #   virtual machine.
+        # @option options [Boolean] :AdminPassword_auto True if the
+        #   administrator password for this virtual machine should be
+        #   automatically generated.
+        # @option options [String] :AdminPassword True if the administrator
+        #   password for this virtual machine should be set to this string.
+        #   (:AdminPasswordAuto must be false.)
+        # @option options [Boolean] :ResetPasswordRequired True if the
+        #   administrator password for this virtual machine must be reset after
+        #   first use.
+        # @option customization [String] :CustomizationScript Script to run on
+        #  guest customization. The entire script must appear in this element.
+        # @option customization [String] :ComputerName Computer name to assign
+        #   to this virtual machine.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #     * :Tasks<~Hash>:
+        #       * :Task<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/PUT-GuestCustomizationSection-vApp.html
+        # @since vCloud API version 1.0
+        def put_guest_customization_section_vapp(id, options={})
+          options = options.dup
+
+          # Mutate options to new format.
+          deprecated = {
+            :enabled => :Enabled,
+            :change_sid => :ChangeSid,
+            :join_domain_enabled => :JoinDomainEnabled,
+            :use_org_settings => :UseOrgSettings,
+            :admin_password => :AdminPassword,
+            :admin_password_enabled => :AdminPasswordEnabled,
+            :admin_password_auto => :AdminPasswordAuto,
+            :reset_password_required => :ResetPasswordRequired,
+            :customization_script => :CustomizationScript,
+            :computer_name => :ComputerName
+          }
+          deprecated.each do |from, to|
+            options[to] = options.delete(from) if options.key?(from)
+          end
+
+          body = Nokogiri::XML::Builder.new do
+            attrs = {
+              :xmlns => 'http://www.vmware.com/vcloud/v1.5',
+              'xmlns:ovf' => 'http://schemas.dmtf.org/ovf/envelope/1'
+            }
+            GuestCustomizationSection(attrs) {
+              self['ovf'].Info 'Specifies Guest OS Customization Settings'
+              if options.key?(:Enabled)
+                Enabled options[:Enabled]
+              end
+              if options.key?(:ChangeSid)
+                ChangeSid options[:ChangeSid]
+              end
+              if options.key?(:JoinDomainEnabled)
+                JoinDomainEnabled options[:JoinDomainEnabled]
+              end
+              if options.key?(:UseOrgSettings)
+                UseOrgSettings options[:UseOrgSettings]
+              end
+              if options.key?(:DomainName)
+                DomainName options[:DomainName]
+              end
+              if options.key?(:DomainUser)
+                DomainUser options[:DomainUser]
+              end
+              if options.key?(:DomainUserPassword)
+                DomainUserPassword options[:DomainUserPassword]
+              end
+              if options.key?(:MachineObjectOU)
+                MachineObjectOU options[:MachineObjectOU]
+              end
+              if options.key?(:AdminPasswordEnabled)
+                AdminPasswordEnabled options[:AdminPasswordEnabled]
+              end
+              if options.key?(:AdminPasswordAuto)
+                AdminPasswordAuto options[:AdminPasswordAuto]
+              end
+              # Don't add AdminPassword if AdminPasswordAuto is true
+              if options.key?(:AdminPassword) and !options[:AdminPasswordAuto]
+                AdminPassword options[:AdminPassword]
+              end
+              if options.key?(:ResetPasswordRequired)
+                ResetPasswordRequired options[:ResetPasswordRequired]
+              end
+              if options.key?(:CustomizationScript)
+                CustomizationScript options[:CustomizationScript]
+              end
+              if options.key?(:ComputerName)
+                ComputerName options[:ComputerName]
+              end
+            }
+          end.to_xml
+
+          request(
+            :body    => body,
+            :expects => 202,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.guestCustomizationSection+xml'},
+            :method  => 'PUT',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vApp/#{id}/guestCustomizationSection"
+          )
+        end
+      end
+    end
+  end
+end