Creating Device Types

The first process is to define device types. The Komodo Eye® uses device types much like another NMS would have a monitoring template for their devices. Device types, coupled with device probes (covered later in the guide) creates highly customizable means to organize and gather targeted data from the desired subset of devices. Before proceeding with creating sites and uploading devices, it is critical to define the device types within your instance of the application. This can be done individually (i.e., one at a time), or through a bulk upload using a provided spreadsheet that is downloaded directly from the application. Defining device types before creating and uploading network devices contributes to a smooth and accurate implementation.

Suggestion for Easier Implementation: As you are preparing your device types, you can utilize

Navigating to Device Types

To input both individual and bulk add device types you will navigate to the same area of the application.

1. Select "Administration"

2. Select "Devices"

3. Select "Device Types"

4. Select "Add Device Type" to create a new device. You can also select an existing device type from the list to edit the details.

5. Once you have selected the “Add Device Type” option, you will be taken to a screen that displays a series of fields and options that can be selected and filled in. Additionally, an option to “Bulk Add” devices is found below the fields.

A Note on the Navigation: when you navigate into individual elements of your network, such as device types, devices, probes, etc…, Komodo Eye will display a menu to the right. This menu offers the option to delve further into the element that you are viewing, or the option to navigate back to the main list/directory. Alternatively, you can use your browser buttons to navigate back and forth between the pages in the application that you have visited.

Creating an Individual Device Type

You can create a new device type by filling out the form shown above. Below is a description of each field and option. Not all fields are required to be filled in.

Category	Field/Option	Description/Use	Example
Device Details	Device Type Name*	This is a user defined device type name that the system will use across all of its tables, lists, devices, etc. This can accommodate existing network naming conventions for your organization.	Ubiquiti End Point 1
	Manufacturer	The manufacturer of the device type.	Ubiquiti Networks
	Device model.	Device model.	AirFiber 5XHD
	Icon	You can select an icon that will be used when presenting devices on lists and maps to aid in quick visual identification of device types.
	Description	This is a brief description of the device type. This can often outline the use of the device within the network.	A brief description.
Means of Data Collection and Access*	SNMP	Enables/disables SNMP for this device type.	On
	Messages (Syslog/Traps)	Enables/disables syslog/traps for this device type.	Off
	SSH	Enables/disables ssh for this device type.	Off
	Telnet	Enables/disables telnet for this device type.	Off
	HTTP	Enables/disables HTTP access for this device type.	Off
	HTTPS	Enables/disables HTTPS access for this device type.	On
Alert Thresholds*	Latency (ms)	Set the maximum latency for this device type in milliseconds. The default is 100 ms.	100
	Loss (%)	This is the maximum loss presented as a percentage. Enter a value between 0 and 100.	100%
	Ping Type	You have the option of selecting the ping “type” to be used with the device type you are defining. The first is a jitter graph that updates every 30 seconds. The second is what we refer to as a “slow pinger,” which is great for low-bandwidth environments, such as SCADA networks. This will send out a small packet every 5 minutes, which aids in keeping network utilization for monitoring very low.	Jitter
	Max Ping Attempts	This is the maximum number of pings before a state change/alert is triggered. The system default is set at 3.	3

* Required

Once you have filled in the form, you can select the “Save” button at the bottom of the form. Once saved, you can navigate back to the Device Type list and you will be able to see your newly created device type. While the basic device type has been created, probes and alerts will later be defined and added to the device type, enabling deeper monitoring of the associated devices.

Bulk Adding Device Types

If you have a large number of devices that you are setting up the Komodo Eye® to monitor, the built in Bulk Add feature will help you efficiently and accurately upload your device types using the application-supplied template.

1. The "Bulk Add" is located on the Device Type creation screen, as shown below.

2. Select the "Bulk Add" button

3. Select the "Download Template" button at the top of the screen. This will automatically initiate a download of a .csv template that can be filled out.

3. The CSV that is downloaded has a few more field options available than what is found on the individual device type creation screen. Below is a table showing each of these fields with a description and example of their use.

Column Name	Definition	Example
name*	This is the user-defined name for the device type.	Ubiquiti End Point 1
description	This is a brief description of the device type. This can often outline the use of the device within the network.	A brief description of this device type and its use.
manufacturer	The manufacturer of the device type.	Ubiquiti Networks
model	Device model.	AirFiber 5XHD
pingType	You have the option of selecting the ping “type” to be used with the device type you are defining. The first is a jitter graph that updates every 30 seconds. The second is what we refer to as a “slow pinger,” which is great for low-bandwidth environments, such as SCADA networks. This will send out a small packet every 5 minutes, which aids in keeping network utilization for monitoring very low. Use Jitter-30 in this field for standard monitoring and LowBandwidth for the slow-pinger option.	Jitter-30
maxLatency	Set the maximum latency for this device type in milliseconds. The default is 100 ms.	100
maxLoss	This is the maximum loss presented as a percentage. Enter a value between 0 and 100.	1
maxPingAttempts	This is the maximum number of pings before a state change/alert is triggered. The system default is set at 3.	3
icon	You can select from a variety of icons that will help you visually distinguish your device type in the lists and on maps within the application. Below this table is another containing a list of the icons with their name that can be input into this field. If no icon is selected, it will default to the standard fa-map-marker icon:	go_wifi_2
Below are the connection and data sharing options available to the device type. Select which are to be used by using “True” (enabled) or “False” (disabled).
telnet	Enables/disables telnet for this device type.	False
web	Enables/disables web access for this device type.	False
ssh	Enables/disables ssh for this device type.	True
ssl	Enables/disables ssl for this device type.	False
snmp	Enables/disables SNMP for this device type. Note: SNMP needs to be enabled for a large majority of the data collection that the Komodo Eye® handles. As you set up your devices, make sure that all of your SNMP enabled devices have this option set to true.	True
traps	Enables/disables syslog/traps for this device type.	False

*Required Field

Below is a list of all of the available icons and their names that can be used with the bulk add spreadsheet.

Icon Name	Icon Image	Icon Name	Icon Image
go_antenna		go_wifi_2
go_ap_generic_1		go_wireless_router
go_ap_generic_2		go_wireless_router_firewall fa-asterisk
go_atm_switch		fa-building
go_bras		fa-circle
go_ethernet_switch		fa-flag
go_firewall		fa-home
go_multi_layer_switch		fa-map-marker
go_ptmp_sector_1		fa-map-signs
go_ptmp_sector_2		fa-print
go_router		fa-server
go_router_firewall		fa-shopping-cart
go_switch_generic		fa-tree
go_tower		fa-university
go_wifi_1		fa-user
fa-asterisk

4. Once you have filled out your template with all of the device types you wish to add, save the template and select the "Choose File" option at the top of the "Bulk Add Device Types" screen.

5. Now that you have found the file and selected it, the template file will be imported into the application. Any errors with the formatting of the device types in the template will be highlighted, as shown below.

6. Should you wish, you can download the device type list again, with the "Row Status" column, which will assist you in quickly finding errors within your device type list. Once you have remedied the issues, you can refresh and reupload your file.

7. Once you have successfully uploaded your devices through the bulk add without any errors, select the "Save" button. Your new device types will now be visible on the main list of device types and ready for the next steps of setting up your network for monitoring using the Komodo Eye®.