Redfish API Support
The BMC Module of the NVIDIA IGX Orin Developer Kit supports the Redfish APIs in this documentation. DMTF’s Redfish is a standard set of APIs for managing and monitoring a platform.
Use this documentation to perform the following tasks:
To log into your BMC, do the following steps. After you complete these steps you can use the environment variables $bmc and $token in other procedures in this documentation.
Save the IP address of your BMC as an environment variable by running the following code. Replace
<BMC_IP>with your IP address, for example 192.168.1.110.export bmc=<BMC_IP>
Log into your BMC and save your access token as an environment variable by running the following code. Change
<BMC_Password>to your password.export token=`curl -k \ -H "Content-Type: application/json" \ -X POST https://$bmc/login \ -d '{"username": "root", "password": "<BMC_Password>"}' | grep token | awk '{print $2;}' | tr -d '"'`
To get your BMC firmware version, after you log in to your BMC, run the following code.
curl -k \
-H "X-Auth-Token:$token" \
-X GET https://$bmc/redfish/v1/UpdateService/FirmwareInventory/BMC_Firmware
— or —
curl -k \
-H "X-Auth-Token:$token" \
-X GET https://$bmc/redfish/v1/Managers/IGX_BMC_0
To reboot your BMC, after you log in to your BMC, run the following code.
curl -k \
-H "X-Auth-Token:$token" \
-X POST https://$bmc/redfish/v1/Managers/IGX_BMC_0/Actions/Manager.Reset \
-d '{"ResetType": "GracefulRestart"}'
To mount the Base OS iso file over https for BMC installation, after you log in to your BMC, run the following code.
curl -k \
-H "X-Auth-Token:$token" \
-H Content-Type:application/json \
-X POST https://$bmc/redfish/v1/Managers/IGX_BMC_0/VirtualMedia/USB1/Actions/VirtualMedia.InsertMedia \
-d '{"Image":"https://<Ubuntu Desktop IP>/isorepo/<Base OS filename>", \
"WriteProtected":true, \
"UserName":"<https Username>", \
"Password":"<https Password>", \
"Inserted":true, \
"TransferMethod":"Stream", \
"TransferProtocolType":"HTTP"}'
To reset your BMC and Orin settings to the factory default, after you log in to your BMC, run the following code.
curl -k \
-H "X-Auth-Token:$token" \
-X POST https://$bmc/redfish/v1/Managers/IGX_BMC_0/Actions/Manager.ResetToDefaults \
-d '{"ResetToDefaultsType": "ResetAll"}'