ibm_power_hmc 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3162f83d1c3168407716f683401e5f3f1b3c49489728561e52ab49410209beaa
-  data.tar.gz: c50f1ac36cda911c01262b06762fd928c06790d4df116f020958edd10ca0713e
+  metadata.gz: faeaaee474f96b0beb9747a2d346110a1321e9060b2b196770598f1bccfd85a8
+  data.tar.gz: 3af51fcdb06f722a95e44bcea28f8ed4f4fef9cdfd9e1332063c3bf288a00c61
 SHA512:
-  metadata.gz: 014ff944d75d5dccf07d894628a0b41c08fe99d3478558f57b22aff2a1e86cc9589368c3a55696dc0f196edabd59f0d9e47b0f2aa09f726b7d6b18c5d250e775
-  data.tar.gz: 68a388e0a6a75c9cc61e9befeca8644fa64f92e95ca8411948fe166ba81c44997bd67c0247d943567fb0f345671bb9164dbc77294bdeb153f534b394c4637334
+  metadata.gz: 1756c8a220a30ba88da0cd0d518a681657f9d08a231c11715e461d0fe5be1c171b17e98bb290fd29f9cdb551da48cdfc699707147abded7cfa204dcde26067be
+  data.tar.gz: 8906b25b90865262000331f4c371b546cac852eeb14714e8c75b0e7ae937422d441a1c920687d4e8913dad088a9eadbbbb7a5d740fceccd57f9733e9112ce2bc

data/README.md

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

data/lib/ibm_power_hmc/connection.rb

@@ -10,7 +10,7 @@ module IbmPowerHmc
   # HMC REST Client connection.
   class Connection
     ##
-    # @!method initialize(host:, password:, username: "hscroot", port: 12_443, validate_ssl: true)
+    # @!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.
@@ -18,6 +18,7 @@ module IbmPowerHmc
     # @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
@@ -90,6 +91,29 @@ module IbmPowerHmc
       FeedParser.new(response.body).objects(:ManagedSystem)
     end
 
+    ##
+    # @!method managed_systems_quick
+    # Retrieve the list of systems managed by the HMC (using Quick API).
+    # @return [Array<Hash>] The list of managed systems.
+    def managed_systems_quick
+      method_url = "/rest/api/uom/ManagedSystem/quick/All"
+      response = request(:get, method_url)
+      JSON.parse(response.body)
+    end
+
+    ##
+    # @!method managed_system_quick(sys_uuid, property = nil)
+    # Retrieve information about a managed system (using Quick API).
+    # @param sys_uuid [String] The UUID of the managed system.
+    # @param property [String] The quick property name (optional).
+    # @return [Hash] The managed system.
+    def managed_system_quick(sys_uuid, property = nil)
+      method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/quick"
+      method_url += "/#{property}" unless property.nil?
+      response = request(:get, method_url)
+      JSON.parse(response.body)
+    end
+
     ##
     # @!method managed_system(lpar_uuid, sys_uuid = nil, group_name = nil)
     # Retrieve information about a managed system.
@@ -159,8 +183,9 @@ module IbmPowerHmc
     # @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)
-      method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}"
-      modify_object_attributes(method_url, {:name => new_name})
+      modify_object do
+        lpar(lpar_uuid).tap { |lpar| lpar.name = new_name }
+      end
     end
 
     ##
@@ -613,14 +638,21 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method template(template_uuid, changes)
-    # modify_object_attributes wrapper for templates.
+    # @!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.
-    # @return [IbmPowerHmc::PartitionTemplate] The partition template.
     def template_modify(template_uuid, changes)
       method_url = "/rest/api/templates/PartitionTemplate/#{template_uuid}"
-      modify_object_attributes(method_url, changes)
+
+      # 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
 
     ##
@@ -759,18 +791,20 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method next_events(wait = true)
+    # @!method next_events(timeout = -1)
     # Retrieve a list of events that occured since last call.
-    # @param wait [Boolean] If no event is available, block until new events occur.
+    # @param timeout [Integer] The number of seconds to wait if no event is available.
+    #   Specify -1 to wait indefinitely.
     # @return [Array<IbmPowerHmc::Event>] The list of events.
-    def next_events(wait = true)
+    def next_events(timeout = -1)
       method_url = "/rest/api/uom/Event"
+      method_url += "?timeout=#{timeout}" if timeout >= 0
 
       response = nil
       loop do
         response = request(:get, method_url)
-        # No need to sleep as the HMC already waits a bit before returning 204
-        break if response.code != 204 || !wait
+        # The HMC waits "timeout" seconds (10 if not specified) before returning 204.
+        break if response.code != 204 || timeout >= 0
       end
       FeedParser.new(response.body).objects(:Event).map do |e|
         data = e.data.split("/") unless e.data.nil?
@@ -876,26 +910,26 @@ module IbmPowerHmc
       end
     end
 
-    private
-
-    # @!method modify_object(method_url, headers = {}, attempts = 5)
-    # Modify an object at a specified URI.
-    # @param method_url [String] The URL of the object to modify.
+    # @!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.
-    # @yield [obj] The object to modify.
-    # @yieldparam obj [IbmPowerHmc::AbstractRest] The object to modify.
-    def modify_object(method_url, headers = {}, attempts = 5)
-      while attempts > 0
-        response = request(:get, method_url)
-        obj = Parser.new(response.body).object
+    # @yieldreturn [IbmPowerHmc::AbstractRest] The object to modify.
+    def modify_object(headers = {}, attempts = 5, &block)
+      modify_object_url(nil, headers, attempts, &block)
+    end
+
+    private
 
-        yield obj
+    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, headers, obj.xml.to_s)
+          request(:post, method_url.nil? ? obj.href.path : method_url, headers, obj.xml.to_s)
           break
         rescue HttpError => e
           attempts -= 1
@@ -905,20 +939,6 @@ module IbmPowerHmc
       end
     end
 
-    # @!method modify_object_attributes(method_url, changes, headers = {}, attempts = 5)
-    # Modify an object at a specified URI.
-    # @param method_url [String] The URL of the object to modify.
-    # @param changes [Hash] Hash of changes to make. Key is the attribute modify/create (as defined in the AbstractNonRest subclass). A value of nil removes the attribute.
-    # @param headers [Hash] HTTP headers.
-    # @param attempts [Integer] Maximum number of retries.
-    def modify_object_attributes(method_url, changes, headers = {}, attempts = 5)
-      modify_object(method_url, headers, attempts) do |obj|
-        changes.each do |key, value|
-          obj.send("#{key}=", value)
-        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.

data/lib/ibm_power_hmc/parser.rb

@@ -159,12 +159,11 @@ module IbmPowerHmc
     end
 
     def collection_of(name, type)
-      objtype = Module.const_get("IbmPowerHmc::#{type}")
       xml.get_elements([name, type].compact.join("/")).map do |elem|
-        objtype.new(elem)
-      end
-    rescue
-      []
+        Module.const_get("IbmPowerHmc::#{elem.name}").new(elem)
+      rescue NameError
+        nil
+      end.compact
     end
   end
 
@@ -221,11 +220,23 @@ module IbmPowerHmc
     ATTRS = {
       :name => "ManagementConsoleName",
       :build_level => "VersionInfo/BuildLevel",
+      :maint_level => "VersionInfo/Maintenance",
+      :sp_name => "VersionInfo/ServicePackName",
       :version => "BaseVersion",
       :ssh_pubkey => "PublicSSHKeyValue",
       :uvmid => "UVMID",
       :tz => "CurrentTimezone",
-      :uptime => "ManagementConsoleUpTime"
+      :uptime => "ManagementConsoleUpTime",
+      :uom_version => "UserObjectModelVersion/MinorVersion",
+      :uom_schema => "UserObjectModelVersion/SchemaNamespace",
+      :templates_version => "TemplateObjectModelVersion/MinorVersion",
+      :templates_schema => "TemplateObjectModelVersion/SchemaNamespace",
+      :web_version => "WebObjectModelVersion/MinorVersion",
+      :web_schema => "WebObjectModelVersion/SchemaNamespace",
+      :session_timeout => "SessionTimeout",
+      :web_access => "RemoteWebAccess",
+      :ssh_access => "RemoteCommandAccess",
+      :vterm_access => "RemoteVirtualTerminalAccess"
     }.freeze
 
     def time
@@ -320,6 +331,10 @@ module IbmPowerHmc
     }.freeze
   end
 
+  class HostChannelAdapter < IOAdapter; end
+  class PhysicalFibreChannelAdapter < IOAdapter; end
+  class SRIOVAdapter < IOAdapter; end
+
   # Common class for LPAR and VIOS
   class BasePartition < AbstractRest
     ATTRS = {
@@ -360,6 +375,10 @@ module IbmPowerHmc
     def sriov_elp_uuids
       uuids_from_links("SRIOVEthernetLogicalPorts")
     end
+
+    def io_adapters
+      collection_of("PartitionIOConfiguration/ProfileIOSlots/ProfileIOSlot/AssociatedIOSlot/RelatedIOAdapter", "*[1]")
+    end
   end
 
   # Logical Partition information
@@ -927,6 +946,7 @@ module IbmPowerHmc
       :name         => "partitionTemplateName",
       :description  => "description",
       :lpar_name    => "logicalPartitionConfig/partitionName",
+      :lpar_type    => "logicalPartitionConfig/partitionType",
       :lpar_id      => "logicalPartitionConfig/partitionId",
       :os           => "logicalPartitionConfig/osVersion",
       :memory       => "logicalPartitionConfig/memoryConfiguration/currMemory",

data/lib/ibm_power_hmc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_power_hmc
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - IBM Power
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2022-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client