Create Devices¶
There are a few ways to create a device: 1. Add a device manually from the frontend GUI 2. Import a device from a CSV file, using the frontend GUI 3. Import a device from ISE 4. Add a device using the API calls directly to the Device Portal backend
From the Devices page, a list of all available devices are shown, and it is possible for users and administrators to Add or to Import new devices.
Note
Administrators of the Device Portal can create and see devices in all device groups, while users of the Device Portal only can add and see devices in the device groups they have been granted access to by the Administrator.
A device has the following parameters:
- MAC-address
the mac-address of the device is the unique identifier for the device
mac-address can be entered in either lowercase, uppercase or a combination, using : - or . as seperator. Same seperator must be used in all places.
valid formats are: 11:aa:bb:22:cc:44 , 1234.abcd.56EF , 123456789abc
- Name
the name is used as extra identifier for the device. It can not contain any characters or numbers.
- Asset ID
the asset ID is a free text field to hold any asset identifications
- Description
the description is a free text field to describe the device
- Device Group
holds the name of the device group this device is associated with
- Key Type
This field defines the device authentication setting
device : the device has has a iPSK Key
group : the device uses the device group defined group PSK Key
mab : the device is a wired device using MAC Authentication Bypass (MAB)
- Device iPSK Key
holds the devices iPSK key
- Expiry Timeout
the field is controlled by the application configuration setting “Enable Expiry Timeout”. If this is enabled then the expiry timeout is available for the device
the expiry timeout date and clock is by default set based on the device groups default expiry timeout, but can be manually overridden.
- Idle Timeout
the field is controlled by the application configuration setting “Enable Idle Timeout”. If this is enabled then the idle timeout is available for the device
the default idle timeout is by default set based on the device groups default idle timeout, but can be manually overridden.
- Quarantine device
parameter which controls if this device is quarantined or not
MAC-address and Device Group are mandatory fields which must be used when creating a device.
Add device¶
When the “Add device” button is selected, you will create a device by manually entering the devices information.
Import from CSV¶
When the “Import from CSV” button is selected, you will be presented with a file selection dialog box where you can select a valid .csv file. The .csv file must use comma (,) as seperator between the fields, and must have at least the mandatory device fields, mac-address and device-group configured for all devices. The .csv file is made up of a header line which should hold the device field keywords, and then a line for each of the devices which should be imported.
Header field |
Header type |
Data field |
Data example |
|---|---|---|---|
mac_address |
mandatory |
formatted as a mac-address |
aa:bb:11:22:cc:44 |
device_group |
mandatory |
name of the device group |
camera-group |
name |
optional |
text, no space or country specific characters |
myname |
description |
optional |
text, free text field |
this is a description |
psk |
optional |
text, 8 - 63 characters |
mySecretKey123 |
pw_type |
optional |
keyword to indicate the psk type |
device | group | mab |
quarantine |
optional |
boolean |
true | false |
asset_id |
optional |
text, free text field |
myname |
idle_timeout |
optional |
number, 0 - 9999 |
90 |
expires |
optional |
ISO formattet date field |
2021-09-09T21:00:00+00:00 |
A example of a .csv file is shown here:
mac_address,device_group,description
22:bb:cc:33:44:55,camera-group,this is a camera device
Note
The API section contains a complete listing of the fields used by the CSV import. The fields for the devices of the API are those that can be used as header fields in the CSV file.