Stackvora.tech

Claim and Onboard a Meraki Device

Detailed guide on claiming and onboarding Cisco Meraki devices using various methods (order, serial, API), assigning them to networks, and troubleshooting common issues.

Onboarding a new Cisco Meraki device into your organization's network involves several steps, from claiming the hardware to assigning it to a specific network. This process links the physical device to your cloud-managed dashboard, enabling configuration, monitoring, and management. This guide covers the various methods for claiming devices and integrating them into an operational network.

Understanding Meraki Device Identification

Each Meraki hardware device is uniquely identified by its serial number and, optionally, by a claim code associated with a specific order. These identifiers are crucial for associating the physical hardware with your Meraki Dashboard organization.

  • Serial Number: A unique alphanumeric string printed on the device label (e.g., Q2XX-XXXX-XXXX). This is the primary identifier for individual devices.
  • Order Number: A Cisco Sales Order (CSO) number or Meraki order number (e.g., 1234567-MER). Claiming by order number typically adds all devices associated with that order to your inventory simultaneously.
  • Claim Code: Sometimes, large orders or specific distributor fulfillment processes may provide a single claim code that represents multiple devices. This is less common but functions similarly to an order number.

Claiming Devices via the Meraki Dashboard UI

The most common method for onboarding devices is through the Meraki Dashboard's graphical user interface.

1. Accessing the Inventory

Navigate to the Meraki Dashboard (dashboard.meraki.com). Ensure you have appropriate administrative privileges (e.g., Organization Administrator) to claim devices.

From the dashboard, go to Organization > Inventory. This page displays all devices currently claimed by your organization, their types, and their network assignments.

2. Initiating the Claim Process

On the Inventory page, click the Claim button, typically located in the top-right corner.

A dialog box will appear, prompting you for the claim method:

  • Claim by Order number: Enter the Meraki order number (e.g., 70XXXXX). If claiming an entire order, all devices associated with that order will be added to your inventory.
  • Claim by Serial number: Enter individual serial numbers, one per line. This is useful for claiming a few devices or devices from different orders. Ensure correct entry, as a mistyped serial number will result in an error.
  • Claim by Claim code: Less common, but if provided, enter the specific claim code.

After entering the identifiers, click Claim. The dashboard will process the request and add the devices to your organization's inventory. You will receive a confirmation message.

Assigning Claimed Devices to a Network

Once devices are in your organization's inventory, they are not yet operational. They must be assigned to a specific Meraki network.

1. Selecting Devices for Assignment

From Organization > Inventory, locate the newly claimed devices. They will typically show a status of "Not assigned." Select the checkboxes next to the devices you wish to assign.

2. Assigning to an Existing Network

With devices selected, click the Assign button (often near the "Claim" button). A dropdown will appear, allowing you to choose an existing network within your organization. Select the target network and click Assign.

3. Creating a New Network During Assignment (Optional)

If you need to create a new network for these devices, you can do so beforehand under Organization > Network-wide settings > Create new network, or in some contexts, the "Assign" dialog might offer a "Create new network" option. However, it's generally cleaner to create the network first, configure its basic settings, and then assign devices to it.

Claiming Devices via Meraki Dashboard API

For large-scale deployments or automated provisioning, the Meraki Dashboard API offers programmatic control over claiming and onboarding. This requires API access enabled in your organization.

1. API Key Generation

Ensure API access is enabled: Organization > Settings > Dashboard API access. Generate an API key under your profile (click your username in the top-right > My profile > API access > Generate new API key).

2. Using the API to Claim Devices

The API endpoint for claiming devices is POST /organizations/{organizationId}/inventory/claim.

You need your organizationId, which can be found in the Dashboard URL when viewing organization-wide settings (e.g., dashboard.meraki.com/o/123456/manage/organization/overview, where 123456 is the ID).

#!/bin/bash

API_KEY="YOUR_MERAKI_API_KEY"
ORG_ID="YOUR_ORGANIZATION_ID"

# Claim by serial numbers
curl -L -X POST 'https://api.meraki.com/api/v1/organizations/'"$ORG_ID"'/inventory/claim' \
  -H 'X-Cisco-Meraki-API-Key: '$API_KEY \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "serials": [
      "Q2XX-XXXX-XXXX",
      "Q2XY-YYYY-YYYY"
    ]
  }'

# Claim by order number (example)
curl -L -X POST 'https://api.meraki.com/api/v1/organizations/'"$ORG_ID"'/inventory/claim' \
  -H 'X-Cisco-Meraki-API-Key: '$API_KEY \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "order": "70XXXXX"
  }'

# Claim by claim code (example)
# curl -L -X POST 'https://api.meraki.com/api/v1/organizations/'"$ORG_ID"'/inventory/claim' \
#   -H 'X-Cisco-Meraki-API-Key: '$API_KEY \
#   -H 'Content-Type: application/json' \
#   --data-raw '{
#     "claimCode": "ABCDEFGHIJK"
#   }'

The API returns a JSON response indicating success or failure, listing the claimed devices.

3. Using the API to Assign Devices to a Network

After claiming, assign devices using POST /networks/{networkId}/devices/claim.

You'll need the networkId of the target network. This can be found in the Dashboard URL when viewing a network's settings (e.g., dashboard.meraki.com/o/123456/n/N_123456789012345678/manage/dashboard/overview, where N_123456789012345678 is the network ID).

#!/bin/bash

API_KEY="YOUR_MERAKI_API_KEY"
NETWORK_ID="YOUR_NETWORK_ID"

curl -L -X POST 'https://api.meraki.com/api/v1/networks/'"$NETWORK_ID"'/devices/claim' \
  -H 'X-Cisco-Meraki-API-Key: '$API_KEY \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "serials": [
      "Q2XX-XXXX-XXXX",
      "Q2XY-YYYY-YYYY"
    ]
  }'

Post-Claiming and Onboarding Steps

Once a device is claimed and assigned to a network, it will attempt to contact the Meraki cloud and download its configuration.

  1. Physical Connection: Connect the device to power and a working internet connection. For most devices (MR, MS, MX), an Ethernet connection is standard.
  2. Firmware Download: The device will check for and download the latest firmware. This process can take several minutes (5-15 minutes, depending on device type and internet speed).
  3. Configuration Sync: After firmware updates, the device will pull its configuration from the assigned Meraki network.
  4. Monitoring: Verify the device's status in the Meraki Dashboard (e.g., Network > Monitor > Devices). It should show "Online" and report its status.

Common Pitfalls and Troubleshooting

  • "Serial number is already claimed" error: This indicates the device is already associated with another Meraki organization. You must contact Meraki Support to unbind the device, providing proof of ownership (e.g., invoice).
  • "Order number not found" error: Double-check the order number. Ensure it's a valid Meraki order number and not a purchase order from a reseller. If persistent, contact your Meraki reseller or Meraki Support.
  • Device shows "Offline" after assignment:
    • Verify physical connectivity: power, Ethernet cable, upstream internet access.
    • Check firewall rules: Meraki devices require outbound TCP port 7734, TCP port 7351, and UDP ports 7351/7352 open to dashboard.meraki.com and other Meraki cloud IPs (refer to documentation.meraki.com/General_Administration/Other_Topics/Uplink_Connections_and_Firewall_Rules for the current list).
    • Ensure DHCP is working and the device is getting an IP address. Most Meraki devices expect DHCP by default.
    • Allow adequate time for initial firmware download and configuration sync (up to 15-20 minutes for some devices on first boot).
  • Incorrect device type for network: You cannot assign an MX Security Appliance to a Wireless network, for example. The dashboard will prevent this. Ensure your target network type matches the device type.

Back to the knowledge base · Ask the AI assistant