idrac 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffcb1d99822a0e7d0015f018b6967e3977d7506438a3e2d917e0615f281aa0e3
-  data.tar.gz: 188a912ccdcdb5712ead6b5f181d59902f9b50718e3c3e39e2949f6fbc7ad606
+  metadata.gz: 32086f37bcf1f9d8bfaf3bf5a54e4159cc2db5ed3b97bc5021203f266e62e7aa
+  data.tar.gz: c107965b24d8edc018f44c42da5f6ddd978d978a4ed83eea51304e7b80dc5f40
 SHA512:
-  metadata.gz: dfd1714f7a86b37991a7493be186043be14a400f6e36d7712c366c1007857eee7eb4ece8390187a56f7faa921f46ffdf9ad1250ff471daf3ad2ccd884c14cda2
-  data.tar.gz: 20d5a051050da7a5b75d08529d16e2806af72ac05161393dd1a5cca509f17b2ec497f7a9b2f9c3f0933af72394b81696ae88b48736b6de67bd8ab7ae43319b25
+  metadata.gz: 45d74e3ba6b18f6a86e6f644932a20b4316814814a4c37961b54092f6bfe018bfbadc3d9cade70c160dd43c7adb80d7e86e30468e88152a32631b0883b94e09d
+  data.tar.gz: b84528baa1d901c687107ea00dc08a1668ad5f60d258cbfb0f9fc69bcbe5efa6530d5c9c2614270f7c3044dd2cd99665168b7f6eadab53d2c4d7b17b1a88fb33

data/README.md

@@ -15,6 +15,7 @@ A Ruby client for the Dell iDRAC API. This gem provides a command-line interface
 - Job queue management (clear, monitor, list)
 - Lifecycle log and System Event Log (SEL) management
 - Lifecycle Controller status management
+- Return values as RecursiveOpenStruct objects for convenient attribute access
 
 ## Installation
 
@@ -170,6 +171,25 @@ client.clear_lifecycle!
 # Clear System Event Logs
 client.clear_system_event_logs!
 
+# Working with RecursiveOpenStruct objects
+# Many methods return data as RecursiveOpenStruct objects for easier property access
+
+# Get memory information
+memory_modules = client.memory
+memory_modules.each do |dimm|
+  # Access properties directly as methods
+  puts "#{dimm.name}: #{dimm.capacity_bytes / (1024**3)}GB, Speed: #{dimm.speed_mhz}MHz"
+end
+
+# Get storage information
+controller = client.controller
+volumes = client.volumes(controller)
+volumes.each do |volume|
+  # Access properties via dot notation
+  puts "#{volume.name} (#{volume.raid_level}): #{volume.capacity_bytes / (1024**3)}GB"
+  puts "  Health: #{volume.health}, FastPath: #{volume.fastpath}"
+end
+
 # Create a client with auto_delete_sessions disabled
 client = IDRAC.new(
   host: '192.168.1.100',
@@ -187,6 +207,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Changelog
 
+### Version 0.1.40
+- **Enhanced Return Values**: Methods that return system components now provide RecursiveOpenStruct objects
+  - Memory, drives, volumes, PSUs, and fans now support convenient dot notation for attribute access
+  - Improved object structure with consistent property naming across different component types
+  - Better code organization and readability when working with returned objects
+
 ### Version 0.1.39
 - **Added Job Management**: New methods for managing iDRAC jobs
   - List jobs using `jobs` and `jobs_detail`

data/bin/idrac

@@ -456,6 +456,37 @@ module IDRAC
       end
     end
 
+    desc "license_info", "Display license information"
+    map "license:info" => :license_info
+    def license_info
+      with_idrac_client do |client|
+        license = client.license_info
+        if license
+          puts "\nLicense Information:".green.bold
+          puts "Description: #{license['Description']}".cyan
+          puts "License Type: #{license['LicenseType']}".cyan
+          puts "License Version: #{client.license_version || 'Unknown'}".cyan
+          puts "Removable: #{license['Removable']}".cyan
+          puts "Status: #{license.dig('Status', 'Health') || 'Unknown'}".cyan
+        else
+          puts "No license information available".yellow
+        end
+      end
+    end
+
+    desc "license_version", "Display the iDRAC license version number"
+    map "license:version" => :license_version
+    def license_version
+      with_idrac_client do |client|
+        version = client.license_version
+        if version
+          puts version
+        else
+          puts "Unknown license version"
+        end
+      end
+    end
+
     desc "test:all", "Run tests for all major functionality areas"
     map "test" => :test_all
     option :quiet, type: :boolean, default: false, desc: "Minimize output, just show pass/fail"
@@ -472,6 +503,8 @@ module IDRAC
         # Basic information
         { name: "System Summary", method: -> (c) { c.summary } },
         { name: "Redfish Version", method: -> (c) { c.redfish_version } },
+        { name: "License Version", method: -> (c) { c.license_version } },
+        { name: "System Health", method: -> (c) { c.system_health } },
         
         # Power methods
         { name: "Power State", method: -> (c) { c.get_power_state } },
@@ -488,6 +521,7 @@ module IDRAC
         
         # System components
         { name: "Memory Info", method: -> (c) { c.memory } },
+        { name: "CPU Info", method: -> (c) { c.cpus } },
         { name: "PSU Info", method: -> (c) { c.psus } },
         { name: "Fan Info", method: -> (c) { c.fans } },
         { name: "NIC Info", method: -> (c) { c.nics } },
@@ -863,6 +897,27 @@ module IDRAC
       end
     end
 
+    desc "system_cpus", "Get processor/CPU information" 
+    map "system:cpus" => :system_cpus
+    def system_cpus
+      with_idrac_client do |client|
+        cpus = client.cpus
+        
+        puts "\nProcessor Summary:".green.bold
+        puts "=" * 50
+        
+        health_color = cpus[:status] == "OK" ? :green : :red
+        
+        puts "Processor Model:".ljust(25) + cpus[:model].to_s.light_cyan
+        puts "Processor Count:".ljust(25) + cpus[:count].to_s.light_cyan
+        puts "Physical Cores:".ljust(25) + cpus[:cores].to_s.light_cyan
+        puts "Logical Cores:".ljust(25) + cpus[:threads].to_s.light_cyan
+        puts "Status:".ljust(25) + cpus[:status].to_s.send(health_color)
+        
+        puts "=" * 50
+      end
+    end
+
     desc "system_psus", "Get power supply information"
     map "system:psus" => :system_psus
     def system_psus
@@ -1103,6 +1158,68 @@ module IDRAC
       end
     end
 
+    desc "system_info", "Get detailed system identification information"
+    map "system:info" => :system_info
+    def system_info
+      with_idrac_client do |client|
+        info = client.system_info
+        
+        if info[:is_dell]
+          puts "Dell iDRAC System:".green.bold
+          puts "  Service Tag: #{info[:service_tag]}".cyan
+          puts "  Model: #{info[:model]}".cyan
+          puts "  iDRAC Version: #{info[:idrac_version]}".cyan
+          puts "  Firmware Version: #{info[:firmware_version]}".cyan
+        else
+          puts "Not a Dell iDRAC system".yellow
+          puts "  Product: #{info[:product]}".cyan
+          if info[:is_ancient_dell]
+            puts "  Ancient Dell System detected. Update firmware.".yellow
+          end
+        end
+      end
+    end
+
+    desc "system_config", "Get complete system configuration"
+    map "system:config" => :system_config
+    def system_config
+      with_idrac_client do |client|
+        response = client.authenticated_request(:get, "/redfish/v1/Systems/System.Embedded.1?$expand=*($levels=1)")
+        if response.status == 200
+          config = JSON.parse(response.body)
+          puts JSON.pretty_generate(config)
+        else
+          puts "Failed to retrieve system configuration: #{response.status}".red
+        end
+      end
+    end
+
+    desc "system_health", "Get system health status"
+    map "system:health" => :system_health
+    def system_health
+      with_idrac_client do |client|
+        health = client.system_health
+        
+        puts "\nSystem Health Status:".green.bold
+        puts "=" * 50
+        
+        # Display overall health with color coding
+        overall_color = health[:overall] == "OK" ? :green : :red
+        system_color = health[:system] == "OK" ? :green : :red
+        processor_color = health[:processor] == "OK" ? :green : :red
+        memory_color = health[:memory] == "OK" ? :green : :red
+        storage_color = health[:storage] == "OK" ? :green : (health[:storage].nil? ? :yellow : :red)
+        
+        puts "Overall Health:".ljust(25) + health[:overall].to_s.send(overall_color)
+        puts "System Health:".ljust(25) + health[:system].to_s.send(system_color)
+        puts "Processor Health:".ljust(25) + health[:processor].to_s.send(processor_color)
+        puts "Memory Health:".ljust(25) + health[:memory].to_s.send(memory_color)
+        puts "Storage Health:".ljust(25) + (health[:storage] || "Unknown").to_s.send(storage_color)
+        
+        puts "=" * 50
+      end
+    end
+
     # Test commands
     desc "test_live", "Test all major functionality of the gem on a real system"
     map "test:live" => :test_live

data/lib/idrac/client.rb

@@ -21,6 +21,7 @@ module IDRAC
     include System
     include VirtualMedia
     include Boot
+    include License
 
     def initialize(host:, username:, password:, port: 443, use_ssl: true, verify_ssl: false, direct_mode: false, auto_delete_sessions: true, retry_count: 3, retry_delay: 1)
       @host = host

data/lib/idrac/license.rb

@@ -0,0 +1,63 @@
+module IDRAC
+  module License
+    # Gets the license information from the iDRAC
+    # @return [Hash] License details
+    def license_info
+      response = authenticated_request(:get, "/redfish/v1/LicenseService/Licenses")
+      if response.status != 200
+        debug "Failed to retrieve licenses list: #{response.status}", 1, :red
+        return nil
+      end
+
+      license_data = JSON.parse(response.body)
+      debug "License collection: #{license_data}", 2
+
+      # Check if there are any license entries
+      if !license_data["Members"] || license_data["Members"].empty?
+        debug "No licenses found", 1, :yellow
+        return nil
+      end
+
+      # Get the first license in the list
+      license_uri = license_data["Members"][0]["@odata.id"]
+      debug "Using license URI: #{license_uri}", 2
+
+      # Get detailed license information
+      license_response = authenticated_request(:get, license_uri)
+      if license_response.status != 200
+        debug "Failed to retrieve license details: #{license_response.status}", 1, :red
+        return nil
+      end
+
+      license_details = JSON.parse(license_response.body)
+      debug "License details: #{license_details}", 2
+
+      return license_details
+    end
+
+    # Extracts the iDRAC version from the license description
+    # @return [Integer, nil] The license version (e.g. 9) or nil if not found
+    def license_version
+      license = license_info
+      return nil unless license
+
+      # Check the Description field, which often contains the version
+      # Example: "iDRAC9 Enterprise License"
+      if license["Description"] && license["Description"].match(/iDRAC(\d+)/i)
+        version = license["Description"].match(/iDRAC(\d+)/i)[1].to_i
+        debug "Found license version from Description: #{version}", 1
+        return version
+      end
+
+      # Try alternative fields if Description didn't work
+      if license["Name"] && license["Name"].match(/iDRAC(\d+)/i)
+        version = license["Name"].match(/iDRAC(\d+)/i)[1].to_i
+        debug "Found license version from Name: #{version}", 1
+        return version
+      end
+
+      debug "Could not determine license version from license info", 1, :yellow
+      nil
+    end
+  end
+end 

data/lib/idrac/storage.rb

@@ -50,7 +50,8 @@ module IDRAC
               encryption_capability: controller.dig("Oem", "Dell", "DellController", "EncryptionCapability"),
               controller_type: controller.dig("Oem", "Dell", "DellController", "ControllerType"),
               pci_slot: controller.dig("Oem", "Dell", "DellController", "PCISlot"),
-              raw: controller
+              raw: controller,
+              odata_id: controller["@odata.id"]
             }
             
             RecursiveOpenStruct.new(controller_data, recurse_over_arrays: true)

data/lib/idrac/system.rb

@@ -332,6 +332,110 @@ module IDRAC
       return nics_with_pci
     end
 
+    # Get system identification information
+    def system_info
+      response = authenticated_request(:get, "/redfish/v1")
+      
+      if response.status == 200
+        begin
+          data = JSON.parse(response.body)
+          
+          # Initialize return hash with defaults
+          info = {
+            is_dell: false,
+            is_ancient_dell: false,
+            product: data["Product"] || "Unknown",
+            service_tag: nil,
+            model: nil,
+            idrac_version: data["RedfishVersion"],
+            firmware_version: nil
+          }
+          
+          # Check if it's a Dell iDRAC
+          if data["Product"] == "Integrated Dell Remote Access Controller"
+            info[:is_dell] = true
+            
+            # Get service tag from Dell OEM data
+            info[:service_tag] = data.dig("Oem", "Dell", "ServiceTag")
+            
+            # Get firmware version - try both common locations
+            info[:firmware_version] = data["FirmwareVersion"] || data.dig("Oem", "Dell", "FirmwareVersion")
+            
+            # Get additional system information
+            system_response = authenticated_request(:get, "/redfish/v1/Systems/System.Embedded.1")
+            if system_response.status == 200
+              system_data = JSON.parse(system_response.body)
+              info[:model] = system_data["Model"]
+            end
+          
+            return info
+          else
+            # Try to handle ancient Dell models where Product is null or non-standard
+            if data["Product"].nil? || data.dig("Oem", "Dell")
+              info[:is_ancient_dell] = true
+              return info
+            end
+          end
+          
+          return info
+        rescue JSON::ParserError
+          raise Error, "Failed to parse system information: #{response.body}"
+        end
+      else
+        raise Error, "Failed to get system information. Status code: #{response.status}"
+      end
+    end
+    
+    # Get processor/CPU information
+    def cpus
+      response = authenticated_request(:get, "/redfish/v1/Systems/System.Embedded.1?$expand=*($levels=1)")
+      
+      if response.status == 200
+        begin
+          data = JSON.parse(response.body)
+          
+          summary = {
+            count: data.dig("ProcessorSummary", "Count"),
+            model: data.dig("ProcessorSummary", "Model"),
+            cores: data.dig("ProcessorSummary", "CoreCount"),
+            threads: data.dig("ProcessorSummary", "LogicalProcessorCount"),
+            status: data.dig("ProcessorSummary", "Status", "Health")
+          }
+          
+          return summary
+        rescue JSON::ParserError
+          raise Error, "Failed to parse processor information: #{response.body}"
+        end
+      else
+        raise Error, "Failed to get processor information. Status code: #{response.status}"
+      end
+    end
+
+    # Get system health status
+    def system_health
+      response = authenticated_request(:get, "/redfish/v1/Systems/System.Embedded.1?$expand=*($levels=1)")
+      
+      if response.status == 200
+        begin
+          data = JSON.parse(response.body)
+          
+          health = {
+            overall: data.dig("Status", "HealthRollup"),
+            system: data.dig("Status", "Health"),
+            processor: data.dig("ProcessorSummary", "Status", "Health"),
+            memory: data.dig("MemorySummary", "Status", "Health"),
+            storage: data.dig("Storage", "Status", "Health")
+          }
+          
+          return health
+        rescue JSON::ParserError
+          raise Error, "Failed to parse system health information: #{response.body}"
+        end
+      else
+        raise Error, "Failed to get system health. Status code: #{response.status}"
+      end
+    end
+
     # Get system event logs
     def system_event_logs
       response = authenticated_request(:get, "/redfish/v1/Managers/iDRAC.Embedded.1/Logs/Sel?$expand=*($levels=1)")

data/lib/idrac/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IDRAC
-  VERSION = "0.4.5"
+  VERSION = "0.5.0"
 end

data/lib/idrac.rb

@@ -51,4 +51,5 @@ require 'idrac/storage'
 require 'idrac/system'
 require 'idrac/virtual_media'
 require 'idrac/boot'
+require 'idrac/license'
 require 'idrac/client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idrac
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Jonathan Siegel
@@ -241,6 +241,7 @@ files:
 - lib/idrac/firmware.rb
 - lib/idrac/firmware_catalog.rb
 - lib/idrac/jobs.rb
+- lib/idrac/license.rb
 - lib/idrac/lifecycle.rb
 - lib/idrac/power.rb
 - lib/idrac/session.rb