ilo-sdk 1.0.0

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: :spec
+spec_pattern = 'spec/**/*_spec.rb'
+def_spec_options = '--color '
+
+desc 'Run unit tests only'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = spec_pattern
+  spec.rspec_opts = def_spec_options
+end
+
+RuboCop::RakeTask.new
+
+desc 'Runs rubocop and unit tests'
+task :test do
+  Rake::Task[:rubocop].invoke
+  Rake::Task[:spec].invoke
+end

data/ilo-sdk.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+# http://guides.rubygems.org/specification-reference
+
+require_relative './lib/ilo-sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ilo-sdk'
+  spec.version       = ILO_SDK::VERSION
+  spec.authors       = ['Anirudh Gupta', 'Bik Bajwa', 'Jared Smartt', 'Vivek Bhatia']
+  spec.email         = ['anirudhg@hpe.com', 'bik.bajwa@hpe.com', 'jared.smartt@hpe.com', 'vivek.bhatia@hpe.com']
+  spec.summary       = 'Gem to interact with iLO API'
+  spec.description   = 'Gem to interact with iLO API'
+  spec.license       = 'Apache-2.0'
+  spec.homepage      = 'https://github.com/HewlettPackard/ilo-sdk-ruby'
+
+  all_files = `git ls-files -z`.split("\x0")
+  spec.files         = all_files.reject { |f| f.match(%r{^(examples\/)|(spec\/)}) }
+  spec.executables   = all_files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'pry'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rubocop', '= 0.39.0'
+
+end

data/lib/ilo-sdk.rb

@@ -0,0 +1,15 @@
+# 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.
+
+require_relative 'ilo-sdk/version'
+require_relative 'ilo-sdk/client'
+
+# Module for interracting with the HPE iLO API
+module ILO_SDK
+end

data/lib/ilo-sdk/client.rb

@@ -0,0 +1,65 @@
+# 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.
+
+require 'logger'
+require_relative 'rest'
+# Load all helpers:
+Dir[File.join(File.dirname(__FILE__), '/helpers/*.rb')].each { |file| require file }
+
+module ILO_SDK
+  # The client defines the connection to the iLO and handles communication with it
+  class Client
+    attr_accessor :host, :user, :password, :ssl_enabled, :logger, :log_level
+
+    # Create a client object
+    # @param [Hash] options the options to configure the client
+    # @option options [String] :host URL, hostname, or IP address of the iLO
+    # @option options [String] :user ('Administrator') Username to use for authentication with the iLO
+    # @option options [String] :password Password to use for authentication with the iLO
+    # @option options [Logger] :logger (Logger.new(STDOUT)) Logger object to use.
+    #   Must implement debug(String), info(String), warn(String), error(String), & level=
+    # @option options [Symbol] :log_level (:info) Log level. Logger must define a constant with this name. ie Logger::INFO
+    # @option options [Boolean] :ssl_enabled (true) Use ssl for requests?
+    def initialize(options = {})
+      options = Hash[options.map { |k, v| [k.to_sym, v] }] # Convert string hash keys to symbols
+      @logger = options[:logger] || Logger.new(STDOUT)
+      [:debug, :info, :warn, :error, :level=].each { |m| raise "Logger must respond to #{m} method " unless @logger.respond_to?(m) }
+      @log_level = options[:log_level] || :info
+      @logger.level = @logger.class.const_get(@log_level.upcase) rescue @log_level
+      @host = options[:host]
+      raise 'Must set the host option' unless @host
+      @host = 'https://' + @host unless @host.start_with?('http://', 'https://')
+      @ssl_enabled = options[:ssl_enabled].nil? ? true : options[:ssl_enabled]
+      raise 'ssl_enabled option must be either true or false' unless [true, false].include?(@ssl_enabled)
+      @logger.warn 'User option not set. Using default (Administrator)' unless options[:user]
+      @user = options[:user] || 'Administrator'
+      @password = options[:password]
+      raise 'Must set the password option' unless @password
+    end
+
+    include Rest
+
+    # Include helper modules:
+    include ManagerNetworkProtocolHelper
+    include DateTimeHelper
+    include ComputerDetailsHelper
+    include SNMPServiceHelper
+    include PowerHelper
+    include AccountServiceHelper
+    include LogEntryHelper
+    include SecureBootHelper
+    include BiosHelper
+    include BootSettingsHelper
+    include FirmwareUpdateHelper
+    include VirtualMediaHelper
+    include ComputerSystemHelper
+    include ChassisHelper
+    include ServiceRootHelper
+  end
+end

data/lib/ilo-sdk/helpers/account_service_helper.rb

@@ -0,0 +1,70 @@
+# 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.
+
+module ILO_SDK
+  # Contains helper methods for Account Service actions
+  module AccountServiceHelper
+    # Get the HREF for a user with a specific username
+    # @param [String, Symbol] uri
+    # @param [String, Symbol] username
+    # @raise [RuntimeError] if the request failed
+    # @return [String] userhref
+    def userhref(uri, username)
+      response = rest_get(uri)
+      items = response_handler(response)['Items']
+      items.each do |it|
+        return it['links']['self']['href'] if it['UserName'] == username
+      end
+    end
+
+    # Get the users
+    # @raise [RuntimeError] if the request failed
+    # @return [String[]] users
+    def get_users
+      response = rest_get('/redfish/v1/AccountService/Accounts/')
+      response_handler(response)['Items'].collect { |user| user['UserName'] }
+    end
+
+    # Create a user
+    # @param [String, Symbol] username
+    # @param [String, Symbol] password
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def create_user(username, password)
+      new_action = { 'UserName' => username, 'Password' => password, 'Oem' => { 'Hp' => { 'LoginName' => username } } }
+      response = rest_post('/redfish/v1/AccountService/Accounts/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Change the password for a user
+    # @param [String, Symbol] username
+    # @param [String, Symbol] password
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def change_password(username, password)
+      new_action = { 'Password' => password }
+      userhref = userhref('/redfish/v1/AccountService/Accounts/', username)
+      response = rest_patch(userhref, body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Delete a specific user
+    # @param [String, Symbol] username
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def delete_user(username)
+      userhref = userhref('/redfish/v1/AccountService/Accounts/', username)
+      response = rest_delete(userhref)
+      response_handler(response)
+      true
+    end
+  end
+end

data/lib/ilo-sdk/helpers/bios_helper.rb

@@ -0,0 +1,146 @@
+# 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.
+
+module ILO_SDK
+  # Contains helper methods for Bios actions
+  module BiosHelper
+    # Get the bios base config
+    # @raise [RuntimeError] if the request failed
+    # @return [Fixnum] bios_baseconfig
+    def get_bios_baseconfig
+      response = rest_get('/redfish/v1/Systems/1/bios/Settings/')
+      response_handler(response)['BaseConfig']
+    end
+
+    # Revert the BIOS
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def revert_bios
+      new_action = { 'BaseConfig' => 'default' }
+      response = rest_patch('/redfish/v1/systems/1/bios/Settings/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Get the UEFI shell start up
+    # @raise [RuntimeError] if the request failed
+    # @return [String] uefi_shell_startup
+    def get_uefi_shell_startup
+      response = rest_get('/redfish/v1/Systems/1/bios/Settings/')
+      bios = response_handler(response)
+      {
+        'UefiShellStartup' => bios['UefiShellStartup'],
+        'UefiShellStartupLocation' => bios['UefiShellStartupLocation'],
+        'UefiShellStartupUrl' => bios['UefiShellStartupUrl']
+      }
+    end
+
+    # Set the UEFI shell start up
+    # @param [String, Symbol] uefi_shell_startup
+    # @param [String, Symbol] uefi_shell_startup_location
+    # @param [String, Symbol] uefi_shell_startup_url
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_uefi_shell_startup(uefi_shell_startup, uefi_shell_startup_location, uefi_shell_startup_url)
+      new_action = {
+        'UefiShellStartup' => uefi_shell_startup,
+        'UefiShellStartupLocation' => uefi_shell_startup_location,
+        'UefiShellStartupUrl' => uefi_shell_startup_url
+      }
+      response = rest_patch('/redfish/v1/Systems/1/bios/Settings/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Get the BIOS DHCP
+    # @raise [RuntimeError] if the request failed
+    # @return [String] bios_dhcp
+    def get_bios_dhcp
+      response = rest_get('/redfish/v1/Systems/1/bios/Settings/')
+      bios = response_handler(response)
+      {
+        'Dhcpv4' => bios['Dhcpv4'],
+        'Ipv4Address' => bios['Ipv4Address'],
+        'Ipv4Gateway' => bios['Ipv4Gateway'],
+        'Ipv4PrimaryDNS' => bios['Ipv4PrimaryDNS'],
+        'Ipv4SecondaryDNS' => bios['Ipv4SecondaryDNS'],
+        'Ipv4SubnetMask' => bios['Ipv4SubnetMask']
+      }
+    end
+
+    # Set the BIOS DHCP
+    # @param [String, Symbol] dhcpv4
+    # @param [String, Symbol] ipv4_address
+    # @param [String, Symbol] ipv4_gateway
+    # @param [String, Symbol] ipv4_primary_dns
+    # @param [String, Symbol] ipv4_secondary_dns
+    # @param [String, Symbol] ipv4_subnet_mask
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_bios_dhcp(dhcpv4, ipv4_address = '', ipv4_gateway = '', ipv4_primary_dns = '', ipv4_secondary_dns = '', ipv4_subnet_mask = '')
+      new_action = {
+        'Dhcpv4' => dhcpv4,
+        'Ipv4Address' => ipv4_address,
+        'Ipv4Gateway' => ipv4_gateway,
+        'Ipv4PrimaryDNS' => ipv4_primary_dns,
+        'Ipv4SecondaryDNS' => ipv4_secondary_dns,
+        'Ipv4SubnetMask' => ipv4_subnet_mask
+      }
+      response = rest_patch('/redfish/v1/Systems/1/bios/Settings/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Get the URL boot file
+    # @raise [RuntimeError] if the request failed
+    # @return [String] url_boot_file
+    def get_url_boot_file
+      response = rest_get('/redfish/v1/Systems/1/bios/Settings/')
+      response_handler(response)['UrlBootFile']
+    end
+
+    # Set the URL boot file
+    # @param [String, Symbol] url_boot_file
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_url_boot_file(url_boot_file)
+      new_action = { 'UrlBootFile' => url_boot_file }
+      response = rest_patch('/redfish/v1/Systems/1/bios/Settings/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Get the BIOS service
+    # @raise [RuntimeError] if the request failed
+    # @return [String] bios_service
+    def get_bios_service
+      response = rest_get('/redfish/v1/Systems/1/bios/Settings/')
+      bios = response_handler(response)
+      {
+        'ServiceName' => bios['ServiceName'],
+        'ServiceEmail' => bios['ServiceEmail']
+      }
+    end
+
+    # Set the BIOS service
+    # @param [String, Symbol] name
+    # @param [String, Symbol] email
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_bios_service(name, email)
+      new_action = {
+        'ServiceName' => name,
+        'ServiceEmail' => email
+      }
+      response = rest_patch('/redfish/v1/Systems/1/bios/Settings/', body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end

data/lib/ilo-sdk/helpers/boot_settings_helper.rb

@@ -0,0 +1,74 @@
+# 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.
+
+module ILO_SDK
+  # Contains helper methods for Boot Settings actions
+  module BootSettingsHelper
+    # Get the boot base config
+    # @raise [RuntimeError] if the request failed
+    # @return [Fixnum] boot_baseconfig
+    def get_boot_baseconfig
+      response = rest_get('/redfish/v1/Systems/1/bios/Boot/Settings/')
+      response_handler(response)['BaseConfig']
+    end
+
+    # Revert the boot
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def revert_boot
+      new_action = { 'BaseConfig' => 'default' }
+      response = rest_patch('/redfish/v1/systems/1/bios/Boot/Settings/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Get the boot order
+    # @raise [RuntimeError] if the request failed
+    # @return [Fixnum] boot_order
+    def get_boot_order
+      response = rest_get('/redfish/v1/systems/1/bios/Boot/Settings/')
+      response_handler(response)['PersistentBootConfigOrder']
+    end
+
+    # Set the boot order
+    # @param [Fixnum] boot_order
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_boot_order(boot_order)
+      new_action = { 'PersistentBootConfigOrder' => boot_order }
+      response = rest_patch('/redfish/v1/systems/1/bios/Boot/Settings/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Get the temporary boot order
+    # @raise [RuntimeError] if the request failed
+    # @return [Fixnum] temporary_boot_order
+    def get_temporary_boot_order
+      response = rest_get('/redfish/v1/Systems/1/')
+      response_handler(response)['Boot']['BootSourceOverrideTarget']
+    end
+
+    # Set the temporary boot order
+    # @param [Fixnum] boot_target
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_temporary_boot_order(boot_target)
+      response = rest_get('/redfish/v1/Systems/1/')
+      boottargets = response_handler(response)['Boot']['BootSourceOverrideSupported']
+      unless boottargets.include? boot_target
+        raise "BootSourceOverrideTarget value - #{boot_target} is not supported. Valid values are: #{boottargets}"
+      end
+      new_action = { 'Boot' => { 'BootSourceOverrideTarget' => boot_target } }
+      response = rest_patch('/redfish/v1/Systems/1/', body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end

data/lib/ilo-sdk/helpers/chassis_helper.rb

@@ -0,0 +1,67 @@
+# 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.
+
+module ILO_SDK
+  # Contains helper methods for Chassis actions
+  module ChassisHelper
+    # Get the power metrics
+    # @raise [RuntimeError] if the request failed
+    # @return [Hash] power_metrics
+    def get_power_metrics
+      chassis = rest_get('/redfish/v1/Chassis/')
+      chassis_uri = response_handler(chassis)['links']['Member'][0]['href']
+      power_metrics_uri = response_handler(rest_get(chassis_uri))['links']['PowerMetrics']['href']
+      response = rest_get(power_metrics_uri)
+      metrics = response_handler(response)
+      power_supplies = []
+      metrics['PowerSupplies'].each do |ps|
+        power_supply = {
+          'LineInputVoltage' => ps['LineInputVoltage'],
+          'LineInputVoltageType' => ps['LineInputVoltageType'],
+          'PowerCapacityWatts' => ps['PowerCapacityWatts'],
+          'PowerSupplyType' => ps['PowerSupplyType'],
+          'Health' => ps['Status']['Health'],
+          'State' => ps['Status']['State']
+        }
+        power_supplies.push(power_supply)
+      end
+      {
+        @host => {
+          'PowerCapacityWatts' => metrics['PowerCapacityWatts'],
+          'PowerConsumedWatts' => metrics['PowerConsumedWatts'],
+          'PowerSupplies' => power_supplies
+        }
+      }
+    end
+
+    # Get the thermal metrics
+    # @raise [RuntimeError] if the request failed
+    # @return [Hash] thermal_metrics
+    def get_thermal_metrics
+      chassis = rest_get('/redfish/v1/Chassis/')
+      chassis_uri = response_handler(chassis)['links']['Member'][0]['href']
+      thermal_metrics_uri = response_handler(rest_get(chassis_uri))['links']['ThermalMetrics']['href']
+      response = rest_get(thermal_metrics_uri)
+      temperatures = response_handler(response)['Temperatures']
+      temp_details = []
+      temperatures.each do |temp|
+        temp_detail = {
+          'PhysicalContext' => temp['PhysicalContext'],
+          'Name' => temp['Name'],
+          'CurrentReading' => temp['ReadingCelsius'],
+          'CriticalThreshold' => temp['LowerThresholdCritical'],
+          'Health' => temp['Status']['Health'],
+          'State' => temp['Status']['State']
+        }
+        temp_details.push(temp_detail)
+      end
+      { @host => temp_details }
+    end
+  end
+end