The router or routers you select determine which tabs display.

Note	Listed below are all the possible tabs. You can select to view the Map option from the List view.

Each of the tab views above displays different sets of device properties. For example, the Default view displays basic device properties, and the Cellular-GSM view displays device properties particular to the cellular network.

For information on how to customize router views, see Customizing Device Views.

For information about the device properties that display in each view, see Device Properties.

For information about common actions performed in these views (for example, adding labels and changing device properties), see Common Device Operations.

At the top, upper-right-hand corner of the screen, select the (root or user name) ( Setting User Preferences for User Interface Display) icon to display the menu options. view routers in Map view, select check the Enable map check box in <user>> Preferences, and then click the Map tab (see Map View) in the main pane.

Note	The additional options (not seen in the Setting User Preferences for User Interface Display) are found as selectable options on the User Preferences page (Servers, Show PAN ID in Hexadecimal)

Note	You can view any RPL tree by clicking the device in Map view, and closing the information popup window.

The RPL tree connection displays data traffic flow as blue or orange lines, as follows:

• Orange lines indicate that the link is an uplink: data traffic flows in the up direction on the map.

• Blue lines indicate that the link is a downlink: data traffic flows in the down direction on the map.

You can migrate CGR operating systems from CG-OS to Cisco IOS on the CONFIG > Firmware Update page, using the procedure in the section, “Performing CG-OS to Cisco IOS Migration” section in the Firmware Management chapter of this book.

When you want to upload router device files to be managed by IoT FND, go to CONFIG > DEVICE FILE MANAGEMENT within the application. At that page, select Actions > Upload to get to the Upload File to Routers page. This page provides you the ability to:

• Search for a router device file by its name such as CGR1120/K9+JAF1648BBCK to upload.

• Search by an abbreviated Device file string such as CGR120/K9+JAF or BBCK to display a range of routers available to upload.

The number of router files available to upload (based on your search criteria) displays and all listed routers are selected (checked boxes) by default. You can define the number of routers that display, by using the drop-down menu on that page. Options are 10 (default), 50, 100 and 200. You can remove the check mark next to any router, that you do not want to upload.

After you have finalized the list to upload, click Upload.

IoT Field Network Director allows you to manage the following embedded access point (AP) attributes on C800 (IR819) and IR829 ISRs. The embedded Access Points on the C800 and IR829 routers are identified as AP800 in the FND user interface.

Note	IoT Field Network Director can only manage APs when operating in Autonomous mode.

You can perform and manage the following aspects for AP800s in FND:

• Discovery

• AP configuration

• Periodic inventory collection

• Firmware update of APs when operating in Autonomous Mode

• Event Management over SNMP

Note	Not all C800 Series and IR800 routers have embedded APs. A C800 ISR features matrix is here. The IR829 ISR features matrix is here.

You must define a specific firmware image to use during ZTD.

You can only define a unified image (k9w8 - factory shipped) for update via ZTD

To refine the list of displayed routers, use the built-in router filters under ROUTERS in the Browse Devices pane or saved custom searches in the Quick View pane (right pane). For example, to display all operational routers, click the Up group under ROUTERS in the Browse Devices pane. Click a filter to insert the corresponding search string in the Search Devices field. For example, clicking the Up group under ROUTERS inserts the search string status:up in the Search Devices field.

At the DEVICES > Field Devices page, use the Browse Devices pane to display routers that belong to one of the groups (such as CGR1000) listed under ROUTER.

Use the Browse Devices pane to display the router devices that belong to one of the groups listed under ROUTER TUNNEL

When you open the DEVICES > Field Devices page in Default view, IoT FND lists All FAN Devices such as Routers, Endpoints (meters, gateways), and IoT Gateway and their basic device properties.

When you select an ENDPOINT device or group in the Browse Devices pane, IoT FND provides tabs to display additional endpoint property views:

Note	Listed below are all the possible tabs (left to right as they appear on the screen).

Each one of these views displays a different set of device properties.

For information on how to customize endpoint views, see Customizing Device Views.

For information about the device properties displayed in each view, see Device Properties.

For information about the common actions in these views (for example, adding labels and changing device properties) that also apply to other devices, see Common Device Operations.

You can view available defined configuration groups for mesh endpoints at the CONFIG > Device Configuration page.

You can use the Browse Devices pane to display the mesh endpoint devices that belong to one of the groups listed under ENDPOINTS.

You can generate any of the following predefined system reports within IoT FND to help troubleshoot issues with an endpoint such as GATEWAY-IR500, EXTENDER-IR500, METER-CGMESH, or any third-party METERS. A Troubleshoot page is displayed for each supported endpoint.

To generate a troubleshooting report for endpoints:

1. Choose DEVICES > Field Devices > Browse Devices tab > ENDPOINT .

2. Click the device on the right pane to view the device information.

3. On the Device Info page, click the Troubleshoot tab.

4. Under the Get Report section of the Troubleshoot page, select the report type. The troubleshooting report types available are All TLVs, Connectivity, General, Register, and Routing.

   Note	Based on the report type selected, the check boxes are auto-selected on the Troubleshoot page; indicating that the report displayed is only for the selected parameters.

5. Click Get Report. A report appears on the Report Output page.

   

6. Click the Report icon to export the report in CSV format. The following figure displays a troubleshooting report generated for General report type.

   

The EST service is located between a Certification Authority (CA) and a client. EST uses Hypertext Transfer Protocol (HTTP) to provide an authenticated and authorized channel for Simple Public Key Infrastructure (PKI) Requests and Responses.

EST also operates with the following protocols and authentication methods:

• Constrained Application Protocol (COAP) web transfer protocol for use with constrained nodes and constrained networks such as low-power, lossy networks.

• TLS/SSL Handshake between Registration Authority (RA) and CA.

• Datagram Transport Layer Security (DTLS) protocol is the preferred method for securing CoAP messages when the Nodes do not have any IPv6 (IP) addresses configured. DTLS uses UDP. It is based on Transport Layer Security (TLS).

• Trust Anchor is explicitly configured on the client or server for use during EST TLS authentication.

IC3000 supports edge computing and communicates with IoT FND through the IOx application, Cisco Fog Director which is accessible via IOT FND.

When the IC3000 starts up, it registers with IoT FND. FND then pushes the configuration to the device. Information pushed includes: metric periodic profile interface settings, user management settings and the heartbeat time interval of the device.

Initial communication occurs by establishing a secure HTTPs session. This connection is then upgraded to a WebSocket connection after initial setup.

Using the WebSocket protocol allows the client and server to talk to each other as well as operate independently of each other as shown in the image below. The client does not need to make a request to connect to the server (see left side of network diagram).

Once established, the client and server communicate over the same TCP connection for the lifecycle of the WebSocket connection.

You can perform the following actions for an IC3000 device type on demand:

• Refresh Metrics

• Reboot

Device Category: GATEWAY (in Browse Devices pane). To view the IC3000 Gateway details:

1. Choose DEVICES > Field Devices

2. Select a IC3000 device under GATEWAY in the left-pane. The device info for the gateway appears as shown in the image below. At the Device Info page, you can Refresh Metrics and Reboot the IC3000.

For details on the IC3000 Devices, refer to the Cisco Industrial Compute Gateway Deployment Guide

IoT FND employs Profile-based configuration for IR510s. This allows you to define a specific Profile instance (configuration) that you can assign to multiple IR500 configuration groups. Table 1 lists the supported Profile types.

Note the following about the Profiles:

• Each Profile type has a default profile instance. The default Profile instance cannot be deleted.

• You can create a Profile instance and associate that profile with multiple configuration groups on the IR510.

• A ‘None’ option is available for all the Profile types that indicates that the configuration does not have any settings for that Profile type. 

• When a configuration push is in progress for a configuration group, all the associated Profiles will be locked (lock icon displays) and Profiles cannot be updated or deleted during that time.

• A lock icon displays for a locked Profile.

To create a new profile:

1. Choose CONFIG > DEVICE CONFIGURATION > Config Profiles tab.

2. Click the + (plus icon) at the top of the configuration panel to open the Add Profile entry panel.

3. Enter a Name for the new profile and select the Profile Type from the drop-down menu.

4. Click Add button. A new entry for the Profile entry appears in the left pane under the Profile Type sub-heading.

To delete a profile:

1. Choose CONFIG > DEVICE CONFIGURATION > Config Profiles tab.

2. Select the Profile name (excluding Default-Profile) that you want to delete. Click on the trash icon to remove the Profile.

3. In the pop up window that appears, click Yes to confirm deletion.

To rename a profile:

1. Choose CONFIG > DEVICE CONFIGURATION > Config Profiles tab.

2. Select the Profile name (excluding Default-Profile) that you would to rename. Click on the pencil icon to open the Rename Profile pop up window.

3. Make your edit and click OK. New name appears in the left pane.

To clone a profile:

1. Choose CONFIG > DEVICE CONFIGURATION > Config Profiles tab.

2. Select the Profile name that you want to clone. Click on the overlapping squares icon to open the Clone Profile pop up window.

3. Enter a Name for the new profile (unique from the existing profile name).

4. Click OK button. A new Profile entry appears in the left pane under the same Profile Type sub-heading.

Configuration Notes:

• Set DSCP (QoS) markings for all interfaces - Ethernet, DTE and DCE. Options: Low Priority (0), Normal Priority (10), Medium Priority (18).

• DSCP is applied on interfaces. Default values for DCE and DTE are Low Priority (0). There are no default values for Ethernet. Traffic will flow unmarked if you do not configure any value on the Configuration Template.

• Only one Raw Socket session can flow through DCE and DTE interfaces at a time. The DSCP value will be the same throughout.

• You can view Profile details in the Configuration Group Template page as shown in the image below.

• You can save configuration templates and push the configuration to all devices in the Configuration Group.

• Any of the Profile associations within a Configuration Group are optional. For example, a Configuration Group may not require Serial DCE settings, so you may select ‘None’ for Serial DCE settings.

In the Browse Devices pane, both NMS and Database servers appear under the All Server Devices heading.

In single NMS or Database server deployments, only one server appears under the NMS and/or Database Servers heading. In cluster deployments, multiple NMS servers appear under the NMS Servers heading. To filter the list pane:

• To display all NMS servers, click Devices > Servers in the top-level menu and then select NMS Servers within the Browse Devices pane. In single NMS server deployments, only one server appears under the NMS Servers heading. In cluster deployments, multiple NMS servers appear under the NMS Servers heading.

• To display all Database servers, click Devices > Servers in the top-level menu and then select Database Servers within the Browse Devices pane. In single-server deployments, only one database server appears under Database Servers. If a secondary database is configured, it also appears under the same entry.

Note	By default, only those NMS and Database Servers in an Up state display.

To display details on the Fog Director, click Devices > Services in the top-level menu and then select Application Management Servers. Details include: Host System Information, Host Disk Information and Service Information. Graphs display details on CPU usage and memory usages.

Assets represent non-Cisco equipment that is associated with an FND-managed Cisco device.

You can view Assets associated with specific routers (DEVICES > Field Devices) at the Device Detail pages of CGR1000, IR800, C800, and SBR (Cisco 5921).

You can view a summary of all assets being tracked for all devices at the DEVICES > Assets page.

You can perform the following actions on Assets at the DEVICES > Assets page, using Bulk Operation:

• Add Assets: Use to upload a CSV file of assets to FND. A history of past file uploads displays at the bottom of the page.

  Example of Asset content in CSV file:

  assetName,assetType,deviceEid,assetDescription,vin,
  hvacNumber,housePlate,attachToWO
  asset1,RDU,00173bab01300000,Sample description,value1, value2, value3,no

  Note	Asset Name and Asset Type are the mandatory fields in the CSV file. All other fields are optional.

• Change Asset Property (CSV file): Use to make changes to existing assets.

• Remove Assets (CSV file): Use to remove specific assets.

• Add Files to Assets (zip/tar file): Use to append additional information to Asset content.

Guidelines for Adding or Associating an Asset with a Device:

• One or more assets can be mapped to a particular device.

• A limit of five assets can be associated to a single device, and there is also a limit of five files per asset.

• An asset can be mapped to only one device at any point in time.

• To select all devices listed on a page, check the check box next to Name.

• To select devices across all pages, click Select All.

• To select a group of devices, check the check boxes of individual devices listed on a page and across pages. The count increments with every device selected, and selections on all pages are retained.

IoT FND lets you customize device views. For List views you can:

• Add and delete tabs

• Specify the properties to display in the columns for each view (see Device Properties by Category for available properties)

• Change the order of columns

To change the sorting order of devices, click the arrowhead icon in the column heading to list the entries in an ascending (upward pointing) or descending manner (downward pointing).

You use labels to create logical groups of devices to facilitate locating devices and device management.

IoT FND keeps detailed information about every device in the system. To access detailed information about a device, click its name or EID.

Depending on your deployment, the number of devices managed by IoT FND can be very large (IoT FND supports up to 10 million devices). To facilitate locating and displaying devices in Map View and List view, IoT FND provides filters and lets you add customized filters. Filters are listed in the Browse Devices and Quick View tabs.

In IoT FND, you can perform the bulk import device actions.

IoT FND uses groups to manage devices in bulk. When you add routers to IoT Field Network Director, IoT FND automatically adds them to the appropriate default ROUTER configuration groups, for example, default-cgr1000 or default-c800. When you add MEs (meters and range extenders), IoT FND adds them to the default ENDPOINT configuration group, default-cgmesh.

You can enable GPS traps to trigger an event if the router moves a distance threshold, after a time threshold, or both. For example, you can configure stationary, pole-top CGR monitoring for a distance threshold, to detect movement from theft or pole incident; for mobile routers, set both thresholds to determine distance over time. The recommended distance threshold is 100 feet (30 m).

To enable GPS traps, uncomment these lines in the default configuration template.

<#-- 
Enable the following configurations to generate events that track if the router 
moves by a certain distance (unit configurable) or within a certain time (in minutes) 
-->
<#-- cgna geo-fence interval 10 -->
<#-- cgna geo-fence distance-threshold 100 -->
<#-- cgna geo-fence threshold-unit foot -->
<#-- cgna geo-fence active -->

Note	Because GPS traps only generate Informational logs, we recommend that you create a rule-based event with high severity (such as CRITICAL) to inform the administrator of router movement. An example of this type of rule definition is: configGroup:name eventName:deviceLocChanged (see Creating a Rule)

For Cisco IOS routers you configure SNMP v3 Informational Events to replace the default SNMP v3 traps. For Cisco IOS routers, converting these SNMP v3 traps to SNMP v3 Informational Events sends an acknowledgment to the router for every event received from the router. The router then verifies that the trap was received by IoT FND. To enable SNMP v3 Informational Events, uncomment the following lines in the default configuration file and push the new configuration file to all router(s) in the group:

In CG-OS by default, SNMP v3 traps are configured for any IoT FND event-related changes that generate a trap on the router. IoT FND maps these traps to the corresponding event.

<#-- Enable the following configurations for the nms host to receive informs 
instead of traps -->
<#-- no snmp-server host ${nms.host} traps version 3 priv ${far.adminUsername} -->
<#-- snmp-server engineID remote ${nms.host} ${nms.localEngineID} -->
<#-- snmp-server user ${far.adminUsername} cgnms remote ${nms.host} v3 auth sha 
${far.adminPassword} priv aes 256 ${far.adminPassword} -->
<#-- snmp-server host ${nms.host} informs version 3 
priv ${far.adminUsername} -->

Depending on CGR factory configuration, a GOS may be present in the VM instance. The GOS installs with the Cisco IOS firmware bundle (see Router Firmware Updates. The GOS, Hypervisor, and Cisco IOS all upgrade when you perform a Cisco IOS image bundle installation or update.

After any Cisco IOS install or upgrade, when IoT FND discovers a GOS, it checks if the initial communications setup is complete before it performs the required setup. The CGR must have a DHCP pool and Gigabit Ethernet 0/1 interface configured to provide an IP address and act as the gateway for the Guest OS. See the Cisco 1000 Series Connected Grid Routers Configuration Guides web portal for information on configuring the CGR.

Note: if the router is configured with Guest-OS CLI during the router’s registration with FND, FND detects that Guest-OS is running and will populate a new Guest OS tab on the Device Info page for that particular router. From that page, we could also trigger a Guest-OS restart. Once the Guest-OS is restarted a pop-up with the status of the operation would be seen on the UI and messages would be logged in the server.log file.

You can trigger a Guest-OS restart from the Guest OS tab. Select the Restart GOS button and select Yes to confirm restart. Once the Guest-OS restarts, a pop-up with the status of the operation appears in the UI and messages are logged in the server.log file.

This section includes the following topics:

• Pushing GOS Configurations

You can push the GOS configuration to the CGR using the IoT FND config template. This is the only way to configure the DHCP pool.

• The configuration required for the application hosting are:

  • Enabling IOx

  • Configuring a VirtualPortGroup to a Layer 3 Data Port

• FND and FD Integrated OVA with FD version v1.18.1 and above.

This section describes how to start, stop, and uninstall the application from the APPS menu.

Go to APPS menu and click the application. As the application is just installed and started, the other options are listed. Click … icon to use them.

Two types of EEM scripts are used on the router: an embedded applet, and Tool Command Language (TCL) scripts that execute on the router individually. You can upload and run new EEM TCL scripts on the router without doing a firmware upgrade. EEM files upload to the eem directory in router flash memory. These scripts display in the Import File page File Type column as eem script . You must edit the configuration template file to activate the EEM TCL scripts (see Editing the ROUTER Configuration Template). This feature works with all router OS versions currently supported by IoT FND.

You can also transfer other file types to the router for better file management capability. You must first import the files to IoT FND to upload files to the router. IoT FND processes the file and stores it in the IoT FND database with the following attributes:

• Filename

• Description

• Import Date/Time

• Size

• Sha1 Checksum

• MD5 Checksum

• File Content

When you want to upload router device files to be managed by IoT FND, go to CONFIG > DEVICE FILE MANAGEMENT within the application.

At that page, select Actions > Upload to get to the Upload File to Routers page (Search for a Specific CGR Device File Name and Upload to FND Router Page). This page provides you the ability to search for a specific device by its name such as CGR1120/K9+JAF1648BBCT or you can search by an abbreviated string such as CGR1120/K9+JAF that will display a list of all routers that share that string (Upload Multiple CGR Files Within a Given String Search Range to the FND Router Page).

Additionally, you can enter the File Path to the router in the File Path field on the page.

The searches yield the number of routers available to upload (based on your search criteria) for management by IoT-FND and displays on the Upload File to Routers page.

You can define how many devices display on the screen by selecting a value from the drop-down menu at the far-right of the screen. Options are 10 (default), 50, 100 and 200. You can remove the check mark next to any individual router file that you do not want to upload.

After you finalize the list you want to upload, click Upload File.

On the CONFIG > Device File Management page, click the Managed Files tab to view a list of routers and the files uploaded to their .../managed/files/ directories. Devices listed in the main pane are members of the selected group.

The following information is included in this list:

• EID link (Name) to the Device Info page

• Number of files (#Files) stored on the device

• File Names uploaded

You can use the Filter By File Name drop-down menu to only view devices that contain a particular file. Select All from the menu to include all devices in the group. Click the refresh button to update the list during file transfer or deletion processes.

On the CONFIG > Device File Management page, click the Actions tab to view the status of the last file transfer or last file deleted for routers in the selected group. You can click the Cancel button to terminate any active file operation.

The Actions tab lists the following attributes:

• Start Time and Finish time of the last transfer

• File name

• Status of the process: UNKNOWN, AWAITING_DELETE, DELETE_IN_PROGRESS, DELETE_COMPLETE, CANCELLED, FINISHED, NONE, NOTSTARTED, UPLOAD_IN_PROGRESS, UPLOAD_COMPLETE, STOPPING, STOPPED

• Completed Devices: Displays the following total number of (upload complete/total number of target devices)

• Error/Devices: Number of errors and errored device count

• File Path

• Status: Icon displays: ?, X or check mark

• Name: EID link to Device Info page

• Last Status Time

• Activity: UPLOAD, DELETE, NONE

• File: Name of file

• Status: Text description of status

• Progress: Percentage number

• Message: Describes any issues discovered during the process

• Error: Description of the error type

IoT FND stores two types of device properties in its database:

• Actual device properties—These are the properties defined by the device, such as IP Address, Transmit Speed, and SSID.

• IoT FND device properties—These are properties defined by IoT FND for devices, such Latitude and Longitude properties, which IoT FND uses to display device locations on its GIS map.

Note	The Key column provides the version of the property name in the IoT FND database that you can use in filters. For example, to search for the device with an IP address of 10.33.0.30, enter ip:10.33.0.30 in the Search Devices field.

This section presents IoT FND device properties by category.

Every device in IoT FND presents a list of fields, which are used for device searches. The available fields for a device are defined in the Device Type field. Fields are either configurable or discovered. Configurable fields are set using XML and CSV files; the device EID is the lookup key. Discovered fields are presented from the device. Fields are also accessible in the device configuration templates for routers.