ibm_power_hmc 0.17.0 → 0.19.0

data/lib/ibm_power_hmc/{connection.rb → apis/uom.rb}

@@ -2,72 +2,8 @@
 
 require 'erb'
 
-# Module for IBM HMC Rest API Client
 module IbmPowerHmc
-  class Error < StandardError; end
-
-  ##
-  # HMC REST Client connection.
   class Connection
-    ##
-    # @!method initialize(host:, password:, username: "hscroot", port: 12_443, validate_ssl: true, timeout: 60)
-    # Create a new HMC connection.
-    #
-    # @param host [String] Hostname of the HMC.
-    # @param password [String] Password.
-    # @param username [String] User name.
-    # @param port [Integer] TCP port number.
-    # @param validate_ssl [Boolean] Verify SSL certificates.
-    # @param timeout [Integer] The default HTTP timeout in seconds.
-    def initialize(host:, password:, username: "hscroot", port: 12_443, validate_ssl: true, timeout: 60)
-      @hostname = "#{host}:#{port}"
-      @username = username
-      @password = password
-      @verify_ssl = validate_ssl
-      @api_session_token = nil
-      @timeout = timeout
-    end
-
-    ##
-    # @!method logon
-    # Establish a trusted session with the Web Services APIs.
-    # @return [String] The X-API-Session token.
-    def logon
-      method_url = "/rest/api/web/Logon"
-      headers = {
-        :content_type => "application/vnd.ibm.powervm.web+xml; type=LogonRequest"
-      }
-      doc = REXML::Document.new("")
-      doc.add_element("LogonRequest", "schemaVersion" => "V1_1_0")
-      doc.root.add_namespace("http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/")
-      doc.root.add_element("UserID").text = @username
-      doc.root.add_element("Password").text = @password
-
-      @api_session_token = ""
-      response = request(:put, method_url, headers, doc.to_s)
-      doc = REXML::Document.new(response.body)
-      elem = doc.elements["LogonResponse/X-API-Session"]
-      raise Error, "LogonResponse/X-API-Session not found" if elem.nil?
-
-      @api_session_token = elem.text
-    end
-
-    ##
-    # @!method logoff
-    # Close the session.
-    def logoff
-      # Don't want to trigger automatic logon here!
-      return if @api_session_token.nil?
-
-      method_url = "/rest/api/web/Logon"
-      begin
-        request(:delete, method_url)
-      rescue
-        # Ignore exceptions as this is best effort attempt to log off.
-      end
-      @api_session_token = nil
-    end
-
     ##
     # @!method management_console
     # Retrieve information about the management console.
@@ -94,7 +30,7 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method managed_system(sys_uuid = nil, group_name = nil)
+    # @!method managed_system(sys_uuid, group_name = nil)
     # Retrieve information about a managed system.
     # @param sys_uuid [String] The UUID of the managed system.
     # @param group_name [String] The extended group attributes.
@@ -194,17 +130,6 @@ module IbmPowerHmc
       response.body[1..-2]
     end
 
-    ##
-    # @!method rename_lpar(lpar_uuid, new_name)
-    # Rename a logical partition.
-    # @param lpar_uuid [String] The UUID of the logical partition.
-    # @param new_name [String] The new name of the logical partition.
-    def rename_lpar(lpar_uuid, new_name)
-      modify_object do
-        lpar(lpar_uuid).tap { |lpar| lpar.name = new_name }
-      end
-    end
-
     ##
     # @!method lpar_migrate_validate(lpar_uuid, target_sys_name, sync = true)
     # Validate if a logical partition can be migrated to another managed system.
@@ -242,6 +167,16 @@ module IbmPowerHmc
       end
     end
 
+    ##
+    # @!method lpar_delete(lpar_uuid)
+    # Delete a logical partition.
+    # @param lpar_uuid [String] The UUID of the logical partition to delete.
+    def lpar_delete(lpar_uuid)
+      method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}"
+      request(:delete, method_url)
+      # Returns HTTP 204 if ok
+    end
+
     ##
     # @!method vioses(sys_uuid = nil, search = nil, group_name = nil, permissive = true)
     # Retrieve the list of virtual I/O servers managed by the HMC.
@@ -377,6 +312,19 @@ module IbmPowerHmc
       network_adapter("VirtualIOServer", vios_uuid, netadap_uuid)
     end
 
+    def network_adapter(obj_type, lpar_uuid, netadap_uuid)
+      if netadap_uuid.nil?
+        method_url = "/rest/api/uom/#{obj_type}/#{lpar_uuid}/ClientNetworkAdapter"
+        response = request(:get, method_url)
+        FeedParser.new(response.body).objects(:ClientNetworkAdapter)
+      else
+        method_url = "/rest/api/uom/#{obj_type}/#{lpar_uuid}/ClientNetworkAdapter/#{netadap_uuid}"
+        response = request(:get, method_url)
+        Parser.new(response.body).object(:ClientNetworkAdapter)
+      end
+    end
+    private :network_adapter
+
     ##
     # @!method sriov_elp_lpar(lpar_uuid, sriov_elp_uuid = nil)
     # Retrieve one or all SR-IOV ethernet logical ports attached to a logical partition.
@@ -384,18 +332,31 @@ module IbmPowerHmc
     # @param sriov_elp_uuid [String] UUID of the port to match (returns all ports if omitted).
     # @return [Array<IbmPowerHmc::SRIOVEthernetLogicalPort>, IbmPowerHmc::SRIOVEthernetLogicalPort] The list of ports.
     def sriov_elp_lpar(lpar_uuid, sriov_elp_uuid = nil)
-      sriov_ethernet_port("LogicalPartition", lpar_uuid, sriov_elp_uuid)
+      sriov_elp("LogicalPartition", lpar_uuid, sriov_elp_uuid)
     end
 
     ##
-    # @!method network_adapter_vios(vios_uuid, sriov_elp_uuid = nil)
+    # @!method sriov_elp_vios(vios_uuid, sriov_elp_uuid = nil)
     # Retrieve one or all SR-IOV ethernet logical ports attached to a Virtual I/O Server.
     # @param vios_uuid [String] UUID of the Virtual I/O Server.
     # @param sriov_elp_uuid [String] UUID of the port to match (returns all ports if omitted).
     # @return [Array<IbmPowerHmc::SRIOVEthernetLogicalPort>, IbmPowerHmc::SRIOVEthernetLogicalPort] The list of ports.
     def sriov_elp_vios(vios_uuid, sriov_elp_uuid = nil)
-      sriov_ethernet_port("VirtualIOServer", vios_uuid, sriov_elp_uuid)
+      sriov_elp("VirtualIOServer", vios_uuid, sriov_elp_uuid)
+    end
+
+    def sriov_elp(obj_type, lpar_uuid, sriov_elp_uuid)
+      if sriov_elp_uuid.nil?
+        method_url = "/rest/api/uom/#{obj_type}/#{lpar_uuid}/SRIOVEthernetLogicalPort"
+        response = request(:get, method_url)
+        FeedParser.new(response.body).objects(:SRIOVEthernetLogicalPort)
+      else
+        method_url = "/rest/api/uom/#{obj_type}/#{lpar_uuid}/SRIOVEthernetLogicalPort/#{sriov_elp_uuid}"
+        response = request(:get, method_url)
+        Parser.new(response.body).object(:SRIOVEthernetLogicalPort)
+      end
     end
+    private :sriov_elp
 
     ##
     # @!method vnic_dedicated(lpar_uuid, vnic_uuid = nil)
@@ -528,7 +489,7 @@ module IbmPowerHmc
     # @!method shared_processor_pool(sys_uuid, pool_uuid = nil)
     # Retrieve information about Shared Processor Pools.
     # @param sys_uuid [String] The UUID of the managed system.
-    # @param pool_uuid [String] The UUID of the shared storage pool (return all pools if omitted)
+    # @param pool_uuid [String] The UUID of the shared processor pool (return all pools if omitted)
     # @return [Array<IbmPowerHmc::SharedProcessorPool>, IbmPowerHmc::SharedProcessorPool] The list of shared processor pools.
     def shared_processor_pool(sys_uuid, pool_uuid = nil)
       if pool_uuid.nil?
@@ -542,172 +503,6 @@ module IbmPowerHmc
       end
     end
 
-    ##
-    # @!method templates_summary(draft = false)
-    # Retrieve the list of partition template summaries.
-    # @param draft [Boolean] Retrieve draft templates as well
-    # @return [Array<IbmPowerHmc::PartitionTemplateSummary>] The list of partition template summaries.
-    def templates_summary(draft = false)
-      method_url = "/rest/api/templates/PartitionTemplate#{'?draft=false' unless draft}"
-      response = request(:get, method_url)
-      FeedParser.new(response.body).objects(:PartitionTemplateSummary)
-    end
-
-    ##
-    # @!method templates(draft = false)
-    # Retrieve the list of partition templates.
-    # @param draft [Boolean] Retrieve draft templates as well
-    # @return [Array<IbmPowerHmc::PartitionTemplate>] The list of partition templates.
-    def templates(draft = false)
-      method_url = "/rest/api/templates/PartitionTemplate?detail=full#{'&draft=false' unless draft}"
-      response = request(:get, method_url)
-      FeedParser.new(response.body).objects(:PartitionTemplate)
-    end
-
-    ##
-    # @!method template(template_uuid)
-    # Retrieve details for a particular partition template.
-    # @param template_uuid [String] UUID of the partition template.
-    # @return [IbmPowerHmc::PartitionTemplate] The partition template.
-    def template(template_uuid)
-      method_url = "/rest/api/templates/PartitionTemplate/#{template_uuid}"
-      response = request(:get, method_url)
-      Parser.new(response.body).object(:PartitionTemplate)
-    end
-
-    ##
-    # @!method capture_lpar(lpar_uuid, sys_uuid, template_name, sync = true)
-    # Capture partition configuration as template.
-    # @param lpar_uuid [String] The UUID of the logical partition.
-    # @param sys_uuid [String] The UUID of the managed system.
-    # @param template_name [String] The name to be given for the new template.
-    # @param sync [Boolean] Start the job and wait for its completion.
-    # @return [IbmPowerHmc::HmcJob] The HMC job.
-    def capture_lpar(lpar_uuid, sys_uuid, template_name, sync = true)
-      # Need to include session token in payload so make sure we are logged in
-      logon if @api_session_token.nil?
-      method_url = "/rest/api/templates/PartitionTemplate/do/capture"
-      params = {
-        "TargetUuid"              => lpar_uuid,
-        "NewTemplateName"         => template_name,
-        "ManagedSystemUuid"       => sys_uuid,
-        "K_X_API_SESSION_MEMENTO" => @api_session_token
-      }
-      job = HmcJob.new(self, method_url, "Capture", "PartitionTemplate", params)
-      job.run if sync
-      job
-    end
-
-    ##
-    # @!method template_check(template_uuid, target_sys_uuid, sync = true)
-    # Start Template Check job (first of three steps to deploy an LPAR from a Template).
-    # @param template_uuid [String] The UUID of the Template to deploy an LPAR from.
-    # @param target_sys_uuid [String] The UUID of the Managed System to deploy the LPAR on.
-    # @param sync [Boolean] Start the job and wait for its completion.
-    # @return [IbmPowerHmc::HmcJob] The HMC job.
-    def template_check(template_uuid, target_sys_uuid, sync = true)
-      # Need to include session token in payload so make sure we are logged in
-      logon if @api_session_token.nil?
-      method_url = "/rest/api/templates/PartitionTemplate/#{template_uuid}/do/check"
-      params = {
-        "TargetUuid"              => target_sys_uuid,
-        "K_X_API_SESSION_MEMENTO" => @api_session_token
-      }
-      job = HmcJob.new(self, method_url, "Check", "PartitionTemplate", params)
-      job.run if sync
-      job
-    end
-
-    ##
-    # @!method template_transform(draft_template_uuid, target_sys_uuid, sync = true)
-    # Start Template Transform job (second of three steps to deploy an LPAR from a Template).
-    # @param draft_template_uuid [String] The UUID of the Draft Template created by the Template Check job.
-    # @param target_sys_uuid [String] The UUID of the Managed System to deploy the LPAR on.
-    # @param sync [Boolean] Start the job and wait for its completion.
-    # @return [IbmPowerHmc::HmcJob] The HMC job.
-    def template_transform(draft_template_uuid, target_sys_uuid, sync = true)
-      # Need to include session token in payload so make sure we are logged in
-      logon if @api_session_token.nil?
-      method_url = "/rest/api/templates/PartitionTemplate/#{draft_template_uuid}/do/transform"
-      params = {
-        "TargetUuid"              => target_sys_uuid,
-        "K_X_API_SESSION_MEMENTO" => @api_session_token
-      }
-      job = HmcJob.new(self, method_url, "Transform", "PartitionTemplate", params)
-      job.run if sync
-      job
-    end
-
-    ##
-    # @!method template_deploy(draft_template_uuid, target_sys_uuid, sync = true)
-    # Start Template Deploy job (last of three steps to deploy an LPAR from a Template).
-    # @param draft_template_uuid [String] The UUID of the Draft Template created by the Template Check job.
-    # @param target_sys_uuid [String] The UUID of the Managed System to deploy the LPAR on.
-    # @param sync [Boolean] Start the job and wait for its completion.
-    # @return [IbmPowerHmc::HmcJob] The HMC job.
-    def template_deploy(draft_template_uuid, target_sys_uuid, sync = true)
-      # Need to include session token in payload so make sure we are logged in
-      logon if @api_session_token.nil?
-      method_url = "/rest/api/templates/PartitionTemplate/#{draft_template_uuid}/do/deploy"
-      params = {
-        "TargetUuid"              => target_sys_uuid,
-        "TemplateUuid"            => draft_template_uuid,
-        "K_X_API_SESSION_MEMENTO" => @api_session_token
-      }
-      job = HmcJob.new(self, method_url, "Deploy", "PartitionTemplate", params)
-      job.run if sync
-      job
-    end
-
-    ##
-    # @!method template_provision(template_uuid, target_sys_uuid, changes)
-    # Deploy Logical Partition from a Template (performs Check, Transform and Deploy steps in a single method).
-    # @param template_uuid [String] The UUID of the Template to deploy an LPAR from.
-    # @param target_sys_uuid [String] The UUID of the Managed System to deploy the LPAR on.
-    # @param changes [Hash] Modifications to apply to the Template before deploying Logical Partition.
-    # @return [String] The UUID of the deployed Logical Partition.
-    def template_provision(template_uuid, target_sys_uuid, changes)
-      draft_uuid = template_check(template_uuid, target_sys_uuid).results["TEMPLATE_UUID"]
-      template_transform(draft_uuid, target_sys_uuid)
-      template_modify(draft_uuid, changes)
-      template_deploy(draft_uuid, target_sys_uuid).results["PartitionUuid"]
-    end
-
-    ##
-    # @!method template_modify(template_uuid, changes)
-    # Modify a template.
-    # @param template_uuid [String] UUID of the partition template to modify.
-    # @param changes [Hash] Hash of changes to make.
-    def template_modify(template_uuid, changes)
-      method_url = "/rest/api/templates/PartitionTemplate/#{template_uuid}"
-
-      # Templates have no href so need to use modify_object_url.
-      modify_object_url(method_url) do
-        template(template_uuid).tap do |obj|
-          changes.each do |key, value|
-            obj.send("#{key}=", value)
-          end
-        end
-      end
-    end
-
-    ##
-    # @!method template_copy(template_uuid, new_name)
-    # Copy existing template to a new one.
-    # @param template_uuid [String] UUID of the partition template to copy.
-    # @param new_name [String] Name of the new template.
-    # @return [IbmPowerHmc::PartitionTemplate] The new partition template.
-    def template_copy(template_uuid, new_name)
-      method_url = "/rest/api/templates/PartitionTemplate"
-      headers = {
-        :content_type => "application/vnd.ibm.powervm.templates+xml;type=PartitionTemplate"
-      }
-      original = template(template_uuid)
-      original.name = new_name
-      response = request(:put, method_url, headers, original.xml.to_s)
-      Parser.new(response.body).object(:PartitionTemplate)
-    end
-
     ##
     # @!method poweron_lpar(lpar_uuid, params = {}, sync = true)
     # Power on a logical partition.
@@ -851,167 +646,5 @@ module IbmPowerHmc
         e
       end.compact
     end
-
-    ##
-    # @!method usertask(uuid = true)
-    # Retrieve details of an event of type "user task".
-    # @param uuid [String] UUID of user task.
-    # @return [Hash] Hash of user task attributes.
-    def usertask(uuid)
-      method_url = "/rest/api/ui/UserTask/#{uuid}"
-      response = request(:get, method_url)
-      j = JSON.parse(response.body)
-      if j['status'].eql?("Completed")
-        case j['key']
-        when "TEMPLATE_PARTITION_SAVE", "TEMPLATE_PARTITION_SAVE_AS", "TEMPLATE_PARTITION_CAPTURE"
-          j['template_uuid'] = templates_summary.find { |t| t.name.eql?(j['labelParams'].first) }&.uuid
-        end
-      end
-      j
-    end
-
-    ##
-    # @!method schema(type)
-    # Retrieve the XML schema file for a given object type.
-    # @param type [String] The object type (e.g. "LogicalPartition", "inc/Types")
-    # @return [REXML::Document] The XML schema file.
-    def schema(type)
-      method_url = "/rest/api/web/schema/#{type}.xsd"
-      response = request(:get, method_url)
-      REXML::Document.new(response.body)
-    end
-
-    class HttpError < Error
-      attr_reader :status, :uri, :reason, :message, :original_exception
-
-      ##
-      # @!method initialize(err)
-      # Create a new HttpError exception.
-      # @param err [RestClient::Exception] The REST client exception.
-      def initialize(err)
-        super
-        @original_exception = err
-        @status = err.http_code
-        @message = err.message
-
-        # Try to parse body as an HttpErrorResponse.
-        unless err.response.nil?
-          begin
-            resp = Parser.new(err.response.body).object(:HttpErrorResponse)
-            @uri = resp.uri
-            @reason = resp.reason
-            @message = resp.message
-          rescue
-            # not an XML body
-          end
-        end
-      end
-
-      def to_s
-        "msg=\"#{@message}\" status=\"#{@status}\" reason=\"#{@reason}\" uri=#{@uri}"
-      end
-    end
-
-    ##
-    # @!method request(method, url, headers = {}, payload = nil)
-    # Perform a REST API request.
-    # @param method [String] The HTTP method.
-    # @param url [String] The method URL.
-    # @param headers [Hash] HTTP headers.
-    # @param payload [String] HTTP request payload.
-    # @return [RestClient::Response] The response from the HMC.
-    def request(method, url, headers = {}, payload = nil)
-      logon if @api_session_token.nil?
-      reauth = false
-      # Check for relative URLs
-      url = "https://#{@hostname}#{url}" if url.start_with?("/")
-      begin
-        headers = headers.merge("X-API-Session" => @api_session_token)
-        RestClient::Request.execute(
-          :method => method,
-          :url => url,
-          :verify_ssl => @verify_ssl,
-          :payload => payload,
-          :headers => headers,
-          :timeout => @timeout
-        )
-      rescue RestClient::Exception => e
-        # Do not retry on failed logon attempts.
-        if e.http_code == 401 && @api_session_token != "" && !reauth
-          # Try to reauth.
-          reauth = true
-          logon
-          retry
-        end
-        raise HttpError.new(e), "REST request failed"
-      end
-    end
-
-    # @!method modify_object(headers = {}, attempts = 5)
-    # Post an IbmPowerHmc::AbstractRest object iteratively using ETag.
-    # @param headers [Hash] HTTP headers.
-    # @param attempts [Integer] Maximum number of retries.
-    # @yieldreturn [IbmPowerHmc::AbstractRest] The object to modify.
-    def modify_object(headers = {}, attempts = 5, &block)
-      modify_object_url(nil, headers, attempts, &block)
-    end
-
-    private
-
-    def modify_object_url(method_url = nil, headers = {}, attempts = 5)
-      while attempts > 0
-        obj = yield
-        raise "object has no href" if method_url.nil? && (!obj.kind_of?(AbstractRest) || obj.href.nil?)
-
-        # Use ETag to ensure object has not changed.
-        headers = headers.merge("If-Match" => obj.etag, :content_type => obj.content_type)
-        begin
-          request(:post, method_url.nil? ? obj.href.path : method_url, headers, obj.xml.to_s)
-          break
-        rescue HttpError => e
-          attempts -= 1
-          # Will get 412 ("Precondition Failed") if ETag mismatches.
-          raise if e.status != 412 || attempts == 0
-        end
-      end
-    end
-
-    ##
-    # @!method network_adapter(vm_type, lpar_uuid, netadap_uuid)
-    # Retrieve one or all virtual ethernet network adapters attached to a Logical Partition or a Virtual I/O Server.
-    # @param vm_type [String] "LogicalPartition" or "VirtualIOServer".
-    # @param lpar_uuid [String] UUID of the Logical Partition or the Virtual I/O Server.
-    # @param netadap_uuid [String] UUID of the adapter to match (returns all adapters if nil).
-    # @return [Array<IbmPowerHmc::ClientNetworkAdapter>, IbmPowerHmc::ClientNetworkAdapter] The list of network adapters.
-    def network_adapter(vm_type, lpar_uuid, netadap_uuid)
-      if netadap_uuid.nil?
-        method_url = "/rest/api/uom/#{vm_type}/#{lpar_uuid}/ClientNetworkAdapter"
-        response = request(:get, method_url)
-        FeedParser.new(response.body).objects(:ClientNetworkAdapter)
-      else
-        method_url = "/rest/api/uom/#{vm_type}/#{lpar_uuid}/ClientNetworkAdapter/#{netadap_uuid}"
-        response = request(:get, method_url)
-        Parser.new(response.body).object(:ClientNetworkAdapter)
-      end
-    end
-
-    ##
-    # @!method sriov_ethernet_port(vm_type, lpar_uuid, sriov_elp_uuid)
-    # Retrieve one or all SR-IOV Ethernet loical ports attached to a Logical Partition or a Virtual I/O Server.
-    # @param vm_type [String] "LogicalPartition" or "VirtualIOServer".
-    # @param lpar_uuid [String] UUID of the Logical Partition or the Virtual I/O Server.
-    # @param sriov_elp_uuid [String] UUID of the port to match (returns all ports if nil).
-    # @return [Array<IbmPowerHmc::SRIOVEthernetLogicalPort>, IbmPowerHmc::SRIOVEthernetLogicalPort] The list of ports.
-    def sriov_ethernet_port(vm_type, lpar_uuid, sriov_elp_uuid)
-      if sriov_elp_uuid.nil?
-        method_url = "/rest/api/uom/#{vm_type}/#{lpar_uuid}/SRIOVEthernetLogicalPort"
-        response = request(:get, method_url)
-        FeedParser.new(response.body).objects(:SRIOVEthernetLogicalPort)
-      else
-        method_url = "/rest/api/uom/#{vm_type}/#{lpar_uuid}/SRIOVEthernetLogicalPort/#{sriov_elp_uuid}"
-        response = request(:get, method_url)
-        Parser.new(response.body).object(:SRIOVEthernetLogicalPort)
-      end
-    end
   end
 end