API ReferenceRack

Bring up Racks

View as Markdown

Bring up Racks with optional name filter. If no filter is specified, targets all racks in the Site.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Authentication

AuthorizationBearer
``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired
Name of the Org

Request

This endpoint expects an object.
siteIdstringRequiredformat: "uuid"
ID of the Site
filterobjectOptional

Filter that selects Racks targeted for bring-up

descriptionstringOptional
Optional description for the bring up operation
ruleIdstringOptionalformat: "uuid"

Optional Operation Rule UUID. When set, pins every bring-up task spawned by this batch to the named rule and overrides Flow’s default rule resolution.

overrideReadinessCheckbooleanOptionalDefaults to false

When true, proceed even if one or more target components (or hosts on the owning rack) are reported as not ready by their persisted status. Intended for operator-supervised maintenance.

Response

OK
taskIdslist of strings

List of task IDs created for the bring up operation (one per rack)

Errors

400
Bad Request Error
403
Forbidden Error