Skip to content

Manage AVerMedia ERMI Seamlessly via Redfish Toolkit

AVerMedia ERMI is fully compatible with the DMTF Redfish standard, enabling instant management through both Redfish Tacklebox and Redfish Trawler. These tools deliver a seamless, flexible, and standards-based management experience — ready to use right out of the box.

Note

Some utilities in Redfish Tacklebox and Redfish Trawler may require minor modifications before use, depending on the target Redfish service implementation.

Control ERMI Efficiently with Redfish Tacklebox

With Redfish Tacklebox, engineers can automate ERMI operations via powerful Python-based command-line tools. It is ideal for scripting, large-scale deployments, and integration into existing workflows, allowing teams to interact with ERMI using the standardized Redfish API with precision and efficiency.

Use Cases:

  • Quickly evaluate Redfish API capabilities
  • Verify and validate Redfish API implementations
  • Integrate Redfish operations into CI/CD pipelines or maintenance scripts

Prerequisite

  • Python programming
  • Command-line operation (Linux/Windows)
  • Basic understanding of Redfish API
  • Docker (if executed in a container environment)

Environment Settings

  • Python 3.x
  • Redfish
  • XlsxWriter
  • Optional: Docker

Installation (Only one method required):

Option 1. From PyPI

pip install redfish_utilities

Option 2. 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

Option 3. 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

Install the external modules:

pip install -r requirements.txt

Examples

  1. Computer System Reset

    .local/bin/rf_power_reset.py -u <username> -p <password> -r <redfish host> -s <system id> -t <reset type>

  2. Virtual Media

    • Virtual Media Information

      .local/bin/rf_virtual_media.py -u <username> -p <password> -r <redfish host> info

    • Virtual Media Insert

      Note

      You need to modify redfish_utilities/system.py first to allow specifying the communication protocol as CIFS, in order to meet the API requirements for image mounting and virtual media operations.

      "Image": image, "TransferProtocolType": "CIFS"/'

      .local/bin/rf_virtual_media.py -u <username> -p <password> -r <redfish host> insert -image <img uri>

    • Virtual Media Eject

      .local/bin/rf_virtual_media.py -u <username> -p <password> -r <redfish host> eject -i <device id>

      virtual media

  3. Others

    • Firmware information Firmware information

    • Manager config Manager config

    • Raw request Raw request

    • Sensor list Sensor

Explore and Control ERMI Visually with Redfish Trawler

Redfish Trawler offers a simple, browser-based interface that enables users to visually explore and manage ERMI (Redfish) systems. It provides an integrated dashboard for connecting to and switching among multiple Redfish services — ideal for managing diverse servers and environments from a single web view.

Use Cases:

  • Prefer a graphical user interface (GUI)
  • Need to connect to and switch between multiple Redfish APIs
  • Require only basic system monitoring and control
  • Want the flexibility to extend or enhance functions using the existing framework

Prerequisite

  • Python environment management (e.g., venv, pip)
  • Basic understanding of Redfish API concepts
  • Basic knowledge of front-end tools (npm / Vue.js) — required only if customizing or extending the UI

Environments Settings

  • Windows/Linux
  • Python 3.x
  • npm (for front-end build)
  • Flask, Flask-Session, pyOpenSSL, and redfish modules

Installation:

git clone https://github.com/DMTF/Redfish-Trawler.git
cd Redfish-Trawler
pip install -r requirements.txt

Build and Run

  • Windows：
./build.bat

./run.bat
  • Linux：
./build.sh

./run.sh

After execution, open a browser and go to http://localhost:5000 to start using the interface.

Restart System with Redfish Trawler

Note

If any changes are made, please rebuild and run.

  1. Define the request body in ActionModal.vue:

    • Import functions

      import { ref, onMounted } from 'vue';

    • Define reset manager

      onMounted(() => {
    if (!props.action_info && props.action_uri && props.action_uri.includes('Manager.Reset')) {
        action_parameters.value = { ResetType: 'GracefulRestart' };
    }
});

    • Define reset system

      onMounted(() => {
    if (!props.action_info && props.action_uri && props.action_uri.includes('ComputerSystem.Reset')) {
        action_parameters.value = { ResetType: 'ForceRestart' };
    }
});

  2. modify System.vue

    :action_uri= "'/redfish/v1/Systems/' + resource.Id + '/Actions/ComputerSystem.Reset'"

trawler1

trawler2

References

Get Started with Redfish Tools and Take Control of ERMI

Take full advantage of AVerMedia ERMI’s Redfish compatibility — connect, explore, and manage instantly with Redfish Tacklebox and Redfish Trawler. Whether you prefer powerful command-line control or an intuitive web interface, Redfish Tools make it simple to operate ERMI efficiently and reliably.

Start using Redfish Tools and experience the future of standardized device management. ERMI Series Product Page