Devices
The "Devices" screen is used to configure devices in the 'digital twin' of the network. Devices in this overview may be present in the network physically, or are planned and yet to be attached to the network (i.e. attached to a switch). From this screen users can create, view and manage devices in the site. This section of the documentation will explain how the "Devices" screen can be used to configure a network.
Columns
| Column | Usage |
|---|---|
| Hostname | The device hostname or description that will be applied in the switchport configuration. |
| MAC | The device vendor MAC-address (optional). |
| IP | The assigned IP-address for the device. |
| Profile | The assigned profile. |
| Group | The assigned group. |
| Switch | The assigned switch (optional). |
| Port | The port on the switch assigned to the device (optional). |
| Created | The date and time on which the device was created. |
| Updated | The date and time when the device was last updated. |
| Mutations | How many times the device configuration has been changed after creation. |
| Patch Port | The patch panel port on which the device has been patched (optional). |
| S/N | The device serial number (optional). |
| Notes | Notes for the device (optional). |
Adding a device
A device can be added by clicking the white and blue "plus"-icon in the top right corner.
A VLAN will be automatically assigned based on the profile and group, unless you have "unguided" mode currently enabled, in which case you are free to manually select any profile, group and VLAN.
Batch count
Use "Batch count" to add multiple devices with automated sequential numbering. The automated numbering works by appending the index of the device starting from 1 to the end of the hostname. Adding a device with the hostname of Camera and a "Batch count" of three will result in Camera1, Camera2, and Camera3.
The device screen
Clicking a device opens the device screen for that device. This screen displays all the relevant information for the device in the network and allows you to perform analysis and troubleshooting on the device.
Editing the hostname
To edit a device hostname, click the pencil next to the hostname in the top left corner.
Locking a device
Role
The lock_devices role is required to use this feature.
To lock a device (and make it immutable for users that do not have the lock_device role) click the padlock-icon in the top left block.
Duplicating a device
To duplicate a device (to quickly add multiple similar devices in succession for example) click the copy icon in the top left block.
Applying custom configuration
To apply custom configuration to this device that differs from the default configuration based on the device profile, click the customize button and enter the desired switch interface configuration.
Floor plans
If you have configured floor plans in your site, you can assign a device to a specific location using the widget in the top right corner.
Properties
To edit the device profile, group, MAC- or IP-address, click the 'pencil' in the top right corner of the 'properties' block.
Entity intents
Below the 'properties' block, users can find the entity intents that are available to them based on their permissions.
The following Entity intents are available to most users:
| Entity intent | Description |
|---|---|
| PROGRAM | Applies the latest configuration to the assigned switchport based on the device profile. |
| RESTART PORT | Applies shut and no shut commands to the switchport in succession. |
| STATUS | Gathers common troubleshooting information about the device from the network. |
| EXPERT | Gathers extensive troubleshooting information about the device from the network. |
| PING | Pings the device from the OSA (may not work due to lack of routes). |
| PING DIAG | Pings the device from the switch, thereby circumventing routing issues. |
Uploads
Uploads, such as configuration back-ups or images of the device, can be added via the "Uploads" block. Uploads can be hidden from users based on the required privilege level.
Details
Device details show the device metadata. Fields such as 'Serial Number' and 'Patch Port' can be edited in this section. It is also possible to add custom metadata fields to devices via the system settings.
Management
Revoke
Retract this device and effectively delete it from active configuration. Revoked devices can be viewed on the 'Devices' screen by clicking "Display" and then "Revoked only" or "Show all".
Mutations and events
View the audit log entries related to this device.
Inspection log
View the inspection alerts that have been generated for this device.
Syslog
View the Syslog entries related to this device.