v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB

Expected Switch

Create Expected Switch

Create an Expected Switch to pre-register network switches expected to be discovered at a Site.

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

Alternatively, Tenant Admins with TargetedInstanceCreation capability can also create Expected Switches if they have an account with the Site's Infrastructure Provider.

post/v2/org/{org}/nico/expected-switch

Request body

siteIdstring uuid required

ID of the site the Expected Switch belongs to

bmcMacAddressstring required

MAC address of the Expected Switch's BMC (Baseboard Management Controller)

defaultBmcUsernamestring nullable

Username for accessing the Expected Switch's BMC

defaultBmcPasswordstring nullable

Password for accessing the Expected Switch's BMC

switchSerialNumberstring required

Serial number of the Expected Switch

nvOsUsernamestring nullable

NvOS username for the Expected Switch

nvOsPasswordstring nullable

NvOS password for the Expected Switch

nvosMacAddressesstring[]

MAC addresses of the Expected Switch's NvOS management interfaces

rackIdstring nullable

Optional rack identifier for this component

bmcIpAddressstring nullable

Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

namestring nullable

Display name for this component

manufacturerstring nullable

Manufacturer of this component

modelstring nullable

Model of this component

descriptionstring nullable

Description of this component

slotIdinteger nullable

Slot ID within the rack

trayIdxinteger nullable

Tray index within the rack

hostIdinteger nullable

Host ID within the tray

labelsLabels

Example request

{
  "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "bmcMacAddress": "00:1A:2B:3C:4D:5E",
  "bmcIpAddress": "192.168.1.100",
  "defaultBmcUsername": "admin",
  "defaultBmcPassword": "password123",
  "switchSerialNumber": "SWITCH-12345",
  "nvOsUsername": "nvadmin",
  "nvOsPassword": "nvpassword123",
  "nvosMacAddresses": [
    "00:1A:2B:3C:4D:60",
    "00:1A:2B:3C:4D:61"
  ],
  "rackId": "rack-01",
  "manufacturer": "NVIDIA",
  "labels": {
    "environment": "production",
    "rack": "A1"
  }
}

Response

Created

idstring uuid

Unique identifier for the Expected Switch

siteIdstring uuid