fog-vcloud-director 0.1.0

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

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve metadata associated with a vDC.
+        #
+        # @param [String] id Object identifier of the vDC.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VdcMetadata.html
+        # @since vCloud API version 1.5
+        def get_vdc_metadata(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vdc/#{id}/metadata/"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the value of the specified key from virtual datacenter
+        # metadata.
+        #
+        # @param [String] id Object identifier of the network.
+        # @param [String] domain
+        # @param [String] key Key of the metadata.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VdcMetadataItem-metadata.html
+        # @since vCloud API version 1.5
+        def get_vdc_metadata_item_metadata(id, domain, key)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "admin/vdc/#{id}/metadata/#{URI.escape(key)})"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :get_vdc_storage_profile, :get_vdc_storage_class
+
+        # Returns storage class referred by the Id. All properties of the
+        # storage classes are visible to vcloud user, except for VDC Storage
+        # Class reference.
+        #
+        # @param [String] id Object identifier of the vDC storage profile.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #     * :href<~String> - The URI of the entity.
+        #     * :type<~String> - The MIME type of the entity.
+        #     * :id<~String> - The entity identifier, expressed in URN format.
+        #       The value of this attribute uniquely identifies the entity,
+        #       persists for the life of the entity, and is never reused.
+        #     * :name<~String> - The name of the entity.
+        #     * :Description<~String> - Optional description.
+        #     * :Enabled<~String> - True if this storage profile is enabled for
+        #       use in the vDC.
+        #     * :Units<~String> - Units used to define :Limit.
+        #     * :Limit<~String> - Maximum number of :Units allocated for this
+        #       storage profile.
+        #     * :Default<~String> - True if this is default storage profile for
+        #       this vDC. The default storage profile is used when an object
+        #       that can specify a storage profile is created with no storage
+        #       profile specified.
+        #
+        # @raise [Fog::Compute::VcloudDirector::Forbidden]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VdcStorageClass.html
+        def get_vdc_storage_class(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vdcStorageProfile/#{id}"
+          )
+        end
+      end
+
+      class Mock
+        def get_vdc_storage_class(id)
+          unless vdc_storage_class = data[:vdc_storage_classes][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"(com.vmware.vcloud.entity.vdcstorageProfile:#{id})\"."
+            )
+          end
+
+          body =
+            {:xmlns=>xmlns,
+             :xmlns_xsi=>xmlns_xsi,
+             :name=>vdc_storage_class[:name],
+             :id=>"urn:vcloud:vdcstorageProfile:#{id}",
+             :type=>"application/vnd.vmware.vcloud.vdcStorageProfile+xml",
+             :href=>make_href("api/vdcStorageProfile/#{id}"),
+             :xsi_schemaLocation=>xsi_schema_location,
+             :Link=>
+              [{:rel=>"up",
+                :type=>"application/vnd.vmware.vcloud.vdc+xml",
+                :href=>make_href("vdc/#{vdc_storage_class[:vdc]}")},
+               {:rel=>"down",
+                :type=>"application/vnd.vmware.vcloud.metadata+xml",
+                :href=>make_href("vdcStorageProfile/#{id}/metadata")}],
+             :Enabled=>vdc_storage_class[:enabled].to_s,
+             :Units=>vdc_storage_class[:units],
+             :Limit=>vdc_storage_class[:limit].to_s,
+             :Default=>vdc_storage_class[:default].to_s}
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :get_vdc_storage_profile_metadata, :get_vdc_storage_class_metadata
+
+        # Retrieve metadata associated with the vDC storage profile.
+        #
+        # @param [String] id Object identifier of the vDC storage profile.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VdcStorageClassMetadata.html
+        def get_vdc_storage_class_metadata(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vdcStorageProfile/#{id}/metadata/"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve metadata associated with the vDC storage profile.
+        #
+        # @param [String] id Object identifier of the vDC storage profile.
+        # @param [String] key Key of the metadata.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VdcStorageClassMetadataItem-metadata.html
+        def get_vdc_storage_class_metadata_item_metadata(id, key)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vdcStorageProfile/#{id}/metadata/#{URI.escape(key)})"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves a list of vdcs in the organization.
+        #
+        # @param [Hash] options
+        # @option options [String] :sortAsc (Sorted by database ID) Sort
+        #   results by attribute-name in ascending order. attribute-name cannot
+        #   include metadata.
+        # @option options [String] :sortDesc (Sorted by database ID) Sort
+        #   results by attribute-name in descending order. attribute-name
+        #   cannot include metadata.
+        # @option options [Integer] :page (1) If the query results span
+        #   multiple pages, return this page.
+        # @option options [Integer] :pageSize (25) Number of results per page,
+        #   to a maximum of 128.
+        # @option options [String] :format (records) One of the following
+        #   types:
+        #   - *references* Returns a reference to each object, including its
+        #     :name, :type, and :href attributes.
+        #   - *records* Returns all database records for each object, with each
+        #     record as an attribute.
+        #   - *idrecords* Identical to the records format, except that object
+        #     references are returned in :id format rather than :href format.
+        # @option options [Array<String>] :fields (all static attribute names)
+        #   List of attribute names or metadata key names to return.
+        # @option options [Integer] :offset (0) Integer value specifying the
+        #   first record to return. Record numbers < offset are not returned.
+        # @option options [String] :filter (none) Filter expression.
+        # @return [Excon::Response]
+        #   * hash<~Hash>:
+        #     * :href<~String> - The URI of the entity.
+        #     * :type<~String> - The MIME type of the entity.
+        #     * :name<~String> - Query name that generated this result set.
+        #     * :page<~String> - Page of the result set that this container
+        #       holds. The first page is page number 1.
+        #     * :pageSize<~String> - Page size, as a number of records or
+        #       references.
+        #     * :total<~String> - Total number of records or references in the
+        #       container.
+        #     * :Link<~Array<Hash>>:
+        #       * :href<~String> - Contains the URI to the entity.
+        #       * :type<~String> - Contains the type of the entity.
+        #       * :rel<~String> - Defines the relationship of the link to the
+        #         object that contains it.
+        #     * :OrgVdcRecord<~Array<Hash>>:
+        #       * TODO
+        #     * :firstPage<~Integer> - First page in the result set.
+        #     * :previousPage<~Integer> - Previous page in the result set.
+        #     * :nextPage<~Integer> - Next page in the result set.
+        #     * :lastPage<~Integer> - Last page in the result set.
+        #
+        # @see http://pubs.vmware.com/vcd-55/topic/com.vmware.vcloud.api.reference.doc_55/doc/operations/GET-RightsFromQuery-query.html
+        # @since vCloud API version 1.5
+        def get_vdcs_from_query(options={})
+          query = []
+          query << "sortAsc=#{options[:sortAsc]}" if options[:sortAsc]
+          query << "sortDesc=#{options[:sortDesc]}" if options[:sortDesc]
+          query << "page=#{options[:page]}" if options[:page]
+          query << "pageSize=#{options[:pageSize]}" if options[:pageSize]
+          query << "format=#{options[:format]}" if options[:format]
+          query << "fields=#{Array(options[:fields]).join(',')}" if options[:fields]
+          query << "offset=#{options[:offset]}" if options[:offset]
+          query << "filter=#{options[:filter]}" if options[:filter]
+
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => 'admin/vdcs/query',
+            :query      => query.map {|q| URI.escape(q)}.join('&')
+          )
+          ensure_list! response.body, :Link
+          ensure_list! response.body,
+            response.body[:type] == 'application/vnd.vmware.vcloud.query.references+xml' ?
+              :OrgVdcReference : :OrgVdcRecord
+
+          %w[firstPage previousPage nextPage lastPage].each do |rel|
+            if link = response.body[:Link].find {|l| l[:rel] == rel}
+              href = Nokogiri::XML.fragment(link[:href])
+              query = CGI.parse(URI.parse(href.text).query)
+              response.body[rel.to_sym] = query['page'].first.to_i
+              response.body[:pageSize] ||= query['pageSize'].first.to_i
+            end
+          end
+
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the virtual hardware section of a VM.
+        #
+        # This operation retrieves the entire VirtualHardwareSection of a VM.
+        # You can also retrieve many RASD item elements of a
+        # VirtualHardwareSection individually, or as groups of related items.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VirtualHardwareSection.html
+        # @since vCloud API version 0.9
+        def get_virtual_hardware_section(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/virtualHardwareSection/"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        require 'fog/vcloud_director/parsers/compute/vm'
+
+        # Retrieve a vApp or VM.
+        #
+        # @note This should probably be deprecated.
+        #
+        # @param [String] id Object identifier of the vApp or VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see #get_vapp
+        def get_vm(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::Compute::VcloudDirector::Vm.new,
+            :path       => "vApp/#{id}"
+          )
+        end
+      end
+      class Mock
+        def get_vm(id)
+          vapp = get_vapp(id).body
+          vm = parse_vapp_to_vm(vapp)
+          body = {:type => vapp[:type], :vm => vm}
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+        
+        # Mock equivalent of Fog::Parsers::Compute::VcloudDirector::Vm
+        def parse_vapp_to_vm(vapp)
+          parser = Fog::Parsers::Compute::VcloudDirector::Vm.new
+          vm = vapp.select {|k| [:href, :name, :status, :type].include? k}
+          network = vapp[:NetworkConnectionSection]
+          vm.merge({
+            :id => vapp[:href].split('/').last,
+            :status => parser.human_status(vapp[:status]),
+            :ip_address => network[:NetworkConnection][:IpAddress],
+            :description => vapp[:Description],
+            :cpu => get_hardware(vapp, 3),
+            :memory => get_hardware(vapp, 4),
+            :disks => get_disks(vapp),
+            :links => [vapp[:GuestCustomizationSection][:Link]],
+          })
+        end
+        
+        def get_hardware(vapp, resource_type)
+          hardware = vapp[:"ovf:VirtualHardwareSection"][:"ovf:Item"]
+          item = hardware.find {|h| h[:"rasd:ResourceType"].to_i == resource_type}
+          if item and item.key? :"rasd:VirtualQuantity"
+            item[:"rasd:VirtualQuantity"].to_i
+          else
+            nil
+          end
+        end
+        
+        def get_disks(vapp)
+          hardware = vapp[:"ovf:VirtualHardwareSection"][:"ovf:Item"]
+          disks = hardware.select {|h| h[:"rasd:ResourceType"].to_i == 17}
+          disks.map {|d| {d[:"rasd:ElementName"] => d[:"rasd:HostResource"][:ns12_capacity].to_i}}
+        end
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Gets capabilities for the VM identified by id.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #    * :href<~String> - The URI of the entity.
+        #    * :type<~String> - The MIME type of the entity.
+        #    * :MemoryHotAddEnabled<~String> - True if the virtual machine
+        #      supports addition of memory while powered on.
+        #    * :CpuHotAddEnabled<~String> - True if the virtual machine
+        #      supports addition of virtual CPUs while powered on.
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VmCapabilities.html
+        def get_vm_capabilities(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/vmCapabilities"
+          )
+        end
+      end
+
+      class Mock
+
+        def get_vm_capabilities(id)
+
+          type = 'application/vnd.vmware.vcloud.vmCapabilitiesSection+xml'
+
+          unless vm = data[:vms][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{type};version=#{api_version}"},
+            :body => get_vm_capabilities_section_body(id, vm)
+          )
+
+        end
+
+        def get_vm_capabilities_section_body(id, vm)
+          {
+            :type => "application/vnd.vmware.vcloud.vmCapabilitiesSection+xml",
+            :href => make_href("vApp/#{id}/vmCapabilities/"),
+            :MemoryHotAddEnabled => "false",
+            :CpuHotAddEnabled => "false",
+          }
+        end
+
+      end
+    end
+  end
+end