ibm_power_hmc 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e298e207fe26a8e768b923b1c0675a6833aaaa8413a995013eafafcaa73e872
-  data.tar.gz: c24af19a29e5d61785dc617fb49b6e7721173d87eaeed58e0865b49e6fc1f7f6
+  metadata.gz: 94b65ab8fab410579afd4e3729d42f8edff610d55a50714bedd5fdb595d1642e
+  data.tar.gz: 7dfc90cb8edc5c5fb87bc150afabf41e4f802bb97ab2517ddc13a910d730354e
 SHA512:
-  metadata.gz: 3f309b4374cb6cb5c9943766080f39786c57c1d694f6475add0ebbb50a2f5247f06026db388e2ec39bad08dc2196467469a9b953f7b1b63b637786822e5210a8
-  data.tar.gz: 5b0ab1c3ad5937de7515d10bef3351968cd70b2aa80ccbfb2fc646326707b086349c1dfeac9e75a6f37730f690ef056359cf75002b6bad5a3d58865f60ab96eb
+  metadata.gz: 5dc2ada9f19d15c5e63a6cffdb3efd4186422f0320609f8852c3fbb33caefed0e7ce59dff35d14415046db8138576e946c502cf9e8036ef21d5b25c9fdaba2a5
+  data.tar.gz: b36ba635a4c46b8cc250cf6c98381e37476c1a90d29ba543e777054d209d35d0bb47e6413049ff5ab4fd01387c4e21c94b424c765d65b563c3d25b3607456d4b

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.31.0
+* Add host attributes(#141)
+* Improve logging (#139)
 ## v0.30.0
 * expose memory region size of a managed system (#140)
 ## v0.29.0

data/lib/ibm_power_hmc/apis/connection.rb

@@ -10,6 +10,8 @@ module IbmPowerHmc
   ##
   # HMC REST Client connection.
   class Connection
+    include Logging
+
     ##
     # @!method initialize(host:, password:, username: "hscroot", port: 12_443, validate_ssl: true, timeout: 60)
     # Create a new HMC connection.
@@ -145,9 +147,11 @@ module IbmPowerHmc
       reauth = false
       # Check for relative URLs
       url = "https://#{@hostname}#{url}" if url.start_with?("/")
+      logger.debug("HMC API request: #{method.upcase} #{url}")
       begin
         headers = headers.merge("X-API-Session" => @api_session_token)
-        RestClient::Request.execute(
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        response = RestClient::Request.execute(
           :method => method,
           :url => url,
           :verify_ssl => @verify_ssl,
@@ -155,7 +159,12 @@ module IbmPowerHmc
           :headers => headers,
           :timeout => @timeout
         )
+        elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
+        logger.debug("HMC API response: #{response.code} #{method.upcase} #{url} (#{'%.3f' % elapsed}s)")
+        response
       rescue RestClient::Exception => e
+        elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
+        logger.debug("HMC API error: #{e.http_code} #{method.upcase} #{url} (#{'%.3f' % elapsed}s) -- #{e.message}")
         raise HttpNotFound.new(e), "Not found" if e.http_code == 404
 
         # Do not retry on failed logon attempts.
@@ -174,8 +183,8 @@ module IbmPowerHmc
     # @param headers [Hash] HTTP headers.
     # @param attempts [Integer] Maximum number of retries.
     # @yieldreturn [IbmPowerHmc::AbstractRest] The object to modify.
-    def modify_object(headers = {}, attempts = 5, &block)
-      modify_object_url(nil, headers, attempts, &block)
+    def modify_object(headers = {}, attempts = 5, &)
+      modify_object_url(nil, headers, attempts, &)
     end
 
     private
@@ -198,4 +207,4 @@ module IbmPowerHmc
       end
     end
   end
-end
+end

data/lib/ibm_power_hmc/logging.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "ibm_power_hmc/null_logger"
+
+module IbmPowerHmc
+  class << self
+    attr_writer :logger
+  end
+
+  def self.logger
+    @logger ||= NullLogger.new
+  end
+
+  module Logging
+    def logger
+      IbmPowerHmc.logger
+    end
+  end
+end

data/lib/ibm_power_hmc/null_logger.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module IbmPowerHmc
+  class NullLogger < Logger
+    def initialize(*_args)
+      super(nil)
+    end
+
+    def add(*_args, &)
+    end
+
+    def debug?
+      false
+    end
+
+    def info?
+      false
+    end
+
+    def warn?
+      false
+    end
+
+    def error?
+      false
+    end
+
+    def fatal?
+      false
+    end
+  end
+end

data/lib/ibm_power_hmc/schema/uom.rb

@@ -47,27 +47,111 @@ module IbmPowerHmc
     ATTRS = {
       :name => "SystemName",
       :state => "State",
+      :detailed_state => "DetailedState",
       :hostname => "Hostname",
       :ipaddr => "PrimaryIPAddress",
       :description => "Description",
       :location => "SystemLocation", # Rack/Unit
       :ref_code => "ReferenceCode",
+      :merged_ref_code => "MergedReferenceCode",
       :fwversion => "SystemFirmware",
+      :sp_version => "ServiceProcessorVersion",
+      :sp_failover_enabled => "ServiceProcessorFailoverEnabled",
+      :sp_failover_reason => "ServiceProcessorFailoverReason",
+      :sp_failover_state => "ServiceProcessorFailoverState",
+      :physical_attn_led => "PhysicalSystemAttentionLEDState",
+      :virtual_attn_led => "VirtualSystemAttentionLEDState",
       :memory => "AssociatedSystemMemoryConfiguration/InstalledSystemMemory",
-      :avail_mem => "AssociatedSystemMemoryConfiguration/CurrentAvailableSystemMemory",
       :config_mem => "AssociatedSystemMemoryConfiguration/ConfigurableSystemMemory",
+      :permanent_mem => "AssociatedSystemMemoryConfiguration/PermanentSystemMemory",
+      :avail_mem => "AssociatedSystemMemoryConfiguration/CurrentAvailableSystemMemory",
+      :pending_avail_mem => "AssociatedSystemMemoryConfiguration/PendingAvailableSystemMemory",
+      :logical_mem_block_size => "AssociatedSystemMemoryConfiguration/CurrentLogicalMemoryBlockSize",
+      :pending_logical_mem_block_size => "AssociatedSystemMemoryConfiguration/PendingLogicalMemoryBlockSize",
+      :memory_region_size => "AssociatedSystemMemoryConfiguration/MemoryRegionSize",
+      :pending_memory_region_size => "AssociatedSystemMemoryConfiguration/PendingMemoryRegionSize",
+      :pending_logical_mem_region_size => "AssociatedSystemMemoryConfiguration/PendingLogicalMemoryRegionSize",
+      :huge_page_count => "AssociatedSystemMemoryConfiguration/HugePageCount",
+      :huge_page_size => "AssociatedSystemMemoryConfiguration/HugePageSize",
+      :max_huge_pages => "AssociatedSystemMemoryConfiguration/MaximumHugePages",
+      :avail_huge_pages => "AssociatedSystemMemoryConfiguration/CurrentAvailableHugePages",
+      :pending_avail_huge_pages => "AssociatedSystemMemoryConfiguration/PendingAvailableHugePages",
+      :requested_huge_pages => "AssociatedSystemMemoryConfiguration/RequestedHugePages",
+      :configurable_huge_pages => "AssociatedSystemMemoryConfiguration/ConfigurableHugePages",
+      :mem_used_by_hypervisor => "AssociatedSystemMemoryConfiguration/MemoryUsedByHypervisor",
+      :is_mem_mirroring_enabled => "AssociatedSystemMemoryConfiguration/CurrentMemoryMirroringMode",
+      :pending_mem_mirroring_mode => "AssociatedSystemMemoryConfiguration/PendingMemoryMirroringMode",
+      :mem_mirroring_state => "AssociatedSystemMemoryConfiguration/MemoryMirroringState",
+      :mirrored_mem => "AssociatedSystemMemoryConfiguration/CurrentMirroredMemory",
+      :configured_mirrored_mem => "AssociatedSystemMemoryConfiguration/ConfiguredMirroredMemory",
+      :avail_mirrored_mem => "AssociatedSystemMemoryConfiguration/CurrentAvailableMirroredMemory",
+      :mirrorable_mem_with_defrag => "AssociatedSystemMemoryConfiguration/MirrorableMemoryWithDefragmentation",
+      :mirrorable_mem_without_defrag => "AssociatedSystemMemoryConfiguration/MirrorableMemoryWithoutDefragmentation",
+      :mirrored_mem_used_by_hypervisor => "AssociatedSystemMemoryConfiguration/MirroredMemoryUsedByHypervisor",
+      :max_mirrored_mem_defragmented => "AssociatedSystemMemoryConfiguration/MaximumMirroredMemoryDefragmented",
+      :temp_mem_for_lpm => "AssociatedSystemMemoryConfiguration/TemporaryMemoryForLogicalPartitionMobilityInUse",
       :cpus => "AssociatedSystemProcessorConfiguration/InstalledSystemProcessorUnits",
       :avail_cpus => "AssociatedSystemProcessorConfiguration/CurrentAvailableSystemProcessorUnits",
       :config_cpus => "AssociatedSystemProcessorConfiguration/ConfigurableSystemProcessorUnits",
+      :pending_avail_cpus => "AssociatedSystemProcessorConfiguration/PendingAvailableSystemProcessorUnits",
+      :linux_cpus => "AssociatedSystemProcessorConfiguration/NumberOfLinuxOnlyProcessorUnits",
+      :linux_or_vios_cpus => "AssociatedSystemProcessorConfiguration/NumberOfLinuxOrVIOSOnlyProcessorUnits",
+      :vios_cpus => "AssociatedSystemProcessorConfiguration/NumberOfVirtualIOServerProcessorUnits",
+      :shared_proc_pool_count => "AssociatedSystemProcessorConfiguration/SharedProcessorPoolCount",
+      :stealable_cpus => "AssociatedSystemProcessorConfiguration/CurrentStealableProcessorUnits",
+      :max_virt_procs_per_lpar => "AssociatedSystemProcessorConfiguration/MaximumAllowedVirtualProcessorsPerPartition",
+      :min_proc_units_per_vproc => "AssociatedSystemProcessorConfiguration/MinimumProcessorUnitsPerVirtualProcessor",
+      :temp_cpus_for_lpm => "AssociatedSystemProcessorConfiguration/TemporaryProcessorUnitsForLogicalPartitionMobilityInUse",
       :mtype => "MachineTypeModelAndSerialNumber/MachineType",
       :model => "MachineTypeModelAndSerialNumber/Model",
       :serial => "MachineTypeModelAndSerialNumber/SerialNumber",
-      :vtpm_version => "AssociatedSystemSecurity/VirtualTrustedPlatformModuleVersion",
-      :vtpm_lpars => "AssociatedSystemSecurity/AvailableVirtualTrustedPlatformModulePartitions",
+      :vtpm_key_length  => "AssociatedSystemSecurity/VirtualTrustedPlatformModuleKeyLength",
+      :vtpm_key_status  => "AssociatedSystemSecurity/VirtualTrustedPlatformModuleKeyStatus",
+      :vtpm_version     => "AssociatedSystemSecurity/VirtualTrustedPlatformModuleVersion",
+      :vtpm_max_lpars   => "AssociatedSystemSecurity/MaximumSupportedVirtualTrustedPlatformModulePartitions",
+      :vtpm_lpars       => "AssociatedSystemSecurity/AvailableVirtualTrustedPlatformModulePartitions",
+      :vtpm_min_key_store_size => "MinimumKeyStoreSize",
+      :vtpm_max_key_store_size => "MaximumkeyStoreSize",
+      :current_power_saving_mode   => "EnergyManagementConfiguration/CurrentPowerSavingMode",
+      :required_power_saving_mode  => "EnergyManagementConfiguration/RequiredPowerSavingMode",
       :is_classic_hmc_mgmt => "IsClassicHMCManagement",
       :is_hmc_mgmt_master => "IsHMCPowerVMManagementMaster",
-      :is_mem_mirroring_enabled => "AssociatedSystemMemoryConfiguration/CurrentMemoryMirroringMode",
-      :memory_region_size => "AssociatedSystemMemoryConfiguration/MemoryRegionSize"
+      :wwpn_prefix => "AssociatedSystemIOConfiguration/WWPNPrefix",
+      :mac_prefix  => "AssociatedSystemVirtualNetwork/VirtualEthernetAdapterMACAddressPrefix",
+      :uptime => "Uptime",
+      :system_type => "SystemType",
+      :processor_throttling => "ProcessorThrottling",
+      # Persistent Memory
+      :max_pmem_volumes          => "AssociatedPersistentMemoryConfiguration/MaximumPersistentMemoryVolumes",
+      :current_pmem_volumes      => "AssociatedPersistentMemoryConfiguration/CurrentPersistentMemoryVolumes",
+      :max_aix_linux_pmem_vols   => "AssociatedPersistentMemoryConfiguration/MaximumAixLinuxPersistentMemoryVolumes",
+      :max_vios_pmem_vols        => "AssociatedPersistentMemoryConfiguration/MaximumVIOSPersistentMemoryVolumes",
+      :dram_pmem_block_size      => "AssociatedPersistentMemoryConfiguration/DramPersistentMemoryVolumeBlockSize",
+      :dram_pmem_size            => "AssociatedPersistentMemoryConfiguration/DramPersistentMemoryVolumesSize",
+      :dram_pmem_current_size    => "AssociatedPersistentMemoryConfiguration/DramPersistentMemoryVolumesCurrentSize",
+      :supported_pmem_dev_types  => "AssociatedPersistentMemoryConfiguration/SupportedPersistentMemoryDeviceTypes",
+      # Migration
+      :max_inactive_migrations   => "SystemMigrationInformation/MaximumInactiveMigrations",
+      :max_active_migrations     => "SystemMigrationInformation/MaximumActiveMigrations",
+      :max_fw_active_migrations  => "SystemMigrationInformation/MaximumFirmwareActiveMigrations",
+      :max_fw_inactive_migrations => "SystemMigrationInformation/MaximumFirmwareInactiveMigrations",
+      :inactive_migrations_in_progress => "SystemMigrationInformation/NumberOfInactiveMigrationsInProgress",
+      :active_migrations_in_progress   => "SystemMigrationInformation/NumberOfActiveMigrationsInProgress",
+      :inactive_lpar_migration_capable => "SystemMigrationInformation/InactiveLogicalPartitionMigrationCapable",
+      :active_lpar_migration_capable   => "SystemMigrationInformation/ActiveLogicalPartitionMigrationCapable",
+      :ibmi_lpar_migration_capable     => "SystemMigrationInformation/IBMiLogicalPartitionMigrationCapable",
+      :sriov_migration_capable         => "SystemMigrationInformation/LogicalPartitionSRIOVMigrationCapable",
+      :pmem_migration_capable          => "SystemMigrationInformation/LogicalPartitionPersistentMemoryMigrationCapable",
+      :redundant_msps_migration_capable => "SystemMigrationInformation/LogicalPartitionRedundantMspsMigrationCapable",
+      :affinity_check_migration_capable => "SystemMigrationInformation/LogicalPartitionAffinityCheckCapable",
+      :vswitch_migration_capable        => "SystemMigrationInformation/LogicalPartitionVSwitchChangeMigrationCapable",
+      :npiv_validation_policy           => "SystemMigrationInformation/NPIVValidationPolicy",
+      :inactive_profile_migration_policy => "SystemMigrationInformation/InactiveProfileMigrationPolicy",
+      # IPL
+      :ipl_lpar_start_policy => "AssociatedIPLConfiguration/PowerOnLogicalPartitionStartPolicy",
+      :ipl_power_on_side     => "AssociatedIPLConfiguration/CurrentPowerOnSide",
+      :ipl_keylock           => "AssociatedIPLConfiguration/CurrentSystemKeylock",
+      :ipl_power_on_source   => "AssociatedIPLConfiguration/PowerOnSource"
     }.freeze
 
     def group_uuids
@@ -90,6 +174,24 @@ module IbmPowerHmc
       end.compact
     end
 
+    def supported_vtpm_versions
+      xml.get_elements("SupportedVTPMVersions").map do |elem|
+        elem.text&.strip
+      end.compact
+    end
+
+    def supported_vtpm2_encryption_levels
+      xml.get_elements("SupportedVTPM2EncryptionLevels").map do |elem|
+        elem.text&.strip
+      end.compact
+    end
+
+    def supported_power_saving_modes
+      xml.get_elements("EnergyManagementConfiguration/SupportedPowerSavingModeTypes").map do |elem|
+        elem.text&.strip
+      end.compact
+    end
+
     def lpars_uuids
       uuids_from_links("AssociatedLogicalPartitions")
     end
@@ -108,36 +210,44 @@ module IbmPowerHmc
     end
 
     def vswitches_uuids
-      uuids_from_links("AssociatedSystemIOConfiguration/AssociatedSystemVirtualNetwork/VirtualSwitches")
+      uuids_from_links(".//AssociatedSystemVirtualNetwork/VirtualSwitches")
     end
 
     def networks_uuids
-      uuids_from_links("AssociatedSystemIOConfiguration/AssociatedSystemVirtualNetwork/VirtualNetworks")
+      uuids_from_links(".//AssociatedSystemVirtualNetwork/VirtualNetworks")
+    end
+
+    def network_bridges_uuids
+      uuids_from_links(".//AssociatedSystemVirtualNetwork/NetworkBridges")
     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"
+      :description         => "Description",
+      :lpar_id             => "PartitionID",
+      :lpar_name           => "PartitionName",
+      :lpar_type           => "PartitionType",
+      :bus_grouping        => "BusGroupingRequired",
+      :io_unit_physloc     => "IOUnitPhysicalLocation",
+      :pci_class           => "PCIClass",
+      :pci_dev             => "PCIDeviceID",
+      :pci_subsys_dev      => "PCISubsystemDeviceID",
+      :pci_man             => "PCIManufacturerID",
+      :pci_rev             => "PCIRevisionID",
+      :pci_vendor          => "PCIVendorID",
+      :pci_subsys_vendor   => "PCISubsystemVendorID",
+      :dr_index            => "SlotDynamicReconfigurationConnectorIndex",
+      :dr_name             => "SlotDynamicReconfigurationConnectorName",
+      :physloc             => "SlotPhysicalLocationCode",
+      :sriov_capable_dev   => "SRIOVCapableDevice",
+      :sriov_capable       => "SRIOVCapableSlot",
+      :sriov_ports_limit   => "SRIOVLogicalPortsLimit",
+      :vpd_model           => "VitalProductDataModel",
+      :vpd_serial          => "VitalProductDataSerialNumber",
+      :vpd_stale           => "VitalProductDataStale",
+      :vpd_type            => "VitalProductDataType"
     }.freeze
 
     def io_adapter
@@ -161,37 +271,44 @@ module IbmPowerHmc
   # 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"
+      :parent              => "ParentName",
+      :parent_dr_index     => "ParentDynamicReconfigurationConnectorIndex",
+      :pci_dev             => "PCIDeviceId",
+      :pci_vendor          => "PCIVendorId",
+      :pci_subsys_dev      => "PCISubsystemDeviceId",
+      :pci_subsys_vendor   => "PCISubsystemVendorId",
+      :pci_rev             => "PCIRevisionId",
+      :pci_class           => "PCIClassCode",
+      :pci_prog_iface      => "ProgrammingInterfaceClass",
+      :type                => "DeviceType",
+      :primary_dev_func    => "PrimaryDeviceFunction",
+      :serial              => "SerialNumber",
+      :fru_number          => "FruNumber",
+      :part_number         => "PartNumber",
+      :ccin                => "CCIN",
+      :slot_child_id       => "SlotChildId",
+      :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 = {
-      :id => "AdapterID",
-      :description => "Description",
-      :name => "DeviceName",
-      :type => "DeviceType",
-      :dr_name => "DynamicReconfigurationConnectorName",
-      :udid => "UniqueDeviceID"
+      :id           => "AdapterID",
+      :description  => "Description",
+      :name         => "DeviceName",
+      :type         => "DeviceType",
+      :dr_name      => "DynamicReconfigurationConnectorName",
+      :physloc      => "PhysicalLocation",
+      :udid         => "UniqueDeviceID",
+      :lpar_capable => "LogicalPartitionAssignmentCapable",
+      :dyn_capable  => "DynamicPartitionAssignmentCapable"
     }.freeze
   end
 

data/lib/ibm_power_hmc/version.rb

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

data/lib/ibm_power_hmc.rb

@@ -4,6 +4,7 @@ require "rexml/document"
 require "rest-client"
 
 require "ibm_power_hmc/version"
+require "ibm_power_hmc/logging"
 
 # Module for IBM HMC Rest API Client
 module IbmPowerHmc

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ibm_power_hmc
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.31.0
 platform: ruby
 authors:
 - IBM Power
@@ -74,6 +74,8 @@ files:
 - lib/ibm_power_hmc/apis/sem.rb
 - lib/ibm_power_hmc/apis/templates.rb
 - lib/ibm_power_hmc/apis/uom.rb
+- lib/ibm_power_hmc/logging.rb
+- lib/ibm_power_hmc/null_logger.rb
 - lib/ibm_power_hmc/schema/job.rb
 - lib/ibm_power_hmc/schema/parser.rb
 - lib/ibm_power_hmc/schema/pcm.rb