supermicro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 669c0c630a85f14dd798b0ae247f337e0f87ded512ffeb3900cb26a1b90d3fbb
+  data.tar.gz: 308a2fb1e423da978a72ac6e5ef47107faf92dd896deb90a5cf787aad6529eb0
+SHA512:
+  metadata.gz: d0d5e2e6813f3e7a6723b02ccae82ee1a385b523567bade9646129e89a1d7a620f96753b8daf5c4d837c56dd52499132fe69ad6cba54293520fa4bd55262d86b
+  data.tar.gz: c4746751cc618049f748c28020890fe8dee881c643b031e77d354081074b337f6f2fc8f0c53d05067fb60c92580e8e6b389beb861151c724e5ae130ef68d3e19

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jonathan Siegel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,224 @@
+# Supermicro Redfish Ruby Client
+
+A Ruby client library for interacting with Supermicro BMC (Baseboard Management Controller) via the Redfish API.
+
+## Features
+
+This gem provides a Ruby interface to manage Supermicro servers through their BMC, offering the same functionality as the iDRAC gem but for Supermicro hardware:
+
+### Inventory Management
+- **System Information**: Model, serial number, BIOS version, UUID
+- **CPU**: Socket information, cores, threads, speed
+- **Memory**: DIMMs capacity, speed, health status
+- **Storage**: Controllers, physical drives, volumes/RAID configuration
+- **Network**: NICs with MAC addresses, link status, IP configuration
+- **Power Supplies**: Status, wattage, health monitoring
+- **Thermal**: Fan speeds, temperature sensors
+- **Power Consumption**: Current usage, capacity
+
+### Configuration
+- **Boot Order**: Set boot device priority
+- **Boot Override**: One-time or persistent boot device selection
+- **BIOS Settings**: Read and modify BIOS attributes
+- **Network Protocols**: Configure BMC network services
+- **User Management**: Create, modify, delete BMC users
+
+### Virtual Media
+- **Mount/Unmount ISO**: Attach HTTP-served ISO images
+- **Virtual Media Status**: Check mounted media
+- **Boot from Virtual Media**: Combined mount and boot configuration
+
+### Power Management
+- **Power Status**: Check current power state
+- **Power Control**: On, Off, Restart, Power Cycle
+- **Graceful Shutdown**: Attempt graceful OS shutdown
+
+### Monitoring & Logging
+- **System Event Log**: View and clear SEL entries
+- **Jobs/Tasks**: Monitor long-running operations
+- **Active Sessions**: View current BMC sessions
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'supermicro'
+```
+
+Or install directly:
+
+```bash
+gem install supermicro
+```
+
+## Usage
+
+### Basic Connection
+
+```ruby
+require 'supermicro'
+
+# Create a client
+client = Supermicro.new(
+  host: '192.168.1.100',
+  username: 'admin',
+  password: 'password',
+  verify_ssl: false
+)
+
+# Or use block form with automatic session cleanup
+Supermicro.connect(
+  host: '192.168.1.100',
+  username: 'admin',
+  password: 'password'
+) do |client|
+  # Your code here
+  puts client.power_status
+end
+```
+
+### Power Management
+
+```ruby
+# Check power status
+status = client.power_status  # => "On" or "Off"
+
+# Power operations
+client.power_on
+client.power_off
+client.power_restart
+client.power_cycle
+```
+
+### System Inventory
+
+```ruby
+# Get system information
+info = client.system_info
+
+# Get CPU information
+cpus = client.cpus
+
+# Get memory information
+memory = client.memory
+
+# Get storage summary
+storage = client.storage_summary
+
+# Get thermal information
+fans = client.fans
+temps = client.temperatures
+```
+
+### Virtual Media
+
+```ruby
+# Check virtual media status
+media = client.virtual_media_status
+
+# Mount an ISO
+client.insert_virtual_media("http://example.com/os.iso")
+
+# Unmount all media
+client.unmount_all_media
+
+# Mount ISO and set boot override
+client.mount_iso_and_boot("http://example.com/os.iso")
+```
+
+### Boot Configuration
+
+```ruby
+# Get boot options
+options = client.boot_options
+
+# Set one-time boot override
+client.set_boot_override("Pxe", persistent: false)
+
+# Quick boot methods
+client.boot_to_pxe
+client.boot_to_disk
+client.boot_to_cd
+client.boot_to_bios_setup
+```
+
+### BIOS Configuration
+
+```ruby
+# Get BIOS attributes
+attrs = client.bios_attributes
+
+# Set BIOS attribute
+client.set_bios_attribute("QuietBoot", "Enabled")
+
+# Reset BIOS to defaults
+client.reset_bios_defaults
+```
+
+## Configuration Options
+
+- `host`: BMC IP address or hostname
+- `username`: BMC username
+- `password`: BMC password
+- `port`: BMC port (default: 443)
+- `use_ssl`: Use HTTPS (default: true)
+- `verify_ssl`: Verify SSL certificates (default: false)
+- `direct_mode`: Use Basic Auth instead of sessions (default: false)
+- `retry_count`: Number of retries for failed requests (default: 3)
+- `retry_delay`: Initial delay between retries in seconds (default: 1)
+
+## Debugging
+
+Enable verbose output:
+
+```ruby
+client.verbosity = 1  # Basic debug output
+client.verbosity = 2  # Include request/response details
+client.verbosity = 3  # Include full stack traces
+```
+
+## Compatibility
+
+Tested with:
+- Supermicro BMC firmware version 01.04.08
+- Redfish API version 1.11.0
+- Ruby 3.0+
+
+## Differences from iDRAC
+
+While the API is similar to the iDRAC gem, there are some Supermicro-specific differences:
+
+1. **URL Paths**: Supermicro uses numeric IDs (e.g., `/Systems/1`) instead of Dell's embedded names
+2. **Redirects**: Supermicro BMC redirects some paths to include trailing slashes
+3. **SEL Path**: System Event Log may be at different locations depending on firmware
+4. **Task Management**: Task/Job structure differs from Dell's implementation
+5. **Virtual Media**: Different action paths and supported media types
+
+## Testing
+
+Run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+Or with specific tests:
+
+```bash
+bundle exec rspec spec/supermicro_spec.rb
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/buildio/supermicro.
+
+## License
+
+MIT

data/lib/supermicro/boot.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'colorize'
+
+module Supermicro
+  module Boot
+    def boot_options
+      response = authenticated_request(:get, "/redfish/v1/Systems/1")
+      
+      if response.status == 200
+        begin
+          data = JSON.parse(response.body)
+          
+          boot_info = data["Boot"] || {}
+          
+          {
+            "boot_source_override_enabled" => boot_info["BootSourceOverrideEnabled"],
+            "boot_source_override_target" => boot_info["BootSourceOverrideTarget"],
+            "boot_source_override_mode" => boot_info["BootSourceOverrideMode"],
+            "allowed_targets" => boot_info["BootSourceOverrideTarget@Redfish.AllowableValues"],
+            "boot_options" => boot_info["BootOptions"],
+            "boot_order" => boot_info["BootOrder"],
+            "uefi_target" => boot_info["UefiTargetBootSourceOverride"]
+          }
+        rescue JSON::ParserError
+          raise Error, "Failed to parse boot options response: #{response.body}"
+        end
+      else
+        raise Error, "Failed to get boot options. Status code: #{response.status}"
+      end
+    end
+
+    def set_boot_override(target, persistence: nil, mode: nil, persistent: false)
+      valid_targets = boot_options["allowed_targets"]
+      
+      unless valid_targets&.include?(target)
+        debug "Invalid boot target. Allowed values:"
+        valid_targets&.each { |t| debug "  - #{t}" }
+        raise Error, "Invalid boot target: #{target}"
+      end
+      
+      # Handle both old persistent parameter and new persistence parameter
+      enabled = if persistence
+        persistence  # Use new parameter if provided
+      elsif persistent
+        "Continuous"  # Legacy support
+      else
+        "Once"  # Default
+      end
+      
+      debug "Setting boot override to #{target} (#{enabled})..."
+      
+      body = {
+        "Boot" => {
+          "BootSourceOverrideEnabled" => enabled,
+          "BootSourceOverrideTarget" => target
+        }
+      }
+      
+      # Add boot mode if specified
+      if mode
+        body["Boot"]["BootSourceOverrideMode"] = mode
+      end
+      
+      response = authenticated_request(
+        :patch,
+        "/redfish/v1/Systems/1",
+        body: body.to_json,
+        headers: { 'Content-Type': 'application/json' }
+      )
+      
+      if response.status.between?(200, 299)
+        debug "Boot override set successfully."
+        return true
+      else
+        raise Error, "Failed to set boot override: #{response.status} - #{response.body}"
+      end
+    end
+    
+    def configure_boot_settings(persistence: nil, mode: nil)
+      debug "Configuring boot settings..."
+      
+      body = { "Boot" => {} }
+      
+      if persistence
+        body["Boot"]["BootSourceOverrideEnabled"] = persistence
+      end
+      
+      if mode
+        body["Boot"]["BootSourceOverrideMode"] = mode
+      end
+      
+      return false if body["Boot"].empty?
+      
+      response = authenticated_request(
+        :patch,
+        "/redfish/v1/Systems/1",
+        body: body.to_json,
+        headers: { 'Content-Type': 'application/json' }
+      )
+      
+      if response.status.between?(200, 299)
+        debug "Boot settings configured successfully."
+        return true
+      else
+        raise Error, "Failed to configure boot settings: #{response.status} - #{response.body}"
+      end
+    end
+
+    def clear_boot_override
+      puts "Clearing boot override...".yellow
+      
+      body = {
+        "Boot" => {
+          "BootSourceOverrideEnabled" => "Disabled"
+        }
+      }
+      
+      response = authenticated_request(
+        :patch,
+        "/redfish/v1/Systems/1",
+        body: body.to_json,
+        headers: { 'Content-Type': 'application/json' }
+      )
+      
+      if response.status.between?(200, 299)
+        puts "Boot override cleared successfully.".green
+        return true
+      else
+        raise Error, "Failed to clear boot override: #{response.status} - #{response.body}"
+      end
+    end
+
+    def set_boot_order(devices)
+      puts "Setting boot order...".yellow
+      
+      body = {
+        "Boot" => {
+          "BootOrder" => devices
+        }
+      }
+      
+      response = authenticated_request(
+        :patch,
+        "/redfish/v1/Systems/1",
+        body: body.to_json,
+        headers: { 'Content-Type': 'application/json' }
+      )
+      
+      if response.status.between?(200, 299)
+        puts "Boot order set successfully.".green
+        return true
+      else
+        raise Error, "Failed to set boot order: #{response.status} - #{response.body}"
+      end
+    end
+
+    def get_boot_devices
+      response = authenticated_request(:get, "/redfish/v1/Systems/1/BootOptions?$expand=*($levels=1)")
+      
+      if response.status == 200
+        begin
+          data = JSON.parse(response.body)
+          
+          devices = data["Members"]&.map do |device|
+            {
+              "id" => device["Id"],
+              "name" => device["DisplayName"] || device["Name"],
+              "description" => device["Description"],
+              "boot_option_reference" => device["BootOptionReference"],
+              "enabled" => device["BootOptionEnabled"],
+              "uefi_device_path" => device["UefiDevicePath"]
+            }
+          end || []
+          
+          return devices
+        rescue JSON::ParserError
+          raise Error, "Failed to parse boot devices response: #{response.body}"
+        end
+      else
+        []
+      end
+    end
+
+    def boot_to_pxe(persistence: nil, mode: nil)
+      set_boot_override("Pxe", persistence: persistence, mode: mode)
+    end
+
+    def boot_to_disk(persistence: nil, mode: nil)
+      set_boot_override("Hdd", persistence: persistence, mode: mode)
+    end
+
+    def boot_to_cd(persistence: nil, mode: nil)
+      set_boot_override("Cd", persistence: persistence, mode: mode)
+    end
+
+    def boot_to_usb(persistence: nil, mode: nil)
+      set_boot_override("Usb", persistence: persistence, mode: mode)
+    end
+
+    def boot_to_bios_setup(persistence: nil, mode: nil)
+      set_boot_override("BiosSetup", persistence: persistence, mode: mode)
+    end
+  end
+end