Skip to content

Redfish OOB check + new OOB plugin: RedfishEndpointPlugin#146

Merged
alexandraBara merged 5 commits intodevelopmentfrom
alex_redfish
Mar 10, 2026
Merged

Redfish OOB check + new OOB plugin: RedfishEndpointPlugin#146
alexandraBara merged 5 commits intodevelopmentfrom
alex_redfish

Conversation

@alexandraBara
Copy link
Collaborator

@alexandraBara alexandraBara commented Mar 9, 2026

Sample redfish connection connnection_config.json:

{
  "RedfishConnectionManager": {
    "host": "<https://bmc.example.com>",
    "port": 443,
    "username": "<username>",
    "password": "<pwd>",
    "use_https": true,
    "verify_ssl": false,
    "timeout_seconds": 30
  }
}

Sample plugin_config.json:

{
  "name": "RedfishEndpointPlugin",
  "desc": "Redfish endpoint: collect URIs and optional checks",
  "global_args": {},
  "plugins": {
    "RedfishEndpointPlugin": {
      "collection_args": {
        "uris": [
          "/redfish/v1/",
          "/redfish/v1/Systems/1",
          "/redfish/v1/Chassis/1/Power"
        ]
      },
      "analysis_args": {
        "checks": {
          "/redfish/v1/Systems/1": {
            "PowerState": "On",
            "Status/Health": { "oneOf": ["OK", "Warning"] }
          },
          "/redfish/v1/Chassis/1/Power": {
            "PowerControl/0/PowerConsumedWatts": { "max": 1000 }
          }
        }
      }
    }
  },
  "result_collators": {}
}

How to run:

(venv) alexbara@ausalexbara02:~/node-scraper$ node-scraper --connection connection-config.json   --plugin-config plugin_config_redfish.json 
  2026-03-09 09:39:23 CDT       INFO               nodescraper | Log path: ./scraper_logs_ausalexbara02_2026_03_09-09_39_23_AM
  2026-03-09 09:39:23 CDT       INFO               nodescraper | System Name: ausalexbara02
  2026-03-09 09:39:23 CDT       INFO               nodescraper | System SKU: None
  2026-03-09 09:39:23 CDT       INFO               nodescraper | System Platform: None
  2026-03-09 09:39:23 CDT       INFO               nodescraper | System location: SystemLocation.LOCAL
  2026-03-09 09:39:23 CDT       INFO               nodescraper | --------------------------------------------------
  2026-03-09 09:39:23 CDT       INFO               nodescraper | Running plugin RedfishEndpointPlugin
  2026-03-09 09:39:23 CDT       INFO               nodescraper | Initializing connection: RedfishConnectionManager
  2026-03-09 09:39:23 CDT       INFO               nodescraper | Connecting to Redfish at https://<IP>:403
  2026-03-09 09:39:24 CDT       INFO               nodescraper | Running data collector: RedfishEndpointCollector
  2026-03-09 09:39:25 CDT       INFO               nodescraper | (RedfishEndpointPlugin) Collected 3 Redfish endpoint(s)
  2026-03-09 09:39:25 CDT       INFO               nodescraper | Running data analyzer: RedfishEndpointAnalyzer
  2026-03-09 09:39:25 CDT    WARNING               nodescraper | Redfish endpoint checks failed: 1 failure(s) — /redfish/v1/Chassis/1/Power PowerControl/0/PowerConsumedWatts: value 3223.0 above max 1000
  2026-03-09 09:39:25 CDT      ERROR               nodescraper | (RedfishEndpointPlugin) 1 check(s) failed (1 warnings: Redfish endpoint checks failed: 1 failure(s) — /redfish/v1/Chassis/1/Power PowerControl/0/PowerConsumedWatts: value 3223.0 above max 1000)
  2026-03-09 09:39:25 CDT       INFO               nodescraper | Closing connections
  2026-03-09 09:39:25 CDT       INFO               nodescraper | Running result collators
  2026-03-09 09:39:25 CDT       INFO               nodescraper | Running TableSummary result collator
  2026-03-09 09:39:25 CDT       INFO               nodescraper |

+--------------------------+--------+-----------------------------+
| Connection               | Status | Message                     |
+--------------------------+--------+-----------------------------+
| RedfishConnectionManager | OK     | task completed successfully |
+--------------------------+--------+-----------------------------+

+-----------------------+--------+----------------------------------------------------------------------------------+
| Plugin                | Status | Message                                                                          |
+-----------------------+--------+----------------------------------------------------------------------------------+
| RedfishEndpointPlugin | ERROR  | Analysis error: 1 check(s) failed (1 warnings: Redfish endpoint checks failed: 1 |
|                       |        | failure(s) — /redfish/v1/Chassis/1/Power PowerControl/0/PowerConsumedWatts:      |
|                       |        | value 3223.0 above max 1000)                                                     |
+-----------------------+--------+----------------------------------------------------------------------------------+

  2026-03-09 09:39:25 CDT       INFO               nodescraper | Data written to csv file: ./scraper_logs_ausalexbara02_2026_03_09-09_39_23_AM/nodescraper.csv

Copy link
Collaborator

@graepaul graepaul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add documentation to the endpoint_analyzer.py for valid options.

@alexandraBara alexandraBara requested a review from graepaul March 10, 2026 13:42
@alexandraBara alexandraBara merged commit 27eb13a into development Mar 10, 2026
6 checks passed
@alexandraBara alexandraBara deleted the alex_redfish branch March 10, 2026 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants