Domain

Firmware update NVLink Domains

Changed on

Update firmware for one or more NVLink Domains identified by their case-sensitive IDs.

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

patch/v2/org/{org}/nico/domain/nvlink/firmware

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/domain/nvlink/firmware
  • Auth
    HTTP bearer

Request body

siteIdstring uuid required

ID of the Site

domainIdsstring[] required

Nonblank, case-sensitive IDs of the NVLink Domains to update. Exact duplicate IDs are rejected.

versionstring nullable

Target firmware input. NVLink Domain targets resolve to their member racks. For rack-scale RMS components, an omitted, null, empty, or whitespace-only value uses the owning rack profile's configured firmware object. Resolution or fetch failures are reported by the asynchronous task.

ruleIdstring uuid

Optional Operation Rule UUID. When set, pins every task spawned by this operation to the named rule and overrides Flow's default rule resolution.

overrideVersionCheckboolean

When true, request that the selected component backend override firmware version-based checks when deciding whether to apply the update. This permits same-version reapplication and downgrade when supported. It does not bypass readiness checks or state-controller routing.

overrideReadinessCheckboolean

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

Example request

{
  "siteId": "550e8400-e29b-41d4-a716-446655440000",
  "domainIds": [
    "650e8400-e29b-41d4-a716-446655440001",
    "750e8400-e29b-41d4-a716-446655440002"
  ],
  "version": "24.11.0"
}

Response

OK

taskIdsstring[]

List of task IDs created for the firmware update operation

Example response

{
  "taskIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 51b54c5d58d1Revision changes
    • breaking

      the / request property's minLength was increased from 0 to 1

    • breaking

      added the pattern \S to the request property /

    • info

      the / request property format was generalized from uuid to no format