Asset Manager User Guide

Transcription

1 Asset Manager User Guide Kinetic - Edge & Fog Processing Module (EFM Revised: May 9, 2018 Contents Asset Manager Overview... 2 Asset Manager Microservices... 2 Asset Discovery... 2 Asset Onboarding... 2 Accepting an Asset... 2 Rejecting an Asset in the Discovered Sensor list... 3 Deleting an Asset in the Rejected Sensor list... 3 Logging in to the Asset Manager... 4 User Interface Overview... 5 Sensor Page... 5 Onboarding Page... 7 Sensor Simulator Onboarding Configuration Sensor Onboarding Definition Asset Definition Onboarding example Asset Class Onboarding example Obtaining documentation and submitting a service request Cisco and/or its affiliates. All rights reserved. Page 1 of 17

2 Asset Manager Overview The Asset Manager is a microservices component of the of Cisco Kinetic EFM that detects and manages assets throughout the EFM message system. The Device DSLinks expose the assets which are required to have been specified using the Cisco EFM Device Object Model Standard structure to allow for auto-discovery. The resulting list of approved assets not only appears in the Asset Manager graphical interface, but also creates a node structure in the EFM data path that can be used as input for other applications. Each accepted asset can be found under the kinetic-efm-asset-dslink/assets, where the name is take from user defined Label. Labels need not be unique. Asset Manager Microservices During the Asset Manager installation process, two microservices or DSLinks are installed on the EFM message broker. The first is the kinetic-efm-asset-dslink, which is the Asset Manager itself. The second, the sensor-simulation, is for testing and demonstration purposes and generates virtual sensors that are published to the message broker. Since the sensor-simulator sensors are defined using the Cisco EFM Device Object Model Standard structure, they will be detected properly by the Asset Manager. The System Administrator can decide to disable or remove the sensor-simulator DSLink if desired. More details on the sensor-simulator can be found in the Sensor Simulator section. Asset Discovery The Asset Manager discovery is a continuous process. The Asset Manager queries the EFM message system for assets, devices or sensors that have been defined using the Cisco EFM Device Object Model Standard structure. When a new asset is found and it is not already in the Approved Sensor list nor the Rejected Sensors, it is placed in the Discovered Sensors list in the Onboarding section. Assets that have been deleted from the Rejected Sensors list can be re-discovered again, but may take up to 10 minutes to be processed. Asset Onboarding Once a new asset is discovered for the first time it is placed in the Discovered Sensors list. The Asset Manager Onboarding tab allows the user to view all new assets in block summary or a detailed list. Select the Discovered Sensor : option on the screen to view the new assets. The user can decide to accept or reject the asset by selecting the corresponding action. Accepting an Asset When accepting the asset, the detail page that shows the following attribute fields: Class Cisco and/or its affiliates. All rights reserved. Page 2 of 17

3 DSA Path S/N (Serial Number Label (User Defined TAG Vendor Product The Class, DSA Path and S/N are read-only fields. The Tags, Vendor and Product are read from the asset definition if they exist, but can be modified by the user. Tags is a custom text-based value useful for grouping and searching the assets, for example [Vibration] can be used for vibration sensors. The user must define a Label string that will identify the sensor by name. The Label string does not have to be unique. The Label Name will be the same node name that is created under the Assets path for the kinetic-efm-assets-dslink. Once the asset is saved, it is placed in the Sensors list and can be viewed by selecting the Sensors tab on the left pane. Rejecting an Asset in the Discovered Sensor list If an asset is rejected, it will be put into the Rejected Sensors list in the Asset Manager Onboarding tab. Once an asset is rejected it can be viewed by selecting the Reject Sensors option on the screen. A list of assets will appear below. Even after rejecting a sensor, the user can decide to accept a sensor or delete. When accepting the asset, it will be the same process as mentioned in Accepting an Asset above. Deleting an Asset in the Rejected Sensor list When deleting the asset, the Asset Manager loses all information. Only if the asset is discovered again will be placed into the Discovered Sensors list in the Asset Manager Onboarding tab. This process may take up to 10 minutes from the deletion. The discovery period is configurable in the applicationconf.json file (restartintervalminutes Cisco and/or its affiliates. All rights reserved. Page 3 of 17

4 Logging in to the Asset Manager When logging into the Asset Manager for the first time, it is necessary the user insert their username and password (as set during installation and click Login to continue. Figure 1. Asset Manager Login Cisco and/or its affiliates. All rights reserved. Page 4 of 17

5 User Interface Overview The user interface of the Kinetic - EFM Asset Manager contains two main pages. In the leftmost portion of the UI, a selector provides switching between 2 different views. The options are: 1. Sensors - All the approved assets or sensors appear in the Sensor page. This is the initial page when logging in. 2. Onboarding - The onboarding page shows all the discovered and rejected assets separately. The Discovered or Rejected Assets list selection is determined by the list selection in the page. Sensor Page Figure 2. Asset Manager and View Selection (Block Mode Cisco and/or its affiliates. All rights reserved. Page 5 of 17

6 1 View Selection pane 2 Asset List Title 3 Summary counts of assets 4 Search (when search is toggled ON. The arrow allows for selecting the attribute to search upon: All Fields Label Tags S/N Vendor Product 5 Block or detailed List display for assets (right 6 Ascending/Descending and Sort criteria: Label S/N Vendor Product 7 Username (left and logoff (right 8 Sensor List Selecting one of the options in the View Selection pane causes the graphical view to change. Figure 3. Asset Manager and View Selection (List Mode - see description table above Cisco and/or its affiliates. All rights reserved. Page 6 of 17

7 When a sensor detail is selected, the page will be updated with the details as follows. Figure 4. Sensor Detail The sensor detail allows for viewing the sensor attributes. But it also allows for editing on the Label, Vendor and Product fields. Select Save to store the information. Onboarding Page Cisco and/or its affiliates. All rights reserved. Page 7 of 17

8 Figure 4. Onboarding Assets - Discovered Sensors page 1 View Selection pane 2 Asset List Title 3 Summary counts of assets 4 Search (when search is toggled ON. The arrow allows for selecting the attribute to search upon: All Fields Label Tags S/N Vendor Product 5 Block or detailed List display for assets (right 6 Discovered Sensors or Rejected Sensors and Sort criteria: Label S/N Vendor Product 7 Username (left and logoff (right 8 Sensor List When a sensor is accepted, the following screen appears to fill all the sensor details. Tags, Vendor and Product can be updated, but the Label field must be defined Cisco and/or its affiliates. All rights reserved. Page 8 of 17

9 Figure 5. Onboarding Assets - Accepting a Sensor If a sensor is rejected, the following message will appear to confirm: Confirm Rejection Do you really want to reject this discovery entry? NOTE: This action will not delete the entry, but only mark it as rejected. It can be recovered later on. Once the Reject button is selected, the asset will move to the Rejected Sensors List Cisco and/or its affiliates. All rights reserved. Page 9 of 17

10 Figure 6. Onboarding Assets - Rejected Sensors page 1 View Selection pane 2 Asset List Title 3 Summary counts of assets 4 Search (when search is toggled ON. The arrow allows for selecting the attribute to search upon: All Fields Label Tags S/N Vendor Product 5 Block or detailed List display for assets (right 6 Discovered Sensors or Rejected Sensors and Sort criteria: Label S/N Vendor Product Cisco and/or its affiliates. All rights reserved. Page 10 of 17

11 7 Username (left and logoff (right 8 Sensor List A sensor can be accepted in the Rejected Sensors list or deleted from the Asset Manager. If it is accepted, then the same page as when Onboarding appears to fill in all the sensor details. Tags, Vendor and Product can be updated, but the Label field must be defined. If a sensor is deleted, the following message appears to confirm: Confirm Delete Do you really want to delete this discovery entry? NOTE: This action will delete the entry permanently. It cannot be recovered. By selecting Delete the action is taken. Only if the asset is discovered again will it be placed into the Discovered Sensors list in the Asset Manager Onboarding tab. This process may take up to 10 minutes from the deletion Cisco and/or its affiliates. All rights reserved. Page 11 of 17

12 Sensor Simulator The sensor-simulation DSLink is an optional component of the EFM Asset Manager. It is used for testing and demonstration purposes and generates virtual sensors that are published to the message broker. Since the sensor-simulator sensors are defined using the Cisco EFM Device Object Model Standard structure, they will be detected properly by the Asset Manager. The System Administrator can decide to disable or remove the sensor-simulator DSLink if desired. By default, the sensor simulator performs the following: Generates 10 virtual sensors, 5 temperature and 5 vibration sensors The sensor update interval is every ms (milliseconds A sinus finishing time of 15 minutes The metrics for the sensor-simulator DSLink can be modified by the System Administrator tool or in the dataflow Editor under the sensor-simulator DSLink, but not in the Asset Manager. The following metrics are user definable and can be set to new values 1 : Simulated Temperature Sensor Count Simulated Vibration Sensor Count Sinus Finishing Time (in minutes 1 When the Simulated Temperature Sensor Count or Simulated Vibration Sensor Count is changed to a new value, a new series of simulator sensors with NEW serial numbers are created. This will appear as additional discovered sensors. The previous simulated sensors are not automatically removed from the Asset Manager, but may need to be purged if no longer in use Cisco and/or its affiliates. All rights reserved. Page 12 of 17

13 Onboarding Configuration Sensor Onboarding Definition When DSA sensors should be added to EFM there needs to be a definition how the node structure should be transformed to a normalized EFM sensor. Sensor onboarding definitions enable exactly this. There can be multiple onboarding definitions for the same target sensor schema definition. The EFM Asset Manager is an extensible component. It ships with the simulator link and the corresponding asset onboarding configuration file definitions. This serves as a working example and that can be used as a template. The EFM Asset Manager configuration files are place in the $EFM_ROOT/asset_manager/config/onboarding directory. Each sensor requires the two file definitions: - Asset Onboarding Definition for the sensor (describe the normalized sensor - Asset Class that corresponds to the specific sensor Definition (source DSLink mapping Asset Definition Onboarding example This file is a JSON formatted file that defines how an asset class is discovered and where it is placed into the broker data path. This is the example file asset_onboarding_definitions_temperaturesensor.json. The highlighted fields are the values that are user configurable. Note that if a sensor has been discovered with an existing asset onboarding definition, modification of the asset definition file is not recommended. Rather it is recommended a new instance be created. Only the values in RED can be updated. [ { "label": "Simulated Temperature Sensor Onboarding", "sourcedslinkdevicetype": "cisco-kinetic-efm-simulation-sensors-temperature_sensor_v1", "assetclassid": "cisco-kinetic-efm-simulation-sensors-temperature_asset_v1", "productimageref": "/static/images/products/generic-temperature-sensor.svg", "primarykey": { "serial": "/$sysid" }, "defaultvalues": { "vendor": "Cisco", "product": "Simulation Link" }, "discoveryqueries": [ { "type": "DQL", "value": "option traversebrokers=true list * filter $sysdevicetype=\"e0d47f ec bf48ebc\"" } ], Cisco and/or its affiliates. All rights reserved. Page 13 of 17

14 ] } "dataflow": { "temperature": { "type": "write-through-dataflow", "config": { "path": "/environment/temperature/:value" } } } A sensor onboarding definition contains a label for identifying purpose. The field assetclassid defines the sensor type, which the sensor onboarding definition finds. As a method of finding assets is where several discoveryqueries are used. They are defined as an array of Discovery Configs, which describe how to find an asset in DSA. The primarykey holds the paths in DSA to the unique identifying field values for the defined assetclassid. The config item dataflow defines the mapping of metric fields from DSA to EFM. The field productimageref is used to reference a UI icon that will be shown when displaying onboarding entries (placed in the nginx directory. Default dimension values for onboarded sensors can be defined in defaultvalues. The field sourcedslinkdevicetype has to define a unique value that represents the given source DSLink in its target version. Therefore, sourcedslinkdevicetype and assetclassid define what DSLink source sensor will be onboarded into which sensor schema definition. Asset Class Onboarding example This file is a GraphQL formatted file that defines how an asset class is discovered and where it is placed into the broker data path. This is the example file asset_class_temperaturesensor.graphqls. The highlighted fields are the values that are user configurable. Note that if a sensor has been discovered with an existing asset onboarding definition, modification of the asset class definition file is not recommended. Rather it is recommended a new instance be created. Normalized sensors are described by a schema. The schema defines the dimension and metric fields and their value scopes. There are some fields like id or label that all sensors share and can be generalized to an abstract sensor base type. The sensor schema definition needs a serialized format because adding of new schemas is expected to work at runtime. Only the values in RED can be updated. # Simulated Temperature sensor type SimulatedTemperatureSensor implements Asset, id: "cisco-kinetic-efm-simulation-sensors-temperature_asset_v1" label: "Simulated Temperature Sensor" { # Asset ID id: label: "ID" isrequired: true access: INTERNAL # Asset type ID Cisco and/or its affiliates. All rights reserved. Page 14 of 17

15 assetclassid: label: "Asset Class ID" isrequired: true issearchable: true access: INTERNAL # Asset onboarding ID assetonboardingid: label: "Asset Onboarding Id" isrequired: true issearchable: true access: INTERNAL # Broker configuration for asset nodeconfig: label: "DSLink Node Configuration" isrequired: true access: INTERNAL # Human readable label for sensor asset label: label: "Label" isrequired: true issearchable: true path: ":displayname" # Tags tags: label: "Tags" isrequired: false issearchable: true access: RW path: "$systags" # Sensor serial number serial: label: "S/N" isprimarykey: true issearchable: true path: "$sysserial" # Sensor vendor name vendor: label: "Vendor" isrequired: false issearchable: true access: RW path: "$sysvendor" Cisco and/or its affiliates. All rights reserved. Page 15 of 17

16 # Sensor product name product: label: "Product" isrequired: false issearchable: true access: RW path: "$sysproduct" } temperature: label: "Temperature", unitname: "degree Celcius", unitsymbol: " C", path: "/temperature/:value" Note that the following definitions must match the corresponding values from the Sensor Definition file to the Asset Class. asset_onboarding_definitions_temperaturesensor.json "label": "Simulated Temperature Sensor Onboarding", "assetclassid": "dataflow": { "temperature": asset_class_temperaturesensor.graphqls type SimulatedTemperatureSensor implements Asset, id: temperature: Float All changes to onboarding configuration files require restarting the EFM Asset Manager for changes to be read Cisco and/or its affiliates. All rights reserved. Page 16 of 17

17 Obtaining documentation and submitting a service request For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at: Subscribe to the What s New in Cisco Product Documentation as a Really Simple Syndication (RSS feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. 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 Cisco and/or its affiliates. All rights reserved. Page 17 of 17