ibm_power_hmc 0.11.0 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 669594ada9babea18977e0e3870c6ea0e27305cd74660dbe2d3bbc70551ed4b4
-  data.tar.gz: 76304c4b431924825adfc32dc14ff31c0951f0c6aae294010331c82a54ca384d
+  metadata.gz: af80f7c29ca2a209985e3b7f62604fc9ba962f2b0c2da10041fad1eb881f7d32
+  data.tar.gz: 006f79fee2ae35c82ba612639662e85ed743753f74142b1054d7166a71e877f9
 SHA512:
-  metadata.gz: 620c2c717f08248e38b1fec9ddec4dc4bea48537ba59a2ad5071cb16b04c93a35fdd05be492eb62de0c67b170881c3c0e7fe57bedfd7c91e92069ac51961bc06
-  data.tar.gz: c79795ef430594a26709e8eb71f96ffca4689cf1e362ff7b8531e15e36d9e2fd73c396387a11634c6eea7f29d2bbc82267f952053a3fe40a0a909f36107a3451
+  metadata.gz: 0ae3f9052998b99880aa096c0cdd13fca6c8112b6c80b93b51b64f2c9f22e07070b2cf100c61a06011086bd0a459f9ec843103c6c8568c02083dd18fbfd5ebd8
+  data.tar.gz: a9ca88412d5554c3d3d5376c72447b90da0f940553fa83d4f5396a402413af3a411b0f51a105418c77a886260d16aff954029bd73e13ff5c2ce56cfa0e30375e

data/.rubocop_local.yml

@@ -9,5 +9,3 @@ Style/OptionalBooleanParameter:
   Enabled: false
 Style/StringConcatenation:
   Enabled: false
-Style/RescueModifier:
-  Enabled: false

data/lib/ibm_power_hmc/connection.rb

@@ -16,12 +16,13 @@ module IbmPowerHmc
     # @param username [String] User name.
     # @param port [Integer] TCP port number.
     # @param validate_ssl [Boolean] Verify SSL certificates.
-    def initialize(host:, password:, username: "hscroot", port: 12_443, validate_ssl: true)
+    def initialize(host:, password:, username: "hscroot", port: 12_443, validate_ssl: true, timeout: 60)
       @hostname = "#{host}:#{port}"
       @username = username
       @password = password
       @verify_ssl = validate_ssl
       @api_session_token = nil
+      @timeout = timeout
     end
 
     ##
@@ -161,15 +162,17 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method vioses(sys_uuid = nil, search = {})
+    # @!method vioses(sys_uuid = nil, search = {}, 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 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 = {})
+    def vioses(sys_uuid = nil, search = {}, 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
       else
         method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualIOServer"
       end
@@ -386,7 +389,7 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method templates_summary
+    # @!method templates_summary(draft = false)
     # Retrieve the list of partition template summaries.
     # @param draft [Boolean] Retrieve draft templates as well
     # @return [Array<IbmPowerHmc::PartitionTemplateSummary>] The list of partition template summaries.
@@ -397,7 +400,7 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method templates
+    # @!method templates(draft = false)
     # Retrieve the list of partition templates.
     # @param draft [Boolean] Retrieve draft templates as well
     # @return [Array<IbmPowerHmc::PartitionTemplate>] The list of partition templates.
@@ -510,8 +513,6 @@ module IbmPowerHmc
     # @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)
-      # Need to include session token in payload so make sure we are logged in
-      logon if @api_session_token.nil?
       draft_uuid = template_check(template_uuid, target_sys_uuid).results["TEMPLATE_UUID"]
       template_transform(draft_uuid, target_sys_uuid)
       template_modify(draft_uuid, changes)
@@ -529,6 +530,23 @@ module IbmPowerHmc
       modify_object_attributes(method_url, changes)
     end
 
+    ##
+    # @!method template_copy(template_uuid, new_name)
+    # Copy existing template to a new one.
+    # @param template_uuid [String] UUID of the partition template to copy.
+    # @param new_name [String] Name of the new template.
+    # @return [IbmPowerHmc::PartitionTemplate] The new partition template.
+    def template_copy(template_uuid, new_name)
+      method_url = "/rest/api/templates/PartitionTemplate"
+      headers = {
+        :content_type => "application/vnd.ibm.powervm.templates+xml;type=PartitionTemplate"
+      }
+      original = template(template_uuid)
+      original.name = new_name
+      response = request(:put, method_url, headers, original.xml.to_s)
+      Parser.new(response.body).object(:PartitionTemplate)
+    end
+
     ##
     # @!method poweron_lpar(lpar_uuid, params = {}, sync = true)
     # Power on a logical partition.
@@ -712,13 +730,15 @@ module IbmPowerHmc
         @status = err.http_code
         @message = err.message
 
-        # Try to parse body as an HttpErrorResponse
+        # Try to parse body as an HttpErrorResponse.
         unless err.response.nil?
-          resp = Parser.new(err.response.body).object(:HttpErrorResponse) rescue nil
-          unless resp.nil?
+          begin
+            resp = Parser.new(err.response.body).object(:HttpErrorResponse)
             @uri = resp.uri
             @reason = resp.reason
             @message = resp.message
+          rescue
+            # not an XML body
           end
         end
       end
@@ -748,12 +768,13 @@ module IbmPowerHmc
           :url => url,
           :verify_ssl => @verify_ssl,
           :payload => payload,
-          :headers => headers
+          :headers => headers,
+          :timeout => @timeout
         )
       rescue RestClient::Exception => e
-        # Do not retry on failed logon attempts
+        # Do not retry on failed logon attempts.
         if e.http_code == 401 && @api_session_token != "" && !reauth
-          # Try to reauth
+          # Try to reauth.
           reauth = true
           logon
           retry
@@ -785,20 +806,18 @@ module IbmPowerHmc
           break
         rescue HttpError => e
           attempts -= 1
-          # Will get 412 ("Precondition Failed") if ETag mismatches
+          # Will get 412 ("Precondition Failed") if ETag mismatches.
           raise if e.status != 412 || attempts == 0
         end
       end
     end
 
-    # @!method modify_object_attributes(method_url, headers = {}, attempts = 5)
+    # @!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.
-    # @yield [obj] The object to modify.
-    # @yieldparam obj [IbmPowerHmc::AbstractRest] The object to modify.
     def modify_object_attributes(method_url, changes, headers = {}, attempts = 5)
       modify_object(method_url, headers, attempts) do |obj|
         changes.each do |key, value|

data/lib/ibm_power_hmc/job.rb

@@ -5,6 +5,7 @@ module IbmPowerHmc
   # HMC Job for long running operations.
   class HmcJob
     class JobNotStarted < StandardError; end
+
     class JobFailed < StandardError
       def initialize(job)
         super
@@ -109,7 +110,7 @@ module IbmPowerHmc
     def run(timeout = 120, poll_interval = 0)
       start
       wait(timeout, poll_interval)
-      raise JobFailed.new(@last_status) unless @last_status.status.eql?("COMPLETED_OK")
+      raise JobFailed.new(@last_status), "Job failed" unless @last_status.status.eql?("COMPLETED_OK")
     ensure
       delete if defined?(@href)
     end

data/lib/ibm_power_hmc/parser.rb

@@ -223,9 +223,15 @@ module IbmPowerHmc
       :build_level => "VersionInfo/BuildLevel",
       :version => "BaseVersion",
       :ssh_pubkey => "PublicSSHKeyValue",
-      :uvmid => "UVMID"
+      :uvmid => "UVMID",
+      :tz => "CurrentTimezone",
+      :uptime => "ManagementConsoleUpTime"
     }.freeze
 
+    def time
+      Time.at(0, singleton("ManagementConsoleTime").to_i, :millisecond).utc
+    end
+
     def managed_systems_uuids
       uuids_from_links("ManagedSystems")
     end
@@ -419,7 +425,7 @@ module IbmPowerHmc
       :location => "LocationCode",
       :description => "Description",
       :is_available => "AvailableForUsage",
-      :capacity => "VolumeCapacity",
+      :capacity => "VolumeCapacity", # in MiB
       :name => "VolumeName",
       :is_fc => "IsFibreChannelBacked",
       :udid => "VolumeUniqueID"
@@ -431,7 +437,7 @@ module IbmPowerHmc
     ATTRS = {
       :name => "DiskName",
       :label => "DiskLabel",
-      :capacity => "DiskCapacity", # In GiB
+      :capacity => "DiskCapacity", # in GiB
       :psize => "PartitionSize",
       :vg => "VolumeGroup",
       :udid => "UniqueDeviceID"
@@ -923,13 +929,13 @@ module IbmPowerHmc
     def vscsi=(list = [])
       adaps = REXML::Element.new('virtualSCSIClientAdapters')
       adaps.add_attribute('schemaVersion', 'V1_5_0')
-      list.each do |vlan|
+      list.each do |vscsi|
         adaps.add_element('VirtualSCSIClientAdapter', {'schemaVersion' => 'V1_5_0'}).tap do |v|
           v.add_element('associatedLogicalUnits', {'schemaVersion' => 'V1_5_0'})
           v.add_element('associatedPhysicalVolume', {'schemaVersion' => 'V1_5_0'}).tap do |e|
-            e.add_element('PhysicalVolume', {'schemaVersion' => 'V1_5_0'}).add_element('name').text = vlan[:physvol] if vlan[:physvol]
+            e.add_element('PhysicalVolume', {'schemaVersion' => 'V1_5_0'}).add_element('name').text = vscsi[:physvol] if vscsi[:physvol]
           end
-          v.add_element('connectingPartitionName').text = vlan[:vios]
+          v.add_element('connectingPartitionName').text = vscsi[:vios]
           v.add_element('AssociatedTargetDevices', {'schemaVersion' => 'V1_5_0'})
           v.add_element('associatedVirtualOpticalMedia', {'schemaVersion' => 'V1_5_0'})
         end
@@ -953,10 +959,10 @@ module IbmPowerHmc
     def vfc=(list = [])
       adaps = REXML::Element.new('virtualFibreChannelClientAdapters')
       adaps.add_attribute('schemaVersion', 'V1_5_0')
-      list.each do |vlan|
+      list.each do |vfc|
         adaps.add_element('VirtualFibreChannelClientAdapter', {'schemaVersion' => 'V1_5_0'}).tap do |v|
-          v.add_element('connectingPartitionName').text = vlan[:vios]
-          v.add_element('portName').text                = vlan[:port]
+          v.add_element('connectingPartitionName').text = vfc[:vios]
+          v.add_element('portName').text                = vfc[:port]
         end
       end
       if xml.elements['logicalPartitionConfig/virtualFibreChannelClientAdapters']
@@ -980,10 +986,10 @@ module IbmPowerHmc
       adaps = REXML::Element.new('clientNetworkAdapters')
       adaps.add_attribute('schemaVersion', 'V1_5_0')
       list.each do |vlan|
-        adaps.add_element('ClientNetworkAdapter',  {'schemaVersion' => 'V1_5_0'}).
-              add_element('clientVirtualNetworks', {'schemaVersion' => 'V1_5_0'}).
-              add_element('ClientVirtualNetwork',  {'schemaVersion' => 'V1_5_0'}).
-              tap do |v|
+        adaps.add_element('ClientNetworkAdapter',  {'schemaVersion' => 'V1_5_0'})
+             .add_element('clientVirtualNetworks', {'schemaVersion' => 'V1_5_0'})
+             .add_element('ClientVirtualNetwork',  {'schemaVersion' => 'V1_5_0'})
+             .tap do |v|
           v.add_element('name').text                 = vlan[:name]
           v.add_element('vlanId').text               = vlan[:vlan_id]
           v.add_element('associatedSwitchName').text = vlan[:switch]
@@ -1036,6 +1042,7 @@ module IbmPowerHmc
     end
   end
 
+  # Performance and Capacity Monitoring preferences
   class ManagementConsolePcmPreference < AbstractRest
     ATTRS = {
       :max_ltm                     => "MaximumManagedSystemsForLongTermMonitor",

data/lib/ibm_power_hmc/pcm.rb

@@ -17,7 +17,7 @@ module IbmPowerHmc
     end
 
     ##
-    # @!method managed_system_pcm_preferences
+    # @!method managed_system_pcm_preferences(sys_uuid)
     # Return Performance and Capacity Monitor preferences for a Managed System.
     # @param sys_uuid [String] The managed system UUID.
     # @return [IbmPowerHmc::ManagedSystemPcmPreference] The PCM preferences for the Managed System.

data/lib/ibm_power_hmc/version.rb

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

metadata

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