Documentation>Cisco IoT Operations Dashboard
Cisco IoT Operations Dashboard
  • Overview
    • Welcome
    • Get Started
      • Onboarding an EDM-Managed device
      • Onboarding an Externally-Managed device
    • How to order
    • Set up the IoT Dashboard
    • Release notes
      • Edge Device release notes
      • Application Manager
      • Cisco Cyber Vision release notes
      • Secure Equipment Access release notes
      • Edge Intelligence release notes
        • EI 1.16.0 - Nov 08, 2023
        • New and Revised features
        • Supported IOx and IOS versions
        • Open caveats
        • Resolved Caveats
        • Recommendations
        • EI 1.14.0 - Aug 08, 2023
        • New and Revised features
        • Supported IOx and IOS versions
        • Open caveats
        • Resolved Caveats
        • Recommendations
        • EI 1.12.0 - May 11, 2023
        • New and Revised features
        • Supported IOx and IOS versions
        • Open caveats
        • Recommendations
        • EI 1.10.2 - Mar 01, 2023
        • New and Revised features
        • Supported IOx and IOS versions
        • Known issues and limitations
        • Recommendations
      • Industrial Asset Vision release notes
      • Industrial Wireless release notes
        • 2023
    • Log in
    • Upgrading Cisco IoT OD
    • Update network device firmware
    • Access control
      • Add and manage users
      • Create sub-organizations
      • Organization Hierarchy for IoT OD
      • Cisco SSO Login Experience
      • Enable Multi-Factor Authentication for an organization on IoT OD
    • Audit user actions
    • Required accounts
    • Switch organizations or Services
    • View cloud service status
    • Feedback form
  • Edge Device Manager (EDM)
    • Requirements and release notes
      • Overview
      • Release notes
      • Firewall Rules: Device and network requirements
      • Supported devices and firmware
    • EDM Sandbox
    • Onboard network devices
      • Onboarding Quick Start Guide for IR devices
      • Prepare existing devices for onboarding
      • Troubleshoot IR device onboarding
      • Manually onboard network devices (alternative method)
    • Configure network devices
      • Overview
      • Create Configuration Group
      • Edit Configuration Group
      • Configuration Variables
      • Manage Configuration Group
      • Edit the configuration for a specific device
      • Create custom templates
      • Base Configuration
        • Hardware
        • WAN Uplink
        • LAN
        • Ethernet Settings
        • Interface
        • Device Settings
        • DHCP
        • Device Management
        • DNS/NTP
        • VPN
        • Network
        • Security
        • Wi-Fi
        • Serial
        • GPIO
    • Manage network devices
      • Add and manage network devices
      • Delete network devices
      • Deactivate network device
      • Mapping Modules for IR Devices
      • Connectivity from IR devices to Cellular Carriers
      • Convert AP to Autonomous Mode
      • Troubleshooting Issues
      • Add and monitor Meraki cameras
    • Monitor network devices
      • Monitor network device status
      • Track device location
      • View network device info on a map
      • View events and alerts
      • Manage notifications
    • EDM API
    • Application management
    • Application management troubleshooting tips
  • Application Manager
    • Overview
      • Release notes
    • Onboarding Externally-Managed IE3x00 Switches
      • Firewall Rules: Devices and Network Requirements
      • Device Configuration and Initiating Connection to OD
    • Application Inventory and Application Instances
    • Device Inventory
    • Device Profiles
    • Role-Based Access Control
    • Technotes: Troubleshooting Tips
  • Cisco Cyber Vision
    • Overview
      • Introduction
      • Release notes
      • User roles and permissions
    • Dashboard
    • Inventory
      • Assets
      • Asset Selection
      • Asset Deletion
      • Asset Vulnerability Management
    • Security Posture
      • Vulnerabilities
      • Acknowledge Vulnerabilities
        • Acknowledge vulnerabilities
    • Data sources
      • PCAP
      • Sensor Application
        • Sensor application
        • Capture modes
    • Configuration
  • Secure Equipment Access
    • Overview
      • Secure Equipment Access overview
      • Release notes
    • Add network devices and connected clients
    • Manage and schedule access for existing SEA access groups
    • Monitor and terminate sessions
    • Duo user security posture checks
    • Record Inline Sessions
    • Access methods
      • SSH Access Method
      • RDP Access Method
      • VNC Access Method
      • Web App Access Method
      • Telnet Access Method
      • SEA Plus Access Method
  • Edge Intelligence
    • Overview
      • EI overview
      • Using EI
      • Dashboard
      • Release notes
      • Upgrade EI Agents
      • Requirements
      • Supported devices and firmware
    • Enable EI agents
    • Add assets
      • Asset Management
      • Asset Types
      • Add Asset Instances
      • Map Asset Instances
      • Edit Asset Inventory Details
      • View Data Policy Status of an Asset
    • Add data destinations
    • Deploy data rule policies
    • Deploy data logic policies
      • Introduction to Data Logic
      • Install and Update VS Code and EI extension
      • Create Data Logic scripts in VS Code
      • Deploy Data Logic in Cisco EI
      • Update Data Logic scripts
      • Clone Data Logic from Cloud UI
    • View EI events
    • Configure and view alert rules
    • Troubleshooting Issues
      • Recommended Log Rotation
      • Documentation for Metrics collection
    • Edge Intelligence API
  • Industrial Asset Vision
    • Overview
      • Introduction
      • Release notes
    • Prerequisites
    • Quick start guide
      • Getting started
        • Onboard Network Devices
        • Onboard Sensors
        • Onboard Bridges
      • Add asset type
      • Add asset
      • Add sensor
      • Assign sensors
      • Add bridge
      • Change Preferences (User Localization)
    • View status and troubleshoot
      • View asset details and locations
      • View sensors details and troubleshoot
      • View network devices details and troubleshoot
      • Arctic Integration
    • Create alerts and generate reports
      • Create and view alerts
      • Generate and view reports
    • RF Performance Tool
    • Add Templates
    • Stream sensor data
    • Add Geofences
    • Group sensors and assets
    • Northbound APIs
      • Using APIs
      • APIs
        • Overview
        • API
          • AssetTypes
            • Get Asset Types
            • Add Asset Type
            • Delete Asset Type
            • Get Asset Type By Id
            • Update Asset Type
          • Assets
            • Get Assets
            • Add Asset
            • Delete Asset
            • Get Asset By Id
            • Update Asset
            • Assign Sensors To Asset
            • Delete Image Of Asset
            • Get Image Of Asset
            • Upload Image Of Asset
            • Get Sensors By Asset Id
            • Get Thumbnail Image Of Asset
            • Unassign Sensors From Asset
          • Sensors
            • Get Sensors
            • Get Sensor By Dev Eui
            • Claim Sensor By Dev Eui
            • Delete Sensor
            • Get Sensor By Id
            • Update Sensor
            • Get Sensor Location Data
            • Onboard Sensor
            • Get Sensor Tabular Telemetry Data
            • Get Sensor Telemetry Data
        • Model
          • AdditionalAttributesMap
          • Asset
          • AssetListResponse
          • AssetRequest
          • AssetType
          • AssetTypeListResponse
          • AssetTypeRequest
          • AssignSensorsRequest
          • AssignSensorsResponse
          • CreateSensorRequest
          • CustomAttributeData
          • CustomAttributeMetadata
          • Error
          • LiveDataItem
          • Location
          • LocationData
          • LocationDataResponse
          • OnboardSensorRequest
          • OnboardSensorResponse
          • PageInfo
          • Sensor
          • SensorListResponse
          • TabularTelemetryDataResponse
          • TelemetryData
          • TelemetryDataResponse
          • TelemetryValue
          • UnassignSensorsRequest
          • UnassignSensorsResponse
          • UpdateSensorRequest
  • Industrial Wireless
    • Overview
      • Introduction
      • Release notes
        • 2023
    • Supported firmware
    • Add new IW devices
    • Manage IW devices
      • Upgrade IW devices
      • Create Groups
      • Assign IW devices to a Group
      • Configure IW devices in online / offline mode
      • Edit and Delete Groups
      • Remove IW devices from Group
      • Create Templates
      • Duplicate Templates
      • Edit and Delete Templates
    • View details
      • View Group details
      • View IW device details
  • Solution Design
    • Tech guidance
    • Gateway Networking
    • Enterprise Network Integration
    • Security
    • Edge Compute
    • Field Deployment
    • Glossary
  • Developer Resources
    • Sandbox
    • Learning Labs
  • Community and Support
    • Developer Support
    • Videos
    • Related Information
    • System Status

EI 1.16.0 - Nov 08, 2023

New and Revised features

  • Support for 2020 version of J2735 for NTCIP 1202 and RSU Connector
  • UI/UX Enhancement
  • NB API Implementation Phase 2
  • Enhancements to internal performance when establishing connections and transmitting messages to Azure IoT Hub

Supported IOx and IOS versions

Device Family Minimum supported IOx version Latest supported IOx version Minimum supported IOS version Latest supported IOS version
IC3K 2.6.0.0 2.6.0.0 1.4.1 1.4.2
IR8X9 1.13.0.6 1.15.0.0 15.9(3)M5 15.9(3)M9
IR1101 2.8.0.0 2.11.0.0 17.09.03 17.12.01
IR1800 2.8.0.0 2.11.0.0 17.09.03 17.12.01
IE3400 2.8.0.0 2.11.0.0 17.09.03 17.12.01

Open caveats

  • NTCIP 1202 Asset configured with SNMP V3 version will not be able to receive SNMP V3 trap messages but it can receive V1/V2 trap messages because of backword compatibility, for Polling attribute SNMP V3 version will be able to receive all V1/V2/V3 polling messages.
  • SNMP standard trap port 162 is not supported as it is reserved by IOX/IOS so it can not communicate for trap messages if it is configured in NTCIP Asset model.
  • Multi topic is not supported on IBM Watson.
  • Protobuf: Support for precision upto 2^53 for 64bit prototypes.
  • Protobuf: Default values (e.g. 0, false, '') are automatically encoded, to avoid this behaviour, null must be assigned to attribute.
  • There won't be a BACKPRESSURE OK event generated for a specific pipeline, if the last event was BACKPRESSURE_UP or BACKPRESSURE_DROP and the pipeline is undeployed (for any reason).
  • In the UI event log for Azure Link, data drops are recorded as events when the transmission fails due to a timeout. Even in low-bandwidth scenarios, you may encounter "Dropping message. Delivery failed due to timeout." messages in the health status path.
  • If the UI does not specify a sampling interval, it will default to 0 seconds, which can lead to crashes if there are many attributes from the southbound. To avoid this, it's essential to set the sampling interval based on the input size.

Resolved Caveats

Caveat ID Descripition
CSCwf99450 EiTenantHealthCriticalAlert
CSCwh68162 CIAM: openssl - Third party library updated to resolve vulnerability
CSCwh68163 CIAM: Graphql - Third party library updated to resolve vulnerability
CSCwh49656 CIAM: Busybox - Third party library updated to resolve vulnerability
CSCwf87758 CIAM: Net-snmp - Third party library updated to resolve vulnerability

Recommendations

  • Please go through the EI documentation for more details.

EI 1.14.0 - Aug 08, 2023

New and Revised features

  • SNMP Enhancements for NTCIP - Wrong Way Driver devices:
    • Enable connection of basic SNMP devices using NTCIP-1202 connector
  • Clone and Publish Data Logics through the Cloud UI:
    • Create and deploy new pipelines without VS Code
  • Basic Cloud API Access for EI Services:
    • Implement API platform with initial endpoint for retrieving status information about Agents

Supported IOx and IOS versions

Device Family Minimum supported IOx version Latest supported IOx version Minimum supported IOS version Latest supported IOS version
IC3K 2.6.0.0 2.6.0.0 1.4.1 1.4.2
IR8X9 1.13.0.6 1.15.0.0 15.9(3)M5 15.9(3)M7
IR1101 2.8.0.0 2.10.0.0 17.09.03 17.11.01
IR1800 2.8.0.0 2.10.0.0 17.09.03 17.11.01
IE3400 2.8.0.0 2.10.0.0 17.09.03 17.11.01

Open caveats

  • NTCIP 1202 Asset configured with SNMP V3 version will not be able to receive SNMP V3 trap messages but it can receive V1/V2 trap messages because of backword compatibility, for Polling attribute SNMP V3 version will be able to receive all V1/V2/V3 polling messages.
  • SNMP standard trap port 162 is not supported as it is reserved by IOX/IOS so it can not communicate for trap messages if it is configured in NTCIP Asset model.
  • Multi topic is not supported on IBM Watson.
  • Protobuf: Support for precision upto 2^53 for 64bit prototypes.
  • Protobuf: Default values (e.g. 0, false, '') are automatically encoded, to avoid this behaviour, null must be assigned to attribute.
  • There won't be a BACKPRESSURE OK event generated for a specific pipeline, if the last event was BACKPRESSURE_UP or BACKPRESSURE_DROP and the pipeline is undeployed (for any reason).
  • In the UI event log for Azure Link, data drops are recorded as events when the transmission fails due to a timeout. Even in low-bandwidth scenarios, you may encounter "Dropping message. Delivery failed due to timeout." messages in the health status path.
  • If the UI does not specify a sampling interval, it will default to 0 seconds, which can lead to crashes if there are many attributes from the southbound. To avoid this, it's essential to set the sampling interval based on the input size.

Resolved Caveats

Caveat ID Descripition
CSCwf75393 EI agent fails to reconnect to upstream cloud after cellular connectivity flap
CSCwf82983 CIAM: openssl - Third party library updated to resolve vulnerability
CSCwh14119 Azure IoT Hub is getting too many null messages
CSCwh11579 Editing an Asset Instance with an Optional File field causes the Save button to become disabled

Recommendations

  • Please go through the EI documentation for SNMP Connector Utilizing NTCIP1202.

EI 1.12.0 - May 11, 2023

New and Revised features

  • Metrics Collection -
    • This feature will provide detailed information on the application's resource usage, i.e., the application's CPU, memory, network utilization, and much more.
    • The name of the CSV file in which the data will be saved as a comma-separated variable is "metrics_collect.csv".
    • The current CSV file will be compressed and a new CSV file created every day at 11:59 PM.
    • The application saves files for seven days. After seventh day, a new file will replace the older one.

Supported IOx and IOS versions

Device Family Minimum supported IOx version Latest supported IOx version Minimum supported IOS version Latest supported IOS version
IC3K 2.6.0.0 2.6.0.0 1.4.1 1.4.2
IR8X9 1.13.0.6 1.15.0.0 15.9(3)M5 15.9(3)M7
IR1101 2.8.0.0 2.8.0.0 17.9.1 17.9.3
IR1800 2.8.0.0 2.8.0.0 17.09.01 17.09.03
IE3400 2.8.0.0 2.8.0.0 17.9.2 17.9.3

Open caveats

  • Multi topic is not supported on IBM Watson.
  • Protobuf: Support for precision upto 2^53 for 64bit prototypes.
  • Protobuf: Default values (for example, 0, false, '') are automatically encoded; to avoid this behaviour, null must be assigned to the attribute.
  • There won't be a BACKPRESSURE OK event generated for a specific pipeline, if the last event was BACKPRESSURE_UP or BACKPRESSURE_DROP and the pipeline is undeployed (for any reason).
  • We are transmitting data drop as an event for Azure Link in the UI under the event log, however in a scenario with low-bandwidth, we can still see "Dropping message. Delivery failed due to timeout." messages in the health status path.
  • If no sampling interval is specified in the UI, it will use the default value of 0 seconds, which may cause the links to crash if there are many attributes from the southbound. The sampling interval has to be used based on the input size.

Recommendations

  • For detailed explanation of Metrics Collection please go through the documentation. See Documentation for Metrics collection.

EI 1.10.2 - Mar 01, 2023

New and Revised features

  • EI agent on IE3400
  • Protobuf support in EI agent
  • Multi-topic support:
    1. Ability to publish data on different topics to MQTT destination using Datalogic script.
    2. Support for subscription of multiple MQTT topics using Datalogic script.

Supported IOx and IOS versions

Device Family Minimum supported IOx version Latest supported IOx version Minimum supported IOS version Latest supported IOS version
IC3K 2.3.0.17 2.6.0.0 1.3.3 1.4.1
IR8X9 1.13.0.6 1.15.0.0 15.9(3)M3 15.9(3)M5
IR1101 2.7.0.0 2.8.0.0 17.8.1 17.9.1
IR1800 2.7.0.0 2.8.0.0 17.8.01a 17.09.01a
IE3400 2.8.0.0 2.8.0.0 17.9.2 17.9.2

Known issues and limitations

  • Multi topic is not supported on IBM Watson.

  • Protobuf: Support for precision upto 2^53 for 64bit prototypes.

  • Protobuf: Default values (e.g. 0, false, '') are automatically encoded, to avoid this behaviour, null must be assigned to attribute.

  • There won't be a BACKPRESSURE OK event generated for a specific pipeline, if the last event was BACKPRESSURE_UP or BACKPRESSURE_DROP and the pipeline is undeployed (for any reason).

  • We are transmitting data drop as an event for Azure Link in the UI under the event log, however in a scenario with low-bandwidth, we can still see "Dropping message. Delivery failed due to timeout." messages in the health status path.

  • If no sampling interval is specified in the UI, it will use the default value of 0 seconds, which may cause the links to crash if there are many attributes from the southbound. The sampling interval has to be used based on the input size.

  • After upgrading from EI_1.8.0 to EI_1.10.0, the following parameters will not be part of dslink.json for azure or MQTT link by default; if the default values for any of the following parameters need to be changed, they must be manually added to the dslink.json file with the necessary values, and then the link must be restarted.

    Code Snippet
    Configuration: "max_cir_queue_count": {
    "type": "int",
    "default": 1024
    },
    "max_cir_queue_size_mb": {
    "type": "int",
    "default": 10
    },
    "sdk_queue_size": {
    "type": "int",
    "default": 64
    },
    "drop_event_init_interval_sec": {
    "type": "int",
    "default": 60
    },
    "drop_event_final_interval_sec": {
    "type": "int",
    "default": 600
    }
    

PS: We should eliminate these unnecessary parameters before downgrading from EI 1.8.0. If you don't, azure and MQTT links will fail to start on the downgrade.

Recommendations

  • Please go through the EI documentation for protobuf sample datalogic script.

EI 1.10.0 - Nov 16, 2022

New and Revised Features

  • Detecting data delivery impacts in NB links of an EI agent and inform the user about the occurrence and its impacts.
  • EI agent on Aventus IR1800.

Supported IOx and IOS versions

Device Family Minimum supported IOx version Latest supported IOx version Minimum supported IOS version Latest supported IOS version
IC3K 2.3.0.17 2.6.0.0 1.3.3 1.4.1
IR8X9 1.13.0.6 1.15.0.0 15.9(3)M3 15.9(3)M5
IR1101 2.7.0.0 2.8.0.0 17.8.1 17.9.1
IR1800 2.7.0.0 2.8.0.0 17.8.01a 17.09.01a

Resolved Caveats

Caveat ID Description
CSCwd02974 [HBR] The log rotation fails on time and size
CSCwc87110 [modbus] An error in configuring an asset leads to mandatory agent-restart
CSCwc95120 CIAM: Vulnerabilities in libmodbus 3.1.6 - third party library updated to resolve vulnerability
CSCwc71655 CIAM: Sqlite 3.35.5 - third party library updated to resolve vulnerability
CSCwc36648 CIAM: Openssl - third party library updated to resolve vulnerability

Known issues and limitations

  • If for a given pipeline the last event is BACKPRESSURE_UP or BACKPRESSURE_DROP and if the pipeline is undeployed (due to any reason) there won't be an BACKPRESSURE_OK event generated after this.

  • For azure link , we are sending data drop as an event in UI under event log. But during low bandwidth scenario, we can still see "Dropping message. Delivery failed due to timeout." messages in health status path.

  • If sampling interval is not provided in the UI it would take the default value which is 0 s, in this case if there are many attributes from south bound then the links can crash. Sampling interval have to be used based on the input size.

  • After upgrade from EI_1.8.0 to EI_1.10.0, below parameters will not be part of dslink.json for azure or MQTT link by default, if incase there is a need to change default values for any of the below parameter then these must be added into dslink.json file manually with required values and restart the link.

    Code Snippet
    Configuration: "max_cir_queue_count": {
    "type": "int",
    "default": 1024
    },
    "max_cir_queue_size_mb": {
    "type": "int",
    "default": 10
    },
    "sdk_queue_size": {
    "type": "int",
    "default": 64
    },
    "drop_event_init_interval_sec": {
    "type": "int",
    "default": 60
    },
    "drop_event_final_interval_sec": {
    "type": "int",
    "default": 600
    }
    

Note: While downgrading from to EI_1.8.0 we should remove these extra parameters before downgrading, failing to do so, will cause azure and MQTT links fail to start on downgrade.

Caveat ID Description
The NTCIP streaming mode doesn't display valid timestamp in UI for data while sending to destination

Recommendations

Upgrade Cisco Edge Intelligence extension for Microsoft Visual Studio Code (VS Code).

  1. Search for the "Cisco Edge Intelligence" extension Visual Studio marketplace.
  2. Follow the prompts to install the extension.
  3. Once installed, "CISCO EI" appears in the explorer bar.

EI 1.8.0 - June 29, 2022

New and Revised Features

  • Previously, the log rotation was based on time, and it is now changed based on the size limit. Once the file size reaches the max size limit, the log file is compressed using gzip algorithm and it is rotated. The archived files will have a timestamp and the log file's name. The algorithm uses 50% of disk space by default and calculates the max size of the file with the default number of files as 10 for each link.

  • In addition to the existing global trigger properties - device_name and field_name, and timestamp is added.

  • The trigger.timestamp is updated with the time while reading the data from source and is made available to the datalogic engine.

  • This timestamp is used in datalogic script and added to the payload on demand.

  • The timestamp is maintained in Zulu.

Supported IOx and IOS versions

Device Family Minimum supported IOx version Latest supported IOx version Minimum supported IOS version Latest supported IOS version
IC3K 2.3.0.10 2.6.0.0 1.3.1 1.4.1
IR8X9 1.13.0.6 1.14.0.0 15.9(3)M3 15.9(3)M4
IR1101 2.3.0.5 2.5.0.0 17.6.1 17.6.3

Resolved Caveats

Caveat ID Description
CSCwb16547 The v1.4.17 does not allow using semantic-message-routing in Azure
CSCwb36421 Creating multiple outbound/northbound MQTT connections on router start
CSCwb45274 If link restarts, then sys/system_status/components/link_name/log_status has to be resubscribed
CSCwb45130 zlib 1.2.11 third party library updated to resolve CVE-2018-25032 vulnerability
CSCwb55824 After EI upgrade from v1.4.17 to v1.6, the serial port settings are not synced properly
CSCwb57023 The EI agent creates a log file too large to rotate, which makes the system into a faulty and non-recoverable
CSCwb57029 HBR reports that after upgrading to 1.6, at least one of their agents has a problem to start up
CSCwb61776 Busybox 1.32.1 third party library updated to resolve vulnerability
CSCwb57029 Openssl - third party library updated to resolve vulnerability

Known issues and limitations

  • Global objects (e.g. "performance", "output", "parameters", "trigger”) provided/implemented by Scripting Engine are not iterable and accessing the internal properties such as “_name” and “0” will lead to run time java script error.
  • Low network bandwidth can cause memory crunch hence resulting in restarting the process. This can be resolved by increasing the network bandwidth or by increasing the sampling interval.
  • Device Model attribute names must not start with a number.
Caveat ID Description Workaround
CSCwc19177 Tables in EI have broken layout after filtering, columns layout is broken, and characters appear in columns where they should not appear This only happens if the user has been on the Edge Device Management UI in the same session.
The workaround is refreshing the web page: hitting F5 or pressing the reload button for the current page in the browser.

Required Action

  • If Timestamp is required in attributes:
  1. In addition to existing global trigger properties - device_name and field_name, timestamp is added.

  2. The trigger.timestamp is updated with the time while reading the data from source and is made available for the datalogic engine.
    For example:

    function on_update() {

    device = trigger.device_name;

    attribute = trigger.field_name;

    value = akmqtt[attribute];

    timestamp = trigger.timestamp;

    // logging only

    logger.info("device name: " + device);

    logger.info("attribute name: " + attribute);

    logger.info("attribute value: " + value);

    logger.info("attribute value timestamp: " + timestamp);

    // construct JSON object

    data = new Object();

    data["v"] = value;

    data["ts"] = timestamp;

    telemetry = new Object();

    telemetry[attribute] = data;

    msg = new Object();

    msg[device] = telemetry;

    logger.info(JSON.stringify(msg));

    publish("output", msg);

    }

  3. This timestamp can be used by the customer in datalogic script and added to the payload on demand.

  4. The timestamp is maintained in Zulu.

    For example: 2022-05-06T12:57:17.461Z

  • Following steps need to be performed to upgrade EI from v1.6.x to v1.8.0:
  1. After upgrading EI agent, we should map our ports again.
  2. Redeploy that pipeline.
  3. Also, we can reset the agent in UI.

Recommendations

Upgrade Cisco Edge Intelligence extension for Microsoft Visual Studio Code (VS Code).

  1. Search for the "Cisco Edge Intelligence" extension Visual Studio marketplace.
  2. Follow the prompts to install the extension.
  3. Once installed, "CISCO EI" appears in the explorer bar.

EI 1.6.2 - May 2, 2022

Supported IOx and IOS versions

Device Family Minimum supported IOx version Latest supported IOx version Minimum supported IOS version Latest supported IOS version
IC3K 2.3.0.10 2.6.0.0 1.3.1 1.4.1
IR8X9 1.13.0.6 1.14.0.0 15.9(3)M3 15.9(3)M4
IR1101 2.3.0.5 2.5.0.0 17.6.1 17.6.2

Resolved Caveats

Caveat ID Description
CSCwb55824 After EI upgrade from version 1.4.17 to 1.6 - the serial port settings are not synced correctly
CSCwb16547 The EI version 1.4.17 does not allow using semantic-message-routing in Azure

Known issues and limitations

  • Global objects (e.g. "performance", "output", "parameters", "trigger”) provided/implemented by Scripting Engine are not iterable and accessing the internal properties such as “_name” and “0” will lead to run time java script error.
  • Low network bandwidth can cause memory crunch hence resulting in restarting the process. This can be resolved by increasing the network bandwidth or by increasing the sampling interval.
  • Device Model attribute names must not start with a number.

Required Action

Steps to follow for data rules/logic using MQTT destination during upgrade from 1.4.X to 1.6.X:

  • Undeploy the current running pipeline in 1.4.X.
  • Upgrade the EI agent version to 1.6.X.
  • Deploy again the same pipeline to the newly upgraded EI agent.

Recommendations

Upgrade Cisco Edge Intelligence extension for Microsoft Visual Studio Code (VS Code).

  1. Search for the "Cisco Edge Intelligence" extension Visual Studio marketplace.
  2. Follow the prompts to install the extension.
  3. Once installed, "CISCO EI" appears in the explorer bar.

EI 1.6.0 - March 10, 2022

New and revised features for EI

  • EIP/CIP asset type with single and multi level tag support
  • Roadways (Trafficware and Econolite binary streaming to SAE J2735 SPAT and J2735 SRM/SSM to NTCIP 1211)
  • Reset option to clear all the data policy deployment information of the EI Agent
  • Events option to track the health status of the system, an EI agent, or a data policy

Supported IOx and IOS versions

Device Family Minimum supported IOx version Latest supported IOx version Minimum supported IOS version Latest supported IOS version
IC3K 2.3.0.10 2.6.0.0 1.3.1 1.4.1
IR8X9 1.13.0.6 1.14.0.0 15.9(3)M3 15.9(3)M4
IR1101 2.3.0.5 2.5.0.0 17.6.1 17.6.2

Resolved Caveats

Caveat ID Description
CSCvz78065 VS code error message: "is not registered for the subscription"
CSCvz86544 Error during undeploying pipeline using Null as pipeline ID
CSCvz87857 Leftover configuration after undeploying MQTT-based pipeline
CSCvz87860 Generic MQTT link seem to send NULL userid, if userid is empty
CSCwa07029 Frequent restarts of Serial Link
CSCvz96278 Certificate expiry issue - Data logic is not getting deployed in roadways production instance
CSCwa11066 Issues related to NTCIP1202 Intersection and streaming
CSCwa37058 NTCIP 1202: J2735 Streaming Asset with empty intersection ID throws error
CSCvz84883 Unable to create Asset Instance with Asset Type details when given like (enable streaming, J2735)
CSCvz65872 EIP/CIP link UI should give error when tag used more than once
CSCvz46841 Gateway sending data via MQTT but EI is says destination is offline in EI Policy Status

Known issues and limitations

  • Global objects (e.g. "performance", "output", "parameters", "trigger”) provided/implemented by Scripting Engine are not iterable and accessing the internal properties such as “_name” and “0” will lead to run time java script error.
  • Low network bandwidth can cause memory crunch hence resulting in restarting the process. This can be resolved by increasing the network bandwidth or by increasing the sampling interval.
  • Device Model attribute names must not start with a number.

Required Action

Steps to follow for data rules/logic using MQTT destination during upgrade from 1.4.X to 1.6.X:

  • Undeploy the current running pipeline in 1.4.X.
  • Upgrade the EI agent version to 1.6.X.
  • Deploy again the same pipeline to the newly upgraded EI agent.

Recommendations

Upgrade Cisco Edge Intelligence extension for Microsoft Visual Studio Code (VS Code).

  1. Search for the "Cisco Edge Intelligence" extension Visual Studio marketplace.
  2. Follow the prompts to install the extension.
  3. Once installed, "CISCO EI" appears in the explorer bar.

EI 1.4.16 - September 29, 2021

New features for EI

  • EIP/CIP asset type (under feature flag)
  • Bulk Import and EI Agent Mapping of Assets via CSV
  • Improvement Overall System Health Overview
    • Added EI Agent Management capabilities from within Edge Intelligence for EDM (Edge Device Manager) managed devices.
    • Added and improved Data Rule and Data Logic health UI views.
    • Multiple UI improvements for better viewing of the overall system health status
  • RSU connector (under feature flag)
    • Support for Probe Vehicle Data (PVD)

Supported IOx and IOS versions

Device Family Minimum supported IOx version Latest supported IOx version Minimum supported IOS version Latest supported IOS version
IC3K 2.3.0.10 2.3.0.17 1.3.1 1.3.3
IR8X9 1.13.0.6 1.14.0.0 15.9(3)M3 15.9(3)M4
IR1101 2.3.0.5 2.5.0.0 17.4.1 17.6.1

Resolved Caveats

Caveat ID Description
CSCvy47690 MQTT Link Logfile Output is suboptimal
CSCvz45769 EI Cloud shows incorrect count of "Number of Assets not sending data" field in Agent status page
CSCvz50503 CIAM: openssl - multiple versions
CSCvz46841 Gateway sending data via MQTT, but EI says destination is offline in EI Policy Status
CSCvz43253 EI goes into restart-loop after IR809 power cycle
CSCvz63909 In case of error scenario, display the tag name in device health status
CSCvz40905 PVD - Data in the RSU connector
CSCvz47645 Fixed an issue that caused a wrong count of mapped assets in the EI Agent view.

Cloud bug fixes

Fixed multiple issues with list requests in Cloud Broker which were leading to missing status updates.

Known issues and limitations

  • Global objects (e.g. "performance", "output", "parameters", "trigger”) provided/implemented by Scripting Engine are not iterable and accessing the internal properties such as “_name” and “0” will lead to run time java script error.
  • Low network bandwidth can cause memory crunch hence resulting in restarting the process. This can be resolved by increasing the network bandwidth or by increasing the sampling interval.
  • Device Model attribute names must not start with a number.

Required Action

If you are not using the RSU connector, no action is required. For the RSU connector, upgrade to EI Agent 1.4.16 to support the new features.

Recommendations

Upgrade Cisco Edge Intelligence extension for Microsoft Visual Studio Code (VS Code).

  1. Search for the "Cisco Edge Intelligence" extension Visual Studio marketplace.
  2. Follow the prompts to install the extension.
  3. Once installed, "CISCO EI" appears in the explorer bar.

EI 1.4.14 - August 31, 2021

Supported IOx and IOS versions

Device Family Minimum supported IOx version Latest supported IOx version Minimum supported IOS version Latest supported IOS version
IC3K 2.3.0.10 2.3.0.17 1.3.1 1.3.3
IR8X9 1.13.0.6 1.14.0.0 15.9(3)M3 15.9(3)M4
IR1101 2.3.0.5 2.5.0.0 17.4.1 17.6.1

Resolved Caveats

Caveat ID Description
CSCvz15725 OPC/UA data model with variable type of "BYTE" is throwing error as Unsupported
CSCvz27622 CIAM: mosquitto 1.6.14 CVE-2021-34432 and others
CSCvz21988 Improper timestamp from Health-Check link
CSCvz21995 Improper clean-up after Serial pipeline undeployment
CSCvz12251 SDK Error in Longevity Test
CSCvy30772 Error message seen in EML logs after pipeline un-deployment with Azure as destination
CSCvz30645 On SS API failure, we don't delete sss_markr file
CSCvz12253 Flaky azure_test test_telemetry_messages_in_flight_limit
CSCvz17830 NTCIP 1202: Communicating with asset using SNMP v1 throws an error

Known issue and limitation

  • Low sampling interval can sometimes result in out of memory. This can be mitigated by either allocating more memory to the application or increasing the sampling interval.

EI 1.4.12 - July 20, 2021

Resolved Caveats

Caveat ID Description
CSCvy85007 Modbus RTU fails on IR1101 with EI 1.4.10
CSCvy92626 Modbus link reports "Failed to read holding register Too many data"

EI 1.4.10 - June 21, 2021

New and revised features

  • Serial Data Model Binary Data Improvements​
  • MQTT Destination Cloud to Datalogic Command Channel​
  • IBM Watson – Automatic Device Instance Creation​
  • EI Agent Management

Known issues and limitations

  • Global objects (e.g. "performance", "output", "parameters", "trigger”) provided/implemented by Scripting Engine are not iterable and accessing the internal properties such as “_name” and “0” will lead to run time java script error.
  • EI agents with $ in their name are not detected, avoid using $ in agent names.
  • Device Model attribute names must not start with a number.

Resolved Caveats

Caveat ID Description
CSCvw46410 Sometimes an error appears in UI during pipeline re-deployment even though the Edge pipeline creation was successful.
CSCvx99112
CSCvx00036
Issues in pipeline undeployment and re-deployment
CSCvx47258 Issues in pipeline re-deployment after EI app restart
CSCvx19097 Incorrect asset status is displayed in EI Agent when using local action
CSCvy39124 Health status of data logic based pipelines show devices as offline when these were online
CSCvx61758 Overall data pipeline status for an EI agent is not updated under high load
CSCvx88907
CSCvx17919
Device model verification left configurations on modbus connector which were not cleaned up automatically
CSCvy19055 Multiple pipelines for a single asset could not be deployed
CSCvy17818
CSCvy27954
Fixed security vulnerabilities
CVE-2020-28928
CVE-2021-29425
CVE-2021-21290
CVE-2021-21295
CVE-2021-21409
CSCvy17411 Improved error handling for OPC-UA Connector in case of conversion errors
CSCvy40980 Decreased memory consumption on Edge devices
Improvement If a script is deployed for debugging from VS Code, any script engine error will be added to the pipeline health as an error log entry in the script debug log visible in VS Code. This way the script developer will have immediate feedback, while only part of the script is executed and some debug messages don't show up later in the script.

EI 1.2.20 - April 12, 2021

Known issues and limitations

  • Global objects (e.g. "performance", "output", "parameters", "trigger”) provided/implemented by Scripting Engine are not iterable and accessing the internal properties such as “_name” and “0” will lead to run time java script error.
  • An error might occur when undeploying a pipeline "invalid path / not found". If this error occurs, undeploy the pipeline again.

Open Caveats

Caveat ID Description
CSCvw46410 Sometimes an error appears in UI during pipeline re-deployment even though the Edge pipeline creation is successful.
CSCvw53849 EI agents with certain characters in their name are not detected.
CSCvw71631 Error message in Modbus log "Device can't start" while pipeline is processing fine.
CSCvw99110 Error might occur when removing pipeline: "invalid path / not found".
CSCvx17434 MQTT link sometimes does not remove full configuration on pipeline undeployment.

Resolved Caveats

Caveat ID Description
CSCvx54280 Fixed security vulnerabilities
CVE-2020-28500
CVE-2021-23337
no external reference * Additional security relevant updates
* CiscoSSL update to version 7.2.225
* MQTT Connector, mosquito update to version 1.6.14
CSCvw94952 Removed redundant messaging from Modbus Logging.

EI 1.2.18 - March 10, 2021

Known issues and limitations

  • Global objects (e.g. "performance", "output", "parameters", "trigger”) provided/implemented by Scripting Engine are not iterable and accessing the internal properties such as “_name” and “0” will lead to run time java script error.
  • An error might occur when undeploying a pipeline "invalid path / not found". If this error occurs, please undeploy the pipeline again.

Open Caveats

Caveat ID Description
CSCvw46410 Sometimes an error appears in UI during pipeline re-deployment even though the Edge pipeline creation is successful.
CSCvw53849 EI agents with certain characters in their name are not detected.
CSCvw71631 Error message in Modbus log "Device can't start" while pipeline is processing fine.
CSCvw99110 Error might occur when removing pipeline: "invalid path / not found".
CSCvx17434 MQTT link sometimes does not remove full configuration on pipeline undeployment.
CSCvx19097 Incorrect asset status displayed in EI Agent when using local action.

Resolved Caveats

Caveat ID Description
CSCvx48895, CSCvx48896 Fixed security vulnerabilities
CVE-2021-23840
CVE-2021-23841

EI 1.2.14 - February 02, 2021

Known issues and limitations

  • Global objects (e.g. "performance", "output", "parameters", "trigger”) provided/implemented by Scripting Engine are not iterable and accessing the internal properties such as “_name” and “0” will lead to run time java script error.
  • An error might occur when undeploying a pipeline "invalid path / not found". If this error occurs, please undeploy the pipeline again.

Open Caveats

Caveat ID Description
CSCvw46410 Sometimes an error appears in UI during pipeline re-deployment even though the Edge pipeline creation is successful.
CSCvw53849 EI agents with certain characters in their name are not detected.
CSCvw71631 Error message in Modbus log "Device can't start" while pipeline is processing fine.
CSCvw99110 Error might occur when removing pipeline: "invalid path / not found".
CSCvx17434 MQTT link sometimes does not remove full configuration on pipeline undeployment.
CSCvx19097 Incorrect asset status displayed in EI Agent when using local action.

Resolved Caveats

Caveat ID Description
CSCvw36630 An error occurred in the UI when the user clicked on an item in the Data Logic page while the connected asset was deleted.
CSCvw76411 Error "Removing partly instantiated pipeline" in Modbus leading to removal of shared asset in case two pipelines are using the same modbus asset where one of them is a multi-input asset pipeline, the other one is a single-asset data rule pipeline.
CSCvw93567 Fixed security vulnerability CVE-2020-1971.

EI 1.2.6 - December 15, 2020

Upgrade requirements

All EI Agents must be updated to the latest version to ensure full feature compatibility with the Cisco EI cloud software. For example, upgrading the EI Agent allows you to use new connection types for Assets and Data Destinations and perform all Data Policy management actions.

In this release, you must manually upgrade the EI Agents using GMM/FND/Local Manager. Because this upgrade process removes all data policy information from the agent, you must also download a summary of your Data Policies, un-deploy the policies, upgrade the EI Agents and then redeploy the policies to the same EI Agents.

  • Upgrade EI Agents instructions
  • Download the EI Agent software

New and revised features

Support for new Asset Types and Assets
  • Serial
Data Destinations enhancements
  • Enhancements to Generic MQTT destinations
  • IBM Watson (telemetry)
  • Cumulocity IoT (telemetry, dynamic provisioning)
  • AWS IoT Core (using Generic MQTT, telemetry, just-in-time provisioning)
  • Azure IoT Central Telemetry support using Azure IoT Hub
Data Logic enhancements

Data Logic now supports the following:

  • Read data from multiple asset types (one asset per type)
  • Write back into a subset of supported devices that support writable attributes (Local Action)
  • Transfer files using the Data Logic script
  • Ability to define the structure of output of a Data Logic within the script
  • Improved configuration and deployment workflow for Data Logic based policies

Known issues and limitations

  • The latest features and enhancements are available only if all EI Agents are upgraded to the latest release.
  • File transfer feature in the Data Logic script has the following limitations:
    • Currently, the maximum file size supported is 30 MB.
    • At any given point of time, only one data logic script which is doing file transfer should be running on an EI Agent.
  • EI agents with $ in their name are not detected - workaround: do not use $ in the name of an EI Agent.
  • Global objects (e.g. "performance", "output", "parameters", "trigger”) provided/implemented by Scripting Engine are not iterable and accessing the internal properties such as “_name” and “0” will lead to run time java script error.

Updated network device requirements and caveats

See Supported network devices and firmware for information on the supported IOS/IOx versions and caveats for this release.

Open Caveats

Caveat ID Description
CSCvw76411 Error "Removing partly instantiated policy" in Modbus leading to removal of shared asset in case two policies are using the same modbus asset where one of them is a multi-input asset policy, the other one is a single-asset data rule policy.
CSCvw46410 Sometimes there is an error seen in UI during policy re-deployment, while in fact on Edge, policy creation is successfully completed.
CSCvw53849 EI agents with certain characters in their name are not detected.
CSCvw71631 Error message in modbus log "Device can't start" while pipeline is processing fine.
CSCvw53849 EI agents with certain characters in their name are not detected.
CSCvw71631 Error message in modbus log "Device can't start" while policy is processing fine.

Resolved Caveats

Caveat ID Description
CSCvw78017 Reduced too big default size of IOx data partition on IR1101 to 256MB and on IC3K to 1GB.
CSCvv09366 Azure connector increased memory when MS Azure Quota was exceeded.
CSCvv77875 New Data Logic automatically created saved last selected EI Agent and Data Destination instead of default values.
CSCvv13912 Selected Data Destination not seen after un-deployment of Data Logic.
CSCvv77861 EI Agents and Data Destination were reset to default on deployment errors.
CSCvv19431
CSCvv50110
MQTT egress configurations was removed, the policy metadata was not removed from the multiple policy store.
This caused issues on undeploy/redeploy operations.
CSCvv39915 MQTT connector disconnected after application restart.
CSCvv68959 MQTT server stopped receiving traffic after policy redeployment.
CSCvw66134 Modbus Link: device model was incompletely configured at the edge.
CSCvw66138 Modbus Link: device model was deployed with incomplete attributes.
CSCvw70940 Modbus serial: added support for parity flag "NONE".
CSCvw06800 Policy status counts were not getting updated (decremented) when a gateway was deleted from the system.
CSCvu96074
CSCvu98461
CSCvv23439
Several fixes in error messages and error message handling.
CSCvw29293
CSCvw29278
CSCvw27432
fixed security vulnerabilities:
CVE-2020-8203
CVE-2010-4756
CVE-2016-3706
CVE-2020-10029
CVE-2020-1752
CVE-2020-6096
CVE-2020-15168

EI 1.0.4 - September 15, 2020

New and revised features

The following production server URLs are now supported when logging in to Cisco IoT from the VS Code app:

  • https://eu.ciscoiot.com
  • https://us.ciscoiot.com

See Data Logic for more information.

EI 1.0.2 - August 6, 2020

New and revised features

  • EI now supports the IR1101 gateway.
    • See Supported edge devices and firmware for more information.
    • Download the EI Agent from the Cisco Download Center.

Resolved caveats

Caveat ID Description
CSCvu99869 The Modbus connector did not reconnect in rare cases in case the connection was lost.
CSCvv23439 Too many health monitoring updates were sent to the cloud in case a connection was lost in one of the connectors.
CSCvv09344 Fast deploy and un-deploy data policies.

EI 1.0.0 - July 22, 2020

Supported Features

Feature Benefit
Integrated device connectivity Edge Intelligence provides various industry-standard connectors such as Open Platform Communications Unified Architecture (OPC UA), MQ Telemetry Transport (MQTT), and Modbus TCP and Remote Terminal Unit (RTU), and integrates seamlessly with your environment.
Data model editor Customize data models that describe exactly what data will be extracted from your assets.
Data logic engine Deploy custom logic using JavaScript to transform data at the edge. Use data logic to sample high-frequency data streams, apply transformation logic, perform rule-based range validation, or normalize data, depending on specific needs.
Microsoft Visual Studio (VS) Code plug-in Simplify development of data logic by leveraging standard development tools.
Data governance Achieve fine-grained control to help ensure that the right data is delivered to the right applications. Data from any source can be filtered at the attribute level and delivered to multiple selected applications.
Application data integration Deliver your data to any application, either cloud hosted or on premises, using built-in connectivity to services such as Microsoft Azure IoT Hub or industry-standard protocols such as MQTT.
Role-based access control Use segmented configuration and operation to control who has access to what elements of the configuration and operation of your Edge Intelligence solution.
Audit trail Log all operations in Edge Intelligence to help ensure accountability for the integrity of your solution configuration and deployment.
Security Deploy industry-leading built-in security that protects your data and your business. Edge applications are protected through a comprehensive security architecture anchored to a hardware root of trust and built-in Transport Layer Security (TLS).
Centralized administration Use the management software to create all aspects of your edge stack configuration in a centralized place, including data models, data logic, destinations, and policies, to greatly simplify the deployment of these pieces at massive scale.
Scalability Manage the lifecycle of an edge stack and associated workflows on thousands of Cisco network devices.
Operational health monitoring Gain real-time visibility into the operational state of the Edge Intelligence agents and execute state of deployed policies.
Data explorer

Known issues and limitations

  • The attribute names of asset model definition should be alphanumeric and can contain underscores. The names should not contain hyphens.

  • There is no limitation on the attribute label naming convention.

Open Caveats

Caveat ID Description
CSCvu98461 Error message does not indicate offline status of EI Agent during deployment.
CSCvu96074 Error message is slightly misleading during deletion of a destination in use.
CSCvu98296 The policy status summary for a GW and the detailed policy status (asset offline/online status) are not in synch.
CSCvu93540 Adding prefix to brokerName causes broker to not appear in EI Agents list.
CSCvv10758 Error while creating data policy with certain length of input fields.
CSCvv09366 Azure increases memory when MS Azure Quota is exceeded.
CSCvv09344 Fast deploy and un-deploy data policies.

EI Agent ( IOx Platform) Caveats

Caveat ID Description
CSCvt55266 IOx Secure Storage not responding after a dozen of minutes.
CSCvv03543 Secure storage may not respond due to docker inspect hanging.
CSCvu76926 Unable to activate the EI application due to USB storage mapping being mandated.
Next