idrac 0.11.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aae19c4ce800e57cb1b15ca37be3d48d1c22f52d2eb455a877fe517f21bd65f4
-  data.tar.gz: 1f772c3a6c316578e572e8b797695e19096e1a04e424f38633f6dfad56b6a12c
+  metadata.gz: 9ad0fa030e4eec1e405f68895dfb6df28cccea13f2d4ec3a73c878e1485858f3
+  data.tar.gz: 1311e7bfd4ecc14ae1ad2ce52b0d5290db92a3c0befed2a5da7ebdebd779f291
 SHA512:
-  metadata.gz: 51c2314dee2b317013816c1e87aacd0d2f5808bb63921826da788d50248e7b84fb871b14abcbc92f92b56ae7cea18d69b5ed32727939549351ee8026510356a1
-  data.tar.gz: e2fe2aad75892982b41819ac1dafd13a7317c85e7d427ee6379b21a8b2daa1e2563c87b1ac97d1910ff9f5900058562a727b06b3e104e9a3183cb82850843db0
+  metadata.gz: 152616e382e2800ba319a761be9f65d463da19273ed8e79236c2a13f32d021a87e4de138763843902e8fb9b5d000b48d47fe653f2d35b6110ad9cc7ba87ae786
+  data.tar.gz: 69f27c37739d3f22a03659d76a0fa4be4334c2c19adb67671b11194987b8c921025d00be0c8cd627d9bcc5991238e2b0d7c444ece750b5da961f3dbcb833d4c4

data/README.md

@@ -36,6 +36,19 @@ Or install it yourself as:
 
     $ gem install idrac
 
+## Compatibility
+
+`activesupport` below 8.1 and `json` 3 cannot be used together: activesupport's
+JSON encoder calls `JSON.generate(..., quirks_mode: true)`, and json 3 removed
+that keyword, so any `hash.to_json` raises `ArgumentError: unknown keyword:
+quirks_mode`. This is not specific to this gem — it bites anything that loads
+`active_support/core_ext` — but idrac depends on activesupport, so pick one of:
+
+- activesupport >= 8.1 with json 3, or
+- activesupport 7.x with json 2.
+
+CI covers both ends.
+
 ## Usage
 
 ### Command Line Interface

data/lib/idrac/client.rb

@@ -81,6 +81,7 @@ module IDRAC
           faraday.response :logger, Logger.new(STDOUT), bodies: @verbosity >= 2 do |logger|
             logger.filter(/(Authorization: Basic )([^,\n]+)/, '\1[FILTERED]')
             logger.filter(/(Password"=>"?)([^,"]+)/, '\1[FILTERED]')
+            logger.filter(/(Password\\?"\s*[:,]\s*(?:\\?"Value\\?"\s*:\s*)?\\?")([^"\\]*)/, '\1[FILTERED]')
           end
         end
       end
@@ -190,7 +191,7 @@ module IDRAC
       headers['Accept'] ||= 'application/json'
       headers['Host'] = @host_header if @host_header
 
-      debug "Request body: #{body}", 2 if body && @verbosity >= 2
+      debug "Request body: #{body.to_s.match?(/password/i) ? '[REDACTED: contains a password]' : body}", 2 if body && @verbosity >= 2
 
       if @direct_mode
         headers['Authorization'] = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"

data/lib/idrac/session.rb

@@ -43,6 +43,7 @@ module IDRAC
           faraday.response :logger, Logger.new(STDOUT), bodies: @verbosity >= 2 do |logger|
             logger.filter(/(Authorization: Basic )([^,\n]+)/, '\1[FILTERED]')
             logger.filter(/(Password"=>"?)([^,"]+)/, '\1[FILTERED]')
+            logger.filter(/(Password\\?"\s*[:,]\s*(?:\\?"Value\\?"\s*:\s*)?\\?")([^"\\]*)/, '\1[FILTERED]')
           end
         end
       end

data/lib/idrac/system_config.rb

@@ -84,6 +84,34 @@ module IDRAC
       end
     end
 
+    # Set iDRAC-only attributes without touching host power. Names are Redfish-style
+    # ("VNCServer.1.Enable" => "Enabled"). iDRAC9 takes a plain PATCH (no job). iDRAC8 has
+    # no Manager Attributes resource (404), so fall back to an SCP import that targets the
+    # iDRAC only, with NoReboot and HostPowerState pinned to the host's current state.
+    # Returns { status: :success } for the PATCH, or the import job's outcome.
+    def set_idrac_attributes(attributes, timeout: 600)
+      debug "Setting iDRAC attributes: #{attributes.to_h { |k, v| [k, k.to_s.match?(/password/i) ? "[REDACTED]" : v] }}", 1, :blue
+      response = authenticated_request(:patch, "/redfish/v1/Managers/iDRAC.Embedded.1/Attributes",
+                                       body: { "Attributes" => attributes }.to_json) { |r| r }
+      return { status: :success } if response.status.between?(200, 299)
+      handle_response(response) unless response.status == 404
+
+      scp = { "SystemConfiguration" => { "Components" => [make_scp(fqdd: "iDRAC.Embedded.1",
+        attributes: attributes.to_h { |k, v| [k.to_s.sub(/\A([^.]+\.\d+)\./, '\1#'), v] })] } }
+      response = authenticated_request(:post,
+        "/redfish/v1/Managers/iDRAC.Embedded.1/Actions/Oem/EID_674_Manager.ImportSystemConfiguration",
+        body: { "ImportBuffer" => JSON.generate(scp), "ShareParameters" => { "Target" => "IDRAC" },
+                "ShutdownType" => "NoReboot", "HostPowerState" => get_power_state }.to_json)
+      wait_for_scp_import(response.headers["location"], timeout: timeout)
+    end
+
+    def enable_vnc!(password:, port: 5901)
+      set_idrac_attributes("VNCServer.1.Enable" => "Enabled", "VNCServer.1.Port" => port,
+                           "VNCServer.1.Password" => password,
+                           "VNCServer.1.SSLEncryptionBitLength" => "Disabled",
+                           "VNCServer.1.LowerEncryptionBitLength" => "Disabled")
+    end
+
     # Apply a system configuration profile to the iDRAC.
     #
     # Waits for the import JOB to finish and returns the JOB's outcome:
@@ -117,6 +145,8 @@ module IDRAC
         "ImportBuffer" => JSON.generate(scp_to_apply),
         "ShareParameters" => {"Target" => target},
         "ShutdownType" => "Forced",
+        # Warning: reboot: false sends "Off", which POWERS THE HOST OFF after the import.
+        # For iDRAC-only attributes use set_idrac_attributes, which keeps the power state.
         "HostPowerState" => reboot ? "On" : "Off"
       }
       

data/lib/idrac/utility.rb

@@ -194,11 +194,28 @@ module IDRAC
     # @param data_selector_values [Array] Array of log types to include (optional)
     # @param wait_timeout [Integer] Maximum time to wait for generation in seconds (default: 600)
     # @return [String, nil] Path to downloaded file or nil if failed
-    def generate_and_download_tsr(output_file: nil, data_selector_values: nil, wait_timeout: 600)
+    def generate_and_download_tsr(output_file: nil, data_selector_values: nil, accept_eula: false, wait_timeout: 600)
       debug "Starting TSR generation and download process...", 1
-      
+
       output_file ||= "supportassist_#{@host}_#{Time.now.strftime('%Y%m%d_%H%M%S')}.zip"
-      
+
+      # Accept the EULA up front when asked -- generate_tsr_logs only errors out otherwise.
+      accept_supportassist_eula if accept_eula
+
+      # Wait out a collection that is still running server-side. The iDRAC allows only one
+      # SupportAssist collection at a time, so generating now would fail with "a SupportAssist job
+      # is already running". Give up after wait_timeout seconds and fail the same way the rest of
+      # this method does (return nil).
+      wait_deadline = Time.now + wait_timeout
+      while supportassist_collection_running?
+        if Time.now > wait_deadline
+          debug "Timed out after #{wait_timeout}s waiting for a running SupportAssist collection to finish", 1, :red
+          return nil
+        end
+        debug "A SupportAssist collection is already running; waiting...", 1, :yellow
+        sleep 15
+      end
+
       # First, generate the TSR
       result = generate_tsr_logs(data_selector_values: data_selector_values)
       
@@ -267,8 +284,9 @@ module IDRAC
           collection_in_progress: false
         }
         
-        # Check if there's an active collection job
-        jobs_response = authenticated_request(:get, "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs")
+        # Check if there's an active collection job. The list must be expanded, otherwise each
+        # Members entry is a bare @odata.id with no Name/JobState and the check never fires.
+        jobs_response = authenticated_request(:get, "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs?$expand=*($levels=1)")
         if jobs_response.status == 200
           jobs_data = JSON.parse(jobs_response.body)
           if jobs_data["Members"]
@@ -294,6 +312,25 @@ module IDRAC
       { available: false, error: e.message }
     end
 
+    # True when a SupportAssist Collection job is still running server-side. Reads the expanded Dell
+    # Jobs list (bare @odata.id members carry no Name/JobState) and treats a job as running when its
+    # Name matches SupportAssist Collection, its JobState is not terminal, and it is below 100%.
+    # Use this to wait out a prior collection before starting a new one (the iDRAC allows only one).
+    def supportassist_collection_running?
+      response = authenticated_request(:get, "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs?$expand=*($levels=1)")
+      return false unless response.status == 200
+
+      members = JSON.parse(response.body)["Members"] || []
+      members.any? do |job|
+        job["Name"].to_s =~ /SupportAssist Collection/i &&
+          !IDRAC::Firmware::TERMINAL_JOB_STATES.include?(job["JobState"]) &&
+          job["PercentComplete"].to_i < 100
+      end
+    rescue => e
+      debug "Error checking SupportAssist collection state: #{e.message}", 1, :red
+      false
+    end
+
     # Check SupportAssist EULA status
     # @return [Hash] EULA status information
     def supportassist_eula_status

data/lib/idrac/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idrac
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.2
 platform: ruby
 authors:
 - Jonathan Siegel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-10 00:00:00.000000000 Z
+date: 2026-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -297,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: API Client for Dell iDRAC