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

Changes

Changed in 3 of the 15 revisions of this API.13

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

      response-optional-property-added

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

      response-optional-property-added

    • endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 38 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog