diff --git a/docs/api.md b/docs/api.md index c886c38e..fa050582 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1818,7 +1818,7 @@ $ curl -k https:///api/redfish/v1 **Route**: `/api/redfish/v1/Systems` -**Description**: Returns collection of available computer systems. +**Description**: Returns collection of available computer systems (PiKVM itself and [PiKVM Switch](switch.md) (if presented). **Query parameters**: None. @@ -1843,6 +1843,46 @@ $ curl -k -u admin:admin https:///api/redfish/v1/Systems }⏎ ``` + Another example for two connected [PiKVM Switches](switch.md): + + ```json + { + "@odata.id": "/redfish/v1/Systems", + "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection", + "Members": [ + { + "@odata.id": "/redfish/v1/Systems/0" + }, + { + "@odata.id": "/redfish/v1/Systems/SwitchPort0" + }, + { + "@odata.id": "/redfish/v1/Systems/SwitchPort1" + }, + { + "@odata.id": "/redfish/v1/Systems/SwitchPort2" + }, + { + "@odata.id": "/redfish/v1/Systems/SwitchPort3" + }, + { + "@odata.id": "/redfish/v1/Systems/SwitchPort4" + }, + { + "@odata.id": "/redfish/v1/Systems/SwitchPort5" + }, + { + "@odata.id": "/redfish/v1/Systems/SwitchPort6" + }, + { + "@odata.id": "/redfish/v1/Systems/SwitchPort7" + } + ], + "Members@odata.count": 9, + "Name": "Computer System Collection" + }⏎ + ``` + ### Individual system information **Method**: `GET` @@ -1966,7 +2006,3 @@ $ curl -k -u admin:admin https:///api/export/prometheus/metrics PiKVM has 3 different ways to receive video and audio, depending on the device. This is also [reflected](video.md) in the web interface. - -| Mode | - -### Get raw H.264 video stream diff --git a/docs/ipmi.md b/docs/ipmi.md index 55feff6b..affba5e3 100644 --- a/docs/ipmi.md +++ b/docs/ipmi.md @@ -96,3 +96,5 @@ To access the Redfish API, use HTTP Basic Auth methods. Also you can use the [re [root@pikvm ~]$ redfishtool -S Never -u admin -p admin -r pikvm Systems [root@pikvm ~]$ redfishtool -S Never -u admin -p admin -r pikvm Systems reset ForceOff ``` + +Available Redfish API is described [here](api.md#redfish).