Managing Device Group and Device Type Modules

Device modules add functions to devices, for example bandwidth graphs, reboot control, or server metrics. You add a device module to a device type group or to a device type. All devices of that group or type then show the module.

• A device group module applies to all device types in the device type group.
• A device module applies to one device type.

To add a module, refer to the article "Adding Device Group and Device Type Modules".

Open the modules of a group or a device type

1. Go to Settings > Device Types.
2. Click modules:

• On the row of a device type group, to see its device group modules.
• On the row of a device type, to see its device modules.

The Device Group Modules page or the Device Modules page opens. The table shows the ID, Enabled, Priority, and Module of each module.

Edit a module

1. On the Device Group Modules page or the Device Modules page, click edit on the row of the module. The Edit Device Group Module popup or the Edit Device Module popup opens.
2. On the Details tab, change the settings:

• Enabled: Set to NO to stop the module on all devices of the group or type. The module stays in the list.
• Priority: Select a value from 1 - Highest to 10 - Lowest. See How priority works.
• Module: Select a different module. When you change the module, the popup shows the settings of the new module.
• Client Access: Select No Access, View, or Edit. This setting controls what clients can do with the module in the client portal.

1. On the Config tab, change the settings of the module. Each module has different settings. If the module has no settings, the tab shows "There are no configuration options for this module".
2. Click Update.

How priority works

A device can get the same module from its device type group and from its device type. The device shows only one of them:

1. The module with the highest priority is used. 1 is the highest priority.
2. If the two modules have the same priority, the module of the device type is used.

For example, to use different settings for one device type, add the same module to the device type with the same priority, or a higher priority, as the group module.

Ubersmith uses only enabled modules. If you disable the module of the device type, the devices use the module of the group again.

Delete a module

1. On the Device Group Modules page or the Device Modules page, click delete on the row of the module.
2. The message "Are you sure you want to delete this device module?" shows. Click Yes.

Ubersmith removes the module from all devices of the group or type.

Custom device modules

You can write your own device modules. For examples, refer to Ubersmith Device Module Examples.

A device module is a PHP file with a name that starts with dm_, for example dm_example.php. To install a custom device module:

1. Copy the file to the custom device modules directory. On a standard installation, this directory is /usr/local/ubersmith/app/custom/include/device_modules/.
2. Recreate the Ubersmith containers:

   # cd /usr/local/ubersmith
   # docker compose rm -sf
   # ./ubersmith_start.sh

3. Add the module to a device type group or a device type. The module shows in the Module list.

For more information, see Ubersmith and Docker.