---
title: "[LRO] Advanced Onboard Devices"
method: POST
path: "/devices/:advanced-onboard"
tags: ["Device"]
---

# [LRO] Advanced Onboard Devices

`POST /devices/:advanced-onboard`

Advanced onboard devices for all devices, such as Extreme/Aerohive, EXOS, VOSS, WiNG, Dell, and Digital Twin. Advanced onboard devices will allow the user to set the device hostname, attach the device location, associate network policy, etc. in a single API request.
To avoid API timeout when onboarding a large number of devices, please make sure to enable async mode (set async=true in query parameter) and use long-running operation API to query the result.

## Query parameters

- `async` boolean

## Request body

- XiqAdvancedOnboardDeviceRequest — The payload to advanced onboard devices
  - `extreme` XiqExtremeDevice[] — The selected target devices
    - `serial_number` string, required — The serial number
    - `location` XiqDeviceLocationAssignment, required — Device location assignment
      - `location_id` integer, required — The assigned location ID, it must be FLOOR type
      - `x` number, double — The horizontal value in the floor map
      - `y` number, double — The vertical value in the floor map
      - `latitude` number, double — The latitude in the geography
      - `longitude` number, double — The longitude in the geography
    - `network_policy_id` integer — The assigned network policy
    - `hostname` string — The device hostname
  - `exos` XiqExosDevice[] — The selected target devices
    - `serial_number` string, required — The serial number
    - `location` XiqDeviceLocationAssignment, required — Device location assignment
      - `location_id` integer, required — The assigned location ID, it must be FLOOR type
      - `x` number, double — The horizontal value in the floor map
      - `y` number, double — The vertical value in the floor map
      - `latitude` number, double — The latitude in the geography
      - `longitude` number, double — The longitude in the geography
    - `network_policy_id` integer — The assigned network policy
    - `hostname` string — The device hostname
  - `voss` XiqVossDevice[] — The selected target devices
    - `serial_number` string, required — The serial number
    - `location` XiqDeviceLocationAssignment, required — Device location assignment
      - `location_id` integer, required — The assigned location ID, it must be FLOOR type
      - `x` number, double — The horizontal value in the floor map
      - `y` number, double — The vertical value in the floor map
      - `latitude` number, double — The latitude in the geography
      - `longitude` number, double — The longitude in the geography
    - `network_policy_id` integer — The assigned network policy
    - `hostname` string — The device hostname
  - `wing` XiqWingDevice[] — The selected target devices
    - `serial_number` string, required — The serial number
    - `mac_address` string, required — The mac address
    - `location` XiqDeviceLocationAssignment, required — Device location assignment
      - `location_id` integer, required — The assigned location ID, it must be FLOOR type
      - `x` number, double — The horizontal value in the floor map
      - `y` number, double — The vertical value in the floor map
      - `latitude` number, double — The latitude in the geography
      - `longitude` number, double — The longitude in the geography
    - `network_policy_id` integer — The assigned network policy
    - `hostname` string — The device hostname
  - `dell` XiqDellDevice[] — The selected target devices
    - `serial_number` string, required — The serial number
    - `service_tag` string, required — The service tag
    - `location` XiqDeviceLocationAssignment, required — Device location assignment
      - `location_id` integer, required — The assigned location ID, it must be FLOOR type
      - `x` number, double — The horizontal value in the floor map
      - `y` number, double — The vertical value in the floor map
      - `latitude` number, double — The latitude in the geography
      - `longitude` number, double — The longitude in the geography
    - `network_policy_id` integer — The assigned network policy
    - `hostname` string — The device hostname
  - `dt` XiqDigitalTwinOnboardDevice[] — The selected target devices
    - `digital_twin_device` XiqDigitalTwinDevice, required — The Digital Twin device to onboard.
      - `make` 'SWITCH_ENGINE' | 'FABRIC_ENGINE', required
      - `model` 'DT_5320_16P_4XE' | 'DT_5320_16P_4XE_DC' | 'DT_5320_24P_8XE' | 'DT_5320_24T_8XE' | 'DT_5320_48P_8XE' | 'DT_5320_48T_8XE' | 'DT_5420F_16MW_32P_4XE' | 'DT_5420F_16W_32P_4XE' | 'DT_5420F_24P_4XE' | 'DT_5420F_24S_4XE' | 'DT_5420F_24T_4XE' | 'DT_5420F_48P_4XE' | 'DT_5420F_48P_4XL' | 'DT_5420F_48T_4XE' | 'DT_5420F_8W_16P_4XE' | 'DT_5420M_16MW_32P_4YE' | 'DT_5420M_24T_4YE' | 'DT_5420M_24W_4YE' | 'DT_5420M_48T_4YE' | 'DT_5420M_48W_4YE' | 'DT_5520_12MW_36W' | 'DT_5520_24T' | 'DT_5520_24W' | 'DT_5520_24X' | 'DT_5520_48SE' | 'DT_5520_48T' | 'DT_5520_48W' | 'DT_5520_24T_ACDC' | 'DT_5520_48T_ACDC' | 'DT_5520_24X_ACDC' | 'DT_5520_48SE_ACDC' | 'DT_5720_24MW' | 'DT_5720_24MXW' | 'DT_5720_48MW' | 'DT_5720_48MXW' | 'DT_7520_48YE_8CE' | 'DT_7520_48XT_6C' | 'DT_7520_48Y_8C' | 'DT_7720_32C', required
      - `os_type` string — The Digital Twin device OS type.
      - `os_version` string, required — The Digital Twin device OS version.
      - `vim_modules` XiqDigitalTwinVimModule[] — The Digital Twin VIM modules.
      - `feat_licenses` XiqDigitalTwinFeatLicense[] — The Digital Twin feature licenses.
    - `location` XiqDeviceLocationAssignment, required — Device location assignment
      - `location_id` integer, required — The assigned location ID, it must be FLOOR type
      - `x` number, double — The horizontal value in the floor map
      - `y` number, double — The vertical value in the floor map
      - `latitude` number, double — The latitude in the geography
      - `longitude` number, double — The longitude in the geography
    - `network_policy_id` integer — The assigned network policy
    - `hostname` string — The device hostname
  - `unmanaged` boolean — Whether to unmanage the devices

## Response `200`

OK

- XiqAdvancedOnboardDeviceResponse — The response for advanced onboard devices
  - `success_devices` XiqSuccessOnboardDevice[] — The success devices
    - `serial_number` string, required — The serial number
    - `device_id` integer, required — The device ID
  - `failure_devices` XiqFailureOnboardDevice[] — The failure devices
    - `serial_number` string, required — The serial number
    - `error` 'UNKNOWN' | 'SUCCEED' | 'EXIST_IN_REDIRECT' | 'FAILED_IN_DB' | 'FAILED_STORE_IN_REDIRECT' | 'SN_IS_NOT_RIGHT' | 'PRODUCT_TYPE_NOT_EXIST' | 'REACH_MAX_SIZE' | 'NOT_SUPPORT_DEVICE' | 'SN_EXISTED_IN_HM' | 'DEVICE_EXISTED' | 'NETMASK_IP_NOT_NULL' | 'BRANCH_ID_USED' | 'INVALID_SERVICE_TAG' | 'RADIO_WIFI1_NOT_SUPPORT' | 'RADIO_PROFILE_NOT_EXIST' | 'SDR_PROFILE_NOT_EXIST' | 'ADMIN_STATE_NOT_SUPPORT' | 'WIFI_POWER_NOT_SUPPORT' | 'OPERATION_MODE_NOT_SUPPORT' | 'COUNTRY_CODE_NOT_SUPPORT' | 'WIFI0_CHANNEL_NOT_SUPPORT' | 'WIFI1_CHANNEL_NOT_SUPPORT' | 'COUNTRY_CODE_IS_NEEDED' | 'MAC_ADDR_REQUIRED' | 'WING_AP_INVALID_ONBOARDING_DATA' | 'NOT_DUAL_BOOT_AP' | 'INVALID_CSV_LOCATION' | 'NOT_SUPPORTED_FOR_CONNECT' | 'DEVICE_EXISTED_ANOTHER_ACCOUNT' | 'FAILED_IN_DTIS_SERVICE' | 'FAILED_IN_DTIS_MAX_CONCURRENT_LIMIT_REACHED' | 'FAILED_DTINSTANCE_ALREADY_ASSOCIATED' | 'FAILED_IN_DTIS_MAX_OVERALL_LIMIT_REACHED' | 'FAILED_IN_DTIS_MAX_LICENSE_LIMIT_REACHED' | 'FAILED_DTINSTANCE_RELAUNCHED_RECENTLY' | 'FAILED_COPILOT_DISABLED' | 'FAILED_IN_DTIS_MAX_CONCURRENT_LIMIT_REACHED_BY_BATCH' | 'FAILED_IN_DTIS_MAX_OVERALL_LIMIT_REACHED_BY_BATCH' | 'REACH_MAX_CAP' | 'NETWORK_POLICY_NOT_FOUND' | 'VERSION_NOT_SUPPORTED' | 'VERSION_DEPRECATED'

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/revisions/242a0e1b1b40/schema)