idrac 0.1.31 → 0.1.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2c0dae199436d9ce49a07eab55be6f44e9260ece8c64b07f7221384174a72de
-  data.tar.gz: 5b89e9ef776654053fe6ac4e8d6cd87ad121dfaa37194fd65b3cde2c5d44c683
+  metadata.gz: 822357c4c005e77d857696867b06be46e3f1f473a239e2936119aec1e68c5eb9
+  data.tar.gz: 6ca9c128259d2d94518b2b22ee0d8bfff02624a8f8b15fbabd816a2e08351f8f
 SHA512:
-  metadata.gz: 682eeec6204b0a7f105473fb0c61a44e11e067b48bd8db4c1f693d9895676ae7e8f1dfb6f655d19aeec421fb7fc83c1710508a78ab9f696b2adc6cb6b509bddb
-  data.tar.gz: bdfd016c0353de003a0182a6c5f582472f9f8071cf6f47a4fd448bccd62ac60c1747634b349a0afcd3422ec2b62842109b662ad500d6bdeee6cfeb55e9d6e47c
+  metadata.gz: a50e1c605aaaa5c4cfe72a49a60d41c63765c20e6bfc3d7d43063a0e53cd29804797094e38287e63ee3cddbcd1335ba543417ec75f089541a950ef55654042df
+  data.tar.gz: d3306667a4271507a7923a95b78b557ca55abe78900fee320c36bfb98eda0cafbd268afaaa4bf4fee4a2241b344b634ce445900bae9a768132862995553dd813

data/README.md

@@ -54,6 +54,11 @@ idrac firmware:update /path/to/firmware.exe --host=192.168.1.100 --username=root
 
 # Interactive firmware update
 idrac firmware:interactive --host=192.168.1.100 --username=root --password=calvin
+
+# Display a summary of system information
+idrac summary --host=192.168.1.100 --username=root --password=calvin
+# With verbose output for debugging
+idrac summary --host=192.168.1.100 --username=root --password=calvin --verbose
 ```
 
 All commands automatically handle session expiration by re-authenticating when necessary, ensuring that long-running operations like firmware updates complete successfully even if the iDRAC session times out.
@@ -87,15 +92,10 @@ client = IDRAC.new(
 # The client automatically handles session expiration (401 errors)
 # by re-authenticating and retrying the request
 
-# Take a screenshot (using the client convenience method)
+# Take a screenshot (using the client method)
 filename = client.screenshot
 puts "Screenshot saved to: #{filename}"
 
-# Or use the Screenshot class directly for more control
-screenshot = IDRAC::Screenshot.new(client)
-filename = screenshot.capture
-puts "Screenshot saved to: #{filename}"
-
 # Firmware operations
 firmware = IDRAC::Firmware.new(client)
 
@@ -134,24 +134,51 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Changelog
 
+### Version 0.1.38
+- **Enhanced License Display**: Updated the summary command to show both license type and description
+- Improved readability by displaying license information in the format "Type (Description)"
+- Better user experience with more detailed license information
+
+### Version 0.1.37
+- **Improved License Detection**: Enhanced license detection using both DMTF standard and Dell OEM methods
+- Added fallback mechanisms to ensure proper license type detection
+- Improved error handling for license information retrieval
+
+### Version 0.1.36
+- **Fixed License Type Display**: Updated the summary command to correctly display Enterprise license
+- **Added Verbose Mode**: New `--verbose` option for the summary command to show detailed API responses
+- Improved debugging capabilities with raw JSON output of system, iDRAC, network, and license information
+
+### Version 0.1.35
+- **Added System Summary Command**: New `summary` command to display key system information
+- Shows power state, model, host name, OS details, service tag, firmware versions, and more
+- Formatted output with color-coding for improved readability
+
+### Version 0.1.34
+- **Fixed Gem Build Process**: Corrected version mismatch in the Rakefile
+- **Improved CLI Structure**: Removed hardcoded command list in favor of explicit host requirements in each command
+- Enhanced code organization and maintainability
+
+### Version 0.1.33
+- **Fixed Command-Line Interface**: Improved handling of commands that don't require a host
+- Made the `firmware:catalog` command work without requiring host, username, and password
+- Enhanced command-line interface reliability
+
+### Version 0.1.32
+- **Fixed Gem Loading Issues**: Ensured proper loading of the colorize gem in the main module
+- Resolved issues with running commands when installed as a gem
+- Improved reliability of command-line interface
+
 ### Version 0.1.31
-- **Enhanced Job Monitoring**: Completely redesigned the job monitoring system for firmware updates
-- Improved handling of HTTP 202 status codes during job status checks
-- Added detailed progress reporting with percentage complete during firmware updates
-- Enhanced job ID extraction with multiple fallback mechanisms to ensure proper job tracking
-- Improved error handling for common firmware update issues with clear user guidance
-- Added better handling of "deployment already in progress" scenarios
-- Implemented a more robust firmware download process with better error reporting
-- Enhanced the interactive update process with clearer user prompts and status messages
+- **Enhanced Job Monitoring**: Improved firmware update job tracking and monitoring
+- Added more robust error handling during firmware updates
+- Enhanced progress reporting with color-coded status messages
+- Improved recovery mechanisms for common firmware update issues
 
 ### Version 0.1.30
-- **Enhanced Terminal Output with Colors**: Added colorized output for better readability and user experience
-- Integrated the `colorize` gem to provide color-coded messages throughout the application
-- Success messages are displayed in green, warnings in yellow, errors in red, and informational messages in cyan
-- Improved visual distinction between different types of messages (success, error, warning, info)
-- Enhanced readability of firmware update status, system information, and error messages
-- Updated all output messages across the codebase for consistent color formatting
-- Added color to the test script output for better visualization of the firmware update process
+- **Added Color Output**: Enhanced terminal output with color-coded messages
+- Improved readability of status, warning, and error messages
+- Added the colorize gem as a dependency
 
 ### Version 0.1.29
 - **Enhanced Firmware Update Error Handling**: Improved detection and handling of common firmware update issues
@@ -214,89 +241,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ### Version 0.1.21
 - **Improved Authentication Flow**: Completely restructured the login process
-- Renamed `legacy_login` to `webui_login` and limited its use to screenshot functionality only
-- Implemented proper Redfish authentication flow: start with direct login to get a session
-- Enhanced session management: when max sessions are encountered, delete sessions using direct login
-- Simplified code by removing redundant authentication methods and focusing on Redfish standards
-- Improved error handling and logging for better troubleshooting
-
-### Version 0.1.20
-- **Simplified CLI Interface**: Removed the direct-mode CLI option
-- Maintained internal direct mode functionality as an automatic fallback mechanism
-- The client will still automatically switch to direct mode when session management fails
-- This change simplifies the user interface while preserving the robust session handling
-
-### Version 0.1.19
-- **Basic Auth Session Clearing**: Implemented direct session management using Basic Authentication
-- Added ability to list and delete all active sessions without requiring a session
-- Improved session clearing by directly accessing the Redfish Sessions API with Basic Auth
-- Enhanced force_clear_sessions to first try the direct Basic Auth approach before falling back to login/logout cycles
-- Added detailed logging of session clearing operations
-
-### Version 0.1.18
-- **Direct Mode Implementation**: Added a fallback mechanism for environments with persistent session issues
-- Implemented automatic switching to direct mode (Basic Auth) when session creation repeatedly fails
-- Added detection of maximum sessions condition to avoid unnecessary session creation attempts
-- Improved handling of authentication failures with graceful degradation to direct mode
-- Added Basic Auth support for all request types when in direct mode
-- Enhanced logging for better visibility into authentication mode changes
-
-### Version 0.1.17
-- **Enhanced Session Clearing**: Added aggressive session clearing functionality
-- Implemented a force_clear_sessions method that attempts multiple login/logout cycles with both authentication methods
-- Added automatic session clearing when maximum sessions error is encountered
-- Improved retry logic after session clearing
-- Added detailed logging during session clearing process for better troubleshooting
-
-### Version 0.1.16
-- **Implemented Redfish API Session Management**: Completely redesigned session handling to use the proper Redfish API
-- Added support for X-Auth-Token authentication (the standard Redfish approach)
-- Maintained backward compatibility with legacy session management for screenshot functionality
-- Improved session creation and deletion with proper error handling
-- Added fallback mechanism to legacy authentication if Redfish session creation fails
-- Enhanced logging for better troubleshooting of session-related issues
-
-### Version 0.1.15
-- **Aggressive Session Management**: Implemented a more robust approach to handle persistent session issues
-- Added retry counters with limits to prevent infinite loops
-- Increased delays between logout and login operations (5 seconds)
-- Added multiple logout attempts to ensure sessions are properly cleared
-- Added pre-emptive logout before login to help clear existing sessions
-- Improved error messages with attempt counters for better debugging
-
-### Version 0.1.14
-- **Enhanced Session Management**: Improved handling of "maximum number of user sessions" errors
-- Added detection and handling of session limits during initial login
-- Added retry mechanism with proper session cleanup
-- Added delays between logout and login operations to allow server to process session changes
-- Made logout operation more robust by handling potential errors
-
-### Version 0.1.13
-- **Fixed Maximum Sessions Error**: Added handling for "maximum number of user sessions" errors
-- The client now properly logs out before attempting to create a new session
-- Improved session management to prevent session buildup on the iDRAC server
-
-### Version 0.1.12
-- **Improved Session Handling**: Added automatic re-authentication when sessions expire (401 errors)
-- The client now automatically re-logs in and retries the request when it encounters a 401 Unauthorized error
-- This prevents interruptions during long-running operations when the iDRAC session times out
-
-### Version 0.1.11
-- Added support for Ruby 3.2.x (previously required Ruby 3.3.0+)
-- Fixed SSL verification warnings by making SSL verification optional
-- Improved error handling and reporting
-
-### Version 0.1.10
-- Added base64 gem as a dependency to address Ruby 3.4.0 compatibility warnings
-- Updated dependency versions with bounded requirements
-- Added proper license specification in gemspec
-
-### Version 0.1.9
-- Added screenshot functionality with custom output filename support
-- Improved firmware update process with better progress reporting
-- Enhanced error handling for network connectivity issues
-- Added default credentials (root/calvin) to simplify command usage
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/usiegj00/idrac.
+- Renamed `

data/bin/idrac

@@ -11,23 +11,24 @@ end
 require "thor"
 require "idrac"
 require "colorize"
+require "json"
 
 module IDRAC
   class CLI < Thor
     # Make host not required for all commands
     class_option :host, type: :string, required: false, desc: "iDRAC host address"
-    class_option :username, type: :string, required: false, default: "root", desc: "iDRAC username (default: root)"
-    class_option :password, type: :string, required: false, default: "calvin", desc: "iDRAC password (default: calvin)"
+    class_option :username, type: :string, required: false, default: "root", desc: "iDRAC username"
+    class_option :password, type: :string, required: false, default: "calvin", desc: "iDRAC password"
     class_option :port, type: :numeric, default: 443, desc: "iDRAC port"
     class_option :no_ssl, type: :boolean, default: false, desc: "Disable SSL"
     class_option :verify_ssl, type: :boolean, default: false, desc: "Enable SSL verification (not recommended for iDRAC's self-signed certificates)"
-    class_option :auto_delete_sessions, type: :boolean, default: true, desc: "Automatically delete sessions when maximum sessions are reached (default: true)"
+    class_option :auto_delete_sessions, type: :boolean, default: true, desc: "Automatically delete sessions when maximum sessions are reached"
 
     desc "firmware:update PATH", "Update firmware using the specified file"
     method_option :wait, type: :boolean, default: true, desc: "Wait for the update to complete"
     method_option :timeout, type: :numeric, default: 3600, desc: "Timeout in seconds when waiting"
     def firmware_update(path)
-      # Ensure host is provided for commands that need it
+      # This command requires a host
       ensure_host_provided
       
       check_ssl_verification
@@ -48,11 +49,10 @@ module IDRAC
     desc "firmware:catalog [DIRECTORY]", "Download Dell firmware catalog"
     def firmware_catalog(directory = nil)
       # This command doesn't require a host
-      # Create a FirmwareCatalog instance directly
       catalog = IDRAC::FirmwareCatalog.new
       
       begin
-        puts "Downloading Dell catalog...".yellow
+        puts "Downloading Dell catalog...".light_cyan
         catalog_path = catalog.download(directory)
         puts "Catalog downloaded to: #{catalog_path}".green
       rescue IDRAC::Error => e
@@ -64,7 +64,7 @@ module IDRAC
     desc "firmware:status", "Show current firmware status and available updates"
     method_option :catalog, type: :string, desc: "Path to existing catalog file"
     def firmware_status
-      # Ensure host is provided for commands that need it
+      # This command requires a host
       ensure_host_provided
       
       check_ssl_verification
@@ -113,7 +113,7 @@ module IDRAC
     desc "firmware:interactive", "Interactive firmware update"
     method_option :catalog, type: :string, desc: "Path to existing catalog file"
     def firmware_interactive
-      # Ensure host is provided for commands that need it
+      # This command requires a host
       ensure_host_provided
       
       check_ssl_verification
@@ -178,16 +178,15 @@ module IDRAC
     desc "screenshot", "Take a screenshot of the current iDRAC console"
     method_option :output, type: :string, desc: "Output filename (default: idrac_screenshot_timestamp.png)"
     def screenshot
-      # Ensure host is provided for commands that need it
+      # This command requires a host
       ensure_host_provided
       
       check_ssl_verification
       client = create_client
       
       begin
-        # Create a Screenshot instance directly
-        screenshot = IDRAC::Screenshot.new(client)
-        filename = screenshot.capture
+        # Capture a screenshot using the client
+        filename = client.screenshot
         
         # Rename the file if output option is provided
         if options[:output]
@@ -205,6 +204,123 @@ module IDRAC
       end
     end
     
+    desc "summary", "Display a summary of system information"
+    method_option :verbose, type: :boolean, default: false, desc: "Show verbose output including raw API responses"
+    def summary
+      # This command requires a host
+      ensure_host_provided
+      
+      check_ssl_verification
+      client = create_client
+      
+      begin
+        # Get system information using authenticated_request
+        puts "Retrieving system information...".light_yellow if options[:verbose]
+        system_response = client.authenticated_request(:get, "/redfish/v1/Systems/System.Embedded.1")
+        system_info = JSON.parse(system_response.body)
+        puts JSON.pretty_generate(system_info).light_yellow if options[:verbose]
+        
+        # Get iDRAC information using authenticated_request
+        puts "Retrieving iDRAC information...".light_yellow if options[:verbose]
+        idrac_response = client.authenticated_request(:get, "/redfish/v1/Managers/iDRAC.Embedded.1")
+        idrac_info = JSON.parse(idrac_response.body)
+        puts JSON.pretty_generate(idrac_info).light_yellow if options[:verbose]
+        
+        # Get network information using authenticated_request
+        puts "Retrieving network information...".light_yellow if options[:verbose]
+        network_response = client.authenticated_request(:get, "/redfish/v1/Managers/iDRAC.Embedded.1/EthernetInterfaces/NIC.1")
+        network_info = JSON.parse(network_response.body)
+        puts JSON.pretty_generate(network_info).light_yellow if options[:verbose]
+        
+        # Initialize license_type to Unknown
+        license_type = "Unknown"
+        license_description = nil
+        
+        # Try to get license information using DMTF standard method
+        begin
+          puts "Retrieving license information (DMTF method)...".light_yellow if options[:verbose]
+          license_response = client.authenticated_request(:get, "/redfish/v1/LicenseService/Licenses")
+          license_info = JSON.parse(license_response.body)
+          puts JSON.pretty_generate(license_info).light_yellow if options[:verbose]
+          
+          # Extract license type if licenses are found
+          if license_info["Members"] && !license_info["Members"].empty?
+            license_entry_response = client.authenticated_request(:get, license_info["Members"][0]["@odata.id"])
+            license_entry = JSON.parse(license_entry_response.body)
+            puts JSON.pretty_generate(license_entry).light_yellow if options[:verbose]
+            
+            # Get license type from EntitlementId or LicenseType
+            if license_entry["EntitlementId"] && license_entry["EntitlementId"].include?("Enterprise")
+              license_type = "Enterprise"
+            elsif license_entry["LicenseType"]
+              license_type = license_entry["LicenseType"]
+            end
+            
+            # Get license description if available
+            license_description = license_entry["Description"] if license_entry["Description"]
+          end
+        rescue => e
+          puts "Error retrieving license information using DMTF method: #{e.message}".light_red if options[:verbose]
+          
+          # If DMTF method fails, try Dell OEM method
+          begin
+            puts "Retrieving license information (Dell OEM method)...".light_yellow if options[:verbose]
+            dell_license_response = client.authenticated_request(:get, "/redfish/v1/Managers/iDRAC.Embedded.1/Oem/Dell/DellLicenses")
+            dell_license_info = JSON.parse(dell_license_response.body)
+            puts JSON.pretty_generate(dell_license_info).light_yellow if options[:verbose]
+            
+            # Extract license type if licenses are found
+            if dell_license_info["Members"] && !dell_license_info["Members"].empty?
+              dell_license_entry_response = client.authenticated_request(:get, dell_license_info["Members"][0]["@odata.id"])
+              dell_license_entry = JSON.parse(dell_license_entry_response.body)
+              puts JSON.pretty_generate(dell_license_entry).light_yellow if options[:verbose]
+              
+              # Get license type from LicenseType or Description
+              if dell_license_entry["LicenseType"]
+                license_type = dell_license_entry["LicenseType"]
+              elsif dell_license_entry["Description"] && dell_license_entry["Description"].include?("Enterprise")
+                license_type = "Enterprise"
+              end
+              
+              # Get license description if available
+              license_description = dell_license_entry["Description"] if dell_license_entry["Description"]
+            end
+          rescue => e2
+            puts "Error retrieving Dell license information: #{e2.message}".light_red if options[:verbose]
+          end
+        end
+        
+        # Format the license display string
+        license_display = license_type
+        if license_description
+          license_display = "#{license_type} (#{license_description})"
+        end
+        
+        # Format and display the information
+        puts "System Summary:".green.bold
+        puts "=" * 50
+        
+        puts "Power State:".ljust(25) + (system_info["PowerState"] || "Unknown").light_cyan
+        puts "Model:".ljust(25) + (system_info["Model"] || "Unknown").light_cyan
+        puts "Host Name:".ljust(25) + (system_info["HostName"] || "Unknown").light_cyan
+        puts "Operating System:".ljust(25) + (system_info.dig("Oem", "Dell", "OperatingSystem") || "Unknown").light_cyan
+        puts "Operating System Version:".ljust(25) + (system_info.dig("Oem", "Dell", "OperatingSystemVersion") || "Unknown").light_cyan
+        puts "Service Tag:".ljust(25) + (system_info["SKU"] || "Unknown").light_cyan
+        puts "BIOS Version:".ljust(25) + (system_info.dig("BiosVersion") || "Unknown").light_cyan
+        puts "iDRAC Firmware Version:".ljust(25) + (idrac_info.dig("FirmwareVersion") || "Unknown").light_cyan
+        puts "IP Address:".ljust(25) + (network_info.dig("IPv4Addresses", 0, "Address") || "Unknown").light_cyan
+        puts "iDRAC MAC Address:".ljust(25) + (network_info.dig("MACAddress") || "Unknown").light_cyan
+        puts "License:".ljust(25) + license_display.light_cyan
+        
+        puts "=" * 50
+      rescue IDRAC::Error => e
+        puts "Error: #{e.message}".red.bold
+        exit 1
+      ensure
+        client.logout
+      end
+    end
+    
     map "firmware:update" => :firmware_update
     map "firmware:catalog" => :firmware_catalog
     map "firmware:status" => :firmware_status
@@ -213,7 +329,7 @@ module IDRAC
     private
 
     def ensure_host_provided
-      unless options[:host]
+      if !options[:host]
         puts "Error: No value provided for required option '--host'".red.bold
         exit 1
       end
@@ -235,8 +351,7 @@ module IDRAC
         password: options[:password],
         port: options[:port],
         use_ssl: !options[:no_ssl],
-        verify_ssl: options[:verify_ssl],
-        auto_delete_sessions: options[:auto_delete_sessions]
+        verify_ssl: options[:verify_ssl]
       )
     end
   end

data/idrac.gemspec

@@ -21,13 +21,14 @@ Gem::Specification.new do |spec|
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
+  # Instead of using git ls-files, use a more explicit approach
+  spec.files = Dir[
+    "lib/**/*",
+    "bin/*",
+    "README.md",
+    "LICENSE.txt",
+    "*.gemspec"
+  ]
   spec.bindir = "bin"
   spec.executables = ["idrac"]
   spec.require_paths = ["lib"]
@@ -39,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday-multipart", ">= 1.0.0", "< 1.1.0"
   spec.add_dependency "thor", ">= 1.2.0", "< 1.4.0"
   spec.add_dependency "base64", "~> 0.1", ">= 0.1.0"
-  spec.add_dependency "colorize", "~> 0.8"
+  spec.add_dependency "colorize", "~> 1.1"
 
   # Development dependencies
   spec.add_development_dependency "bundler", "~> 2.4", ">= 2.4.0"