Allocation6

Audit2

BMC Credential1

Credential Rotation2

Domain6

DPU Extension Service7

DPU Machine2

Expected Machine11

Expected Power Shelf7

Expected Rack8

Expected Rack Group8

Expected Switch7

Host Firmware Config2

InfiniBand Partition6

Infrastructure Provider2

Instance10

Instance Type8

IP Block6

iPXE Template2

Machine25

Measured Boot Trusted Machine3

Measured Boot Trusted Profile3

Metadata1

Network Security Group5

NVLink Logical Partition6

Operating System5

Rack14

Rule5

Service Account1

Site6

Site Explorer2

SKU5

SpectrumX Partition4

SSH Key5

SSH Key Group5

Subnet5

Task3

Task Run8

Tenant4

Tenant Account5

Tenant Identity10

Tray12

UEFI Credential1

User1

VPC9

VPC Peering4

VPC Prefix5

Expected Switch

Update Expected Switch

Changed on Oct 19, 2026

Update an existing Expected Switch by ID.

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

Infrastructure Provider must own the Expected Switch.

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

patch/v2/org/{org}/nico/expected-switch/{expectedSwitchId}

Request

Base URL
https://nico-rest-api.nico.svc.cluster.local
URL
https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/expected-switch/{expectedSwitchId}
Auth
HTTP bearer

Request body

idstring uuid nullable

ID of the Expected Switch to update.

For single updates, omit id or set it to null to use the ID from the URL path. A non-null body id must match the URL ID and use lowercase, hyphenated UUID format. Otherwise, REST returns HTTP 400.

bmcMacAddressstring nullable

Immutable MAC address of the Expected Switch's BMC (Baseboard Management Controller). Omit this field when updating. A formatting-equivalent value is accepted for compatibility and preserves the originally stored spelling, but changing the physical MAC address is rejected with HTTP 400.

defaultBmcUsernamestring nullable

Username for accessing the Expected Switch's BMC (no API length limit; the BMC's username policy still applies). Omission or null preserves the value. A non-empty value can be supplied without defaultBmcPassword.

defaultBmcPasswordstring nullable

Password for accessing the Expected Switch's BMC (up to 255 characters; the BMC's password policy still applies). Omission or null preserves the value. A non-empty value can be supplied without defaultBmcUsername.

switchSerialNumberstring nullable

Serial number of the Expected Switch

nvOsUsernamestring nullable

NvOS username for the Expected Switch. Omission or null preserves the value. A non-empty value can be supplied without nvOsPassword. Provide both fields when setting NVOS credentials for the first time.

nvOsPasswordstring nullable

NvOS password for the Expected Switch. Omission or null preserves the value. A non-empty value can be supplied without nvOsUsername. Provide both fields when setting NVOS credentials for the first time.

nvosMacAddressesstring[]

Deprecated and ignored. Omitted, null, empty, and nonempty values all leave stored ports and primary selection unchanged. Use nvosInterfaces to replace ports. Supplying both fields is allowed; only nvosInterfaces takes effect.

rackIdstring nullable

Optional rack identifier for this component

bmcIpAddressstring nullable

Optional BMC IP address (IPv4 or IPv6). A non-empty address sets the value and pre-allocates a reserved IP for the BMC. An empty string clears the value. Omission or null preserves the current value. It must not be unspecified, multicast, or IPv4 limited broadcast.

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

Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.

Example request

{
  "defaultBmcUsername": "newadmin",
  "defaultBmcPassword": "newpassword123",
  "switchSerialNumber": "SWITCH-54321",
  "nvOsUsername": "newnvadmin",
  "nvOsPassword": "newnvpassword123",
  "nvosInterfaces": [
    {
      "macAddress": "00:1A:2B:3C:4D:62",
      "isPrimary": true
    },
    {
      "macAddress": "00:1A:2B:3C:4D:63",
      "isPrimary": false
    }
  ],
  "rackId": "rack-02",
  "manufacturer": "NVIDIA",
  "labels": {
    "environment": "staging",
    "rack": "B2"
  }
}

Response

idstring uuid

Unique identifier for the Expected Switch

siteIdstring uuid

ID of the site the Expected Switch belongs to

bmcMacAddressstring

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

switchSerialNumberstring