Manage USB Devices Using Fleet

Objective
Prerequisites
Configuration
Apply USB Device Policy Using Fleet
Concepts
API References

Objective

This guide provides instructions on how to manage USB devices for your sites using fleet configuration via VoltConsole. See Fleet for conceptual details of the fleet.

You can enable or disable access to USB devices for your sites via the fleet configuration. By default all USB devices are denied in the fleet and you can either allow all or attach USB device policies to manage specific devices. You can also create USB device policy from within the fleet configuration.

Using the instructions in this guide, you can update fleet configuration to enable or disable access to all or specific USB devices for your sites that are part of the fleet.

Prerequisites

A valid Volterra Account is required.

Note: In case you do not have an account, see Create a Volterra Account.

One or more Volterra Sites. See Site Management for more information.
Volterra fleet with the sites added to this fleet. See Create a Fleet for more information.

Configuration

The following video shows creating a fleet with the required network configuration and applying to your gateways:

Apply USB Device Policy Using Fleet

Log into the VoltConsole and perform the following:

Step 1: Navigate to fleets and start editing fleet configuration.

Select Manage from the configuration menu in the system namespace. Select Site Management -> Fleet from the options.

Click ... -> Edit for the fleet through which you want to manage USB devices.

Step 2: Start configuring USB device policy.

* Go to `Advanced Configuration` section and enable `Show Advanced Fields` option.

Select an option for the USB Device Policy field and perform configuration as per the following guidelines:
- Select Deny All USB Devices to deny all USB devices for your sites. This is selected by default.
- Select Allow All USB Devices to allow all USB devices for your sites.
- Select USB Device Policy to apply an existing USB device policy or create a new one.

This example creates a new USB device policy from within fleet configuration and applies it to fleet.

fleet adv usb — Figure: Fleet USB Policy

Click Create new usb policy in the options for the USB Device Policy field. This opens the USB device policy creation form.

Step 3: Create a USB device policy.

Enter a name for the USB device policy in the metadata section.
Go to Allowed USB devices section and configure the fields as per the following guidelines. You can enter any one field or combination of fields.
- iSerialNumber - Enter index of serial number for your device
- Vendor ID - Enter the device vendor identifier.
- Product ID - Enter the device product identifier assigned by the manufacturer.
- Class - Enter the device class.
- Subclass - Enter the device subclass.
- Protocol - Enter the protocol for this device.

This example creates a policy with the vendor identifier.

usb pol new — Figure: Creation of USB Device Policy

Note: You can add more than one device using the Add item option.

Click Continue to create the policy and apply it to the fleet configuration.

Note: You can obtain the USB device properties using the site dashboard for your site. Navigate to Sites -> Site List in the system namespace, click on your site to open its dashboard, and click on the Tools tab. Select Show USB devices option for the Select tool field. Select a node from the list of the Node name field.

Step 4: Complete updating the fleet configuration.

Go to Enable Default Fleet Config Download section and enable Show Advanced Fields option.
Click on the Enable Default Fleet Config Download checkbox.