redfish-utilities 3.4.4

Redfish Utilities

Redfish Tacklebox

Copyright 2019-2025 DMTF. All rights reserved.

About

Redfish Tacklebox contains a set of Python3 utilities to perform common management operations with a Redfish service. The utilities can be used as part of larger management applications, or be used as standalone command line tools.

Installation

Only one installation method is required to use Redfish Tacklebox.

From PyPI

pip install redfish_utilities

Building from Source

git clone https://github.com/DMTF/Redfish-Tacklebox.git
cd Redfish-Tacklebox
python setup.py sdist
pip install dist/redfish_utilities-x.x.x.tar.gz

Building Docker

• Pull the container from Docker Hub:

  docker pull dmtf/redfish-tacklebox:latest
  

• Build a container from local source:

  docker build -t dmtf/redfish-tacklebox:latest .
  

• Build a container from GitHub:

  docker build -t dmtf/redfish-tacklebox:latest https://github.com/DMTF/Redfish-Tacklebox.git
  

Requirements

External modules:

• redfish: https://pypi.python.org/pypi/redfish
• XlsxWriter: https://pypi.org/project/XlsxWriter

You may install the external modules by running:

pip install -r requirements.txt

Utilities

• Discover (rf_discover.py)
• Sensor List (rf_sensor_list.py)
• System Inventory (rf_sys_inventory.py)
• Logs (rf_logs.py)
• SEL (rf_sel.py)
• Power/Reset (rf_power_reset.py)
• Boot Override (rf_boot_override.py)
• Virtual Media (rf_virtual_media.py)
• BIOS Settings (rf_bios_settings.py)
• Manager Configuration (rf_manager_config.py)
• Accounts (rf_accounts.py)
• Update (rf_update.py)
• Firmware Inventory (rf_firmware_inventory.py)
• Event Service (rf_event_service.py)
• Licenses (rf_licenses.py)
• Certificates (rf_certificates.py)
• Diagnostic Data (rf_diagnostic_data.py)
• Assembly (rf_assembly.py)
• Power Equipment (rf_power_equipment.py)
• Thermal Equipment (rf_thermal_equipment.py)
• Raw Request (rf_raw_request.py)
• Test Event Listener (rf_test_event_listener.py)

Release Process

1. Go to the "Actions" page
2. Select the "Release and Publish" workflow
3. Click "Run workflow"
4. Fill out the form
5. Click "Run workflow"