ibm_power_hmc 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49c35a3e54753bb8c31a1eafc7c6e98e0ad2a662d4d24c284e873ec3d30aa144
-  data.tar.gz: 8429c8a52729102cfcdd2294fc25a2a27dd3f01b0ba9f3f0e46ebbea931903ac
+  metadata.gz: 2a66a6b3ab2a70a1c398c51dae01828b936b6f859d34bc957ad22101e9314e11
+  data.tar.gz: 0f92d6cafc9348975d179b17e6451d31edae23d96a3314f6c4b3d9bc76d97cfa
 SHA512:
-  metadata.gz: 7b0cdb3f5348b221cd5fd147e63d391719b06324a49eec554fd1820d90f8000fb4000e005d5e638e6445be0608f7ea30a3a1db1d1345ac1cbf32526fd428f01f
-  data.tar.gz: 06d590cf0b6f2d92fbdd685d511ebd499597a285a248807cbe2814e5d569ad237753c7b2196c03b40d9f4be25d08071f990dc3d9d3fad0b20e4f5a8ef7a64438
+  metadata.gz: 996802e21a82bfaf391a84fb1872998ecd662b19f0a600315c0445ad817d3220b723879a99272ff79ff15f7add22d12bef6be275ff8106816fe3289e2113ad61
+  data.tar.gz: a4dd65ac732a8e4cda2377df1d87b575c9947e1c5a7a41bff19a4eda333ed49c0f92a754a4e864e2d00d93f55a4e47e6862ab5a701c5f0f2091a6e5cbcf05522

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.21.0
+* Add methods to create/delete LPAR client network adapters
+* Add methods and schema definitions for volume groups
+* Add label and page83 schema definitions for PVs
+* Add schema definitions for capabilities of lpars and vioses
 ## v0.20.0
 * Add permissive option (`ignoreError=true`) for cluster APIs
 * Fix `modify_object` method when URI has a query part

data/lib/ibm_power_hmc/apis/connection.rb

@@ -2,6 +2,9 @@
 
 # Module for IBM HMC Rest API Client
 module IbmPowerHmc
+  WEB_XMLNS = "http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/"
+  UOM_XMLNS = "http://www.ibm.com/xmlns/systems/power/firmware/uom/mc/2012_10/"
+
   class Error < StandardError; end
 
   ##
@@ -37,7 +40,7 @@ module IbmPowerHmc
       }
       doc = REXML::Document.new("")
       doc.add_element("LogonRequest", "schemaVersion" => "V1_1_0")
-      doc.root.add_namespace("http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/")
+      doc.root.add_namespace(WEB_XMLNS)
       doc.root.add_element("UserID").text = @username
       doc.root.add_element("Password").text = @password
 
@@ -122,7 +125,7 @@ module IbmPowerHmc
       end
 
       def to_s
-        "msg=\"#{@message}\" status=\"#{@status}\" reason=\"#{@reason}\" uri=#{@uri}"
+        %(msg="#{@message}" status="#{@status}" reason="#{@reason}" uri=#{@uri})
       end
     end
 

data/lib/ibm_power_hmc/apis/job.rb

@@ -7,13 +7,15 @@ module IbmPowerHmc
     class JobNotStarted < StandardError; end
 
     class JobFailed < StandardError
+      attr_reader :job
+
       def initialize(job)
         super
         @job = job
       end
 
       def to_s
-        "id=\"#{@job.id}\" operation=\"#{@job.group}/#{@job.operation}\" status=\"#{@job.status}\" message=\"#{@job.message}\" exception_text=\"#{@job.results['ExceptionText']}\""
+        %(#{job.status} err="#{job.results["result"]}" rc=#{job.results["returnCode"]} msg="#{job.message}" exception="#{job.results["ExceptionText"]}" url=#{job.url} id=#{job.id})
       end
     end
 
@@ -42,21 +44,8 @@ module IbmPowerHmc
       headers = {
         :content_type => "application/vnd.ibm.powervm.web+xml; type=JobRequest"
       }
-      doc = REXML::Document.new("")
-      doc.add_element("JobRequest:JobRequest", "schemaVersion" => "V1_1_0")
-      doc.root.add_namespace("http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/")
-      doc.root.add_namespace("JobRequest", "http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/")
-      op = doc.root.add_element("RequestedOperation", "schemaVersion" => "V1_1_0")
-      op.add_element("OperationName").text = @operation
-      op.add_element("GroupName").text = @group
-
-      jobparams = doc.root.add_element("JobParameters", "schemaVersion" => "V1_1_0")
-      @params.each do |key, value|
-        jobparam = jobparams.add_element("JobParameter", "schemaVersion" => "V1_1_0")
-        jobparam.add_element("ParameterName").text = key
-        jobparam.add_element("ParameterValue").text = value
-      end
-      response = @conn.request(:put, @method_url, headers, doc.to_s)
+      jobreq = JobRequest.marshal({:operation => @operation, :group => @group, :params => @params}, WEB_XMLNS)
+      response = @conn.request(:put, @method_url, headers, jobreq.xml.to_s)
       jobresp = Parser.new(response.body).object(:JobResponse)
       # Save the URL of the job (JobID is not sufficient as not all jobs are in uom).
       @href = jobresp.href.path

data/lib/ibm_power_hmc/apis/uom.rb

@@ -234,6 +234,29 @@ module IbmPowerHmc
       JSON.parse(response.body)
     end
 
+    ##
+    # @!method volume_groups(vios_uuid)
+    # Retrieve the list of volume groups available on a virtual I/O server.
+    # @param vios_uuid [String] The UUID of the virtual I/O server.
+    # @return [Array<IbmPowerHmc::VolumeGroup>] The list of volume groups.
+    def volume_groups(vios_uuid)
+      method_url = "/rest/api/uom/VirtualIOServer/#{vios_uuid}/VolumeGroup"
+      response = request(:get, method_url)
+      FeedParser.new(response.body).objects(:VolumeGroup)
+    end
+
+    ##
+    # @!method volume_group(vios_uuid, vg_uuid)
+    # Retrieve information about a volume group on a virtual I/O server.
+    # @param vios_uuid [String] The UUID of the virtual I/O server.
+    # @param vg_uuid [String] The UUID of the volume group.
+    # @return [IbmPowerHmc::VolumeGroup] The volume groups.
+    def volume_group(vios_uuid, vg_uuid)
+      method_url = "/rest/api/uom/VirtualIOServer/#{vios_uuid}/VolumeGroup/#{vg_uuid}"
+      response = request(:get, method_url)
+      Parser.new(response.body).object(:VolumeGroup)
+    end
+
     ##
     # @!method groups
     # Retrieve the list of groups defined on the HMC.
@@ -325,6 +348,36 @@ module IbmPowerHmc
     end
     private :network_adapter
 
+    ##
+    # @!method network_adapter_lpar_create(lpar_uuid, sys_uuid, vswitch_uuid, **args)
+    # Create a virtual ethernet network adapter attached to a logical partition.
+    # @param lpar_uuid [String] UUID of the logical partition.
+    # @param sys_uuid [String] UUID of the managed system of the virtual switch.
+    # @param vswitch_uuid [String] UUID of the virtual switch.
+    # @param args [Hash] The network adapter properties.
+    # @return [IbmPowerHmc::ClientNetworkAdapter] The created network adapter.
+    def network_adapter_lpar_create(lpar_uuid, sys_uuid, vswitch_uuid, **args)
+      method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/ClientNetworkAdapter"
+      headers = {
+        :content_type => "application/vnd.ibm.powervm.uom+xml; type=ClientNetworkAdapter"
+      }
+      args[:vswitch_href] = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualSwitch/#{vswitch_uuid}"
+      netadap = ClientNetworkAdapter.marshal(args)
+      response = request(:put, method_url, headers, netadap.xml.to_s)
+      Parser.new(response.body).object(:ClientNetworkAdapter)
+    end
+
+    ##
+    # @!method network_adapter_lpar_delete(lpar_uuid, netadap_uuid)
+    # Delete a virtual ethernet network adapter attached to a logical partition.
+    # @param lpar_uuid [String] UUID of the logical partition.
+    # @param netadap_uuid [String] UUID of the adapter to delete.
+    def network_adapter_lpar_delete(lpar_uuid, netadap_uuid)
+      method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/ClientNetworkAdapter/#{netadap_uuid}"
+      request(:delete, method_url)
+      # Returns HTTP 204 if ok
+    end
+
     ##
     # @!method sriov_elp_lpar(lpar_uuid, sriov_elp_uuid = nil)
     # Retrieve one or all SR-IOV ethernet logical ports attached to a logical partition.

data/lib/ibm_power_hmc/schema/job.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module IbmPowerHmc
+  # Job Request
+  class JobRequest < AbstractRest
+    def operation
+      singleton("RequestedOperation/OperationName")
+    end
+
+    def operation=(operation)
+      elem = xml.elements["RequestedOperation"]
+      elem = xml.add_element("RequestedOperation", "schemaVersion" => "V1_1_0") if elem.nil?
+      elem.add_element("OperationName").text = operation
+    end
+
+    def group
+      singleton("RequestedOperation/GroupName")
+    end
+
+    def group=(group)
+      elem = xml.elements["RequestedOperation"]
+      elem = xml.add_element("RequestedOperation", "schemaVersion" => "V1_1_0") if elem.nil?
+      elem.add_element("GroupName").text = group
+    end
+
+    def params
+      params = {}
+      xml.each_element("JobParameters/JobParameter") do |jobparam|
+        name = jobparam.elements["ParameterName"]&.text&.strip
+        value = jobparam.elements["ParameterValue"]&.text&.strip
+        params[name] = value unless name.nil?
+      end
+      params
+    end
+
+    def params=(params)
+      jobparams = xml.add_element("JobParameters", "schemaVersion" => "V1_1_0")
+      params.each do |key, value|
+        jobparam = jobparams.add_element("JobParameter", "schemaVersion" => "V1_1_0")
+        jobparam.add_element("ParameterName").text = key
+        jobparam.add_element("ParameterValue").text = value
+      end
+    end
+  end
+
+  # Job Response
+  class JobResponse < AbstractRest
+    ATTRS = {
+      :id => "JobID",
+      :status => "Status",
+      :message => "ResponseException/Message",
+      :target_uuid => "TargetUuid",
+      :linear_progress => "Progress/LinearProgress"
+    }.freeze
+
+    def url
+      singleton("RequestURL", "href")
+    end
+
+    def request
+      elem = xml.elements["JobRequestInstance"]
+      JobRequest.new(elem) unless elem.nil?
+    end
+
+    def started_at
+      timestamp("TimeStarted")
+    end
+
+    def completed_at
+      timestamp("TimeCompleted")
+    end
+
+    def results
+      results = {}
+      xml.each_element("Results/JobParameter") do |jobparam|
+        name = jobparam.elements["ParameterName"]&.text&.strip
+        value = jobparam.elements["ParameterValue"]&.text&.strip
+        results[name] = value unless name.nil?
+      end
+      results
+    end
+  end
+end

data/lib/ibm_power_hmc/schema/parser.rb

@@ -87,6 +87,23 @@ module IbmPowerHmc
       self.class::ATTRS.each { |varname, xpath| define_attr(varname, xpath) }
     end
 
+    ##
+    # @!method marshal(attrs = {}, namespace = UOM_XMLNS, version = "V1_1_0")
+    # XML marshaling of object.
+    # @param attrs [Hash] The initial properties of the object.
+    # @param namespace [String] The XML namespace to use.
+    # @param version [String] The XML schema version to use.
+    def self.marshal(attrs = {}, namespace = UOM_XMLNS, version = "V1_1_0")
+      doc = REXML::Document.new("")
+      doc.add_element(name.split("::").last, "schemaVersion" => version)
+      doc.root.add_namespace(namespace)
+      obj = new(doc.root)
+      attrs.each do |varname, value|
+        obj.send("#{varname}=", value)
+      end
+      obj
+    end
+
     ##
     # @!method define_attr(varname, xpath)
     # Define an instance variable using the text of an XML element as value.

data/lib/ibm_power_hmc/schema/uom.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'base64'
+
 module IbmPowerHmc
   # HMC information
   class ManagementConsole < AbstractRest
@@ -74,7 +76,7 @@ module IbmPowerHmc
 
     def capabilities
       xml.get_elements("AssociatedSystemCapabilities/*").map do |elem|
-        elem.name unless elem.text&.strip != "true"
+        elem.name if elem.text&.strip == "true"
       end.compact
     end
 
@@ -174,6 +176,12 @@ module IbmPowerHmc
       uuids_from_links("SRIOVEthernetLogicalPorts")
     end
 
+    def capabilities
+      xml.get_elements("PartitionCapabilities/*").map do |elem|
+        elem.name if elem.text&.strip == "true"
+      end.compact
+    end
+
     def io_adapters
       collection_of("PartitionIOConfiguration/ProfileIOSlots/ProfileIOSlot/AssociatedIOSlot/RelatedIOAdapter", "*[1]")
     end
@@ -201,10 +209,20 @@ module IbmPowerHmc
 
   # VIOS information
   class VirtualIOServer < BasePartition
+    def capabilities
+      xml.get_elements("VirtualIOServerCapabilities/*").map do |elem|
+        elem.name if elem.text&.strip == "true"
+      end.compact.concat(super)
+    end
+
     def pvs
       collection_of("PhysicalVolumes", "PhysicalVolume")
     end
 
+    def vg_uuids
+      uuids_from_links("StoragePools")
+    end
+
     def rep
       elem = xml.elements["MediaRepositories/VirtualMediaRepository"]
       VirtualMediaRepository.new(elem) unless elem.nil?
@@ -295,6 +313,33 @@ module IbmPowerHmc
     }.freeze
   end
 
+  # Volume Group information
+  class VolumeGroup < AbstractRest
+    ATTRS = {
+      :udid => "UniqueDeviceID",
+      :size => "AvailableSize", # in GiB
+      :dev_count => "BackingDeviceCount",
+      :free_space => "FreeSpace", # in GiB
+      :capacity => "GroupCapacity",
+      :name => "GroupName",
+      :serial => "GroupSerialID",
+      :state => "GroupState",
+      :max_lvs => "MaximumLogicalVolumes"
+    }.freeze
+
+    def reps
+      collection_of("MediaRepositories", "VirtualMediaRepository")
+    end
+
+    def pvs
+      collection_of("PhysicalVolumes", "PhysicalVolume")
+    end
+
+    def lvs
+      collection_of("VirtualDisks", "VirtualDisk")
+    end
+  end
+
   # Empty parent class to match K2 schema definition
   class VirtualSCSIStorage < AbstractNonRest; end
 
@@ -307,8 +352,19 @@ module IbmPowerHmc
       :capacity => "VolumeCapacity", # in MiB
       :name => "VolumeName",
       :is_fc => "IsFibreChannelBacked",
+      :is_iscsi => "IsISCSIBacked",
       :udid => "VolumeUniqueID"
     }.freeze
+
+    def label
+      str = singleton("StorageLabel")
+      Base64.decode64(str) unless str.nil?
+    end
+
+    def page83
+      str = singleton("DescriptorPage83")
+      Base64.decode64(str) unless str.nil?
+    end
   end
 
   # Logical Volume information
@@ -318,9 +374,13 @@ module IbmPowerHmc
       :label => "DiskLabel",
       :capacity => "DiskCapacity", # in GiB
       :psize => "PartitionSize",
-      :vg => "VolumeGroup",
       :udid => "UniqueDeviceID"
     }.freeze
+
+    def vg_uuid
+      href = singleton("VolumeGroup", "href")
+      uuid_from_href(href) unless href.nil?
+    end
   end
 
   # Virtual CD-ROM information
@@ -415,6 +475,10 @@ module IbmPowerHmc
     def vswitch_uuid
       uuids_from_links("AssociatedVirtualSwitch").first
     end
+
+    def vswitch_href=(href)
+      xml.add_element("AssociatedVirtualSwitch").add_element("link", "href" => href, "rel" => "related")
+    end
   end
 
   # Client Network Adapter information
@@ -849,25 +913,4 @@ module IbmPowerHmc
       :detail => "EventDetail"
     }.freeze
   end
-
-  # Job Response
-  class JobResponse < AbstractRest
-    ATTRS = {
-      :id        => "JobID",
-      :status    => "Status",
-      :operation => "JobRequestInstance/RequestedOperation/OperationName",
-      :group     => "JobRequestInstance/RequestedOperation/GroupName",
-      :message   => "ResponseException/Message"
-    }.freeze
-
-    def results
-      results = {}
-      xml.each_element("Results/JobParameter") do |jobparam|
-        name = jobparam.elements["ParameterName"]&.text&.strip
-        value = jobparam.elements["ParameterValue"]&.text&.strip
-        results[name] = value unless name.nil?
-      end
-      results
-    end
-  end
 end

data/lib/ibm_power_hmc/version.rb

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

data/lib/ibm_power_hmc.rb

@@ -14,6 +14,7 @@ module IbmPowerHmc
   require_relative "./ibm_power_hmc/apis/templates"
   require_relative "./ibm_power_hmc/apis/uom"
   require_relative "./ibm_power_hmc/schema/parser"
+  require_relative "./ibm_power_hmc/schema/job"
   require_relative "./ibm_power_hmc/schema/pcm"
   require_relative "./ibm_power_hmc/schema/sem"
   require_relative "./ibm_power_hmc/schema/templates"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_power_hmc
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - IBM Power
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -62,6 +62,7 @@ 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/schema/job.rb
 - lib/ibm_power_hmc/schema/parser.rb
 - lib/ibm_power_hmc/schema/pcm.rb
 - lib/ibm_power_hmc/schema/sem.rb