Expected Switch

Retrieve all Expected Switches

Changed on

Retrieve all Expected Switches.

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

Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Switches if they have an account with the Site's Infrastructure Provider (siteId query parameter is required for Tenants).

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

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
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid

ID of the Site to filter Expected Switches by

includeRelation'Site'

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'BMC_MAC_ADDRESS_ASC' | 'BMC_MAC_ADDRESS_DESC' | 'SWITCH_SERIAL_NUMBER_ASC' | 'SWITCH_SERIAL_NUMBER_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

OK

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

Serial number of the Expected Switch

nvosMacAddressesstring[]

Deprecated flat NVOS MAC list retained for v2 compatibility. Use nvosInterfaces. Responses emit both fields, and this array contains the same MACs in the same order as nvosInterfaces.

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

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.

createdstring date-time

ISO 8601 datetime when the Expected Switch was created

updatedstring date-time

ISO 8601 datetime when the Expected Switch was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    "bmcIpAddress": "192.168.1.100",
    "switchSerialNumber": "SWITCH-12345",
    "nvosInterfaces": [
      {
        "macAddress": "00:1A:2B:3C:4D:60",
        "isPrimary": true
      },
      {
        "macAddress": "00:1A:2B:3C:4D:61",
        "isPrimary": false
      }
    ],
    "nvosMacAddresses": [
      "00:1A:2B:3C:4D:60",
      "00:1A:2B:3C:4D:61"
    ],
    "rackId": "rack-01",
    "manufacturer": "NVIDIA",
    "labels": {
      "environment": "production",
      "rack": "A1"
    },
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Changes

  • 4890ac0cf6acRevision changes
    • info

      added the optional property / to the response with the status

    • info

      response property items/nvosMacAddresses deprecated

  • 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