towk/magellan
1
0
Fork 0
mirror of https://github.com/davidallendj/magellan.git synced 2025-12-20 03:27:03 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added a firmware updating section to README.md

Browse source
This commit is contained in:
David J. Allen 2024-05-13 09:30:17 -06:00
parent 0f74e1e7f7
commit d86532e96a
No known key found for this signature in database
GPG key ID: 717C593FF60A2ACC
1 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -132,6 +132,27 @@ This uses the info stored in cache to request information about each BMC node if
Note: If the `cache` flag is not set, `magellan` will use "/tmp/$USER/magellan.db" by default.
### Updating Firmware
The `magellan` tool is capable of updating firmware with using the `update` subcommand via the Redfish API. This may sometimes necessary if some of the `collect` output is missing or is not including what is expected. The subcommand expects there to be a running HTTP/HTTPS server running that has an accessbile URL path to the firmware download. Specify the URL with the `--firmware-path` flag and the firmware type with the `--component` flag with all the other usual arguments like in the example below:
```bash
./magellan update \
--host 172.16.0.108 \
--port 443 \
--user username \ --pass password \
--firmware-path http://172.16.0.255:8005/firmware/bios/image.RBU \
--component BIOS
```
Then, the update status can be viewed by including the `--status` flag along with the other usual arguments or with the `watch` command:
```bash
./magellan update --status --host 172.16.0.110 --user admin --pass password | jq '.'
# ...or...
watch -n 1 "./magellan update --status --host 172.16.0.110 --user admin --pass password | jq '.'"
```
### Getting an Access Token (WIP)
The `magellan` tool has a `login` subcommand that works with the [`opaal`](https://github.com/OpenCHAMI/opaal) service to obtain a token needed to access the SMD service. If the SMD instance requires authentication, set the `MAGELLAN_ACCESS_TOKEN` environment variable to have `magellan` include it in the header for HTTP requests to SMD.