Operating mode claim to network API endpoint

Last updated
Save as PDF

Using the dashboard API to choose operating mode when onboarding

If you do not use detailsByDevice to set the device mode field in your JSON body request, all cloud-native IOS XE devices will be claimed to the network by default in cloud operating (managed) mode.

This will factory reset your device and erase all existing configurations. After the device reloads, the dashboard will apply the new cloud configuration.

All dashboard devices can be claimed to networks, including cloud-native IOS XE, using the dashboard API endpoint Claim Network Devices.

In order to use the claim network devices endpoint to add your cloud-native IOS XE device to your dashboard network, you must include in the JSON body request an array of cloud IDs followed by a detailsByDevice array with the following properties for each device

Note: For cloud-native IOS XE devices cloud ID = serial

serials
- Array of cloud-native IOS XE devices cloud IDs.
addAtomically
- Boolean
  - True: Add all devices or none. If any of the devices listed in the serials array fail to add to network then all devices listed will not be added to the network.
detailsByDevice
- serial
- details
  - name
    - device mode
      - value
        
        managed - use this for cloud operating mode. Using managed will factory reset your device and erase all existing configurations. After the device reloads, the dashboard will apply the new cloud configuration.
        
        monitored - use this for hybrid operating mode.
    - username
      - value
        
        IOS XE username
    - password
      - value
        
        IOS XE password
    - enable password
      - value
        
        IOS XE enable password - this is optional

Example - cloud operating mode

Using managed mode will factory reset your device and erase all existing configurations. After the device reloads, the dashboard will apply the new cloud configuration.

Example - hybrid operating mode

curl -L --request POST \
--url https://api.meraki.com/api/v1/networ.../devices/claim \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"serials": [
"{Cloud ID}",
"{Cloud ID}"
],
"addAtomically": true,
"detailsByDevice", [
{
"serial": "{Cloud ID}",
"details": [
{"name":"device mode","value":"monitored"},
{"name":"username","value":"{username}"},
{"name":"password","value":"{password}"},
{"name":"enable password","value":"{enable_password}"}]
},
{
"serial": "{Cloud ID}",
"details": [
{"name":"device mode","value":"monitored"},
{"name":"username","value":"{username}"},
{"name":"password","value":"{password}"},
{"name":"enable password","value":"{enable_password}"}]
},
],
}'