idrac 0.7.10 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ada89d6fb4827e57600dda32ff7a93124b526ee3986335fb593c2a61ea767d29
-  data.tar.gz: 4237b089a51941b56524e3d4341835b5c60c36b365cfff9e74f90faa43bf0fad
+  metadata.gz: 58f8d5e0d7f90857359eaf0be71c114da11ac324539b335e1a55f21567c33020
+  data.tar.gz: 498235abd52da11fba45a89032a5e0a72a56b53b7918e60bbdacfeda718229a2
 SHA512:
-  metadata.gz: 7a5367ff256299d380a8be3d9b1f284051e96ac415e377667e8118cb0511b138fa7a0c3644a1d48c69bba74e5d812cd0046add67a4a1b0d7913b482de9b03d87
-  data.tar.gz: ddc6e9496009474248636fe2037b6aa721bb9f50a333937835062f02aad4ed7fff46f098a824b0ef1eabe3c704e2584261d08e150f426e4c778886a56a7c164b
+  metadata.gz: 83010a42db5c2f04ce5d7c49802725e54aeb68409c2aaca00318fb32bb4c6adb69b50f22f2e2b14891934fd308b248d6b8169bcb70ba8e3f0415ea5405c3438a
+  data.tar.gz: d9bea26cad955e27ad749018973d999e76741b34d0645f2cc7f9abc046f977ec95d23bebbb46a2e80f990bb71cc265c7b52b1ed539dee0a8463984efa66f1864

data/README.md

@@ -17,6 +17,8 @@ A Ruby client for the Dell iDRAC API. This gem provides a command-line interface
 - Lifecycle Controller status management
 - Return values as RecursiveOpenStruct objects for convenient attribute access
 - Reset iDRAC functionality
+- Generate and download TSR (Technical Support Report) / SupportAssist collections
+- SupportAssist EULA management
 
 ## Installation
 
@@ -85,6 +87,11 @@ idrac sel:clear --host=192.168.1.100
 
 # Reset iDRAC
 idrac reset --host=192.168.1.100
+
+# TSR/SupportAssist Collection Commands
+idrac tsr_collect --host=192.168.1.100  # Generate and download TSR logs
+idrac tsr_status --host=192.168.1.100  # Check TSR collection status
+idrac tsr_accept_eula --host=192.168.1.100  # Accept SupportAssist EULA (required before first use)
 ```
 
 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.
@@ -179,6 +186,18 @@ client.clear_lifecycle!
 # Clear System Event Logs
 client.clear_system_event_logs!
 
+# TSR/SupportAssist Collection operations
+# Accept EULA (required only once)
+client.accept_supportassist_eula
+
+# Generate and download TSR logs
+file_path = client.generate_and_download_tsr(output_file: "tsr.zip")
+puts "TSR logs saved to: #{file_path}"
+
+# Check TSR collection status
+status = client.tsr_status
+puts "Collection available: #{status[:available]}"
+
 # Working with hash objects
 # Methods return data as Ruby hashes with string keys for consistent access
 
@@ -272,6 +291,15 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Changelog
 
+### Version 0.8.0
+- **Added TSR/SupportAssist Collection Support**: Simplified commands for generating Technical Support Reports
+  - Generate and download SupportAssist collections with direct file download
+  - Automatic EULA acceptance check with clear user guidance
+  - Simple CLI commands: `tsr_collect`, `tsr_status`, `tsr_accept_eula`
+  - Job-based generation with automatic progress tracking
+  - Direct download approach based on Dell's official Python implementation
+  - Clear error messages when EULA acceptance is required
+
 ### Version 0.7.8
 - **Network Redirection Support**: Added optional `host_header` parameter to Client initialization
 - Enables iDRAC access through network redirection scenarios where the connection IP differs from the Host header requirement

data/bin/idrac

@@ -1660,6 +1660,53 @@ module IDRAC
       end
     end
     
+    # TSR (Technical Support Report) commands
+    desc "tsr_collect", "Generate and download TSR/SupportAssist collection"
+    method_option :output, type: :string, desc: "Output filename"
+    def tsr_collect
+      with_idrac_client do |client|
+        puts "Generating and downloading TSR logs...".yellow
+        puts "This may take several minutes...".yellow
+        
+        result = client.generate_and_download_tsr(output_file: options[:output])
+        
+        if result
+          puts "TSR logs saved to: #{result}".green
+          puts "File size: #{File.size(result) / 1024 / 1024} MB".cyan if File.exist?(result)
+        else
+          puts "Failed to generate or download TSR logs".red
+        end
+      end
+    end
+    
+    desc "tsr_status", "Check TSR collection status"
+    def tsr_status
+      with_idrac_client do |client|
+        status = client.tsr_status
+        
+        puts "\nTSR Collection Status:".green.bold
+        puts "Available: #{status[:available] ? 'Yes'.green : 'No'.red}"
+        
+        if status[:collection_in_progress]
+          puts "Collection in progress: Yes".yellow
+          puts "Job ID: #{status[:job_id]}".cyan if status[:job_id]
+        else
+          puts "Collection in progress: No".green
+        end
+      end
+    end
+    
+    desc "tsr_accept_eula", "Accept SupportAssist EULA"
+    def tsr_accept_eula
+      with_idrac_client do |client|
+        if client.accept_supportassist_eula
+          puts "SupportAssist EULA accepted successfully".green
+        else
+          puts "Failed to accept SupportAssist EULA".red
+        end
+      end
+    end
+    
     private
 
     def with_idrac_client

data/bin/idrac-tsr

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/idrac'
+require 'optparse'
+
+options = {
+  host: ENV['IDRAC_HOST'],
+  username: ENV['IDRAC_USER'] || 'root',
+  password: ENV['IDRAC_PASSWORD'] || 'calvin',
+  output: nil,
+  data_types: [0, 1, 2], # Default: Hardware, OS, Debug
+  timeout: 600,
+  verbose: false
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: idrac-tsr [options]"
+  
+  opts.on("-h", "--host HOST", "iDRAC host address") do |h|
+    options[:host] = h
+  end
+  
+  opts.on("-u", "--username USER", "Username (default: root)") do |u|
+    options[:username] = u
+  end
+  
+  opts.on("-p", "--password PASS", "Password (default: calvin)") do |p|
+    options[:password] = p
+  end
+  
+  opts.on("-o", "--output FILE", "Output filename (default: auto-generated)") do |o|
+    options[:output] = o
+  end
+  
+  opts.on("-d", "--data TYPES", "Data types to collect (comma-separated: 0=HW,1=OS,2=Debug,3=TTY,4=All)") do |d|
+    options[:data_types] = d.split(',').map(&:to_i)
+  end
+  
+  opts.on("-t", "--timeout SECONDS", Integer, "Timeout in seconds (default: 600)") do |t|
+    options[:timeout] = t
+  end
+  
+  opts.on("-v", "--verbose", "Verbose output") do
+    options[:verbose] = true
+  end
+  
+  opts.on("--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+if options[:host].nil?
+  puts "Error: Host is required. Use -h HOST or set IDRAC_HOST environment variable"
+  exit 1
+end
+
+begin
+  client = IDRAC::Client.new(
+    host: options[:host],
+    username: options[:username],
+    password: options[:password],
+    verify_ssl: false
+  )
+  
+  client.verbosity = options[:verbose] ? 1 : 0
+  
+  puts "Connecting to #{options[:host]}..."
+  client.login
+  
+  puts "Generating TSR logs (this may take several minutes)..."
+  result = client.generate_and_download_tsr(
+    output_file: options[:output],
+    data_selector_values: options[:data_types],
+    wait_timeout: options[:timeout]
+  )
+  
+  if result
+    puts "✓ TSR logs saved to: #{result}"
+    puts "  File size: #{File.size(result) / 1024 / 1024} MB" if File.exist?(result)
+  else
+    puts "✗ Failed to download TSR logs"
+    exit 1
+  end
+  
+  client.logout
+rescue => e
+  puts "Error: #{e.message}"
+  exit 1
+end

data/lib/idrac/client.rb

@@ -155,6 +155,11 @@ module IDRAC
       headers['Accept'] ||= 'application/json'
       headers['Host'] = @host_header if @host_header
       
+      # Debug the body being sent
+      if body && @verbosity >= 2
+        debug "Request body: #{body}", 2
+      end
+      
       # Determine authentication method and set headers
       if @direct_mode
         headers['Authorization'] = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
@@ -190,6 +195,7 @@ module IDRAC
       begin
         conn.options.timeout = timeout if timeout
         conn.options.open_timeout = open_timeout if open_timeout
+        
         conn.run_request(method, path, body, headers)
       ensure
         conn.options.timeout = original_timeout

data/lib/idrac/utility.rb

@@ -1,7 +1,355 @@
+
 module IDRAC
   module Utility
     include Debuggable
 
+    # Generate TSR (Technical Support Report) logs using SupportAssistCollection for local generation
+    # @param data_selector_values [Array] Array of log types to include (optional)
+    #   Default includes all available log types
+    # @return [Hash] Result hash with status and job/task information
+    def generate_tsr_logs(data_selector_values: nil, share_type: nil, share_parameters: nil)
+      debug "Generating TSR/SupportAssist logs...", 1
+      
+      # Check EULA status first
+      eula_status = supportassist_eula_status
+      if eula_status["EULAAccepted"] == false || eula_status["EULAAccepted"] == "false"
+        puts "\n" + "="*80
+        puts "ERROR: SupportAssist EULA Not Accepted".red.bold
+        puts "="*80
+        puts ""
+        puts "The SupportAssist End User License Agreement (EULA) must be accepted".yellow
+        puts "before you can generate TSR/SupportAssist collections.".yellow
+        puts ""
+        puts "To accept the EULA, run:".cyan
+        puts "  idrac tsr_accept_eula --host #{@host} --port #{@port}".green.bold
+        puts ""
+        puts "="*80
+        return { status: :failed, error: "SupportAssist EULA not accepted" }
+      end
+      
+      # Default data selector values for comprehensive TSR
+      # Valid values for SupportAssistCollection: "DebugLogs", "GPULogs", "HWData", "OSAppData", "TTYLogs", "TelemetryReports"
+      data_selector_values ||= ["HWData", "OSAppData"]  
+      
+      # Map numeric values to iDRAC expected strings if needed
+      if data_selector_values.is_a?(Array) && data_selector_values.first.to_s =~ /^\d+$/
+        data_selector_values = data_selector_values.map do |val|
+          case val.to_s
+          when "0" then "HWData"
+          when "1" then "OSAppData"  
+          when "2" then "TTYLogs"
+          when "3" then "DebugLogs"
+          else "HWData"  # Default to HWData
+          end
+        end
+      elsif data_selector_values.is_a?(String)
+        data_selector_values = data_selector_values.split(',')
+      end
+      
+      debug "Data selector values: #{data_selector_values.inspect}", 1
+      
+      # Use SupportAssistCollection for local generation as it supports "Local" ShareType
+      payload = {
+        "ShareType" => "Local",
+        "DataSelectorArrayIn" => data_selector_values,
+        "Filter" => "No",  # Don't filter PII
+        "Transmit" => "No"  # Don't transmit to Dell
+      }
+      
+      debug "SupportAssist collection payload: #{payload.to_json}", 1
+      
+      response = authenticated_request(
+        :post,
+        "/redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLCService/Actions/DellLCService.SupportAssistCollection",
+        body: payload.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+      
+      case response.status
+      when 202
+        # Accepted - job created
+        location = response.headers["location"]
+        if location
+          debug "TSR generation job created: #{location}", 1, :green
+          job_id = location.split("/").last
+          # Wait for job to complete and capture the file location
+          job_result = wait_for_job_with_location(job_id)
+          if job_result && (job_result["JobState"] == "Completed" || job_result["JobState"] == "CompletedWithErrors")
+            result = { status: :success, job: job_result }
+            # Check if we got a file location from the job completion
+            result[:location] = job_result["FileLocation"] if job_result["FileLocation"]
+            result
+          else
+            { status: :failed, error: "Job did not complete successfully" }
+          end
+        else
+          { status: :accepted, message: "TSR generation initiated" }
+        end
+      when 200..299
+        debug "TSR generation completed immediately", 1, :green
+        { status: :success }
+      else
+        error_msg = parse_error_response(response)
+        debug "Failed to generate TSR: #{error_msg}", 1, :red
+        { status: :failed, error: error_msg }
+      end
+    rescue => e
+      debug "Error generating TSR: #{e.message}", 1, :red
+      { status: :error, error: e.message }
+    end
+
+    # Download TSR/SupportAssist logs from a URL location
+    # @param location [String] URL location of the TSR file
+    # @param output_file [String] Path to save the TSR file (optional)
+    # @return [String, nil] Path to downloaded file or nil if failed
+    def download_tsr_from_location(location, output_file: nil)
+      debug "Downloading TSR from location: #{location}", 1
+      
+      # Default output filename with timestamp
+      output_file ||= "supportassist_#{@host}_#{Time.now.strftime('%Y%m%d_%H%M%S')}.zip"
+      
+      # Download the file from the location
+      file_response = authenticated_request(:get, location)
+      
+      if file_response.status == 200 && file_response.body
+        File.open(output_file, 'wb') do |f|
+          f.write(file_response.body)
+        end
+        debug "TSR saved to: #{output_file} (#{File.size(output_file)} bytes)", 1, :green
+        return output_file
+      else
+        debug "Failed to download file from location. Status: #{file_response.status}", 1, :red
+        nil
+      end
+    rescue => e
+      debug "Error downloading TSR: #{e.message}", 1, :red
+      nil
+    end
+    
+    # Wait for job and capture file location from response headers
+    # @param job_id [String] The job ID to wait for
+    # @param max_wait [Integer] Maximum time to wait in seconds
+    # @return [Hash, nil] Job data with FileLocation if available
+    def wait_for_job_with_location(job_id, max_wait: 600)
+      debug "Waiting for job #{job_id} to complete...", 1
+      start_time = Time.now
+      
+      while (Time.now - start_time) < max_wait
+        job_response = authenticated_request(:get, "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/#{job_id}")
+        
+        if job_response.status == 200
+          job_data = JSON.parse(job_response.body)
+          
+          case job_data["JobState"]
+          when "Completed", "CompletedWithErrors"
+            debug "Job #{job_id} completed: #{job_data["JobState"]}", 1, :green
+            
+            # Check response headers for file location
+            if job_response.headers["location"]
+              job_data["FileLocation"] = job_response.headers["location"]
+              debug "Found file location in headers: #{job_data["FileLocation"]}", 1, :green
+            end
+            
+            # Also check the job data itself for output location
+            if job_data["Oem"] && job_data["Oem"]["Dell"] && job_data["Oem"]["Dell"]["OutputLocation"]
+              job_data["FileLocation"] = job_data["Oem"]["Dell"]["OutputLocation"]
+              debug "Found file location in job data: #{job_data["FileLocation"]}", 1, :green
+            end
+            
+            return job_data
+          when "Failed", "Exception"
+            debug "Job #{job_id} failed: #{job_data["Message"]}", 1, :red
+            return job_data
+          else
+            debug "Job #{job_id} state: #{job_data["JobState"]} - #{job_data["PercentComplete"]}%", 2
+            sleep 5
+          end
+        else
+          debug "Failed to get job status: #{job_response.status}", 2
+          sleep 5
+        end
+      end
+      
+      debug "Timeout waiting for job #{job_id}", 1, :red
+      nil
+    end
+    
+    # Parse error response from iDRAC
+    def parse_error_response(response)
+      begin
+        data = JSON.parse(response.body)
+        if data["error"] && data["error"]["@Message.ExtendedInfo"]
+          data["error"]["@Message.ExtendedInfo"].first["Message"]
+        elsif data["error"] && data["error"]["message"]
+          data["error"]["message"]
+        else
+          "Status: #{response.status} - #{response.body}"
+        end
+      rescue
+        "Status: #{response.status} - #{response.body}"
+      end
+    end
+
+    # Generate and download TSR logs in a single operation
+    # @param output_file [String] Path to save the TSR file (optional)
+    # @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)
+      debug "Starting TSR generation and download process...", 1
+      
+      output_file ||= "supportassist_#{@host}_#{Time.now.strftime('%Y%m%d_%H%M%S')}.zip"
+      
+      # First, generate the TSR
+      result = generate_tsr_logs(data_selector_values: data_selector_values)
+      
+      if result[:status] == :success && result[:job]
+        debug "TSR generation completed successfully", 1, :green
+        
+        # Check if the job response has a location for the file
+        if result[:location]
+          return download_tsr_from_location(result[:location], output_file: output_file)
+        else
+          # Try alternative download methods based on Dell's Python script approach
+          debug "Attempting to locate generated TSR file...", 1, :yellow
+          
+          # Wait a moment for the file to be available
+          sleep 2
+          
+          # Try known endpoints where the file might be available
+          possible_locations = [
+            "/redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLCService/ExportedFiles/SupportAssist",
+            "/redfish/v1/Managers/iDRAC.Embedded.1/Oem/Dell/DellLCService/ExportedFiles",
+            "/downloads/supportassist_collection.zip",
+            "/sysmgmt/2016/server/support_assist_collection"
+          ]
+          
+          possible_locations.each do |location|
+            debug "Trying location: #{location}", 2
+            file_response = authenticated_request(:get, location)
+            
+            if file_response.status == 200 && file_response.body && file_response.body.size > 1024
+              File.open(output_file, 'wb') do |f|
+                f.write(file_response.body)
+              end
+              debug "TSR saved to: #{output_file} (#{File.size(output_file)} bytes)", 1, :green
+              return output_file
+            end
+          end
+          
+          debug "Could not locate TSR file for direct download", 1, :yellow
+          debug "The collection was generated but may require network share export", 1, :yellow
+        end
+      elsif result[:status] == :accepted
+        debug "TSR generation was accepted but status unknown", 1, :yellow
+      else
+        debug "Failed to initiate TSR generation: #{result[:error]}", 1, :red
+      end
+      
+      nil
+    end
+    public
+
+    # Get TSR/SupportAssist collection status
+    # @return [Hash] Status information
+    def tsr_status
+      debug "Checking SupportAssist collection status...", 1
+      
+      response = authenticated_request(
+        :get,
+        "/redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLCService"
+      )
+      
+      if response.status == 200
+        data = JSON.parse(response.body)
+        status = {
+          available: data["Actions"]&.key?("#DellLCService.SupportAssistCollection"),
+          export_available: data["Actions"]&.key?("#DellLCService.SupportAssistExportLastCollection"),
+          collection_in_progress: false
+        }
+        
+        # Check if there's an active collection job
+        jobs_response = authenticated_request(:get, "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs")
+        if jobs_response.status == 200
+          jobs_data = JSON.parse(jobs_response.body)
+          if jobs_data["Members"]
+            jobs_data["Members"].each do |job|
+              if job["Name"]&.include?("SupportAssist") || job["Name"]&.include?("TSR")
+                status[:collection_in_progress] = true
+                status[:job_id] = job["Id"]
+                status[:job_state] = job["JobState"]
+                break
+              end
+            end
+          end
+        end
+        
+        debug "SupportAssist status: #{status.to_json}", 2
+        status
+      else
+        debug "Failed to get SupportAssist status: #{response.status}", 1, :red
+        { available: false, error: "Unable to determine status" }
+      end
+    rescue => e
+      debug "Error checking SupportAssist status: #{e.message}", 1, :red
+      { available: false, error: e.message }
+    end
+
+    # Check SupportAssist EULA status
+    # @return [Hash] EULA status information
+    def supportassist_eula_status
+      debug "Checking SupportAssist EULA status...", 1
+      
+      response = authenticated_request(
+        :post,
+        "/redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLCService/Actions/DellLCService.SupportAssistGetEULAStatus",
+        body: {}.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+      
+      if response.status.between?(200, 299)
+        begin
+          data = JSON.parse(response.body)
+          debug "EULA status: #{data.to_json}", 2
+          return data
+        rescue JSON::ParserError
+          return { "EULAAccepted" => "Unknown" }
+        end
+      else
+        error_msg = parse_error_response(response)
+        debug "Failed to get EULA status: #{error_msg}", 1, :red
+        return { "EULAAccepted" => "Error", "error" => error_msg }
+      end
+    rescue => e
+      debug "Error checking EULA status: #{e.message}", 1, :red
+      { "EULAAccepted" => "Error", "error" => e.message }
+    end
+    
+    # Accept SupportAssist EULA
+    # @return [Boolean] true if successful
+    def accept_supportassist_eula
+      debug "Accepting SupportAssist EULA...", 1
+      
+      response = authenticated_request(
+        :post,
+        "/redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLCService/Actions/DellLCService.SupportAssistAcceptEULA",
+        body: {}.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+      
+      if response.status.between?(200, 299)
+        debug "SupportAssist EULA accepted successfully", 1, :green
+        true
+      else
+        error_msg = parse_error_response(response)
+        debug "Failed to accept EULA: #{error_msg}", 1, :red
+        false
+      end
+    rescue => e
+      debug "Error accepting EULA: #{e.message}", 1, :red
+      false
+    end
+    
     # Reset the iDRAC controller (graceful restart)
     def reset!
       debug "Resetting iDRAC controller...", 1

data/lib/idrac/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: idrac
 version: !ruby/object:Gem::Version
-  version: 0.7.10
+  version: 0.8.0
 platform: ruby
 authors:
 - Jonathan Siegel
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -261,6 +260,7 @@ files:
 - README.md
 - bin/console
 - bin/idrac
+- bin/idrac-tsr
 - bin/setup
 - idrac.gemspec
 - lib/idrac.rb
@@ -286,7 +286,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: http://github.com
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -301,8 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: API Client for Dell iDRAC
 test_files: []