ibm_power_hmc 0.12.2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af80f7c29ca2a209985e3b7f62604fc9ba962f2b0c2da10041fad1eb881f7d32
-  data.tar.gz: 006f79fee2ae35c82ba612639662e85ed743753f74142b1054d7166a71e877f9
+  metadata.gz: 3162f83d1c3168407716f683401e5f3f1b3c49489728561e52ab49410209beaa
+  data.tar.gz: c50f1ac36cda911c01262b06762fd928c06790d4df116f020958edd10ca0713e
 SHA512:
-  metadata.gz: 0ae3f9052998b99880aa096c0cdd13fca6c8112b6c80b93b51b64f2c9f22e07070b2cf100c61a06011086bd0a459f9ec843103c6c8568c02083dd18fbfd5ebd8
-  data.tar.gz: a9ca88412d5554c3d3d5376c72447b90da0f940553fa83d4f5396a402413af3a411b0f51a105418c77a886260d16aff954029bd73e13ff5c2ce56cfa0e30375e
+  metadata.gz: 014ff944d75d5dccf07d894628a0b41c08fe99d3478558f57b22aff2a1e86cc9589368c3a55696dc0f196edabd59f0d9e47b0f2aa09f726b7d6b18c5d250e775
+  data.tar.gz: 68a388e0a6a75c9cc61e9befeca8644fa64f92e95ca8411948fe166ba81c44997bd67c0247d943567fb0f345671bb9164dbc77294bdeb153f534b394c4637334

data/lib/ibm_power_hmc/connection.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'erb'
+
 # Module for IBM HMC Rest API Client
 module IbmPowerHmc
   class Error < StandardError; end
@@ -77,13 +79,13 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method managed_systems(search = {})
+    # @!method managed_systems(search = nil)
     # Retrieve the list of systems managed by the HMC.
-    # @param search [Hash] The optional property name and value to match.
+    # @param search [String] The optional search criteria.
     # @return [Array<IbmPowerHmc::ManagedSystem>] The list of managed systems.
-    def managed_systems(search = {})
+    def managed_systems(search = nil)
       method_url = "/rest/api/uom/ManagedSystem"
-      search.each { |key, value| method_url += "/search/(#{key}==#{value})" }
+      method_url += "/search/(#{ERB::Util.url_encode(search)})" unless search.nil?
       response = request(:get, method_url)
       FeedParser.new(response.body).objects(:ManagedSystem)
     end
@@ -103,15 +105,15 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method lpars(sys_uuid = nil, search = {})
+    # @!method lpars(sys_uuid = nil, search = nil)
     # 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.
+    # @param search [String] The optional search criteria.
     # @return [Array<IbmPowerHmc::LogicalPartition>] The list of logical partitions.
-    def lpars(sys_uuid = nil, search = {})
+    def lpars(sys_uuid = nil, search = nil)
       if sys_uuid.nil?
         method_url = "/rest/api/uom/LogicalPartition"
-        search.each { |key, value| method_url += "/search/(#{key}==#{value})" }
+        method_url += "/search/(#{ERB::Util.url_encode(search)})" unless search.nil?
       else
         method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/LogicalPartition"
       end
@@ -162,20 +164,57 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method vioses(sys_uuid = nil, search = {}, permissive = true)
+    # @!method lpar_migrate_validate(lpar_uuid, target_sys_name, sync = true)
+    # Validate if a logical partition can be migrated to another managed system.
+    # @raise [IbmPowerHmc::JobFailed] if validation fails
+    # @param lpar_uuid [String] The UUID of the logical partition to migrate.
+    # @param target_sys_name [String] The managed system to migrate partition to.
+    # @param sync [Boolean] Start the job and wait for its completion.
+    def lpar_migrate_validate(lpar_uuid, target_sys_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/uom/LogicalPartition/#{lpar_uuid}/do/MigrateValidate"
+      params = {
+        "TargetManagedSystemName" => target_sys_name
+      }
+      HmcJob.new(self, method_url, "MigrateValidate", "LogicalPartition", params).tap do |job|
+        job.run if sync
+      end
+    end
+
+    ##
+    # @!method lpar_migrate(lpar_uuid, target_sys_name, sync = true)
+    # Migrate a logical partition to another managed system.
+    # @param lpar_uuid [String] The UUID of the logical partition to migrate.
+    # @param target_sys_name [String] The managed system to migrate partition to.
+    # @param sync [Boolean] Start the job and wait for its completion.
+    def lpar_migrate(lpar_uuid, target_sys_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/uom/LogicalPartition/#{lpar_uuid}/do/Migrate"
+      params = {
+        "TargetManagedSystemName" => target_sys_name
+      }
+      HmcJob.new(self, method_url, "Migrate", "LogicalPartition", params).tap do |job|
+        job.run if sync
+      end
+    end
+
+    ##
+    # @!method vioses(sys_uuid = nil, search = nil, permissive = true)
     # 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.
+    # @param search [String] The optional search criteria.
     # @param permissive [Boolean] Skip virtual I/O servers that have error conditions.
     # @return [Array<IbmPowerHmc::VirtualIOServer>] The list of virtual I/O servers.
-    def vioses(sys_uuid = nil, search = {}, permissive = true)
+    def vioses(sys_uuid = nil, search = nil, permissive = true)
       if sys_uuid.nil?
         method_url = "/rest/api/uom/VirtualIOServer"
-        search.each { |key, value| method_url += "/search/(#{key}==#{value})" }
-        method_url += "?ignoreError=true" if permissive
+        method_url += "/search/(#{ERB::Util.url_encode(search)})" unless search.nil?
       else
         method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualIOServer"
       end
+      method_url += "?ignoreError=true" if permissive
       response = request(:get, method_url)
       FeedParser.new(response.body).objects(:VirtualIOServer)
     end
@@ -315,6 +354,42 @@ module IbmPowerHmc
       end
     end
 
+    ##
+    # @!method vscsi_client_adapter(lpar_uuid, adap_uuid = nil)
+    # Retrieve one or all virtual SCSI storage client adapters attached to a logical partition.
+    # @param lpar_uuid [String] UUID of the logical partition.
+    # @param adap_uuid [String] UUID of the adapter to match (returns all adapters if omitted).
+    # @return [Array<IbmPowerHmc::VirtualSCSIClientAdapter>, IbmPowerHmc::VirtualSCSIClientAdapter] The list of storage adapters.
+    def vscsi_client_adapter(lpar_uuid, adap_uuid = nil)
+      if adap_uuid.nil?
+        method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/VirtualSCSIClientAdapter"
+        response = request(:get, method_url)
+        FeedParser.new(response.body).objects(:VirtualSCSIClientAdapter)
+      else
+        method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/VirtualSCSIClientAdapter/#{adap_uuid}"
+        response = request(:get, method_url)
+        Parser.new(response.body).object(:VirtualSCSIClientAdapter)
+      end
+    end
+
+    ##
+    # @!method vfc_client_adapter(lpar_uuid, adap_uuid = nil)
+    # Retrieve one or all virtual Fibre Channel storage client adapters attached to a logical partition.
+    # @param lpar_uuid [String] UUID of the logical partition.
+    # @param adap_uuid [String] UUID of the adapter to match (returns all adapters if omitted).
+    # @return [Array<IbmPowerHmc::VirtualFibreChannelClientAdapter>, IbmPowerHmc::VirtualFibreChannelClientAdapter] The list of storage adapters.
+    def vfc_client_adapter(lpar_uuid, adap_uuid = nil)
+      if adap_uuid.nil?
+        method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/VirtualFibreChannelClientAdapter"
+        response = request(:get, method_url)
+        FeedParser.new(response.body).objects(:VirtualFibreChannelClientAdapter)
+      else
+        method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/VirtualFibreChannelClientAdapter/#{adap_uuid}"
+        response = request(:get, method_url)
+        Parser.new(response.body).object(:VirtualFibreChannelClientAdapter)
+      end
+    end
+
     ##
     # @!method clusters
     # Retrieve the list of clusters managed by the HMC.
@@ -388,6 +463,24 @@ module IbmPowerHmc
       Parser.new(response.body).object(:Tier)
     end
 
+    ##
+    # @!method shared_processor_pool(sys_uuid, pool_uuid = nil)
+    # Retrieve information about Shared Processor Pools.
+    # @param sys_uuid [String] The UUID of the managed system.
+    # @param pool_uuid [String] The UUID of the shared storage pool (return all pools if omitted)
+    # @return [Array<IbmPowerHmc::SharedProcessorPool>, IbmPowerHmc::SharedProcessorPool] The list of shared processor pools.
+    def shared_processor_pool(sys_uuid, pool_uuid = nil)
+      if pool_uuid.nil?
+        method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/SharedProcessorPool"
+        response = request(:get, method_url)
+        FeedParser.new(response.body).objects(:SharedProcessorPool)
+      else
+        method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/SharedProcessorPool/#{pool_uuid}"
+        response = request(:get, method_url)
+        Parser.new(response.body).object(:SharedProcessorPool)
+      end
+    end
+
     ##
     # @!method templates_summary(draft = false)
     # Retrieve the list of partition template summaries.

data/lib/ibm_power_hmc/parser.rb

@@ -262,7 +262,9 @@ module IbmPowerHmc
       :model => "MachineTypeModelAndSerialNumber/Model",
       :serial => "MachineTypeModelAndSerialNumber/SerialNumber",
       :vtpm_version => "AssociatedSystemSecurity/VirtualTrustedPlatformModuleVersion",
-      :vtpm_lpars => "AssociatedSystemSecurity/AvailableVirtualTrustedPlatformModulePartitions"
+      :vtpm_lpars => "AssociatedSystemSecurity/AvailableVirtualTrustedPlatformModulePartitions",
+      :is_classic_hmc_mgmt => "IsClassicHMCManagement",
+      :is_hmc_mgmt_master => "IsHMCPowerVMManagementMaster"
     }.freeze
 
     def group_uuids
@@ -517,7 +519,9 @@ module IbmPowerHmc
       :type     => "AdapterType", # "Server", "Client", "Unknown"
       :location => "LocationCode",
       :slot     => "VirtualSlotNumber",
-      :required => "RequiredAdapter"
+      :required => "RequiredAdapter",
+      :lpar_id  => "LocalPartitionID",
+      :dr_name  => "DynamicReconfigurationConnectorName"
     }.freeze
   end
 
@@ -896,6 +900,22 @@ module IbmPowerHmc
     }.freeze
   end
 
+  # Shared Processor Pool
+  class SharedProcessorPool < AbstractRest
+    ATTRS = {
+      :name => "PoolName",
+      :available => "AvailableProcUnits",
+      :max => "MaximumProcessingUnits",
+      :reserved => "CurrentReservedProcessingUnits",
+      :pending_reserved => "PendingReservedProcessingUnits",
+      :pool_id => "PoolID"
+    }.freeze
+
+    def lpar_uuids
+      uuids_from_links("AssignedPartitions")
+    end
+  end
+
   class PartitionTemplateSummary < AbstractRest
     ATTRS = {
       :name => "partitionTemplateName"

data/lib/ibm_power_hmc/version.rb

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

metadata

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