ibm_power_hmc 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6aae673197b8e5426c2f75250ef521db9d7e8eed79a20c70089612a10d189cfc
-  data.tar.gz: f7b5cd95629fedf835a97eebd33874edf777527cb8af2c4c5ebdbaaf9364d4d8
+  metadata.gz: 9c95e9629a205e4276acce5737764da0da1cda5f5eb31dc7eef6adb72c12b3f4
+  data.tar.gz: 8b6c5e4f244cdfe42a317eaa95c992913aab9c387b90de04829fcfa9a6446775
 SHA512:
-  metadata.gz: 793385e1153eff3f9d4bdb8eafe62365a92f0d7fcde75452c1327c36de86b99b2ffd011bf05a57ec9101b4d2d6e84139bc4e86e6cb83347aadef1f0fe5e10b1c
-  data.tar.gz: 3eedcfd6693b0ac13c725488c1f13bb6433e94b136eaebf1c48f4118582b7ed937ad0e6fe1d06f8c74d209eb67f885e181cc26b7b60683f837628f9fc5ed4f3c
+  metadata.gz: be586460348393017cc19cf04ddca66d4c5b2c11685242d0996a9e1536fcc7b36317d8498edc69cb98c9ebb0eccd182093f90063af9742b140506f9f75d7c8cc
+  data.tar.gz: 13504ec3baa2d6ac8712a1c3bd1b313876516ea0aa162338868a671b2cafd0ba57ee3b81689f95b0c2e89820c7a7a733295348a73e6b6cb3e1ffec79fa3dd487

data/.rubocop_local.yml

@@ -2,6 +2,6 @@ AllCops:
   Exclude:
   - '*.gemspec'
 Layout/HashAlignment:
-  EnforcedHashRocketStyle: key
+  Enabled: false
 Style/ConditionalAssignment:
-  EnforcedStyle: assign_inside_condition
+  Enabled: false

data/README.md

@@ -42,6 +42,12 @@ puts hmc.name
 puts hmc.version
 ```
 
+Retrieving managed systems that are powered on:
+
+```ruby
+hc.managed_systems("State" => "operating")
+```
+
 Listing the logical partitions and virtual I/O servers of each managed system:
 
 ```ruby

data/lib/ibm_power_hmc/connection.rb

@@ -2,8 +2,6 @@
 
 # Module for IBM HMC Rest API Client
 module IbmPowerHmc
-  require_relative 'pcm.rb'
-
   class Error < StandardError; end
 
   ##
@@ -19,7 +17,6 @@ module IbmPowerHmc
     # @param port [Integer] TCP port number.
     # @param validate_ssl [Boolean] Verify SSL certificates.
     def initialize(host:, username: "hscroot", password:, port: 12_443, validate_ssl: true)
-      # Damien: use URI::HTTPS
       @hostname = "#{host}:#{port}"
       @username = username
       @password = password
@@ -37,10 +34,8 @@ module IbmPowerHmc
         :content_type => "application/vnd.ibm.powervm.web+xml; type=LogonRequest"
       }
       doc = REXML::Document.new("")
-      doc.add_element("LogonRequest", {
-                        "xmlns" => "http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/",
-                        "schemaVersion" => "V1_1_0"
-                      })
+      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
 
@@ -69,15 +64,6 @@ module IbmPowerHmc
       @api_session_token = nil
     end
 
-    def parse_feed(doc, myclass)
-      objs = []
-      doc.each_element("feed/entry") do |entry|
-        objs << myclass.new(entry)
-      end
-      objs
-    end
-    private :parse_feed
-
     ##
     # @!method management_console
     # Retrieve information about the management console.
@@ -85,20 +71,20 @@ module IbmPowerHmc
     def management_console
       method_url = "/rest/api/uom/ManagementConsole"
       response = request(:get, method_url)
-      doc = REXML::Document.new(response.body)
       # This request returns a feed with a single entry.
-      parse_feed(doc, ManagementConsole).first
+      FeedParser.new(response.body).objects(:ManagementConsole).first
     end
 
     ##
-    # @!method managed_systems
+    # @!method managed_systems(search = {})
     # Retrieve the list of systems managed by the HMC.
+    # @param search [Hash] The optional property name and value to match.
     # @return [Array<IbmPowerHmc::ManagedSystem>] The list of managed systems.
-    def managed_systems
+    def managed_systems(search = {})
       method_url = "/rest/api/uom/ManagedSystem"
+      search.each { |key, value| method_url += "/search/(#{key}==#{value})" }
       response = request(:get, method_url)
-      doc = REXML::Document.new(response.body)
-      parse_feed(doc, ManagedSystem)
+      FeedParser.new(response.body).objects(:ManagedSystem)
     end
 
     ##
@@ -106,31 +92,30 @@ module IbmPowerHmc
     # Retrieve information about a managed system.
     # @param sys_uuid [String] The UUID of the managed system.
     # @param group_name [String] The extended group attributes.
-    # @return [IbmPowerHmc::ManagedSystem] The logical partition.
+    # @return [IbmPowerHmc::ManagedSystem] The managed system.
     def managed_system(sys_uuid, group_name = nil)
       method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}"
       method_url += "?group=#{group_name}" unless group_name.nil?
 
       response = request(:get, method_url)
-      doc = REXML::Document.new(response.body)
-      entry = doc.elements["entry"]
-      ManagedSystem.new(entry)
+      Parser.new(response.body).object(:ManagedSystem)
     end
 
     ##
-    # @!method lpars(sys_uuid = nil)
+    # @!method lpars(sys_uuid = nil, search = {})
     # Retrieve the list of logical partitions managed by the HMC.
     # @param sys_uuid [String] The UUID of the managed system.
+    # @param search [Hash] The optional property name and value to match.
     # @return [Array<IbmPowerHmc::LogicalPartition>] The list of logical partitions.
-    def lpars(sys_uuid = nil)
+    def lpars(sys_uuid = nil, search = {})
       if sys_uuid.nil?
         method_url = "/rest/api/uom/LogicalPartition"
+        search.each { |key, value| method_url += "/search/(#{key}==#{value})" }
       else
         method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/LogicalPartition"
       end
       response = request(:get, method_url)
-      doc = REXML::Document.new(response.body)
-      parse_feed(doc, LogicalPartition)
+      FeedParser.new(response.body).objects(:LogicalPartition)
     end
 
     ##
@@ -149,15 +134,14 @@ module IbmPowerHmc
       method_url += "?group=#{group_name}" unless group_name.nil?
 
       response = request(:get, method_url)
-      doc = REXML::Document.new(response.body)
-      entry = doc.elements["entry"]
-      LogicalPartition.new(entry)
+      Parser.new(response.body).object(:LogicalPartition)
     end
 
     ##
     # @!method lpar_quick_property(lpar_uuid, property_name)
     # Retrieve a quick property of a logical partition.
     # @param lpar_uuid [String] The UUID of the logical partition.
+    # @param property_name [String] The quick property name.
     # @return [String] The quick property value.
     def lpar_quick_property(lpar_uuid, property_name)
       method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/quick/#{property_name}"
@@ -167,19 +151,35 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method vioses(sys_uuid = nil)
+    # @!method rename_lpar(lpar_uuid, newname)
+    # Rename a logical partition.
+    # @param lpar_uuid [String] The UUID of the logical partition.
+    # @param newname [String] The new name of the logical partition.
+    def rename_lpar(lpar_uuid, newname)
+      method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}"
+      headers = {
+        :content_type => "application/vnd.ibm.powervm.uom+xml; type=LogicalPartition",
+      }
+      modify_object(method_url, headers) do |lpar|
+        lpar.xml.elements["PartitionName"].text = newname
+      end
+    end
+
+    ##
+    # @!method vioses(sys_uuid = nil, search = {})
     # Retrieve the list of virtual I/O servers managed by the HMC.
     # @param sys_uuid [String] The UUID of the managed system.
+    # @param search [Hash] The optional property name and value to match.
     # @return [Array<IbmPowerHmc::VirtualIOServer>] The list of virtual I/O servers.
-    def vioses(sys_uuid = nil)
+    def vioses(sys_uuid = nil, search = {})
       if sys_uuid.nil?
         method_url = "/rest/api/uom/VirtualIOServer"
+        search.each { |key, value| method_url += "/search/(#{key}==#{value})" }
       else
         method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualIOServer"
       end
       response = request(:get, method_url)
-      doc = REXML::Document.new(response.body)
-      parse_feed(doc, VirtualIOServer)
+      FeedParser.new(response.body).objects(:VirtualIOServer)
     end
 
     ##
@@ -198,9 +198,7 @@ module IbmPowerHmc
       method_url += "?group=#{group_name}" unless group_name.nil?
 
       response = request(:get, method_url)
-      doc = REXML::Document.new(response.body)
-      entry = doc.elements["entry"]
-      VirtualIOServer.new(entry)
+      Parser.new(response.body).object(:VirtualIOServer)
     end
 
     ##
@@ -293,6 +291,21 @@ module IbmPowerHmc
       job
     end
 
+    ##
+    # @!method remove_connection(hmc_uuid, sys_uuid, sync = true)
+    # Remove a managed system from the management console.
+    # @param hmc_uuid [String] The UUID of the management console.
+    # @param sys_uuid [String] The UUID of the managed system.
+    # @param sync [Boolean] Start the job and wait for its completion.
+    # @return [IbmPowerHmc::HmcJob] The HMC job.
+    def remove_connection(hmc_uuid, sys_uuid, sync = true)
+      method_url = "/rest/api/uom/ManagementConsole/#{hmc_uuid}/ManagedSystem/#{sys_uuid}/do/RemoveConnection"
+
+      job = HmcJob.new(self, method_url, "RemoveConnection", "ManagedSystem")
+      job.run if sync
+      job
+    end
+
     ##
     # @!method cli_run(hmc_uuid, cmd, sync = true)
     # Run a CLI command on the HMC as a job.
@@ -326,8 +339,7 @@ module IbmPowerHmc
         # No need to sleep as the HMC already waits a bit before returning 204
         break if response.code != 204 || !wait
       end
-      doc = REXML::Document.new(response.body)
-      parse_feed(doc, Event)
+      FeedParser.new(response.body).objects(:Event)
     end
 
     ##
@@ -356,10 +368,8 @@ module IbmPowerHmc
 
         # Try to parse body as an HttpErrorResponse
         unless err.response.nil?
-          doc = REXML::Document.new(err.response.body)
-          entry = doc.elements["entry"]
-          unless entry.nil?
-            resp = HttpErrorResponse.new(entry)
+          resp = Parser.new(err.response.body).object(:HttpErrorResponse)
+          unless resp.nil?
             @uri = resp.uri
             @reason = resp.reason
             @message = resp.message
@@ -368,7 +378,7 @@ module IbmPowerHmc
       end
 
       def to_s
-        "msg=#{@message} status=#{@status} reason=#{@reason} uri=#{@uri}"
+        "msg=\"#{@message}\" status=\"#{@status}\" reason=\"#{@reason}\" uri=#{@uri}"
       end
     end
 
@@ -386,7 +396,7 @@ module IbmPowerHmc
       # Check for relative URLs
       url = "https://#{@hostname}#{url}" if url.start_with?("/")
       begin
-        headers = headers.merge({"X-API-Session" => @api_session_token})
+        headers = headers.merge("X-API-Session" => @api_session_token)
         RestClient::Request.execute(
           :method => method,
           :url => url,
@@ -405,5 +415,27 @@ module IbmPowerHmc
         raise HttpError.new(e), "REST request failed"
       end
     end
+
+    private
+
+    def modify_object(method_url, headers = {}, attempts = 5)
+      while attempts > 0
+        response = request(:get, method_url)
+        obj = Parser.new(response.body).object
+
+        yield obj
+
+        # Use ETag to ensure object has not changed.
+        headers = headers.merge("If-Match" => obj.etag)
+        begin
+          request(:post, 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
   end
 end

data/lib/ibm_power_hmc/job.rb

@@ -24,7 +24,7 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method status
+    # @!method start
     # Start the job asynchronously.
     # @return [String] The ID of the job.
     def start
@@ -32,25 +32,22 @@ module IbmPowerHmc
         :content_type => "application/vnd.ibm.powervm.web+xml; type=JobRequest"
       }
       doc = REXML::Document.new("")
-      doc.add_element("JobRequest:JobRequest", {
-                        "xmlns:JobRequest" => "http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/",
-                        "xmlns" => "http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/",
-                        "schemaVersion" => "V1_1_0"
-                      })
-      op = doc.root.add_element("RequestedOperation", {"schemaVersion" => "V1_1_0"})
+      doc.add_element("JobRequest:JobRequest", "schemaVersion" => "V1_1_0")
+      doc.root.add_namespace("http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/")
+      doc.root.add_namespace("JobRequest", "http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/")
+      op = doc.root.add_element("RequestedOperation", "schemaVersion" => "V1_1_0")
       op.add_element("OperationName").text = @operation
       op.add_element("GroupName").text = @group
-      # Damien: ProgressType?
-      jobparams = doc.root.add_element("JobParameters", {"schemaVersion" => "V1_1_0"})
+
+      jobparams = doc.root.add_element("JobParameters", "schemaVersion" => "V1_1_0")
       @params.each do |key, value|
-        jobparam = jobparams.add_element("JobParameter", {"schemaVersion" => "V1_1_0"})
+        jobparam = jobparams.add_element("JobParameter", "schemaVersion" => "V1_1_0")
         jobparam.add_element("ParameterName").text = key
         jobparam.add_element("ParameterValue").text = value
       end
       response = @conn.request(:put, @method_url, headers, doc.to_s)
-      doc = REXML::Document.new(response.body)
-      info = doc.root.elements["content/JobResponse:JobResponse"]
-      @id = info.elements["JobID"].text
+      jobresp = Parser.new(response.body).object(:JobResponse)
+      @id = jobresp.id
     end
 
     # @return [Hash] The job results returned by the HMC.
@@ -68,20 +65,9 @@ module IbmPowerHmc
         :content_type => "application/vnd.ibm.powervm.web+xml; type=JobRequest"
       }
       response = @conn.request(:get, method_url, headers)
-      doc = REXML::Document.new(response.body)
-      info = doc.root.elements["content/JobResponse:JobResponse"]
-      status = info.elements["Status"].text
-      # Damien: also retrieve "ResponseException/Message"?
-
-      # Gather Job results returned by the HMC.
-      @results = {}
-      info.each_element("Results/JobParameter") do |result|
-        name = result.elements["ParameterName"].text.strip
-        value = result.elements["ParameterValue"].text.strip
-        @results[name] = value
-      end
-
-      status
+      jobresp = Parser.new(response.body).object(:JobResponse)
+      @results = jobresp.results
+      jobresp.status
     end
 
     ##
@@ -112,8 +98,7 @@ module IbmPowerHmc
     # @return [String] The status of the job.
     def run(timeout = 120, poll_interval = 0)
       start
-      status = wait(timeout, poll_interval)
-      status
+      wait(timeout, poll_interval)
     ensure
       delete if defined?(@id)
     end

data/lib/ibm_power_hmc/parser.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'uri'
+
+module IbmPowerHmc
+  # Parser for HMC feeds and entries.
+  class Parser
+    def initialize(body)
+      @doc = REXML::Document.new(body)
+    end
+
+    def entry
+      @doc.elements["entry"]
+    end
+
+    def object(filter_type = nil)
+      self.class.to_obj(entry, filter_type)
+    end
+
+    def self.to_obj(entry, filter_type = nil)
+      return if entry.nil?
+
+      content = entry.elements["content"]
+      return if content.nil?
+
+      type = content.attributes["type"]
+      return if type.nil?
+
+      type = type.split("=").last
+      return unless filter_type.nil? || filter_type.to_s == type
+
+      Module.const_get("IbmPowerHmc::#{type}").new(entry)
+    end
+  end
+
+  class FeedParser < Parser
+    def entries
+      objs = []
+      @doc.each_element("feed/entry") do |entry|
+        objs << yield(entry)
+      end
+      objs
+    end
+
+    def objects(filter_type = nil)
+      entries do |entry|
+        self.class.to_obj(entry, filter_type)
+      end.compact
+    end
+  end
+
+  private_constant :Parser
+  private_constant :FeedParser
+
+  # HMC generic XML entry
+  class AbstractRest
+    ATTRS = {}.freeze
+    attr_reader :uuid, :published, :etag, :xml
+
+    def initialize(doc)
+      @uuid = doc.elements["id"]&.text
+      @published = Time.xmlschema(doc.elements["published"]&.text)
+      @etag = doc.elements["etag:etag"]&.text&.strip
+      type = self.class.name.split("::").last
+      @xml = doc.elements["content/#{type}:#{type}"]
+      define_attrs(self.class::ATTRS)
+    end
+
+    def define_attr(varname, xpath)
+      value = text_element(xpath)
+      self.class.__send__(:attr_reader, varname)
+      instance_variable_set("@#{varname}", value)
+    end
+
+    def define_attrs(hash)
+      hash.each do |key, value|
+        define_attr(key, value)
+      end
+    end
+
+    def text_element(xpath)
+      xml.elements[xpath]&.text&.strip
+    end
+
+    def extract_uuid_from_href(href)
+      URI(href).path.split('/').last
+    end
+  end
+
+  # HMC information
+  class ManagementConsole < AbstractRest
+    ATTRS = {
+      :name => "ManagementConsoleName",
+      :build_level => "VersionInfo/BuildLevel",
+      :version => "BaseVersion"
+    }.freeze
+
+    def managed_systems_uuids
+      xml.get_elements("ManagedSystems/link").map do |link|
+        extract_uuid_from_href(link.attributes["href"])
+      end.compact
+    end
+  end
+
+  # Managed System information
+  class ManagedSystem < AbstractRest
+    ATTRS = {
+      :name => "SystemName",
+      :state => "State",
+      :hostname => "Hostname",
+      :ipaddr => "PrimaryIPAddress",
+      :fwversion => "SystemFirmware",
+      :memory => "AssociatedSystemMemoryConfiguration/InstalledSystemMemory",
+      :avail_mem => "AssociatedSystemMemoryConfiguration/CurrentAvailableSystemMemory",
+      :cpus => "AssociatedSystemProcessorConfiguration/InstalledSystemProcessorUnits",
+      :avail_cpus => "AssociatedSystemProcessorConfiguration/CurrentAvailableSystemProcessorUnits",
+      :mtype => "MachineTypeModelAndSerialNumber/MachineType",
+      :model => "MachineTypeModelAndSerialNumber/Model",
+      :serial => "MachineTypeModelAndSerialNumber/SerialNumber"
+    }.freeze
+
+    def lpars_uuids
+      xml.get_elements("AssociatedLogicalPartitions/link").map do |link|
+        extract_uuid_from_href(link.attributes["href"])
+      end.compact
+    end
+
+    def vioses_uuids
+      xml.get_elements("AssociatedVirtualIOServers/link").map do |link|
+        extract_uuid_from_href(link.attributes["href"])
+      end.compact
+    end
+  end
+
+  # Common class for LPAR and VIOS
+  class BasePartition < AbstractRest
+    ATTRS = {
+      :name => "PartitionName",
+      :id => "PartitionID",
+      :state => "PartitionState",
+      :type => "PartitionType",
+      :memory => "PartitionMemoryConfiguration/CurrentMemory",
+      :dedicated => "PartitionProcessorConfiguration/HasDedicatedProcessors",
+      :rmc_state => "ResourceMonitoringControlState",
+      :rmc_ipaddr => "ResourceMonitoringIPAddress",
+      :ref_code => "ReferenceCode"
+    }.freeze
+
+    def sys_uuid
+      sys_href = xml.elements["AssociatedManagedSystem"].attributes["href"]
+      extract_uuid_from_href(sys_href)
+    end
+  end
+
+  # Logical Partition information
+  class LogicalPartition < BasePartition
+  end
+
+  # VIOS information
+  class VirtualIOServer < BasePartition
+  end
+
+  # HMC Event
+  class Event < AbstractRest
+    ATTRS = {
+      :id     => "EventID",
+      :type   => "EventType",
+      :data   => "EventData",
+      :detail => "EventDetail"
+    }.freeze
+  end
+
+  # Error response from HMC
+  class HttpErrorResponse < AbstractRest
+    ATTRS = {
+      :status  => "HTTPStatus",
+      :uri     => "RequestURI",
+      :reason  => "ReasonCode",
+      :message => "Message"
+    }.freeze
+  end
+
+  # Job Response
+  class JobResponse < AbstractRest
+    ATTRS = {
+      :id      => "JobID",
+      :status  => "Status",
+      :message => "ResponseException/Message"
+    }.freeze
+
+    def results
+      results = {}
+      xml.each_element("Results/JobParameter") do |result|
+        name = result.elements["ParameterName"]&.text&.strip
+        value = result.elements["ParameterValue"]&.text&.strip
+        results[name] = value unless name.nil?
+      end
+      results
+    end
+  end
+end

data/lib/ibm_power_hmc/pcm.rb

@@ -5,26 +5,62 @@ require 'uri'
 
 module IbmPowerHmc
   class Connection
+    def pcm_preferences
+      method_url = "/rest/api/pcm/preferences"
+
+      response = request(:get, method_url)
+      REXML::Document.new(response.body)
+    end
+
+    ##
+    # @!method phyp_metrics(sys_uuid:, start_ts: nil, end_ts: nil, short_term: false)
+    # Retrieve PowerVM metrics for a given managed system.
+    # @param sys_uuid [String] The managed system UUID.
+    # @param start_ts [Time] Start timestamp.
+    # @param end_ts [Time] End timestamp.
+    # @param short_term [Boolean] Retrieve short term monitor metrics (default to long term).
+    # @return [Array<Hash>] The PowerVM metrics for the managed system.
+    def phyp_metrics(sys_uuid:, start_ts: nil, end_ts: nil, short_term: false)
+      type = short_term ? "ShortTermMonitor" : "LongTermMonitor"
+      method_url = "/rest/api/pcm/ManagedSystem/#{sys_uuid}/RawMetrics/#{type}"
+      query = {}
+      query["StartTS"] = self.class.format_time(start_ts) unless start_ts.nil?
+      query["EndTS"] = self.class.format_time(end_ts) unless end_ts.nil?
+      method_url += "?" + query.map { |h| h.join("=") }.join("&") unless query.empty?
+
+      response = request(:get, method_url)
+      FeedParser.new(response.body).entries do |entry|
+        link = entry.elements["link"]
+        next if link.nil?
+
+        href = link.attributes["href"]
+        next if href.nil?
+
+        response = request(:get, href)
+        JSON.parse(response.body)
+      end.compact
+    end
+
     ##
-    # @!method managed_system_metrics(sys_uuid:, start_ts: nil, end_ts: nil, no_samples: nil)
+    # @!method managed_system_metrics(sys_uuid:, start_ts: nil, end_ts: nil, no_samples: nil, aggregated: false)
     # Retrieve metrics for a managed system.
     # @param sys_uuid [String] The managed system UUID.
-    # @param start_ts [String] Start timestamp.
-    # @param end_ts [String] End timestamp.
+    # @param start_ts [Time] Start timestamp.
+    # @param end_ts [Time] End timestamp.
     # @param no_samples [Integer] Number of samples.
-    # @return [Array<Hash>] The processed metrics for the managed system.
-    def managed_system_metrics(sys_uuid:, start_ts: nil, end_ts: nil, no_samples: nil)
-      method_url = "/rest/api/pcm/ManagedSystem/#{sys_uuid}/ProcessedMetrics"
-      query = []
-      query << "StartTS=#{start_ts}" unless start_ts.nil?
-      query << "EndTS=#{end_ts}" unless end_ts.nil?
-      query << "NoOfSamples=#{no_samples}" unless no_samples.nil?
-      method_url += "?" + query.compact.join('&') unless query.empty?
+    # @param aggregated [Boolean] Retrieve aggregated metrics (default to Processed).
+    # @return [Array<Hash>] The metrics for the managed system.
+    def managed_system_metrics(sys_uuid:, start_ts: nil, end_ts: nil, no_samples: nil, aggregated: false)
+      type = aggregated ? "AggregatedMetrics" : "ProcessedMetrics"
+      method_url = "/rest/api/pcm/ManagedSystem/#{sys_uuid}/#{type}"
+      query = {}
+      query["StartTS"] = self.class.format_time(start_ts) unless start_ts.nil?
+      query["EndTS"] = self.class.format_time(end_ts) unless end_ts.nil?
+      query["NoOfSamples"] = no_samples unless no_samples.nil?
+      method_url += "?" + query.map { |h| h.join("=") }.join("&") unless query.empty?
 
       response = request(:get, method_url)
-      doc = REXML::Document.new(response.body)
-      metrics = []
-      doc.each_element("feed/entry") do |entry|
+      FeedParser.new(response.body).entries do |entry|
         category = entry.elements["category"]
         next if category.nil?
 
@@ -37,10 +73,50 @@ module IbmPowerHmc
         href = link.attributes["href"]
         next if href.nil?
 
-        response = request(:get, href.to_s)
-        metrics << JSON.parse(response.body)
-      end
-      metrics
+        response = request(:get, href)
+        JSON.parse(response.body)
+      end.compact
+    end
+
+    ##
+    # @!method lpar_metrics(sys_uuid:, lpar_uuid:, start_ts: nil, end_ts: nil, no_samples: nil, aggregated: false)
+    # Retrieve metrics for a logical partition.
+    # @param sys_uuid [String] The managed system UUID.
+    # @param lpar_uuid [String] The logical partition UUID.
+    # @param start_ts [Time] Start timestamp.
+    # @param end_ts [Time] End timestamp.
+    # @param no_samples [Integer] Number of samples.
+    # @param aggregated [Boolean] Retrieve aggregated metrics (default to Processed).
+    # @return [Array<Hash>] The metrics for the logical partition.
+    def lpar_metrics(sys_uuid:, lpar_uuid:, start_ts: nil, end_ts: nil, no_samples: nil, aggregated: false)
+      type = aggregated ? "AggregatedMetrics" : "ProcessedMetrics"
+      method_url = "/rest/api/pcm/ManagedSystem/#{sys_uuid}/LogicalPartition/#{lpar_uuid}/#{type}"
+      query = {}
+      query["StartTS"] = self.class.format_time(start_ts) unless start_ts.nil?
+      query["EndTS"] = self.class.format_time(end_ts) unless end_ts.nil?
+      query["NoOfSamples"] = no_samples unless no_samples.nil?
+      method_url += "?" + query.map { |h| h.join("=") }.join("&") unless query.empty?
+
+      response = request(:get, method_url)
+      FeedParser(response.body).entries do |entry|
+        link = entry.elements["link"]
+        next if link.nil?
+
+        href = link.attributes["href"]
+        next if href.nil?
+
+        response = request(:get, href)
+        JSON.parse(response.body)
+      end.compact
+    end
+
+    ##
+    # @!method format_time(time)
+    # Convert ruby time to HMC time format.
+    # @param time [Time] The ruby time to convert.
+    # @return [String] The time in HMC format.
+    def self.format_time(time)
+      time.utc.xmlschema
     end
   end
 end

data/lib/ibm_power_hmc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IbmPowerHmc
-  VERSION = "0.1.2"
+  VERSION = "0.2.1"
 end

data/lib/ibm_power_hmc.rb

@@ -7,7 +7,8 @@ require "ibm_power_hmc/version"
 
 # Module for IBM HMC Rest API Client
 module IbmPowerHmc
-  require_relative "./ibm_power_hmc/objects.rb"
+  require_relative "./ibm_power_hmc/parser.rb"
   require_relative "./ibm_power_hmc/job.rb"
   require_relative "./ibm_power_hmc/connection.rb"
+  require_relative "./ibm_power_hmc/pcm.rb"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_power_hmc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - IBM Power
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 description: A Ruby gem for interacting with the IBM Hardware Management Console (HMC).
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -45,7 +45,7 @@ files:
 - lib/ibm_power_hmc.rb
 - lib/ibm_power_hmc/connection.rb
 - lib/ibm_power_hmc/job.rb
-- lib/ibm_power_hmc/objects.rb
+- lib/ibm_power_hmc/parser.rb
 - lib/ibm_power_hmc/pcm.rb
 - lib/ibm_power_hmc/version.rb
 homepage: http://github.com/IBM/ibm_power_hmc_sdk_ruby
@@ -56,7 +56,7 @@ metadata:
   homepage_uri: http://github.com/IBM/ibm_power_hmc_sdk_ruby
   source_code_uri: http://github.com/IBM/ibm_power_hmc_sdk_ruby
   changelog_uri: http://github.com/IBM/ibm_power_hmc_sdk_ruby/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -71,8 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: IBM Power HMC Ruby gem.
 test_files: []

data/lib/ibm_power_hmc/objects.rb

@@ -1,150 +0,0 @@
-# frozen_string_literal: true
-
-require 'uri'
-
-# Module for IBM HMC Rest API Client
-module IbmPowerHmc
-  # HMC generic object
-  class HmcObject
-    attr_reader :uuid, :xml
-
-    def initialize(doc)
-      @uuid = doc.elements["id"].text
-      @xml = doc
-    end
-
-    def get_value(doc, xpath, varname)
-      value = doc.elements[xpath]
-      value = value.text unless value.nil?
-      value = value.strip unless value.nil?
-      self.class.__send__(:attr_reader, varname)
-      instance_variable_set("@#{varname}", value)
-    end
-
-    def get_values(doc, hash)
-      hash.each do |key, value|
-        get_value(doc, key, value)
-      end
-    end
-  end
-
-  # HMC information
-  class ManagementConsole < HmcObject
-    XMLMAP = {
-      "ManagementConsoleName" => "name",
-      "VersionInfo/BuildLevel" => "build_level",
-      "BaseVersion" => "version"
-    }.freeze
-
-    def initialize(doc)
-      super(doc)
-      info = doc.elements["content/ManagementConsole:ManagementConsole"]
-      get_values(info, XMLMAP)
-    end
-  end
-
-  # Managed System information
-  class ManagedSystem < HmcObject
-    XMLMAP = {
-      "SystemName" => "name",
-      "State" => "state",
-      "Hostname" => "hostname",
-      "PrimaryIPAddress" => "ipaddr",
-      "SystemFirmware" => "fwversion",
-      "AssociatedSystemMemoryConfiguration/InstalledSystemMemory" => "memory",
-      "AssociatedSystemMemoryConfiguration/CurrentAvailableSystemMemory" => "avail_mem",
-      "AssociatedSystemProcessorConfiguration/InstalledSystemProcessorUnits" => "cpus",
-      "AssociatedSystemProcessorConfiguration/CurrentAvailableSystemProcessorUnits" => "avail_cpus",
-      "MachineTypeModelAndSerialNumber/MachineType" => "mtype",
-      "MachineTypeModelAndSerialNumber/Model" => "model",
-      "MachineTypeModelAndSerialNumber/SerialNumber" => "serial",
-    }.freeze
-
-    def initialize(doc)
-      super(doc)
-      info = doc.elements["content/ManagedSystem:ManagedSystem"]
-      get_values(info, XMLMAP)
-    end
-  end
-
-  # Logical Partition information
-  class LogicalPartition < HmcObject
-    attr_reader :sys_uuid
-
-    XMLMAP = {
-      "PartitionName" => "name",
-      "PartitionID" => "id",
-      "PartitionState" => "state",
-      "PartitionType" => "type",
-      "PartitionMemoryConfiguration/CurrentMemory" => "memory",
-      "PartitionProcessorConfiguration/HasDedicatedProcessors" => "dedicated",
-      "ResourceMonitoringControlState" => "rmc_state",
-      "ResourceMonitoringIPAddress" => "rmc_ipaddr"
-    }.freeze
-
-    def initialize(doc)
-      super(doc)
-      info = doc.elements["content/LogicalPartition:LogicalPartition"]
-      sys_href = info.elements["AssociatedManagedSystem"].attributes["href"]
-      @sys_uuid = URI(sys_href).path.split('/').last
-      get_values(info, XMLMAP)
-    end
-  end
-
-  # VIOS information
-  class VirtualIOServer < HmcObject
-    attr_reader :sys_uuid
-
-    XMLMAP = {
-      "PartitionName" => "name",
-      "PartitionID" => "id",
-      "PartitionState" => "state",
-      "PartitionType" => "type",
-      "PartitionMemoryConfiguration/CurrentMemory" => "memory",
-      "PartitionProcessorConfiguration/HasDedicatedProcessors" => "dedicated"
-    }.freeze
-
-    def initialize(doc)
-      super(doc)
-      info = doc.elements["content/VirtualIOServer:VirtualIOServer"]
-      sys_href = info.elements["AssociatedManagedSystem"].attributes["href"]
-      @sys_uuid = URI(sys_href).path.split('/').last
-      get_values(info, XMLMAP)
-    end
-  end
-
-  # HMC Event
-  class Event < HmcObject
-    attr_reader :published
-
-    XMLMAP = {
-      "EventID" => "id",
-      "EventType" => "type",
-      "EventData" => "data",
-      "EventDetail" => "detail",
-    }.freeze
-
-    def initialize(doc)
-      super(doc)
-      @published = doc.elements["published"].text
-      info = doc.elements["content/Event:Event"]
-      get_values(info, XMLMAP)
-    end
-  end
-
-  # Error response from HMC
-  class HttpErrorResponse < HmcObject
-    XMLMAP = {
-      "HTTPStatus" => "status",
-      "RequestURI" => "uri",
-      "ReasonCode" => "reason",
-      "Message" => "message",
-    }.freeze
-
-    def initialize(doc)
-      super(doc)
-      info = doc.elements["content/HttpErrorResponse:HttpErrorResponse"]
-      get_values(info, XMLMAP)
-    end
-  end
-end