Organization

This guide includes the following sections:

Conventions

This document uses the following conventions.

Note: Means reader take note. Notes contain helpful suggestions or references to material not covered in the manual.

Caution: Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data.

Warning: IMPORTANT SAFETY INSTRUCTIONS

Means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents. Use the statement number provided at the end of each warning to locate its translation in the translated safety warnings that accompanied this device.

SAVE THESE INSTRUCTIONS

New Features

New Features in IoT FND 4.0 lists new features that are in IoT FND 4.0.x.

IoT FND 4.0 Software Subscriptions

 

 

IoT FND Licenses

Summary of IoT FND Licenses provides a summary of licenses supported on IoT FND, Release 4.0.x. Contact your Cisco partner to obtain the necessary licenses.

About Cisco IoT FND

The IoT Field Network Director (IoT FND) is a software platform to manage a multi-service network and security infrastructure for IoT applications such as smart grid applications, including advanced metering infrastructure (AMI). IoT FND is a scalable, highly secure, modular, and open-platform with an extensible architecture. IoT FND is a multi-vendor, multi-service, communications network management platform that enables network connectivity to an open ecosystem of power grid devices.

Through the browser-based interface, utility operators manage and monitor devices in a Cisco Connected Grid Field Area Network (FAN) solution, using IPv6 over Low-power Wireless Personal Area Networks (6LoWPANs). The FAN includes the following devices:

■Cisco 1000 Series Connected Grid Routers (CGRs), also called pole-top or DIN-rail-mount routers. These devices are identified by model (for example, CGR1000, CGR1120, or CGR1240) on the Field Devices page.

■Cisco 800 Series Industrial Integrated Services Routers (IR800s) are ruggedized small-form factor cellular routers for mobile/vehicle applications. IR829 includes WiFi providing connectivity in non-carpeted IT spaces, industrials, utilities, transportation, infrastructure, industrial M2M application, asset monitoring, Smart Grid, and utility applications. These devices are referred to as FARs in this document and identified by product ID (for example, IR800) on the Field Devices page. You can use IoT FND to manage the following IR800 models: IR809 and IR829.

■Cisco 800 Series Integrated Services Routers (C800s) are used in most networks as edge routers or gateways to provide WAN connectivity (cellular, satellite over Ethernet, and WiFi) to an end device (energy-distribution automation devices, other verticals such as ATMs, and mobile deployments). These devices are referred to as FARs in this document and identified by product ID (for example, C800 or C819) on the Field Devices page.

You can use IoT FND to manage the following hardened Cisco 819H devices:

–C819HG-4G-V-K9

–C819HG-4G-A-K9

–C819HG-U-K9

–C819HGW-S-A-K9

–C819H-K9

–C819G-B-K9

–C819G-U-K9

–C819G-4G-V-K9

–C819G+7-K9

■Cisco 500 Series Wireless Personal Area Network (WPAN) Industrial Routers (IR500) supply RF mesh connectivity to IPv4 and serial Internet of Things (IoT) devices (for example, recloser control, cap bank control, voltage regulator controls, and other remote terminal units).

Note: CGRs, C800, IR800s, IR500s and other types of mesh endpoint devices can coexist on a network, but cannot be in the same device group (see Creating Device Groups and Working with Mesh Endpoint Firmware Images) or firmware management group. Refer to the following sections in the IoT Field Network Director User Guide for more information: “Creating Device Groups”, “Working with Mesh Endpoint Firmware Images” and “Configuring Firmware Group Settings”.

■Cisco Interface Module for LoRaWAN is an extension module for the industrial routers, Cisco IR809 and IR829, and serves as a carrier-grade gateway for outdoor deployments. The module provides unlicensed low-power wide area (LPWA) wireless connectivity for a range of Internet of Things (IoT) use cases such as asset tracking, water and gas metering, street lighting, smart parking/building/agriculture, and environment monitoring. There are two models supported, which are differentiated by their band support (863-870 MHz ISM or 902-928 MHz ISM). The module is identified by product ID (for example, IXM-LORA-800-H-V2).

■Cisco 800 Series Access Points are integrated access points on the Cisco 800 Series Integrated Services Routers (C800). These access points are referred to as FARs in this document and identified by product ID (for example, AP800).

Note: Both the C819 and IR829 have embedded APs and we support management of those two APs.

■Cisco ASR 1000 Series Aggregation Services Routers (ASRs) and Cisco ISR 3900 Series Integrated Service Routers (ISRs), referred to as head-end routers or HERs in this document.

■Cisco IPv6 RF mesh endpoints (smart meters and range extenders).

Note: CGRs, C800, IR800s, IR500s and other types of mesh endpoint devices can coexist on a network, but cannot be in the same device group or firmware management group.

The software features enterprise-class fault, configuration, accounting, performance, and security (FCAPS) functionality, as defined in the OSI Network Management reference model.

Cisco IoT Features and Capabilities

■ Configuration Management – Cisco IoT FND facilitates configuration of large numbers of Cisco CGRs, Cisco C800s, Cisco ASRs, and endpoints. Use Cisco IoT FND to bulk-configure devices by placing them into configuration groups, editing settings in a configuration template, and then pushing the configuration to all devices in the group.

■ Device and Event Monitoring – Cisco IoT FND displays easy-to-read tabular views of extensive information generated by devices, allowing you to monitor your network for errors. Cisco IoT FND provides integrated Geographic Information System (GIS) map-based visualization of FAN devices such as routers and smart meters. Use IoT FND to create CGR-specific work orders that include the required certificates to access the router.

■ Firmware Management – Cisco IoT FND serves as a repository for Cisco CGR, Cisco C800s, Cisco IR800 (which has a different group for firmware management) and endpoint firmware images. Use Cisco IoT FND to upgrade the firmware running on groups of devices by loading the firmware image file onto the Cisco IoT FND server, and then uploading the image to the devices in the group. Once uploaded, use IoT FND to install the firmware image directly on the devices.

■ Zero Touch Deployment – This ease-of-use feature automatically registers (enrolls) and distributes X.509 certificates and provisioning information over secure connections within a connected grid network.

■ Tunnel Provisioning – Protects data exchanged between Cisco ASRs and Cisco CGRs and C800s, and prevents unauthorized access to Cisco CGRs to provide secure communication between devices. Cisco IoT FND can execute CLI commands to provision secure tunnels between Cisco CGRs, Cisco C800s, Cisco IR800s and Cisco ASRs. Use Cisco IoT FND to bulk-configure tunnel provisioning using groups.

■ IPv6 RPL Tree Polling – The IPv6 Routing Protocol for Low-power and Lossy Networks (RPL) finds neighbors and establishes routes using ICMPv6 message exchanges. RPL manages routes based on the relative position of the endpoint to the CGR that is the root of the routing tree. RPL tree polling is available through the mesh nodes and CGR periodic updates. The RPL tree represents the mesh topology, which is useful for troubleshooting. For example, the hop count information received from the RPL tree can determine the use of unicast or multicast for the firmware download process. IoT FND maintains a periodically updated snapshot of the RPL tree.

■ Dynamic Multipoint VPN and Flex VPN – For Cisco C800 devices and Cisco IR800 devices, DMVPN and Flex VPN do not require IoT FND to apply device-specific tunnel configuration to the HER during tunnel provisioning. HER tunnel provisioning is only required for site-to-site VPN tunnels.

■ Dual PHY Support – IoT FND can communicate with devices that support Dual PHY (RF and PLC) traffic. IoT FND identifies CGRs running Dual PHY, enables configuration to masters and slaves, and collects metrics from masters. IoT FND also manages security keys for Dual PHY CGRs. On the mesh side, IoT FND identifies Dual PHY nodes using unique hardware IDs, enables configuration pushes and firmware updates, and collects metrics, including RF and PLC traffic ratios.

■ Guest OS (GOS) Support – For Cisco IOS CGR 1000 devices that support Guest OS, IoT FND allows approved users to manage applications running on the supported operating systems. IoT FND supports all phases of application deployment, and displays application status and the Hypervisor version running on the device.

■ Device Location Tracking – For CGR 1000, C800, and IR800 devices, IoT FND displays real-time location and device location history.

■ Software Security Module (SSM) – This is a low-cost alternative to the Hardware Security Module (HSM), and is used for signing CSMP messages sent to meters and IR500 devices.

■ Diagnostics and Troubleshooting – The IoT FND rule engine infrastructure provides effective monitoring of triage-based troubleshooting. Device troubleshooting runs on-demand device path trace and ping on any CGR, Cisco C800, Cisco IR800, range extender, or meter (mesh endpoints).

■ High Availability – To ensure uninterrupted network management and monitoring, you can deploy the Cisco IoT FND solution in a High Availability (HA) configuration. By using clusters of load-balanced IoT FND servers and primary and standby IoT FND databases, Cisco IoT FND constantly monitors the health of the system, including connectivity within clusters and server resource usage. If a server cluster member or database becomes unavailable or a tunnel fails, another takes its place seamlessly. Additionally, you can add reliability to your IoT FND solution by configuring redundant tunnels between a Cisco CGR and multiple Cisco ASRs.

■ Power Outage Notifications – Connected Grid Endpoints (CGEs) implement a power outage notification service to support timely and efficient reporting of power outages. In the event of a power outage, CGEs perform the necessary functions to conserve energy and notify neighboring nodes of the outage. FARs relay the power outage notification to IoT FND, which then issues push notifications to customers to relate information on the outage.

■ Mesh Upgrade Support – Allows over-the-air software and firmware upgrades to field devices such as Cisco CGRs and CGEs (for example, AMI meter endpoints).

■ Audit Logging – Logs access information for user activity for audit, regulatory compliance, and Security Event and Incident Management (SEIM) integration. This simplifies management and enhances compliance by integrated monitoring, reporting, and troubleshooting capabilities.

■ North Bound APIs – Eases integration of existing utility applications such as outage management system (OMS), meter data management (MDM), trouble-ticketing systems, and manager-of-managers.

■ Work Orders for Device Manager – Credentialed field technicians can remotely access and update work orders.

■ Role-Based Access Controls – Integrates with enterprise security policies and role-based access control for AMI network devices.

■ Event and Issue Management – Fault event collection, filtering, and correlation for communication network monitoring. IoT FND supports a variety of fault-event mechanisms for threshold-based rule processing, custom alarm generation, and alarm event processing. Faults display on a color-coded GIS-map view for various endpoints in the utility network. This allows operator-level custom, fault-event generation, processing, and forwarding to various utility applications such as an outage management system. Automatic issue tracking is based on the events collected.

System Requirements

Minimum Hardware and Software Requirements for Cisco IoT FND and Supporting Systems lists the hardware and software versions associated with this release.

Note: For a large scale system, refer to Oracle DB Server Hardware Requirements Example Profiles and Application Server Hardware Requirements Example Profile for Routers and Endpoints for scale requirements.

.

Note: If deploying a IoT FND server cluster, all nodes in the cluster should run on similar hardware. Additionally, all nodes must run the same version of IoT FND.

Installation Notes

The installation procedure for IoT FND comprises several tasks, as described in the Cisco IoT Field Network Director User Guide, Release 4.0.x . Contact your Cisco partner to obtain a copy of this guide.

You can also find details on upgrading from Oracle 11g to Oracle 12c for existing installations; and, instructions for installing Oracle 12c in new installations within the User Guide.

Important Notes

In Limitations and Restrictions and Caveats, caveats that reference CG-NMS are also relevant to IoT FND. In cases where the caveat was first posted to CG-NMS, we left the CG-NMS reference.

OpenSSH Version

Since IoT FND is supported on a variety of Red Hat Enterprise Linux (RHEL) 5 Update releases, the OpenSSH version that comes with a given release might be an older version with known security holes. Consequently, we recommend ensuring that OpenSSH on the RHEL IoT FND server is up to date. On initial installation, upgrade the OpenSSH package in the IoT FND server to the latest version (6.4 or later).

Limitations and Restrictions

Cisco recommends that you review this section before you begin working with IoT FND. These are known limitations that will not be fixed, and there is not always a workaround for these issues. Some features might not work as documented, and some features might be affected by recent changes to the software.

CSCtx50284

Symptom: CG-NMS failed to shut down cleanly. The Cisco CG-NMS server.log file included exceptions.

Conditions: Occurred when the Cisco CG-NMS server was shut down or restarted using the Red Hat service commands service cgms stop or service cgms restart and Cisco CG-NMS internal server components shut down in an incorrect sequence.

Exceptions might have also appeared in the server.log file if any Cisco CG-NMS logging category is set to “Debug” level, as at this level, exceptions that represent normal internal activity might have been logged.

If the Cisco CG-NMS server was not commanded to shut down using the service commands, then check the cgms_watchdog.log to see if watchdog restarted Cisco CG-NMS. If watchdog restarted Cisco CG-NMS, then there was a notation in cgms_watchdog.log providing the reason watchdog was triggered.

If the shutdown cannot be explained, then the exceptions might have indicated why the server shut down, and should be reviewed by the Cisco Technical Assistance Center (TAC).

Workaround: There is no workaround for this issue.

■ CSCty78770

Symptom: If two or more devices have the same GPS coordinate (which is likely if two Cisco CGRs are on the same pole), the icon in the map shows the devices as a cluster even at maximum zoom in.

Conditions: This issue occurs when two devices of the same type have the same GPS location.

Workaround: There is no workaround for this issue.

■ CSCtz29999

Symptom: On the Devices List page under “WiMAX Link Info”, the Base Station Identifier (BSID) field is not populated.

Conditions: The issue only occurs for WiMAX links.

Workaround: There is no workaround for this issue.

■ CSCub90976

Symptom: When configuring high availability (HA) on the secondary database at initial setup, the entire output of the database content copy is unexpectedly seen in the log output. Logging is inconsistent with logs when a new database is set up.

Conditions: The issue occurs when configuring or setting up a secondary CG-NMS database.

Workaround: There is no workaround for this issue.

■ CSCuc17916

Symptom: When reprovisioning or creating workorders for the Cisco CGR, a Cisco CGR SSID entry greater than 31 characters in the CSV import file does not throw an error during import, but creates other issues.

Conditions: The issue occurs when an SSID entry with more than 31 characters is found.

Workaround: Limit the number of characters to less than or equal to 31.

■ CSCui54154

Symptom: On the Device > Routers or Devices > Field Devices page in List view with routers selected, on the Config tab the Config Error Details column may contain a hyperlink to the error description. If the Config tab is exported using the Export CSV option, the Config Error Details column is not included in the exported CSV file.

Conditions: This issue occurs when trying to export the Config tab with routers selected.

Workaround: There is no workaround for this issue.

■ CSCui54221

Symptom: On the Device > Routers or Devices > Field Devices page in List view with routers selected, on the Firmware tab the Firmware Error Details column may contain a hyperlink to the error description. If the Firmware tab is exported using the Export CSV option, Firmware Error Details column is not included in the exported CSV file.

Conditions: This issue occurs when trying to export the Firmware tab with routers selected.

Workaround: There is no workaround for this issue.

■ CSCuj70073

Symptom: Deleting a large number of elements from CG-NMS takes a long time.

Conditions: This issue occurs when you delete a large number of elements from CG-NMS and devices with issues are included in the operation. CG-NMS must lock all devices. Devices with issue rows in the NMS database increase the time of the delete operation.

Workaround: There is no workaround for this issue.

■ CSCul02893

Symptom: The Confirm dialog box does not display to start an SD Card Password push.

Conditions: This issue occurs during an SD card password enable or disable operation.

Workaround: There is no workaround for this issue.

■ CSCul05847

Symptom: On the Config > Device Configuration > Push Configuration page during a push SD card password operation, the start and end times displayed are the same.

Conditions: This issue occurs during an SD card password enable or disable operation.

Workaround: There is no workaround for this issue.

■ CSCuo96482

Symptom: A CGR module hot swap causes a CG-NMS metric retrieval failure, and an error displays in CG-NMS during show interfaces command processing.

Conditions: This issue occurs during CGR reprovisioning where a module in the CGR was just swapped.

Workaround: There is no workaround for this issue. Avoid removing modules during CGR provisioning.

■ CSCuo96336

Symptom: A success message displays on metrics refresh although WSMA was timed out. No WSMA error displays.

Conditions: This issue occurs when you click Refresh Metrics and CG-NMS successfully refreshes, but WSMA was timed out.

Workaround: There is no workaround for this issue.

■ CSCur38441

Symptom: On the Field Devices page, in Map view with the Overlay option and a group selected, clicking a cluster icon displays the device count either as zero or an incorrect number.

Conditions: This issue occurs with the overlay feature enabled and set to All or Associated Endpoints/Routers, and the zoom level set so that a single marker denotes a group of devices.

Workaround: To display an accurate device count, zoom in until the icons no longer appear clustered and display as individual icons on the map.

■ CSCur44911

Symptom: During the ZTD process, illegal state exceptions display in the server logs indicating tunnel interface change traps occurred.

Conditions: This issue occurs when you add a new interface on the router that CG-NMS did not detect. Exceptions display in the server log when CG-NMS receives traps from that interface.

Workaround: There is no workaround for this issue. Exceptions are not logged after CG-NMS detects the interface either during periodic inventory polling or user-triggered refresh metrics.

■CSCuv32208

Symptom: IoT FND GUI shows the database (DB) server in “down” state when checked under “Servers” section. All FND operations work correctly and no side effects are observed as a consequence of this apparent “down” state of the DB server. The database is marked “up” on the IoT FND application server restart but is soon marked “down” after 15 minutes of startup.

Conditions: This is caused under certain circumstances when periodic jobs responsible for updating the DB server status are stuck in the ACQUIRED state and never recover. This prevents the IoT FND application from updating the status of the DB server.

Workaround: The following workaround requires access to the DB server.

1. Stop the IoT FND application server.

2. Log in to the DB server as cgms_dev_user.

3. Update the State column for the CgnmsDbJobTrigger row in the QRTZ_TRIGGER tables from ACQUIRED to WAITING.

4. Commit the transaction.

5. Start the IoT FND application server.

■ CSCuy49541

Symptom: When navigating to the Firmware page, the left pane and right pane do not show correct data.

Conditions: User navigated to the images tab before the firmware tab finished loading.

Workaround: Wait for firmware tab to complete loading before navigating to the images tab.

■ CSCuz13240

Symptom: Software Security Monitor (SSM) server cannot generate more than one custom certificate. When attempting to generate a second certificate, the script generates the keypair and a CSR without logging any error but the signature verification fails.

Conditions: SSM attempts to generate a second custom certificate. Red Hat Enterprise Linux 7.x was in use.

Workaround: There is no workaround.

Caveats

This section presents open and resolved caveats in this release and information on using the Bug Search Tool to view details on those caveats. Section topics are:

■Open Caveats

■Resolved Caveats

■Accessing the Bug Search Tool

Related Documentation

Find Cisco 1000 Series Connected Grid Routers and IoT Device Manager documentation at:

www.cisco.com/go/cgr1000-docs

For information on additional systems referenced in this release note, see the following documentation on Cisco.com:

■ Cisco IoT Field Network Director User Guide, Release 5.1

■ Cisco ASR 1000 Series Aggregation Services Routers Configuration Guide

■ Cisco 3945 Series Integrated Services Router

■ Cisco 800 Series Integrated Services Routers

■ Cisco 800 Series Industrial Integrated Services Routers

■ Cisco 800 Series Access Points

■ Cisco 500 Series WPAN Industrial Routers

■ Cisco LoRaWAN Interface Module Hardware Installation Guide

 

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

All printed copies and duplicate soft copies are considered un-Controlled copies and the original on-line version should be referred to for latest version.

Cisco has more than 200 offices worldwide. Addresses, phone numbers, and fax numbers are listed on the Cisco website at www.cisco.com/go/offices.

No combinations are authorized or intended under this document.

© 2017 Cisco Systems, Inc. All rights reserved.