Creating Devices

Much like creating device types or sites, you can both individually input devices or use the Komodo Eye®’s bulk upload feature. If you haven’t already done so, you will need to have created the associated sites and device types prior to adding in any new devices. You don’t need to have created device probes for the devices at this point, as those can be added to, or changed within a device type at any time.

Navigating to the Devices

1. Select "Administration"

2. Select "Devices"

3. Select the "Device List" sub-menu.

4. You can now see a complete list of all the monitored devices. At the top, select the "Add Equipment" button.

5. This will now open up a device creation screen. From here you can opt to set up an individual device, or continue on to the bulk add feature to quickly set up a variety of devices to be monitored by the application.

Individual Device Creation

To add a new device, you will need to have a few things:

Field Name	Definition
Location*	The location is the site that has previously been defined in the application. You will be required to select a site from the list. If you don’t have a site defined for the new device, you will need to create the site prior to proceeding with the device set up.
Device Type*	The device type has been previously set up in the application. You will be required to select a device type from the list. If you don’t have a device type defined for the new device, you will need to create the device type prior to proceeding with the device set up.
Note on Device Types: If you select a device type that has SNMP enabled through the device type, you will be given 3 additional fields. The first will have you select the SNMP profile that you have previously set up (see the Setting Up Your SNMP Profiles section), if you select an existing SNMP profile, all of the credentials of that profile will be used with the device you are creating. If you opt to directly add a profile to the device, first select the SNMP version, and input the information into the required fields that are associated with V1, V2c, or V3.
IP*	You will need to provide the IP address for the device that you are adding into the application.
Hostname*	The host name is the user-defined name that you will assign to the device, and isn’t necessarily the hostname that is defined by the device hardware or software. This will likely be associated with a new or existing naming convention that your organization uses.
Serial Number	This would be the serial number found on/with your device that you can optionally add into the system.
Latitude	The latitude of the device, if left blank, the device will inherit the latitude of the site to which it is assigned, if that has been defined. Latitude must be a number between -90 and 90
Longitude	The longitude of the device, if left blank, the device will inherit the longitude of the site to which it is assigned, if that has been defined. Longitude must be a number between -180 and 180.
Suppress Alerts	You can opt to suppress alerts for specific devices. This can be turned on/off at any time for all devices found within the application.

*Required Fields

Once you have filled in the required and any optional fields that you choose, you can select the “Save” button at the bottom of the form. Your new device will now show up in the device list. If everything was set up correctly, you should be able to navigate back to your device from the device list, or refresh the page, and you will be able to see a series of new menu options on the right side, in addition to graphs (latency, loss, jitter, etc.) that will begin to populate with data.

Bulk Device Creation

Bulk device creation uses the same fields within a .csv that are found in the single device creation screen (and outlined above). To do the bulk add for devices, there are a few extra steps to gather data from the system before you are able to successfully bulk add new devices into the application. The primary reason that SNMP profiles, sites, and device types are created first is that they will generate a unique id string. These strings will need to be used in the corresponding fields for the bulk device upload. If you use the display name, the bulk add function will error-out all of the device rows.

If you wish to input individual SNMP profile information for each device, you will also need your SNMP credentials on hand to add into the bulk add spreadsheet. Devices that are associated with device types that have SNMP enabled will be required to have the id for existing SNMP profiles, or the individual credentials. If you are individually adding profiles to the spreadsheet, the bulk add template has provisions for all of the different types of SNMP that are available.

Where to Find SNMP, Site, and Device Type IDs

You will need to navigate to both the Site and Device Type lists to find the IDs, which are toggleable list fields. They are both found underneath the Administration menu. The process for finding the IDs is identical for both the sites and device types, and will be demonstrated with the sites list.

1. Navigate to either the "Sites" or "Device Type" lists.

2. Select the "Column" icon/text to the right of the list of sites or device types. This will open a menu where you can toggle data columns for the list.

3. From the list in the "Columns" menu, select the "Id" box so that a blue check mark appears.

4. After it has been selected, close the "Columns" menu by selecting the same text/icon that was used to open it up.

5. Scroll the list to the right and you will find the "Id" heading with a list of the unique strings associated with each site or device type. From here you can either copy/paste directly from this list, or export the list as a .csv or an Excel file.

6. To export the list, navigate to the bottom right corner of the screen and select the desired export format. The download will automatically initiate once it is selected.

Creating and Uploading the Device Bulk Add

Once you have the site and device type Ids, and the necessary SNMP credentials for all the devices that are to be uploaded, you can begin the process of putting together the bulk add spreadsheet.

1. Starting on the device creation page, select the "Bulk Add" button located at the bottom of the form.

2. Once the bulk add screen is loaded, select the "Download Template" button. A .csv template file will download.

3. The bulk upload spreadsheet contains virtually the same information that is found on the UI form, but comes with some minor complexitiesbelow is a table that explains each of the fields and provides example data for each one.

Important Note: when you are ready to upload your bulk add devices, delete the top explanatory rows above the headings to guarantee a successful upload.

Column Name	Definition	Example
hostname*	The hostname is the user-defined name that you will assign to the device, and isn’t necessarily the hostname that is defined by the device hardware or software. This will likely be associated with a new or existing naming convention that your organization uses.	Site Router 1
locationId*	The locationId is the site that has previously been defined in the application. You will be required to use an existing site id, which is a string of letters and numbers. If you don’t have a site defined for the new device, you will need to create the site,and get the id prior to proceeding with the device set up. This process is covered in the previous section.	63a92509-00ff-4181-8ee9-bc3c69f0473b (NOT the display text, for example Network Site 1)
equipmentTypeId*	The equipmentTypeId is the device type that has previously been defined in the application. You will be required to use an existing device type id, which is a string of letters and numbers. If you don’t have a device type defined for the new device, you will need to create the device type and get the id prior to proceeding with the device set up. This process is covered in the previous section.	eedcf91c-8e66-4f86-a4b2-d4181cc4e362 (NOT the display text, for example Ubiquiti CPE)
ip*	You will need to provide the IP address for the device that you are adding into the application.	127.0.0.1
latitude	The latitude of the device, if left blank, the device will inherit the latitude of the site to which it is assigned, if that has been defined. Latitude must be a number between -90 and 90	39.75756783
longitude	The longitude of the device, if left blank, the device will inherit the longitude of the site to which it is assigned, if that has been defined. Longitude must be a number between -180 and 180.	-78.65234523
barcode	This would be the serial number found on/with your device that you can optionally add into the system.	123-45-6789
serviceType	You can opt to suppress alerts for specific devices. This can be turned on/off at any time for all devices found within the application. To have the alerts suppressed, type in maintenance into the corresponding field. For this to be marked as “false” or for alerting to happen, use “--” in the field.	-- (allowing alerts)
Note on SNMP: If you select a device type that has SNMP enabled through the device type, you will need to fill in the appropriate SNMP profile information for that particular device. It may be useful to keep your devices grouped by SNMP profiles to make this easier to implement in the bulk add spreadsheet. When it comes to adding SNMP profiles you have 2 options, you can select from SNMP profiles that you have previously created. This will be similar to sites and device types, in that you will need to locate the id for each profile that is input into the application. The second option is to individually enter the profile information. Each different version of SNMP (version 1, 2c, and 3) will require different fields, and the others will be left blank.
snmpProfile (Preferred method)	If you have previously input your SNMP profiles into the application, you can find the Id string for each of the profiles and insert it into the corresponding field under this heading.	df4b7268-0b76-4743-92c7-6dbe6b0c329f
snmpVersion	You will need to indicate what version of SNMP with a 1, 2c, or 3.	3
snmpCommunity	This is the password that is associated with SNMP versions 1 or 2c.	passwordsrule123
snmpUsername	This field is only used for SNMP V3. You will need to have the Username input into the corresponding field.	usersnmpV3
snmpAuthProtocol	This field is only used for SNMP V3 to determine the Authentication Protocol. You can only use MD5, SHA, or noAuth in this field.	SHA
snmpAuthProtocolPass	This field is only used for SNMP V3. You will need to input your authentication password.	greatpassword321
snmpPrivacyProtocol	This field is only used for SNMP V3 to define the privacy protocol. You much use either AES, DES, or noPriv in this field.	AES
snmpPrivacyPass	This field is only used for SNMP V3. You will need to input your privacy password.	bestpassword213
snmpContext	This field is only used for SNMP V3 and provides user-defined contextual information for the particular profile.	Interesting or useful information about the profile.

*Required Field

4. After you have populated and edited the bulk add spreadsheet, select the "Choose File" option and select the spreadsheet that you created.

5. The file will populate on the screen, if there are a large number of devices, it may take a few moments to do this. If everything matches up well, all of the fields will remain neutrally colored. Of note, the Site ID and Device Type ID both are using the string IDs and NOT the plain text display name for the associated site and device types.

6. Alternatively, errors with the bulk add, which in this case is the "Site ID" and "Device Type ID" fields using the display text, will be highlighted and the errors will be noted in the "Row Status" column. You can download the list as a .csv or Excel file using the buttons in the bottom right corner, allowing you to fix the identified errors.

7. Once you have successfully added all of the devices using the bulk add, you can select the "Save" button in the bottom left corner and your devices will be added to the applications device inventory. You will need to verify that the devices were properly uploaded and are responding by going through the list and performing a check.