UBubccr
v1
bmc

bmc os power

Changed on

Controller:

github.com/ubccr/grendel/internal/api.(*Handler).BmcOsPower

Middlewares:

  • github.com/go-fuego/fuego.defaultLogger.middleware
  • github.com/ubccr/grendel/internal/api.(*Handler).authMiddleware

Change power status of node(s)

post/v1/bmc/power/os

Request

Query parameters

nodesetstring

Filter by nodeset. Minimum of one query parameter is required

tagsstring

Filter by tags. Minimum of one query parameter is required

Headers

Acceptstring

Request body

boot_optionstring

string of type schemas.BootSourceOverrideTarget. Common options include: None, Pxe, BiosSetup, Utilities, Diags

power_optionstring

string of type schemas.ResetType. Common options include: On, ForceOn, ForceOff, ForceRestart, GracefulRestart, GracefulShutdown, PowerCycle

Example request

{
  "boot_option": "Pxe",
  "power_option": "PowerCycle"
}

Response

OK

datastring
hoststring
msgstring
statusstring

Changes

  • 12410be95557Revision changes
    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/xml)

  • 9e09e176e964Revision changes
    • info

      endpoint added