ipmi

Manage IPMI interfaces.
get /ipmi

Show all IPMI devices

Parameters
pagination string query
Responses
200 successful operation
IpmiDevice array
IpmiDevice object 
[
  {
    "id": 0,
    "ip": "string",
    "mac": "string",
    "vlan": 0,
    "state": {
      "power": true,
      "fanSpeeds": [
        0
      ],
      "sysTemperature": 0,
      "cpuTemperatures": [
        0
      ]
    },
    "server": {
      "id": 0,
      "ip": "string",
      "ips": [
        "string"
      ],
      "ipmi": {
        "id": 0,
        "ip": "string",
        "mac": "string",
        "vlan": 0
      },
      "macs": [
        "string"
      ],
      "osds": 0,
      "image": "string",
      "notes": "string",
      "state": "booting",
      "daosId": 0,
      "health": {
        "uptime": 0,
        "freeRam": 0,
        "clockDrift": 0,
        "hwDetectTime": 0,
        "runningImage": "string",
        "cephDiskProcs": 0
      },
      "hardware": {
        "cpu": "string",
        "ram": 0,
        "cpus": 0,
        "ipmi": {
          "ip": "string",
          "mac": "string",
          "vlan": "string",
          "subnet": "string"
        },
        "cpuArch": "string",
        "cpuFreq": 0,
        "mainboard": "string",
        "totalCores": 0,
        "cpuArchParsed": "AMD64",
        "mainboardSerial": "string",
        "virtualCoresPerCpu": 0,
        "physicalCoresPerCpu": 0
      },
      "hostname": "string",
      "lastSeen": 0,
      "services": {
        "additionalProp1": 0,
        "additionalProp2": 0,
        "additionalProp3": 0
      },
      "machineId": "string",
      "usedPorts": [
        0
      ],
      "nrHugepages": 0,
      "osdsRunning": 0,
      "hasSambaSssd": true,
      "daemonVersion": 0,
      "servicesRunning": {
        "additionalProp1": 0,
        "additionalProp2": 0,
        "additionalProp3": 0
      }
    },
    "warnings": [
      {
        "id": "string",
        "message": "string"
      }
    ]
  }
]
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
{
  "ip": "string",
  "access": {
    "password": "string",
    "username": "string",
    "keepAdminPassword": true
  }
}
Responses
default successful operation
delete /ipmi/{id}

Remove an IPMI device, it will be re-detected if it still exists

Parameters
id integer path Required
Responses
default successful operation
get /ipmi/config

Get the global IPMI configuration

Responses
200 successful operation
IpmiConfig object 
{
  "password": "string"
}
patch /ipmi/config

Set the global IPMI configuration

Parameters
body object 
{
  "password": "string"
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /ipmi/poll-state

Poll the state of the given IPMI devices.

Parameters
id array query
integer
Responses
200 successful operation
object 
{
  "additionalProp1": {
    "state": {
      "power": true,
      "fanSpeeds": [
        0
      ],
      "sysTemperature": 0,
      "cpuTemperatures": [
        0
      ]
    },
    "warnings": [
      {
        "id": "string",
        "message": "string"
      }
    ]
  },
  "additionalProp2": {
    "state": {
      "power": true,
      "fanSpeeds": [
        0
      ],
      "sysTemperature": 0,
      "cpuTemperatures": [
        0
      ]
    },
    "warnings": [
      {
        "id": "string",
        "message": "string"
      }
    ]
  },
  "additionalProp3": {
    "state": {
      "power": true,
      "fanSpeeds": [
        0
      ],
      "sysTemperature": 0,
      "cpuTemperatures": [
        0
      ]
    },
    "warnings": [
      {
        "id": "string",
        "message": "string"
      }
    ]
  }
}
post /ipmi/{id}/identify

Turns on the identify LED for 5 minutes.

Parameters
id integer path Required
Responses
default successful operation
post /ipmi/{id}/power-on

Boots a server.

Parameters
id integer path Required
Responses
default successful operation
post /ipmi/{id}/power-off

Shutdown a server.

Parameters
id integer path Required
Responses
default successful operation
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
{
  "password": "string",
  "username": "string",
  "keepAdminPassword": true
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
post /ipmi/{id}/power-cycle

Reboots a server.

Parameters
id integer path Required
Responses
default successful operation
post /ipmi/{id}/reboot-to-bios

Reboots a server and opens the BIOS setup menu.

Parameters
id integer path Required
Responses
default successful operation
post /ipmi/{id}/ipmi-controller-reset

Reboots the IPMI management controller itself.

Parameters
id integer path Required
Responses
default successful operation