Installation and Setup

Installation

The Logic.Monitor PowerShell module is available on the PowerShell Gallery and works with PowerShell 5.1+ (some features require PowerShell 6.1+).

# Install from PowerShell Gallery
Install-Module -Name "Logic.Monitor"

# Import the module
Import-Module Logic.Monitor

# Update to the latest version
Update-Module -Name "Logic.Monitor"

# Check your current version
Get-Module Logic.Monitor -ListAvailable | Select-Object Version

# Install a specific version
Install-Module -Name "Logic.Monitor" -RequiredVersion 7.7.0

# View available versions
Find-Module Logic.Monitor -AllVersions | Select-Object Version

Authentication

Before using any module commands, you need to connect to your LogicMonitor portal.

API Token (LMv1)

Most common method using API access credentials.

Connect-LMAccount `
    -AccessId "your_access_id" `
    -AccessKey "your_access_key" `
    -AccountName "your_portal"

Bearer Token

Use OAuth bearer tokens for authentication.

Connect-LMAccount `
    -BearerToken "your_bearer_token" `
    -AccountName "your_portal"

Using Cached Credentials

The module includes secure credential caching using Microsoft’s SecretManagement module for managing multiple portal connections.

# First time: Create a cached credential
New-LMCachedAccount `
    -AccessId "your_access_id" `
    -AccessKey "your_access_key" `
    -AccountName "production-portal"

# Add more portals as needed
New-LMCachedAccount `
    -AccessId "staging_id" `
    -AccessKey "staging_key" `
    -AccountName "staging-portal"

# Connect using cached credentials
Connect-LMAccount -UseCachedCredential

# You'll see a selection menu:
# Selection Number | Portal Name
# 0) production-portal
# 1) staging-portal
# Enter the number for the cached credential you wish to use:

# List cached accounts
Get-LMCachedAccount

# Remove a cached account
Remove-LMCachedAccount -AccountName "old-portal"

# Update cached credentials
New-LMCachedAccount `
    -AccessId "new_id" `
    -AccessKey "new_key" `
    -AccountName "production-portal"

Quick Start Examples

Once connected, here are some common operations to get you started:

# List all devices
Get-LMDevice

# Get a specific device
Get-LMDevice -Name "device.example.com"

# Find devices by pattern
Get-LMDevice -DisplayName "prod*"

# Filter devices by property
Get-LMDevice -Filter "hostStatus -eq 'normal'"

# Create a new device
New-LMDevice `
    -Name "server01.example.com" `
    -DisplayName "Production Server 01" `
    -PreferredCollectorId 5 `
    -Properties @{
        environment = "production"
        location = "us-east"
    }

# Get active alerts
Get-LMAlert

# Get critical alerts
Get-LMAlert -Filter "severity -eq '4'"

# Get alerts for a specific device
Get-LMAlert -Filter "deviceDisplayName -eq 'server01'"

# Acknowledge an alert
Get-LMAlert -Id 12345 |
    New-LMAlertAck -Note "Investigating issue"

# List all dashboards
Get-LMDashboard

# Get a specific dashboard
Get-LMDashboard -Name "Network Overview"

# Clone a dashboard
Copy-LMDashboard `
    -Id 123 `
    -Name "Network Overview - Copy" `
    -GroupName "My Dashboards"

# Import a LogicModule (new in 7.7.0)
Import-LMLogicModuleFromFile `
    -FilePath "C:\LogicModules\datasource.json" `
    -Type datasources `
    -Format json

# List all datasources
Get-LMDatasource

# Export a datasource
Export-LMDatasource -Id 123 -FilePath "C:\Backup\datasource.json"

# List available commands
Get-Command -Module "Logic.Monitor"

# Get help for a specific command
Get-Help Get-LMDevice -Full

# Search for commands
Get-Command -Module "Logic.Monitor" -Name "*Device*"

# Check module version
Get-Module Logic.Monitor | Select-Object Name, Version