LogicMonitor PowerShell Documentation

LogicMonitor PowerShell Module

Welcome to the LogicMonitor PowerShell Module documentation. This module provides a comprehensive set of cmdlets for managing your LogicMonitor environment through PowerShell.

Categories

Account management

Commands for managing accounts and account groups

• connect-lmaccount
• disconnect-lmaccount
• get-lmaccountstatus
• get-lmcachedaccount
• new-lmcachedaccount
• remove-lmcachedaccount

Alert management

Commands for managing alerts and escalation chains

• get-lmalert
• get-lmalertrule
• get-lmescalationchain
• get-lmrecipientgroup
• new-lmalertack
• new-lmalertescalation
• new-lmalertnote
• new-lmalertrule
• new-lmrecipientgroup
• remove-lmalertrule
• remove-lmrecipientgroup
• set-lmalertrule
• set-lmrecipientgroup

Devices

Commands for managing devices, SDTs, properties, and network scanning

• copy-lmdevice
• export-lmdeviceconfigbackup
• export-lmdevicedata
• get-lmdevice
• get-lmdevicealertsettings
• get-lmdevicealerts
• get-lmdeviceconfigsourcedata
• get-lmdevicedata
• get-lmdevicedatasourceinstance
• get-lmdevicedatasourceinstancealertrecipients
• get-lmdevicedatasourceinstancealertsetting
• get-lmdevicedatasourceinstancegroup
• get-lmdevicedatasourcelist
• get-lmdeviceeventsourcelist
• get-lmdeviceinstancedata
• get-lmdeviceinstancelist
• get-lmdevicenetflowendpoints
• get-lmdevicenetflowflows
• get-lmdevicenetflowports
• get-lmdeviceproperty
• get-lmdevicesdt
• get-lmdevicesdthistory
• invoke-lmdeviceconfigsourcecollection
• new-lmdevice
• new-lmdevicedatasourceinstance
• new-lmdevicedatasourceinstancegroup
• new-lmdevicedatasourceinstancesdt
• new-lmdevicedatasourcesdt
• new-lmdeviceproperty
• new-lmdevicesdt
• remove-lmdevice
• remove-lmdevicedatasourceinstance
• remove-lmdevicedatasourceinstancegroup
• remove-lmdeviceproperty
• set-lmdevice
• set-lmdevicedatasourceinstance
• set-lmdevicedatasourceinstancealertsetting
• set-lmdeviceproperty

Services

Commands for viewing services and service members

• get-lmservice
• get-lmservicemember

Device groups

Commands for managing device groups and their properties

• get-lmdevicegroup
• get-lmdevicegroupalerts
• get-lmdevicegroupdatasourcealertsetting
• get-lmdevicegroupdatasourcelist
• get-lmdevicegroupdevices
• get-lmdevicegroupgroups
• get-lmdevicegroupproperty
• get-lmdevicegroupsdt
• get-lmdevicegroupsdthistory
• new-lmdevicegroup
• new-lmdevicegroupproperty
• new-lmdevicegroupsdt
• remove-lmdevicegroup
• remove-lmdevicegroupproperty
• set-lmdevicegroup
• set-lmdevicegroupdatasourcealertsetting
• set-lmdevicegroupproperty

Dashboards

Commands for managing dashboards and widgets

• copy-lmdashboard
• get-lmdashboard
• get-lmdashboardgroup
• get-lmdashboardwidget
• import-lmdashboard
• new-lmdashboardgroup
• remove-lmdashboard
• remove-lmdashboardgroup
• remove-lmdashboardwidget

Collector groups

Commands for managing collector groups and their properties

• get-lmcollectorgroup
• new-lmcollectorgroup
• remove-lmcollectorgroup
• set-lmcollectorgroup

Collectors

Commands for managing collectors and their configurations

• get-lmcollector
• get-lmcollectordebugresult
• get-lmcollectorinstaller
• get-lmcollectorversions
• invoke-lmcollectordebugcommand
• new-lmcollector
• set-lmcollector
• set-lmcollectorconfig

Website groups

Commands for managing website groups and their properties

• get-lmwebsitegroup
• get-lmwebsitegroupalerts
• get-lmwebsitegroupsdt
• get-lmwebsitegroupsdthistory
• new-lmwebsitegroup
• remove-lmwebsitegroup
• set-lmwebsitegroup

Websites

Commands for managing website monitoring and website groups

• get-lmwebsite
• get-lmwebsitealerts
• get-lmwebsitecheckpoint
• get-lmwebsitedata
• get-lmwebsiteproperty
• get-lmwebsitesdt
• get-lmwebsitesdthistory
• new-lmwebsite
• remove-lmwebsite
• set-lmwebsite

User management

Commands for managing users, roles, and accounts

• get-lmapitoken
• get-lmrole
• get-lmuser
• get-lmusergroup
• invoke-lmuserlogoff
• new-lmapitoken
• new-lmapiuser
• new-lmrole
• new-lmuser
• remove-lmapitoken
• remove-lmrole
• remove-lmuser
• set-lmapitoken
• set-lmrole
• set-lmuser
• set-lmuserdata

Report groups

Commands for managing report groups and their properties

• get-lmreportgroup
• new-lmreportgroup
• remove-lmreportgroup
• set-lmreportgroup

Reports

Commands for managing reports and report groups

• copy-lmreport
• get-lmreport
• remove-lmreport

Cloud monitoring

Commands for managing cloud monitoring and cloud groups

• get-lmawsaccountid
• invoke-lmawsaccounttest
• invoke-lmazureaccounttest
• invoke-lmazuresubscriptiondiscovery
• invoke-lmcloudgroupnetscan
• invoke-lmgcpaccounttest

Cost optimization

Commands for viewing cost optimization recommendations

• get-lmcostoptimizationrecommendations

Netscan groups

Commands for managing netscan groups and their properties

• get-lmnetscangroup
• new-lmnetscangroup
• remove-lmnetscangroup
• set-lmnetscangroup

Netscan

Commands for managing netscan and enhanced netscan

• get-lmnetscan
• get-lmnetscanexecution
• get-lmnetscanexecutiondevices
• invoke-lmnetscan
• new-lmenhancednetscan
• new-lmnetscan
• remove-lmnetscan
• set-lmnetscan

Logicmodules

Commands for managing logic modules and their properties

• export-lmlogicmodule
• get-lmappliestofunction
• get-lmconfigsource
• get-lmconfigsourceupdatehistory
• get-lmdatasource
• get-lmdatasourceassociateddevices
• get-lmdatasourcegraph
• get-lmdatasourcemetadata
• get-lmdatasourceoverviewgraph
• get-lmdatasourceupdatehistory
• get-lmeventsource
• get-lmlogsource
• get-lmlogicmodulemetadata
• get-lmpropertysource
• get-lmrepositorylogicmodules
• get-lmsysoidmap
• get-lmtopologysource
• import-lmexchangemodule
• import-lmlogicmodule
• import-lmrepositorylogicmodules
• new-lmappliestofunction
• new-lmdatasource
• new-lmdatasourcegraph
• new-lmdatasourceoverviewgraph
• new-lmlogicmodule
• remove-lmappliestofunction
• remove-lmconfigsource
• remove-lmdatasource
• remove-lmlogsource
• remove-lmpropertysource
• remove-lmtopologysource
• set-lmappliestofunction
• set-lmconfigsource
• set-lmdatasource
• set-lmpropertysource
• set-lmtopologysource
• test-lmappliestoquery

Topology

Commands for managing topology maps and topology groups

• get-lmtopologymap
• get-lmtopologymapdata

Logs

Commands for managing event logs and audit logs

• get-lmauditlogs
• get-lmintegrationlogs
• get-lmlogmessage
• get-lmlogpartition
• get-lmlogpartitionretention
• new-lmlogpartition
• remove-lmlogpartition
• send-lmlogmessage
• set-lmlogpartition
• set-lmlogpartitionaction

Access groups

Commands for managing access groups and their properties

• get-lmaccessgroup
• new-lmaccessgroup
• new-lmaccessgroupmapping
• remove-lmaccessgroup
• set-lmaccessgroup

Sdts

Commands for managing SDTs and their properties

• get-lmsdt
• remove-lmsdt
• set-lmsdt

Opsnotes

Commands for managing opsnotes and their properties

• get-lmopsnote
• new-lmopsnote
• remove-lmopsnote
• set-lmopsnote

Push metrics

Commands for managing push metrics and their properties

• new-lmpushmetricdatapoint
• new-lmpushmetricinstance
• send-lmpushmetric

Configuration

Commands for managing global settings

• get-lmnormalizedproperties
• get-lmportalinfo
• new-lmnormalizedproperties
• remove-lmnormalizedproperties
• set-lmnewusermessage
• set-lmnormalizedproperties
• set-lmportalinfo

Other

Additional utility commands

• build-lmfilter
• get-lmcostoptimizationrecommendationcategories
• get-lmunmonitoreddevice
• get-lmusagemetrics
• invoke-lmactivediscovery
• new-lmrecipient
• remove-lmunmonitoreddevice
• set-lmpushmoduledeviceproperty
• set-lmpushmoduleinstanceproperty
• set-lmunmonitoreddevice