# Redfish Use Case Checkers
Copyright 2017-2025 DMTF. All rights reserved.
## About
The Redfish Use Case Checkers performs common management use cases to ensure a Redfish service meets functional expectations.
## Installation
From PyPI:
pip install redfish_use_case_checkers
From GitHub:
git clone https://github.com/DMTF/Redfish-Use-Case-Checkers.git
cd Redfish-Use-Case-Checkers
python setup.py sdist
pip install dist/redfish_use_case_checkers-x.x.x.tar.gz
## Requirements
The Redfish Use Case Checkers requires Python3.
Required external packages:
```
colorama
redfish
redfish_utilities
```
If installing from GitHub, you may install the external packages by running:
pip install -r requirements.txt
## Usage
```
usage: rf_use_case_checkers.py [-h] --user USER --password PASSWORD --rhost
RHOST [--report-dir REPORT_DIR] [--relaxed]
[--test-list [{AccountManagement,PowerControl,BootOverride,ManagerEthernetInterfaces} ...]]
[--debugging]
Validate Redfish services against use cases
options:
-h, --help show this help message and exit
--user USER, -u USER The username for authentication
--password PASSWORD, -p PASSWORD
The password for authentication
--rhost RHOST, -r RHOST
The address of the Redfish service (with scheme)
--report-dir REPORT_DIR
The directory for generated report files (default:
'reports')
--relaxed Allows for some failures to be logged as warnings;
useful if the criteria is to meet the literal 'shall'
statements in the specification.
--test-list [{AccountManagement,PowerControl,BootOverride,ManagerEthernetInterfaces} ...]
Selects specific tests to perform instead of running
the entire test suite.
--debugging Controls the verbosity of the debugging output; if not
specified only INFO and higher are logged.
```
Example:
rf_use_case_checkers -r https://192.168.1.100 -u USERNAME -p PASSWORD
## 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"
Raw data
{
"_id": null,
"home_page": "https://github.com/DMTF/Redfish-Use-Case-Checkers",
"name": "redfish-use-case-checkers",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Redfish",
"author": "DMTF, https://www.dmtf.org/standards/feedback",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/01/2f/a3fb5f534a0831bc27c362787506d91f0e128e708b0cd95f073195880f6c/redfish_use_case_checkers-2.0.4.tar.gz",
"platform": null,
"description": "# Redfish Use Case Checkers\n\nCopyright 2017-2025 DMTF. All rights reserved.\n\n## About\n\nThe Redfish Use Case Checkers performs common management use cases to ensure a Redfish service meets functional expectations.\n\n## Installation\n\nFrom PyPI:\n\n pip install redfish_use_case_checkers\n\nFrom GitHub:\n\n git clone https://github.com/DMTF/Redfish-Use-Case-Checkers.git\n cd Redfish-Use-Case-Checkers\n python setup.py sdist\n pip install dist/redfish_use_case_checkers-x.x.x.tar.gz\n\n## Requirements\n\nThe Redfish Use Case Checkers requires Python3.\n\nRequired external packages:\n\n```\ncolorama\nredfish\nredfish_utilities\n```\n\nIf installing from GitHub, you may install the external packages by running:\n\n pip install -r requirements.txt\n\n## Usage\n\n```\nusage: rf_use_case_checkers.py [-h] --user USER --password PASSWORD --rhost\n RHOST [--report-dir REPORT_DIR] [--relaxed]\n [--test-list [{AccountManagement,PowerControl,BootOverride,ManagerEthernetInterfaces} ...]]\n [--debugging]\n\nValidate Redfish services against use cases\n\noptions:\n -h, --help show this help message and exit\n --user USER, -u USER The username for authentication\n --password PASSWORD, -p PASSWORD\n The password for authentication\n --rhost RHOST, -r RHOST\n The address of the Redfish service (with scheme)\n --report-dir REPORT_DIR\n The directory for generated report files (default:\n 'reports')\n --relaxed Allows for some failures to be logged as warnings;\n useful if the criteria is to meet the literal 'shall'\n statements in the specification.\n --test-list [{AccountManagement,PowerControl,BootOverride,ManagerEthernetInterfaces} ...]\n Selects specific tests to perform instead of running\n the entire test suite.\n --debugging Controls the verbosity of the debugging output; if not\n specified only INFO and higher are logged.\n```\n\nExample:\n\n rf_use_case_checkers -r https://192.168.1.100 -u USERNAME -p PASSWORD\n\n## Release Process\n\n1. Go to the \"Actions\" page\n2. Select the \"Release and Publish\" workflow\n3. Click \"Run workflow\"\n4. Fill out the form\n5. Click \"Run workflow\"\n",
"bugtrack_url": null,
"license": "BSD 3-clause \"New\" or \"Revised License\"",
"summary": "Redfish Use Case Checkers",
"version": "2.0.4",
"project_urls": {
"Homepage": "https://github.com/DMTF/Redfish-Use-Case-Checkers"
},
"split_keywords": [
"redfish"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3d4c2e6ad73df6bf30899f762cd91779c8553fde791221e39e588bacd06eb3d8",
"md5": "f16aff1aeac43f91998f69c3ca0fd479",
"sha256": "0d72f1336484ea4e442a7cec91ee2d6195c946dc3500925b511139bc063610d7"
},
"downloads": -1,
"filename": "redfish_use_case_checkers-2.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f16aff1aeac43f91998f69c3ca0fd479",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 43596,
"upload_time": "2025-07-25T21:09:17",
"upload_time_iso_8601": "2025-07-25T21:09:17.018161Z",
"url": "https://files.pythonhosted.org/packages/3d/4c/2e6ad73df6bf30899f762cd91779c8553fde791221e39e588bacd06eb3d8/redfish_use_case_checkers-2.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "012fa3fb5f534a0831bc27c362787506d91f0e128e708b0cd95f073195880f6c",
"md5": "bf1e222c4748a5fbbb971d8e89be9fdc",
"sha256": "38d9a1b53c9d7085364d5493c3676390f6adce67a82e4876f9579938b5583a2f"
},
"downloads": -1,
"filename": "redfish_use_case_checkers-2.0.4.tar.gz",
"has_sig": false,
"md5_digest": "bf1e222c4748a5fbbb971d8e89be9fdc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 39503,
"upload_time": "2025-07-25T21:09:18",
"upload_time_iso_8601": "2025-07-25T21:09:18.098022Z",
"url": "https://files.pythonhosted.org/packages/01/2f/a3fb5f534a0831bc27c362787506d91f0e128e708b0cd95f073195880f6c/redfish_use_case_checkers-2.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 21:09:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DMTF",
"github_project": "Redfish-Use-Case-Checkers",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "colorama",
"specs": []
},
{
"name": "redfish",
"specs": [
[
">=",
"3.0.0"
]
]
},
{
"name": "redfish_utilities",
"specs": [
[
">=",
"3.4.1"
]
]
}
],
"lcname": "redfish-use-case-checkers"
}
JSON
