ipmi
Manage IPMI interfaces.
GET /ipmi
Parameters
No parameters...
Endpoint
curl -X GET http://mgmt-node:8080/api/ipmi
Response 200
id
integer
optional
-
ip
string
optional
-
mac
string
optional
-
vlan
integer
optional
-
server
object
optional
-
Example response
[
{
"id": 0,
"ip": "string",
"mac": "string",
"vlan": 0,
"server": {
"id": 0,
"hostname": "string",
"state": "booting",
"mac": "string",
"ip": "string",
"image": "string",
"hardware": {
"ram": 0,
"cpu": "string",
"cpus": 0,
"coresPerCpu": 0,
"cpuFreq": 0,
"mainboard": "string",
"mainboardSerial": "string",
"ipmi": {
"ip": "string",
"subnet": "string",
"mac": "string",
"vlan": "string"
}
},
"lastSeen": 0,
"services": {},
"servicesRunning": {},
"osds": 0,
"osdsRunning": 0,
"ips": [
"string"
],
"health": {
"uptime": 0,
"hwDetectTime": 0,
"cephDiskProcs": 0,
"runningImage": "string",
"clockDrift": 0
},
"ipmi": {
"id": 0,
"ip": "string",
"mac": "string",
"vlan": 0
},
"notes": "string"
}
}
]
GET /ipmi/poll-state
Parameters
id
array
query
optional
-
Endpoint
curl -X GET http://mgmt-node:8080/api/ipmi/poll-state?id=0
Response 200
Example response
{}
DELETE /ipmi/{id}
Parameters
id
integer
path
-
Endpoint
curl -X DELETE http://mgmt-node:8080/api/ipmi/{id}
POST /ipmi/add
Parameters
body
object
optional
Request to add an IPMI device that is not managed by croit's DHCP server
Endpoint
curl -X POST http://mgmt-node:8080/api/ipmi/add
Example body
{
"ip": "string",
"access": {
"username": "string",
"password": "string",
"keepAdminPassword": true
}
}
GET /ipmi/config
Parameters
No parameters...
Endpoint
curl -X GET http://mgmt-node:8080/api/ipmi/config
Response 200
password
string
optional
-
Example response
{
"password": "string"
}
PATCH /ipmi/config
Parameters
body
object
optional
-
Endpoint
curl -X PATCH http://mgmt-node:8080/api/ipmi/config
Example body
{
"password": "string"
}
Response 200
result
object
optional
-
name
string
optional
-
id
integer
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
statusCode
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
object
string
optional
-
output
string
optional
-
Example response
{
"result": {},
"name": "string",
"id": 0,
"state": "WAITING",
"statusCode": 0,
"done": true,
"startedAt": 0,
"startedBy": "string",
"object": "string",
"output": "string"
}
POST /ipmi/{id}/initialize
Parameters
id
integer
path
-
body
object
optional
Access details for an IPMI device
Endpoint
curl -X POST http://mgmt-node:8080/api/ipmi/{id}/initialize
Example body
{
"username": "string",
"password": "string",
"keepAdminPassword": true
}
Response 200
result
object
optional
-
name
string
optional
-
id
integer
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
statusCode
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
object
string
optional
-
output
string
optional
-
Example response
{
"result": {},
"name": "string",
"id": 0,
"state": "WAITING",
"statusCode": 0,
"done": true,
"startedAt": 0,
"startedBy": "string",
"object": "string",
"output": "string"
}
POST /ipmi/{id}/power-on
Parameters
id
integer
path
-
Endpoint
curl -X POST http://mgmt-node:8080/api/ipmi/{id}/power-on
POST /ipmi/{id}/power-off
Parameters
id
integer
path
-
Endpoint
curl -X POST http://mgmt-node:8080/api/ipmi/{id}/power-off
POST /ipmi/{id}/power-cycle
Parameters
id
integer
path
-
Endpoint
curl -X POST http://mgmt-node:8080/api/ipmi/{id}/power-cycle
POST /ipmi/{id}/reboot-to-bios
Parameters
id
integer
path
-
Endpoint
curl -X POST http://mgmt-node:8080/api/ipmi/{id}/reboot-to-bios
POST /ipmi/{id}/identify
Parameters
id
integer
path
-
Endpoint
curl -X POST http://mgmt-node:8080/api/ipmi/{id}/identify
POST /ipmi/{id}/ipmi-controller-reset
Parameters
id
integer
path
-
Endpoint
curl -X POST http://mgmt-node:8080/api/ipmi/{id}/ipmi-controller-reset