ilo-sdk 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39068db4621e387c98482d7dc545fd8cb7ccf503
-  data.tar.gz: a05c6dec3838c31dfd7a706940c9adfa4e9f9c65
+  metadata.gz: 6ab6bf099aad85914a4e0a9b4c9399d9f263e722
+  data.tar.gz: ec8b5d88be00336190a2ee51f9f2e279c9fe75a9
 SHA512:
-  metadata.gz: 8d3e5c1ddc3d61d76d30dd920abc50c9c4f587e1b30c0671a6d3c68f84c5b5ac4dfb94aebbeb9d9f0f7a3e4961ac0efece73a369a13952b0a7df2baa2e66681b
-  data.tar.gz: 358cb51d0ab7746d292e6cf40dc4c66381440838effffa6817da7b0ef5a4fe4698c506c88747cb00ea7507b5537890ed0a5577af6b43e7cbc8b52e17842ff47b
+  metadata.gz: cacb3f0f39fc3bba895f1b1d7d2d8297c5ea9e850b3e967856fd965332f09168ee39e09e3d6467d4fa97e708bcf604a4cb22c819b477bba0e19e0bb7ba1efc13
+  data.tar.gz: 3e4a180967d557b4581d36c56042a39cf8cc945729db1ea4d0715da9d6ad9f7919f67e9a6886810edfeecf793be421f8e17ea3e3efabb450f316f9a3a512c693

data/.rubocop.yml

@@ -12,16 +12,20 @@ Metrics/ModuleLength:
 Metrics/ParameterLists:
   Max: 6
 
-Style/FileName:
-  Exclude:
-    - 'lib/ilo-sdk.rb'
-
 Style/IndentationWidth:
   Width: 2
 
 Style/VariableName:
   EnforcedStyle: snake_case
 
+Style/FileName:
+  Exclude:
+    - 'lib/ilo-sdk.rb'
+
+Style/AlignParameters:
+  Exclude:
+    - 'lib/ilo-sdk/cli.rb'
+
 
 Style/AccessorMethodName:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,18 @@
-## v1.0.0
-Initial release
+### New (Unreleased)
+ - Added custom exception classes
+ - Added disable_proxy client option
+ - Added CLI
+ - Support environment variables
+
+### v1.1.0
+ - Added ManagerAccountHelper (to allow setting user permissions)
+
+### v1.0.2
+ - Make client.get_certificate return the full X509 object
 
 ### v1.0.1
+ - Added SSL certificate helper methods
  - Make `pry` a development dependency, not a runtime dependency.
+
+## v1.0.0
+Initial release

data/README.md

@@ -1,8 +1,13 @@
 # Ruby SDK for HPE iLO
+
 [![Gem Version](https://badge.fury.io/rb/ilo-sdk.svg)](https://badge.fury.io/rb/ilo-sdk)
 
 Software Development Kit for interacting with the Hewlett Packard Enterprise iLO (Integrated Lights-Out) server management technology.
 
+### Supported iLO versions:
+
+- iLO 4
+
 ## Installation
 
 - Require the gem in your Gemfile:
@@ -20,8 +25,9 @@ Software Development Kit for interacting with the Hewlett Packard Enterprise iLO
 
 
 ## Client
-Everything you do with this API happens through a client object.  
-Creating the client object is the first step; then you can perform actions on the client.  
+
+Everything you do with this API happens through a client object.
+Creating the client object is the first step; then you can perform actions on the client.
 
 ```ruby
 require 'ilo-sdk'
@@ -31,13 +37,28 @@ client = ILO_SDK::Client.new(
   password: 'secret123',
   ssl_enabled: true,                  # This is the default and strongly encouraged
   logger: Logger.new(STDOUT),         # This is the default
-  log_level: :info                   # This is the default
+  log_level: :info,                   # This is the default
+  disable_proxy: true                 # Default is false. Set to disable, even if ENV['http_proxy'] is set
 )
 ```
 
-:lock: Tip: Check the file permissions because the password is stored in clear-text.
+:lock: Tip: Check the file permissions when storing passwords in clear-text.
+
+#### Environment Variables
+
+You can also set many client options using environment variables. For bash:
+
+```bash
+export ILO_HOST='https://oneview.example.com'
+export ILO_USER='Administrator'
+export ILO_PASSWORD='secret123'
+export ILO_SSL_ENABLED=false # NOTE: Disabling SSL is strongly discouraged. Please see the CLI section for import instructions.
+```
+
+:lock: Tip: Be sure nobody can access to your environment variables
 
 ### Custom logging
+
 The default logger is a standard logger to STDOUT, but if you want to specify your own, you can.  However, your logger must implement the following methods:
 
 ```ruby
@@ -50,9 +71,11 @@ level=(Symbol, etc.) # The parameter here will be the log_level attribute
 
 
 ## Actions
+
 Actions are performed on the client, and defined in the [helper modules](lib/ilo-sdk/helpers).
 
 #### Account Service
+
 ```ruby
 # Get list of users:
 users = client.get_users
@@ -68,7 +91,19 @@ client.delete_user('user1')
 ```
 
 #### Bios
+
 ```ruby
+# Get all BIOS settings
+settings = client.get_bios_settings
+
+# Set BIOS settings
+client.set_bios_settings(
+  UefiShellStartup: 'Enabled',
+  Ipv4Gateway: '10.0.1.1',
+  ServiceEmail: 'admin@domain.com'
+  # Note: You can set many more options here. This is just an example.
+)
+
 # Get BIOS base configuration:
 baseconfig = client.get_bios_baseconfig
 
@@ -105,11 +140,12 @@ bios_service_settings = client.get_bios_service
 
 # Set BIOS service settings:
 service_name = 'my_name'
-service_email = 'my_name@hpe.com'
+service_email = 'my_name@domain.com'
 client.set_bios_service(service_name, service_email)
 ```
 
 #### Boot Settings
+
 ```ruby
 # Get boot order base configuration:
 baseconfig = client.get_boot_baseconfig
@@ -140,6 +176,7 @@ client.set_temporary_boot_order(boot_source_override_target)
 ```
 
 #### Chassis
+
 ```ruby
 # Get power metrics information:
 power_metrics = client.get_power_metrics
@@ -149,6 +186,7 @@ thermal_metrics = client.get_thermal_metrics
 ```
 
 #### Computer Details
+
 ```ruby
 # Get computer details (including general, network, and array controller details):
 computer_details = client.get_computer_details
@@ -164,21 +202,21 @@ array_controller_details = client.get_array_controller_details
 ```
 
 #### Computer System
-```ruby
-# Get the computer system asset tag:
-asset_tag = client.get_asset_tag
-
-# Set the computer system asset tag:
-client.set_asset_tag('HP001')
 
-# Get the indicator led state:
-indicator_led = client.get_indicator_led
-
-# Set the indicator led state:
-client.set_indicator_led('Lit')
+```ruby
+# Get computer system settings
+settings = client.get_system_settings
+
+# Set computer system settings
+client.set_system_settings(
+  AssetTag: 'HP001',
+  IndicatorLED: 'Lit'
+  # Note: You can set more options here. This is just an example.
+)
 ```
 
 #### Date Time
+
 ```ruby
 # Get the time zone:
 time_zone = client.get_time_zone
@@ -201,6 +239,7 @@ client.set_ntp_server(ntp_servers)
 ```
 
 #### Firmware
+
 ```ruby
 # Get the firmware version:
 fw_version = client.get_fw_version
@@ -210,6 +249,7 @@ client.set_fw_upgrade('www.firmwareupgrade.com')
 ```
 
 #### HTTPS Certificate
+
 ```ruby
 # Get the current SSL Certificate and check to see if expires within 24 hours
 expiration = client.get_certificate.not_after.to_datetime
@@ -240,6 +280,7 @@ end
 ```
 
 #### Log Entry
+
 ```ruby
 # Clear a specific type of logs:
 log_type = 'IEL'
@@ -254,7 +295,8 @@ duration = 10 # hours
 logs = client.get_log(severity_level, duration, log_type)
 ```
 
-### Manager Account
+#### Manager Account
+
 ```ruby
 # Get the Account Privileges for a specific user:
 username = 'Administrator'
@@ -276,6 +318,7 @@ client.set_account_privileges(username, privileges)
 ```
 
 #### Manager Network Protocol
+
 ```ruby
 # Get the minutes until session timeout:
 timeout = client.get_timeout
@@ -285,6 +328,7 @@ client.set_timeout(60)
 ```
 
 #### Power
+
 ```ruby
 # Get the power state of the system:
 power_state = client.get_power_state
@@ -297,6 +341,7 @@ client.reset_ilo
 ```
 
 #### Secure Boot
+
 ```ruby
 # Get whether or not UEFI secure boot is enabled:
 uefi_secure_boot = client.get_uefi_secure_boot
@@ -306,6 +351,7 @@ client.set_uefi_secure_boot(true)
 ```
 
 #### Service Root
+
 ```ruby
 # Get the schema information with a given prefix:
 schema_prefix = 'Account'
@@ -317,6 +363,7 @@ registry = client.get_registry(registry_prefix)
 ```
 
 #### SNMP
+
 ```ruby
 # Get the SNMP mode:
 snmp_mode = client.get_snmp_mode
@@ -331,6 +378,7 @@ client.set_snmp(snmp_mode, snmp_alerts_enabled)
 ```
 
 #### Virtual Media
+
 ```ruby
 # Get the virtual media information:
 virtual_media = client.get_virtual_media
@@ -348,6 +396,7 @@ client.eject_virtual_media(id)
 ```
 
 ## Custom requests
+
 In most cases, interacting with the client object is enough, but sometimes you need to make your own custom requests to the iLO.
 This project makes it extremely easy to do with some built-in methods for the client object. Here are some examples:
 
@@ -365,11 +414,36 @@ This example is about as basic as it gets, but you can make any type of iLO requ
 If a resource does not do what you need, this will allow you to do it.
 Please refer to the documentation and [code](lib/ilo-sdk/rest.rb) for complete list of methods and information about how to use them.
 
+
+## CLI
+
+This gem also comes with a command-line interface to make interracting with the iLO API without needing to create a Ruby program.
+
+Note: In order to use this, you will need to make sure your ruby bin directory is in your path. Run $ gem environment to see where the executable paths are for your Ruby installation.
+
+To get started, run `$ ilo-ruby --help`.
+
+To communicate with an appliance, you will need to set up a few environment variables so it knows how to communicate. Run $ ilo-ruby env to see the available environment variables.
+
+Here are a few examples of how you might want to use the CLI:
+
+##### Start an interactive console session with an iLO connection:
+
+```bash
+$ ilo-ruby console
+Connected to https://ilo.example.com
+HINT: The @client object is available to you
+>
+```
+
+
 ## License
+
 This project is licensed under the Apache 2.0 license. Please see [LICENSE](LICENSE) for more info.
 
 
 ## Contributing and feature requests
+
 **Contributing:** You know the drill. Fork it, branch it, change it, commit it, and pull-request it.
 We are passionate about improving this project, and glad to accept help to make it better. However, keep the following in mind:
 
@@ -381,11 +455,13 @@ We are passionate about improving this project, and glad to accept help to make
 This feedback is crucial for us to deliver a useful product. Do not assume we have already thought of everything, because we assure you that is not the case.
 
 ### Building the Gem
+
 First run `$ bundle` (requires the bundler gem), then...
  - To build only, run `$ rake build`.
  - To build and install the gem, run `$ rake install`.
 
 ### Testing
+
  - RuboCop: `$ rake rubocop`
  - Unit: `$ rake spec`
  - All test: `$ rake test`
@@ -393,6 +469,7 @@ First run `$ bundle` (requires the bundler gem), then...
 Note: run `$ rake -T` to get a list of all the available rake tasks.
 
 ## Authors
+
  - Anirudh Gupta - [@Anirudh-Gupta](https://github.com/Anirudh-Gupta)
  - Bik Bajwa - [@bikbajwa](https://github.com/bikbajwa)
  - Jared Smartt - [@jsmartt](https://github.com/jsmartt)

data/bin/ilo-ruby

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'ilo-sdk'
+ILO_SDK::Cli::Runner.new(ARGV.dup).execute!

data/ilo-sdk.gemspec

@@ -1,10 +1,10 @@
 # coding: utf-8
 # http://guides.rubygems.org/specification-reference
 
-# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+# (c) Copyright 2016 Hewlett Packard Enterprise Development LP
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
-# You may not use this file except in compliance with 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
@@ -29,7 +29,9 @@ Gem::Specification.new do |spec|
   spec.executables   = all_files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'pry'
+  spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'pry'
+
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rake'

data/lib/ilo-sdk.rb

@@ -1,7 +1,7 @@
-# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+# (c) Copyright 2016 Hewlett Packard Enterprise Development LP
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
-# You may not use this file except in compliance with 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
@@ -11,7 +11,10 @@
 
 require_relative 'ilo-sdk/version'
 require_relative 'ilo-sdk/client'
+require_relative 'ilo-sdk/exceptions'
+require_relative 'ilo-sdk/cli'
 
 # Module for interracting with the HPE iLO API
 module ILO_SDK
+  ENV_VARS = %w(ILO_HOST ILO_USER ILO_PASSWORD ILO_SSL_ENABLED).freeze
 end

data/lib/ilo-sdk/cli.rb

@@ -0,0 +1,214 @@
+# (c) Copyright 2016 Hewlett Packard Enterprise Development LP
+#
+# 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 'thor'
+require 'json'
+require 'yaml'
+
+module ILO_SDK
+  # cli for ilo-sdk
+  class Cli < Thor
+    # Runner class to enable testing
+    class Runner
+      def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+        @argv = argv
+        @stdin = stdin
+        @stdout = stdout
+        @stderr = stderr
+        @kernel = kernel
+      end
+
+      def execute!
+        exit_code = begin
+          $stderr = @stderr
+          $stdin  = @stdin
+          $stdout = @stdout
+
+          ILO_SDK::Cli.start(@argv)
+          0
+        rescue StandardError => e
+          b = e.backtrace
+          @stderr.puts("#{b.shift}: #{e.message} (#{e.class})")
+          @stderr.puts(b.map { |s| "\tfrom #{s}" }.join("\n"))
+          1
+        rescue SystemExit => e
+          e.status
+        end
+
+        # Proxy our exit code back to the injected kernel.
+        @kernel.exit(exit_code)
+      end
+    end
+
+    class_option :ssl_verify,
+      type: :boolean,
+      desc: 'Enable/Disable SSL verification for requests. Can also use ENV[\'ILO_SSL_ENABLED\']',
+      default: nil
+
+    class_option :host,
+      desc: 'Hostname or URL of iLO. Can also use ENV[\'ILO_HOST\']'
+
+    class_option :user,
+      desc: 'Username. Can also use ENV[\'ILO_USER\']',
+      aliases: '-u'
+
+    class_option :log_level,
+      desc: 'Log level to use',
+      aliases: '-l',
+      enum: %w(debug info warn error),
+      default: 'warn'
+
+    map ['-v', '--version'] => :version
+
+
+    method_option :format,
+      desc: 'Output format',
+      aliases: '-f',
+      enum: %w(json yaml human),
+      default: 'human'
+    desc 'env', 'Show environment variables for ilo-sdk for Ruby'
+    def env
+      data = {}
+      ILO_SDK::ENV_VARS.each { |k| data[k] = ENV[k] }
+      if @options['format'] == 'human'
+        data.each do |key, value|
+          value = "'#{value}'" if value && ! %w(true false).include?(value)
+          printf "%-#{data.keys.max_by(&:length).length}s = %s\n", key, value || 'nil'
+        end
+      else
+        output(parse_hash(data, true))
+      end
+    end
+
+    desc 'console', 'Open a Ruby console with a connection to iLO'
+    def console
+      client_setup({}, true, true)
+      puts "Connected to #{@client.host}"
+      puts "HINT: The @client object is available to you\n\n"
+    rescue
+      puts "WARNING: Couldn't connect to #{@options['host'] || ENV['ILO_HOST'] || 'nil (host not set)'}\n\n"
+    ensure
+      require 'pry'
+      Pry.config.prompt = proc { '> ' }
+      Pry.plugins['stack_explorer'] && Pry.plugins['stack_explorer'].disable!
+      Pry.plugins['byebug'] && Pry.plugins['byebug'].disable!
+      Pry.start(ILO_SDK::Console.new(@client))
+    end
+
+    desc 'version', 'Print gem and iLO API versions'
+    def version
+      puts "Gem Version: #{ILO_SDK::VERSION}"
+      client_setup({ 'log_level' => :error }, true)
+      ver = @client.response_handler(@client.rest_get('/redfish/v1/'))['RedfishVersion']
+      puts "iLO Redfish API version: #{ver}"
+    rescue StandardError, SystemExit
+      puts 'iLO API version unknown'
+    end
+
+    desc 'login', 'Attempt loading an authenticated API endpoint'
+    def login
+      client_setup
+      @client.response_handler(@client.rest_get('/redfish/v1/Sessions/'))
+      puts 'Login Successful!'
+    end
+
+    private
+
+    def fail_nice(msg = nil)
+      puts "ERROR: #{msg}" if msg
+      exit 1
+    end
+
+    def client_setup(client_params = {}, quiet = false, throw_errors = false)
+      client_params['ssl_enabled'] = true if @options['ssl_verify'] == true
+      client_params['ssl_enabled'] = false if @options['ssl_verify'] == false
+      client_params['host'] ||= @options['host'] if @options['host']
+      client_params['user'] ||= @options['user'] if @options['user']
+      client_params['log_level'] ||= @options['log_level'].to_sym if @options['log_level']
+      @client = ILO_SDK::Client.new(client_params)
+    rescue StandardError => e
+      raise e if throw_errors
+      fail_nice if quiet
+      fail_nice "Failed to login to iLO at '#{client_params['host'] || ENV['ILO_HOST']}'. Message: #{e}"
+    end
+
+    # Parse options hash from input. Handles chaining and keywords such as true/false & nil
+    # Returns new hash with proper nesting and formatting
+    def parse_hash(hash, convert_types = false)
+      new_hash = {}
+      hash.each do |k, v|
+        if convert_types
+          v = v.to_i if v && v.match(/^\d+$/)
+          v = true if v == 'true'
+          v = false if v == 'false'
+          v = nil if v == 'nil'
+        end
+        if k =~ /\./
+          sub_hash = new_hash
+          split = k.split('.')
+          split.each do |sub_key|
+            if sub_key == split.last
+              sub_hash[sub_key] = v
+            else
+              sub_hash[sub_key] ||= {}
+              sub_hash = sub_hash[sub_key]
+            end
+          end
+          new_hash[split.first] ||= {}
+        else
+          new_hash[k] = v
+        end
+      end
+      new_hash
+    end
+
+    # Print output in a given format.
+    def output(data = {}, indent = 0)
+      case @options['format']
+      when 'json'
+        puts JSON.pretty_generate(data)
+      when 'yaml'
+        puts data.to_yaml
+      else
+        # rubocop:disable Metrics/BlockNesting
+        if data.class == Hash
+          data.each do |k, v|
+            if v.class == Hash || v.class == Array
+              puts "#{' ' * indent}#{k.nil? ? 'nil' : k}:"
+              output(v, indent + 2)
+            else
+              puts "#{' ' * indent}#{k.nil? ? 'nil' : k}: #{v.nil? ? 'nil' : v}"
+            end
+          end
+        elsif data.class == Array
+          data.each do |d|
+            if d.class == Hash || d.class == Array
+              output(d, indent + 2)
+            else
+              puts "#{' ' * indent}#{d.nil? ? 'nil' : d}"
+            end
+          end
+          puts "\nTotal: #{data.size}" if indent < 1
+        else
+          puts "#{' ' * indent}#{data.nil? ? 'nil' : data}"
+        end
+        # rubocop:enable Metrics/BlockNesting
+      end
+    end
+  end
+
+  # Console class
+  class Console
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/lib/ilo-sdk/client.rb

@@ -17,32 +17,48 @@ Dir[File.join(File.dirname(__FILE__), '/helpers/*.rb')].each { |file| require fi
 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
+    attr_accessor :host, :user, :password, :ssl_enabled, :disable_proxy, :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] :host (ENV['ILO_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?
+    # @option options [Boolean] :disable_proxy (false) Disable usage of a proxy 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 = options[:host] || ENV['ILO_HOST']
+      raise InvalidClient, '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
+      @ssl_enabled = true # Default
+      if ENV.key?('ILO_SSL_ENABLED')
+        @ssl_enabled = case ENV['ILO_SSL_ENABLED']
+                       when 'true', '1' then true
+                       when 'false', '0' then false
+                       else ENV['ILO_SSL_ENABLED']
+                       end
+      end
+      @ssl_enabled = options[:ssl_enabled] unless options[:ssl_enabled].nil?
+      unless [true, false].include?(@ssl_enabled)
+        raise InvalidClient, "ssl_enabled option must be true or false. Got '#{@ssl_enabled}'"
+      end
+      unless @ssl_enabled
+        @logger.warn "SSL is disabled for all requests to #{@host}! We recommend you import the necessary certificates instead. of disabling SSL"
+      end
+      @disable_proxy = options[:disable_proxy]
+      raise InvalidClient, 'disable_proxy option must be true, false, or nil' unless [true, false, nil].include?(@disable_proxy)
+      @logger.warn 'User option not set. Using default (Administrator)' unless options[:user] || ENV['ILO_USER']
+      @user = options[:user] || ENV['ILO_USER'] || 'Administrator'
+      @password = options[:password] || ENV['ILO_PASSWORD']
+      raise InvalidClient, 'Must set the password option' unless @password
     end
 
     include Rest

data/lib/ilo-sdk/exceptions.rb

@@ -0,0 +1,31 @@
+# (c) Copyright 2016 Hewlett Packard Enterprise Development LP
+#
+# 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.
+
+# Contains all the custom Exception classes
+module ILO_SDK
+  class InvalidClient < StandardError # Client configuration is invalid
+  end
+
+  class InvalidRequest < StandardError # Could not make request
+  end
+
+  class BadRequest < StandardError # 400
+  end
+
+  class Unauthorized < StandardError # 401
+  end
+
+  class NotFound < StandardError # 404
+  end
+
+  class RequestError < StandardError # Other bad response codes
+  end
+end

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

@@ -12,6 +12,25 @@
 module ILO_SDK
   # Contains helper methods for Bios actions
   module BiosHelper
+    # Get all the BIOS settings
+    # @param system_id [Integer, String] ID of the system
+    # @raise [RuntimeError] if the request failed
+    # @return [Hash] BIOS settings
+    def get_bios_settings(system_id = 1)
+      response_handler(rest_get("/redfish/v1/Systems/#{system_id}/bios/Settings/"))
+    end
+
+    # Set BIOS settings
+    # @param options [Hash] Hash of options to set
+    # @param system_id [Integer, String] ID of the system
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_bios_settings(options, system_id = 1)
+      r = response_handler(rest_patch("/redfish/v1/Systems/#{system_id}/bios/Settings/", body: options))
+      @logger.warn(r) if r['error']
+      true
+    end
+
     # Get the bios base config
     # @raise [RuntimeError] if the request failed
     # @return [Fixnum] bios_baseconfig
@@ -44,9 +63,9 @@ module ILO_SDK
     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
+    # @param uefi_shell_startup [String, Symbol]
+    # @param uefi_shell_startup_location [String, Symbol]
+    # @param uefi_shell_startup_url [String, Symbol]
     # @raise [RuntimeError] if the request failed
     # @return true
     def set_uefi_shell_startup(uefi_shell_startup, uefi_shell_startup_location, uefi_shell_startup_url)
@@ -77,12 +96,12 @@ module ILO_SDK
     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
+    # @param dhcpv4 [String, Symbol]
+    # @param ipv4_address [String, Symbol]
+    # @param ipv4_gateway [String, Symbol]
+    # @param ipv4_primary_dns [String, Symbol]
+    # @param ipv4_secondary_dns [String, Symbol]
+    # @param ipv4_subnet_mask [String, Symbol]
     # @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 = '')
@@ -108,7 +127,7 @@ module ILO_SDK
     end
 
     # Set the URL boot file
-    # @param [String, Symbol] url_boot_file
+    # @param url_boot_file [String, Symbol]
     # @raise [RuntimeError] if the request failed
     # @return true
     def set_url_boot_file(url_boot_file)
@@ -131,8 +150,8 @@ module ILO_SDK
     end
 
     # Set the BIOS service
-    # @param [String, Symbol] name
-    # @param [String, Symbol] email
+    # @param name [String, Symbol]
+    # @param email [String, Symbol]
     # @raise [RuntimeError] if the request failed
     # @return true
     def set_bios_service(name, email)

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

@@ -1,7 +1,7 @@
-# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+# (c) Copyright 2016 Hewlett Packard Enterprise Development LP
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
-# You may not use this file except in compliance with 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
@@ -12,19 +12,41 @@
 module ILO_SDK
   # Contains helper methods for Computer System actions
   module ComputerSystemHelper
+    # Get the computer system settings
+    # @param system_id [Integer, String] ID of the system
+    # @raise [RuntimeError] if the request failed
+    # @return [Hash] Computer system settings
+    def get_system_settings(system_id = 1)
+      response_handler(rest_get("/redfish/v1/Systems/#{system_id}/"))
+    end
+
+    # Set computer system settings
+    # @param options [Hash] Hash of options to set
+    # @param system_id [Integer, String] ID of the system
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_system_settings(options, system_id = 1)
+      response_handler(rest_patch("/redfish/v1/Systems/#{system_id}/", body: options))
+      true
+    end
+
     # Get the Asset Tag
+    # @deprecated Use {#get_system_settings} instead
     # @raise [RuntimeError] if the request failed
     # @return [String] asset_tag
     def get_asset_tag
+      @logger.warn '[Deprecated] `get_asset_tag` is deprecated. Please use `get_system_settings[\'AssetTag\']` instead.'
       response = rest_get('/redfish/v1/Systems/1/')
       response_handler(response)['AssetTag']
     end
 
     # Set the Asset Tag
-    # @param [String, Symbol] asset_tag
+    # @deprecated Use {#set_system_settings} instead
+    # @param asset_tag [String, Symbol]
     # @raise [RuntimeError] if the request failed
     # @return true
     def set_asset_tag(asset_tag)
+      @logger.warn '[Deprecated] `set_asset_tag` is deprecated. Please use `set_system_settings(AssetTag: <tag>)` instead.'
       new_action = { 'AssetTag' => asset_tag }
       response = rest_patch('/redfish/v1/Systems/1/', body: new_action)
       response_handler(response)
@@ -32,18 +54,22 @@ module ILO_SDK
     end
 
     # Get the UID indicator LED state
+    # @deprecated Use {#get_system_settings} instead
     # @raise [RuntimeError] if the request failed
     # @return [String] indicator_led
     def get_indicator_led
+      @logger.warn '[Deprecated] `get_indicator_led` is deprecated. Please use `get_system_settings[\'IndicatorLED\']` instead.'
       response = rest_get('/redfish/v1/Systems/1/')
       response_handler(response)['IndicatorLED']
     end
 
     # Set the UID indicator LED
-    # @param [String, Symbol] state
+    # @deprecated Use {#set_system_settings} instead
+    # @param state [String, Symbol]
     # @raise [RuntimeError] if the request failed
     # @return true
     def set_indicator_led(state)
+      @logger.warn '[Deprecated] `set_indicator_led` is deprecated. Please use `set_system_settings(IndicatorLED: <state>)` instead.'
       new_action = { 'IndicatorLED' => state }
       response = rest_patch('/redfish/v1/Systems/1/', body: new_action)
       response_handler(response)

data/lib/ilo-sdk/rest.rb

@@ -1,4 +1,4 @@
-# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+# (c) Copyright 2016 Hewlett Packard Enterprise Development LP
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # You may not use this file except in compliance with the License.
@@ -23,14 +23,17 @@ module ILO_SDK
     # @param [Hash] options the options for the request
     # @option options [String] :body Hash to be converted into json and set as the request body
     # @option options [String] :Content-Type ('application/json') Set to nil or :none to have this option removed
+    # @raise [InvalidRequest] if the request is invalid
+    # @raise [SocketError] if a connection could not be made
+    # @raise [OpenSSL::SSL::SSLError] if SSL validation of the iLO's certificate failed
     # @return [NetHTTPResponse] The response object
     def rest_api(type, path, options = {})
-      raise 'Must specify path' unless path
-      raise 'Must specify type' unless type
+      raise InvalidRequest, 'Must specify path' unless path
+      raise InvalidRequest, 'Must specify type' unless type
       @logger.debug "Making :#{type} rest call to #{@host}#{path}"
 
       uri = URI.parse(URI.escape("#{@host}#{path}"))
-      http = Net::HTTP.new(uri.host, uri.port)
+      http = @disable_proxy ? Net::HTTP.new(uri.host, uri.port, nil, nil) : Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.scheme == 'https'
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless @ssl_enabled
 
@@ -39,12 +42,15 @@ module ILO_SDK
       @logger.debug "  Response: Code=#{response.code}. Headers=#{response.to_hash}\n  Body=#{response.body}"
       response
     rescue OpenSSL::SSL::SSLError => e
-      msg = 'SSL verification failed for request. Please either:'
-      msg += "\n  1. Install the certificate into your cert store"
+      msg = 'SSL verification failed for the request. Please either:'
+      msg += "\n  1. Install the necessary certificate(s) into your cert store"
       msg += ". Using cert store: #{ENV['SSL_CERT_FILE']}" if ENV['SSL_CERT_FILE']
-      msg += "\n  2. Set the :ssl_enabled option to false for your ilo client"
+      msg += "\n  2. Set the :ssl_enabled option to false for your iLO client (not recommended)"
       @logger.error msg
       raise e
+    rescue SocketError => e
+      e.message.prepend("Failed to connect to iLO host #{@host}!\n")
+      raise e
     end
 
     # Make a restful GET request
@@ -88,8 +94,10 @@ module ILO_SDK
     # Handle the response for rest call.
     #   If an asynchronous task was started, this waits for it to complete.
     # @param [HTTPResponse] HTTP response
-    # @raise [RuntimeError] if the request failed
-    # @raise [RuntimeError] if a task was returned that did not complete successfully
+    # @raise [ILO_SDK::BadRequest] if the request failed with a 400 status
+    # @raise [ILO_SDK::Unauthorized] if the request failed with a 401 status
+    # @raise [ILO_SDK::NotFound] if the request failed with a 404 status
+    # @raise [ILO_SDK::RequestError] if the request failed with any other status
     # @return [Hash] The parsed JSON body
     def response_handler(response)
       case response.code.to_i
@@ -113,19 +121,23 @@ module ILO_SDK
       when RESPONSE_CODE_NO_CONTENT # Synchronous delete
         return {}
       when RESPONSE_CODE_BAD_REQUEST
-        raise "400 BAD REQUEST #{response.body}"
+        raise BadRequest, "400 BAD REQUEST #{response.body}"
       when RESPONSE_CODE_UNAUTHORIZED
-        raise "401 UNAUTHORIZED #{response.body}"
+        raise Unauthorized, "401 UNAUTHORIZED #{response.body}"
       when RESPONSE_CODE_NOT_FOUND
-        raise "404 NOT FOUND #{response.body}"
+        raise NotFound, "404 NOT FOUND #{response.body}"
       else
-        raise "#{response.code} #{response.body}"
+        raise RequestError, "#{response.code} #{response.body}"
       end
     end
 
 
     private
 
+    # @param type [Symbol] The type of request object to build (get, post, put, patch, or delete)
+    # @param uri [URI] URI object
+    # @param options [Hash] Options for building the request. All options except "body" are set as headers.
+    # @raise [ILO_SDK::InvalidRequest] if the request type is not recognized
     def build_request(type, uri, options)
       case type.downcase
       when 'get', :get
@@ -139,7 +151,7 @@ module ILO_SDK
       when 'delete', :delete
         request = Net::HTTP::Delete.new(uri.request_uri)
       else
-        raise "Invalid rest call: #{type}"
+        raise InvalidRequest, "Invalid rest call: #{type}"
       end
       options['Content-Type'] ||= 'application/json'
       options.delete('Content-Type') if [:none, 'none', nil].include?(options['Content-Type'])

data/lib/ilo-sdk/version.rb

@@ -1,7 +1,7 @@
-# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+# (c) Copyright 2016 Hewlett Packard Enterprise Development LP
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
-# You may not use this file except in compliance with 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
@@ -11,5 +11,5 @@
 
 # Gem version defined here
 module ILO_SDK
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ilo-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Anirudh Gupta
@@ -11,8 +11,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -20,7 +34,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -103,7 +117,8 @@ email:
 - bik.bajwa@hpe.com
 - jared.smartt@hpe.com
 - vivek.bhatia@hpe.com
-executables: []
+executables:
+- ilo-ruby
 extensions: []
 extra_rdoc_files: []
 files:
@@ -115,9 +130,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/ilo-ruby
 - ilo-sdk.gemspec
 - lib/ilo-sdk.rb
+- lib/ilo-sdk/cli.rb
 - lib/ilo-sdk/client.rb
+- lib/ilo-sdk/exceptions.rb
 - lib/ilo-sdk/helpers/account_service_helper.rb
 - lib/ilo-sdk/helpers/bios_helper.rb
 - lib/ilo-sdk/helpers/boot_settings_helper.rb