idrac 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a32506a7e00919c067cf111bdb2cd7f2e3422302a93f2678512ffa8e17b46758
-  data.tar.gz: 7271bbbfcdca8616c4cb9c742c46a49213f314eaa0774e4dd2e31e189402ac49
+  metadata.gz: 84cc513a711ebdea97f786857702ff36f607a0787e32dfe9b923f2587fc0f547
+  data.tar.gz: f6ff7e6b297064d268c702bbe89c7a6c663a9e0b7b4096bb92ae3ba922731e49
 SHA512:
-  metadata.gz: 3918c78519d1d10062a9efe2bf69988a038e6d82dc433478448901b12eeb55bdd1ba371ea1843309f6a2eba40c2eb80f8feb88dfa25f01e3e6811bca70039de8
-  data.tar.gz: a96828348048c1b281ed075f23d3baed1446206806085a87d4699a14879d186cc44dfc552bd1950c07517eb05fe0b6591b80f75822a4f44d778099e1cdfb8ca5
+  metadata.gz: 40c1af62898da133ddb2ecf7dab1888c4b3b6758c7af912f9cdd3f2f644c089d42dea211c58a0aa5ceb056a04dec9df3cd98cdbe3b664c271aec3e4bc03f686a
+  data.tar.gz: b1977e34694d5a5c41d54fe461bcb8c03724e4bdf5a6c59aa08fd6325ddd22c41a50d0e615fbfba86428aaf73b6960f03f6dedf1a4811617d98aa466d04dbfa7

data/README.md

@@ -52,6 +52,20 @@ idrac firmware:interactive --host=192.168.1.100 --username=root --password=calvi
 
 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.
 
+#### Session Management Options
+
+By default, the client will automatically delete existing sessions when the maximum session limit is reached. You can control this behavior with the `--auto-delete-sessions` option:
+
+```bash
+# Disable automatic session deletion (use direct mode instead when max sessions reached)
+idrac firmware:status --host=192.168.1.100 --no-auto-delete-sessions
+
+# Explicitly enable automatic session deletion (this is the default)
+idrac firmware:status --host=192.168.1.100 --auto-delete-sessions
+```
+
+When `--auto-delete-sessions` is enabled (the default), the client will attempt to delete existing sessions when it encounters a "maximum number of user sessions" error. When disabled, it will switch to direct mode (using Basic Authentication) instead of trying to clear sessions.
+
 ### Ruby API
 
 ```ruby
@@ -95,6 +109,14 @@ end
 # Update firmware
 job_id = firmware.update('/path/to/firmware.exe', wait: true)
 puts "Update completed with job ID: #{job_id}"
+
+# Create a client with auto_delete_sessions disabled
+client = IDRAC.new(
+  host: '192.168.1.100',
+  username: 'root',
+  password: 'calvin',
+  auto_delete_sessions: false
+)
 ```
 
 ## Development
@@ -105,6 +127,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Changelog
 
+### Version 0.1.22
+- **Session Management Control**: Added `--auto-delete-sessions` CLI option (default: true)
+- When enabled, the client automatically deletes existing sessions when maximum session limit is reached
+- When disabled, the client switches to direct mode instead of trying to clear sessions
+- Added detailed logging for session management decisions
+- Updated documentation with examples of how to use the new option
+
 ### 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

data/bin/idrac

@@ -19,6 +19,7 @@ module IDRAC
     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)"
 
     desc "firmware:update PATH", "Update firmware using the specified file"
     method_option :wait, type: :boolean, default: true, desc: "Wait for the update to complete"
@@ -191,7 +192,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

data/lib/idrac/client.rb

@@ -8,10 +8,10 @@ require 'json'
 
 module IDRAC
   class Client
-    attr_reader :host, :username, :password, :port, :use_ssl, :verify_ssl
+    attr_reader :host, :username, :password, :port, :use_ssl, :verify_ssl, :auto_delete_sessions
     attr_accessor :direct_mode
 
-    def initialize(host:, username:, password:, port: 443, use_ssl: true, verify_ssl: true, direct_mode: false)
+    def initialize(host:, username:, password:, port: 443, use_ssl: true, verify_ssl: true, direct_mode: false, auto_delete_sessions: true)
       @host = host
       @username = username
       @password = password
@@ -24,6 +24,7 @@ module IDRAC
       @direct_mode = direct_mode
       @sessions_maxed = false
       @tried_clearing_sessions = false
+      @auto_delete_sessions = auto_delete_sessions
     end
 
     def connection
@@ -154,30 +155,37 @@ module IDRAC
         puts "Maximum sessions reached during Redfish session creation"
         @sessions_maxed = true
         
-        # Try to clear sessions
-        if force_clear_sessions
-          puts "Successfully cleared sessions, trying to create a new session"
-          
-          # Try one more time after clearing
-          response = connection.post(url) do |req|
-            req.headers.merge!(basic_auth_headers)
-            req.body = payload.to_json
-          end
-          
-          if response.status == 201 || response.status == 200
-            @x_auth_token = response.headers['X-Auth-Token']
-            @session_location = response.headers['Location']
-            puts "Redfish session created successfully after clearing sessions"
-            @sessions_maxed = false
-            return true
+        # Try to clear sessions if auto_delete_sessions is enabled
+        if @auto_delete_sessions
+          puts "Auto-delete sessions is enabled, attempting to clear sessions"
+          if force_clear_sessions
+            puts "Successfully cleared sessions, trying to create a new session"
+            
+            # Try one more time after clearing
+            response = connection.post(url) do |req|
+              req.headers.merge!(basic_auth_headers)
+              req.body = payload.to_json
+            end
+            
+            if response.status == 201 || response.status == 200
+              @x_auth_token = response.headers['X-Auth-Token']
+              @session_location = response.headers['Location']
+              puts "Redfish session created successfully after clearing sessions"
+              @sessions_maxed = false
+              return true
+            else
+              puts "Failed to create Redfish session after clearing: #{response.status} - #{response.body}"
+              # If we still can't create a session, switch to direct mode
+              @direct_mode = true
+              return false
+            end
           else
-            puts "Failed to create Redfish session after clearing: #{response.status} - #{response.body}"
-            # If we still can't create a session, switch to direct mode
+            puts "Failed to clear sessions, switching to direct mode"
             @direct_mode = true
             return false
           end
         else
-          puts "Failed to clear sessions, switching to direct mode"
+          puts "Auto-delete sessions is disabled, switching to direct mode"
           @direct_mode = true
           return false
         end
@@ -237,12 +245,16 @@ module IDRAC
           # Check for maximum sessions error
           if error_message.include?("maximum number of user sessions")
             puts "Maximum sessions reached for WebUI, attempting to clear sessions (attempt #{retry_count + 1}/3)..."
-            # Try to clear any existing sessions
-            force_clear_sessions
-            # Wait for the server to process the session changes
-            sleep(3)
-            # Try logging in again with incremented retry counter
-            return webui_login(retry_count + 1)
+            # Try to clear any existing sessions if auto_delete_sessions is enabled
+            if @auto_delete_sessions
+              force_clear_sessions
+              # Wait for the server to process the session changes
+              sleep(3)
+              # Try logging in again with incremented retry counter
+              return webui_login(retry_count + 1)
+            else
+              raise Error, "Maximum sessions reached and auto-delete sessions is disabled"
+            end
           end
           
           raise Error, "Error Message: #{error_message}"

data/lib/idrac/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idrac
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - Jonathan Siegel