ipmi
Manage IPMI interfaces.
get /ipmi
Show all IPMI devices
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
post /ipmi/add
Add an IPMI device that is not managed by croit's DHCP server
Parameters
body object
Request to add an IPMI device that is not managed by croit's DHCP server
Examples
Request Body
{
"ip": "string",
"access": {
"password": "string",
"username": "string",
"keepAdminPassword": true
}
}delete /ipmi/{id}
Remove an IPMI device, it will be re-detected if it still exists
Parameters
id integer path Required
Examples
No request body required
get /ipmi/config
Get the global IPMI configuration
Responses
default response
default response
object
Examples
No request body required
patch /ipmi/config
Set the global IPMI configuration
Parameters
body object
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"password": "string"
}get /ipmi/poll-state
Poll the state of the given IPMI devices.
Parameters
id array query
Array of integer items
Responses
default response
default response
object
Examples
No request body required
post /ipmi/{id}/identify
Turns on the identify LED for 5 minutes.
Parameters
id integer path Required
Examples
No request body required
post /ipmi/{id}/power-on
Boots a server.
Parameters
id integer path Required
Examples
No request body required
post /ipmi/{id}/power-off
Shutdown a server.
Parameters
id integer path Required
Examples
No request body required
post /ipmi/{id}/initialize
Initialize an IPMI device to be used with croit.
Sets boot device to PXE, and turns on power and optionally configures the ADMIN password to the default croit password.
Parameters
id integer path Required
body object
Access details for an IPMI device
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"password": "string",
"username": "string",
"keepAdminPassword": true
}post /ipmi/{id}/power-cycle
Reboots a server.
Parameters
id integer path Required
Examples
No request body required
post /ipmi/{id}/reboot-to-bios
Reboots a server and opens the BIOS setup menu.
Parameters
id integer path Required
Examples
No request body required
post /ipmi/{id}/ipmi-controller-reset
Reboots the IPMI management controller itself.
Parameters
id integer path Required
Examples
No request body required