ilo-sdk 1.0.0

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

@@ -0,0 +1,158 @@
+# 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 computer details actions
+  module ComputerDetailsHelper
+    # Get all of the computer details
+    # @raise [RuntimeError] if the request failed
+    # @return [Hash] computer_details
+    def get_computer_details
+      general_computer_details = get_general_computer_details
+      computer_network_details = get_computer_network_details
+      array_controller_details = get_array_controller_details
+      general_computer_details.merge(computer_network_details).merge(array_controller_details)
+    end
+
+    # Get the general computer details
+    # @raise [RuntimeError] if the request failed
+    # @return [Fixnum] general_computer_details
+    def get_general_computer_details
+      response = rest_get('/redfish/v1/Systems/1/')
+      details = response_handler(response)
+      {
+        'GeneralDetails' => {
+          'manufacturer' => details['Manufacturer'],
+          'model' => details['Model'],
+          'AssetTag' => details['AssetTag'],
+          'bios_version' => details['Bios']['Current']['VersionString'],
+          'memory' => details['Memory']['TotalSystemMemoryGB'].to_s + ' GB',
+          'processors' => details['Processors']['Count'].to_s + ' x ' + details['Processors']['ProcessorFamily'].to_s
+        }
+      }
+    end
+
+    # Get the computer network details
+    # @raise [RuntimeError] if the request failed
+    # @return [Hash] computer_network_details
+    def get_computer_network_details
+      network_adapters = []
+      response = rest_get('/redfish/v1/Systems/1/NetworkAdapters/')
+      networks = response_handler(response)['links']['Member']
+      networks.each do |network|
+        response = rest_get(network['href'])
+        detail = response_handler(response)
+        physical_ports = []
+        detail['PhysicalPorts'].each do |port|
+          n = {
+            'Name' => port['Name'],
+            'StructuredName' => port['Oem']['Hp']['StructuredName'],
+            'MacAddress' => port['MacAddress'],
+            'State' => port['Status']['State']
+          }
+          physical_ports.push(n)
+        end
+        nets = {
+          'Name' => detail['Name'],
+          'StructuredName' => detail['StructuredName'],
+          'PartNumber' => detail['PartNumber'],
+          'State' => detail['Status']['State'],
+          'Health' => detail['Status']['Health'],
+          'PhysicalPorts' => physical_ports
+        }
+        network_adapters.push(nets)
+      end
+      {
+        'NetworkAdapters' => network_adapters
+      }
+    end
+
+    # Get the array controller details
+    # @raise [RuntimeError] if the request failed
+    # @return [Hash] array_controller_details
+    def get_array_controller_details
+      response = rest_get('/redfish/v1/Systems/1/SmartStorage/')
+      storages = response_handler(response)
+      array_controllers = []
+      response = rest_get(storages['links']['ArrayControllers']['href'])
+      array_ctrls = response_handler(response)
+      if array_ctrls['links'].key? 'Member'
+        array_ctrls['links']['Member'].each do |array_controller|
+          response = rest_get(array_controller['href'])
+          controller = response_handler(response)
+          storage_enclosures = []
+          response = rest_get(controller['links']['StorageEnclosures']['href'])
+          response_handler(response)['links']['Member'].each do |enclosure|
+            response = rest_get(enclosure['href'])
+            enclsr = response_handler(response)
+            enc = {
+              'Model' => enclsr['Model'],
+              'SerialNumber' => enclsr['SerialNumber'],
+              'DriveBayCount' => enclsr['DriveBayCount'],
+              'State' => enclsr['Status']['State'],
+              'Health' => enclsr['Status']['Health'],
+              'Location' => enclsr['Location'].to_s + ' (' + enclsr['LocationFormat'].to_s + ')',
+              'FirmwareVersion' => enclsr['FirmwareVersion']['Current']['VersionString']
+            }
+            storage_enclosures.push(enc)
+          end
+
+          logical_drives = []
+          response = rest_get(controller['links']['LogicalDrives']['href'])
+          response_handler(response)['links']['Member'].each do |logicaldrive|
+            response = rest_get(logicaldrive['href'])
+            lds = response_handler(response)
+            data_drives = []
+            response = rest_get(lds['links']['DataDrives']['href'])
+            response_handler(response)['links']['Member'].each do |datadrives|
+              response = rest_get(datadrives['href'])
+              disk_drive = response_handler(response)
+              dd = {
+                'Model' => disk_drive['Model'],
+                'Name' => disk_drive['Name'],
+                'RotationalSpeedRpm' => disk_drive['RotationalSpeedRpm'],
+                'SerialNumber' => disk_drive['SerialNumber'],
+                'State' => disk_drive['Status']['State'],
+                'Health' => disk_drive['Status']['Health'],
+                'CapacityMiB' => disk_drive['CapacityMiB'],
+                'CurrentTemperatureCelsius' => disk_drive['CurrentTemperatureCelsius']
+              }
+              data_drives.push(dd)
+            end
+            ld = {
+              'Size' => lds['CapacityMiB'],
+              'Raid' => lds['Raid'],
+              'Status' => lds['Status']['State'],
+              'Health' => lds['Status']['Health'],
+              'DataDrives' => data_drives
+            }
+            logical_drives.push(ld)
+          end
+          ac = {
+            'Model' => controller['Model'],
+            'SerialNumber' => controller['SerialNumber'],
+            'State' => controller['Status']['State'],
+            'Health' => controller['Status']['Health'],
+            'Location' => controller['Location'],
+            'FirmWareVersion' => controller['FirmwareVersion']['Current']['VersionString'],
+            'LogicalDrives' => logical_drives,
+            'Enclosures' => storage_enclosures
+          }
+          array_controllers.push(ac)
+        end
+      end
+      {
+        'HPSmartStorage' => {
+          'Health' => storages['Status']['Health'],
+          'ArrayControllers' => array_controllers
+        }
+      }
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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 Computer System actions
+  module ComputerSystemHelper
+    # Get the Asset Tag
+    # @raise [RuntimeError] if the request failed
+    # @return [String] asset_tag
+    def get_asset_tag
+      response = rest_get('/redfish/v1/Systems/1/')
+      response_handler(response)['AssetTag']
+    end
+
+    # Set the Asset Tag
+    # @param [String, Symbol] asset_tag
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_asset_tag(asset_tag)
+      new_action = { 'AssetTag' => asset_tag }
+      response = rest_patch('/redfish/v1/Systems/1/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Get the UID indicator LED state
+    # @raise [RuntimeError] if the request failed
+    # @return [String] indicator_led
+    def get_indicator_led
+      response = rest_get('/redfish/v1/Systems/1/')
+      response_handler(response)['IndicatorLED']
+    end
+
+    # Set the UID indicator LED
+    # @param [String, Symbol] state
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_indicator_led(state)
+      new_action = { 'IndicatorLED' => state }
+      response = rest_patch('/redfish/v1/Systems/1/', body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# 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 Date and Time actions
+  module DateTimeHelper
+    # Get the Time Zone
+    # @raise [RuntimeError] if the request failed
+    # @return [String] time_zone
+    def get_time_zone
+      response = rest_get('/redfish/v1/Managers/1/DateTime/')
+      response_handler(response)['TimeZone']['Name']
+    end
+
+    # Set the Time Zone
+    # @param [Fixnum] time_zone
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_time_zone(time_zone)
+      time_response = rest_get('/redfish/v1/Managers/1/DateTime/')
+      new_time_zone = response_handler(time_response)['TimeZoneList'].select { |timezone| timezone['Name'] == time_zone }
+      new_action = { 'TimeZone' => { 'Index' => new_time_zone[0]['Index'] } }
+      response = rest_patch('/redfish/v1/Managers/1/DateTime/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Get whether or not ntp servers are being used
+    # @raise [RuntimeError] if the request failed
+    # @return [TrueClass, FalseClass] use_ntp
+    def get_ntp
+      response = rest_get('/redfish/v1/Managers/1/EthernetInterfaces/1/')
+      response_handler(response)['Oem']['Hp']['DHCPv4']['UseNTPServers']
+    end
+
+    # Set whether or not ntp servers are being used
+    # @param [TrueClass, FalseClass] use_ntp
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_ntp(use_ntp)
+      new_action = { 'Oem' => { 'Hp' => { 'DHCPv4' => { 'UseNTPServers' => use_ntp } } } }
+      response = rest_patch('/redfish/v1/Managers/1/EthernetInterfaces/1/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Get the NTP Servers
+    # @raise [RuntimeError] if the request failed
+    # @return [Array] ntp_servers
+    def get_ntp_servers
+      response = rest_get('/redfish/v1/Managers/1/DateTime/')
+      response_handler(response)['StaticNTPServers']
+    end
+
+    # Set the NTP Servers
+    # @param [Fixnum] ntp_servers
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_ntp_servers(ntp_servers)
+      new_action = { 'StaticNTPServers' => ntp_servers }
+      response = rest_patch('/redfish/v1/Managers/1/DateTime/', body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end

data/lib/ilo-sdk/helpers/firmware_update.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 Firmware Update actions
+  module FirmwareUpdateHelper
+    # Get the Firmware Version
+    # @raise [RuntimeError] if the request failed
+    # @return [String] fw_version
+    def get_fw_version
+      response = rest_get('/redfish/v1/Systems/1/FirmWareInventory/')
+      response_handler(response)['Current']['SystemBMC'][0]['VersionString']
+    end
+
+    # Set the Firmware Upgrade
+    # @param [String, Symbol] uri
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_fw_upgrade(uri, tpm_override_flag = true)
+      new_action = { 'Action' => 'InstallFromURI', 'FirmwareURI' => uri, 'TPMOverrideFlag' => tpm_override_flag }
+      response = rest_post('/redfish/v1/Managers/1/UpdateService/', body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# 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 Log Entry actions
+  module LogEntryHelper
+    # Clear the specified logs
+    # @param [String, Symbol] log_type
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def clear_logs(log_type)
+      new_action = { 'Action' => 'ClearLog' }
+      response = rest_post("/redfish/v1/Managers/1/LogServices/#{log_type}/", body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Check to see if the specified logs are empty
+    # @param [String, Symbol] log_type
+    # @raise [RuntimeError] if the request failed
+    # @return [TrueClass, FalseClass] logs_empty
+    def logs_empty?(log_type)
+      response = rest_get("/redfish/v1/Managers/1/LogServices/#{log_type}/Entries/")
+      response_handler(response)['Items'].empty?
+    end
+
+    # Get the specified logs
+    # @param [String, Symbol] severity_level
+    # @param [String, Symbol] duration
+    # @param [String, Symbol] log_type
+    # @raise [RuntimeError] if the request failed
+    # @return logs
+    def get_logs(severity_level, duration, log_type)
+      response = rest_get("/redfish/v1/Managers/1/LogServices/#{log_type}/Entries/")
+      entries = response_handler(response)['Items']
+      logs = []
+      entries.each do |e|
+        if severity_level.nil?
+          logs.push("#{e['Severity']} | #{e['Message']} | #{e['Created']}") if Time.parse(e['Created']) > (Time.now.utc - (duration * 3600))
+        elsif e['Severity'] == severity_level && Time.parse(e['Created']) > (Time.now.utc - (duration * 3600))
+          logs.push("#{e['Severity']} | #{e['Message']} | #{e['Created']}")
+        end
+      end
+      logs
+    end
+  end
+end

data/lib/ilo-sdk/helpers/manager_network_protocol_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 Manager Network Protocol actions
+  module ManagerNetworkProtocolHelper
+    # Get the Session Timeout Minutes
+    # @raise [RuntimeError] if the request failed
+    # @return [Fixnum] timeout
+    def get_timeout
+      response = rest_get('/redfish/v1/Managers/1/NetworkService/')
+      response_handler(response)['SessionTimeoutMinutes']
+    end
+
+    # Set the Session Timeout Minutes
+    # @param [Fixnum] timeout
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_timeout(timeout)
+      new_action = { 'SessionTimeoutMinutes' => timeout }
+      response = rest_patch('/redfish/v1/Managers/1/NetworkService/', body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# 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 Power actions
+  module PowerHelper
+    # Get the Power State
+    # @raise [RuntimeError] if the request failed
+    # @return [String] power_state
+    def get_power_state
+      response = rest_get('/redfish/v1/Systems/1/')
+      response_handler(response)['PowerState']
+    end
+
+    # Set the Power State
+    # @param [String, Symbol] state
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_power_state(state)
+      new_action = { 'Action' => 'Reset', 'ResetType' => state }
+      response = rest_post('/redfish/v1/Systems/1/', body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Reset the iLO
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def reset_ilo
+      new_action = { 'Action' => 'Reset' }
+      response = rest_post('/redfish/v1/Managers/1/', body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end