ibm_power_hmc 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c19305b95374164ab2a6e6168a4a292ea0666065cbcbe8f05dea30483b622055
-  data.tar.gz: be50d67e7c462cc17f20be3f643c6029e4f2ba7d43f872f1821bbe428f0e11fe
+  metadata.gz: 2c866478ebd950e9570ce2983d62e90b15fdc27163ea77f3b3f5873138b57cf9
+  data.tar.gz: c58488b78a699e4d0f1fc48c43d41db03f9df7c20f861d29e37d80375e8068a2
 SHA512:
-  metadata.gz: 1191f64dd2f5c550d25a372b4a0502dd4e7b5a8e779a2dacdf079a22f3a8b8092af6e4ddff514b0e06dddf8239985033034959e385f951f2f535f092866cbd12
-  data.tar.gz: d6af992547d99624f59e6eb5ec3404768c91d1b9c9809e9542966fee15b4a350e8b8803e6fd25a597c48699b630171b7cae8327108f0ec6616e2329c5441bf1c
+  metadata.gz: 8201481418ec67876a0298d8785ca23a7f2e366a4765ddda8e98024fa71a97a79932661d920090b033da9958c3859460865bb56b7379058e02a9d4f688dab523
+  data.tar.gz: cfee7c90c9c22149358b17cf861df4d31d757dde93cf5a30c1196f7957fe48d28bb636643bfbed99238b18215d2048d61c85067b66c8d481bc7678d3fe5ab112

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,7 +257,7 @@ 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
@@ -335,29 +380,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.
@@ -479,21 +501,22 @@ 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
-
-      response = request(:get, method_url)
-      Parser.new(response.body).object(:ClientNetworkAdapter)
     end
   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)
@@ -154,6 +121,41 @@ module IbmPowerHmc
     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)
+      @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
+  end
+
   # HMC information
   class ManagementConsole < AbstractRest
     ATTRS = {
@@ -211,7 +213,10 @@ 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
@@ -222,7 +227,7 @@ module IbmPowerHmc
     def net_adap_uuids
       xml.get_elements("ClientNetworkAdapters/link").map do |link|
         extract_uuid_from_href(link.attributes["href"])
-      end
+      end.compact
     end
 
     def name=(name)
@@ -250,6 +255,66 @@ module IbmPowerHmc
     def sys_uuid
       href.path.split('/')[-3]
     end
+
+    def networks_uuids
+      xml.get_elements("VirtualNetworks/link").map do |link|
+        extract_uuid_from_href(link.attributes["href"])
+      end.compact
+    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")
+      extract_uuid_from_href(href)
+    end
+
+    def lpars_uuids
+      xml.get_elements("ConnectedPartitions/link").map do |link|
+        extract_uuid_from_href(link.attributes["href"])
+      end.compact
+    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"
+    }.freeze)
+
+    def vswitch_uuid
+      href = singleton("AssociatedVirtualSwitch/link", "href")
+      extract_uuid_from_href(href)
+    end
+  end
+
+  # Client Network Adapter information
+  class ClientNetworkAdapter < VirtualEthernetAdapter
+    def networks_uuids
+      xml.get_elements("VirtualNetworks/link").map do |link|
+        extract_uuid_from_href(link.attributes["href"])
+      end.compact
+    end
   end
 
   # HMC Event
@@ -262,15 +327,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.5.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.5.0
 platform: ruby
 authors:
 - IBM Power
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client