General

PowerShell module for accessing the LogicMonitor REST API.

This project is also published in the PowerShell Gallery at https://www.powershellgallery.com/packages/Logic.Monitor/.

Check out the full Logic.Monitor module documenation at: https://logicmonitor.github.io/lm-powershell-module-docs/

Community Contribution Notice: This PowerShell module is an open-source project created and maintained by LogicMonitor users. While not an official LogicMonitor product, it's designed by people who use and understand the platform.

The module is freely available for everyone to use, modify, and improve. We welcome your feedback and contributions! If you have ideas or encounter any issues, please share them through GitHub issues or pull requests.

Many community members rely on this module in their daily operations. Though we can't offer formal support guarantees, our collaborative community strives to address questions and continuously enhance functionality.

We hope you find this tool valuable for your LogicMonitor workflows!

Installation

• From PowerShell Gallery:

Install-Module -Name "Logic.Monitor"

Upgrading

• New releases are published often, to ensure you have the latest version you can run:

Update-Module -Name "Logic.Monitor"

General Usage

Before you can use on module commands you will need to be connected to a LM portal. To connect your LM portal use the Connect-LMAccount command:

Connect-LMAccount -AccessId "lm_access_id" -AccessKey "lm_access_key" -AccountName "lm_portal_prefix_name"

Once connected you can then run an appropriate command, a full list of commands available can be found using:

Get-Command -Module "Logic.Monitor"

To disconnect from an account simply run the Disconnect-LMAccount command:

Disconnect-LMAccount

To cache credentials for multiple portals you can use the command New-LMCachedAccount, once a credential has been cached you can reference it when connecting to an lm portal using the -UserCachedCredentials switch in Connect-LMAccount.

Cached credentials are stored in a LocalVault using Microsoft's SecretManagement module. If its your first time using SecretManagement you will be prompted to set up a password for accessing your cached accounts in the LocalVault using this method.

New-LMCachedAccount -AccessId "lm_access_id" -AccessKey "lm_access_key" -AccountName "lm_portal_prefix_name"
Connect-LMAccount -UseCachedCredential

#Example output when using cached credentials
#Selection Number | Portal Name
#0) portalname
#1) portalnamesandbox
#Enter the number for the cached credential you wish to use: 1
#Connected to LM portal portalnamesandbox using account

Change List

7.3.0

New Cmdlets:

• Get-LMDiagnosticSource: Retrieves LogicMonitor Diagnostic Sources by ID, Name, DisplayName, or filter. Supports pagination and returns objects of type LogicMonitor.DiagnosticSource.

• New-LMDiagnosticSource: Creates a new Diagnostic Source in LogicMonitor using a provided configuration object.

• Set-LMDiagnosticSource: Updates an existing Diagnostic Source. Supports updating by ID or Name, and only sends fields that are explicitly set. Special handling for the name field via the -NewName parameter.

• Remove-LMDiagnosticSource: Removes a Diagnostic Source by ID or Name.

• Get-LMServiceGroup: Retrieves LogicMonitor Service Groups by ID, Name, DisplayName, or filter. Supports pagination and returns objects of type LogicMonitor.DeviceGroup.

• New-LMServiceGroup: Creates a new Service Group in LogicMonitor.

• Set-LMServiceGroup: Updates an existing Service Group. Supports updating by ID or Name, and only sends fields that are explicitly set. Special handling for the name field via the -NewName parameter.

• Remove-LMServiceGroup: Removes a Service Group by ID or Name.

Updated Cmdlets:

• Get-LMLogicModuleMetadata: Added support for DIAGNOSTICSOURCE in the -Type parameter. Improved filtering logic for all parameters. Fixed bug with isInUser filtering not returning all results when omitted.

• Set-LMDatasource, Set-LMDevice, Set-LMDeviceGroup, Set-LMConfigsource, Set-LMPropertysource, Set-LMCollectorGroup, Set-LMTopologysource, Set-LMWebsiteGroup, Set-LMReportGroup, Set-LMRole, Set-LMNetscanGroup, Set-LMRecipientGroup, Set-LMAppliesToFunction, Set-LMAccessGroup: Unified the empty key removal logic and special handling for name/NewName (or groupName/NewName for recipient groups). Now, the name (or groupName) field is only included if -NewName is specified, matching the new pattern.

• New-LMCachedAccount / Remove-LMCachedAccount: Improved logic for handling credential vaults and metadata validation.

Note on DiagnosticSources:

DiagnosticSources are currently in closed beta and are not fully supported at this time. Only users in the DiagnosticSource closed beta will be able to leverage these cmdlets.

Major Changes in v7:

• API Headers: Updated all API request headers to use a custom User-Agent (Logic.Monitor-PowerShell-Module/Version) for usage reporting on versions deployed.

Documentation Overhaul

We're excited to announce our new comprehensive documentation site at https://logicmonitor.github.io/lm-powershell-module-docs/. The site includes:

• Detailed command reference information
• Code examples and snippets
• Best practices guides

New Filter Wizard

Introducing the Filter Wizard, a new interactive tool to help build complex filters:

• Visual filter construction
• Support for all filter operators
• Real-time filter preview
• Available through Build-LMFilter or -FilterWizard parameter

# Use the standalone filter builder
Build-LMFilter

# Use built-in filter wizard parameter
Get-LMDeviceGroup -FilterWizard

Previous Release Notes

License

Copyright, 2024, LogicMonitor, Inc.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.