ruby_vcloud_sdk 0.5.1 → 0.6.0

data/README.md

@@ -33,7 +33,9 @@ Copyright (c) VMware, Inc.
       throws:
         'RestClient::BadRequest' for un-expected errors
 
-    delete_catalog
+    delete_catalog_by_name
+      parameters:
+        name (String): name of catalog
       returns: nil
       throws:
         'ObjectNotFoundError' when catalog with the name does not exist
@@ -110,7 +112,38 @@ Copyright (c) VMware, Inc.
       throws:
         'ObjectNotFoundError' when disk with the name does not exist
         'RestClient::BadRequest' for un-expected errors
-    
+
+    create_disk
+      parameters:
+        name (String): name of disk
+        size_mb (Integer): disk size in megabyte
+        vm (VCloudSdk::VM, optional): VM that to add disk locality to
+        bus_type (String, optional): bus type of disk, defaults to "scsi"
+        bus_sub_type (String, optional): bus sub type of disk, defaults to "lsilogic"
+      returns: Disk object created
+      throws:
+        'CloudError' when size_mb is less than or equal to 0
+        'CloudError' when bus_type is invalid
+        'CloudError' when bus_sub_type is invalid
+        'RestClient::BadRequest' for un-expected errors
+
+    delete_disk_by_name
+      parameters:
+        name (String): name of disk
+      returns: nil
+      throws:
+        'CloudError' when more than one disks matching the name exist
+        'CloudError' when disk is attached to vm
+        'RestClient::BadRequest' for un-expected errors
+
+    delete_all_disks_by_name
+      parameters:
+        name (String): name of disk
+      returns: nil
+      throws:
+        'CloudError' when any disk deletion failure occurs
+        'RestClient::BadRequest' for un-expected errors
+
   Catalog
   
      items
@@ -134,7 +167,10 @@ Copyright (c) VMware, Inc.
         throws:
           'RestClient::BadRequest' for un-expected errors
      
-     delete_item
+     delete_item_by_name_and_type
+        parameters:
+          name (String): name of item
+          type (String, optional): type of item - "application/vnd.vmware.vcloud.vAppTemplate+xml" or "application/vnd.vmware.vcloud.media+xml"
         returns: nil
         throws:
           'ObjectNotFoundError' when an item matching the name and type is not found
@@ -152,11 +188,45 @@ Copyright (c) VMware, Inc.
           'ObjectNotFoundError' when storage profile with the name does not exist
           'RestClient::BadRequest' for un-expected errors
 
+     find_media_by_name
+        parameters:
+          name (String): name of media
+        returns: media catalog item matching name
+        throws:
+          'ObjectNotFoundError' when an item matching the name and type is not found
+          'RestClient::BadRequest' for un-expected error
+
      upload_vapp_template
+         parameters:
+           vdc_name (String): name of vdc
+           template_name (String): name of vapp template
+           directory (String): path of vapp template directory
+           storage_profile_name (String, optional): name of storage profile to upload vapp template to
+        returns: vapp template catalog item uploaded
+        throws:
+          'CloudError' when vapp template matching name already exists
+          'ApiTimeoutError' if uploading vapp files times out
+          'CloudError' when uploading vapp template task is not successful
+          'RestClient::BadRequest' for un-expected error
 
      find_vapp_template_by_name
+        parameters:
+          name (String): name of vapp template
+        returns: vapp template catalog item matching name
+        throws:
+          'ObjectNotFoundError' when an item matching the name and type is not found
+          'RestClient::BadRequest' for un-expected error
 
      instantiate_vapp_template
+         parameters:
+           template_name (String): name of vapp template
+           vdc_name (String): name of vdc
+           vapp_name (String): name of vapp
+           description (String, optional): description of vapp template
+         returns: vapp object instantiated
+         throws:
+           'ApiError' when instantiating vapp template task is not successful
+           'RestClient::BadRequest' for un-expected error
      
   Network
   
@@ -222,8 +292,70 @@ Copyright (c) VMware, Inc.
          'CloudError' when VApp is in status of 'POWERED_ON' and can not be recomposed
          'RestClient::BadRequest' for un-expected errors
 
+     list_networks
+       returns: array of network names
+       throws:
+         'RestClient::BadRequest' for un-expected errors
+
+     add_network_by_name
+       parameters:
+         network_name (String): name of network in vdc org to add to vapp
+         vapp_net_name (String, optional): what to name the network of the vapp.
+         Default to network_name
+         fence_mode (String, optional): Fencing allows identical virtual machines in different
+         vApps to be powered on without conflict by isolating the MAC and IP addresses of the
+         virtual machines. Available options are "bridged", "isolated" and "natRouted". Default
+         to "bridged".
+       returns: task object
+       throws:
+        'CloudError' when invalid fence mode is specified
+        'ObjectNotFoundError' when network with the name does not exist
+        'RestClient::BadRequest' for un-expected errors
+
+     delete_network_by_name
+       parameters:
+         name (String): name of network to delete
+       returns: nil
+       throws:
+         'ObjectNotFoundError' when network with the name does not exist
+         'RestClient::BadRequest' for un-expected errors
+
   VM
 
+     vcpu:
+       returns: number of virtual cpus of VM
+       throws:
+         'CloudError' when information of number of virtual cpus of VM is unavailable
+         'RestClient::BadRequest' for un-expected errors
+
+     vcpu=
+       parameters:
+         The virtual cpu count.
+       returns: VM object
+       throws:
+         'CloudError' when the cpu count is less than or equal to 0
+         'RestClient::BadRequest' for un-expected errors
+
+     memory
+       returns: integer number, the size of memory in megabyte
+       throws:
+         'ApiError' when AllocationUnits of memory is in unexpected form
+         'CloudError' when size of memory is zero
+         'RestClient::BadRequest' for un-expected errors
+
+     memory=
+        parameters:
+          The size of memory in megabyte.
+        returns: VM object
+        throws:
+          'CloudError' when the memory size is less than or equal to 0
+          'RestClient::BadRequest' for un-expected errors
+
+    list_networks
+      returns: array of network names
+      throws:
+        'RestClient::BadRequest' for un-expected errors
+
      independent_disks
        returns: array of disk objects
        throws:
@@ -280,6 +412,53 @@ Copyright (c) VMware, Inc.
          'ObjectNotFoundError' if when media with the name does not exist
          'RestClient::BadRequest' for un-expected errors
 
+     add_nic
+        parameters:
+          network_name (String): name of network to add NIC
+          ip_addressing_mode (String, optional): available options are "NONE", "MANUAL",
+          "POOL" and "DHCP". Default to "POOL"
+          ip (String, optional): IP address for "MANUAL" IP Mode
+        return: task object
+        throws:
+          'CloudError' if when ip_addressing_mode is invalid
+          'CloudError' if ip is not specified in "MANUAL" ip_addressing_mode
+          'CloudError' if vm is powered on
+          'ObjectNotFoundError' if network is not added to VM's parent VApp
+          'RestClient::BadRequest' for un-expected errors
+
+     product_section_properties
+        returns:
+          array of hash values representing properties of product section of VM
+          empty array if VM does not have product section
+        throws:
+          'RestClient::BadRequest' for un-expected errors
+
+     product_section_properties=
+        parameters:
+          properties (array of hash values): properties of product section of VM
+        returns: VM object
+        throws:
+          'RestClient::BadRequest' for un-expected errors
+        note:
+          Rebooting VM is needed to reflect product section changes
+
+     internal_disks
+       returns: array of internal disk objects
+       throws:
+         'RestClient::BadRequest' for un-expected errors
+
+     create_internal_disk
+       parameters:
+         capcity (Integer): disk size in megabyte
+         bus_type (String, optional): bus type of disk, defaults to "scsi"
+         bus_sub_type (String, optional): bus sub type of disk, defaults to "lsilogic"
+       returns: InternalDisk object created
+       throws:
+         'CloudError' when capcity is less than or equal to 0
+         'CloudError' when bus_type is invalid
+         'CloudError' when bus_sub_type is invalid
+         'RestClient::BadRequest' for un-expected errors
+
   VdcStorageProfile
   
      available_storage

data/lib/ruby_vcloud_sdk/catalog.rb

@@ -51,7 +51,7 @@ module VCloudSdk
       end
     end
 
-    def delete_item(name, item_type = nil)
+    def delete_item_by_name_and_type(name, item_type = nil)
       link = find_item_link(name)
       item = VCloudSdk::CatalogItem.new(@session, link)
 
@@ -97,15 +97,21 @@ module VCloudSdk
       media = upload_media_file media, media_file
 
       add_item(media)
+      find_media_by_name(media_name)
+    end
+
+    def find_media_by_name(name)
+      find_item(name, Xml::MEDIA_TYPE[:MEDIA])
     end
 
     def upload_vapp_template(
-      vdc_name,
+        vdc_name,
         template_name,
         directory,
         storage_profile_name = nil)
       if item_exists?(template_name)
-        fail "vApp template '#{template_name}' already exists in catalog #{name}"
+        fail CloudError,
+             "vApp template '#{template_name}' already exists in catalog #{name}"
       end
 
       vdc = find_vdc_by_name vdc_name
@@ -123,6 +129,7 @@ module VCloudSdk
         Template #{template_name} uploaded, adding to catalog #{name}.
       }
       add_item(vapp_template)
+      find_vapp_template_by_name(template_name)
     end
 
     def find_vapp_template_by_name(name)
@@ -156,18 +163,16 @@ module VCloudSdk
     private
 
     def add_item(item)
-      catalog_item = create_catalog_item_payload(item)
+      payload = create_catalog_item_payload(item)
       catalog_name = name
-      catalog_item_name = catalog_item.name
+      catalog_item_name = item.name
       Config.logger.info "Adding #{catalog_item_name} to catalog #{catalog_name}"
       connection.post(admin_xml.add_item_link,
-                      catalog_item,
+                      payload,
                       Xml::ADMIN_MEDIA_TYPE[:CATALOG_ITEM])
       Config.logger.info %Q{
-        catalog_item #{catalog_item_name} added to catalog #{catalog_name}:
-        #{catalog_item.to_s}
+        catalog_item #{catalog_item_name} added to catalog #{catalog_name}
       }
-      catalog_item
     end
 
     def delete_item_by_link(link)
@@ -237,10 +242,10 @@ module VCloudSdk
     end
 
     def create_catalog_item_payload(item)
-      catalog_item = Xml::WrapperFactory.create_instance(Xml::XML_TYPE[:CATALOGITEM])
-      catalog_item.name = item.name
-      catalog_item.entity = item
-      catalog_item
+      Xml::WrapperFactory.create_instance(Xml::XML_TYPE[:CATALOGITEM]).tap do |payload|
+        payload.name = item.name
+        payload.entity = item
+      end
     end
 
     def validate_vapp_template_tasks(vapp_template)

data/lib/ruby_vcloud_sdk/client.rb

@@ -2,6 +2,7 @@ require_relative "vdc"
 require_relative "catalog"
 require_relative "session"
 require_relative "infrastructure"
+require_relative "right_record"
 
 module VCloudSdk
 
@@ -31,12 +32,20 @@ module VCloudSdk
       find_catalog_by_name name
     end
 
-    def delete_catalog(name)
+    def delete_catalog_by_name(name)
       catalog = find_catalog_by_name(name)
       catalog.delete_all_items
       connection.delete("/api/admin/catalog/#{catalog.id}")
       nil
     end
+
+    def right_records
+      right_records = connection.get("/api/admin/rights/query").right_records
+
+      right_records.map do |right_record|
+        VCloudSdk::RightRecord.new(right_record)
+      end
+    end
   end
 
 end

data/lib/ruby_vcloud_sdk/connection/connection.rb

@@ -142,7 +142,7 @@ module VCloudSdk
             }
             @login_url = default_login_url
           else
-            # Typically url_content is the full URL such as "https://10.146.21.135/api/sessions"
+            # Typically url_content is the full URL such as "https://10.147.0.0/api/sessions"
             # In this case we need to trim the beginning of the url string
             @login_url = get_nested_resource(url_node.login_url.content)
           end

data/lib/ruby_vcloud_sdk/disk.rb

@@ -9,7 +9,7 @@ module VCloudSdk
     extend Forwardable
     def_delegators :entity_xml,
                    :name, :bus_type, :bus_sub_type,
-                   :size_mb, :status
+                   :capacity, :status
 
     def initialize(session, link)
       @session = session
@@ -32,18 +32,6 @@ module VCloudSdk
       VCloudSdk::VM.new(@session, vm_link.href)
     end
 
-    def delete
-      fail CloudError,
-           "Disk '#{name}' of link #{href} is attached to VM '#{vm.name}'" if attached?
-
-      disk_name = name
-      task = connection.delete(entity_xml.remove_link.href)
-      task = monitor_task(task)
-
-      Config.logger.info "Disk '#{disk_name}' of link #{@link} is deleted successfully"
-      task
-    end
-
     private
 
     def vm_reference

data/lib/ruby_vcloud_sdk/infrastructure.rb

@@ -11,7 +11,17 @@ module VCloudSdk
     def find_vdc_by_name(name)
       vdc_link = @session.org.vdc_link(name)
       fail ObjectNotFoundError, "VDC #{name} not found" unless vdc_link
-      VCloudSdk::VDC.new(@session, connection.get(vdc_link))
+      VCloudSdk::VDC.new(@session, vdc_link)
+    end
+
+    def find_network_by_name(name)
+      @session.org.networks.each do |network_link|
+        if network_link.name == name
+          return VCloudSdk::Network.new(@session, network_link)
+        end
+      end
+
+      fail ObjectNotFoundError, "Network '#{name}' is not found"
     end
 
     def catalogs

data/lib/ruby_vcloud_sdk/internal_disk.rb

@@ -0,0 +1,12 @@
+module VCloudSdk
+
+  class InternalDisk
+    attr_reader :capacity, :bus_type, :bus_sub_type
+
+    def initialize(entity_xml)
+      @capacity = entity_xml.host_resource.attribute("capacity").to_s.to_i
+      @bus_type = entity_xml.host_resource.attribute("busType").to_s
+      @bus_sub_type = entity_xml.host_resource.attribute("busSubType").to_s
+    end
+  end
+end

data/lib/ruby_vcloud_sdk/network.rb

@@ -5,17 +5,22 @@ module VCloudSdk
   class Network
     include Infrastructure
 
+    extend Forwardable
+    def_delegator :entity_xml, :name
+
     def initialize(session, link)
       @session = session
       @link = link
     end
 
-    def name
-      entity_xml.name
+    def href
+      @link
     end
 
     def ip_ranges
-      entity_xml.ip_ranges
+      entity_xml
+        .ip_scope
+        .ip_ranges
         .ranges
         .reduce(IpRanges.new) do |result, i|
           result + IpRanges.new("#{i.start_address}-#{i.end_address}")

data/lib/ruby_vcloud_sdk/right_record.rb

@@ -0,0 +1,12 @@
+module VCloudSdk
+
+  class RightRecord
+    attr_reader :name, :category
+
+    def initialize(right_record_xml_obj)
+      @right_record_xml_obj = right_record_xml_obj
+      @name = right_record_xml_obj[:name]
+      @category = right_record_xml_obj[:category]
+    end
+  end
+end

data/lib/ruby_vcloud_sdk/vapp.rb

@@ -86,6 +86,57 @@ module VCloudSdk
       self
     end
 
+    def list_networks
+      entity_xml
+        .network_config_section
+        .network_configs
+        .map { |network_config| network_config.network_name }
+    end
+
+    def add_network_by_name(
+        network_name,
+        vapp_net_name = nil,
+        fence_mode = Xml::FENCE_MODES[:BRIDGED])
+      fail CloudError,
+           "Invalid fence mode '#{fence_mode}'" unless Xml::FENCE_MODES
+                                                         .each_value
+                                                         .any? { |m| m == fence_mode }
+      network = find_network_by_name(network_name)
+      new_vapp_net_name = vapp_net_name.nil? ? network.name : vapp_net_name
+      network_config_param = network_config_param(
+                               network,
+                               new_vapp_net_name,
+                               fence_mode)
+      payload = entity_xml.network_config_section
+      payload.add_network_config(network_config_param)
+      task = connection.put(payload.href,
+                            payload,
+                            Xml::MEDIA_TYPE[:NETWORK_CONFIG_SECTION])
+      monitor_task(task)
+    end
+
+    def delete_network_by_name(name)
+      unless list_networks.any? { |network_name| network_name == name}
+        fail ObjectNotFoundError,
+             "Network '#{name}' is not found"
+      end
+
+      fail CloudError,
+           %Q{
+               Network '#{name}' is being used by one or more VMs.
+               Please remove the NIC(s) in VM(s) that are in use of the network.
+               Check logs for details.
+             } if network_in_use?(name)
+
+      payload = entity_xml.network_config_section
+      payload.delete_network_config(name)
+      task = connection.put(payload.href,
+                            payload,
+                            Xml::MEDIA_TYPE[:NETWORK_CONFIG_SECTION])
+      monitor_task(task)
+      nil
+    end
+
     private
 
     def recompose_from_vapp_template_param(template)
@@ -118,5 +169,39 @@ module VCloudSdk
         params.add_delete_item vm.href
       end
     end
+
+    def network_config_param(
+        network,
+        vapp_net_name,
+        fence_mode)
+      Xml::WrapperFactory.create_instance("NetworkConfig").tap do |params|
+        network_entity_xml = connection.get(network.href)
+        params.ip_scope.tap do |ip_scope|
+          net_ip_scope = network_entity_xml.ip_scope
+          ip_scope.is_inherited = net_ip_scope.is_inherited?
+          ip_scope.gateway = net_ip_scope.gateway
+          ip_scope.netmask = net_ip_scope.netmask
+          ip_scope.ip_ranges.add_ranges(net_ip_scope.ip_ranges.ranges)
+        end
+        params.fence_mode = fence_mode
+        params.parent_network["name"] = network_entity_xml["name"]
+        params.parent_network["href"] = network_entity_xml["href"]
+        params["networkName"] = vapp_net_name
+      end
+    end
+
+    def network_in_use?(network_name)
+      network_in_use = false
+      vms.each do |vm|
+        vm.list_networks.each do |net_name|
+          if net_name == network_name
+            network_in_use = true
+            Config.logger.error "VM #{vm.name} is using network #{network_name}"
+          end
+        end
+      end
+
+      network_in_use
+    end
   end
 end