ilo-sdk 1.0.0

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

@@ -0,0 +1,32 @@
+# 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 Secure Boot actions
+  module SecureBootHelper
+    # Get the UEFI secure boot
+    # @raise [RuntimeError] if the request failed
+    # @return [TrueClass, FalseClass] uefi_secure_boot
+    def get_uefi_secure_boot
+      response = rest_get('/redfish/v1/Systems/1/SecureBoot/')
+      response_handler(response)['SecureBootEnable']
+    end
+
+    # Set the UEFI secure boot true or false
+    # @param [Boolean] secure_boot_enable
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_uefi_secure_boot(secure_boot_enable)
+      new_action = { 'SecureBootEnable' => secure_boot_enable }
+      response = rest_patch('/redfish/v1/Systems/1/SecureBoot/', body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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 Service Root Actions
+  module ServiceRootHelper
+    # Get the schema information with given prefix
+    # @param [String, Symbol] schema_prefix
+    # @raise [RuntimeError] if the request failed
+    # @return [String] schema
+    def get_schema(schema_prefix)
+      response = rest_get('/redfish/v1/Schemas/')
+      schemas = response_handler(response)['Items']
+      schema = schemas.select { |s| s['Schema'].start_with?(schema_prefix) }
+      raise "NO schema found with this schema prefix : #{schema_prefix}" if schema.empty?
+      info = []
+      schema.each do |sc|
+        response = rest_get(sc['Location'][0]['Uri']['extref'])
+        schema_store = response_handler(response)
+        info.push(schema_store)
+      end
+      info
+    end
+
+    # Get the Registry with given registry_prefix
+    # @param [String, Symbol] registry_prefix
+    # @raise [RuntimeError] if the request failed
+    # @return [String] registry
+    def get_registry(registry_prefix)
+      response = rest_get('/redfish/v1/Registries/')
+      registries = response_handler(response)['Items']
+      registry = registries.select { |reg| reg['Schema'].start_with?(registry_prefix) }
+      info = []
+      registry.each do |reg|
+        response = rest_get(reg['Location'][0]['Uri']['extref'])
+        registry_store = response_handler(response)
+        info.push(registry_store)
+      end
+      info
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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 SNMP Service actions
+  module SNMPServiceHelper
+    # Get the SNMP Mode
+    # @raise [RuntimeError] if the request failed
+    # @return [String] snmp_mode
+    def get_snmp_mode
+      response = rest_get('/redfish/v1/Managers/1/SnmpService/')
+      response_handler(response)['Mode']
+    end
+
+    # Get the SNMP Alerts Enabled value
+    # @raise [RuntimeError] if the request failed
+    # @return [String] snmp_alerts_enabled
+    def get_snmp_alerts_enabled
+      response = rest_get('/redfish/v1/Managers/1/SnmpService/')
+      response_handler(response)['AlertsEnabled']
+    end
+
+    # Set the SNMP Mode and Alerts Enabled value
+    # @param [String, Symbol] snmp_mode
+    # @param [Boolean] snmp_alerts
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_snmp(snmp_mode, snmp_alerts)
+      new_action = { 'Mode' => snmp_mode, 'AlertsEnabled' => snmp_alerts }
+      response = rest_patch('/redfish/v1/Managers/1/SnmpService/', body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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 Virtual Media actions
+  module VirtualMediaHelper
+    # Get the Virtual Media Information
+    # @raise [RuntimeError] if the request failed
+    # @return [String] virtual_media
+    def get_virtual_media
+      response = rest_get('/redfish/v1/Managers/1/VirtualMedia/')
+      media = {}
+      response_handler(response)['links']['Member'].each do |vm|
+        response = rest_get(vm['href'])
+        virtual_media = response_handler(response)
+        media[virtual_media['Id']] = {
+          'Image' => virtual_media['Image'],
+          'MediaTypes' => virtual_media['MediaTypes']
+        }
+      end
+      media
+    end
+
+    # Return whether Virtual Media is inserted
+    # @raise [RuntimeError] if the request failed
+    # @return [TrueClass, FalseClass] virtual_media_inserted
+    def virtual_media_inserted?(id)
+      response = rest_get("/redfish/v1/Managers/1/VirtualMedia/#{id}/")
+      response_handler(response)['Inserted']
+    end
+
+    # Insert Virtual Media
+    # @param [String, Symbol] id
+    # @param [String, Symbol] image
+    # @return true
+    def insert_virtual_media(id, image)
+      new_action = {
+        'Action' => 'InsertVirtualMedia',
+        'Target' => '/Oem/Hp',
+        'Image' => image
+      }
+      response = rest_post("/redfish/v1/Managers/1/VirtualMedia/#{id}/", body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Eject Virtual Media
+    # @param [String, Symbol] id
+    # @return true
+    def eject_virtual_media(id)
+      new_action = {
+        'Action' => 'EjectVirtualMedia',
+        'Target' => '/Oem/Hp'
+      }
+      response = rest_post("/redfish/v1/Managers/1/VirtualMedia/#{id}/", body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end

data/lib/ilo-sdk/rest.rb

@@ -0,0 +1,165 @@
+# 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 'uri'
+require 'net/http'
+require 'openssl'
+require 'json'
+
+module ILO_SDK
+  # Contains all the methods for making API REST calls
+  module Rest
+    # Make a restful API request to the iLO
+    # @param [Symbol] type the rest method/type Options are :get, :post, :put, :patch, and :delete
+    # @param [String] path the path for the request. Usually starts with "/rest/"
+    # @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
+    # @return [NetHTTPResponse] The response object
+    def rest_api(type, path, options = {})
+      raise 'Must specify path' unless path
+      raise '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.use_ssl = true if uri.scheme == 'https'
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless @ssl_enabled
+
+      request = build_request(type, uri, options)
+      response = http.request(request)
+      @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 += ". 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"
+      @logger.error msg
+      raise e
+    end
+
+    # Make a restful GET request
+    # Parameters & return value align with those of the {ILO_SDK::Rest::rest_api} method above
+    def rest_get(path)
+      rest_api(:get, path, {})
+    end
+
+    # Make a restful POST request
+    # Parameters & return value align with those of the {ILO_SDK::Rest::rest_api} method above
+    def rest_post(path, options = {})
+      rest_api(:post, path, options)
+    end
+
+    # Make a restful PUT request
+    # Parameters & return value align with those of the {ILO_SDK::Rest::rest_api} method above
+    def rest_put(path, options = {})
+      rest_api(:put, path, options)
+    end
+
+    # Make a restful PATCH request
+    # Parameters & return value align with those of the {ILO_SDK::Rest::rest_api} method above
+    def rest_patch(path, options = {})
+      rest_api(:patch, path, options)
+    end
+
+    # Make a restful DELETE request
+    # Parameters & return value align with those of the {ILO_SDK::Rest::rest_api} method above
+    def rest_delete(path, options = {})
+      rest_api(:delete, path, options)
+    end
+
+    RESPONSE_CODE_OK           = 200
+    RESPONSE_CODE_CREATED      = 201
+    RESPONSE_CODE_ACCEPTED     = 202
+    RESPONSE_CODE_NO_CONTENT   = 204
+    RESPONSE_CODE_BAD_REQUEST  = 400
+    RESPONSE_CODE_UNAUTHORIZED = 401
+    RESPONSE_CODE_NOT_FOUND    = 404
+
+    # 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
+    # @return [Hash] The parsed JSON body
+    def response_handler(response)
+      case response.code.to_i
+      when RESPONSE_CODE_OK # Synchronous read/query
+        begin
+          return JSON.parse(response.body)
+        rescue JSON::ParserError => e
+          @logger.warn "Failed to parse JSON response. #{e}"
+          return response.body
+        end
+      when RESPONSE_CODE_CREATED # Synchronous add
+        return JSON.parse(response.body)
+      when RESPONSE_CODE_ACCEPTED # Asynchronous add, update or delete
+        return JSON.parse(response.body) # TODO: Remove when tested
+        # TODO: Make this actually wait for the task
+        # @logger.debug "Waiting for task: #{response.header['location']}"
+        # task = wait_for(response.header['location'])
+        # return true unless task['associatedResource'] && task['associatedResource']['resourceUri']
+        # resource_data = rest_get(task['associatedResource']['resourceUri'])
+        # return JSON.parse(resource_data.body)
+      when RESPONSE_CODE_NO_CONTENT # Synchronous delete
+        return {}
+      when RESPONSE_CODE_BAD_REQUEST
+        raise "400 BAD REQUEST #{response.body}"
+      when RESPONSE_CODE_UNAUTHORIZED
+        raise "401 UNAUTHORIZED #{response.body}"
+      when RESPONSE_CODE_NOT_FOUND
+        raise "404 NOT FOUND #{response.body}"
+      else
+        raise "#{response.code} #{response.body}"
+      end
+    end
+
+
+    private
+
+    def build_request(type, uri, options)
+      case type.downcase
+      when 'get', :get
+        request = Net::HTTP::Get.new(uri.request_uri)
+      when 'post', :post
+        request = Net::HTTP::Post.new(uri.request_uri)
+      when 'put', :put
+        request = Net::HTTP::Put.new(uri.request_uri)
+      when 'patch', :patch
+        request = Net::HTTP::Patch.new(uri.request_uri)
+      when 'delete', :delete
+        request = Net::HTTP::Delete.new(uri.request_uri)
+      else
+        raise "Invalid rest call: #{type}"
+      end
+      options['Content-Type'] ||= 'application/json'
+      options.delete('Content-Type') if [:none, 'none', nil].include?(options['Content-Type'])
+      auth = true
+      if [:none, 'none'].include?(options['auth'])
+        options.delete('auth')
+        auth = false
+      end
+      options.each do |key, val|
+        if key.to_s.downcase == 'body'
+          request.body = val.to_json rescue val
+        else
+          request[key] = val
+        end
+      end
+
+      filtered_options = options.to_s
+      filtered_options.gsub!(@password, 'filtered') if @password
+      @logger.debug "  Options: #{filtered_options}"
+
+      request.basic_auth(@user, @password) if auth
+      request
+    end
+  end
+end

data/lib/ilo-sdk/version.rb

@@ -0,0 +1,13 @@
+# 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.
+
+# Gem version defined here
+module ILO_SDK
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: ilo-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anirudh Gupta
+- Bik Bajwa
+- Jared Smartt
+- Vivek Bhatia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+description: Gem to interact with iLO API
+email:
+- anirudhg@hpe.com
+- bik.bajwa@hpe.com
+- jared.smartt@hpe.com
+- vivek.bhatia@hpe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ilo-sdk.gemspec
+- lib/ilo-sdk.rb
+- lib/ilo-sdk/client.rb
+- lib/ilo-sdk/helpers/account_service_helper.rb
+- lib/ilo-sdk/helpers/bios_helper.rb
+- lib/ilo-sdk/helpers/boot_settings_helper.rb
+- lib/ilo-sdk/helpers/chassis_helper.rb
+- lib/ilo-sdk/helpers/computer_details_helper.rb
+- lib/ilo-sdk/helpers/computer_system_helper.rb
+- lib/ilo-sdk/helpers/date_time_helper.rb
+- lib/ilo-sdk/helpers/firmware_update.rb
+- lib/ilo-sdk/helpers/log_entry_helper.rb
+- lib/ilo-sdk/helpers/manager_network_protocol_helper.rb
+- lib/ilo-sdk/helpers/power_helper.rb
+- lib/ilo-sdk/helpers/secure_boot_helper.rb
+- lib/ilo-sdk/helpers/service_root_helper.rb
+- lib/ilo-sdk/helpers/snmp_service_helper.rb
+- lib/ilo-sdk/helpers/virtual_media_helper.rb
+- lib/ilo-sdk/rest.rb
+- lib/ilo-sdk/version.rb
+homepage: https://github.com/HewlettPackard/ilo-sdk-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Gem to interact with iLO API
+test_files: []