---
title: "bmc os power"
method: POST
path: "/v1/bmc/power/os"
tags: ["v1", "bmc"]
---

# bmc os power

`POST /v1/bmc/power/os`

#### 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)

## Query parameters

- `nodeset` string
- `tags` string

## Headers

- `Accept` string

## Request body

- BmcOsPowerBody — BmcOsPowerBody schema
  - `boot_option` string — string of type schemas.BootSourceOverrideTarget. Common options include: None, Pxe, BiosSetup, Utilities, Diags
  - `power_option` string — string of type schemas.ResetType. Common options include: On, ForceOn, ForceOff, ForceRestart, GracefulRestart, GracefulShutdown, PowerCycle

## Response `200`

OK

- JobMessage[]
  - `data` string
  - `host` string
  - `msg` string
  - `redfish_error` object
    - `code` string
    - `error` object
      - `@Message.ExtendedInfo` object[], nullable
        - `Message` string
        - `MessageArgs.@odata.count` integer
        - `MessageId` string
        - `RelatedProperties.@odata.count` integer
        - `Resolution` string
        - `Severity` string
      - `code` string
      - `message` string
  - `status` string

## Other responses

- `default` — Default Error

## Changes

- **2025-10-26** `12410be95557` — 2 info
  - added the optional property `items/data` to the response with the `200` status (media type: application/json)
  - added the optional property `items/data` to the response with the `200` status (media type: application/xml)
- **2025-03-21** `9e09e176e964` — 1 info
  - endpoint added
- **2024-12-03** `29c6a9c3f49b` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/ubccr/apis/grendel-api/changes/v1/bmc/power/os/post.md)

---

[API](https://skmtc.dev/ubccr/apis/grendel-api.md) · [All operations](https://skmtc.dev/ubccr/apis/grendel-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ubccr/grendel-api/revisions/62eb4acab992/schema)