Sign in

v1

latestOpenAPI 3.1.02026-07-174237122.7 KB
v1
bmc

bmc os power

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

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