BMC Credential

Create Or Update BMC Credential

Changed on

Create or update a site-wide or per-BMC root credential. Equivalent to nico-admin-cli credential add-bmc.

When kind is SiteWideRoot and Core uses bmc_site_wide_root_source = "local", Core rejects the write with 412; before any managed device uses version 0, supply or correct it through the configured local environment or credential file. After ingestion, leave the local value unchanged and use BMC credential rotation to advance to a backend-managed version. This source policy does not block BMCRoot writes.

User must have authorization role with PROVIDER_ADMIN suffix.

put/v2/org/{org}/nico/credential/bmc

Request

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

Request body

siteIdstring uuid required

ID of the Site where the credential is stored.

kind'SiteWideRoot' | 'BMCRoot' required

Which BMC credential to store.

passwordstring required

Credential password.

usernamestring

Optional username; Core defaults to "root" for BMCRoot when omitted.

macAddressstring

BMC MAC address. Required for kind BMCRoot, ignored for SiteWideRoot.

Response

BMC credential was created or updated

siteIdstring uuid required

ID of the Site where the credential is stored.

kind'SiteWideRoot' | 'BMCRoot' required

Which BMC credential was stored.

usernamestring

Optional username; Core defaults to "root" for BMCRoot when omitted.

macAddressstring

BMC MAC address. Required for kind BMCRoot, ignored for SiteWideRoot.

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

  • 78f3b35615a5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status