topic Re: API to retrieve the model number of a physicals or maybe virtual CP FW in API / CLI Discussion

API to retrieve the model number of a physicals or maybe virtual CP FW

RamiShahar — Mon, 24 Apr 2023 14:37:17 GMT

Is there an API to retrieve the model number of a physical or maybe virtual CP FW?

CP R80 and above version

Re: API to retrieve the model number of a physicals or maybe virtual CP FW

HeikoAnkenbrand — Mon, 24 Apr 2023 15:01:46 GMT

Use the management API:

Management API Reference

With the following command you can check the hardware and other information:

mgmt_cli get-platform name "gw1"  --format json

Here is a sample output:

{
  "tasks" : [ {
    "task-name" : "get-platform",
    "task-id" : "01234567-89ab-1234-9e1f-0e1e68312345",
    "status" : "succeeded",
    "progress-percentage" : 100,
    "suppressed" : false,
    "task-details" : [ {
      "os-name" : "Gaia",
      "version" : "R81.10",
      "hardware" : "Open Server"
    } ]
  } ]
}

Re: API to retrieve the model number of a physicals or maybe virtual CP FW

RamiShahar — Mon, 24 Apr 2023 17:46:11 GMT

So it is only supported in API V1.9 ? The latest one? Is there another version below to show this info ?

Re: API to retrieve the model number of a physicals or maybe virtual CP FW

PhoneBoy — Mon, 24 Apr 2023 23:11:55 GMT

Yes, that API endpoint was added to R81.20 (API v1.9).
It does not exist in previous versions.

However, you can get the value configured in SmartConsole by checking the output of show-simple-gateway.
Otherwise, you can use run-script to probe the various gateways with CLI commands to determine the model/version.