Modules Management
Last updated on 18 April, 2023You can do the following to keep your modules up-to-date at all times:
- Install module updates: An update is a new version of a module. LogicMonitor recommends having the most-up-to-date modules installed. When you install an update, be aware that it overwrites the existing installed version. The Preservations feature allows you to install the update while preserving customized sections of your module.
- Edit an existing custom module: You can edit modules using the module editor. You access the module editor from My Module Toolbox. You can edit, test, and save module information such as AppliesTo and Collector scripting.
Note: The LogicModule editor is currently available for PropertySources, AppliesTo Function, and SNMP SysOID Maps. For the other LogicModule types, you are directed to the Settings page.
- Delete a module: Permanently deletes a module you no longer need from LogicMonitor’s My Module Toolbox.
Installing a Module Update
- In the LogicMonitor navigation menu, select Modules.
- From My Module Toolbox, navigate to the module that you want to update. For more information, see Modules Overview.
- From the Status column, select Update.
An update window appears, which displays a side-by-side comparison (read only) of the installed version and the new version. - After you review and compare the versions, you can do one of the following:
- Skip the update to retain the current installed version of the module.
- A final review to advance to the Preservations window.
- Use the Preservations options to retain or overwrite module settings:
- When the toggle is off, the new module setting will override the installed version.
- When the toggle is on, the existing setting is preserved.
You can preserve settings for Active Discovery filters, AppliesTo, Collection Interval, Discovery Interval, Display Name, and Group.
- To install the update, select Save.
Note: You can also update a module from the module’s details panel. For more information, see Modules Overview.
Editing a Custom Module
- In the LogicMonitor navigation menu, select Modules.
- In My Module Toolbox, select a module (row) to display the module’s details panel.
- From the details panel for the selected module, select the Edit icon to open the module editor.
- Make your edits in the module editor. For more information, see the documentation for the specific module:
- When finished editing, select Save.
- On the Update Reason window, enter a History Note, and then select Save.
The History Note is saved in the module’s local history. - On the Commit a Version window, enter the following information:
- Minor update or major update
- Version Note
- Make this version public
- Select Commit Version.
Deleting a Module
- From the LogicMonitor navigation menu, select Modules.
- In My Module Toolbox, select the module you want to delete.
- In the module editor pane at the bottom of the page, select the Delete icon.
- In the following Delete? prompt, select Delete.
The module is permanently deleted from My Module Toolbox.