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/.

Disclaimer: This PowerShell module is developed as an open-source project and is not officially supported by LogicMonitor. It is maintained by a community of users who are passionate about enhancing its capabilities and functionality. While LogicMonitor recognizes the effort and ingenuity behind this module, please note that it is provided "as is" without any official support or warranty from LogicMonitor.

We encourage contributions and feedback from all users. If you encounter issues or have suggestions for improvements, please feel free to open an issue or submit a pull request. Your involvement is invaluable in making this module better for everyone!

Use of this module is at your own risk; however, it has been developed with care and is used by our community. We look forward to seeing how it can be improved and how it can help solve your problems!

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

Examples

Most Get commands can pull info by id or name to allow for easier retrieval without needing to know the specific resource id. The name parameters in get commands can also accept wildcard values. All responses will return objects in list view so for readability you may want to pipe the output to Format-Table.

Get list of devices:

#Get all devices
Get-LMDevice

#Get device via id
Get-LMDevice -Id 1

#Get device via hostname
Get-LMDevice -Name device.example.com

#Get device via displayname/wildcard
Get-LMDevice -DisplayName "corp*"

When modifying or removing a device you can use the Name parameter instead of id but wildcard values cannot be used.

Modify a device:

#Change device Name,DisplayName,Description,Link and set collector assignment
Set-LMDevice -Id 1 -DisplayName "New Device Name" -NewName "device.example.com" -Description "Critical Device" -Link "http://device.example.com" -PreferredCollectorId 1

#Add/Update custom properties to a resource and disable alerting
Set-LMDevice -Id 1 -Properties @{propname1="value1";propname2="value2"} -DisableAlerting $true

Remove a device:

#Remove device by hostname
Remove-LMDevice -Name "device.example.com" -HardDelete $false

Send LM Log Message:

Send-LMLogMessage -Message "Hello World!" -resourceMapping @{"system.displayname"="LM-COLL"} -Metadata @{"extra-data"="value";"extra-data2"="value2"}

Add a new user to LogicMonitor:

New-LMUser -RoleNames @("administrator") -Password "changeme" -FirstName John -LastName Doe -Email jdoe@example.com -Username jdoe@example.com -ForcePasswordChange $true -Phone "5558675309"

Generate new API Token:

New-LMAPIToken -Username jdoe@example.com -Note "Used for K8s"

Using the -Filter parameter:

The -Filter parameter has been overhauled to provide more options and flexibility in generating more complex server side filtering options. Previously -Filter only took in a hashtable of properties to perform an equal comparison against, this was very limited compared to the additional filtering options available in LM APIv3. As a result of the update 4.2 you can now use the following operators when construction the filter string. Additionally the old hashtable method of filtering is still supported for backwards compatibility but may be removed in a future update:

Operator	Description
-eq	Equal
-ne	Not equal
-gt	Greater than
-lt	Less than
-ge	Greater than or equal
-le	Less than or equal
-contains	Contain
-notcontains	Does not contain
-and	Comparison and operator
-or	Comparison or operator

Notes: When creating your own custom filters, consider the following items:

Text values: Enclose the text in single quotation marks (for example, 'Value' or 'Value with spaces'):

-Filter "displayName -eq 'MyNameHere'"

Variables: Enclose variables that need to be expanded in single quotation marks:

-Filter "username -eq '$User'"

Integer values: You don't need to enclose integers (for example, 500). You can often enclose integers in single quotation marks but is not required:

-Filter "id -eq 7"

System values: Enclose system values (for example, $true, $false, or $null) in single quotation marks:

-Filter "disableAlerting -eq '$true'"

Field names: Field names in the LM API are case sensitive, ensure you use the proper casing when creating a custom filter (ex displayName). Using incorrect casing can result in unexpected results being returned. Also reference LM APIv3 swagger guide for details on which fields are supported for filtering.

Additional Filter Examples:

#Device Hostname contains UDM and aleting is disabled
Get-LMDevice -Filter "disableAlerting -eq '$true' -and name -contains 'UDM'"

#User email address either contains steve or is null
Get-LMUser -Filter "email -contains 'steve' -or email -ne '$null'"

#Get active alerts where the instance name is Kubernetes_Scheduler and the Alert Rule is labeled Critical
Get-LMAlert -Filter "instanceName -eq 'Kubernetes_Scheduler' -and rule -eq 'Critical'"

Note: Using the -Name parameter to target a resource during a Set/Remove command will perform an initial get request for you automatically to retrieve the required id. When performing a large amount of changes using id is the preferred method to avoid excessive lookups and avoid any potential API throttling.

Additional Code Examples and Documentation

• Code Snippet Library
• Command Documentation

Available Commands:

Connect-LMAccount

Copy-LMDashboard
Copy-LMDevice
Copy-LMReport

Disconnect-LMAccount

Export-LMDeviceConfigBackup
Export-LMDeviceData
Export-LMLogicModule

Get-LMAccessGroup
Get-LMAccountStatus
Get-LMAlert
Get-LMAlertRule
Get-LMAPIToken
Get-LMAppliesToFunction
Get-LMAuditLogs
Get-LMCachedAccount
Get-LMCollector
Get-LMCollectorDebugResult
Get-LMCollectorGroup
Get-LMCollectorInstaller
Get-LMCollectorVersions
Get-LMConfigSource
Get-LMDashboard
Get-LMDashboardGroup
Get-LMDashboardWidget
Get-LMDatasource
Get-LMDatasourceAssociatedDevices
Get-LMDatasourceGraph
Get-LMDatasourceMetadata
Get-LMDatasourceOverviewGraph
Get-LMDatasourceUpdateHistory
Get-LMDevice
Get-LMDeviceAlerts
Get-LMDeviceAlertSettings
Get-LMDeviceConfigSourceData
Get-LMDeviceData
Get-LMDeviceDatasourceInstance
Get-LMDeviceDatasourceInstanceAlertSetting
Get-LMDeviceDatasourceInstanceGroup
Get-LMDeviceDatasourceList
Get-LMDeviceEventSourceList
Get-LMDeviceGroup
Get-LMDeviceGroupAlerts
Get-LMDeviceGroupDatasourceAlertSetting
Get-LMDeviceGroupDatasourceList
Get-LMDeviceGroupDevices
Get-LMDeviceGroupGroups
Get-LMDeviceGroupProperty
Get-LMDeviceGroupSDT
Get-LMDeviceGroupSDTHistory
Get-LMDeviceInstanceData
Get-LMDeviceInstanceList
Get-LMDeviceNetflowEndpoints
Get-LMDeviceNetflowFlows
Get-LMDeviceNetflowPorts
Get-LMDeviceProperty
Get-LMDeviceSDT
Get-LMDeviceSDTHistory
Get-LMEscalationChain
Get-LMEventSource
Get-LMIntegrationLogs
Get-LMNetscan
Get-LMNetscanExecution
Get-LMNetscanExecutionDevices
Get-LMNetscanGroup
Get-LMOpsNote
Get-LMPortalInfo
Get-LMPropertySource
Get-LMRecipientGroup
Get-LMReport
Get-LMReportGroup
Get-LMRepositoryLogicModules
Get-LMRole
Get-LMSDT
Get-LMTopologyMap
Get-LMTopologyMapData
Get-LMTopologySource
Get-LMUnmonitoredDevice
Get-LMUsageMetrics
Get-LMUser
Get-LMUserGroup
Get-LMWebsite
Get-LMWebsiteAlerts
Get-LMWebsiteCheckpoint
Get-LMWebsiteData
Get-LMWebsiteGroup
Get-LMWebsiteGroupAlerts
Get-LMWebsiteGroupSDT
Get-LMWebsiteGroupSDTHistory
Get-LMWebsiteProperty
Get-LMWebsiteSDT
Get-LMWebsiteSDTHistory\

Import-LMDashboard
Import-LMExchangeModule
Import-LMLogicModule
Import-LMRepositoryLogicModules

Invoke-LMActiveDiscovery
Invoke-LMCloudGroupNetScan
Invoke-LMCollectorDebugCommand
Invoke-LMDeviceConfigSourceCollection
Invoke-LMNetScan
Invoke-LMUserLogoff

New-LMAlertAck
New-LMAlertEscalation
New-LMAlertNote
New-LMAPIToken
New-LMAPIUser
New-LMAppliesToFunction
New-LMCachedAccount
New-LMCollector
New-LMCollectorGroup
New-LMDashboardGroup
New-LMDatasourceGraph
New-LMDatasourceOverviewGraph
New-LMDevice
New-LMDeviceDatasourceInstance
New-LMDeviceDatasourceInstanceGroup
New-LMDeviceDatasourceInstanceSDT
New-LMDeviceDatasourceSDT
New-LMDeviceGroup
New-LMDeviceGroupSDT
New-LMDeviceProperty
New-LMDeviceSDT
New-LMEnhancedNetScan
New-LMNetScan
New-LMNetscanGroup
New-LMOpsNote
New-LMPushMetricDataPoint
New-LMPushMetricInstance
New-LMReportGroup
New-LMRole
New-LMUser
New-LMWebsite
New-LMWebsiteGroup

Remove-LMAPIToken
Remove-LMAppliesToFunction
Remove-LMCachedAccount
Remove-LMCollectorGroup
Remove-LMConfigsource
Remove-LMDashboard
Remove-LMDashboardGroup
Remove-LMDashboardWidget
Remove-LMDatasource
Remove-LMDevice
Remove-LMDeviceDatasourceInstance
Remove-LMDeviceGroup
Remove-LMDeviceProperty
Remove-LMNetscan
Remove-LMNetscanGroup
Remove-LMOpsNote
Remove-LMPropertysource
Remove-LMReport
Remove-LMReportGroup
Remove-LMRole
Remove-LMSDT
Remove-LMTopologysource
Remove-LMUnmonitoredDevice
Remove-LMUser
Remove-LMWebsite
Remove-LMWebsiteGroup

Send-LMLogMessage
Send-LMPushMetric

Set-LMAPIToken
Set-LMAppliesToFunction
Set-LMCollector
Set-LMCollectorConfig
Set-LMCollectorGroup
Set-LMConfigsource
Set-LMDatasource
Set-LMDevice
Set-LMDeviceDatasourceInstance
Set-LMDeviceDatasourceInstanceAlertSetting
Set-LMDeviceGroup
Set-LMDeviceGroupDatasourceAlertSetting
Set-LMDeviceProperty
Set-LMNetscan
Set-LMNetscanGroup
Set-LMNewUserMessage
Set-LMOpsNote
Set-LMPortalInfo
Set-LMPropertysource
Set-LMPushModuleDeviceProperty
Set-LMPushModuleInstanceProperty
Set-LMReportGroup
Set-LMRole
Set-LMSDT
Set-LMTopologysource
Set-LMUnmonitoredDevice
Set-LMUser
Set-LMWebsite

Note: Some commands accept pipeline input, see Get-Command <cmdlet-name> -Module Logic.Monitor for details.

Change List

Important Update: Logic.Monitor PowerShell Module Transition

We are excited to announce a significant update to the Logic.Monitor PowerShell module. Starting with version 6.0, the module will be relocating to a new repository within the LogicMonitor GitHub organization. The new repository will be named lm-powershell-module.

This change aims to enhance visibility within the community and to foster a more centralized and collaborative environment for feedback and contributions. As a community-driven open source project, we believe this move will allow for more robust development and support, benefiting all users.

What This Means for You:

• The new repository location will be active with the release of version 6.0.
• Users are encouraged to start using the new repository for all future updates, issue tracking, and contributions.

Action Required:

• Please update your bookmarks and local environments to point to the new repository: https://github.com/LogicMonitor/lm-powershell-module
• Subscribe to the repository to stay updated with the latest releases and discussions.

We appreciate your continued support and enthusiasm for the Logic.Monitor PowerShell module. Your contributions and feedback are vital to the success of this project, and we look forward to seeing how the module evolves with your participation.

6.0

New Cmdlets:

• Get-LMDeviceInstanceData: This cmdlet retrieves data for LogicMonitor device instances based on the specified parameters. The cmdlet can only retrieve data within the last 24 hours. You can use Get-LMDeviceInstanceList to quickly get a list of instances for a particular device.
• New-LMAlertEscalation: This cmdlet invokes an escalation for a LogicMonitor alert. It takes a -Ids parameter which is an array of alert ids to escalate.
• Get-LMAccessGroup: This cmdlet will retrieve data for specified LogicMonitor access groups. You can retrieve all access groups or limit the results using -Id, -Name or -Filter parameters.

Note: Access Groups are not available in all portals and needs to be enabled before any access group commands can be utilized.

Updated Cmdlets:

• Set-LMDeviceDatasourceInstanceAlertSetting: AlertForNoData, AlertClearTransitionInterval and AlertTransitionInterval parameters are now mandatory as a result of endpoint changes for LM APIv3. These values can now be set at instance and group level overrides and as a result must be specified when modifying alert thresholds.
• Set-LMDeviceGroupDatasourceAlertSetting: AlertForNoData, AlertClearTransitionInterval and AlertTransitionInterval parameters are now mandatory as a result of endpoint changes for LM APIv3. These values can now be set at instance and group level overrides and as a result must be specified when modifying alert thresholds.

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/.