ipmi

Manage IPMI interfaces.

get /ipmi

Shows all IPMI devices

Arguments

  • No arguments...

Definition
get /ipmi
Attributes

  • idinteger

    -

  • ipstring

    -

  • macstring

    -

  • vlaninteger

    -

  • serverobject

    -

    • idinteger

      -

    • hostnamestring

      -

    • statestring

      [booting, running, offline, rebooting]

    • macstring

      -

    • ipstring

      -

    • imagestring

      -

    • hardwareobject

      -

      • ramnumber

        -

      • cpustring

        -

      • cpusinteger

        -

      • coresPerCpuinteger

        -

      • cpuFreqnumber

        -

      • mainboardstring

        -

      • mainboardSerialstring

        -

      • ipmiobject

        -

        • ipstring

          -

        • subnetstring

          -

        • macstring

          -

        • vlanstring

          -

    • lastSeennumber

      Duration in seconds.

    • servicesobject

      Number of services configured on the server by type.

    • servicesRunningobject

      Number of services currently running on the server by type.

    • osdsinteger

      Number of disks currently mounted as OSD.

    • osdsRunninginteger

      Number of OSD daemons currently running.

    • ipsarray

      IPs configured on all NICs, only these are valid for the main IP.

    • healthobject

      -

      • uptimenumber

        Duration in seconds.

      • hwDetectTimenumber

        Duration in seconds.

      • cephDiskProcsinteger

        -

      • runningImagestring

        -

      • clockDriftnumber

        Approximate time difference between this server and the management server, negative values indicate the server is behind.

    • ipmiobject

      -

      • idinteger

        -

      • ipstring

        -

      • macstring

        -

      • vlaninteger

        -

    • notesstring

      User-defined notes for this server

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": , "cpu": "string", "cpus": 0, "coresPerCpu": 0, "cpuFreq": , "mainboard": "string", "mainboardSerial": "string", "ipmi": { "ip": "string", "subnet": "string", "mac": "string", "vlan": "string" } }, "lastSeen": , "services": {}, "servicesRunning": {}, "osds": 0, "osdsRunning": 0, "ips": [ "string" ], "health": { "uptime": , "hwDetectTime": , "cephDiskProcs": 0, "runningImage": "string", "clockDrift": }, "ipmi": { "id": 0, "ip": "string", "mac": "string", "vlan": 0 }, "notes": "string" } } ]

get /ipmi/poll-state

Polls the state of the given IPMI devices.

Arguments

  • idoptionalarray

    -

Definition
get /ipmi/poll-state
Attributes
Example response
{}

delete /ipmi/{id}

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

Arguments

  • idrequiredinteger

    -

Definition
delete /ipmi/{id}

get /ipmi/config

Gets the global IPMI configuration

Arguments

  • No arguments...

Definition
get /ipmi/config
Attributes

  • passwordstring

    -

Example response
{ "password": "string" }

patch /ipmi/config

Sets the global IPMI configuration

Arguments

  • bodyoptional

    -

Definition
patch /ipmi/config
Attributes

  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

post /ipmi/{id}/initialize

Initialize an IPMI device to be used with croit.

Arguments

  • idrequiredinteger

    -

  • bodyoptional

    Optional information for accessing the IPMI device if it uses a non-default password.

Definition
post /ipmi/{id}/initialize
Attributes

  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

post /ipmi/{id}/power-on

Boots a server.

Arguments

  • idrequiredinteger

    -

Definition
post /ipmi/{id}/power-on

post /ipmi/{id}/power-off

Shutdown a server.

Arguments

  • idrequiredinteger

    -

Definition
post /ipmi/{id}/power-off

post /ipmi/{id}/power-cycle

Reboots a server.

Arguments

  • idrequiredinteger

    -

Definition
post /ipmi/{id}/power-cycle

post /ipmi/{id}/reboot-to-bios

Reboots a server and opens the BIOS setup menu.

Arguments

  • idrequiredinteger

    -

Definition
post /ipmi/{id}/reboot-to-bios

post /ipmi/{id}/identify

Turns on the identify LED for 5 minutes.

Arguments

  • idrequiredinteger

    -

Definition
post /ipmi/{id}/identify

post /ipmi/{id}/ipmi-controller-reset

Reboots the IPMI management controller itself.

Arguments

  • idrequiredinteger

    -

Definition
post /ipmi/{id}/ipmi-controller-reset