idrac 0.1.38 → 0.1.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 462eec3a8d4efc8ef0c8b79247cb3b5624f96c97b1cb2b98e10311939fcea521
-  data.tar.gz: 91793e111a24c4d71ef4ab9c38ea6291630b4314e754f108068a6cded9c23b70
+  metadata.gz: 9ca237b7873f9c7011ab3cc8f8da9661edd442752b2d31a20d4ad497ebf436fa
+  data.tar.gz: 7de812bcd331d79be897e08481a578742a93b5128c0df57858dc706cd67a3239
 SHA512:
-  metadata.gz: 0e6ecd835d5f68d3e4230944843131d70cc5e239bfc546127af7fed5d9fe83a82c4c5421f68fd88ea76f6f94fc9df8193405c936f20ee1a4905cc66e3d457bd7
-  data.tar.gz: e301acc6c69c352fb3ae4bc2503a7501ab01fe4dd3af9597a2b276aa468c98cb9a9e03c649e55271b26edc8d738b7fcf758e46ab5adef4100cbd6553583f1371
+  metadata.gz: 3d9692f031a229c5f2da0540834d68e5ce5feab575c72e8a4d3e0633b00a6880dd34b52221f3fe5f3d5f08dfbec18b8cddedb21b48b7c7454a4a442d55319adb
+  data.tar.gz: '0004391394c8a4e00b3ddd3ad54cff7fea51d372335a4cceb492bcc817f8c5d315dd29943256885ca5d5c9221dc0c880ce31b15861206dc32c45ead32e353090'

data/README.md

@@ -12,6 +12,9 @@ A Ruby client for the Dell iDRAC API. This gem provides a command-line interface
 - Comprehensive error handling with clear user guidance
 - Automatic job tracking and monitoring for firmware updates
 - Color-coded terminal output for improved readability and user experience
+- Job queue management (clear, monitor, list)
+- Lifecycle log and System Event Log (SEL) management
+- Lifecycle Controller status management
 
 ## Installation
 
@@ -37,9 +40,9 @@ The gem provides a command-line interface for interacting with iDRAC servers:
 
 ```bash
 # Take a screenshot of the iDRAC console
-idrac screenshot --host=192.168.1.100 --username=root --password=calvin
+idrac screenshot --host=192.168.1.100
 # Specify a custom output filename
-idrac screenshot --host=192.168.1.100 --username=root --password=calvin --output=my_screenshot.png
+idrac screenshot --host=192.168.1.100
 
 # Download the Dell firmware catalog (no host required)
 idrac catalog download
@@ -47,18 +50,36 @@ idrac catalog download
 idrac firmware:catalog
 
 # Check firmware status and available updates
-idrac firmware:status --host=192.168.1.100 --username=root --password=calvin
+idrac firmware:status --host=192.168.1.100 
 
 # Update firmware using a specific file
-idrac firmware:update /path/to/firmware.exe --host=192.168.1.100 --username=root --password=calvin
+idrac firmware:update /path/to/firmware.exe --host=192.168.1.100 
 
 # Interactive firmware update
-idrac firmware:interactive --host=192.168.1.100 --username=root --password=calvin
+idrac firmware:interactive --host=192.168.1.100 
 
 # Display a summary of system information
-idrac summary --host=192.168.1.100 --username=root --password=calvin
+idrac summary --host=192.168.1.100 
 # With verbose output for debugging
-idrac summary --host=192.168.1.100 --username=root --password=calvin --verbose
+idrac summary --host=192.168.1.100 
+
+# Job Management Commands
+idrac jobs:list --host=192.168.1.100 
+idrac jobs:detail --host=192.168.1.100 
+idrac jobs:clear --host=192.168.1.100 
+idrac jobs:force_clear --host=192.168.1.100 
+idrac jobs:wait JID_12345678 --host=192.168.1.100 
+idrac tasks --host=192.168.1.100 
+
+# Lifecycle Controller Commands
+idrac lifecycle:status --host=192.168.1.100 
+idrac lifecycle:enable --host=192.168.1.100 
+idrac lifecycle:disable --host=192.168.1.100 
+idrac lifecycle:ensure --host=192.168.1.100 
+idrac lifecycle:clear --host=192.168.1.100 
+
+# System Event Log (SEL) Commands
+idrac sel:clear --host=192.168.1.100 
 ```
 
 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.
@@ -92,15 +113,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)
 
@@ -122,6 +138,38 @@ end
 job_id = firmware.update('/path/to/firmware.exe', wait: true)
 puts "Update completed with job ID: #{job_id}"
 
+# Job management
+jobs = client.jobs
+puts "Found #{jobs['Members'].count} jobs"
+
+# List job details
+client.jobs_detail
+
+# Clear all jobs
+client.clear_jobs!
+
+# Force clear job queue (use with caution)
+client.force_clear_jobs!
+
+# Wait for a specific job to complete
+job_data = client.wait_for_job("JID_12345678")
+
+# Lifecycle Controller operations
+# Check if Lifecycle Controller is enabled
+status = client.get_idrac_lifecycle_status
+
+# Enable Lifecycle Controller
+client.set_idrac_lifecycle_status(true)
+
+# Ensure Lifecycle Controller is enabled
+client.ensure_lifecycle_controller!
+
+# Clear Lifecycle log
+client.clear_lifecycle!
+
+# Clear System Event Logs
+client.clear_system_event_logs!
+
 # Create a client with auto_delete_sessions disabled
 client = IDRAC.new(
   host: '192.168.1.100',
@@ -139,6 +187,20 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Changelog
 
+### Version 0.1.39
+- **Added Job Management**: New methods for managing iDRAC jobs
+  - List jobs using `jobs` and `jobs_detail`
+  - Clear jobs with `clear_jobs!` 
+  - Force clear job queue with `force_clear_jobs!`
+  - Wait for specific jobs with `wait_for_job`
+- **Added Lifecycle Controller Management**: New methods for managing the Lifecycle Controller
+  - Check Lifecycle Controller status with `get_idrac_lifecycle_status`
+  - Enable/disable Lifecycle Controller with `set_idrac_lifecycle_status`
+  - Ensure Lifecycle Controller is enabled with `ensure_lifecycle_controller!`
+  - Clear Lifecycle logs with `clear_lifecycle!`
+  - Clear System Event Logs with `clear_system_event_logs!`
+- Improved API organization with dedicated modules for related functionality
+
 ### 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)"
@@ -246,4 +308,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 `
+- Renamed `

data/bin/idrac

@@ -23,30 +23,160 @@ module IDRAC
     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"
+    class_option :verbose, type: :boolean, default: false, aliases: '-v', desc: "Enable verbose output"
+    class_option :very_verbose, type: :boolean, default: false, aliases: '-vv', desc: "Enable very verbose output with detailed headers and requests"
+    class_option :debug, type: :boolean, default: false, aliases: '-vvv', desc: "Enable debug output with detailed stack traces and SSL info"
 
-    desc "firmware:update PATH", "Update firmware using the specified file"
+    def self.exit_on_failure?
+      true
+    end
+    
+    # Helper methods that shouldn't be exposed as commands
+    no_commands do
+      # Override the built-in help command to modify displayed command names
+      def help(command = nil)
+        if command
+          super
+        else
+          # Get the formatted help output
+          output = capture_stdout { super }
+          
+          # First handle methods with multiple underscores (like jobs_force_clear)
+          modified_output = output.gsub(/idrac (\w+)_(\w+)_(\w+)/) do |match|
+            "idrac #{$1}:#{$2}:#{$3}"
+          end
+          
+          # Then handle methods with a single underscore (like lifecycle_status)
+          modified_output = modified_output.gsub(/idrac (\w+)_(\w+)/) do |match|
+            "idrac #{$1}:#{$2}"
+          end
+          
+          puts modified_output
+        end
+      end
+      
+      # Utility method to capture stdout
+      def capture_stdout
+        original_stdout = $stdout
+        $stdout = StringIO.new
+        yield
+        $stdout.string
+      ensure
+        $stdout = original_stdout
+      end
+    end
+    
+    desc "jobs_list", "List all iDRAC jobs"
+    map "jobs:list" => :jobs_list
+    def jobs_list
+      with_idrac_client do |client|
+        client.jobs
+      end
+    end
+    
+    desc "jobs_detail", "List detailed job information"
+    map "jobs:detail" => :jobs_detail
+    def jobs_detail
+      with_idrac_client do |client|
+        client.jobs_detail
+      end
+    end
+    
+    desc "jobs_clear", "Clear all jobs from the job queue"
+    map "jobs:clear" => :jobs_clear
+    def jobs_clear
+      with_idrac_client do |client|
+        client.clear_jobs!
+      end
+    end
+    
+    desc "jobs_force_clear", "Force clear the job queue"
+    map "jobs:force_clear" => :jobs_force_clear
+    map "jobs:force:clear" => :jobs_force_clear
+    def jobs_force_clear
+      with_idrac_client do |client|
+        client.force_clear_jobs!
+      end
+    end
+    
+    desc "jobs_wait JOB_ID", "Wait for a specific job to complete"
+    map "jobs:wait" => :jobs_wait
+    def jobs_wait(job_id)
+      with_idrac_client do |client|
+        job_data = client.wait_for_job(job_id)
+        puts "Job completed: #{job_data['Id']} - #{job_data['JobState']} - #{job_data['Message']}".green
+      end
+    end
+    
+    desc "tasks", "List iDRAC tasks"
+    def tasks
+      with_idrac_client do |client|
+        client.tasks
+      end
+    end
+    
+    desc "lifecycle_status", "Check if Lifecycle Controller is enabled"
+    map "lifecycle:status" => :lifecycle_status
+    def lifecycle_status
+      with_idrac_client do |client|
+        client.get_idrac_lifecycle_status
+      end
+    end
+    
+    desc "lifecycle_enable", "Enable Lifecycle Controller"
+    map "lifecycle:enable" => :lifecycle_enable
+    def lifecycle_enable
+      with_idrac_client do |client|
+        client.set_idrac_lifecycle_status(true)
+      end
+    end
+    
+    desc "lifecycle_disable", "Disable Lifecycle Controller"
+    map "lifecycle:disable" => :lifecycle_disable
+    def lifecycle_disable
+      with_idrac_client do |client|
+        client.set_idrac_lifecycle_status(false)
+      end
+    end
+    
+    desc "lifecycle_ensure", "Ensure Lifecycle Controller is enabled"
+    map "lifecycle:ensure" => :lifecycle_ensure
+    def lifecycle_ensure
+      with_idrac_client do |client|
+        client.ensure_lifecycle_controller!
+      end
+    end
+    
+    desc "lifecycle_clear", "Clear Lifecycle log"
+    map "lifecycle:clear" => :lifecycle_clear
+    def lifecycle_clear
+      with_idrac_client do |client|
+        client.clear_lifecycle!
+      end
+    end
+    
+    desc "sel_clear", "Clear System Event Logs (SEL)"
+    map "sel:clear" => :sel_clear
+    def sel_clear
+      with_idrac_client do |client|
+        client.clear_system_event_logs!
+      end
+    end
+
+    desc "firmware_update PATH", "Update firmware using the specified file"
+    map "firmware:update" => :firmware_update
     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)
-      # This command requires a host
-      ensure_host_provided
-      
-      check_ssl_verification
-      client = create_client
-      firmware = IDRAC::Firmware.new(client)
-      
-      begin
+      with_idrac_client do |client|
+        firmware = IDRAC::Firmware.new(client)
         job_id = firmware.update(path, wait: options[:wait], timeout: options[:timeout])
         puts "Firmware update initiated with job ID: #{job_id}"
-      rescue IDRAC::Error => e
-        puts "Error: #{e.message}"
-        exit 1
-      ensure
-        client.logout
       end
     end
     
-    desc "firmware:catalog [DIRECTORY]", "Download Dell firmware catalog"
+    desc "firmware_catalog [DIRECTORY]", "Download Dell firmware catalog"
+    map "firmware:catalog" => :firmware_catalog
     def firmware_catalog(directory = nil)
       # This command doesn't require a host
       catalog = IDRAC::FirmwareCatalog.new
@@ -61,17 +191,13 @@ module IDRAC
       end
     end
     
-    desc "firmware:status", "Show current firmware status and available updates"
+    desc "firmware_status", "Show current firmware status and available updates"
+    map "firmware:status" => :firmware_status
     method_option :catalog, type: :string, desc: "Path to existing catalog file"
     def firmware_status
-      # This command requires a host
-      ensure_host_provided
-      
-      check_ssl_verification
-      client = create_client
-      firmware = IDRAC::Firmware.new(client)
-      
-      begin
+      with_idrac_client do |client|
+        firmware = IDRAC::Firmware.new(client)
+        
         # Get system inventory - the Firmware class will print its own message
         inventory = firmware.get_system_inventory
         
@@ -102,25 +228,16 @@ module IDRAC
         else
           puts "\nTo check for updates, download the catalog first with 'idrac firmware:catalog'".yellow
         end
-      rescue IDRAC::Error => e
-        puts "Error: #{e.message}".red.bold
-        exit 1
-      ensure
-        client.logout
       end
     end
     
-    desc "firmware:interactive", "Interactive firmware update"
+    desc "firmware_interactive", "Interactive firmware update"
+    map "firmware:interactive" => :firmware_interactive
     method_option :catalog, type: :string, desc: "Path to existing catalog file"
     def firmware_interactive
-      # This command requires a host
-      ensure_host_provided
-      
-      check_ssl_verification
-      client = create_client
-      firmware = IDRAC::Firmware.new(client)
-      
-      begin
+      with_idrac_client do |client|
+        firmware = IDRAC::Firmware.new(client)
+        
         catalog_path = options[:catalog]
         
         # Default catalog location is now ~/.idrac/Catalog.xml
@@ -164,30 +281,18 @@ module IDRAC
             puts "3. If no updates appear to be in progress, you may need to restart the iDRAC".light_yellow
             puts "   (iDRAC web interface > Settings > iDRAC Settings > Reset iDRAC)".light_yellow
           else
-            puts "Error: #{e.message}".red.bold
+            raise # re-raise for the wrapper to handle
           end
         end
-      rescue => e
-        puts "Error: #{e.message}".red.bold
-        exit 1
-      ensure
-        client.logout
       end
     end
     
     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
-      # 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
+      with_idrac_client do |client|
+        # Capture a screenshot using the client
+        filename = client.screenshot
         
         # Rename the file if output option is provided
         if options[:output]
@@ -197,41 +302,31 @@ module IDRAC
         end
         
         puts "Screenshot saved to: #{filename}"
-      rescue IDRAC::Error => e
-        puts "Error: #{e.message}"
-        exit 1
-      ensure
-        client.logout
       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
+      with_idrac_client do |client|
+        verbose = options[:verbose] || options[:very_verbose] || options[:debug]
+        
         # Get system information using authenticated_request
-        puts "Retrieving system information...".light_yellow if options[:verbose]
+        puts "Retrieving system information...".light_yellow if 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]
+        puts JSON.pretty_generate(system_info).light_yellow if verbose
         
         # Get iDRAC information using authenticated_request
-        puts "Retrieving iDRAC information...".light_yellow if options[:verbose]
+        puts "Retrieving iDRAC information...".light_yellow if 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]
+        puts JSON.pretty_generate(idrac_info).light_yellow if verbose
         
         # Get network information using authenticated_request
-        puts "Retrieving network information...".light_yellow if options[:verbose]
+        puts "Retrieving network information...".light_yellow if 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]
+        puts JSON.pretty_generate(network_info).light_yellow if verbose
         
         # Initialize license_type to Unknown
         license_type = "Unknown"
@@ -239,16 +334,16 @@ module IDRAC
         
         # Try to get license information using DMTF standard method
         begin
-          puts "Retrieving license information (DMTF method)...".light_yellow if options[:verbose]
+          puts "Retrieving license information (DMTF method)...".light_yellow if 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]
+          puts JSON.pretty_generate(license_info).light_yellow if 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]
+            puts JSON.pretty_generate(license_entry).light_yellow if verbose
             
             # Get license type from EntitlementId or LicenseType
             if license_entry["EntitlementId"] && license_entry["EntitlementId"].include?("Enterprise")
@@ -261,20 +356,20 @@ module IDRAC
             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]
+          puts "Error retrieving license information using DMTF method: #{e.message}".light_red if verbose
           
           # If DMTF method fails, try Dell OEM method
           begin
-            puts "Retrieving license information (Dell OEM method)...".light_yellow if options[:verbose]
+            puts "Retrieving license information (Dell OEM method)...".light_yellow if 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]
+            puts JSON.pretty_generate(dell_license_info).light_yellow if 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]
+              puts JSON.pretty_generate(dell_license_entry).light_yellow if verbose
               
               # Get license type from LicenseType or Description
               if dell_license_entry["LicenseType"]
@@ -287,7 +382,7 @@ module IDRAC
               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]
+            puts "Error retrieving Dell license information: #{e2.message}".light_red if verbose
           end
         end
         
@@ -314,6 +409,74 @@ module IDRAC
         puts "License:".ljust(25) + license_display.light_cyan
         
         puts "=" * 50
+      end
+    end
+    
+    desc "power_state", "Get current server power state"
+    map "power:state" => :power_state
+    def power_state
+      with_idrac_client do |client|
+        state = client.get_power_state
+        puts "Current power state: #{state}".light_cyan
+      end
+    end
+    
+    desc "power_on", "Power on the server"
+    map "power:on" => :power_on
+    def power_on
+      with_idrac_client do |client|
+        client.power_on
+      end
+    end
+    
+    desc "power_off", "Power off the server"
+    map "power:off" => :power_off
+    def power_off
+      with_idrac_client do |client|
+        client.power_off
+      end
+    end
+    
+    desc "power_reboot", "Reboot the server"
+    map "power:reboot" => :power_reboot
+    def power_reboot
+      with_idrac_client do |client|
+        client.reboot
+      end
+    end
+    
+    desc "redfish_version", "Display the Redfish API version"
+    map "redfish:version" => :redfish_version
+    def redfish_version
+      with_idrac_client do |client|
+        version = client.redfish_version
+        puts version
+      end
+    end
+
+    private
+
+    def with_idrac_client
+      ensure_host_provided
+      check_ssl_verification
+      client = create_client
+      
+      # Set verbosity level for the client
+      if client.respond_to?(:verbosity=)
+        if options[:debug]
+          client.verbosity = 3
+        elsif options[:very_verbose]
+          client.verbosity = 2
+        elsif options[:verbose]
+          client.verbosity = 1
+        else
+          client.verbosity = 0
+        end
+      end
+      
+      # Execute command with proper error handling
+      begin
+        yield client
       rescue IDRAC::Error => e
         puts "Error: #{e.message}".red.bold
         exit 1
@@ -321,13 +484,6 @@ module IDRAC
         client.logout
       end
     end
-    
-    map "firmware:update" => :firmware_update
-    map "firmware:catalog" => :firmware_catalog
-    map "firmware:status" => :firmware_status
-    map "firmware:interactive" => :firmware_interactive
-
-    private
 
     def ensure_host_provided
       if !options[:host]
@@ -352,7 +508,8 @@ module IDRAC
         password: options[:password],
         port: options[:port],
         use_ssl: !options[:no_ssl],
-        verify_ssl: options[:verify_ssl]
+        verify_ssl: options[:verify_ssl],
+        auto_delete_sessions: options[:auto_delete_sessions]
       )
     end
   end