Cisco IoT Operations Dashboard

Prepare existing devices for onboarding

Alert: Cisco has made the end-of-life (EOL) announcement for the Cisco Edge Device Manager (EDM).

Overview

Existing network devices must be prepared for onboarding before they can be added using Internet of Things Operations Dashboard (IoT OD) Edge Device Manager (EDM) service. This includes:

RMA replacement devices
Devices that are being repurposed for IoT OD
Devices purchased without the IoT OD product identification (PID)

Note: If you purchased a new network device using a Cisco IoT OD PID, these instructions are not required. Proceed to the Onboarding Quick Start Guide --IR devices.

To prepare a network device, all configurations must be completely erased from the device, which is then entered in the Cisco Network Plug and Play Solution (PnP) that provisions them for use with Cisco IoT OD. PnP also provides the device with the required security certificates and redirects it to Cisco IoT OD so it can be added to your organization's account.

Summary steps (existing devices)

Existing devices prep summary steps

After the existing network device is prepared, you can add the devices to Cisco IoT OD and complete the network configuration.

Existing device prerequisites

Requirement	Description
Create a Cisco Smart Account	A Cisco Smart Account is required to prepare your network device. See Get a Smart Account
Device serial number	Note the 11 character device serial number of your network device. For example: FTX2000000N. Use the following command to show the PID and serial# for your device: #show license udi
Supported firmware	Make sure the edge device is running a supported software version. See Supported devices and firmware
Network and device requirements	Verify all network and device requirements are met. For example: * Use a supported network device interface for onboarding. * Verify that devices on your network can reach the IoT OD cloud at https://us.ciscoiot.com/ or https://eu.ciscoiot.com/ (must be all lower-case). For more information, see Firewall Rules: Device and network requirements.

Erase the device configuration

IMPORTANT Any existing configurations on an existing device must be removed before you add the device to the network. If any previous configuration exists on the device, provisioning will fail.

Recommended method

Enter the following command on your IR1101 or IR18xx series device. This will erase the configuration and reload the device:

Code Snippet

Copy#pnp service reset

Alternative method

Delete all IOS images in the flash except the current IOS image.
To view the currently running IOS image:

#show version | include image System image file is "flash:ir800-universalk9-mz.SPA.159-3.M2a 2. Remove the startup-configuration using the following commands: #erase nvram:
#reload 3. Remove or rename any files in the flash that have the .cfg extension. 4. Reboot the network device without saving the configuration. Do not save config when asked.

IMPORTANT: After the device reloads, DO NOT type anything on the console until it says PNP_DISCOVERY_DONE.

Note: If using an IR829 gateway, the AP must be in autonomous mode and not unified mode. If AP is in unified mode, convert the AP to autonomous mode.

Create a Cisco Smart Account

A Cisco Smart Account is required to use Cisco PnP. Ask to be added as an administrator if your organization already has an account.

To create a new account:

Go to Cisco Software Central at software.cisco.com.
Click Get a Smart Account and enter your information.
If a new domain identifier is entered, wait for an approval call from the Cisco Smart Account team. If an existing domain identifier is used, the Smart Account is created.

Learn more about Smart Accounts.

Get a Smart Account

Create a Controller Profile

The Controller Profile specifies the Cisco IoT OD host that provisions your devices for use with Cisco IoT OD. The profile is selected when adding a device to Cisco PnP.

The profile also includes an SSL certificate for secure communication.

Go to https://software.cisco.com and log in to an "administrator" account.
Click Plug and Play Connect.
Select your Cisco Smart Account or Virtual Smart Account (top right).
Click the Controller Profiles tab, then click Add Profile.
Next to Controller Type, select PNP SERVER, then click Next.
Enter the following information:
1. Profile Name⁠—A meaningful name, such as MYCISCO.
2. Default Profile⁠—Select Yes if this Smart Account is only used for Cisco IoT OD. This profile will be used any time you order an network device.
  - Host Name ⁠—Enter either eu.ciscoiot.com or us.ciscoiot.com based on the device location (must be all lower-case).
  - SSL Certificate —Copy and paste the certificate chain below. Be sure to copy the certificate in its entirety.
    You can also select the security certificate file if it is stored on your computer.
3. Click Next.
4. Review the profile details and click Submit > Done.
Learn more about Controller Profiles.

Copy and paste this certificate chain to your PnP Controller Profile.

Code Snippet

Copy-----BEGIN CERTIFICATE-----
MIIGEzCCA/ugAwIBAgIQfVtRJrR2uhHbdBYLvFMNpzANBgkqhkiG9w0BAQwFADCB
iDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCk5ldyBKZXJzZXkxFDASBgNVBAcTC0pl
cnNleSBDaXR5MR4wHAYDVQQKExVUaGUgVVNFUlRSVVNUIE5ldHdvcmsxLjAsBgNV
BAMTJVVTRVJUcnVzdCBSU0EgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMTgx
MTAyMDAwMDAwWhcNMzAxMjMxMjM1OTU5WjCBjzELMAkGA1UEBhMCR0IxGzAZBgNV
BAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4GA1UEBxMHU2FsZm9yZDEYMBYGA1UE
ChMPU2VjdGlnbyBMaW1pdGVkMTcwNQYDVQQDEy5TZWN0aWdvIFJTQSBEb21haW4g
VmFsaWRhdGlvbiBTZWN1cmUgU2VydmVyIENBMIIBIjANBgkqhkiG9w0BAQEFAAOC
AQ8AMIIBCgKCAQEA1nMz1tc8INAA0hdFuNY+B6I/x0HuMjDJsGz99J/LEpgPLT+N
TQEMgg8Xf2Iu6bhIefsWg06t1zIlk7cHv7lQP6lMw0Aq6Tn/2YHKHxYyQdqAJrkj
eocgHuP/IJo8lURvh3UGkEC0MpMWCRAIIz7S3YcPb11RFGoKacVPAXJpz9OTTG0E
oKMbgn6xmrntxZ7FN3ifmgg0+1YuWMQJDgZkW7w33PGfKGioVrCSo1yfu4iYCBsk
Haswha6vsC6eep3BwEIc4gLw6uBK0u+QDrTBQBbwb4VCSmT3pDCg/r8uoydajotY
uK3DGReEY+1vVv2Dy2A0xHS+5p3b4eTlygxfFQIDAQABo4IBbjCCAWowHwYDVR0j
BBgwFoAUU3m/WqorSs9UgOHYm8Cd8rIDZsswHQYDVR0OBBYEFI2MXsRUrYrhd+mb
+ZsF4bgBjWHhMA4GA1UdDwEB/wQEAwIBhjASBgNVHRMBAf8ECDAGAQH/AgEAMB0G
A1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAbBgNVHSAEFDASMAYGBFUdIAAw
CAYGZ4EMAQIBMFAGA1UdHwRJMEcwRaBDoEGGP2h0dHA6Ly9jcmwudXNlcnRydXN0
LmNvbS9VU0VSVHJ1c3RSU0FDZXJ0aWZpY2F0aW9uQXV0aG9yaXR5LmNybDB2Bggr
BgEFBQcBAQRqMGgwPwYIKwYBBQUHMAKGM2h0dHA6Ly9jcnQudXNlcnRydXN0LmNv
bS9VU0VSVHJ1c3RSU0FBZGRUcnVzdENBLmNydDAlBggrBgEFBQcwAYYZaHR0cDov
L29jc3AudXNlcnRydXN0LmNvbTANBgkqhkiG9w0BAQwFAAOCAgEAMr9hvQ5Iw0/H
ukdN+Jx4GQHcEx2Ab/zDcLRSmjEzmldS+zGea6TvVKqJjUAXaPgREHzSyrHxVYbH
7rM2kYb2OVG/Rr8PoLq0935JxCo2F57kaDl6r5ROVm+yezu/Coa9zcV3HAO4OLGi
H19+24rcRki2aArPsrW04jTkZ6k4Zgle0rj8nSg6F0AnwnJOKf0hPHzPE/uWLMUx
RP0T7dWbqWlod3zu4f+k+TY4CFM5ooQ0nBnzvg6s1SQ36yOoeNDT5++SR2RiOSLv
xvcRviKFxmZEJCaOEDKNyJOuB56DPi/Z+fVGjmO+wea03KbNIaiGCpXZLoUmGv38
sbZXQm2V0TP2ORQGgkE49Y9Y3IBbpNV9lXj9p5v//cWoaasm56ekBYdbqbe4oyAL
l6lFhd2zi+WJN44pDfwGF/Y4QA5C5BIG+3vzxhFoYt/jmPQT2BVPi7Fp2RBgvGQq
6jG35LWjOhSbJuMLe/0CjraZwTiXWTb2qHSihrZe68Zk6s+go/lunrotEbaGmAhY
LcmsJWTyXnW0OMGuf1pGg+pRyrbxmRE1a6Vqe8YAsOf4vmSyrcjC8azjUeqkk+B5
yOGBQMkKW+ESPMFgKuOXwIlCypTPRpgSabuY0MLTDXJLR27lk8QyKGOHQ+SwMj4K
00u/I5sUKUErmgQfky3xxzlIPK1aEn8=
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIFgTCCBGmgAwIBAgIQOXJEOvkit1HX02wQ3TE1lTANBgkqhkiG9w0BAQwFADB7
MQswCQYDVQQGEwJHQjEbMBkGA1UECAwSR3JlYXRlciBNYW5jaGVzdGVyMRAwDgYD
VQQHDAdTYWxmb3JkMRowGAYDVQQKDBFDb21vZG8gQ0EgTGltaXRlZDEhMB8GA1UE
AwwYQUFBIENlcnRpZmljYXRlIFNlcnZpY2VzMB4XDTE5MDMxMjAwMDAwMFoXDTI4
MTIzMTIzNTk1OVowgYgxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpOZXcgSmVyc2V5
MRQwEgYDVQQHEwtKZXJzZXkgQ2l0eTEeMBwGA1UEChMVVGhlIFVTRVJUUlVTVCBO
ZXR3b3JrMS4wLAYDVQQDEyVVU0VSVHJ1c3QgUlNBIENlcnRpZmljYXRpb24gQXV0
aG9yaXR5MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAgBJlFzYOw9sI
s9CsVw127c0n00ytUINh4qogTQktZAnczomfzD2p7PbPwdzx07HWezcoEStH2jnG
vDoZtF+mvX2do2NCtnbyqTsrkfjib9DsFiCQCT7i6HTJGLSR1GJk23+jBvGIGGqQ
Ijy8/hPwhxR79uQfjtTkUcYRZ0YIUcuGFFQ/vDP+fmyc/xadGL1RjjWmp2bIcmfb
IWax1Jt4A8BQOujM8Ny8nkz+rwWWNR9XWrf/zvk9tyy29lTdyOcSOk2uTIq3XJq0
tyA9yn8iNK5+O2hmAUTnAU5GU5szYPeUvlM3kHND8zLDU+/bqv50TmnHa4xgk97E
xwzf4TKuzJM7UXiVZ4vuPVb+DNBpDxsP8yUmazNt925H+nND5X4OpWaxKXwyhGNV
icQNwZNUMBkTrNN9N6frXTpsNVzbQdcS2qlJC9/YgIoJk2KOtWbPJYjNhLixP6Q5
D9kCnusSTJV882sFqV4Wg8y4Z+LoE53MW4LTTLPtW//e5XOsIzstAL81VXQJSdhJ
WBp/kjbmUZIO8yZ9HE0XvMnsQybQv0FfQKlERPSZ51eHnlAfV1SoPv10Yy+xUGUJ
5lhCLkMaTLTwJUdZ+gQek9QmRkpQgbLevni3/GcV4clXhB4PY9bpYrrWX1Uu6lzG
KAgEJTm4Diup8kyXHAc/DVL17e8vgg8CAwEAAaOB8jCB7zAfBgNVHSMEGDAWgBSg
EQojPpbxB+zirynvgqV/0DCktDAdBgNVHQ4EFgQUU3m/WqorSs9UgOHYm8Cd8rID
ZsswDgYDVR0PAQH/BAQDAgGGMA8GA1UdEwEB/wQFMAMBAf8wEQYDVR0gBAowCDAG
BgRVHSAAMEMGA1UdHwQ8MDowOKA2oDSGMmh0dHA6Ly9jcmwuY29tb2RvY2EuY29t
L0FBQUNlcnRpZmljYXRlU2VydmljZXMuY3JsMDQGCCsGAQUFBwEBBCgwJjAkBggr
BgEFBQcwAYYYaHR0cDovL29jc3AuY29tb2RvY2EuY29tMA0GCSqGSIb3DQEBDAUA
A4IBAQAYh1HcdCE9nIrgJ7cz0C7M7PDmy14R3iJvm3WOnnL+5Nb+qh+cli3vA0p+
rvSNb3I8QzvAP+u431yqqcau8vzY7qN7Q/aGNnwU4M309z/+3ri0ivCRlv79Q2R+
/czSAaF9ffgZGclCKxO/WIu6pKJmBHaIkU4MiRTOok3JMrO66BQavHHxW/BBC5gA
CiIDEOUMsfnNkjcZ7Tvx5Dq2+UUTJnWvu6rvP3t3O9LEApE9GQDTF1w52z97GA1F
zZOFli9d31kWTz9RvdVFGD/tSo7oBmF0Ixa1DVBzJ0RHfxBdiSprhTEUxOipakyA
vGp4z7h/jnZymQyd/teRCBaho1+V
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIEMjCCAxqgAwIBAgIBATANBgkqhkiG9w0BAQUFADB7MQswCQYDVQQGEwJHQjEb
MBkGA1UECAwSR3JlYXRlciBNYW5jaGVzdGVyMRAwDgYDVQQHDAdTYWxmb3JkMRow
GAYDVQQKDBFDb21vZG8gQ0EgTGltaXRlZDEhMB8GA1UEAwwYQUFBIENlcnRpZmlj
YXRlIFNlcnZpY2VzMB4XDTA0MDEwMTAwMDAwMFoXDTI4MTIzMTIzNTk1OVowezEL
MAkGA1UEBhMCR0IxGzAZBgNVBAgMEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4GA1UE
BwwHU2FsZm9yZDEaMBgGA1UECgwRQ29tb2RvIENBIExpbWl0ZWQxITAfBgNVBAMM
GEFBQSBDZXJ0aWZpY2F0ZSBTZXJ2aWNlczCCASIwDQYJKoZIhvcNAQEBBQADggEP
ADCCAQoCggEBAL5AnfRu4ep2hxxNRUSOvkbIgwadwSr+GB+O5AL686tdUIoWMQua
BtDFcCLNSS1UY8y2bmhGC1Pqy0wkwLxyTurxFa70VJoSCsN6sjNg4tqJVfMiWPPe
3M/vg4aijJRPn2jymJBGhCfHdr/jzDUsi14HZGWCwEiwqJH5YZ92IFCokcdmtet4
YgNW8IoaE+oxox6gmf049vYnMlhvB/VruPsUK6+3qszWY19zjNoFmag4qMsXeDZR
rOme9Hg6jc8P2ULimAyrL58OAd7vn5lJ8S3frHRNG5i1R8XlKdH5kBjHYpy+g8cm
ez6KJcfA3Z3mNWgQIJ2P2N7Sw4ScDV7oL8kCAwEAAaOBwDCBvTAdBgNVHQ4EFgQU
oBEKIz6W8Qfs4q8p74Klf9AwpLQwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQF
MAMBAf8wewYDVR0fBHQwcjA4oDagNIYyaHR0cDovL2NybC5jb21vZG9jYS5jb20v
QUFBQ2VydGlmaWNhdGVTZXJ2aWNlcy5jcmwwNqA0oDKGMGh0dHA6Ly9jcmwuY29t
b2RvLm5ldC9BQUFDZXJ0aWZpY2F0ZVNlcnZpY2VzLmNybDANBgkqhkiG9w0BAQUF
AAOCAQEACFb8AvCb6P+k+tZ7xkSAzk/ExfYAWMymtrwUSWgEdujm7l3sAg9g1o1Q
GE8mTgHj5rCl7r+8dFRBv/38ErjHT1r0iWAFf2C3BUrz9vHCv8S5dIa2LX1rzNLz
Rt0vxuBqw8M0Ayx9lt1awg6nCpnBBYurDC/zXDrPbDdVCYfeU0BsWO/8tqtlbgT2
G9w84FoVxp7Z8VlIMCFlA2zs6SFz7JsDoeA3raAVGI/6ugLOpyypEBMs1OUIJqsi
l2D4kF501KKaU73yqWjgom7C12yxow+ev+to51byrvLjKzg6CYG1a4XXvi3tPxq3
smPi9WIsgtRqAEFQ8TmDn5XpNpaYbg==
-----END CERTIFICATE-----

Add your network devices to Plug and Play (PnP) Connect

Supported network devices added to PnP will be provisioned using the connection details in the selected Controller Profile you just created. Once added, you can add the devices to your organization's IoT OD account.

Go to https://software.cisco.com.
Click Plug and Play Connect.
Select your Cisco Smart Account or Virtual Smart Account (top right).
Click the Devices tab, then click Add Devices.
Accept the agreement if prompted.
Under Identify Source, select Enter device info manually and click Next.
Click Identify Device.
Enter the following information:
1. Serial number—The network device that will be added to Cisco IoT OD. For example: FTX2007800N Note: The Serial Number and Base PID are located on the back of the device.
2. Base PID—Enter the PID for your device, such as IR1101-K9 or IR18xx-K9.
3. Controller Profile—Select the profile you just created.
4. Enter an optional description and click Next.
  
  The devices are added to your profile and will appear in the Pending Redirection state.

Background: The PnP process

The following illustration shows what happens when you use PnP to provision a network device so it can be claimed by Cisco IoT OD.

PnP Illustration

Note: Most of these steps occur in the background. Your task is to obtain the network device for the right Smart Account, connect it to the network, and claim it using Cisco IoT OD.

How to use a USB stick to bootstrap an IR1101 or IR1800 network device

If you power up a device and you don't get an IP address and the PnP process does not start, you can still pre-stage the network device using the USB port. Here are some scenarios where pre-staging the network device is necessary:

Cellular interface that requires an APN to be configured
MPLS tags for Gigabit uplinks
dot1x authentication
dot1q encapsulation and VLANs
static IP address in absence of DHCP server

While all those operations can be done on the console, for the Cisco IOS-XE on a Cisco IR1101 or IR18xx series network device, you can preconfigure using just a USB stick. When the network device boots without any configuration, it loads the configuration on the USB stick. This option will not load a full configuration, but enough to get the device internet access and start the PnP discovery process, while the rest of the configuration will be pushed by Cisco IoT Operations Dashboard later.

If there is no startup configuration, Cisco IOS-XE on the Cisco IR1101 will look for a file in the FAT-formatted USB stick called “ciscortr.cfg”. Here is a sample configuration that can be customized for your specific needs. It configures a specific APN, configures a dialer on Cellular 0/1/0, sets the default route, and configures a PnP profile.

Copy this file on a USB stick formatted in FAT. Save this file with name "ciscortr.cfg" on the root directory.

Here is an example you can adjust for your specific needs. For instance, use "m2m.tele2.com" in place of your company's APN cellular provider name. Use the same concept to configure a static IP address, or any other pre-staging before PnP starts.

Code Snippet

Copy! This file should be on a USB stick formatted in FAT
! Save this file with name "ciscortr.cfg" on the root directory

ipv6 unicast-routing
controller cellular 0/1/0
profile id 1 apn m2m.tele2.com

int cellular 0/1/0
ip address negotiated
dialer in-band
dialer idle-timeout 0
dialer-group 1
ipv6 enable
no shut

access-list 1 permit any

dialer-list 1 protocol ip permit
dialer-list 1 protocol ipv6 permit

dialer watch-list 1 ip 5.6.7.8 255.255.255.255
dialer watch-list 1 delay route-check initial 60
dialer watch-list 1 delay connect 1

ip route 0.0.0.0 0.0.0.0 cellular 0/1/0
ipv6 route ::/0 Cellular0/1/0

pnp profile pnp_cco_profile
transport https host devicehelper.cisco.com port 443

do-exec write memory

Insert the stick in any IR1101 or IR18xx series device and boot. If this network device has no configuration, it will boot using this configuration file.