ibm_power_hmc 0.23.1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 664a0abb7f7694b46dfc2b6df5bd77d4302dc95388a31b39700cee8c2f8aa577
-  data.tar.gz: aa33a336fb9acb8f5b638d3e0d141a39700b6557c055aa21e03d3caa74a4e06f
+  metadata.gz: b15e5d3ed25c9329a63b1655da54869b5f0a979f7775149209648d86a0fa67ad
+  data.tar.gz: c1c78e4c661ef6c90ea743245b3e5c29777e7ab51e276a088ca9206d814b99ce
 SHA512:
-  metadata.gz: fccd5b4c9a95d02e36e06fe171f9f6f62aef3632f4698c0954bb05d31ce0d7c8e815cd5d280d9f397da2d7962223dd46e7b1813a64afd71f3c5685ef00f6fea0
-  data.tar.gz: '011009cf620e6d618c936f69e4593a7369e3c7cb11e70c20778c7422806386995b62f20cf4d5141c07b6ec725df7aacc599f2bd52b508e7b41281d5830d91c70'
+  metadata.gz: 379f4c199e6c5a818617608060d98fe75413856b588760a6c0a2a946002858d7df52ce2b86ba54a4af9a2de3b61391828d3fbca4457dae93319c37cc2813bec9
+  data.tar.gz: 5299f74322afac43f91af2a131b5fb1521fc0f3ca3ed87106405006ef181eaa9d776b80e1501f13dabdbdee9630ba3868a47b0839ba88458f88b2782ed43623b

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v0.25.0
+* Add `vios_uuid` as alias to `lpar_uuid` for VFC schema definition
+* Add `lpar_delete_vios_mappings` util method
+* Add option to `lpar_delete` to delete associated VIOS VSCSI/VFC mappings
+## v0.24.0
+* Add schema methods to modify VSCSI and VFC mappings
+* Add schema definition for IOSlot
+* Add schema definition for IORDevice
 ## v0.23.0
 * Enhance schema definition for physical fibre channel adapters
 ## v0.22.0

data/lib/ibm_power_hmc/apis/templates.rb

@@ -119,20 +119,6 @@ module IbmPowerHmc
       job
     end
 
-    ##
-    # @!method template_provision(template_uuid, target_sys_uuid, changes)
-    # Deploy Logical Partition from a Template (performs Check, Transform and Deploy steps in a single method).
-    # @param template_uuid [String] The UUID of the Template to deploy an LPAR from.
-    # @param target_sys_uuid [String] The UUID of the Managed System to deploy the LPAR on.
-    # @param changes [Hash] Modifications to apply to the Template before deploying Logical Partition.
-    # @return [String] The UUID of the deployed Logical Partition.
-    def template_provision(template_uuid, target_sys_uuid, changes)
-      draft_uuid = template_check(template_uuid, target_sys_uuid).results["TEMPLATE_UUID"]
-      template_transform(draft_uuid, target_sys_uuid)
-      template_modify(draft_uuid, changes)
-      template_deploy(draft_uuid, target_sys_uuid).results["PartitionUuid"]
-    end
-
     ##
     # @!method template_modify(template_uuid, changes)
     # Modify a template.

data/lib/ibm_power_hmc/apis/uom.rb

@@ -168,11 +168,15 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method lpar_delete(lpar_uuid)
+    # @!method lpar_delete(lpar_uuid, delete_vios_mappings: false)
     # Delete a logical partition.
     # @param lpar_uuid [String] The UUID of the logical partition to delete.
-    def lpar_delete(lpar_uuid)
+    # @param delete_vios_mappings [Boolean] Delete associated VIOS VFC and VSCSI server adapters.
+    def lpar_delete(lpar_uuid, delete_vios_mappings: false)
       method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}"
+
+      lpar_delete_vios_mappings(lpar_uuid) if delete_vios_mappings
+
       request(:delete, method_url)
       # Returns HTTP 204 if ok
     end

data/lib/ibm_power_hmc/schema/uom.rb

@@ -94,10 +94,15 @@ module IbmPowerHmc
       uuids_from_links("AssociatedVirtualIOServers")
     end
 
+    # Deprecated: use io_slots.io_adapter
     def io_adapters
       collection_of("AssociatedSystemIOConfiguration/IOSlots/IOSlot/RelatedIOAdapter", "IOAdapter")
     end
 
+    def io_slots
+      collection_of("AssociatedSystemIOConfiguration/IOSlots", "IOSlot")
+    end
+
     def vswitches_uuids
       uuids_from_links("AssociatedSystemIOConfiguration/AssociatedSystemVirtualNetwork/VirtualSwitches")
     end
@@ -107,6 +112,73 @@ module IbmPowerHmc
     end
   end
 
+  # I/O Slot information
+  class IOSlot < AbstractNonRest
+    ATTRS = {
+      :description => "Description",
+      :lpar_id => "PartitionID",
+      :lpar_name => "PartitionName",
+      :lpar_type => "PartitionType",
+      :pci_class => "PCIClass",
+      :pci_dev => "PCIDeviceID",
+      :pci_subsys_dev => "PCISubsystemDeviceID",
+      :pci_man => "PCIManufacturerID",
+      :pci_rev => "PCIRevisionID",
+      :pci_vendor => "PCIVendorID",
+      :pci_subsys_vendor => "PCISubsystemVendorID",
+      :dr_name => "SlotDynamicReconfigurationConnectorName",
+      :physloc => "SlotPhysicalLocationCode",
+      :sriov_capable_dev => "SRIOVCapableDevice",
+      :sriov_capable => "SRIOVCapableSlot",
+      :vpd_model => "VitalProductDataModel",
+      :vpd_serial => "VitalProductDataSerialNumber",
+      :vpd_stale => "VitalProductDataStale",
+      :vpd_type => "VitalProductDataType"
+    }.freeze
+
+    def io_adapter
+      elem = xml.elements["RelatedIOAdapter/*[1]"]
+      Module.const_get("IbmPowerHmc::#{elem.name}").new(elem) unless elem.nil?
+    rescue NameError
+      nil
+    end
+
+    def features
+      xml.get_elements("FeatureCodes").map do |elem|
+        elem.text&.strip
+      end.compact
+    end
+
+    def ior_devices
+      collection_of("IORDevices", "IORDevice")
+    end
+  end
+
+  # I/O Device information
+  class IORDevice < AbstractNonRest
+    ATTRS = {
+      :parent => "ParentName",
+      :pci_dev => "PCIDeviceId",
+      :pci_vendor => "PCIVendorId",
+      :pci_subsys_dev => "PCISubsystemDeviceId",
+      :pci_subsys_vendor => "PCISubsystemVendorId",
+      :pci_rev => "PCIRevisionId",
+      :pci_class => "PCIClassCode",
+      :type => "DeviceType",
+      :serial => "SerialNumber",
+      :fru_number => "FruNumber",
+      :part_number => "PartNumber",
+      :ccin => "CCIN",
+      :size => "Size",
+      :location => "LocationCode",
+      :ucode_version => "MicroCodeVersion",
+      :wwpn => "WWPN",
+      :wwnn => "WWNN",
+      :macaddr => "MacAddressValue",
+      :description => "Description"
+    }.freeze
+  end
+
   # I/O Adapter information
   class IOAdapter < AbstractNonRest
     ATTRS = {
@@ -211,10 +283,17 @@ module IbmPowerHmc
       end.compact
     end
 
+    # Deprecated: use io_slots.io_adapter
     def io_adapters
       collection_of("PartitionIOConfiguration/ProfileIOSlots/ProfileIOSlot/AssociatedIOSlot/RelatedIOAdapter", "*[1]")
     end
 
+    def io_slots
+      xml.get_elements("PartitionIOConfiguration/ProfileIOSlots/ProfileIOSlot/AssociatedIOSlot").map do |elem|
+        IOSlot.new(elem)
+      end.compact
+    end
+
     def shared_processor_pool_uuid
       href = singleton("ProcessorPool", "href")
       uuid_from_href(href) unless href.nil?
@@ -278,10 +357,39 @@ module IbmPowerHmc
       collection_of("VirtualSCSIMappings", "VirtualSCSIMapping")
     end
 
+    # Remove VSCSI mapping (vhostX) from XML
+    def vscsi_mapping_delete!(location)
+      vscsi_mappings.each do |mapping|
+        mapping.xml.parent.delete(mapping.xml) if mapping.server&.location == location
+      end
+    end
+
+    # Remove VSCSI target (vtscsiX) from XML
+    def vscsi_mapping_unmap!(target)
+      mapping = vscsi_mappings.find { |m| m.device&.target == target }
+      mapping.xml.parent.delete(mapping.xml) unless mapping.nil?
+    end
+
     def vfc_mappings
       collection_of("VirtualFibreChannelMappings", "VirtualFibreChannelMapping")
     end
 
+    # Remove VFC mapping (vfchostX) from XML
+    def vfc_mapping_delete!(location)
+      mapping = vfc_mappings.find { |m| m.server&.location == location }
+      mapping.xml.parent.delete(mapping.xml) unless mapping.nil?
+    end
+
+    # Remove FC adapter mapping (fcsX) from XML
+    def vfc_mapping_unmap!(location)
+      mapping = vfc_mappings.find { |m| m.port && m.server&.location == location }
+      return if mapping.nil?
+
+      mapping.port.xml.parent.delete(mapping.port.xml)
+      mapping.server.map_port = nil
+      mapping.server.xml.delete(mapping.server.port.xml) unless mapping.server.port.nil?
+    end
+
     def seas
       collection_of("SharedEthernetAdapters", "SharedEthernetAdapter")
     end
@@ -735,6 +843,8 @@ module IbmPowerHmc
 
   # VFC client information
   class VirtualFibreChannelClientAdapter < VirtualFibreChannelAdapter
+    alias vios_uuid lpar_uuid
+
     def nport_loggedin
       collection_of("NportLoggedInStatus", "VirtualFibreChannelNPortLoginStatus")
     end

data/lib/ibm_power_hmc/utils.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module IbmPowerHmc
+  class Connection
+    ##
+    # @!method lpar_delete_vios_mappings(lpar_uuid)
+    # Delete VIOS VSCSI and VFC mappings associated to a given logical partition.
+    # @param lpar_uuid [String] The logical partition UUID.
+    def lpar_delete_vios_mappings(lpar_uuid)
+      vscsi_client_adapter(lpar_uuid).concat(vfc_client_adapter(lpar_uuid)).group_by(&:vios_uuid).each do |vios_uuid, adapters|
+        modify_object do
+          vios(vios_uuid, nil, "ViosSCSIMapping,ViosFCMapping").tap do |vios|
+            adapters.collect(&:server).each do |server|
+              case server
+              when VirtualSCSIServerAdapter
+                vios.vscsi_mapping_delete!(server.location)
+              when VirtualFibreChannelServerAdapter
+                vios.vfc_mapping_delete!(server.location)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    ##
+    # @!method template_provision(template_uuid, target_sys_uuid, changes)
+    # Deploy Logical Partition from a Template (performs Check, Transform and Deploy steps in a single method).
+    # @param template_uuid [String] The UUID of the Template to deploy an LPAR from.
+    # @param target_sys_uuid [String] The UUID of the Managed System to deploy the LPAR on.
+    # @param changes [Hash] Modifications to apply to the Template before deploying Logical Partition.
+    # @return [String] The UUID of the deployed Logical Partition.
+    def template_provision(template_uuid, target_sys_uuid, changes)
+      draft_uuid = template_check(template_uuid, target_sys_uuid).results["TEMPLATE_UUID"]
+      template_transform(draft_uuid, target_sys_uuid)
+      template_modify(draft_uuid, changes)
+      template_deploy(draft_uuid, target_sys_uuid).results["PartitionUuid"]
+    end
+  end
+end

data/lib/ibm_power_hmc/version.rb

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

data/lib/ibm_power_hmc.rb

@@ -19,4 +19,5 @@ module IbmPowerHmc
   require_relative "./ibm_power_hmc/schema/sem"
   require_relative "./ibm_power_hmc/schema/templates"
   require_relative "./ibm_power_hmc/schema/uom"
+  require_relative "./ibm_power_hmc/utils"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_power_hmc
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.25.0
 platform: ruby
 authors:
 - IBM Power
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-23 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -68,6 +68,7 @@ files:
 - lib/ibm_power_hmc/schema/sem.rb
 - lib/ibm_power_hmc/schema/templates.rb
 - lib/ibm_power_hmc/schema/uom.rb
+- lib/ibm_power_hmc/utils.rb
 - lib/ibm_power_hmc/version.rb
 homepage: http://github.com/IBM/ibm_power_hmc_sdk_ruby
 licenses: