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:

Log in to your BMC#

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.

  1. 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.

    1export bmc=<BMC_IP>

  2. Log into your BMC and save your access token as an environment variable by running the following code. Change <BMC_Password> to your password.

    1export token=`curl -k \
2                   -H "Content-Type: application/json" \
3                   -X POST https://$bmc/login \
4                   -d '{"username": "root", "password": "<BMC_Password>"}' | grep token | awk '{print $2;}' | tr -d '"'`

Get your BMC firmware version#

To get your BMC firmware version, after you log in to your BMC, run the following code.

1curl -k \
2     -H "X-Auth-Token: $token" \
3     -X GET https://$bmc/redfish/v1/UpdateService/FirmwareInventory/BMC_Firmware

— or —

1curl -k \
2     -H "X-Auth-Token: $token" \
3     -X GET https://$bmc/redfish/v1/Managers/IGX_BMC_0

Reboot your BMC#

To reboot your BMC, after you log in to your BMC, run the following code.

1curl -k \
2     -H "X-Auth-Token: $token" \
3     -X POST https://$bmc/redfish/v1/Managers/IGX_BMC_0/Actions/Manager.Reset \
4     -d '{"ResetType": "GracefulRestart"}'

Mount the Base OS iso file#

To mount the Base OS iso file over https for BMC installation, after you log in to your BMC, run the following code.

 1curl -k \
 2     -H "X-Auth-Token:$token" \
 3     -H Content-Type:application/json \
 4     -X POST https://$bmc/redfish/v1/Managers/IGX_BMC_0/VirtualMedia/USB1/Actions/VirtualMedia.InsertMedia \
 5     -d '{"Image":"https://<Ubuntu Desktop IP>/isorepo/<Base OS filename>", \
 6          "WriteProtected":true, \
 7          "UserName":"<https Username>", \
 8          "Password":"<https Password>", \
 9          "Inserted":true, \
10          "TransferMethod":"Stream", \
11          "TransferProtocolType":"HTTP"}'

Reset your BMC and Orin settings#

To reset your BMC and Orin settings to the factory default, after you log in to your BMC, run the following code.

1curl -k \
2     -H "X-Auth-Token:$token" \
3     -X POST https://$bmc/redfish/v1/Managers/IGX_BMC_0/Actions/Manager.ResetToDefaults \
4     -d '{"ResetToDefaultsType": "ResetAll"}'
On this page