[curl] OpenBMC Software

List Software Objects
[curl]

curl -b cjar -k https://${bmc_ip}/xyz/openbmc_project/software/list

For example
[curl in Linux]

$ curl -b cjar -k https://192.168.88.38/xyz/openbmc_project/software/list
{
  "data": [
    "/xyz/openbmc_project/software/baac2cb8",
    "/xyz/openbmc_project/software/baac2cb8/software_version",
    "/xyz/openbmc_project/software/active",
    "/xyz/openbmc_project/software/functional"
  ],
  "message": "200 OK",
  "status": "ok"
}

Enumerate Software Objects
[curl]

curl -b cjar -k https://${bmc_ip}/xyz/openbmc_project/software/enumerate

For example
[curl in Linux]

$ curl -b cjar -k https://192.168.88.38/xyz/openbmc_project/software/enumerate
{
  "data": {
    "/xyz/openbmc_project/software/active": {
      "endpoints": [
        "/xyz/openbmc_project/software/baac2cb8"
      ]
    },
    "/xyz/openbmc_project/software/baac2cb8": {
      "Activation": "xyz.openbmc_project.Software.Activation.Activations.Active",
      "Path": "",
      "Priority": 0,
      "Purpose": "xyz.openbmc_project.Software.Version.VersionPurpose.BMC",
      "RequestedActivation": "xyz.openbmc_project.Software.Activation.RequestedActivations.None",
      "Version": "v2.1-69-gbfca3f8",
      "associations": [
        [
          "inventory",
          "activation",
          ""
        ]
      ]
    },
    "/xyz/openbmc_project/software/baac2cb8/software_version": {
      "endpoints": [
        "/xyz/openbmc_project/software"
      ]
    },
    "/xyz/openbmc_project/software/functional": {
      "endpoints": [
        "/xyz/openbmc_project/software/baac2cb8"
      ]
    }
  },
  "message": "200 OK",
  "status": "ok"
}

Get OpenBMC Software Version
[curl]

curl -b cjar -k https://${bmc_ip}/xyz/openbmc_project/software/<ID>/attr/Version

For example
[curl in Linux]

$ curl -b cjar -k https://192.168.88.38/xyz/openbmc_project/software/baac2cb8/attr/Version
{
  "data": "v2.1-69-gbfca3f8",
  "message": "200 OK",
  "status": "ok"
}

Factory Reset Host and BMC Software
[curl]

curl -c cjar -b cjar -k -H 'Content-Type: application/json' -X POST -d '{"data":[]}' https://${bmc_ip}/xyz/openbmc_project/software/action/Reset

For example
[curl in Linux]

$ curl -c cjar -b cjar -k -H 'Content-Type: application/json' -X POST -d '{"data":[]}' https://192.168.88.38/yz/openbmc_project/software/action/Reset
{
  "data": null,
  "message": "200 OK",
  "status": "ok"
}

Field Mode
[curl]

curl -c cjar -b cjar -k https://${bmc_ip}/xyz/openbmc_project/software/attr/FieldModeEnabled

Enable

curl -c cjar -b cjar -k -H 'Content-Type: application/json' -X PUT -d '{"data": 1}' https://${bmc_ip}/xyz/openbmc_project/software/attr/FieldModeEnabled

Disable

curl -c cjar -b cjar -k -H 'Content-Type: application/json' -X PUT -d '{"data": 0}' https://${bmc_ip}/xyz/openbmc_project/software/attr/FieldModeEnabled

For example
[curl in Linux]

$ curl -c cjar -b cjar -k -H 'Content-Type: application/json' -X PUT -d '{"data": 1}' https://192.168.88.38/xy/openbmc_project/software/attr/FieldModeEnabled
{
  "data": null,
  "message": "200 OK",
  "status": "ok"
}

Delete Images
[curl]
Delete Image from System

curl -c cjar -b cjar -k -H "Content-Type: application/json" -X POST -d '{"data": []}' https://${bmc_ip}/xyz/openbmc_project/software/<image id>/action/Delete

Delete All Non-running Images

curl -c cjar -b cjar -k -H "Content-Type: application/json" -X POST -d '{"data": []}' https://${bmc_ip}/xyz/openbmc_project/software/action/DeleteAll

For example
[curl in Linux]

$ curl -c cjar -b cjar -k -H "Content-Type: application/json" -X POST -d '{"data": []}' https://192.168.88.38/xyz/openbmc_project/software/action/DeleteAll
{
  "data": null,
  "message": "200 OK",
  "status": "ok"
}

Reference
[1] "OpenBMC" https://github.com/openbmc/
[2] "OpenBMC REST cheat sheet" https://github.com/openbmc/docs/blob/master/REST-cheatsheet.md
[3] "Host Management with OpenBMC" https://github.com/openbmc/docs/blob/master/host-management.md
[4] "OpenBMC REST API" https://github.com/openbmc/docs/blob/master/rest-api.md
[5] "Host Code Update" https://github.com/openbmc/docs/blob/master/code-update/host-code-update.md
[6] "OpenBMC UBI Code Update" https://github.com/openbmc/docs/blob/master/code-update/ubi-code-update.md

Last Updated: 23-02-2018