Download the PHP package dot-mike/nmscustomfields without Composer
On this page you can find all versions of the php package dot-mike/nmscustomfields. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dot-mike/nmscustomfields
More information about dot-mike/nmscustomfields
Files in dot-mike/nmscustomfields
Package nmscustomfields
Short Description LibreNMS plugin to add custom fields to devices
License MIT
Informations about the package nmscustomfields
nmscustomfields
nmscustomfields - A LibreNMS plugin package to add support for creating custom fields for devices.
Installation
Without Docker
Go to the LibreNMS base directory and run the following commands as librenms user:
With Docker
If you are using LibreNMS with Docker, you can install the plugin by customizing the Dockerfile.
Example Dockerfile:
Usage
To get started, open LibreNMS and enable the plugin by navigating to Overview->Plugins->Plugins Admin and enable the nmscustomfields
plugin.
Add and manage Custom Fields
Navigate to Overview->Plugins->Custom Fields Plugin to start adding custom fields that will be available for devices. Here you will also be able to manage the field values in bulk.
Editing Custom Fields for a Device
Navigate to a device page and you will see the custom fields section where you will find a link to edit the custom fields for the device.
Screenshots
API Documentation
The plugin also adds API endpoints to manage the custom fields for devices.
Devices
API
List Custom Fields
- Description: Retrieves a list of custom fields for a specified device.
- Parameters:
{device}
: The identifier of the device.
Show Custom Field
- Description: Retrieves details of a specific custom field for a specified device.
- Parameters:
{device}
: The identifier of the device.{customdevicefield}
: The identifier of the custom field.
Delete Custom Field
- Description: Deletes a specific custom field for a specified device.
- Parameters:
{device}
: The identifier of the device.{customdevicefield}
: The identifier of the custom field.
Update Custom Field
- Description: Partially updates a specific custom field for a specified device.
- Parameters:
{device}
: The identifier of the device.{customdevicefield}
: The identifier of the custom field.
Upsert Custom Field
- Description: Creates or updates a custom field for a specified device.
- Parameters:
{device}
: The identifier of the device.- Request body containing the custom field data.