Redfish Utilities
Project description
Redfish Tackebox
Copyright 2019 DMTF. All rights reserved.
About
Redfish Tacklebox contains a set of Python 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
pip install redfish_utilities
Building from Source
python setup.py sdist --formats=zip
cd dist
pip install redfish_utilities-x.x.x.zip
Requirements
External modules:
- redfish: https://pypi.python.org/pypi/redfish
You may install the external modules by running:
pip install -r requirements.txt
Utilities
Sensor List
usage: rf_sensor_list [-h] --user USER --password PASSWORD --rhost RHOST
A tool to walk a Redfish service and list sensor info
required arguments:
--user USER, -u USER The user name for authentication
--password PASSWORD, -p PASSWORD
The password for authentication
--rhost RHOST, -r RHOST
The address of the Redfish service (with scheme)
optional arguments:
-h, --help show this help message and exit
Example: rf_sensor_list -u root -p root -r https://192.168.1.100
The tool will log into the service specified by the rhost argument using the credentials provided by the user and password arguments. It then traverses the Chassis Collection for the Service, and reads their respective Power and Thermal Resources. Using the information from those resources, it will build a sensor table and print the information collected.
Update
usage: rf_update [-h] --user USER --password PASSWORD --rhost RHOST --image
IMAGE [--target TARGET]
A tool to perform an update with a Redfish service
required arguments:
--user USER, -u USER The user name for authentication
--password PASSWORD, -p PASSWORD
The password for authentication
--rhost RHOST, -r RHOST
The address of the Redfish service (with scheme)
--image IMAGE, -i IMAGE
The URI or filepath of the image
optional arguments:
-h, --help show this help message and exit
--target TARGET, -t TARGET
The target resource to apply the image
The tool will log into the service specified by the rhost argument using the credentials provided by the user and password arguments. It then builds a request payload to perform a Simple Update action against the Update Service using the image specified by the image argument. The optional target argument is used in the request if attempting to update a particular system, device, manager, or other resource. Once the Simple Update is requested, it monitors the progress of the update, and displays response messages reported by the service about the update once complete.
Release Process
- Update
CHANGELOG.md
with the list of changes since the last release - Update
setup.py
to reflect the new version - Push changes to Github and create a new release
- Push the new tool version to pypi.org
python setup.py sdist
twine upload dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.