2.6.2. User Devices

In the User Devices section, we can find all the information regarding user devices (End Point devices) that we have already registered, and the ones that the OpenNAC Enterprise has discovered.

../../_images/userdevices_overview.png


The User Devices tab features the following columns:

  • MAC address: Shows the user device’s MAC address.

  • Name: Shows the name of the user device.

  • Last policy: Shows the last policy for the specific user device.

  • Owner: Shows the user device owner.

  • Type: Shows the user device type.

  • Details: Shows a shortcut that redirects to Analytics -> Discover filtering the events for the MAC of that user device.

  • Tags: Shows a bar with the number of tags of each type assigned to the device.

  • i: Expands the information.

../../_images/ud_more.png


2.6.2.1. Top menu

We can see the following option on the top menu:

  • Add new: Allows to add a new user device.

  • Edit: Allows editing a single user device.

  • Bulk edit: Allows editing a group of user devices.

  • Delete: Allows to delete the user devices selected.

  • Refresh: Allows to refresh the view.

  • Export data: Allows to export the policy rules in JSON format.

  • Import data: Allows to import data from a JSON or XML file. This can be done over an entire page or after filtering the data.

  • Tags: Used to search devices by partial or complete tag. Tag list or regular expression are not supported.

../../_images/ud_tag.png


  • Filters: Allows to search devices on the selected business profile with predefined or custom filters such as IP, MAC, and policy.

../../_images/ud_filter.png


2.6.2.2. Add new

To register a new User Device, click the Add new button. A popup window will be displayed with all the parameters that need to be filled in.

2.6.2.2.1. Device info

In this section, we can configure some of the parameters for the device. The mandatory parameters are the IP, Brand, and Model. The other parameters will be useful to complete the device information.

../../_images/userdevices_deviceinfo.png


  • Name: The user device name that we want to assign.

  • Owner: The owner of the user device. This field is used by BYOD use cases (Bring your own device).

  • Vendor: The hardware vendor of the user device.

  • Model: The model of the user device hardware.

  • Version: The version of the user device

  • Type: Type of user devices. This can be a host or a phone device.

  • Comment: This can be used to include useful information to identify user devices.

Also we can find all the information regarding the different tags that we can associate with the network devices:

  • Profile tags: Shows information about its profile.

  • Security tags: Shows information about its security posture.

  • Process tags: Shows information about user devices processes.

  • Application tags: Shows information about application installed.

  • Network tags: Shows network information about the user device gathered with OpenNAC Enterprise.

  • Custom Tags Shows all the customized tags.

  • Other tags: Shows other type of tags.

2.6.2.2.2. MAC addresses

In this section, we can configure a MAC or multiple MACs associated with the user device. The MAC is one of the most important parameters as it is used to refer to the user devices in the Logs and in most of the tool modules. Also, if we are using the OpenNAC Enterprise Agent, it can automatically group different MACs associated with a user device.

../../_images/userdevices_macaddress.png


2.6.2.2.3. Custom fields

In this section, we can configure other parameters that are not already defined in the previous sections. You can define any parameter and its desired value by clicking on the Add new button. This will allow us to implement filters to find our device by the custom parameters that we define.

../../_images/userdevices_customfields.png


2.6.2.3. Bulk edit

The Bulk edit allows you to modify multiple user device entries at the same time. To open the features window shown below, go to the upper menu of the User Devices tab, and find the Bulk edit button:

../../_images/bulk_edit.png


2.6.2.3.1. General

This section shows the number of user device that we are editing compared to the total number of user devices.

2.6.2.3.2. Edit properties

In this section, we can edit the properties for the user devices selected. It displays two tabs, the Device info and the Custom fields.

Note

Removed properties will be ignored.

2.6.2.3.2.1. Device info

You edit the device information in the following fields:

../../_images/ud_di.png


  • Name: The user device name that we want to assign.

  • Owner: The owner of the user device. This field is used by BYOD use cases (Bring your own device)

  • Vendor: The hardware vendor of the user device.

  • Model: The model the user device hardware.

  • Version: The version of the user device

  • Type: Type of user devices. This can be a host or a phone device.

  • Comment: This can be used to include useful information to identify user devices.

Also we can find all the information regarded to the different tags that we can associate to the network devices:

  • Profile tags: Shows information about its profile.

  • Security tags: Shows information about its security posture.

  • Process tags: Shows information about user devices processes.

  • Application tags: Shows information about application installed.

  • Network tags: Shows network information about the user device gathered with OpenNAC Enterprise.

  • Custom Tags Shows all the customized tags.

  • Other tags: Shows other type of tags.

2.6.2.3.2.2. Custom fields

In this tab, we can configure other parameters that are not already defined in the previous tabs. You can define any parameter and its desired value by clicking on the Add new button. This will allow us to implement filters to find our device by the custom parameters that we define.

../../_images/ud_cf.png


2.6.2.3.3. Remove properties

It is possible to delete different properties for the user devices selected:

../../_images/ud_rm.png


  • Owner: Allows deleting the owner.

  • Vendor: Allows deleting the vendor.

  • Model: Allows deleting the model.

  • Version: Allows deleting the version.

  • Comment: Allows deleting the comment.

  • Tags: Allows deleting multiple tags.

  • Custom fields: Allows deleting multiple custom fields.

2.6.2.4. Script to update tags

There is a script that allows adding and removing tags from USER DEVICES. Apply it when it is necessary to deal with large volumes of devices and tags. We will use a CSV file to specify the MAC address of the user device(s) and the tag(s) that we want to add or remove. We can also remove tags on a “large scale” according to the prefix of a tag (ONC,LBD,etc.). In this case, we will remove the tags that contain a specified prefix.

The script is the following:

/usr/share/opennac/utils/scripts/userdev_mod_tags.php

For more information about the script check the userdev_mod_tags.php section: