ibm_power_hmc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 397feab84db9812185ab1125cd6778b52a1848519d6bae5950d69cb31e9b4845
+  data.tar.gz: 27dd4d94cd61a19c66d0d6e438c17987ea5926af78b7677b5044a11a50acdb18
+SHA512:
+  metadata.gz: 1171816de48bed97b1837ab39d3bd639772928ebee98fb8f287c85006196bdf068320599b921a239d10d5ce74e98629cde754eca14b12c6cf6be85477e7a7fb3
+  data.tar.gz: 10f7397e58acab288715283de98480caf915fb628021b2f8c5261b13b2c7b273cdec5e1d7a52b35560acbe5cae6dfed5c9e68516673d97ff5f91a9fb44daa370

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+= 0.1.0
+* Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ibm_power_hmc.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    ibm_power_hmc (0.1.0)
+      rest-client (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0704)
+    netrc (0.11.0)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ibm_power_hmc!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,91 @@
+# IBM Power HMC Ruby SDK
+
+Ruby client library to interact with the IBM Hardware Management Console.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ibm_power_hmc'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ibm_power_hmc
+
+## Usage
+
+### Connection
+
+```ruby
+require "ibm_power_hmc"
+
+hc = IbmPowerHmc::Connection.new(
+  host: "<hmc host>",
+  username: "<hmc user (e.g. hscroot)>",
+  password: "<hmc password>",
+  validate_ssl: false)
+```
+
+### Using the SDK
+
+Retrieving information about the management console itself:
+
+```ruby
+hmc = hc.management_console
+puts hmc.name
+puts hmc.version
+```
+
+Listing the logical partitions and virtual I/O servers of each managed system:
+
+```ruby
+hc.managed_systems.each do |sys|
+  puts sys
+  puts hc.lpars(sys.uuid)
+  puts hc.vioses(sys.uuid)
+end
+```
+
+Retrieving a quick property for a given logical partition:
+
+```ruby
+hc.lpar_quick_property(lpar_uuid, "PartitionState")
+```
+
+Shutting down a logical partition:
+
+```ruby
+hc.poweroff_lpar(lpar_uuid, { "operation" => "shutdown" })
+```
+
+Processing events:
+
+```ruby
+loop
+  hc.next_events.each do |event|
+    puts event
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/IBM/ibm_power_hmc_sdk_ruby.
+
+
+## License
+
+This SDK is released under the Apache 2.0 license.
+The license's full text can be found in [LICENSE](https://github.com/IBM/ibm_power_hmc_sdk_ruby/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ibm_power_hmc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ibm_power_hmc.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/ibm_power_hmc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ibm_power_hmc"
+  spec.version       = IbmPowerHmc::VERSION
+  spec.authors       = ["IBM Power"]
+
+  spec.summary       = %q{IBM Power HMC Ruby gem.}
+  spec.description   = %q{A Ruby gem for interacting with the IBM Hardware Management Console (HMC).}
+  spec.homepage      = "http://github.com/IBM/ibm_power_hmc_sdk_ruby"
+  spec.license       = "Apache-2.0"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rest-client", "~> 2.1"
+end

data/lib/ibm_power_hmc/connection.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+# Module for IBM HMC Rest API Client
+module IbmPowerHmc
+  # HMC REST Client connection
+  class Connection
+    def initialize(host:, username: "hscroot", password:, port: 12_443, validate_ssl: true)
+      # Damien: use URI::HTTPS
+      @hostname = "#{host}:#{port}"
+      @username = username
+      @password = password
+      @verify_ssl = validate_ssl
+      @api_session_token = nil
+    end
+
+    def logon
+      method_url = "/rest/api/web/Logon"
+      headers = {
+        content_type: "application/vnd.ibm.powervm.web+xml; type=LogonRequest"
+      }
+      doc = REXML::Document.new("")
+      doc.add_element("LogonRequest", {
+                        "xmlns" => "http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/",
+                        "schemaVersion" => "V1_1_0"
+                      })
+      doc.root.add_element("UserID").text = @username
+      doc.root.add_element("Password").text = @password
+
+      # Damien: begin/rescue
+      @api_session_token = ""
+      response = request(:put, method_url, headers, doc.to_s)
+      doc = REXML::Document.new(response.body)
+      @api_session_token = doc.root.elements["X-API-Session"].text
+    end
+
+    def logoff
+      method_url = "/rest/api/web/Logon"
+      request(:delete, method_url)
+      @api_session_token = nil
+    end
+
+    def management_console
+      method_url = "/rest/api/uom/ManagementConsole"
+      response = request(:get, method_url)
+      doc = REXML::Document.new(response.body)
+      entry = doc.root.elements["entry"]
+      ManagementConsole.new(entry)
+    end
+
+    def managed_systems
+      method_url = "/rest/api/uom/ManagedSystem"
+      response = request(:get, method_url)
+      doc = REXML::Document.new(response.body)
+      systems = []
+      return systems if doc.root.nil?
+
+      doc.root.each_element("entry") do |entry|
+        system = ManagedSystem.new(entry)
+        systems += [system]
+      end
+      systems
+    end
+
+    def lpars(sys_uuid = nil)
+      if sys_uuid.nil?
+        method_url = "/rest/api/uom/LogicalPartition"
+      else
+        method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/LogicalPartition"
+      end
+      response = request(:get, method_url)
+      doc = REXML::Document.new(response.body)
+      lpars = []
+      return lpars if doc.root.nil?
+
+      doc.root.each_element("entry") do |entry|
+        lpar = LogicalPartition.new(entry)
+        lpars += [lpar]
+      end
+      lpars
+    end
+
+    def lpar(lpar_uuid, sys_uuid = nil, group_name = nil)
+      if sys_uuid.nil?
+        method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}"
+      else
+        method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/LogicalPartition/#{lpar_uuid}"
+      end
+      method_url += "?group=#{group_name}" unless group_name.nil?
+
+      response = request(:get, method_url)
+      doc = REXML::Document.new(response.body)
+      entry = doc.elements["entry"]
+      LogicalPartition.new(entry)
+    end
+
+    def lpar_quick_property(lpar_uuid, property_name)
+      method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/quick/#{property_name}"
+
+      response = request(:get, method_url)
+      response.body[1..-2]
+    end
+
+    def vioses(sys_uuid = nil)
+      if sys_uuid.nil?
+        method_url = "/rest/api/uom/VirtualIOServer"
+      else
+        method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/VirtualIOServer"
+      end
+      begin
+        response = request(:get, method_url)
+      rescue StandardError
+        return []
+      end
+      doc = REXML::Document.new(response.body)
+      vioses = []
+      return vioses if doc.root.nil?
+
+      doc.root.each_element("entry") do |entry|
+        vios = VirtualIOServer.new(entry)
+        vioses += [vios]
+      end
+      vioses
+    end
+
+    # Damien: share the same method for VIOS and LPAR?
+    def lpar_profiles(lpar_uuid)
+      method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/LogicalPartitionProfile"
+      begin
+        response = request(:get, method_url)
+      rescue StandardError
+        return []
+      end
+      doc = REXML::Document.new(response.body)
+      profiles = []
+      return profiles if doc.root.nil?
+
+      doc.root.each_element("entry") do |entry|
+        profile = LogicalPartitionProfile.new(lpar_uuid, entry)
+        profiles += [profile]
+      end
+      profiles
+    end
+
+    def poweron_lpar(lpar_uuid, params = {})
+      method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/do/PowerOn"
+
+      job = HmcJob.new(self, method_url, "PowerOn", "LogicalPartition", params)
+      job.start
+      job.wait
+      job.delete
+    end
+
+    def poweroff_lpar(lpar_uuid, params = {})
+      method_url = "/rest/api/uom/LogicalPartition/#{lpar_uuid}/do/PowerOff"
+
+      job = HmcJob.new(self, method_url, "PowerOff", "LogicalPartition", params)
+      job.start
+      job.wait
+      job.delete
+    end
+
+    # Damien: share with poweron_lpar?
+    def poweron_vios(vios_uuid, params = {})
+      method_url = "/rest/api/uom/VirtualIOServer/#{vios_uuid}/do/PowerOn"
+
+      job = HmcJob.new(self, method_url, "PowerOn", "VirtualIOServer", params)
+      job.start
+      job.wait
+      job.delete
+    end
+
+    # Damien: share with poweroff_lpar?
+    def poweroff_vios(vios_uuid, params = {})
+      method_url = "/rest/api/uom/VirtualIOServer/#{vios_uuid}/do/PowerOff"
+
+      job = HmcJob.new(self, method_url, "PowerOff", "VirtualIOServer", params)
+      job.start
+      job.wait
+      job.delete
+    end
+
+    def poweron_managed_system(sys_uuid, params = {})
+      method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/do/PowerOn"
+
+      job = HmcJob.new(self, method_url, "PowerOn", "ManagedSystem", params)
+      job.start
+      job.wait
+      job.delete
+    end
+
+    def poweroff_managed_system(sys_uuid, params = {})
+      method_url = "/rest/api/uom/ManagedSystem/#{sys_uuid}/do/PowerOff"
+
+      job = HmcJob.new(self, method_url, "PowerOff", "ManagedSystem", params)
+      job.start
+      job.wait
+      job.delete
+    end
+
+    # Blocks until new events occur.
+    def next_events
+      method_url = "/rest/api/uom/Event"
+
+      events = []
+      loop do
+        response = request(:get, method_url)
+        next if response.code == 204
+
+        doc = REXML::Document.new(response.body)
+        doc.root.each_element("entry") do |entry|
+          event = Event.new(entry)
+          events += [event]
+        end
+        break
+      end
+      events
+    end
+
+    def request(method, url, headers = {}, payload = nil)
+      logon if @api_session_token.nil?
+
+      headers = headers.merge({ "X-API-Session" => @api_session_token })
+      # Damien: use URI module and prepare in initialize?
+      response = RestClient::Request.execute(
+        method: method,
+        url: "https://" + @hostname + url,
+        verify_ssl: @verify_ssl,
+        payload: payload,
+        headers: headers
+      )
+      if response.code == 403
+        # Damien: if token expires, reauth?
+        @api_session_token = nil
+        logon
+        # Damien: retry TBD
+      end
+      response
+    end
+  end
+end

data/lib/ibm_power_hmc/job.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Module for IBM HMC Rest API Client
+module IbmPowerHmc
+  # HMC Job for long running operations
+  class HmcJob
+    def initialize(hc, method_url, operation, group, params)
+      @hc = hc
+      @method_url = method_url
+      @operation = operation
+      @group = group
+      @params = params
+    end
+
+    def start
+      headers = {
+        content_type: "application/vnd.ibm.powervm.web+xml; type=JobRequest"
+      }
+      doc = REXML::Document.new("")
+      doc.add_element("JobRequest:JobRequest", {
+                        "xmlns:JobRequest" => "http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/",
+                        "xmlns" => "http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/",
+                        "schemaVersion" => "V1_1_0"
+                      })
+      op = doc.root.add_element("RequestedOperation", { "schemaVersion" => "V1_1_0" })
+      op.add_element("OperationName").text = @operation
+      op.add_element("GroupName").text = @group
+      # Damien: ProgressType?
+      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 = @hc.request(:put, @method_url, headers, doc.to_s)
+      doc = REXML::Document.new(response.body)
+      info = doc.root.elements["content/JobResponse:JobResponse"]
+      @id = info.elements["JobID"].text
+    end
+
+    def status
+      # Damien: check id is defined
+      method_url = "/rest/api/uom/jobs/#{@id}"
+      headers = {
+        content_type: "application/vnd.ibm.powervm.web+xml; type=JobRequest"
+      }
+      response = @hc.request(:get, method_url, headers)
+      doc = REXML::Document.new(response.body)
+      info = doc.root.elements["content/JobResponse:JobResponse"]
+      status = info.elements["Status"].text
+      # Damien: also retrieve "ResponseException/Message"
+      status
+    end
+
+    def wait(timeout = 120, poll_interval = 30)
+      endtime = Time.now + timeout
+      while Time.now < endtime do
+        status = self.status
+        break if status != "RUNNING" # Damien: and != "STARTING"?
+        sleep(poll_interval)
+      end
+    end
+
+    def delete
+      # Damien: check id is defined
+      method_url = "/rest/api/uom/jobs/#{@id}"
+      @hc.request(:delete, method_url)
+      # Returns HTTP 204 if ok
+    end
+  end
+end

data/lib/ibm_power_hmc/objects.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+# Module for IBM HMC Rest API Client
+module IbmPowerHmc
+  # HMC generic object
+  class HmcObject
+    attr_reader :uuid
+
+    def initialize(doc)
+      @uuid = doc.elements["id"].text
+    end
+
+    def get_value(doc, xpath, varname)
+      value = doc.elements[xpath]
+      value = value.text unless value.nil?
+      value = value.strip unless value.nil?
+      self.class.__send__(:attr_reader, "#{varname}")
+      instance_variable_set("@#{varname}", value)
+    end
+
+    def get_values(doc, hash)
+      hash.each do |key, value|
+        get_value(doc, key, value)
+      end
+    end
+
+    def to_s
+      "uuid=#{@uuid}"
+    end
+  end
+
+  # HMC information
+  class ManagementConsole < HmcObject
+    XMLMAP = {
+      "ManagementConsoleName" => "name",
+      "VersionInfo/BuildLevel" => "build_level",
+      "BaseVersion" => "version"
+    }.freeze
+
+    def initialize(doc)
+      super(doc)
+      info = doc.elements["content/ManagementConsole:ManagementConsole"]
+      get_values(info, XMLMAP)
+    end
+
+    def to_s
+      "hmc name=#{@name} version=#{@version} build_level=#{@build_level}"
+    end
+  end
+
+  # Managed System information
+  class ManagedSystem < HmcObject
+    XMLMAP = {
+      "SystemName" => "name",
+      "State" => "state",
+      "Hostname" => "hostname",
+      "PrimaryIPAddress" => "ipaddr",
+      "AssociatedSystemMemoryConfiguration/InstalledSystemMemory" => "memory",
+      "AssociatedSystemMemoryConfiguration/CurrentAvailableSystemMemory" => "avail_mem",
+      "AssociatedSystemProcessorConfiguration/InstalledSystemProcessorUnits" => "cpus",
+      "AssociatedSystemProcessorConfiguration/CurrentAvailableSystemProcessorUnits" => "avail_cpus"
+    }.freeze
+
+    def initialize(doc)
+      super(doc)
+      info = doc.elements["content/ManagedSystem:ManagedSystem"]
+      get_values(info, XMLMAP)
+    end
+
+    def to_s
+      "sys name=#{@name} state=#{@state} ip=#{@ipaddr} mem=#{@memory}MB avail=#{@avail_mem}MB CPUs=#{@cpus} avail=#{@avail_cpus}"
+    end
+  end
+
+  # Logical Partition information
+  class LogicalPartition < HmcObject
+    attr_reader :sys_uuid
+
+    XMLMAP = {
+      "PartitionName" => "name",
+      "PartitionID" => "id",
+      "PartitionState" => "state",
+      "PartitionType" => "type",
+      "PartitionMemoryConfiguration/CurrentMemory" => "memory",
+      "PartitionProcessorConfiguration/HasDedicatedProcessors" => "dedicated",
+      "ResourceMonitoringControlState" => "rmc_state",
+      "ResourceMonitoringIPAddress" => "rmc_ipaddr"
+    }.freeze
+
+    def initialize(doc)
+      super(doc)
+      info = doc.elements["content/LogicalPartition:LogicalPartition"]
+      sys_href = info.elements["AssociatedManagedSystem"].attributes["href"]
+      @sys_uuid = URI(sys_href).path.split('/').last
+      get_values(info, XMLMAP)
+    end
+
+    def to_s
+      "lpar name=#{@name} id=#{@id} state=#{@state} type=#{@type} memory=#{@memory}MB dedicated cpus=#{@dedicated}"
+    end
+  end
+
+  # VIOS information
+  class VirtualIOServer < HmcObject
+    attr_reader :sys_uuid
+
+    XMLMAP = {
+      "PartitionName" => "name",
+      "PartitionID" => "id",
+      "PartitionState" => "state",
+      "PartitionType" => "type",
+      "PartitionMemoryConfiguration/CurrentMemory" => "memory",
+      "PartitionProcessorConfiguration/HasDedicatedProcessors" => "dedicated"
+    }.freeze
+
+    def initialize(doc)
+      super(doc)
+      info = doc.elements["content/VirtualIOServer:VirtualIOServer"]
+      sys_href = info.elements["AssociatedManagedSystem"].attributes["href"]
+      @sys_uuid = URI(sys_href).path.split('/').last
+      get_values(info, XMLMAP)
+    end
+
+    def to_s
+      "vios name=#{@name} id=#{@id} state=#{@state} type=#{@type} memory=#{@memory}MB dedicated cpus=#{@dedicated}"
+    end
+  end
+
+  # LPAR profile
+  class LogicalPartitionProfile < HmcObject
+    attr_reader :lpar_uuid
+
+    # Damien: TBD
+  end
+
+  # HMC Event
+  class Event < HmcObject
+    XMLMAP = {
+      "EventID" => "id",
+      "EventType" => "type",
+      "EventData" => "data",
+      "EventDetail" => "detail",
+    }.freeze
+
+    def initialize(doc)
+      super(doc)
+      info = doc.elements["content/Event:Event"]
+      get_values(info, XMLMAP)
+    end
+
+    def to_s
+      "event id=#{@id} type=#{@type} data=#{@data} detail=#{@detail}"
+    end
+  end
+end

data/lib/ibm_power_hmc/version.rb

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

data/lib/ibm_power_hmc.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rexml/document"
+require "rest-client"
+
+require "ibm_power_hmc/version"
+
+# Module for IBM HMC Rest API Client
+module IbmPowerHmc
+  require_relative "./ibm_power_hmc/objects.rb"
+  require_relative "./ibm_power_hmc/job.rb"
+  require_relative "./ibm_power_hmc/connection.rb"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: ibm_power_hmc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- IBM Power
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: A Ruby gem for interacting with the IBM Hardware Management Console (HMC).
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ibm_power_hmc.gemspec
+- lib/ibm_power_hmc.rb
+- lib/ibm_power_hmc/connection.rb
+- lib/ibm_power_hmc/job.rb
+- lib/ibm_power_hmc/objects.rb
+- lib/ibm_power_hmc/version.rb
+homepage: http://github.com/IBM/ibm_power_hmc_sdk_ruby
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://github.com/IBM/ibm_power_hmc_sdk_ruby
+  source_code_uri: http://github.com/IBM/ibm_power_hmc_sdk_ruby
+  changelog_uri: http://github.com/IBM/ibm_power_hmc_sdk_ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: IBM Power HMC Ruby gem.
+test_files: []