ibm_power_hmc 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c19305b95374164ab2a6e6168a4a292ea0666065cbcbe8f05dea30483b622055
-  data.tar.gz: be50d67e7c462cc17f20be3f643c6029e4f2ba7d43f872f1821bbe428f0e11fe
+  metadata.gz: caf9b3a9dcb79bb47bbe628afda5c77ecf94ec6627dc469b8e1a2f564196c8a3
+  data.tar.gz: 031cf0f7f98a8800203281e6d7b27b83adce11651363ac3ce01d06d8c9a69865
 SHA512:
-  metadata.gz: 1191f64dd2f5c550d25a372b4a0502dd4e7b5a8e779a2dacdf079a22f3a8b8092af6e4ddff514b0e06dddf8239985033034959e385f951f2f535f092866cbd12
-  data.tar.gz: d6af992547d99624f59e6eb5ec3404768c91d1b9c9809e9542966fee15b4a350e8b8803e6fd25a597c48699b630171b7cae8327108f0ec6616e2329c5441bf1c
+  metadata.gz: 305a5f34bb64be2962d639b38df77fed119de4bb4800db6c0c3d0343af5ac04b336020d3ad0c58a91176ed8601d45a06ab0c6e439592accb5759a7e6924739d2
+  data.tar.gz: 40e6fa63028817a280c26d75a7e0777cb3da60a801ec9dc742fa99405da1fb23343bc79e4b2d81ea145047a6ed1ad06ce72dd681bdc544a685b672a3b92b1805

data/README.md

@@ -52,9 +52,9 @@ Listing the logical partitions and virtual I/O servers of each managed system:
 
 ```ruby
 hc.managed_systems.each do |sys|
-  puts sys
-  puts hc.lpars(sys.uuid)
-  puts hc.vioses(sys.uuid)
+  puts sys.name
+  hc.lpars(sys.uuid).each { |lpar| puts lpar.name }
+  hc.vioses(sys.uuid).each { |vios| puts vios.name }
 end
 ```
 
@@ -73,9 +73,9 @@ hc.poweroff_lpar(lpar_uuid, { "operation" => "shutdown" })
 Processing events:
 
 ```ruby
-loop
+loop do
   hc.next_events.each do |event|
-    puts event
+    puts event.type
   end
 end
 ```

data/lib/ibm_power_hmc/connection.rb

@@ -157,7 +157,6 @@ module IbmPowerHmc
     # @param new_name [String] The new name of the logical partition.
     def rename_lpar(lpar_uuid, new_name)
       method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}"
-
       modify_object(method_url) { |lpar| lpar.name = new_name }
     end
 
@@ -197,12 +196,58 @@ module IbmPowerHmc
       Parser.new(response.body).object(:VirtualIOServer)
     end
 
+    ##
+    # @!method virtual_switches(sys_uuid)
+    # Retrieve the list of virtual switches from a specified managed system.
+    # @param sys_uuid [String] The UUID of the managed system.
+    # @return [Array<IbmPowerHmc::VirtualSwitch>] The list of virtual switches.
+    def virtual_switches(sys_uuid)
+      method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualSwitch"
+      response = request(:get, method_url)
+      FeedParser.new(response.body).objects(:VirtualSwitch)
+    end
+
+    ##
+    # @!method virtual_switch(vswitch_uuid, sys_uuid)
+    # Retrieve information about a virtual switch.
+    # @param vswitch_uuid [String] The UUID of the virtual switch.
+    # @param sys_uuid [String] The UUID of the managed system.
+    # @return [IbmPowerHmc::VirtualSwitch] The virtual switch.
+    def virtual_switch(vswitch_uuid, sys_uuid)
+      method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualSwitch/#{vswitch_uuid}"
+      response = request(:get, method_url)
+      Parser.new(response.body).object(:VirtualSwitch)
+    end
+
+    ##
+    # @!method virtual_networks(sys_uuid)
+    # Retrieve the list of virtual networks from a specified managed system.
+    # @param sys_uuid [String] The UUID of the managed system.
+    # @return [Array<IbmPowerHmc::VirtualNetwork>] The list of virtual networks.
+    def virtual_networks(sys_uuid)
+      method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualNetwork"
+      response = request(:get, method_url)
+      FeedParser.new(response.body).objects(:VirtualNetwork)
+    end
+
+    ##
+    # @!method virtual_network(vnet_uuid, sys_uuid)
+    # Retrieve information about a virtual network.
+    # @param vnet_uuid [String] The UUID of the virtual network.
+    # @param sys_uuid [String] The UUID of the managed system.
+    # @return [IbmPowerHmc::VirtualNetwork] The virtual network.
+    def virtual_network(vnet_uuid, sys_uuid)
+      method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualNetwork/#{vnet_uuid}"
+      response = request(:get, method_url)
+      Parser.new(response.body).object(:VirtualNetwork)
+    end
+
     ##
     # @!method network_adapter_lpar(lpar_uuid, netadap_uuid = nil)
     # Retrieve one or all virtual ethernet network adapters attached to a logical partition.
     # @param lpar_uuid [String] UUID of the logical partition.
     # @param netadap_uuid [String] UUID of the adapter to match (returns all adapters if omitted).
-    # @return [Array<IbmPowerHmc::ClientNetworkAdapter>] The list of network adapters.
+    # @return [Array<IbmPowerHmc::ClientNetworkAdapter>, IbmPowerHmc::ClientNetworkAdapter] The list of network adapters.
     def network_adapter_lpar(lpar_uuid, netadap_uuid = nil)
       network_adapter("LogicalPartition", lpar_uuid, netadap_uuid)
     end
@@ -212,11 +257,176 @@ module IbmPowerHmc
     # Retrieve one or all virtual ethernet network adapters attached to a Virtual I/O Server.
     # @param vios_uuid [String] UUID of the Virtual I/O Server.
     # @param netadap_uuid [String] UUID of the adapter to match (returns all adapters if omitted).
-    # @return [Array<IbmPowerHmc::ClientNetworkAdapter>] The list of network adapters.
+    # @return [Array<IbmPowerHmc::ClientNetworkAdapter>, IbmPowerHmc::ClientNetworkAdapter] The list of network adapters.
     def network_adapter_vios(vios_uuid, netadap_uuid = nil)
       network_adapter("VirtualIOServer", vios_uuid, netadap_uuid)
     end
 
+    ##
+    # @!method sriov_elp_lpar(lpar_uuid, sriov_elp_uuid = nil)
+    # Retrieve one or all SR-IOV ethernet logical ports attached to a logical partition.
+    # @param lpar_uuid [String] UUID of the logical partition.
+    # @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)
+    end
+
+    ##
+    # @!method network_adapter_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)
+    end
+
+    ##
+    # @!method vnic_dedicated(lpar_uuid, vnic_uuid = nil)
+    # Retrieve one or all dedicated virtual network interface controller (vNIC) attached to a logical partition.
+    # @param lpar_uuid [String] UUID of the logical partition.
+    # @param vnic_uuid [String] UUID of the vNIC to match (returns all vNICs if omitted).
+    # @return [Array<IbmPowerHmc::VirtualNICDedicated>, IbmPowerHmc::VirtualNICDedicated] The list of vNICs.
+    def vnic_dedicated(lpar_uuid, vnic_uuid = nil)
+      if vnic_uuid.nil?
+        method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/VirtualNICDedicated"
+        response = request(:get, method_url)
+        FeedParser.new(response.body).objects(:VirtualNICDedicated)
+      else
+        method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/VirtualNICDedicated/#{vnic_uuid}"
+        response = request(:get, method_url)
+        Parser.new(response.body).object(:VirtualNICDedicated)
+      end
+    end
+
+    ##
+    # @!method clusters
+    # Retrieve the list of clusters managed by the HMC.
+    # @return [Array<IbmPowerHmc::Cluster>] The list of clusters.
+    def clusters
+      method_url = "/rest/api/uom/Cluster"
+      response = request(:get, method_url)
+      FeedParser.new(response.body).objects(:Cluster)
+    end
+
+    ##
+    # @!method cluster(cl_uuid)
+    # Retrieve information about a cluster.
+    # @param cl_uuid [String] The UUID of the cluster.
+    # @return [IbmPowerHmc::Cluster] The cluster.
+    def cluster(cl_uuid)
+      method_url = "/rest/api/uom/Cluster/#{cl_uuid}"
+      response = request(:get, method_url)
+      Parser.new(response.body).object(:Cluster)
+    end
+
+    ##
+    # @!method ssps
+    # Retrieve the list of shared storage pools managed by the HMC.
+    # @return [Array<IbmPowerHmc::SharedStoragePool>] The list of shared storage pools.
+    def ssps
+      method_url = "/rest/api/uom/SharedStoragePool"
+      response = request(:get, method_url)
+      FeedParser.new(response.body).objects(:SharedStoragePool)
+    end
+
+    ##
+    # @!method ssp(ssp_uuid)
+    # Retrieve information about a shared storage pool.
+    # @param ssp_uuid [String] The UUID of the shared storage pool.
+    # @return [IbmPowerHmc::SharedStoragePool] The shared storage pool.
+    def ssp(ssp_uuid)
+      method_url = "/rest/api/uom/SharedStoragePool/#{ssp_uuid}"
+      response = request(:get, method_url)
+      Parser.new(response.body).object(:SharedStoragePool)
+    end
+
+    ##
+    # @!method tiers(group_name = nil)
+    # Retrieve the list of tiers that are part of shared storage pools managed by the HMC.
+    # @param group_name [String] The extended group attributes.
+    # @return [Array<IbmPowerHmc::Tier>] The list of tiers.
+    def tiers(group_name = nil)
+      method_url = "/rest/api/uom/Tier"
+      method_url += "?group=#{group_name}" unless group_name.nil?
+      response = request(:get, method_url)
+      FeedParser.new(response.body).objects(:Tier)
+    end
+
+    ##
+    # @!method tier(tier_uuid, ssp_uuid = nil, group_name = nil)
+    # Retrieve information about a tier.
+    # @param tier_uuid [String] The UUID of the tier.
+    # @param ssp_uuid [String] The UUID of the shared storage pool.
+    # @param group_name [String] The extended group attributes.
+    # @return [IbmPowerHmc::Tier] The tier.
+    def tier(tier_uuid, ssp_uuid = nil, group_name = nil)
+      if ssp_uuid.nil?
+        method_url = "/rest/api/uom/Tier/#{tier_uuid}"
+      else
+        method_url = "/rest/api/uom/SharedStoragePool/#{ssp_uuid}/Tier/#{tier_uuid}"
+      end
+      method_url += "?group=#{group_name}" unless group_name.nil?
+
+      response = request(:get, method_url)
+      Parser.new(response.body).object(:Tier)
+    end
+
+    ##
+    # @!method templates_summary
+    # Retrieve the list of partition template summaries.
+    # @return [Array<IbmPowerHmc::PartitionTemplateSummary>] The list of partition template summaries.
+    def templates_summary
+      method_url = "/rest/api/templates/PartitionTemplate"
+      response = request(:get, method_url)
+      FeedParser.new(response.body).objects(:PartitionTemplateSummary)
+    end
+
+    ##
+    # @!method templates
+    # Retrieve the list of partition templates.
+    # @return [Array<IbmPowerHmc::PartitionTemplate>] The list of partition templates.
+    def templates
+      method_url = "/rest/api/templates/PartitionTemplate?detail=full"
+      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 poweron_lpar(lpar_uuid, params = {}, sync = true)
     # Power on a logical partition.
@@ -335,29 +545,6 @@ module IbmPowerHmc
       job
     end
 
-    ##
-    # @!method virtual_switches(sys_uuid)
-    # Retrieve the list of virtual switches from a specified managed system.
-    # @param sys_uuid [String] The UUID of the managed system.
-    # @return [Array<IbmPowerHmc::VirtualSwitch>] The list of virtual switches.
-    def virtual_switches(sys_uuid)
-      method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualSwitch"
-      response = request(:get, method_url)
-      FeedParser.new(response.body).objects(:VirtualSwitch)
-    end
-
-    ##
-    # @!method virtual_switch(vswitch_uuid, sys_uuid)
-    # Retrieve information about a virtual switch.
-    # @param vswitch_uuid [String] The UUID of the virtual switch.
-    # @param sys_uuid [String] The UUID of the managed system.
-    # @return [IbmPowerHmc::VirtualSwitch] The virtual switch.
-    def virtual_switch(vswitch_uuid, sys_uuid)
-      method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualSwitch/#{vswitch_uuid}"
-      response = request(:get, method_url)
-      Parser.new(response.body).object(:VirtualSwitch)
-    end
-
     ##
     # @!method next_events(wait = true)
     # Retrieve a list of events that occured since last call.
@@ -372,7 +559,31 @@ module IbmPowerHmc
         # No need to sleep as the HMC already waits a bit before returning 204
         break if response.code != 204 || !wait
       end
-      FeedParser.new(response.body).objects(:Event)
+      FeedParser.new(response.body).objects(:Event).map do |e|
+        data = e.data.split("/")
+        if data[-2].eql?("UserTask")
+          e.usertask = usertask(data.last)
+        end
+        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.select { |t| t.name.eql?(j['labelParams'].first) }.first&.uuid
+        end
+      end
+      j
     end
 
     ##
@@ -479,21 +690,41 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method network_adapter_lpar(lpar_uuid, netadap_uuid = nil)
+    # @!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] "Logical Partition" or "VirtualIOServer".
+    # @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>] The list of network adapters.
+    # @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
 
-      response = request(:get, method_url)
-      Parser.new(response.body).object(:ClientNetworkAdapter)
+    ##
+    # @!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

data/lib/ibm_power_hmc/job.rb

@@ -26,7 +26,7 @@ module IbmPowerHmc
     ##
     # @!method start
     # Start the job asynchronously.
-    # @return [String] The ID of the job.
+    # @return [String] The URL of the job.
     def start
       headers = {
         :content_type => "application/vnd.ibm.powervm.web+xml; type=JobRequest"
@@ -47,7 +47,8 @@ module IbmPowerHmc
       end
       response = @conn.request(:put, @method_url, headers, doc.to_s)
       jobresp = Parser.new(response.body).object(:JobResponse)
-      @id = jobresp.id
+      # Save the URL of the job (JobID is not sufficient as not all jobs are in uom).
+      @href = jobresp.href.path
     end
 
     # @return [Hash] The job results returned by the HMC.
@@ -58,13 +59,12 @@ module IbmPowerHmc
     # Return the status of the job.
     # @return [String] The status of the job.
     def status
-      raise JobNotStarted unless defined?(@id)
+      raise JobNotStarted unless defined?(@href)
 
-      method_url = "/rest/api/uom/jobs/#{@id}"
       headers = {
         :content_type => "application/vnd.ibm.powervm.web+xml; type=JobRequest"
       }
-      response = @conn.request(:get, method_url, headers)
+      response = @conn.request(:get, @href, headers)
       jobresp = Parser.new(response.body).object(:JobResponse)
       @results = jobresp.results
       jobresp.status
@@ -100,17 +100,16 @@ module IbmPowerHmc
       start
       wait(timeout, poll_interval)
     ensure
-      delete if defined?(@id)
+      delete if defined?(@href)
     end
 
     ##
     # @!method delete
     # Delete the job from the HMC.
     def delete
-      raise JobNotStarted unless defined?(@id)
+      raise JobNotStarted unless defined?(@href)
 
-      method_url = "/rest/api/uom/jobs/#{@id}"
-      @conn.request(:delete, method_url)
+      @conn.request(:delete, @href)
       # Returns HTTP 204 if ok
     end
   end

data/lib/ibm_power_hmc/parser.rb

@@ -78,39 +78,16 @@ module IbmPowerHmc
   private_constant :FeedParser
 
   ##
-  # HMC generic K2 XML entry.
-  # Encapsulate data for a single object.
-  # The XML looks like this:
-  # <entry>
-  #   <id>uuid</id>
-  #   <published>timestamp</published>
-  #   <etag:etag>ETag</etag:etag>
-  #   <content type="type">
-  #     <!-- actual content here -->
-  #   </content>
-  # </entry>
-  #
+  # HMC generic K2 non-REST object.
   # @abstract
-  # @attr_reader [String] uuid The UUID of the object contained in the entry.
-  # @attr_reader [URI::HTTPS] href The URL of the object itself.
-  # @attr_reader [Time] published The time at which the entry was published.
-  # @attr_reader [String] etag The entity tag of the entry.
-  # @attr_reader [String] content_type The content type of the object contained in the entry.
   # @attr_reader [REXML::Document] xml The XML document representing this object.
-  class AbstractRest
+  class AbstractNonRest
     ATTRS = {}.freeze
-    attr_reader :uuid, :href, :published, :etag, :content_type, :xml
+    attr_reader :xml
 
-    def initialize(doc)
-      @uuid = doc.elements["id"]&.text
-      link = doc.elements["link[@rel='SELF']"]
-      @href = URI(link.attributes["href"]) unless link.nil?
-      @published = Time.xmlschema(doc.elements["published"]&.text)
-      @etag = doc.elements["etag:etag"]&.text&.strip
-      content = doc.elements["content"]
-      @content_type = content.attributes["type"]
-      @xml = content.elements.first
-      define_attrs(self.class::ATTRS)
+    def initialize(xml)
+      @xml = xml
+      self.class::ATTRS.each { |varname, xpath| define_attr(varname, xpath) }
     end
 
     ##
@@ -123,17 +100,7 @@ module IbmPowerHmc
       self.class.__send__(:attr_reader, varname)
       instance_variable_set("@#{varname}", value)
     end
-
-    ##
-    # @!method define_attrs(hash)
-    # Define instance variables using the texts of XML elements as values.
-    # @param hash [Hash] The name of the instance variables and the XPaths
-    #   of the XML elements containing the values.
-    def define_attrs(hash)
-      hash.each do |key, value|
-        define_attr(key, value)
-      end
-    end
+    private :define_attr
 
     ##
     # @!method singleton(xpath, attr = nil)
@@ -149,8 +116,72 @@ module IbmPowerHmc
       attr.nil? ? elem.text&.strip : elem.attributes[attr]
     end
 
-    def extract_uuid_from_href(href)
-      URI(href).path.split('/').last
+    def to_s
+      str = +"#{self.class.name}:\n"
+      self.class::ATTRS.each do |varname, _|
+        value = instance_variable_get("@#{varname}")
+        value = value.nil? ? "null" : "'#{value}'"
+        str << "  #{varname}: #{value}\n"
+      end
+      str
+    end
+
+    def uuid_from_href(href, index = -1)
+      URI(href).path.split('/')[index]
+    end
+
+    def uuids_from_links(elem, index = -1)
+      xml.get_elements("#{elem}/link[@href]").map do |link|
+        uuid_from_href(link.attributes["href"], index)
+      end.compact
+    end
+  end
+
+  ##
+  # HMC generic K2 REST object.
+  # Encapsulate data for a single REST object.
+  # The XML looks like this:
+  # <entry>
+  #   <id>uuid</id>
+  #   <published>timestamp</published>
+  #   <link rel="SELF" href="https://..."/>
+  #   <etag:etag>ETag</etag:etag>
+  #   <content type="type">
+  #     <!-- actual content here -->
+  #   </content>
+  # </entry>
+  #
+  # @abstract
+  # @attr_reader [String] uuid The UUID of the object contained in the entry.
+  # @attr_reader [Time] published The time at which the entry was published.
+  # @attr_reader [URI::HTTPS] href The URL of the object itself.
+  # @attr_reader [String] etag The entity tag of the entry.
+  # @attr_reader [String] content_type The content type of the object contained in the entry.
+  class AbstractRest < AbstractNonRest
+    attr_reader :uuid, :published, :href, :etag, :content_type
+
+    def initialize(entry)
+      if entry.name != "entry"
+        # We are inlined.
+        super(entry)
+        return
+      end
+
+      @uuid = entry.elements["id"]&.text
+      @published = Time.xmlschema(entry.elements["published"]&.text)
+      link = entry.elements["link[@rel='SELF']"]
+      @href = URI(link.attributes["href"]) unless link.nil?
+      @etag = entry.elements["etag:etag"]&.text&.strip
+      content = entry.elements["content"]
+      @content_type = content.attributes["type"]
+      super(content.elements.first)
+    end
+
+    def to_s
+      str = super
+      str << "  uuid: '#{uuid}'\n" if defined?(@uuid)
+      str << "  published: '#{published}'\n" if defined?(@published)
+      str
     end
   end
 
@@ -163,9 +194,7 @@ module IbmPowerHmc
     }.freeze
 
     def managed_systems_uuids
-      xml.get_elements("ManagedSystems/link").map do |link|
-        extract_uuid_from_href(link.attributes["href"])
-      end.compact
+      uuids_from_links("ManagedSystems")
     end
   end
 
@@ -183,22 +212,52 @@ module IbmPowerHmc
       :avail_cpus => "AssociatedSystemProcessorConfiguration/CurrentAvailableSystemProcessorUnits",
       :mtype => "MachineTypeModelAndSerialNumber/MachineType",
       :model => "MachineTypeModelAndSerialNumber/Model",
-      :serial => "MachineTypeModelAndSerialNumber/SerialNumber"
+      :serial => "MachineTypeModelAndSerialNumber/SerialNumber",
+      :vtpm_version => "AssociatedSystemSecurity/VirtualTrustedPlatformModuleVersion",
+      :vtpm_lpars => "AssociatedSystemSecurity/AvailableVirtualTrustedPlatformModulePartitions"
     }.freeze
 
-    def lpars_uuids
-      xml.get_elements("AssociatedLogicalPartitions/link").map do |link|
-        extract_uuid_from_href(link.attributes["href"])
+    def cpu_compat_modes
+      xml.get_elements("AssociatedSystemProcessorConfiguration/SupportedPartitionProcessorCompatibilityModes").map do |elem|
+        elem.text&.strip
       end.compact
     end
 
+    def lpars_uuids
+      uuids_from_links("AssociatedLogicalPartitions")
+    end
+
     def vioses_uuids
-      xml.get_elements("AssociatedVirtualIOServers/link").map do |link|
-        extract_uuid_from_href(link.attributes["href"])
-      end.compact
+      uuids_from_links("AssociatedVirtualIOServers")
+    end
+
+    def io_adapters
+      xml.get_elements("AssociatedSystemIOConfiguration/IOSlots/IOSlot/RelatedIOAdapter/IOAdapter").map do |elem|
+        IOAdapter.new(elem)
+      end
+    end
+
+    def vswitches_uuids
+      uuids_from_links("AssociatedSystemIOConfiguration/AssociatedSystemVirtualNetwork/VirtualSwitches")
+    end
+
+    def networks_uuids
+      uuids_from_links("AssociatedSystemIOConfiguration/AssociatedSystemVirtualNetwork/VirtualNetworks")
     end
   end
 
+  # I/O Adapter information
+  class IOAdapter < AbstractNonRest
+    ATTRS = {
+      :id => "AdapterID",
+      :description => "Description",
+      :name => "DeviceName",
+      :type => "DeviceType",
+      :dr_name => "DynamicReconfigurationConnectorName",
+      :udid => "UniqueDeviceID"
+    }.freeze
+  end
+
   # Common class for LPAR and VIOS
   class BasePartition < AbstractRest
     ATTRS = {
@@ -211,20 +270,33 @@ module IbmPowerHmc
       :rmc_state => "ResourceMonitoringControlState",
       :rmc_ipaddr => "ResourceMonitoringIPAddress",
       :os => "OperatingSystemVersion",
-      :ref_code => "ReferenceCode"
+      :ref_code => "ReferenceCode",
+      :procs => "PartitionProcessorConfiguration/CurrentDedicatedProcessorConfiguration/CurrentProcessors",
+      :proc_units => "PartitionProcessorConfiguration/CurrentSharedProcessorConfiguration/CurrentProcessingUnits",
+      :vprocs => "PartitionProcessorConfiguration/CurrentSharedProcessorConfiguration/AllocatedVirtualProcessors"
     }.freeze
 
     def sys_uuid
       sys_href = singleton("AssociatedManagedSystem", "href")
-      extract_uuid_from_href(sys_href)
+      uuid_from_href(sys_href)
     end
 
     def net_adap_uuids
-      xml.get_elements("ClientNetworkAdapters/link").map do |link|
-        extract_uuid_from_href(link.attributes["href"])
+      uuids_from_links("ClientNetworkAdapters")
+    end
+
+    def lhea_ports
+      xml.get_elements("HostEthernetAdapterLogicalPorts/HostEthernetAdapterLogicalPort").map do |elem|
+        HostEthernetAdapterLogicalPort.new(elem)
       end
     end
 
+    def sriov_elp_uuids
+      uuids_from_links("SRIOVEthernetLogicalPorts")
+    end
+
+    # Setters
+
     def name=(name)
       xml.elements[ATTRS[:name]].text = name
       @name = name
@@ -233,27 +305,527 @@ module IbmPowerHmc
 
   # Logical Partition information
   class LogicalPartition < BasePartition
+    def vnic_dedicated_uuids
+      uuids_from_links("DedicatedVirtualNICs")
+    end
+
+    def vscsi_client_uuids
+      uuids_from_links("VirtualSCSIClientAdapters")
+    end
+
+    def vfc_client_uuids
+      uuids_from_links("VirtualFibreChannelClientAdapters")
+    end
   end
 
   # VIOS information
   class VirtualIOServer < BasePartition
+    def pvs
+      xml.get_elements("PhysicalVolumes/PhysicalVolume").map do |elem|
+        PhysicalVolume.new(elem)
+      end
+    end
+
+    def rep
+      elem = xml.elements["MediaRepositories/VirtualMediaRepository"]
+      VirtualMediaRepository.new(elem) unless elem.nil?
+    end
+
+    def vscsi_mappings
+      xml.get_elements("VirtualSCSIMappings/VirtualSCSIMapping").map do |elem|
+        VirtualSCSIMapping.new(elem)
+      end
+    end
+
+    def vfc_mappings
+      xml.get_elements("VirtualFibreChannelMappings/VirtualFibreChannelMapping").map do |elem|
+        VirtualFibreChannelMapping.new(elem)
+      end
+    end
+  end
+
+  # Empty parent class to match K2 schema definition
+  class VirtualSCSIStorage < AbstractNonRest; end
+
+  # Physical Volume information
+  class PhysicalVolume < VirtualSCSIStorage
+    ATTRS = {
+      :location => "LocationCode",
+      :description => "Description",
+      :is_available => "AvailableForUsage",
+      :capacity => "VolumeCapacity",
+      :name => "VolumeName",
+      :is_fc => "IsFibreChannelBacked",
+      :udid => "VolumeUniqueID"
+    }.freeze
+  end
+
+  # Logical Volume information
+  class VirtualDisk < VirtualSCSIStorage
+    ATTRS = {
+      :name => "DiskName",
+      :label => "DiskLabel",
+      :capacity => "DiskCapacity", # In GiB
+      :psize => "PartitionSize",
+      :vg => "VolumeGroup",
+      :udid => "UniqueDeviceID"
+    }.freeze
+  end
+
+  # Virtual CD-ROM information
+  class VirtualOpticalMedia < VirtualSCSIStorage
+    ATTRS = {
+      :name => "MediaName",
+      :udid => "MediaUDID",
+      :mount_opts => "MountType",
+      :size => "Size" # in GiB
+    }.freeze
+  end
+
+  # Virtual Media Repository information
+  class VirtualMediaRepository < AbstractNonRest
+    ATTRS = {
+      :name => "RepositoryName",
+      :size => "RepositorySize" # in GiB
+    }.freeze
+
+    def vopts
+      xml.get_elements("OpticalMedia/VirtualOpticalMedia").map do |elem|
+        VirtualOpticalMedia.new(elem)
+      end
+    end
   end
 
   # Virtual Switch information
   class VirtualSwitch < AbstractRest
     ATTRS = {
       :id   => "SwitchID",
-      :mode => "SwitchMode",
+      :mode => "SwitchMode", # "VEB", "VEPA"
       :name => "SwitchName"
     }.freeze
 
     def sys_uuid
       href.path.split('/')[-3]
     end
+
+    def networks_uuids
+      uuids_from_links("VirtualNetworks")
+    end
+  end
+
+  # Virtual Network information
+  class VirtualNetwork < AbstractRest
+    ATTRS = {
+      :name       => "NetworkName",
+      :vlan_id    => "NetworkVLANID",
+      :vswitch_id => "VswitchID",
+      :tagged     => "TaggedNetwork"
+    }.freeze
+
+    def vswitch_uuid
+      href = singleton("AssociatedSwitch", "href")
+      uuid_from_href(href)
+    end
+
+    def lpars_uuids
+      uuids_from_links("ConnectedPartitions")
+    end
+  end
+
+  # Virtual I/O Adapter information
+  class VirtualIOAdapter < AbstractRest
+    ATTRS = {
+      :type     => "AdapterType", # "Server", "Client", "Unknown"
+      :location => "LocationCode",
+      :slot     => "VirtualSlotNumber",
+      :required => "RequiredAdapter"
+    }.freeze
+  end
+
+  # Virtual Ethernet Adapter information
+  class VirtualEthernetAdapter < VirtualIOAdapter
+    ATTRS = ATTRS.merge({
+      :macaddr    => "MACAddress",
+      :vswitch_id => "VirtualSwitchID",
+      :vlan_id    => "PortVLANID",
+      :location   => "LocationCode"
+    }.freeze)
+
+    def vswitch_uuid
+      uuids_from_links("AssociatedVirtualSwitch").first
+    end
+  end
+
+  # Client Network Adapter information
+  class ClientNetworkAdapter < VirtualEthernetAdapter
+    def networks_uuids
+      uuids_from_links("VirtualNetworks")
+    end
+  end
+
+  # LP-HEA information
+  class EthernetBackingDevice < IOAdapter; end
+  class HostEthernetAdapterLogicalPort < EthernetBackingDevice
+    ATTRS = ATTRS.merge({
+      :macaddr  => "MACAddress",
+      :port_id  => "LogicalPortID",
+      :state    => "PortState",
+      :location => "HEALogicalPortPhysicalLocation"
+    }.freeze)
+  end
+
+  # Virtual NIC dedicated information
+  class VirtualNICDedicated < VirtualIOAdapter
+    ATTRS = ATTRS.merge({
+      :location     => "DynamicReconfigurationConnectorName", # overrides VirtualIOAdapter
+      :macaddr      => "Details/MACAddress",
+      :os_devname   => "Details/OSDeviceName",
+      :port_vlan_id => "Details/PortVLANID"
+    }.freeze)
+  end
+
+  # SR-IOV Configured Logical Port information
+  class SRIOVConfiguredLogicalPort < AbstractRest
+    ATTRS = {
+      :port_id      => "LogicalPortID",
+      :port_vlan_id => "PortVLANID",
+      :location     => "LocationCode",
+      :dr_name      => "DynamicReconfigurationConnectorName",
+      :devname      => "DeviceName",
+      :capacity     => "ConfiguredCapacity"
+    }.freeze
+
+    def lpars_uuids
+      uuids_from_links("AssociatedLogicalPartitions")
+    end
+  end
+
+  # SR-IOV Ethernet Logical Port information
+  class SRIOVEthernetLogicalPort < SRIOVConfiguredLogicalPort
+    ATTRS = ATTRS.merge({
+      :macaddr => "MACAddress"
+    }.freeze)
+  end
+
+  # Virtual SCSI mapping information
+  class VirtualSCSIMapping < AbstractNonRest
+    def lpar_uuid
+      href = singleton("AssociatedLogicalPartition", "href")
+      uuid_from_href(href)
+    end
+
+    def client
+      elem = xml.elements["ClientAdapter"]
+      VirtualSCSIClientAdapter.new(elem) unless elem.nil?
+    end
+
+    def server
+      elem = xml.elements["ServerAdapter"]
+      VirtualSCSIServerAdapter.new(elem) unless elem.nil?
+    end
+
+    def storage
+      # Possible storage types are:
+      # LogicalUnit, PhysicalVolume, VirtualDisk, VirtualOpticalMedia
+      elem = xml.elements["Storage/*[1]"]
+      Module.const_get("IbmPowerHmc::#{elem.name}").new(elem) unless elem.nil?
+    end
+
+    def device
+      # Possible backing device types are:
+      # LogicalVolumeVirtualTargetDevice, PhysicalVolumeVirtualTargetDevice,
+      # SharedStoragePoolLogicalUnitVirtualTargetDevice, VirtualOpticalTargetDevice
+      elem = xml.elements["TargetDevice/*[1]"]
+      Module.const_get("IbmPowerHmc::#{elem.name}").new(elem) unless elem.nil?
+    end
+  end
+
+  # Virtual SCSI adapter (common class for Client and Server)
+  class VirtualSCSIAdapter < VirtualIOAdapter
+    ATTRS = ATTRS.merge({
+      :name => "AdapterName",
+      :backdev => "BackingDeviceName",
+      :remote_backdev => "RemoteBackingDeviceName",
+      :remote_lpar_id => "RemoteLogicalPartitionID",
+      :remote_slot => "RemoteSlotNumber",
+      :server_location => "ServerLocationCode",
+      :udid => "UniqueDeviceID"
+    }.freeze)
+  end
+
+  # Virtual SCSI client adapter information
+  class VirtualSCSIClientAdapter < VirtualSCSIAdapter
+    def server
+      elem = xml.elements["ServerAdapter"]
+      VirtualSCSIServerAdapter.new(elem) unless elem.nil?
+    end
+
+    def vios_uuid
+      href = singleton("ConnectingPartition", "href")
+      uuid_from_href(href)
+    end
+  end
+
+  # Virtual SCSI server adapter information
+  class VirtualSCSIServerAdapter < VirtualSCSIAdapter; end
+
+  # Virtual target device information
+  class VirtualTargetDevice < AbstractNonRest
+    ATTRS = {
+      :lun => "LogicalUnitAddress",
+      :parent => "ParentName",
+      :target => "TargetName",
+      :udid => "UniqueDeviceID"
+    }.freeze
+  end
+
+  # LV backing device information
+  class LogicalVolumeVirtualTargetDevice < VirtualTargetDevice; end
+
+  # PV backing device information
+  class PhysicalVolumeVirtualTargetDevice < VirtualTargetDevice; end
+
+  # LU backing device information
+  class SharedStoragePoolLogicalUnitVirtualTargetDevice < VirtualTargetDevice
+    ATTRS = ATTRS.merge({
+      :cluster_id => "ClusterID",
+      :path => "PathName",
+      :raid_level => "RAIDLevel"
+    }.freeze)
+  end
+
+  # Virtual CD backing device information
+  class VirtualOpticalTargetDevice < VirtualTargetDevice
+    def media
+      elem = xml.elements["VirtualOpticalMedia"]
+      VirtualOpticalMedia.new(elem) unless elem.nil?
+    end
+  end
+
+  # VFC mapping information
+  class VirtualFibreChannelMapping < AbstractNonRest
+    def lpar_uuid
+      href = singleton("AssociatedLogicalPartition", "href")
+      uuid_from_href(href)
+    end
+
+    def client
+      elem = xml.elements["ClientAdapter"]
+      VirtualFibreChannelClientAdapter.new(elem) unless elem.nil?
+    end
+
+    def server
+      elem = xml.elements["ServerAdapter"]
+      VirtualFibreChannelServerAdapter.new(elem) unless elem.nil?
+    end
+
+    def port
+      elem = xml.elements["Port"]
+      PhysicalFibreChannelPort.new(elem) unless elem.nil?
+    end
+  end
+
+  # VFC adapter information
+  class VirtualFibreChannelAdapter < VirtualIOAdapter
+    ATTRS = ATTRS.merge({
+      :name => "AdapterName",
+      :lpar_id => "ConnectingPartitionID",
+      :slot => "ConnectingVirtualSlotNumber",
+      :udid => "UniqueDeviceID"
+    }.freeze)
+
+    def lpar_uuid
+      href = singleton("ConnectingPartition", "href")
+      uuid_from_href(href)
+    end
+  end
+
+  # VFC client information
+  class VirtualFibreChannelClientAdapter < VirtualFibreChannelAdapter
+    def nport_loggedin
+      xml.get_elements("NportLoggedInStatus/VirtualFibreChannelNPortLoginStatus").map do |elem|
+        VirtualFibreChannelNPortLoginStatus.new(elem)
+      end
+    end
+
+    def server
+      elem = xml.elements["ServerAdapter"]
+      VirtualFibreChannelServerAdapter.new(elem) unless elem.nil?
+    end
+
+    def wwpns
+      singleton("WWPNs")&.split
+    end
+
+    def os_disks
+      xml.get_elements("OperatingSystemDisks/OperatingSystemDisk/Name").map do |elem|
+        elem.text&.strip
+      end.compact
+    end
+  end
+
+  # VFC port status
+  class VirtualFibreChannelNPortLoginStatus < AbstractNonRest
+    ATTRS = {
+      :wwpn => "WWPN",
+      :wwpn_status => "WWPNStatus",
+      :loggedin_by => "LoggedInBy",
+      :reason => "StatusReason"
+    }.freeze
+  end
+
+  # VFC server information
+  class VirtualFibreChannelServerAdapter < VirtualFibreChannelAdapter
+    ATTRS = ATTRS.merge({
+      :map_port => "MapPort"
+    }.freeze)
+
+    def port
+      elem = xml.elements["PhysicalPort"]
+      PhysicalFibreChannelPort.new(elem) unless elem.nil?
+    end
+  end
+
+  # FC port information
+  class PhysicalFibreChannelPort < AbstractNonRest
+    ATTRS = {
+      :location => "LocationCode",
+      :name => "PortName",
+      :udid => "UniqueDeviceID",
+      :wwpn => "WWPN",
+      :wwnn => "WWNN",
+      :avail_ports => "AvailablePorts",
+      :total_ports => "TotalPorts"
+    }.freeze
+
+    def pvs
+      xml.get_elements("PhysicalVolumes/PhysicalVolume").map do |elem|
+        PhysicalVolume.new(elem)
+      end
+    end
+  end
+
+  # Cluster information
+  class Cluster < AbstractRest
+    ATTRS = {
+      :name => "ClusterName",
+      :id => "ClusterID",
+      :tier_capable => "ClusterCapabilities/IsTierCapable"
+    }.freeze
+
+    def ssp_uuid
+      href = singleton("ClusterSharedStoragePool", "href")
+      uuid_from_href(href)
+    end
+
+    def nodes
+      xml.get_elements("Node/Node").map do |elem|
+        Node.new(elem)
+      end
+    end
+  end
+
+  # Cluster node information
+  class Node < AbstractNonRest
+    ATTRS = {
+      :hostname => "HostName",
+      :lpar_id => "PartitionID",
+      :state => "State",
+      :ioslevel => "VirtualIOServerLevel"
+    }.freeze
+
+    def vios_uuid
+      href = singleton("VirtualIOServer", "href")
+      uuid_from_href(href)
+    end
+  end
+
+  # SSP information
+  class SharedStoragePool < AbstractRest
+    ATTRS = {
+      :name => "StoragePoolName",
+      :udid => "UniqueDeviceID",
+      :capacity => "Capacity",
+      :free_space => "FreeSpace",
+      :overcommit => "OverCommitSpace",
+      :total_lu_size => "TotalLogicalUnitSize",
+      :alert_threshold => "AlertThreshold"
+    }.freeze
+
+    def cluster_uuid
+      href = singleton("AssociatedCluster", "href")
+      uuid_from_href(href)
+    end
+
+    def pvs
+      xml.get_elements("PhysicalVolumes/PhysicalVolume").map do |elem|
+        PhysicalVolume.new(elem)
+      end
+    end
+
+    def tiers_uuids
+      uuids_from_links("AssociatedTiers")
+    end
+
+    def lus
+      xml.get_elements("LogicalUnits/LogicalUnit").map do |elem|
+        LogicalUnit.new(elem)
+      end
+    end
+  end
+
+  # SSP tier information
+  class Tier < AbstractRest
+    ATTRS = {
+      :name => "Name",
+      :udid => "UniqueDeviceID",
+      :type => "Type",
+      :capacity => "Capacity",
+      :total_lu_size => "TotalLogicalUnitSize",
+      :is_default => "IsDefault",
+      :free_space => "FreeSpace"
+    }.freeze
+
+    def ssp_uuid
+      href = singleton("AssociatedSharedStoragePool", "href")
+      uuid_from_href(href)
+    end
+
+    def lus_uuids
+      uuids_from_links("AssociatedLogicalUnits")
+    end
+  end
+
+  # SSP LU information
+  class LogicalUnit < VirtualSCSIStorage
+    ATTRS = {
+      :name => "UnitName",
+      :capacity => "UnitCapacity",
+      :udid => "UniqueDeviceID",
+      :thin => "ThinDevice",
+      :type => "LogicalUnitType",
+      :in_use => "InUse"
+    }.freeze
+  end
+
+  class PartitionTemplateSummary < AbstractRest
+    ATTRS = {
+      :name => "partitionTemplateName"
+    }.freeze
+  end
+
+  class PartitionTemplate < AbstractRest
+    ATTRS = {
+      :name        => "partitionTemplateName",
+      :description => "description",
+      :os          => "logicalPartitionConfig/osVersion",
+      :memory      => "logicalPartitionConfig/memoryConfiguration/currMemory"
+    }.freeze
   end
 
   # HMC Event
   class Event < AbstractRest
+    attr_accessor :usertask
     ATTRS = {
       :id     => "EventID",
       :type   => "EventType",
@@ -262,15 +834,6 @@ module IbmPowerHmc
     }.freeze
   end
 
-  # Network adapter information
-  class ClientNetworkAdapter < AbstractRest
-    ATTRS = {
-      :macaddr      => "MACAddress",
-      :vswitch_id   => "VirtualSwitchID",
-      :vlan_id      => "PortVLANID"
-    }.freeze
-  end
-
   # Error response from HMC
   class HttpErrorResponse < AbstractRest
     ATTRS = {

data/lib/ibm_power_hmc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_power_hmc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.0
 platform: ruby
 authors:
 - IBM Power
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client