From c853772fdb3e8b94aa0abc29c8fffcb3119bea4a Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 14:16:20 -0400 Subject: [PATCH 01/17] Add recently deleted support --- Logic.Monitor.Format.ps1xml | 53 +++++++++ Private/Update-LogicMonitorModule.ps1 | 93 ++++++++++----- Public/Get-LMRecentlyDeleted.ps1 | 162 ++++++++++++++++++++++++++ Public/Remove-LMRecentlyDeleted.ps1 | 79 +++++++++++++ Public/Restore-LMRecentlyDeleted.ps1 | 79 +++++++++++++ 5 files changed, 435 insertions(+), 31 deletions(-) create mode 100644 Public/Get-LMRecentlyDeleted.ps1 create mode 100644 Public/Remove-LMRecentlyDeleted.ps1 create mode 100644 Public/Restore-LMRecentlyDeleted.ps1 diff --git a/Logic.Monitor.Format.ps1xml b/Logic.Monitor.Format.ps1xml index bf321ec..4c95b50 100644 --- a/Logic.Monitor.Format.ps1xml +++ b/Logic.Monitor.Format.ps1xml @@ -1452,6 +1452,59 @@ + + + + LogicMonitorRecentlyDeleted + + LogicMonitor.RecentlyDeleted + + + + + + + + + + + + + + + + + + + + + + + + + + + id + + + resourceType + + + resourceName + + + deletedOn + + + deletedBy + + + resourceId + + + + + LogicMonitorLMUptimeDevice diff --git a/Private/Update-LogicMonitorModule.ps1 b/Private/Update-LogicMonitorModule.ps1 index 01f7078..afe31ad 100644 --- a/Private/Update-LogicMonitorModule.ps1 +++ b/Private/Update-LogicMonitorModule.ps1 @@ -42,48 +42,79 @@ function Update-LogicMonitorModule { ) foreach ($Module in $Modules) { - # Read the currently installed version - $Installed = Get-Module -ListAvailable -Name $Module + try { + # Read the currently installed version + $Installed = Get-Module -ListAvailable -Name $Module -ErrorAction SilentlyContinue - # There might be multiple versions - if ($Installed -is [Array]) { - $InstalledVersion = $Installed[0].Version - } - elseif ($Installed.Version) { - $InstalledVersion = $Installed.Version - } - else { - #Not installed or manually imported - return - } + if (-not $Installed) { + Write-Verbose "Module $Module is not installed; skipping update check." + continue + } + + # There might be multiple versions + if ($Installed -is [Array]) { + $InstalledVersion = $Installed[0].Version + } + elseif ($Installed.Version) { + $InstalledVersion = $Installed.Version + } + else { + Write-Verbose "Unable to determine installed version for module $Module; skipping update check." + continue + } + + # Lookup the latest version online + try { + $Online = Find-Module -Name $Module -Repository PSGallery -ErrorAction Stop + $OnlineVersion = $Online.Version + } + catch { + Write-Verbose "Unable to query online version for module $Module. $_" + continue + } - # Lookup the latest version Online - $Online = Find-Module -Name $Module -Repository PSGallery -ErrorAction Stop - $OnlineVersion = $Online.Version + # Compare the versions + if ([System.Version]$OnlineVersion -le [System.Version]$InstalledVersion) { + Write-Information "[INFO]: Module $Module version $InstalledVersion is the latest version." + continue + } - # Compare the versions - if ([System.Version]$OnlineVersion -gt [System.Version]$InstalledVersion) { + Write-Information "[INFO]: You are currently using an outdated version ($InstalledVersion) of $Module." - # Uninstall the old version if ($CheckOnly) { - Write-Information "[INFO]: You are currently using an outdated version ($InstalledVersion) of $Module, please consider upgrading to the latest version ($OnlineVersion) as soon as possible. Use the -AutoUpdateModule switch next time you connect to auto upgrade to the latest version." + Write-Information "[INFO]: Please consider upgrading to the latest version ($OnlineVersion) of $Module as soon as possible. Use the -AutoUpdateModule switch next time you connect to auto upgrade to the latest version." + continue } - elseif ($UninstallFirst -eq $true) { - Write-Information "[INFO]: You are currently using an outdated version ($InstalledVersion) of $Module, uninstalling prior Module $Module version $InstalledVersion" - Uninstall-Module -Name $Module -Force -Verbose:$False - Write-Information "[INFO]: Installing newer Module $Module version $OnlineVersion." - Install-Module -Name $Module -Force -AllowClobber -Verbose:$False -MinimumVersion $OnlineVersion - Update-LogicMonitorModule -CheckOnly -Modules @($Module) + if ($UninstallFirst -eq $true) { + Write-Information "[INFO]: Uninstalling prior Module $Module version $InstalledVersion." + try { + Uninstall-Module -Name $Module -Force -Verbose:$False -ErrorAction Stop + } + catch { + Write-Verbose "Failed to uninstall module $Module version $InstalledVersion. $_" + continue + } } - else { - Write-Information "[INFO]: You are currently using an outdated version ($InstalledVersion) of $Module. Installing newer Module $Module version $OnlineVersion." - Install-Module -Name $Module -Force -AllowClobber -Verbose:$False -MinimumVersion $OnlineVersion + + Write-Information "[INFO]: Installing newer Module $Module version $OnlineVersion." + try { + Install-Module -Name $Module -Force -AllowClobber -Verbose:$False -MinimumVersion $OnlineVersion -ErrorAction Stop + } + catch { + Write-Verbose "Failed to install module $Module version $OnlineVersion. $_" + continue + } + + try { Update-LogicMonitorModule -CheckOnly -Modules @($Module) } + catch { + Write-Verbose "Post-installation verification failed for module $Module. $_" + } } - else { - Write-Information "[INFO]: Module $Module version $InstalledVersion is the latest version." + catch { + Write-Verbose "Unexpected error encountered while updating module $Module. $_" } } } \ No newline at end of file diff --git a/Public/Get-LMRecentlyDeleted.ps1 b/Public/Get-LMRecentlyDeleted.ps1 new file mode 100644 index 0000000..bdbcfa4 --- /dev/null +++ b/Public/Get-LMRecentlyDeleted.ps1 @@ -0,0 +1,162 @@ +<# +.SYNOPSIS +Retrieves recently deleted resources from the LogicMonitor recycle bin. + +.DESCRIPTION +The Get-LMRecentlyDeleted function queries the LogicMonitor recycle bin for deleted resources +within a configurable time range. Results can be filtered by resource type and deleted-by user, +and support paging through the API using size, offset, and sort parameters. + +.PARAMETER ResourceType +Limits results to a specific resource type. Accepted values are All, device, and deviceGroup. +Defaults to All. + +.PARAMETER DeletedAfter +The earliest deletion timestamp (inclusive) to return. Defaults to seven days prior when not specified. + +.PARAMETER DeletedBefore +The latest deletion timestamp (exclusive) to return. Defaults to the current time when not specified. + +.PARAMETER DeletedBy +Limits results to items deleted by the specified user principal. + +.PARAMETER BatchSize +The number of records to request per API call (1-1000). Defaults to 1000. + +.PARAMETER Sort +Sort expression passed to the API. Defaults to -deletedOn. + +.EXAMPLE +Get-LMRecentlyDeleted -ResourceType device -DeletedBy "lmsupport" + +Retrieves every device deleted by the user lmsupport over the past seven days. + +.EXAMPLE +Get-LMRecentlyDeleted -DeletedAfter (Get-Date).AddDays(-1) -DeletedBefore (Get-Date) -BatchSize 100 -Sort "+deletedOn" + +Retrieves deleted resources from the past 24 hours in ascending order of deletion time. + +.NOTES +You must establish a session with Connect-LMAccount prior to calling this function. +#> +function Get-LMRecentlyDeleted { + + [CmdletBinding()] + param ( + [ValidateSet('All', 'device', 'deviceGroup')] + [String]$ResourceType = 'All', + + [Nullable[DateTime]]$DeletedAfter, + + [Nullable[DateTime]]$DeletedBefore, + + [String]$DeletedBy, + + [ValidateRange(1, 1000)] + [Int]$BatchSize = 1000, + + [String]$Sort = '-deletedOn' + ) + + if (-not $Script:LMAuth.Valid) { + Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." + return + } + + function Get-EpochMilliseconds { + param ([Parameter(Mandatory)][DateTime]$InputDate) + return [long][Math]::Round((New-TimeSpan -Start (Get-Date -Date '1/1/1970') -End $InputDate.ToUniversalTime()).TotalMilliseconds) + } + + $now = Get-Date + + if (-not $DeletedAfter -and -not $DeletedBefore) { + $DeletedBefore = $now + $DeletedAfter = $now.AddDays(-7) + } + else { + if (-not $DeletedAfter) { + $DeletedAfter = $now.AddDays(-7) + } + if (-not $DeletedBefore) { + $DeletedBefore = $now + } + } + + if ($DeletedAfter -and $DeletedBefore -and $DeletedAfter -gt $DeletedBefore) { + Write-Error "The value supplied for DeletedAfter occurs after DeletedBefore. Please adjust the time range and try again." + return + } + + $filterParts = @() + + if ($DeletedAfter) { + $filterParts += ('deletedOn>:"{0}"' -f (Get-EpochMilliseconds -InputDate $DeletedAfter)) + } + + if ($DeletedBefore) { + $filterParts += ('deletedOn<:"{0}"' -f (Get-EpochMilliseconds -InputDate $DeletedBefore)) + } + + if ($ResourceType -ne 'All') { + $filterParts += ('resourceType:"{0}"' -f $ResourceType) + } + + if ($DeletedBy) { + $filterParts += ('deletedBy:"{0}"' -f $DeletedBy) + } + + $filterString = $null + if ($filterParts.Count -gt 0) { + $filterString = $filterParts -join ',' + } + + $resourcePath = '/recyclebin/recycles' + $results = @() + $currentOffset = 0 + $total = $null + + while ($true) { + $queryParams = "?size=$BatchSize&offset=$currentOffset&sort=$Sort" + if ($filterString) { + $queryParams += "&filter=$filterString" + } + + $headers = New-LMHeader -Auth $Script:LMAuth -Method 'GET' -ResourcePath $resourcePath + $uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $resourcePath + $queryParams + + Resolve-LMDebugInfo -Url $uri -Headers $headers[0] -Command $MyInvocation + + $response = Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $uri -Method 'GET' -Headers $headers[0] -WebSession $headers[1] + + $itemCount = 0 + if ($response.items) { + $results += $response.items + $itemCount = ($response.items | Measure-Object).Count + } + + if (-not $total -and $response.total) { + $total = $response.total + } + + if ($itemCount -lt $BatchSize) { + break + } + + if ($total -and (($currentOffset + $itemCount) -ge $total)) { + break + } + + $currentOffset += $itemCount + } + + if ($response.total) { + Write-Verbose "Retrieved $($results.Count) of $($response.total) recently deleted items." + } + else { + Write-Verbose "Retrieved $($results.Count) recently deleted items." + } + + return (Add-ObjectTypeInfo -InputObject $results -TypeName 'LogicMonitor.RecentlyDeleted') +} + diff --git a/Public/Remove-LMRecentlyDeleted.ps1 b/Public/Remove-LMRecentlyDeleted.ps1 new file mode 100644 index 0000000..946aa92 --- /dev/null +++ b/Public/Remove-LMRecentlyDeleted.ps1 @@ -0,0 +1,79 @@ +<# +.SYNOPSIS +Permanently removes one or more resources from the LogicMonitor recycle bin. + +.DESCRIPTION +The Remove-LMRecentlyDeleted function submits a batch delete request for the provided recycle +identifiers, permanently removing the associated resources from the recycle bin. + +.PARAMETER RecycleId +One or more recycle identifiers representing deleted resources. Accepts pipeline input and +property names of Id. + +.EXAMPLE +Get-LMRecentlyDeleted -ResourceType deviceGroup -DeletedBy "lmsupport" | Select-Object -First 3 -ExpandProperty id | Remove-LMRecentlyDeleted + +Permanently deletes the first three device groups currently in the recycle bin for the user lmsupport. + +.NOTES +You must establish a session with Connect-LMAccount prior to calling this function. +#> +function Remove-LMRecentlyDeleted { + + [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] + param ( + [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] + [Alias('Id')] + [String[]]$RecycleId + ) + + begin { + $idBuffer = New-Object System.Collections.Generic.List[string] + } + + process { + foreach ($id in $RecycleId) { + if ([string]::IsNullOrWhiteSpace($id)) { + continue + } + $idBuffer.Add($id) + } + } + + end { + if (-not $Script:LMAuth.Valid) { + Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." + return + } + + if ($idBuffer.Count -eq 0) { + Write-Error "No recycle identifiers were supplied. Provide at least one identifier and try again." + return + } + + $resourcePath = '/recyclebin/recycles/batchdelete' + $payload = ConvertTo-Json -InputObject $idBuffer.ToArray() + $headers = New-LMHeader -Auth $Script:LMAuth -Method 'POST' -ResourcePath $resourcePath -Data $payload + $uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $resourcePath + + Resolve-LMDebugInfo -Url $uri -Headers $headers[0] -Command $MyInvocation -Payload $payload + + $targetDescription = "RecycleId(s): $(($idBuffer.ToArray()) -join ', ')" + + if ($PSCmdlet.ShouldProcess($targetDescription, 'Permanently delete recently deleted resources')) { + $response = Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $uri -Method 'POST' -Headers $headers[0] -WebSession $headers[1] -Body $payload + + if ($null -ne $response) { + return (Add-ObjectTypeInfo -InputObject $response -TypeName 'LogicMonitor.RecentlyDeletedRemoveResult') + } + + $summary = [PSCustomObject]@{ + recycleIds = $idBuffer.ToArray() + message = 'Permanent delete request submitted successfully.' + } + + return (Add-ObjectTypeInfo -InputObject $summary -TypeName 'LogicMonitor.RecentlyDeletedRemoveResult') + } + } +} + diff --git a/Public/Restore-LMRecentlyDeleted.ps1 b/Public/Restore-LMRecentlyDeleted.ps1 new file mode 100644 index 0000000..21d3493 --- /dev/null +++ b/Public/Restore-LMRecentlyDeleted.ps1 @@ -0,0 +1,79 @@ +<# +.SYNOPSIS +Restores one or more resources from the LogicMonitor recycle bin. + +.DESCRIPTION +The Restore-LMRecentlyDeleted function issues a batch restore request for the provided recycle +identifiers, returning the selected resources to their original state when possible. + +.PARAMETER RecycleId +One or more recycle identifiers representing deleted resources. Accepts pipeline input and +property names of Id. + +.EXAMPLE +Get-LMRecentlyDeleted -ResourceType device -DeletedBy "lmsupport" | Select-Object -First 5 -ExpandProperty id | Restore-LMRecentlyDeleted + +Restores the five most recently deleted devices by lmsupport. + +.NOTES +You must establish a session with Connect-LMAccount prior to calling this function. +#> +function Restore-LMRecentlyDeleted { + + [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Medium')] + param ( + [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] + [Alias('Id')] + [String[]]$RecycleId + ) + + begin { + $idBuffer = New-Object System.Collections.Generic.List[string] + } + + process { + foreach ($id in $RecycleId) { + if ([string]::IsNullOrWhiteSpace($id)) { + continue + } + $idBuffer.Add($id) + } + } + + end { + if (-not $Script:LMAuth.Valid) { + Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." + return + } + + if ($idBuffer.Count -eq 0) { + Write-Error "No recycle identifiers were supplied. Provide at least one identifier and try again." + return + } + + $resourcePath = '/recyclebin/recycles/batchrestore' + $payload = ConvertTo-Json -InputObject $idBuffer.ToArray() + $headers = New-LMHeader -Auth $Script:LMAuth -Method 'POST' -ResourcePath $resourcePath -Data $payload + $uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $resourcePath + + Resolve-LMDebugInfo -Url $uri -Headers $headers[0] -Command $MyInvocation -Payload $payload + + $targetDescription = "RecycleId(s): $(($idBuffer.ToArray()) -join ', ')" + + if ($PSCmdlet.ShouldProcess($targetDescription, 'Restore recently deleted resources')) { + $response = Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $uri -Method 'POST' -Headers $headers[0] -WebSession $headers[1] -Body $payload + + if ($null -ne $response) { + return (Add-ObjectTypeInfo -InputObject $response -TypeName 'LogicMonitor.RecentlyDeletedRestoreResult') + } + + $summary = [PSCustomObject]@{ + recycleIds = $idBuffer.ToArray() + message = 'Restore request submitted successfully.' + } + + return (Add-ObjectTypeInfo -InputObject $summary -TypeName 'LogicMonitor.RecentlyDeletedRestoreResult') + } + } +} + From 2aa475217551de4d4ea88ba2a4697fbbcd2f5b1b Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 14:23:03 -0400 Subject: [PATCH 02/17] Fix csv export bug with Export-LMDeviceData - expand json depth to 5 and tweak export details for CSV so datapoints are individual columns --- Public/Export-LMDeviceData.ps1 | 43 ++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) diff --git a/Public/Export-LMDeviceData.ps1 b/Public/Export-LMDeviceData.ps1 index 12ae453..cc9d62e 100644 --- a/Public/Export-LMDeviceData.ps1 +++ b/Public/Export-LMDeviceData.ps1 @@ -135,9 +135,48 @@ function Export-LMDeviceData { } } + $csvExportList = @() + if ($ExportFormat -eq 'csv') { + foreach ($ExportItem in $DataExportList) { + if (-not $ExportItem.dataPoints) { + $row = [ordered]@{ + deviceId = $ExportItem.deviceId + deviceName = $ExportItem.deviceName + datasourceName = $ExportItem.datasourceName + instanceName = $ExportItem.instanceName + instanceGroup = $ExportItem.instanceGroup + } + $csvExportList += [PSCustomObject]$row + continue + } + + foreach ($Datapoint in @($ExportItem.dataPoints)) { + $row = [ordered]@{ + deviceId = $ExportItem.deviceId + deviceName = $ExportItem.deviceName + datasourceName = $ExportItem.datasourceName + instanceName = $ExportItem.instanceName + instanceGroup = $ExportItem.instanceGroup + } + + foreach ($Property in $Datapoint.PSObject.Properties) { + $row[$Property.Name] = $Property.Value + } + + $csvExportList += [PSCustomObject]$row + } + } + } + switch ($ExportFormat) { - "json" { $DataExportList | ConvertTo-Json -Depth 3 | Out-File -FilePath "$ExportPath\LMDeviceDataExport.json" ; return } - "csv" { $DataExportList | Export-Csv -NoTypeInformation -Path "$ExportPath\LMDeviceDataExport.csv" ; return } + "json" { + $DataExportList | ConvertTo-Json -Depth 5 | Out-File -FilePath (Join-Path -Path $ExportPath -ChildPath 'LMDeviceDataExport.json') + return + } + "csv" { + $csvExportList | Export-Csv -NoTypeInformation -Path (Join-Path -Path $ExportPath -ChildPath 'LMDeviceDataExport.csv') + return + } default { return $DataExportList } } } From a328046b44604afc3bd4d8e9504d66035dd19ce7 Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 14:33:53 -0400 Subject: [PATCH 03/17] prepare release notes --- README.md | 27 ++++++++++++++------------- RELEASENOTES.md | 25 +++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 01b3bb6..0953a3f 100644 --- a/README.md +++ b/README.md @@ -73,29 +73,30 @@ Connect-LMAccount -UseCachedCredential # Change List -## 7.6.1 +## 7.7.0 ### New Cmdlets -- **Send-LMWebhookMessage**: Send a webhook message to LM Logs. -- **Get-LMAWSExternalId**: Generate an ExternalID for AWS onboarding. +- **Get-LMRecentlyDeleted**: Retrieve recycle-bin entries with optional date, resource type, and deleted-by filters. +- **Restore-LMRecentlyDeleted**: Batch restore recycle-bin items by recycle identifier. +- **Remove-LMRecentlyDeleted**: Permanently delete recycle-bin entries in bulk. ### Updated Cmdlets -- **Set-LMDeviceGroup**: Added *-Extra* field which takes a PSCustomObject for specifying extra cloud settings for LM Cloud resource groups. -- **New-LMDeviceGroup**: Added *-Extra* field which takes a PSCustomObject for specifying extra cloud settings for LM Cloud resource groups. +- **Update-LogicMonitorModule**: Hardened for non-blocking version checks; failures are logged via `Write-Verbose` and never terminate connecting cmdlets. +- **Export-LMDeviceData**: CSV exports now expand datapoints into individual rows and JSON exports capture deeper datapoint structures. ### Examples ```powershell -# Create a new external web uptime check -New-LMUptimeDevice -Name "shop.example.com" -HostGroupIds '123' -Domain 'shop.example.com' -TestLocationAll +# Retrieve all recently deleted devices for the past seven days +Get-LMRecentlyDeleted -ResourceType device -DeletedBy "lmsupport" -Verbose -# Update an existing uptime device by name -Set-LMUptimeDevice -Name "shop.example.com" -Description "Updated uptime monitor" -GlobalSmAlertCond half +# Restore a previously deleted device and confirm the operation +Get-LMRecentlyDeleted -ResourceType device | Select-Object -First 1 -ExpandProperty id | Restore-LMRecentlyDeleted -Confirm:$false -# Remove an uptime device -Remove-LMUptimeDevice -Name "shop.example.com" +# Permanently remove stale recycle-bin entries +Get-LMRecentlyDeleted -DeletedAfter (Get-Date).AddMonths(-1) | Select-Object -ExpandProperty id | Remove-LMRecentlyDeleted -Confirm:$false -# Migrate legacy websites to uptime and disable their alerting -Get-LMWebsite -Type Webcheck | ConvertTo-LMUptimeDevice -TargetHostGroupIds '123' -DisableSourceAlerting +# Export device datapoints to CSV with flattened datapoint rows +Export-LMDeviceData -DeviceId 12345 -StartDate (Get-Date).AddHours(-6) -ExportFormat csv -ExportPath "C:\\Exports" ``` diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 27709ed..56ea6f5 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -1,5 +1,30 @@ # Previous module release notes +## 7.6.1 + +### New Cmdlets +- **Send-LMWebhookMessage**: Send a webhook message to LM Logs. +- **Get-LMAWSExternalId**: Generate an ExternalID for AWS onboarding. + +### Updated Cmdlets +- **Set-LMDeviceGroup**: Added *-Extra* field which takes a PSCustomObject for specifying extra cloud settings for LM Cloud resource groups. +- **New-LMDeviceGroup**: Added *-Extra* field which takes a PSCustomObject for specifying extra cloud settings for LM Cloud resource groups. + +### Examples +```powershell +# Create a new external web uptime check +New-LMUptimeDevice -Name "shop.example.com" -HostGroupIds '123' -Domain 'shop.example.com' -TestLocationAll + +# Update an existing uptime device by name +Set-LMUptimeDevice -Name "shop.example.com" -Description "Updated uptime monitor" -GlobalSmAlertCond half + +# Remove an uptime device +Remove-LMUptimeDevice -Name "shop.example.com" + +# Migrate legacy websites to uptime and disable their alerting +Get-LMWebsite -Type Webcheck | ConvertTo-LMUptimeDevice -TargetHostGroupIds '123' -DisableSourceAlerting +``` + ## 7.6 ### New Cmdlets From b54238433183347c2174912696e5fb952239353b Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 14:52:10 -0400 Subject: [PATCH 04/17] Update Update-LogicMonitorModule.ps1 --- Private/Update-LogicMonitorModule.ps1 | 37 +++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/Private/Update-LogicMonitorModule.ps1 b/Private/Update-LogicMonitorModule.ps1 index afe31ad..73a7135 100644 --- a/Private/Update-LogicMonitorModule.ps1 +++ b/Private/Update-LogicMonitorModule.ps1 @@ -41,6 +41,8 @@ function Update-LogicMonitorModule { [Switch]$CheckOnly ) + $psGalleryAvailable = $null + foreach ($Module in $Modules) { try { # Read the currently installed version @@ -63,13 +65,43 @@ function Update-LogicMonitorModule { continue } + if ($null -eq $psGalleryAvailable) { + try { + $repository = Get-PSRepository -Name 'PSGallery' -ErrorAction Stop + if (-not $repository) { + $psGalleryAvailable = $false + } + else { + try { + $probeUri = 'https://www.powershellgallery.com/api/v2/Packages?$top=1&$skip=0' + Invoke-RestMethod -Uri $probeUri -Method Get -TimeoutSec 5 -ErrorAction Stop | Out-Null + $psGalleryAvailable = $true + } + catch { + Write-Verbose "Unable to reach PSGallery endpoint ($probeUri). $_" + $psGalleryAvailable = $false + } + } + } + catch { + Write-Verbose "PSGallery repository is not registered on this host. $_" + $psGalleryAvailable = $false + } + } + + if (-not $psGalleryAvailable) { + Write-Verbose "PSGallery repository is unavailable; skipping update check for module $Module." + continue + } + # Lookup the latest version online try { - $Online = Find-Module -Name $Module -Repository PSGallery -ErrorAction Stop + $Online = Find-Module -Name $Module -Repository 'PSGallery' -ErrorAction Stop $OnlineVersion = $Online.Version } catch { Write-Verbose "Unable to query online version for module $Module. $_" + $psGalleryAvailable = $false continue } @@ -99,10 +131,11 @@ function Update-LogicMonitorModule { Write-Information "[INFO]: Installing newer Module $Module version $OnlineVersion." try { - Install-Module -Name $Module -Force -AllowClobber -Verbose:$False -MinimumVersion $OnlineVersion -ErrorAction Stop + Install-Module -Name $Module -Repository 'PSGallery' -Force -AllowClobber -Verbose:$False -MinimumVersion $OnlineVersion -ErrorAction Stop } catch { Write-Verbose "Failed to install module $Module version $OnlineVersion. $_" + $psGalleryAvailable = $false continue } From 7d755e2fd78e681a9b5b70994d8e71fbe3724af6 Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 14:54:48 -0400 Subject: [PATCH 05/17] enable verbose --- .github/workflows/test-win.yml | 2 +- .github/workflows/test.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test-win.yml b/.github/workflows/test-win.yml index 49d4274..fd9907d 100644 --- a/.github/workflows/test-win.yml +++ b/.github/workflows/test-win.yml @@ -46,7 +46,7 @@ jobs: $Result = Invoke-Pester -Container $Container -Output Detailed -PassThru #Write OpsNote to test portal indicating test status - Connect-LMAccount -AccessId $env:LM_ACCESS_ID -AccessKey $env:LM_ACCESS_KEY -AccountName $env:LM_PORTAL -DisableConsoleLogging + Connect-LMAccount -AccessId $env:LM_ACCESS_ID -AccessKey $env:LM_ACCESS_KEY -AccountName $env:LM_PORTAL -DisableConsoleLogging -Verbose $TimeNow = Get-Date -UFormat %m%d%Y-%H%M $OpsNote = New-LMOpsNote -Note "Github test build submitted on $TimeNow - $($Result.Result)" -Tags @("GithubActions","TestPipeline-Win5.1","PSVersion-$Version") diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 4385aa1..e3c0ca3 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -46,7 +46,7 @@ jobs: $Result = Invoke-Pester -Container $Container -Output Detailed -PassThru #Write OpsNote to test portal indicating test status - Connect-LMAccount -AccessId $env:LM_ACCESS_ID -AccessKey $env:LM_ACCESS_KEY -AccountName $env:LM_PORTAL -DisableConsoleLogging + Connect-LMAccount -AccessId $env:LM_ACCESS_ID -AccessKey $env:LM_ACCESS_KEY -AccountName $env:LM_PORTAL -DisableConsoleLogging -Verbose $TimeNow = Get-Date -UFormat %m%d%Y-%H%M $OpsNote = New-LMOpsNote -Note "Github test build submitted on $TimeNow - $($Result.Result)" -Tags @("GithubActions","TestPipeline-Core","PSVersion-$Version") From 5b1f1661a2bab4a0790a1c30ab5292e0d88bbcf1 Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 14:56:29 -0400 Subject: [PATCH 06/17] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0953a3f..7ece28f 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ Connect-LMAccount -UseCachedCredential #Connected to LM portal portalnamesandbox using account ``` + # Change List ## 7.7.0 From f913d4e499db2b2c81f01a133460597e14b3992f Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 15:02:03 -0400 Subject: [PATCH 07/17] Update-LogicMonitorModule explicitly calling PSGallery #63 --- Private/Update-LogicMonitorModule.ps1 | 37 ++------------------------- README.md | 1 - 2 files changed, 2 insertions(+), 36 deletions(-) diff --git a/Private/Update-LogicMonitorModule.ps1 b/Private/Update-LogicMonitorModule.ps1 index 73a7135..028263c 100644 --- a/Private/Update-LogicMonitorModule.ps1 +++ b/Private/Update-LogicMonitorModule.ps1 @@ -41,8 +41,6 @@ function Update-LogicMonitorModule { [Switch]$CheckOnly ) - $psGalleryAvailable = $null - foreach ($Module in $Modules) { try { # Read the currently installed version @@ -65,43 +63,13 @@ function Update-LogicMonitorModule { continue } - if ($null -eq $psGalleryAvailable) { - try { - $repository = Get-PSRepository -Name 'PSGallery' -ErrorAction Stop - if (-not $repository) { - $psGalleryAvailable = $false - } - else { - try { - $probeUri = 'https://www.powershellgallery.com/api/v2/Packages?$top=1&$skip=0' - Invoke-RestMethod -Uri $probeUri -Method Get -TimeoutSec 5 -ErrorAction Stop | Out-Null - $psGalleryAvailable = $true - } - catch { - Write-Verbose "Unable to reach PSGallery endpoint ($probeUri). $_" - $psGalleryAvailable = $false - } - } - } - catch { - Write-Verbose "PSGallery repository is not registered on this host. $_" - $psGalleryAvailable = $false - } - } - - if (-not $psGalleryAvailable) { - Write-Verbose "PSGallery repository is unavailable; skipping update check for module $Module." - continue - } - # Lookup the latest version online try { - $Online = Find-Module -Name $Module -Repository 'PSGallery' -ErrorAction Stop + $Online = Find-Module -Name $Module -ErrorAction Stop $OnlineVersion = $Online.Version } catch { Write-Verbose "Unable to query online version for module $Module. $_" - $psGalleryAvailable = $false continue } @@ -131,11 +99,10 @@ function Update-LogicMonitorModule { Write-Information "[INFO]: Installing newer Module $Module version $OnlineVersion." try { - Install-Module -Name $Module -Repository 'PSGallery' -Force -AllowClobber -Verbose:$False -MinimumVersion $OnlineVersion -ErrorAction Stop + Install-Module -Name $Module -Force -AllowClobber -Verbose:$False -MinimumVersion $OnlineVersion -ErrorAction Stop } catch { Write-Verbose "Failed to install module $Module version $OnlineVersion. $_" - $psGalleryAvailable = $false continue } diff --git a/README.md b/README.md index 7ece28f..0953a3f 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,6 @@ Connect-LMAccount -UseCachedCredential #Connected to LM portal portalnamesandbox using account ``` - # Change List ## 7.7.0 From b4299968e97472b81d547312a7fb95476fdbaa9e Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 15:24:21 -0400 Subject: [PATCH 08/17] Update Format-LMFilter.ps1 --- Private/Format-LMFilter.ps1 | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Private/Format-LMFilter.ps1 b/Private/Format-LMFilter.ps1 index 72a4253..2aba792 100644 --- a/Private/Format-LMFilter.ps1 +++ b/Private/Format-LMFilter.ps1 @@ -73,7 +73,16 @@ function Format-LMFilter { } } else { - $FormatedFilter += $SingleFilter.Replace("'", "`"") #replace single quotes with double quotes as reqired by LM API + if ($SingleFilter -match "^(\s*)'(.*)'(\s*)$") { + $Leading = $Matches[1] + $Value = $Matches[2] + $Trailing = $Matches[3] + $EscapedValue = $Value.Replace('"', '\"') + $FormatedFilter += $Leading + '"' + $EscapedValue + '"' + $Trailing + } + else { + $FormatedFilter += $SingleFilter + } } } } From aae20b8f2934ebc6c08cb40b97299cfa051af5a0 Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 15:33:05 -0400 Subject: [PATCH 09/17] Update Set/New-LMWebsite, add alertExpr alias and update synopsis When using get-lmwebsite, there is a property called alertExpr. However, that doesn't appear anywhere on the documentation page. In this set-lmwebsite command, it's referred to as -SSLAlertThresholds. If a note could be added somewhere letting us know that those are the same thing, that'd be great. --- Public/New-LMWebsite.ps1 | 3 ++- Public/Set-LMWebsite.ps1 | 4 ++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/Public/New-LMWebsite.ps1 b/Public/New-LMWebsite.ps1 index 53857f0..be14f08 100644 --- a/Public/New-LMWebsite.ps1 +++ b/Public/New-LMWebsite.ps1 @@ -51,7 +51,7 @@ Specifies the domain of the website to check. Specifies the HTTP type to use for the website check. The valid values are "http" and "https". The default value is "https". .PARAMETER SSLAlertThresholds -Specifies the SSL alert thresholds for the website check. +Specifies the SSL alert thresholds for the website check. This is an alias for the alertExpr parameter. .PARAMETER PingCount Specifies the number of pings to send for the ping check. The valid values are 5, 10, 15, 20, 30, and 60. @@ -164,6 +164,7 @@ function New-LMWebsite { [String]$HttpType = "https", [Parameter(ParameterSetName = "Website")] + [Alias("alertExpr")] [String[]]$SSLAlertThresholds, [Parameter(ParameterSetName = "Ping")] diff --git a/Public/Set-LMWebsite.ps1 b/Public/Set-LMWebsite.ps1 index 9e1509e..67144b7 100644 --- a/Public/Set-LMWebsite.ps1 +++ b/Public/Set-LMWebsite.ps1 @@ -48,6 +48,9 @@ Specifies how to handle properties. Valid values: "Add", "Replace", "Refresh". .PARAMETER PollingInterval Specifies the polling interval. Valid values: 1-10, 30, 60. +.PARAMETER SSLAlertThresholds +Specifies the SSL alert thresholds for the website check. This is an alias for the alertExpr parameter. + .PARAMETER TestLocationAll Indicates whether to test from all locations. Cannot be used with TestLocationCollectorIds or TestLocationSmgIds. @@ -122,6 +125,7 @@ function Set-LMWebsite { [String]$HttpType, [Parameter(ParameterSetName = "Website")] + [Alias("alertExpr")] [String[]]$SSLAlertThresholds, [Parameter(ParameterSetName = "Ping")] From e4bc73be11bce2845b4346a76cb7c5c184d69e8e Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 17:07:00 -0400 Subject: [PATCH 10/17] Add new report cmdlets and bug fixes - Add Invoke-LMReportExecution - Add Get-LMReportExecutionTask - Fix 'Cannot bind argument to parameter 'InputObject' because it is null' bug when a response is successful but null - Fix -Debug incorrectly in certain situations indicating a GET request as DELETE --- Private/Add-ObjectTypeInfo.ps1 | 1 + Private/Invoke-LMRestMethod.ps1 | 4 ++ Private/New-LMHeader.ps1 | 3 + Private/Resolve-LMDebugInfo.ps1 | 34 +++++++++-- Public/Get-LMReportExecutionTask.ps1 | 77 ++++++++++++++++++++++++ Public/Invoke-LMReportExecution.ps1 | 89 ++++++++++++++++++++++++++++ 6 files changed, 202 insertions(+), 6 deletions(-) create mode 100644 Public/Get-LMReportExecutionTask.ps1 create mode 100644 Public/Invoke-LMReportExecution.ps1 diff --git a/Private/Add-ObjectTypeInfo.ps1 b/Private/Add-ObjectTypeInfo.ps1 index 3a1c9c9..a8d0f56 100644 --- a/Private/Add-ObjectTypeInfo.ps1 +++ b/Private/Add-ObjectTypeInfo.ps1 @@ -101,6 +101,7 @@ function Add-ObjectTypeInfo { Position = 0, ValueFromPipeline = $true )] + [AllowNull()] $InputObject, [Parameter( Mandatory = $false, diff --git a/Private/Invoke-LMRestMethod.ps1 b/Private/Invoke-LMRestMethod.ps1 index 8df009d..959ebbd 100644 --- a/Private/Invoke-LMRestMethod.ps1 +++ b/Private/Invoke-LMRestMethod.ps1 @@ -94,6 +94,10 @@ function Invoke-LMRestMethod { while (-not $success -and $retryCount -le $MaxRetries) { try { + if ($Headers.ContainsKey('__LMMethod')) { + $Headers.Remove('__LMMethod') | Out-Null + } + # Build parameters for Invoke-RestMethod $params = @{ Uri = $Uri diff --git a/Private/New-LMHeader.ps1 b/Private/New-LMHeader.ps1 index bf7f1c0..582ce57 100644 --- a/Private/New-LMHeader.ps1 +++ b/Private/New-LMHeader.ps1 @@ -130,5 +130,8 @@ function New-LMHeader { $Header.Add("Content-Type", $ContentType) $Header.Add("X-Version", $Version) + # Store HTTP method for diagnostics; removed prior to request dispatch + $Header.Add("__LMMethod", $Method) + return @($Header, $Session) } diff --git a/Private/Resolve-LMDebugInfo.ps1 b/Private/Resolve-LMDebugInfo.ps1 index f18c581..7f65ac6 100644 --- a/Private/Resolve-LMDebugInfo.ps1 +++ b/Private/Resolve-LMDebugInfo.ps1 @@ -43,13 +43,35 @@ function Resolve-LMDebugInfo { # Add timestamp for correlation $Timestamp = Get-Date -Format "yyyy-MM-dd HH:mm:ss.fff" - # Extract HTTP method from headers or default to GET - $HttpMethod = if ($Headers.ContainsKey('Content-Type') -and $Payload) { - if ($Payload -match '".*":\s*null|".*":\s*""') { "PATCH" } else { "POST" } + $HttpMethod = $null + + if ($Headers.ContainsKey('__LMMethod')) { + $HttpMethod = $Headers['__LMMethod'] + $Headers.Remove('__LMMethod') | Out-Null + } + + if (-not $HttpMethod) { + $CommandName = $Command.MyCommand.Name + switch -Regex ($CommandName) { + '^(Get|Find|Search|Test|Resolve|Format|Measure|Show)-' { $HttpMethod = 'GET'; break } + '^(Remove|Uninstall|Disconnect|Stop|Clear|Delete)-' { $HttpMethod = 'DELETE'; break } + '^(Set|Update|Enable|Disable|Rename|Move|Merge|Patch|Edit)-' { $HttpMethod = 'PATCH'; break } + '^(New|Add|Copy|Send|Import|Invoke|Start|Publish|Submit|Approve)-' { $HttpMethod = 'POST'; break } + } + } + + if (-not $HttpMethod) { + if ($Headers.ContainsKey('Content-Type') -and $Payload) { + if ($Payload -match '".*":\s*null|".*":\s*""') { $HttpMethod = 'PATCH' } + else { $HttpMethod = 'POST' } + } + elseif ($Payload) { + $HttpMethod = 'POST' + } + else { + $HttpMethod = 'GET' + } } - elseif ($Url -match '/\d+$' -and !$Payload) { "GET" } - elseif (!$Payload) { "DELETE" } - else { "POST" } Write-Debug "============ LogicMonitor API Debug Info ==============" Write-Debug "Command: $($Command.MyCommand) | Method: $HttpMethod | Timestamp: $Timestamp" diff --git a/Public/Get-LMReportExecutionTask.ps1 b/Public/Get-LMReportExecutionTask.ps1 new file mode 100644 index 0000000..7402a2d --- /dev/null +++ b/Public/Get-LMReportExecutionTask.ps1 @@ -0,0 +1,77 @@ +<# +.SYNOPSIS +Retrieves the status of a LogicMonitor report execution task. + +.DESCRIPTION +Get-LMReportExecutionTask fetches information about a previously triggered report execution task. +Supply the report identifier (ID or name) along with the task ID returned from +Invoke-LMReportExecution to check completion status or retrieve the result URL. + +.PARAMETER ReportId +The ID of the report whose execution task should be retrieved. + +.PARAMETER ReportName +The name of the report whose execution task should be retrieved. + +.PARAMETER TaskId +The execution task identifier returned when the report was triggered. + +.EXAMPLE +Invoke-LMReportExecution -Id 42 | Select-Object -ExpandProperty taskId | Get-LMReportExecutionTask -ReportId 42 + +Gets the execution status for the specified report/task combination. + +.EXAMPLE +$task = Invoke-LMReportExecution -Name "Monthly Availability" +Get-LMReportExecutionTask -ReportName "Monthly Availability" -TaskId $task.taskId + +Checks the task status for the report by name. + +.NOTES +You must run Connect-LMAccount before running this command. +#> +function Get-LMReportExecutionTask { + + [CmdletBinding(DefaultParameterSetName = 'ReportId')] + param ( + [Parameter(Mandatory, ParameterSetName = 'ReportId')] + [Int]$ReportId, + + [Parameter(Mandatory, ParameterSetName = 'ReportName')] + [String]$ReportName, + + [Parameter(Mandatory)] + [String]$TaskId + ) + + if (-not $Script:LMAuth.Valid) { + Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." + return + } + + $resolvedReportId = $null + + switch ($PSCmdlet.ParameterSetName) { + 'ReportId' { + $resolvedReportId = $ReportId + } + 'ReportName' { + $lookup = Get-LMReport -Name $ReportName + if (Test-LookupResult -Result $lookup.Id -LookupString $ReportName) { + return + } + $resolvedReportId = $lookup.Id + } + } + + $resourcePath = "/report/reports/$resolvedReportId/tasks/$TaskId" + $headers = New-LMHeader -Auth $Script:LMAuth -Method 'GET' -ResourcePath $resourcePath + $uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $resourcePath + + Resolve-LMDebugInfo -Url $uri -Headers $headers[0] -Command $MyInvocation + + $response = Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $uri -Method 'GET' -Headers $headers[0] -WebSession $headers[1] + + return (Add-ObjectTypeInfo -InputObject $response -TypeName 'LogicMonitor.ReportExecutionTask') +} + diff --git a/Public/Invoke-LMReportExecution.ps1 b/Public/Invoke-LMReportExecution.ps1 new file mode 100644 index 0000000..70658f0 --- /dev/null +++ b/Public/Invoke-LMReportExecution.ps1 @@ -0,0 +1,89 @@ +<# +.SYNOPSIS +Triggers the execution of a LogicMonitor report. + +.DESCRIPTION +Invoke-LMReportExecution starts an on-demand run of a LogicMonitor report. The report can be +identified by ID or name. Optional parameters allow impersonating another admin or overriding the +email recipients for the generated output. + +.PARAMETER Id +The ID of the report to execute. + +.PARAMETER Name +The name of the report to execute. + +.PARAMETER WithAdminId +The admin ID to impersonate when generating the report. Defaults to the current user when omitted. + +.PARAMETER ReceiveEmails +One or more email addresses (comma-separated) that should receive the generated report. + +.EXAMPLE +Invoke-LMReportExecution -Id 42 + +Starts an immediate execution of the report with ID 42 using the current user's context. + +.EXAMPLE +Invoke-LMReportExecution -Name "Monthly Availability" -WithAdminId 101 -ReceiveEmails "ops@example.com" + +Runs the "Monthly Availability" report as admin ID 101 and emails the results to ops@example.com. + +.NOTES +You must run Connect-LMAccount before running this command. +#> +function Invoke-LMReportExecution { + + [CmdletBinding(DefaultParameterSetName = 'Id')] + param ( + [Parameter(Mandatory, ParameterSetName = 'Id')] + [Int]$Id, + + [Parameter(Mandatory, ParameterSetName = 'Name')] + [String]$Name, + + [Int]$WithAdminId = 0, + + [String]$ReceiveEmails + ) + + if (-not $Script:LMAuth.Valid) { + Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." + return + } + + $reportId = $null + + switch ($PSCmdlet.ParameterSetName) { + 'Id' { + $reportId = $Id + } + 'Name' { + $lookup = Get-LMReport -Name $Name + if (Test-LookupResult -Result $lookup.Id -LookupString $Name) { + return + } + $reportId = $lookup.Id + } + } + + $resourcePath = "/report/reports/$reportId/executions" + + $Data = @{ + withAdminId = $WithAdminId + receiveEmails = $ReceiveEmails + } + + $body = Format-LMData -Data $Data -UserSpecifiedKeys $PSBoundParameters.Keys + + $headers = New-LMHeader -Auth $Script:LMAuth -Method 'POST' -ResourcePath $resourcePath -Data $body + + $uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $resourcePath + + Resolve-LMDebugInfo -Url $uri -Headers $headers[0] -Command $MyInvocation -Payload $body + + $response = Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $uri -Method 'POST' -Headers $headers[0] -WebSession $headers[1] -Body $body + + return (Add-ObjectTypeInfo -InputObject $response -TypeName 'LogicMonitor.ReportExecutionTask') +} + From 29eb08b096eacfefdba8b8fd638c6eaad059de1e Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 22:40:10 -0400 Subject: [PATCH 11/17] Add Integration cmdlets ### New Cmdlets - **Get-LMIntegration**: Retrieve integration configurations from LogicMonitor. - **Remove-LMIntegration**: Remove integrations by ID or name. - **Remove-LMEscalationChain**: Remove escalation chains by ID or name. --- Logic.Monitor.Format.ps1xml | 47 ++++++++++++ Public/Get-LMIntegration.ps1 | 113 ++++++++++++++++++++++++++++ Public/Remove-LMEscalationChain.ps1 | 91 ++++++++++++++++++++++ Public/Remove-LMIntegration.ps1 | 91 ++++++++++++++++++++++ README.md | 26 +++++++ 5 files changed, 368 insertions(+) create mode 100644 Public/Get-LMIntegration.ps1 create mode 100644 Public/Remove-LMEscalationChain.ps1 create mode 100644 Public/Remove-LMIntegration.ps1 diff --git a/Logic.Monitor.Format.ps1xml b/Logic.Monitor.Format.ps1xml index 4c95b50..404b522 100644 --- a/Logic.Monitor.Format.ps1xml +++ b/Logic.Monitor.Format.ps1xml @@ -1453,6 +1453,53 @@ + + + LogicMonitorIntegration + + LogicMonitor.Integration + + + + + + + + + + + + + + + + + + + + + + + + id + + + name + + + type + + + enabledStatus + + + description + + + + + + LogicMonitorRecentlyDeleted diff --git a/Public/Get-LMIntegration.ps1 b/Public/Get-LMIntegration.ps1 new file mode 100644 index 0000000..3ae3c07 --- /dev/null +++ b/Public/Get-LMIntegration.ps1 @@ -0,0 +1,113 @@ +<# +.SYNOPSIS +Retrieves integrations from LogicMonitor. + +.DESCRIPTION +The Get-LMIntegration function retrieves integration configurations from LogicMonitor. It can retrieve all integrations, a specific integration by ID or name, or filter the results. + +.PARAMETER Id +The ID of the specific integration to retrieve. + +.PARAMETER Name +The name of the specific integration to retrieve. + +.PARAMETER Filter +A filter object to apply when retrieving integrations. + +.PARAMETER BatchSize +The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + +.EXAMPLE +#Retrieve all integrations +Get-LMIntegration + +.EXAMPLE +#Retrieve a specific integration by name +Get-LMIntegration -Name "Slack-Integration" + +.NOTES +You must run Connect-LMAccount before running this command. + +.INPUTS +None. You cannot pipe objects to this command. + +.OUTPUTS +Returns integration objects from LogicMonitor. +#> + +function Get-LMIntegration { + + [CmdletBinding(DefaultParameterSetName = 'All')] + param ( + [Parameter(ParameterSetName = 'Id')] + [Int]$Id, + + [Parameter(ParameterSetName = 'Name')] + [String]$Name, + + [Parameter(ParameterSetName = 'Filter')] + [Object]$Filter, + + [ValidateRange(1, 1000)] + [Int]$BatchSize = 1000 + ) + #Check if we are logged in and have valid api creds + if ($Script:LMAuth.Valid) { + + #Build header and uri + $ResourcePath = "/setting/integrations" + + #Initalize vars + $QueryParams = "" + $Count = 0 + $Done = $false + $Results = @() + + #Loop through requests + while (!$Done) { + #Build query params + switch ($PSCmdlet.ParameterSetName) { + "All" { $QueryParams = "?size=$BatchSize&offset=$Count&sort=+id" } + "Id" { $resourcePath += "/$Id" } + "Name" { $QueryParams = "?filter=name:`"$Name`"&size=$BatchSize&offset=$Count&sort=+id" } + "Filter" { + #List of allowed filter props + $PropList = @() + $ValidFilter = Format-LMFilter -Filter $Filter -PropList $PropList + $QueryParams = "?filter=$ValidFilter&size=$BatchSize&offset=$Count&sort=+id" + } + } + + $Headers = New-LMHeader -Auth $Script:LMAuth -Method "GET" -ResourcePath $ResourcePath + $Uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $ResourcePath + $QueryParams + + + + Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation + + #Issue request + $Response = Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $Uri -Method "GET" -Headers $Headers[0] -WebSession $Headers[1] + + #Stop looping if single device, no need to continue + if ($PSCmdlet.ParameterSetName -eq "Id") { + $Done = $true + return (Add-ObjectTypeInfo -InputObject $Response -TypeName "LogicMonitor.Integration" ) + } + #Check result size and if needed loop again + else { + [Int]$Total = $Response.Total + [Int]$Count += ($Response.Items | Measure-Object).Count + $Results += $Response.Items + if ($Count -ge $Total) { + $Done = $true + } + } + + } + return (Add-ObjectTypeInfo -InputObject $Results -TypeName "LogicMonitor.Integration" ) + } + else { + Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." + } +} + diff --git a/Public/Remove-LMEscalationChain.ps1 b/Public/Remove-LMEscalationChain.ps1 new file mode 100644 index 0000000..890a68c --- /dev/null +++ b/Public/Remove-LMEscalationChain.ps1 @@ -0,0 +1,91 @@ +<# +.SYNOPSIS +Removes a LogicMonitor escalation chain. + +.DESCRIPTION +The Remove-LMEscalationChain function removes a LogicMonitor escalation chain based on either its ID or name. + +.PARAMETER Id +Specifies the ID of the escalation chain to be removed. This parameter is mandatory when using the 'Id' parameter set. + +.PARAMETER Name +Specifies the name of the escalation chain to be removed. This parameter is mandatory when using the 'Name' parameter set. + +.EXAMPLE +Remove-LMEscalationChain -Id 12345 +Removes the LogicMonitor escalation chain with ID 12345. + +.EXAMPLE +Remove-LMEscalationChain -Name "Critical-Alerts" +Removes the LogicMonitor escalation chain with the name "Critical-Alerts". + +.INPUTS +You can pipe input to this function. + +.OUTPUTS +Returns a PSCustomObject containing the ID of the removed escalation chain and a message indicating the success of the removal operation. +#> +function Remove-LMEscalationChain { + + [CmdletBinding(DefaultParameterSetName = 'Id', SupportsShouldProcess, ConfirmImpact = 'High')] + param ( + [Parameter(Mandatory, ParameterSetName = 'Id', ValueFromPipelineByPropertyName)] + [Int]$Id, + + [Parameter(Mandatory, ParameterSetName = 'Name')] + [String]$Name + + ) + #Check if we are logged in and have valid api creds + begin {} + process { + if ($Script:LMAuth.Valid) { + + #Lookup Id if supplying name + if ($Name) { + $LookupResult = (Get-LMEscalationChain -Name $Name).Id + if (Test-LookupResult -Result $LookupResult -LookupString $Name) { + return + } + $Id = $LookupResult + } + + if ($PSItem) { + $Message = "Id: $Id | Name: $($PSItem.name)" + } + elseif ($Name) { + $Message = "Id: $Id | Name: $Name" + } + else { + $Message = "Id: $Id" + } + + #Build header and uri + $ResourcePath = "/setting/alert/chains/$Id" + + + if ($PSCmdlet.ShouldProcess($Message, "Remove Escalation Chain")) { + $Headers = New-LMHeader -Auth $Script:LMAuth -Method "DELETE" -ResourcePath $ResourcePath + $Uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $ResourcePath + + Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation + + #Issue request + Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $Uri -Method "DELETE" -Headers $Headers[0] -WebSession $Headers[1] | Out-Null + + $Result = [PSCustomObject]@{ + Id = $Id + Message = "Successfully removed ($Message)" + } + + return $Result + } + + } + else { + Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." + } + } + end {} +} + diff --git a/Public/Remove-LMIntegration.ps1 b/Public/Remove-LMIntegration.ps1 new file mode 100644 index 0000000..797d2be --- /dev/null +++ b/Public/Remove-LMIntegration.ps1 @@ -0,0 +1,91 @@ +<# +.SYNOPSIS +Removes a LogicMonitor integration. + +.DESCRIPTION +The Remove-LMIntegration function removes a LogicMonitor integration based on either its ID or name. + +.PARAMETER Id +Specifies the ID of the integration to be removed. This parameter is mandatory when using the 'Id' parameter set. + +.PARAMETER Name +Specifies the name of the integration to be removed. This parameter is mandatory when using the 'Name' parameter set. + +.EXAMPLE +Remove-LMIntegration -Id 12345 +Removes the LogicMonitor integration with ID 12345. + +.EXAMPLE +Remove-LMIntegration -Name "Slack-Integration" +Removes the LogicMonitor integration with the name "Slack-Integration". + +.INPUTS +You can pipe input to this function. + +.OUTPUTS +Returns a PSCustomObject containing the ID of the removed integration and a message indicating the success of the removal operation. +#> +function Remove-LMIntegration { + + [CmdletBinding(DefaultParameterSetName = 'Id', SupportsShouldProcess, ConfirmImpact = 'High')] + param ( + [Parameter(Mandatory, ParameterSetName = 'Id', ValueFromPipelineByPropertyName)] + [Int]$Id, + + [Parameter(Mandatory, ParameterSetName = 'Name')] + [String]$Name + + ) + #Check if we are logged in and have valid api creds + begin {} + process { + if ($Script:LMAuth.Valid) { + + #Lookup Id if supplying name + if ($Name) { + $LookupResult = (Get-LMIntegration -Name $Name).Id + if (Test-LookupResult -Result $LookupResult -LookupString $Name) { + return + } + $Id = $LookupResult + } + + if ($PSItem) { + $Message = "Id: $Id | Name: $($PSItem.name)" + } + elseif ($Name) { + $Message = "Id: $Id | Name: $Name" + } + else { + $Message = "Id: $Id" + } + + #Build header and uri + $ResourcePath = "/setting/integrations/$Id" + + + if ($PSCmdlet.ShouldProcess($Message, "Remove Integration")) { + $Headers = New-LMHeader -Auth $Script:LMAuth -Method "DELETE" -ResourcePath $ResourcePath + $Uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $ResourcePath + + Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation + + #Issue request + Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $Uri -Method "DELETE" -Headers $Headers[0] -WebSession $Headers[1] | Out-Null + + $Result = [PSCustomObject]@{ + Id = $Id + Message = "Successfully removed ($Message)" + } + + return $Result + } + + } + else { + Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." + } + } + end {} +} + diff --git a/README.md b/README.md index 0953a3f..db8438c 100644 --- a/README.md +++ b/README.md @@ -79,10 +79,23 @@ Connect-LMAccount -UseCachedCredential - **Get-LMRecentlyDeleted**: Retrieve recycle-bin entries with optional date, resource type, and deleted-by filters. - **Restore-LMRecentlyDeleted**: Batch restore recycle-bin items by recycle identifier. - **Remove-LMRecentlyDeleted**: Permanently delete recycle-bin entries in bulk. +- **Get-LMIntegration**: Retrieve integration configurations from LogicMonitor. +- **Remove-LMIntegration**: Remove integrations by ID or name. +- **Remove-LMEscalationChain**: Remove escalation chains by ID or name. +- **Invoke-LMReportExecution**: Trigger on-demand execution of LogicMonitor reports with optional admin impersonation and custom email recipients. +- **Get-LMReportExecutionTask**: Check the status and retrieve results of previously triggered report executions. ### Updated Cmdlets - **Update-LogicMonitorModule**: Hardened for non-blocking version checks; failures are logged via `Write-Verbose` and never terminate connecting cmdlets. - **Export-LMDeviceData**: CSV exports now expand datapoints into individual rows and JSON exports capture deeper datapoint structures. +- **Set-LMWebsite**: Added `alertExpr` alias for `SSLAlertThresholds` parameter for improved API compatibility. Updated synopsis to reflect enhanced parameter validation. +- **New-LMWebsite**: Added `alertExpr` alias for `SSLAlertThresholds` parameter for improved API compatibility. +- **Format-LMFilter**: Enhanced filter string escaping to properly handle special characters like parentheses, dollar signs, ampersands, and brackets in filter expressions. + +### Bug Fixes +- **Add-ObjectTypeInfo**: Fixed "Cannot bind argument to parameter 'InputObject' because it is null" error by adding `[AllowNull()]` attribute to handle successful but null API responses. +- **Resolve-LMDebugInfo**: Improved HTTP method detection logic to correctly identify request types (GET, POST, PATCH, DELETE) based on cmdlet naming conventions and headers, fixing incorrect debug output. +- **Invoke-LMRestMethod**: Added cleanup of internal `__LMMethod` diagnostic header before dispatching requests to prevent API errors. ### Examples ```powershell @@ -97,6 +110,19 @@ Get-LMRecentlyDeleted -DeletedAfter (Get-Date).AddMonths(-1) | Select-Object -Ex # Export device datapoints to CSV with flattened datapoint rows Export-LMDeviceData -DeviceId 12345 -StartDate (Get-Date).AddHours(-6) -ExportFormat csv -ExportPath "C:\\Exports" + +# Retrieve all integrations +Get-LMIntegration + +# Remove an integration by name +Remove-LMIntegration -Name "Slack-Integration" + +# Remove an escalation chain by ID +Remove-LMEscalationChain -Id 123 + +# Trigger a report execution and check its status +$task = Invoke-LMReportExecution -Name "Monthly Availability" -WithAdminId 101 -ReceiveEmails "ops@example.com" +Get-LMReportExecutionTask -ReportName "Monthly Availability" -TaskId $task.taskId ``` From de5c03fddac696ede4fe27b977df4ed0b1d6b05e Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 23:45:35 -0400 Subject: [PATCH 12/17] Add Invoke-LMAPIRequest cmdlet --- Documentation/Invoke-LMAPIRequest.md | 361 +++++++++++++ .../Utilities/Invoke-LMAPIRequest-Guide.md | 473 ++++++++++++++++++ Public/Invoke-LMAPIRequest.ps1 | 336 +++++++++++++ README.md | 16 + 4 files changed, 1186 insertions(+) create mode 100644 Documentation/Invoke-LMAPIRequest.md create mode 100644 Documentation/Utilities/Invoke-LMAPIRequest-Guide.md create mode 100644 Public/Invoke-LMAPIRequest.ps1 diff --git a/Documentation/Invoke-LMAPIRequest.md b/Documentation/Invoke-LMAPIRequest.md new file mode 100644 index 0000000..19f84ed --- /dev/null +++ b/Documentation/Invoke-LMAPIRequest.md @@ -0,0 +1,361 @@ +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Invoke-LMAPIRequest + +## SYNOPSIS +Executes a custom LogicMonitor API request with full control over endpoint and payload. + +## SYNTAX + +### Data (Default) +``` +Invoke-LMAPIRequest -ResourcePath -Method [-QueryParams ] [-Data ] + [-Version ] [-ContentType ] [-MaxRetries ] [-NoRetry] [-OutFile ] + [-TypeName ] [-AsHashtable] [-WhatIf] [-Confirm] [] +``` + +### RawBody +``` +Invoke-LMAPIRequest -ResourcePath -Method [-QueryParams ] [-RawBody ] + [-Version ] [-ContentType ] [-MaxRetries ] [-NoRetry] [-OutFile ] + [-TypeName ] [-AsHashtable] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Invoke-LMAPIRequest function provides advanced users with direct access to the LogicMonitor API +while leveraging the module's authentication, retry logic, debug utilities, and error handling. +This is useful for accessing API endpoints that don't yet have dedicated cmdlets in the module. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method GET +``` + +Get a custom resource not yet supported by a dedicated cmdlet. + +### EXAMPLE 2 +```powershell +$data = @{ + name = "My Integration" + type = "slack" + url = "https://hooks.slack.com/services/..." +} +Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method POST -Data $data +``` + +Create a resource with custom payload. + +### EXAMPLE 3 +```powershell +$updates = @{ + description = "Updated description" +} +Invoke-LMAPIRequest -ResourcePath "/device/devices/123" -Method PATCH -Data $updates +``` + +Update a resource with PATCH. + +### EXAMPLE 4 +```powershell +Invoke-LMAPIRequest -ResourcePath "/setting/integrations/456" -Method DELETE +``` + +Delete a resource. + +### EXAMPLE 5 +```powershell +$queryParams = @{ + size = 500 + filter = 'status:"active"' + fields = "id,name,status" +} +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams $queryParams -Version 3 +``` + +Get with query parameters and custom version. + +### EXAMPLE 6 +```powershell +$rawJson = '{"name":"test","customField":null}' +Invoke-LMAPIRequest -ResourcePath "/custom/endpoint" -Method POST -RawBody $rawJson +``` + +Use raw body for special formatting requirements. + +### EXAMPLE 7 +```powershell +Invoke-LMAPIRequest -ResourcePath "/report/reports/123/download" -Method GET -OutFile "C:\Reports\report.pdf" +``` + +Download a report to file. + +### EXAMPLE 8 +```powershell +$offset = 0 +$size = 1000 +$allResults = @() +do { + $response = Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams @{ size = $size; offset = $offset } + $allResults += $response.items + $offset += $size +} while ($allResults.Count -lt $response.total) +``` + +Get paginated results manually. + +## PARAMETERS + +### -ResourcePath +The API resource path (e.g., "/device/devices", "/setting/integrations/123"). +Do not include the base URL or query parameters here. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Method +The HTTP method to use. Valid values: GET, POST, PATCH, PUT, DELETE. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: GET, POST, PATCH, PUT, DELETE + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryParams +Optional hashtable of query parameters to append to the request URL. +Example: @{ size = 100; offset = 0; filter = 'name:"test"' } + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Data +Optional hashtable containing the request body data. Will be automatically converted to JSON. +Use this for POST, PATCH, and PUT requests. + +```yaml +Type: Hashtable +Parameter Sets: Data +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RawBody +Optional raw string body to send with the request. Use this instead of -Data when you need +complete control over the request body format. Mutually exclusive with -Data. + +```yaml +Type: String +Parameter Sets: RawBody +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +The X-Version header value for the API request. Defaults to 3. +Some newer API endpoints may require different version numbers. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentType +The Content-Type header for the request. Defaults to "application/json". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: application/json +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxRetries +Maximum number of retry attempts for transient errors. Defaults to 3. +Set to 0 to disable retries. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoRetry +Switch to completely disable retry logic and fail immediately on any error. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutFile +Path to save the response content to a file. Useful for downloading reports or exports. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TypeName +Optional type name to add to the returned objects (e.g., "LogicMonitor.CustomResource"). +This enables proper formatting if you have custom format definitions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsHashtable +Switch to return the response as a hashtable instead of a PSCustomObject. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +You cannot pipe objects to this command. + +## OUTPUTS + +### System.Object +Returns the API response as a PSCustomObject by default, or as specified by -AsHashtable. + +## NOTES +You must run Connect-LMAccount before running this command. + +This cmdlet is designed for advanced users who need to: +- Access API endpoints not yet covered by dedicated cmdlets +- Test new API features or beta endpoints +- Implement custom workflows requiring direct API access +- Prototype new functionality before requesting cmdlet additions + +For standard operations, use the dedicated cmdlets (Get-LMDevice, New-LMDevice, etc.) as they +provide better parameter validation, documentation, and user experience. + +## RELATED LINKS + +[Module Documentation](https://logicmonitor.github.io/lm-powershell-module-docs/) + diff --git a/Documentation/Utilities/Invoke-LMAPIRequest-Guide.md b/Documentation/Utilities/Invoke-LMAPIRequest-Guide.md new file mode 100644 index 0000000..d0b4344 --- /dev/null +++ b/Documentation/Utilities/Invoke-LMAPIRequest-Guide.md @@ -0,0 +1,473 @@ +# Invoke-LMAPIRequest - Advanced User Guide + +## Overview + +`Invoke-LMAPIRequest` is a universal API request cmdlet designed for advanced users who need direct access to LogicMonitor API endpoints that don't yet have dedicated cmdlets in the module. It provides full control over API requests while leveraging the module's robust infrastructure. + +## Why Use This Cmdlet? + +### Problem Statement +With over 200+ cmdlets in the Logic.Monitor module, we still don't cover every API endpoint. Advanced users who discover new endpoints in the LogicMonitor API documentation often have to: +- Reinvent authentication handling +- Implement retry logic for transient failures +- Handle rate limiting manually +- Build debug utilities from scratch +- Deal with error handling inconsistencies + +### Solution +`Invoke-LMAPIRequest` provides a "bring your own endpoint" approach that: +- ✅ Uses existing module authentication (API keys, Bearer tokens, Session sync) +- ✅ Leverages built-in retry logic with exponential backoff +- ✅ Integrates with module debug utilities (`-Debug`, `Resolve-LMDebugInfo`) +- ✅ Handles rate limiting automatically +- ✅ Provides consistent error handling +- ✅ Supports all HTTP methods (GET, POST, PATCH, PUT, DELETE) +- ✅ Allows custom API version headers +- ✅ Includes ShouldProcess support for safety + +## Key Features + +### 1. Full CRUD Operation Support +```powershell +# CREATE - POST +$data = @{ name = "New Resource"; type = "custom" } +Invoke-LMAPIRequest -ResourcePath "/custom/endpoint" -Method POST -Data $data + +# READ - GET +Invoke-LMAPIRequest -ResourcePath "/custom/endpoint/123" -Method GET + +# UPDATE - PATCH +$updates = @{ description = "Updated" } +Invoke-LMAPIRequest -ResourcePath "/custom/endpoint/123" -Method PATCH -Data $updates + +# DELETE +Invoke-LMAPIRequest -ResourcePath "/custom/endpoint/123" -Method DELETE +``` + +**Important:** You must format data according to the API's requirements. For example, `customProperties` must be an array: +```powershell +# ❌ Wrong - simple hashtable +$data = @{ + name = "device1" + customProperties = @{ prop1 = "value1" } +} + +# ✅ Correct - array of name/value objects +$data = @{ + name = "device1" + customProperties = @( + @{ name = "prop1"; value = "value1" } + @{ name = "prop2"; value = "value2" } + ) +} +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method POST -Data $data +``` + +### 2. Query Parameter Support +```powershell +$queryParams = @{ + size = 1000 + offset = 0 + filter = 'status:"active"' + fields = "id,name,status,created" + sort = "+name" +} +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams $queryParams +``` + +### 3. Custom API Versions +Some newer LogicMonitor API endpoints require different version numbers: +```powershell +# Use API version 4 for newer endpoints +Invoke-LMAPIRequest -ResourcePath "/new/endpoint" -Method GET -Version 4 +``` + +### 4. Raw Body Control +For special cases where you need exact control over JSON formatting: +```powershell +$rawJson = @" +{ + "name": "test", + "customField": null, + "preservedFormatting": true +} +"@ +Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method POST -RawBody $rawJson +``` + +### 5. File Downloads +```powershell +# Download reports or exports +Invoke-LMAPIRequest -ResourcePath "/report/reports/123/download" -Method GET -OutFile "C:\Reports\monthly.pdf" +``` + +### 6. Manual Pagination +```powershell +function Get-AllDevicesManually { + $offset = 0 + $size = 1000 + $allResults = @() + + do { + $response = Invoke-LMAPIRequest ` + -ResourcePath "/device/devices" ` + -Method GET ` + -QueryParams @{ size = $size; offset = $offset; sort = "+id" } + + $allResults += $response.items + $offset += $size + Write-Progress -Activity "Fetching devices" -Status "$($allResults.Count) of $($response.total)" + } while ($allResults.Count -lt $response.total) + + return $allResults +} +``` + +### 7. Type Information +Add custom type names for proper formatting: +```powershell +$result = Invoke-LMAPIRequest ` + -ResourcePath "/custom/endpoint" ` + -Method GET ` + -TypeName "LogicMonitor.CustomResource" +``` + +### 8. Hashtable Output +For easier property manipulation: +```powershell +$result = Invoke-LMAPIRequest ` + -ResourcePath "/device/devices/123" ` + -Method GET ` + -AsHashtable + +$result["customProperty"] = "newValue" +``` + +### 9. Formatting Output +Control how API responses are displayed: +```powershell +# Default: Returns raw objects (PowerShell chooses format automatically) +$devices = Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET + +# For table view, pipe to Format-Table with specific properties +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET | + Format-Table id, name, displayName, status, collectorId + +# Or use Select-Object to choose properties, then let PowerShell format +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET | + Select-Object id, name, displayName, status | + Format-Table -AutoSize + +# For detailed view of a single item +Invoke-LMAPIRequest -ResourcePath "/device/devices/123" -Method GET | Format-List + +# Use custom type name to leverage existing format definitions +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -TypeName "LogicMonitor.Device" +# This will use the LogicMonitor.Device format definition from Logic.Monitor.Format.ps1xml + +# Pipeline remains fully functional +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET | + Where-Object { $_.status -eq 'normal' } | + Select-Object id, name, customProperties | + Export-Csv devices.csv # ✅ Works perfectly! +``` + +**Tip:** For frequently used endpoints, create a wrapper function with custom formatting: +```powershell +function Get-MyCustomResource { + Invoke-LMAPIRequest -ResourcePath "/custom/endpoint" -Method GET | + Format-Table id, name, status, created -AutoSize +} +``` + +## Design Patterns + +### Pattern 1: Testing New API Features +```powershell +# Test a beta endpoint before requesting a dedicated cmdlet +$betaData = @{ + feature = "new-capability" + enabled = $true +} +Invoke-LMAPIRequest -ResourcePath "/beta/features" -Method POST -Data $betaData -Version 4 +``` + +### Pattern 2: Bulk Operations +```powershell +# Bulk update multiple resources +$deviceIds = 1..100 +foreach ($id in $deviceIds) { + $updates = @{ description = "Bulk updated $(Get-Date)" } + Invoke-LMAPIRequest -ResourcePath "/device/devices/$id" -Method PATCH -Data $updates + Start-Sleep -Milliseconds 100 # Rate limiting +} +``` + +### Pattern 3: Custom Workflows +```powershell +# Complex workflow combining multiple API calls +function Deploy-CustomConfiguration { + param($ConfigName, $Targets) + + # Step 1: Create configuration + $config = @{ name = $ConfigName; type = "custom" } + $created = Invoke-LMAPIRequest -ResourcePath "/configs" -Method POST -Data $config + + # Step 2: Apply to targets + foreach ($target in $Targets) { + $assignment = @{ configId = $created.id; targetId = $target } + Invoke-LMAPIRequest -ResourcePath "/configs/assignments" -Method POST -Data $assignment + } + + # Step 3: Verify deployment + $status = Invoke-LMAPIRequest -ResourcePath "/configs/$($created.id)/status" -Method GET + return $status +} +``` + +### Pattern 4: Error Handling +```powershell +try { + $result = Invoke-LMAPIRequest ` + -ResourcePath "/risky/endpoint" ` + -Method POST ` + -Data $data ` + -ErrorAction Stop + + Write-Host "Success: $($result.id)" +} +catch { + Write-Error "API request failed: $($_.Exception.Message)" + # Fallback logic here +} +``` + +## Best Practices + +### 1. Use Dedicated Cmdlets When Available +```powershell +# ❌ Don't do this +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET + +# ✅ Do this instead +Get-LMDevice +``` + +### 2. Validate Input Before Sending +```powershell +function New-CustomResource { + param($Name, $Type) + + # Validate locally first + if ([string]::IsNullOrWhiteSpace($Name)) { + throw "Name cannot be empty" + } + + $data = @{ name = $Name; type = $Type } + Invoke-LMAPIRequest -ResourcePath "/custom/resources" -Method POST -Data $data +} +``` + +### 3. Use -WhatIf for Testing +```powershell +# Test without making actual changes +Invoke-LMAPIRequest ` + -ResourcePath "/device/devices/123" ` + -Method DELETE ` + -WhatIf +``` + +### 4. Leverage Debug Output +```powershell +# Enable debug to see full request details +Invoke-LMAPIRequest ` + -ResourcePath "/endpoint" ` + -Method POST ` + -Data $data ` + -Debug +``` + +### 5. Handle Pagination Properly +```powershell +# For large datasets, use pagination +$size = 1000 # Max batch size +$offset = 0 +do { + $batch = Invoke-LMAPIRequest ` + -ResourcePath "/large/dataset" ` + -Method GET ` + -QueryParams @{ size = $size; offset = $offset } + + Process-Batch $batch.items + $offset += $size +} while ($batch.items.Count -eq $size) +``` + +## Integration with Module Features + +### Authentication +Automatically uses the current session from `Connect-LMAccount`: +```powershell +Connect-LMAccount -AccessId $id -AccessKey $key -AccountName "company" +Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET +# No need to handle auth manually! +``` + +### Retry Logic +Built-in exponential backoff for transient failures: +```powershell +# Automatically retries on 429, 502, 503, 504 +Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -MaxRetries 5 + +# Disable retries for time-sensitive operations +Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -NoRetry +``` + +### Debug Information +Integrates with module debug utilities: +```powershell +# Shows full request details including headers, URL, payload +$DebugPreference = "Continue" +Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method POST -Data $data +``` + +## Common Use Cases + +### 1. Accessing New API Endpoints +```powershell +# LogicMonitor releases a new API endpoint +# Use Invoke-LMAPIRequest until a dedicated cmdlet is available +Invoke-LMAPIRequest -ResourcePath "/new/feature" -Method GET +``` + +### 2. Custom Integrations +```powershell +# Build custom integrations with external systems +$webhookData = @{ + url = "https://external-system.com/webhook" + events = @("alert.created", "alert.cleared") +} +Invoke-LMAPIRequest -ResourcePath "/integrations/webhooks" -Method POST -Data $webhookData +``` + +### 3. Prototyping +```powershell +# Prototype new functionality before requesting cmdlet additions +# Test different approaches quickly +$approaches = @( + @{ method = "approach1"; params = @{} }, + @{ method = "approach2"; params = @{} } +) + +foreach ($approach in $approaches) { + $result = Invoke-LMAPIRequest ` + -ResourcePath "/test/endpoint" ` + -Method POST ` + -Data $approach + + Measure-Performance $result +} +``` + +### 4. Advanced Filtering +```powershell +# Complex filters not yet supported by dedicated cmdlets +$complexFilter = 'name~"prod-*" && status:"active" && customProperties.environment:"production"' +Invoke-LMAPIRequest ` + -ResourcePath "/device/devices" ` + -Method GET ` + -QueryParams @{ filter = $complexFilter; size = 1000 } +``` + +## Troubleshooting + +### Issue: "Invalid json body" or "Cannot deserialize" Errors + +This usually means your data structure doesn't match the API's expected format. + +**Common Issue: customProperties Format** +```powershell +# ❌ Wrong - This will fail +$data = @{ + name = "device1" + customProperties = @{ environment = "prod" } # Simple hashtable +} + +# ✅ Correct - Array of name/value objects +$data = @{ + name = "device1" + customProperties = @( + @{ name = "environment"; value = "prod" } + ) +} +``` + +**Solution:** Check the LogicMonitor API documentation or look at how dedicated cmdlets format the data: +```powershell +# Compare with working cmdlet +New-LMDevice -Name "test" -DisplayName "test" -PreferredCollectorId 1 -Properties @{test="value"} -Debug + +# Look at the "Request Payload" in debug output to see the correct format +``` + +### Issue: Authentication Errors +```powershell +# Verify you're connected +if (-not $Script:LMAuth.Valid) { + Connect-LMAccount -AccessId $id -AccessKey $key -AccountName "company" +} +``` + +### Issue: Rate Limiting +```powershell +# Increase retry attempts or add delays +Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -MaxRetries 10 + +# Or add manual delays in loops +foreach ($item in $items) { + Invoke-LMAPIRequest -ResourcePath "/endpoint/$item" -Method GET + Start-Sleep -Milliseconds 500 +} +``` + +### Issue: Unexpected Response Format +```powershell +# Use -Debug to see raw response +$result = Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -Debug + +# Or capture as hashtable for inspection +$result = Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -AsHashtable +$result.Keys | ForEach-Object { Write-Host "$_: $($result[$_])" } +``` + +## Contributing + +If you find yourself frequently using `Invoke-LMAPIRequest` for a specific endpoint, consider: +1. Opening a GitHub issue requesting a dedicated cmdlet +2. Contributing a PR with the new cmdlet implementation +3. Sharing your use case to help prioritize development + +## Related Cmdlets + +- `Connect-LMAccount` - Establish authentication +- `Get-LMDevice`, `New-LMDevice`, etc. - Dedicated resource cmdlets +- `Build-LMFilter` - Interactive filter builder +- `Invoke-LMRestMethod` - Internal REST method wrapper (not for direct use) + +## Summary + +`Invoke-LMAPIRequest` bridges the gap between the module's current capabilities and the full LogicMonitor API surface area. It empowers advanced users to: +- Access any API endpoint immediately +- Prototype new functionality +- Build custom integrations +- Test beta features + +While maintaining the benefits of: +- Centralized authentication +- Robust error handling +- Automatic retries +- Consistent debugging +- Module best practices + +Use it when you need flexibility, but prefer dedicated cmdlets for routine operations. + diff --git a/Public/Invoke-LMAPIRequest.ps1 b/Public/Invoke-LMAPIRequest.ps1 new file mode 100644 index 0000000..997835f --- /dev/null +++ b/Public/Invoke-LMAPIRequest.ps1 @@ -0,0 +1,336 @@ +<# +.SYNOPSIS +Executes a custom LogicMonitor API request with full control over endpoint and payload. + +.DESCRIPTION +The Invoke-LMAPIRequest function provides advanced users with direct access to the LogicMonitor API +while leveraging the module's authentication, retry logic, debug utilities, and error handling. +This is useful for accessing API endpoints that don't yet have dedicated cmdlets in the module. + +.PARAMETER ResourcePath +The API resource path (e.g., "/device/devices", "/setting/integrations/123"). +Do not include the base URL or query parameters here. + +.PARAMETER Method +The HTTP method to use. Valid values: GET, POST, PATCH, PUT, DELETE. + +.PARAMETER QueryParams +Optional hashtable of query parameters to append to the request URL. +Example: @{ size = 100; offset = 0; filter = 'name:"test"' } + +.PARAMETER Data +Optional hashtable containing the request body data. Will be automatically converted to JSON. +Use this for POST, PATCH, and PUT requests. + +.PARAMETER RawBody +Optional raw string body to send with the request. Use this instead of -Data when you need +complete control over the request body format. Mutually exclusive with -Data. + +.PARAMETER Version +The X-Version header value for the API request. Defaults to 3. +Some newer API endpoints may require different version numbers. + +.PARAMETER ContentType +The Content-Type header for the request. Defaults to "application/json". + +.PARAMETER MaxRetries +Maximum number of retry attempts for transient errors. Defaults to 3. +Set to 0 to disable retries. + +.PARAMETER NoRetry +Switch to completely disable retry logic and fail immediately on any error. + +.PARAMETER OutFile +Path to save the response content to a file. Useful for downloading reports or exports. + +.PARAMETER TypeName +Optional type name to add to the returned objects (e.g., "LogicMonitor.CustomResource"). +This enables proper formatting if you have custom format definitions. + +.PARAMETER AsHashtable +Switch to return the response as a hashtable instead of a PSCustomObject. + +.EXAMPLE +# Get a custom resource not yet supported by a dedicated cmdlet +Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method GET + +.EXAMPLE +# Create a resource with custom payload +$data = @{ + name = "My Integration" + type = "slack" + url = "https://hooks.slack.com/services/..." +} +Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method POST -Data $data + +.EXAMPLE +# Create a device with custom properties (note the array format) +$data = @{ + name = "server1" + displayName = "Production Server" + preferredCollectorId = 5 + customProperties = @( + @{ name = "environment"; value = "production" } + @{ name = "owner"; value = "ops-team" } + ) +} +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method POST -Data $data + +.EXAMPLE +# Update a resource with PATCH +$updates = @{ + description = "Updated description" +} +Invoke-LMAPIRequest -ResourcePath "/device/devices/123" -Method PATCH -Data $updates + +.EXAMPLE +# Delete a resource +Invoke-LMAPIRequest -ResourcePath "/setting/integrations/456" -Method DELETE + +.EXAMPLE +# Get with query parameters and custom version +$queryParams = @{ + size = 500 + filter = 'status:"active"' + fields = "id,name,status" +} +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams $queryParams -Version 3 + +.EXAMPLE +# Use raw body for special formatting requirements +$rawJson = '{"name":"test","customField":null}' +Invoke-LMAPIRequest -ResourcePath "/custom/endpoint" -Method POST -RawBody $rawJson + +.EXAMPLE +# Download a report to file +Invoke-LMAPIRequest -ResourcePath "/report/reports/123/download" -Method GET -OutFile "C:\Reports\report.pdf" + +.EXAMPLE +# Format output as table +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET | Format-Table id, name, displayName, status + +# Use existing format definition +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -TypeName "LogicMonitor.Device" + +.EXAMPLE +# Get paginated results manually +$offset = 0 +$size = 1000 +$allResults = @() +do { + $response = Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams @{ size = $size; offset = $offset } + $allResults += $response.items + $offset += $size +} while ($allResults.Count -lt $response.total) + +.NOTES +You must run Connect-LMAccount before running this command. + +This cmdlet is designed for advanced users who need to: +- Access API endpoints not yet covered by dedicated cmdlets +- Test new API features or beta endpoints +- Implement custom workflows requiring direct API access +- Prototype new functionality before requesting cmdlet additions + +For standard operations, use the dedicated cmdlets (Get-LMDevice, New-LMDevice, etc.) as they +provide better parameter validation, documentation, and user experience. + +.INPUTS +None. You cannot pipe objects to this command. + +.OUTPUTS +Returns the API response as a PSCustomObject by default, or as specified by -AsHashtable. +#> +function Invoke-LMAPIRequest { + + [CmdletBinding(DefaultParameterSetName = 'Data', SupportsShouldProcess, ConfirmImpact = 'Medium')] + param ( + [Parameter(Mandatory)] + [ValidateNotNullOrEmpty()] + [String]$ResourcePath, + + [Parameter(Mandatory)] + [ValidateSet("GET", "POST", "PATCH", "PUT", "DELETE")] + [String]$Method, + + [Hashtable]$QueryParams, + + [Parameter(ParameterSetName = 'Data')] + [Hashtable]$Data, + + [Parameter(ParameterSetName = 'RawBody')] + [String]$RawBody, + + [ValidateRange(1, 10)] + [Int]$Version = 3, + + [String]$ContentType = "application/json", + + [ValidateRange(0, 10)] + [Int]$MaxRetries = 3, + + [Switch]$NoRetry, + + [String]$OutFile, + + [String]$TypeName, + + [Switch]$AsHashtable + ) + + #Check if we are logged in and have valid api creds + if (-not $Script:LMAuth.Valid) { + Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." + return + } + + # Ensure ResourcePath starts with / + if (-not $ResourcePath.StartsWith('/')) { + $ResourcePath = '/' + $ResourcePath + } + + # Build the request body + $Body = $null + if ($PSCmdlet.ParameterSetName -eq 'Data' -and $Data) { + # Convert hashtable to JSON + $Body = $Data | ConvertTo-Json -Depth 10 -Compress + } + elseif ($PSCmdlet.ParameterSetName -eq 'RawBody' -and $RawBody) { + $Body = $RawBody + } + + # Build query string from QueryParams hashtable + $QueryString = "" + if ($QueryParams -and $QueryParams.Count -gt 0) { + $queryParts = @() + foreach ($key in $QueryParams.Keys) { + $value = $QueryParams[$key] + if ($null -ne $value) { + # URL encode the value + $encodedValue = [System.Web.HttpUtility]::UrlEncode($value.ToString()) + $queryParts += "$key=$encodedValue" + } + } + if ($queryParts.Count -gt 0) { + $QueryString = "?" + ($queryParts -join "&") + } + } + + # Build the full URI + $Uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $ResourcePath + $QueryString + + # Create a message for ShouldProcess + $operationDescription = switch ($Method) { + "GET" { "Retrieve from" } + "POST" { "Create resource at" } + "PATCH" { "Update resource at" } + "PUT" { "Replace resource at" } + "DELETE" { "Delete resource at" } + } + + # Adjust ConfirmImpact based on method + $shouldProcessTarget = $ResourcePath + $shouldProcessAction = $operationDescription + + # Determine if we should prompt based on method + # GET requests should never prompt unless explicitly requested + # DELETE requests should always prompt unless explicitly suppressed + $shouldPrompt = $true + if ($Method -eq "GET") { + # For GET, only process if -Confirm was explicitly passed + if ($PSBoundParameters.ContainsKey('Confirm')) { + $shouldPrompt = $PSCmdlet.ShouldProcess($shouldProcessTarget, $shouldProcessAction) + } + else { + $shouldPrompt = $true # Skip ShouldProcess for GET + } + } + elseif ($Method -eq "DELETE") { + # For DELETE, always use ShouldProcess with High impact + $shouldPrompt = $PSCmdlet.ShouldProcess($shouldProcessTarget, $shouldProcessAction, "Are you sure you want to delete this resource?") + } + else { + # For POST, PATCH, PUT use normal ShouldProcess + $shouldPrompt = $PSCmdlet.ShouldProcess($shouldProcessTarget, $shouldProcessAction) + } + + if ($shouldPrompt) { + + # Generate headers with custom version + $Headers = New-LMHeader -Auth $Script:LMAuth -Method $Method -ResourcePath $ResourcePath -Data $Body -Version $Version -ContentType $ContentType + + # Output debug information + Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation -Payload $Body + + # Build parameters for Invoke-LMRestMethod + $restParams = @{ + Uri = $Uri + Method = $Method + Headers = $Headers[0] + WebSession = $Headers[1] + CallerPSCmdlet = $PSCmdlet + } + + if ($Body) { + $restParams.Body = $Body + } + + if ($OutFile) { + $restParams.OutFile = $OutFile + } + + if ($MaxRetries -eq 0 -or $NoRetry) { + $restParams.NoRetry = $true + } + else { + $restParams.MaxRetries = $MaxRetries + } + + # Issue request + $Response = Invoke-LMRestMethod @restParams + + # Handle the response + if ($null -eq $Response) { + return $null + } + + # If OutFile was specified, the response is already saved + if ($OutFile) { + Write-Verbose "Response saved to: $OutFile" + return [PSCustomObject]@{ + Success = $true + FilePath = $OutFile + Message = "Response saved successfully" + } + } + + # Return the items array if it exists, otherwise return the response object + if ($Response.items) { + $Response = $Response.items + } + + # Add type information if specified + if ($TypeName) { + $Response = Add-ObjectTypeInfo -InputObject $Response -TypeName $TypeName + } + + # Convert to hashtable if requested + if ($AsHashtable -and $Response) { + if ($Response -is [Array]) { + return $Response | ForEach-Object { + $hashtable = @{} + $_.PSObject.Properties | ForEach-Object { $hashtable[$_.Name] = $_.Value } + $hashtable + } + } + else { + $hashtable = @{} + $Response.PSObject.Properties | ForEach-Object { $hashtable[$_.Name] = $_.Value } + return $hashtable + } + } + + return $Response + } +} + diff --git a/README.md b/README.md index db8438c..34910c0 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,7 @@ Connect-LMAccount -UseCachedCredential - **Remove-LMEscalationChain**: Remove escalation chains by ID or name. - **Invoke-LMReportExecution**: Trigger on-demand execution of LogicMonitor reports with optional admin impersonation and custom email recipients. - **Get-LMReportExecutionTask**: Check the status and retrieve results of previously triggered report executions. +- **Invoke-LMAPIRequest**: Universal API request cmdlet for advanced users to access any LogicMonitor API endpoint with custom payloads while leveraging module authentication, retry logic, and debug utilities. ### Updated Cmdlets - **Update-LogicMonitorModule**: Hardened for non-blocking version checks; failures are logged via `Write-Verbose` and never terminate connecting cmdlets. @@ -123,6 +124,21 @@ Remove-LMEscalationChain -Id 123 # Trigger a report execution and check its status $task = Invoke-LMReportExecution -Name "Monthly Availability" -WithAdminId 101 -ReceiveEmails "ops@example.com" Get-LMReportExecutionTask -ReportName "Monthly Availability" -TaskId $task.taskId + +# Use the universal API request cmdlet for endpoints +Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method GET -QueryParams @{ size = 500 } + +# Create a device with full control +$customData = @{ + name = "1.1.1.1" + displayName = "Custom Device" + preferredCollectorId = 76 + deviceType = 0 + customProperties = @( + @{name="propname";value="value"} + ) +} +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method POST -Data $customData -Version 3 ``` From 7160bbcbc432332953c527d90bb4558bd1001672 Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 23:53:56 -0400 Subject: [PATCH 13/17] fix verbose in build fix test case for devices --- .github/workflows/test-win.yml | 2 +- .github/workflows/test.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test-win.yml b/.github/workflows/test-win.yml index fd9907d..49d4274 100644 --- a/.github/workflows/test-win.yml +++ b/.github/workflows/test-win.yml @@ -46,7 +46,7 @@ jobs: $Result = Invoke-Pester -Container $Container -Output Detailed -PassThru #Write OpsNote to test portal indicating test status - Connect-LMAccount -AccessId $env:LM_ACCESS_ID -AccessKey $env:LM_ACCESS_KEY -AccountName $env:LM_PORTAL -DisableConsoleLogging -Verbose + Connect-LMAccount -AccessId $env:LM_ACCESS_ID -AccessKey $env:LM_ACCESS_KEY -AccountName $env:LM_PORTAL -DisableConsoleLogging $TimeNow = Get-Date -UFormat %m%d%Y-%H%M $OpsNote = New-LMOpsNote -Note "Github test build submitted on $TimeNow - $($Result.Result)" -Tags @("GithubActions","TestPipeline-Win5.1","PSVersion-$Version") diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index e3c0ca3..4385aa1 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -46,7 +46,7 @@ jobs: $Result = Invoke-Pester -Container $Container -Output Detailed -PassThru #Write OpsNote to test portal indicating test status - Connect-LMAccount -AccessId $env:LM_ACCESS_ID -AccessKey $env:LM_ACCESS_KEY -AccountName $env:LM_PORTAL -DisableConsoleLogging -Verbose + Connect-LMAccount -AccessId $env:LM_ACCESS_ID -AccessKey $env:LM_ACCESS_KEY -AccountName $env:LM_PORTAL -DisableConsoleLogging $TimeNow = Get-Date -UFormat %m%d%Y-%H%M $OpsNote = New-LMOpsNote -Note "Github test build submitted on $TimeNow - $($Result.Result)" -Tags @("GithubActions","TestPipeline-Core","PSVersion-$Version") From 632d39ac1bf9c12a87480e317addcf4cc778597a Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Wed, 29 Oct 2025 23:57:36 -0400 Subject: [PATCH 14/17] update support docs for v7.7.0 --- Documentation/Get-LMIntegration.md | 146 ++++ Documentation/Get-LMRecentlyDeleted.md | 166 +++++ Documentation/Get-LMReportExecutionTask.md | 121 ++++ Documentation/Invoke-LMAPIRequest.md | 738 +++++++++++---------- Documentation/Invoke-LMReportExecution.md | 138 ++++ Documentation/New-LMWebsite.md | 2 +- Documentation/Remove-LMEscalationChain.md | 135 ++++ Documentation/Remove-LMIntegration.md | 134 ++++ Documentation/Remove-LMRecentlyDeleted.md | 108 +++ Documentation/Restore-LMRecentlyDeleted.md | 108 +++ Documentation/Set-LMWebsite.md | 2 +- 11 files changed, 1435 insertions(+), 363 deletions(-) create mode 100644 Documentation/Get-LMIntegration.md create mode 100644 Documentation/Get-LMRecentlyDeleted.md create mode 100644 Documentation/Get-LMReportExecutionTask.md create mode 100644 Documentation/Invoke-LMReportExecution.md create mode 100644 Documentation/Remove-LMEscalationChain.md create mode 100644 Documentation/Remove-LMIntegration.md create mode 100644 Documentation/Remove-LMRecentlyDeleted.md create mode 100644 Documentation/Restore-LMRecentlyDeleted.md diff --git a/Documentation/Get-LMIntegration.md b/Documentation/Get-LMIntegration.md new file mode 100644 index 0000000..d841028 --- /dev/null +++ b/Documentation/Get-LMIntegration.md @@ -0,0 +1,146 @@ +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Get-LMIntegration + +## SYNOPSIS +Retrieves integrations from LogicMonitor. + +## SYNTAX + +### All (Default) +``` +Get-LMIntegration [-BatchSize ] [-ProgressAction ] [] +``` + +### Id +``` +Get-LMIntegration [-Id ] [-BatchSize ] [-ProgressAction ] [] +``` + +### Name +``` +Get-LMIntegration [-Name ] [-BatchSize ] [-ProgressAction ] + [] +``` + +### Filter +``` +Get-LMIntegration [-Filter ] [-BatchSize ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +The Get-LMIntegration function retrieves integration configurations from LogicMonitor. +It can retrieve all integrations, a specific integration by ID or name, or filter the results. + +## EXAMPLES + +### EXAMPLE 1 +``` +#Retrieve all integrations +Get-LMIntegration +``` + +### EXAMPLE 2 +``` +#Retrieve a specific integration by name +Get-LMIntegration -Name "Slack-Integration" +``` + +## PARAMETERS + +### -Id +The ID of the specific integration to retrieve. + +```yaml +Type: Int32 +Parameter Sets: Id +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the specific integration to retrieve. + +```yaml +Type: String +Parameter Sets: Name +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter object to apply when retrieving integrations. + +```yaml +Type: Object +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +The number of results to return per request. +Must be between 1 and 1000. +Defaults to 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None. You cannot pipe objects to this command. +## OUTPUTS + +### Returns integration objects from LogicMonitor. +## NOTES +You must run Connect-LMAccount before running this command. + +## RELATED LINKS diff --git a/Documentation/Get-LMRecentlyDeleted.md b/Documentation/Get-LMRecentlyDeleted.md new file mode 100644 index 0000000..14d7129 --- /dev/null +++ b/Documentation/Get-LMRecentlyDeleted.md @@ -0,0 +1,166 @@ +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Get-LMRecentlyDeleted + +## SYNOPSIS +Retrieves recently deleted resources from the LogicMonitor recycle bin. + +## SYNTAX + +``` +Get-LMRecentlyDeleted [[-ResourceType] ] [[-DeletedAfter] ] [[-DeletedBefore] ] + [[-DeletedBy] ] [[-BatchSize] ] [[-Sort] ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +The Get-LMRecentlyDeleted function queries the LogicMonitor recycle bin for deleted resources +within a configurable time range. +Results can be filtered by resource type and deleted-by user, +and support paging through the API using size, offset, and sort parameters. + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-LMRecentlyDeleted -ResourceType device -DeletedBy "lmsupport" +``` + +Retrieves every device deleted by the user lmsupport over the past seven days. + +### EXAMPLE 2 +``` +Get-LMRecentlyDeleted -DeletedAfter (Get-Date).AddDays(-1) -DeletedBefore (Get-Date) -BatchSize 100 -Sort "+deletedOn" +``` + +Retrieves deleted resources from the past 24 hours in ascending order of deletion time. + +## PARAMETERS + +### -ResourceType +Limits results to a specific resource type. +Accepted values are All, device, and deviceGroup. +Defaults to All. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: All +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedAfter +The earliest deletion timestamp (inclusive) to return. +Defaults to seven days prior when not specified. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedBefore +The latest deletion timestamp (exclusive) to return. +Defaults to the current time when not specified. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedBy +Limits results to items deleted by the specified user principal. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +The number of records to request per API call (1-1000). +Defaults to 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: 1000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +Sort expression passed to the API. +Defaults to -deletedOn. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: -deletedOn +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +You must establish a session with Connect-LMAccount prior to calling this function. + +## RELATED LINKS diff --git a/Documentation/Get-LMReportExecutionTask.md b/Documentation/Get-LMReportExecutionTask.md new file mode 100644 index 0000000..a353a6e --- /dev/null +++ b/Documentation/Get-LMReportExecutionTask.md @@ -0,0 +1,121 @@ +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Get-LMReportExecutionTask + +## SYNOPSIS +Retrieves the status of a LogicMonitor report execution task. + +## SYNTAX + +### ReportId (Default) +``` +Get-LMReportExecutionTask -ReportId -TaskId [-ProgressAction ] + [] +``` + +### ReportName +``` +Get-LMReportExecutionTask -ReportName -TaskId [-ProgressAction ] + [] +``` + +## DESCRIPTION +Get-LMReportExecutionTask fetches information about a previously triggered report execution task. +Supply the report identifier (ID or name) along with the task ID returned from +Invoke-LMReportExecution to check completion status or retrieve the result URL. + +## EXAMPLES + +### EXAMPLE 1 +``` +Invoke-LMReportExecution -Id 42 | Select-Object -ExpandProperty taskId | Get-LMReportExecutionTask -ReportId 42 +``` + +Gets the execution status for the specified report/task combination. + +### EXAMPLE 2 +``` +$task = Invoke-LMReportExecution -Name "Monthly Availability" +Get-LMReportExecutionTask -ReportName "Monthly Availability" -TaskId $task.taskId +``` + +Checks the task status for the report by name. + +## PARAMETERS + +### -ReportId +The ID of the report whose execution task should be retrieved. + +```yaml +Type: Int32 +Parameter Sets: ReportId +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportName +The name of the report whose execution task should be retrieved. + +```yaml +Type: String +Parameter Sets: ReportName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TaskId +The execution task identifier returned when the report was triggered. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +You must run Connect-LMAccount before running this command. + +## RELATED LINKS diff --git a/Documentation/Invoke-LMAPIRequest.md b/Documentation/Invoke-LMAPIRequest.md index 19f84ed..a508225 100644 --- a/Documentation/Invoke-LMAPIRequest.md +++ b/Documentation/Invoke-LMAPIRequest.md @@ -1,361 +1,377 @@ ---- -external help file: Logic.Monitor-help.xml -Module Name: Logic.Monitor -online version: -schema: 2.0.0 ---- - -# Invoke-LMAPIRequest - -## SYNOPSIS -Executes a custom LogicMonitor API request with full control over endpoint and payload. - -## SYNTAX - -### Data (Default) -``` -Invoke-LMAPIRequest -ResourcePath -Method [-QueryParams ] [-Data ] - [-Version ] [-ContentType ] [-MaxRetries ] [-NoRetry] [-OutFile ] - [-TypeName ] [-AsHashtable] [-WhatIf] [-Confirm] [] -``` - -### RawBody -``` -Invoke-LMAPIRequest -ResourcePath -Method [-QueryParams ] [-RawBody ] - [-Version ] [-ContentType ] [-MaxRetries ] [-NoRetry] [-OutFile ] - [-TypeName ] [-AsHashtable] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Invoke-LMAPIRequest function provides advanced users with direct access to the LogicMonitor API -while leveraging the module's authentication, retry logic, debug utilities, and error handling. -This is useful for accessing API endpoints that don't yet have dedicated cmdlets in the module. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method GET -``` - -Get a custom resource not yet supported by a dedicated cmdlet. - -### EXAMPLE 2 -```powershell -$data = @{ - name = "My Integration" - type = "slack" - url = "https://hooks.slack.com/services/..." -} -Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method POST -Data $data -``` - -Create a resource with custom payload. - -### EXAMPLE 3 -```powershell -$updates = @{ - description = "Updated description" -} -Invoke-LMAPIRequest -ResourcePath "/device/devices/123" -Method PATCH -Data $updates -``` - -Update a resource with PATCH. - -### EXAMPLE 4 -```powershell -Invoke-LMAPIRequest -ResourcePath "/setting/integrations/456" -Method DELETE -``` - -Delete a resource. - -### EXAMPLE 5 -```powershell -$queryParams = @{ - size = 500 - filter = 'status:"active"' - fields = "id,name,status" -} -Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams $queryParams -Version 3 -``` - -Get with query parameters and custom version. - -### EXAMPLE 6 -```powershell -$rawJson = '{"name":"test","customField":null}' -Invoke-LMAPIRequest -ResourcePath "/custom/endpoint" -Method POST -RawBody $rawJson -``` - -Use raw body for special formatting requirements. - -### EXAMPLE 7 -```powershell -Invoke-LMAPIRequest -ResourcePath "/report/reports/123/download" -Method GET -OutFile "C:\Reports\report.pdf" -``` - -Download a report to file. - -### EXAMPLE 8 -```powershell -$offset = 0 -$size = 1000 -$allResults = @() -do { - $response = Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams @{ size = $size; offset = $offset } - $allResults += $response.items - $offset += $size -} while ($allResults.Count -lt $response.total) -``` - -Get paginated results manually. - -## PARAMETERS - -### -ResourcePath -The API resource path (e.g., "/device/devices", "/setting/integrations/123"). -Do not include the base URL or query parameters here. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Method -The HTTP method to use. Valid values: GET, POST, PATCH, PUT, DELETE. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: GET, POST, PATCH, PUT, DELETE - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryParams -Optional hashtable of query parameters to append to the request URL. -Example: @{ size = 100; offset = 0; filter = 'name:"test"' } - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Data -Optional hashtable containing the request body data. Will be automatically converted to JSON. -Use this for POST, PATCH, and PUT requests. - -```yaml -Type: Hashtable -Parameter Sets: Data -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RawBody -Optional raw string body to send with the request. Use this instead of -Data when you need -complete control over the request body format. Mutually exclusive with -Data. - -```yaml -Type: String -Parameter Sets: RawBody -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -The X-Version header value for the API request. Defaults to 3. -Some newer API endpoints may require different version numbers. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 3 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentType -The Content-Type header for the request. Defaults to "application/json". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: application/json -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxRetries -Maximum number of retry attempts for transient errors. Defaults to 3. -Set to 0 to disable retries. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 3 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRetry -Switch to completely disable retry logic and fail immediately on any error. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutFile -Path to save the response content to a file. Useful for downloading reports or exports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TypeName -Optional type name to add to the returned objects (e.g., "LogicMonitor.CustomResource"). -This enables proper formatting if you have custom format definitions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsHashtable -Switch to return the response as a hashtable instead of a PSCustomObject. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -You cannot pipe objects to this command. - -## OUTPUTS - -### System.Object -Returns the API response as a PSCustomObject by default, or as specified by -AsHashtable. - -## NOTES -You must run Connect-LMAccount before running this command. - -This cmdlet is designed for advanced users who need to: -- Access API endpoints not yet covered by dedicated cmdlets -- Test new API features or beta endpoints -- Implement custom workflows requiring direct API access -- Prototype new functionality before requesting cmdlet additions - -For standard operations, use the dedicated cmdlets (Get-LMDevice, New-LMDevice, etc.) as they -provide better parameter validation, documentation, and user experience. - -## RELATED LINKS - -[Module Documentation](https://logicmonitor.github.io/lm-powershell-module-docs/) - +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Invoke-LMAPIRequest + +## SYNOPSIS +Executes a custom LogicMonitor API request with full control over endpoint and payload. + +## SYNTAX + +### Data (Default) +``` +Invoke-LMAPIRequest -ResourcePath -Method [-QueryParams ] [-Data ] + [-Version ] [-ContentType ] [-MaxRetries ] [-NoRetry] [-OutFile ] + [-TypeName ] [-AsHashtable] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +### RawBody +``` +Invoke-LMAPIRequest -ResourcePath -Method [-QueryParams ] [-RawBody ] + [-Version ] [-ContentType ] [-MaxRetries ] [-NoRetry] [-OutFile ] + [-TypeName ] [-AsHashtable] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Invoke-LMAPIRequest function provides advanced users with direct access to the LogicMonitor API +while leveraging the module's authentication, retry logic, debug utilities, and error handling. +This is useful for accessing API endpoints that don't yet have dedicated cmdlets in the module. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method GET +``` + +Get a custom resource not yet supported by a dedicated cmdlet. + +### EXAMPLE 2 +```powershell +$data = @{ + name = "My Integration" + type = "slack" + url = "https://hooks.slack.com/services/..." +} +Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method POST -Data $data +``` + +Create a resource with custom payload. + +### EXAMPLE 3 +```powershell +$updates = @{ + description = "Updated description" +} +Invoke-LMAPIRequest -ResourcePath "/device/devices/123" -Method PATCH -Data $updates +``` + +Update a resource with PATCH. + +### EXAMPLE 4 +```powershell +Invoke-LMAPIRequest -ResourcePath "/setting/integrations/456" -Method DELETE +``` + +Delete a resource. + +### EXAMPLE 5 +```powershell +$queryParams = @{ + size = 500 + filter = 'status:"active"' + fields = "id,name,status" +} +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams $queryParams -Version 3 +``` + +Get with query parameters and custom version. + +### EXAMPLE 6 +```powershell +$rawJson = '{"name":"test","customField":null}' +Invoke-LMAPIRequest -ResourcePath "/custom/endpoint" -Method POST -RawBody $rawJson +``` + +Use raw body for special formatting requirements. + +### EXAMPLE 7 +```powershell +Invoke-LMAPIRequest -ResourcePath "/report/reports/123/download" -Method GET -OutFile "C:\Reports\report.pdf" +``` + +Download a report to file. + +### EXAMPLE 8 +```powershell +$offset = 0 +$size = 1000 +$allResults = @() +do { + $response = Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams @{ size = $size; offset = $offset } + $allResults += $response.items + $offset += $size +} while ($allResults.Count -lt $response.total) +``` + +Get paginated results manually. + +## PARAMETERS + +### -ResourcePath +The API resource path (e.g., "/device/devices", "/setting/integrations/123"). +Do not include the base URL or query parameters here. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Method +The HTTP method to use. Valid values: GET, POST, PATCH, PUT, DELETE. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryParams +Optional hashtable of query parameters to append to the request URL. +Example: @{ size = 100; offset = 0; filter = 'name:"test"' } + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Data +Optional hashtable containing the request body data. Will be automatically converted to JSON. +Use this for POST, PATCH, and PUT requests. + +```yaml +Type: Hashtable +Parameter Sets: Data +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RawBody +Optional raw string body to send with the request. Use this instead of -Data when you need +complete control over the request body format. Mutually exclusive with -Data. + +```yaml +Type: String +Parameter Sets: RawBody +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +The X-Version header value for the API request. Defaults to 3. +Some newer API endpoints may require different version numbers. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentType +The Content-Type header for the request. Defaults to "application/json". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: application/json +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxRetries +Maximum number of retry attempts for transient errors. Defaults to 3. +Set to 0 to disable retries. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoRetry +Switch to completely disable retry logic and fail immediately on any error. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutFile +Path to save the response content to a file. Useful for downloading reports or exports. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TypeName +Optional type name to add to the returned objects (e.g., "LogicMonitor.CustomResource"). +This enables proper formatting if you have custom format definitions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsHashtable +Switch to return the response as a hashtable instead of a PSCustomObject. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +You cannot pipe objects to this command. + +## OUTPUTS + +### System.Object +Returns the API response as a PSCustomObject by default, or as specified by -AsHashtable. + +## NOTES +You must run Connect-LMAccount before running this command. + +This cmdlet is designed for advanced users who need to: +- Access API endpoints not yet covered by dedicated cmdlets +- Test new API features or beta endpoints +- Implement custom workflows requiring direct API access +- Prototype new functionality before requesting cmdlet additions + +For standard operations, use the dedicated cmdlets (Get-LMDevice, New-LMDevice, etc.) as they +provide better parameter validation, documentation, and user experience. + +## RELATED LINKS + +[Module Documentation](https://logicmonitor.github.io/lm-powershell-module-docs/) + diff --git a/Documentation/Invoke-LMReportExecution.md b/Documentation/Invoke-LMReportExecution.md new file mode 100644 index 0000000..4691043 --- /dev/null +++ b/Documentation/Invoke-LMReportExecution.md @@ -0,0 +1,138 @@ +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Invoke-LMReportExecution + +## SYNOPSIS +Triggers the execution of a LogicMonitor report. + +## SYNTAX + +### Id (Default) +``` +Invoke-LMReportExecution -Id [-WithAdminId ] [-ReceiveEmails ] + [-ProgressAction ] [] +``` + +### Name +``` +Invoke-LMReportExecution -Name [-WithAdminId ] [-ReceiveEmails ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +Invoke-LMReportExecution starts an on-demand run of a LogicMonitor report. +The report can be +identified by ID or name. +Optional parameters allow impersonating another admin or overriding the +email recipients for the generated output. + +## EXAMPLES + +### EXAMPLE 1 +``` +Invoke-LMReportExecution -Id 42 +``` + +Starts an immediate execution of the report with ID 42 using the current user's context. + +### EXAMPLE 2 +``` +Invoke-LMReportExecution -Name "Monthly Availability" -WithAdminId 101 -ReceiveEmails "ops@example.com" +``` + +Runs the "Monthly Availability" report as admin ID 101 and emails the results to ops@example.com. + +## PARAMETERS + +### -Id +The ID of the report to execute. + +```yaml +Type: Int32 +Parameter Sets: Id +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the report to execute. + +```yaml +Type: String +Parameter Sets: Name +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WithAdminId +The admin ID to impersonate when generating the report. +Defaults to the current user when omitted. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveEmails +One or more email addresses (comma-separated) that should receive the generated report. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +You must run Connect-LMAccount before running this command. + +## RELATED LINKS diff --git a/Documentation/New-LMWebsite.md b/Documentation/New-LMWebsite.md index 57b2c6c..6797941 100644 --- a/Documentation/New-LMWebsite.md +++ b/Documentation/New-LMWebsite.md @@ -313,7 +313,7 @@ Specifies the SSL alert thresholds for the website check. ```yaml Type: String[] Parameter Sets: Website -Aliases: +Aliases: alertExpr Required: False Position: Named diff --git a/Documentation/Remove-LMEscalationChain.md b/Documentation/Remove-LMEscalationChain.md new file mode 100644 index 0000000..db87827 --- /dev/null +++ b/Documentation/Remove-LMEscalationChain.md @@ -0,0 +1,135 @@ +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Remove-LMEscalationChain + +## SYNOPSIS +Removes a LogicMonitor escalation chain. + +## SYNTAX + +### Id (Default) +``` +Remove-LMEscalationChain -Id [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +### Name +``` +Remove-LMEscalationChain -Name [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Remove-LMEscalationChain function removes a LogicMonitor escalation chain based on either its ID or name. + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-LMEscalationChain -Id 12345 +Removes the LogicMonitor escalation chain with ID 12345. +``` + +### EXAMPLE 2 +``` +Remove-LMEscalationChain -Name "Critical-Alerts" +Removes the LogicMonitor escalation chain with the name "Critical-Alerts". +``` + +## PARAMETERS + +### -Id +Specifies the ID of the escalation chain to be removed. +This parameter is mandatory when using the 'Id' parameter set. + +```yaml +Type: Int32 +Parameter Sets: Id +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the escalation chain to be removed. +This parameter is mandatory when using the 'Name' parameter set. + +```yaml +Type: String +Parameter Sets: Name +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### You can pipe input to this function. +## OUTPUTS + +### Returns a PSCustomObject containing the ID of the removed escalation chain and a message indicating the success of the removal operation. +## NOTES + +## RELATED LINKS diff --git a/Documentation/Remove-LMIntegration.md b/Documentation/Remove-LMIntegration.md new file mode 100644 index 0000000..2925678 --- /dev/null +++ b/Documentation/Remove-LMIntegration.md @@ -0,0 +1,134 @@ +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Remove-LMIntegration + +## SYNOPSIS +Removes a LogicMonitor integration. + +## SYNTAX + +### Id (Default) +``` +Remove-LMIntegration -Id [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +### Name +``` +Remove-LMIntegration -Name [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Remove-LMIntegration function removes a LogicMonitor integration based on either its ID or name. + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-LMIntegration -Id 12345 +Removes the LogicMonitor integration with ID 12345. +``` + +### EXAMPLE 2 +``` +Remove-LMIntegration -Name "Slack-Integration" +Removes the LogicMonitor integration with the name "Slack-Integration". +``` + +## PARAMETERS + +### -Id +Specifies the ID of the integration to be removed. +This parameter is mandatory when using the 'Id' parameter set. + +```yaml +Type: Int32 +Parameter Sets: Id +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the integration to be removed. +This parameter is mandatory when using the 'Name' parameter set. + +```yaml +Type: String +Parameter Sets: Name +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### You can pipe input to this function. +## OUTPUTS + +### Returns a PSCustomObject containing the ID of the removed integration and a message indicating the success of the removal operation. +## NOTES + +## RELATED LINKS diff --git a/Documentation/Remove-LMRecentlyDeleted.md b/Documentation/Remove-LMRecentlyDeleted.md new file mode 100644 index 0000000..d909049 --- /dev/null +++ b/Documentation/Remove-LMRecentlyDeleted.md @@ -0,0 +1,108 @@ +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Remove-LMRecentlyDeleted + +## SYNOPSIS +Permanently removes one or more resources from the LogicMonitor recycle bin. + +## SYNTAX + +``` +Remove-LMRecentlyDeleted [-RecycleId] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Remove-LMRecentlyDeleted function submits a batch delete request for the provided recycle +identifiers, permanently removing the associated resources from the recycle bin. + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-LMRecentlyDeleted -ResourceType deviceGroup -DeletedBy "lmsupport" | Select-Object -First 3 -ExpandProperty id | Remove-LMRecentlyDeleted +``` + +Permanently deletes the first three device groups currently in the recycle bin for the user lmsupport. + +## PARAMETERS + +### -RecycleId +One or more recycle identifiers representing deleted resources. +Accepts pipeline input and +property names of Id. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Id + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +You must establish a session with Connect-LMAccount prior to calling this function. + +## RELATED LINKS diff --git a/Documentation/Restore-LMRecentlyDeleted.md b/Documentation/Restore-LMRecentlyDeleted.md new file mode 100644 index 0000000..6a1f32c --- /dev/null +++ b/Documentation/Restore-LMRecentlyDeleted.md @@ -0,0 +1,108 @@ +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Restore-LMRecentlyDeleted + +## SYNOPSIS +Restores one or more resources from the LogicMonitor recycle bin. + +## SYNTAX + +``` +Restore-LMRecentlyDeleted [-RecycleId] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Restore-LMRecentlyDeleted function issues a batch restore request for the provided recycle +identifiers, returning the selected resources to their original state when possible. + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-LMRecentlyDeleted -ResourceType device -DeletedBy "lmsupport" | Select-Object -First 5 -ExpandProperty id | Restore-LMRecentlyDeleted +``` + +Restores the five most recently deleted devices by lmsupport. + +## PARAMETERS + +### -RecycleId +One or more recycle identifiers representing deleted resources. +Accepts pipeline input and +property names of Id. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Id + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +You must establish a session with Connect-LMAccount prior to calling this function. + +## RELATED LINKS diff --git a/Documentation/Set-LMWebsite.md b/Documentation/Set-LMWebsite.md index 3f7f991..37810cb 100644 --- a/Documentation/Set-LMWebsite.md +++ b/Documentation/Set-LMWebsite.md @@ -265,7 +265,7 @@ Accept wildcard characters: False ```yaml Type: String[] Parameter Sets: Website -Aliases: +Aliases: alertExpr Required: False Position: Named From fc8a329eaead6b233cfe6f520dd4a8407d8ab011 Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Thu, 30 Oct 2025 00:03:02 -0400 Subject: [PATCH 15/17] Update Logic.Monitor-help.xml --- en-US/Logic.Monitor-help.xml | 63221 +++++++++++++++++++++------------ 1 file changed, 41461 insertions(+), 21760 deletions(-) diff --git a/en-US/Logic.Monitor-help.xml b/en-US/Logic.Monitor-help.xml index cf556ad..05d216c 100644 --- a/en-US/Logic.Monitor-help.xml +++ b/en-US/Logic.Monitor-help.xml @@ -724,6 +724,241 @@ Connect-LMAccount -UseCachedCredential -CachedAccountName "CachedAccountName" + + + ConvertTo-LMUptimeDevice + ConvertTo + LMUptimeDevice + + Migrates LogicMonitor website checks to LM Uptime devices. + + + + ConvertTo-LMUptimeDevice consumes objects returned by Get-LMWebsite, translates their configuration into the v3 Uptime payload shape, and provisions new Uptime devices by invoking New-LMUptimeDevice. The cmdlet preserves alerting behaviour, polling thresholds, locations, and scripted web steps whenever possible. + + + + ConvertTo-LMUptimeDevice + + Website + + Website object returned by Get-LMWebsite. Accepts pipeline input. + + PSObject + + PSObject + + + None + + + NamePrefix + + Optional string prefixed to the generated Uptime device name. + + String + + String + + + None + + + NameSuffix + + Optional string appended to the generated Uptime device name. + + String + + String + + + None + + + TargetHostGroupIds + + Explicit host group identifiers for the new device. + + String[] + + String[] + + + None + + + DisableSourceAlerting + + When specified, disables alerting on the source website after the Uptime device is created successfully. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Website + + Website object returned by Get-LMWebsite. Accepts pipeline input. + + PSObject + + PSObject + + + None + + + NamePrefix + + Optional string prefixed to the generated Uptime device name. + + String + + String + + + None + + + NameSuffix + + Optional string appended to the generated Uptime device name. + + String + + String + + + None + + + TargetHostGroupIds + + Explicit host group identifiers for the new device. + + String[] + + String[] + + + None + + + DisableSourceAlerting + + When specified, disables alerting on the source website after the Uptime device is created successfully. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + LogicMonitor.LMUptimeDevice + + + + + + + + + You must run Connect-LMAccount prior to execution. The cmdlet honours -WhatIf/-Confirm through ShouldProcess. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Get-LMWebsite -Name "logicmonitor.com" | ConvertTo-LMUptimeDevice -NameSuffix "-uptime" + + Migrates the logicmonitor.com website check to an Uptime device with a "-uptime" suffix. + + + + + Copy-LMDashboard @@ -1357,23 +1592,23 @@ Copy-LMDevice -Name "NewDevice" -DisplayName "New Display Name" -Description "Ne - Copy-LMReport + Copy-LMDevicePropertyToDevice Copy - LMReport + LMDevicePropertyToDevice - Creates a copy of a LogicMonitor report. + Copies device properties from a source device to target devices. Sensitive properties cannot be copied as their values are not available via API. - The Copy-LMReport function creates a new report based on an existing report's configuration. It allows you to specify a new name, description, and parent group while maintaining other settings from the source report. + The Copy-LMDevicePropertyToDevice function copies specified properties from a source device to one or more target devices. The source device can be randomly selected from a group or explicitly specified. Properties are copied to the targets while preserving other existing device properties. - Copy-LMReport - - Name + Copy-LMDevicePropertyToDevice + + SourceDeviceId - The name for the new report. This parameter is mandatory. + The ID of the source device to copy properties from. This parameter is part of the "SourceDevice" parameter set. String @@ -1382,22 +1617,60 @@ Copy-LMDevice -Name "NewDevice" -DisplayName "New Display Name" -Description "Ne None - - Description + + TargetDeviceId - An optional description for the new report. + The ID of the target device(s) to copy properties to. Multiple device IDs can be specified. - String + String[] - String + String[] None - - ParentGroupId + + PropertyNames - The ID of the parent group for the new report. + Array of property names to copy. These can be only be custom properties directly assigned to the device. + + String[] + + String[] + + + None + + + PassThru + + If specified, returns the updated device objects. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Copy-LMDevicePropertyToDevice + + SourceGroupId + + The ID of the source group to randomly select a device from. This parameter is part of the "SourceGroup" parameter set. String @@ -1406,18 +1679,41 @@ Copy-LMDevice -Name "NewDevice" -DisplayName "New Display Name" -Description "Ne None - - ReportObject + + TargetDeviceId - The source report object to copy settings from. This parameter is mandatory. + The ID of the target device(s) to copy properties to. Multiple device IDs can be specified. - Object + String[] - Object + String[] + + + None + + + PropertyNames + + Array of property names to copy. These can be only be custom properties directly assigned to the device. + + String[] + + String[] None + + PassThru + + If specified, returns the updated device objects. + + + SwitchParameter + + + False + ProgressAction @@ -1433,10 +1729,10 @@ Copy-LMDevice -Name "NewDevice" -DisplayName "New Display Name" -Description "Ne - - Name + + SourceDeviceId - The name for the new report. This parameter is mandatory. + The ID of the source device to copy properties from. This parameter is part of the "SourceDevice" parameter set. String @@ -1445,10 +1741,10 @@ Copy-LMDevice -Name "NewDevice" -DisplayName "New Display Name" -Description "Ne None - - Description + + SourceGroupId - An optional description for the new report. + The ID of the source group to randomly select a device from. This parameter is part of the "SourceGroup" parameter set. String @@ -1457,30 +1753,42 @@ Copy-LMDevice -Name "NewDevice" -DisplayName "New Display Name" -Description "Ne None - - ParentGroupId + + TargetDeviceId - The ID of the parent group for the new report. + The ID of the target device(s) to copy properties to. Multiple device IDs can be specified. - String + String[] - String + String[] None - - ReportObject + + PropertyNames - The source report object to copy settings from. This parameter is mandatory. + Array of property names to copy. These can be only be custom properties directly assigned to the device. - Object + String[] - Object + String[] None + + PassThru + + If specified, returns the updated device objects. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction @@ -1494,99 +1802,26 @@ Copy-LMDevice -Name "NewDevice" -DisplayName "New Display Name" -Description "Ne None - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns the newly created report object. - - - - - - + + - You must run Connect-LMAccount before running this command. + Requires an active Logic Monitor session. Use Connect-LMAccount to log in before running this function. -------------------------- EXAMPLE 1 -------------------------- - #Copy a report with basic settings -Copy-LMReport -Name "New Report" -ReportObject $reportObject + Copy-LMDevicePropertyToDevice -SourceDeviceId 123 -TargetDeviceId 456 -PropertyNames "location","department" +Copies the location and department properties from device 123 to device 456. -------------------------- EXAMPLE 2 -------------------------- - #Copy a report with all optional parameters -Copy-LMReport -Name "New Report" -Description "New report description" -ParentGroupId 12345 -ReportObject $reportObject - - - - - - - - - - Disconnect-LMAccount - Disconnect - LMAccount - - Disconnects from a previously connected LM portal. - - - - The Disconnect-LMAccount function clears stored API credentials for a previously connected LM portal. It's useful for switching between LM portals or clearing credentials after a script runs. - - - - Disconnect-LMAccount - - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - None. This command does not generate any output. - - - - - - - - - Once disconnected you will need to reconnect to a portal before you will be allowed to run commands again. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Disconnect from the current LM portal -Disconnect-LMAccount + Copy-LMDevicePropertyToDevice -SourceGroupId 789 -TargetDeviceId 456,457 -PropertyNames "location" -PassThru +Randomly selects a device from group 789 and copies its location property to devices 456 and 457, returning the updated devices. @@ -1596,66 +1831,65 @@ Disconnect-LMAccount - Export-LMDeviceConfigBackup - Export - LMDeviceConfigBackup + Copy-LMDevicePropertyToGroup + Copy + LMDevicePropertyToGroup - Exports the latest version of device configurations from LogicMonitor. + Copies device properties from a source device to target device groups. Sensitive properties cannot be copied as their values are not available via API. - The Export-LMDeviceConfigBackup function exports the latest version of device configurations for specified devices. It can export configs from either a single device or all devices in a device group. + The Copy-LMDevicePropertyToGroup function copies specified properties from a source device to one or more target device groups. The source device can be randomly selected from a group or explicitly specified. Properties are copied to the target groups while preserving other existing group properties. - Export-LMDeviceConfigBackup - - DeviceGroupId + Copy-LMDevicePropertyToGroup + + SourceDeviceId - The ID of the device group to export configurations from. This parameter is mandatory when using the DeviceGroup parameter set. + The ID of the source device to copy properties from. This parameter is part of the "SourceDevice" parameter set. - Int32 + String - Int32 + String - 0 + None - - InstanceNameFilter + + TargetGroupId - A regex filter to use for filtering Instance names. Defaults to "running|current|PaloAlto". + The ID of the target group(s) to copy properties to. Multiple group IDs can be specified. - Regex + String[] - Regex + String[] - [rR]unning|[cC]urrent|[pP]aloAlto + None - - ConfigSourceNameFilter + + PropertyNames - A regex filter to use for filtering ConfigSource names. Defaults to ".*". + Array of property names to copy. These can be only be custom properties directly assigned to the device. - Regex + String[] - Regex + String[] - .* + None - Path + PassThru - The file path where the CSV backup will be exported to. + If specified, returns the updated device group objects. - String - String + SwitchParameter - None + False ProgressAction @@ -1671,54 +1905,53 @@ Disconnect-LMAccount - Export-LMDeviceConfigBackup + Copy-LMDevicePropertyToGroup - DeviceId + SourceGroupId - The ID of the device to export configurations from. This parameter is mandatory when using the Device parameter set. + The ID of the source group to randomly select a device from. This parameter is part of the "SourceGroup" parameter set. - Int32 + String - Int32 + String - 0 + None - - InstanceNameFilter + + TargetGroupId - A regex filter to use for filtering Instance names. Defaults to "running|current|PaloAlto". + The ID of the target group(s) to copy properties to. Multiple group IDs can be specified. - Regex + String[] - Regex + String[] - [rR]unning|[cC]urrent|[pP]aloAlto + None - - ConfigSourceNameFilter + + PropertyNames - A regex filter to use for filtering ConfigSource names. Defaults to ".*". + Array of property names to copy. These can be only be custom properties directly assigned to the device. - Regex + String[] - Regex + String[] - .* + None - Path + PassThru - The file path where the CSV backup will be exported to. + If specified, returns the updated device group objects. - String - String + SwitchParameter - None + False ProgressAction @@ -1735,58 +1968,212 @@ Disconnect-LMAccount - - DeviceGroupId + + SourceDeviceId - The ID of the device group to export configurations from. This parameter is mandatory when using the DeviceGroup parameter set. + The ID of the source device to copy properties from. This parameter is part of the "SourceDevice" parameter set. - Int32 + String - Int32 + String - 0 + None - DeviceId + SourceGroupId - The ID of the device to export configurations from. This parameter is mandatory when using the Device parameter set. + The ID of the source group to randomly select a device from. This parameter is part of the "SourceGroup" parameter set. - Int32 + String - Int32 + String - 0 + None - - InstanceNameFilter + + TargetGroupId - A regex filter to use for filtering Instance names. Defaults to "running|current|PaloAlto". + The ID of the target group(s) to copy properties to. Multiple group IDs can be specified. - Regex + String[] - Regex + String[] - [rR]unning|[cC]urrent|[pP]aloAlto + None - - ConfigSourceNameFilter + + PropertyNames - A regex filter to use for filtering ConfigSource names. Defaults to ".*". + Array of property names to copy. These can be only be custom properties directly assigned to the device. - Regex + String[] - Regex + String[] - .* + None - Path + PassThru - The file path where the CSV backup will be exported to. + If specified, returns the updated device group objects. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + Requires an active Logic Monitor session. Use Connect-LMAccount to log in before running this function. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Copy-LMDevicePropertyToGroup -SourceDeviceId 123 -TargetGroupId 456 -PropertyNames "location","department" +Copies the location and department properties from device 123 to group 456. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Copy-LMDevicePropertyToGroup -SourceGroupId 789 -TargetGroupId 456,457 -PropertyNames "location" -PassThru +Randomly selects a device from group 789 and copies its location property to groups 456 and 457, returning the updated groups. + + + + + + + + + + Copy-LMReport + Copy + LMReport + + Creates a copy of a LogicMonitor report. + + + + The Copy-LMReport function creates a new report based on an existing report's configuration. It allows you to specify a new name, description, and parent group while maintaining other settings from the source report. + + + + Copy-LMReport + + Name + + The name for the new report. This parameter is mandatory. + + String + + String + + + None + + + Description + + An optional description for the new report. + + String + + String + + + None + + + ParentGroupId + + The ID of the parent group for the new report. + + String + + String + + + None + + + ReportObject + + The source report object to copy settings from. This parameter is mandatory. + + Object + + Object + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + The name for the new report. This parameter is mandatory. + + String + + String + + + None + + + Description + + An optional description for the new report. + + String + + String + + + None + + + ParentGroupId + + The ID of the parent group for the new report. String @@ -1795,6 +2182,18 @@ Disconnect-LMAccount None + + ReportObject + + The source report object to copy settings from. This parameter is mandatory. + + Object + + Object + + + None + ProgressAction @@ -1821,7 +2220,7 @@ Disconnect-LMAccount - Returns an array of device configuration objects if successful. + Returns the newly created report object. @@ -1836,16 +2235,16 @@ Disconnect-LMAccount -------------------------- EXAMPLE 1 -------------------------- - #Export configurations from a device group -Export-LMDeviceConfigBackup -DeviceGroupId 2 -Path "export-report.csv" + #Copy a report with basic settings +Copy-LMReport -Name "New Report" -ReportObject $reportObject -------------------------- EXAMPLE 2 -------------------------- - #Export configurations from a single device -Export-LMDeviceConfigBackup -DeviceId 1 -Path "export-report.csv" + #Copy a report with all optional parameters +Copy-LMReport -Name "New Report" -Description "New report description" -ParentGroupId 12345 -ReportObject $reportObject @@ -1855,23 +2254,78 @@ Export-LMDeviceConfigBackup -DeviceId 1 -Path "export-report.csv" - Export-LMDeviceData + Disconnect-LMAccount + Disconnect + LMAccount + + Disconnects from a previously connected LM portal. + + + + The Disconnect-LMAccount function clears stored API credentials for a previously connected LM portal. It's useful for switching between LM portals or clearing credentials after a script runs. + + + + Disconnect-LMAccount + + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + None. This command does not generate any output. + + + + + + + + + Once disconnected you will need to reconnect to a portal before you will be allowed to run commands again. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Disconnect from the current LM portal +Disconnect-LMAccount + + + + + + + + + + Export-LMDashboard Export - LMDeviceData + LMDashboard - Exports device monitoring data from LogicMonitor. + Exports dashboards from LogicMonitor to a JSON file. - The Export-LMDeviceData function exports monitoring data from LogicMonitor devices or device groups. It supports exporting data for specific time ranges and can filter datasources. Data can be exported in CSV or JSON format. + The Export-LMDashboard function exports dashboard information from LogicMonitor to a JSON file. - Export-LMDeviceData - - DeviceId + Export-LMDashboard + + Id - The ID of the device to export data from. This parameter is part of a mutually exclusive parameter set. + The ID of the dashboard to retrieve. Part of a mutually exclusive parameter set. Int32 @@ -1881,45 +2335,47 @@ Export-LMDeviceConfigBackup -DeviceId 1 -Path "export-report.csv" 0 - StartDate + PassThru - The start date and time for data collection. Defaults to 1 hour ago. + Switch to return the dashboard export as a PSCustomObject. - DateTime - DateTime + SwitchParameter - (Get-Date).AddHours(-1) + False - EndDate + FilePath - The end date and time for data collection. Defaults to current time. + The path to the output file. - DateTime + String - DateTime + String - (Get-Date) + (Get-Location).Path - - DatasourceIncludeFilter + + ProgressAction - A filter pattern to include specific datasources. Defaults to "*" (all datasources). + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference - * + None + + + Export-LMDashboard - DatasourceExcludeFilter + Name - A filter pattern to exclude specific datasources. Defaults to null (no exclusions). + The name of the dashboard to retrieve. Part of a mutually exclusive parameter set. String @@ -1929,21 +2385,20 @@ Export-LMDeviceConfigBackup -DeviceId 1 -Path "export-report.csv" None - ExportFormat + PassThru - The format for the exported data. Valid values are "csv", "json", or "none". Defaults to "none". + Switch to return the dashboard export as a PSCustomObject. - String - String + SwitchParameter - None + False - ExportPath + FilePath - The path where exported files will be saved. Defaults to current directory. + The path to the output file. String @@ -1965,111 +2420,224 @@ Export-LMDeviceConfigBackup -DeviceId 1 -Path "export-report.csv" None + + + + Id + + The ID of the dashboard to retrieve. Part of a mutually exclusive parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the dashboard to retrieve. Part of a mutually exclusive parameter set. + + String + + String + + + None + + + PassThru + + Switch to return the dashboard export as a PSCustomObject. + + SwitchParameter + + SwitchParameter + + + False + + + FilePath + + The path to the output file. + + String + + String + + + (Get-Location).Path + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.Dashboard objects. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Export a dashboard to a JSON file +Export-LMDashboard -Id 123 -FilePath "C:\temp" + + + + + + + + + + Export-LMDeviceConfigBackup + Export + LMDeviceConfigBackup + + Exports the latest version of device configurations from LogicMonitor. + + + + The Export-LMDeviceConfigBackup function exports the latest version of device configurations for specified devices. It can export configs from either a single device or all devices in a device group. + + - Export-LMDeviceData + Export-LMDeviceConfigBackup - DeviceDisplayName + DeviceGroupId - The display name of the device to export data from. This parameter is part of a mutually exclusive parameter set. + The ID of the device group to export configurations from. This parameter is mandatory when using the DeviceGroup parameter set. - String + Int32 - String + Int32 - None + 0 - StartDate + InstanceNameFilter - The start date and time for data collection. Defaults to 1 hour ago. + A regex filter to use for filtering Instance names. Defaults to "running|current|PaloAlto". - DateTime + Regex - DateTime + Regex - (Get-Date).AddHours(-1) + [rR]unning|[cC]urrent|[pP]aloAlto - EndDate + ConfigSourceNameFilter - The end date and time for data collection. Defaults to current time. + A regex filter to use for filtering ConfigSource names. Defaults to ".*". - DateTime + Regex - DateTime + Regex - (Get-Date) + .* - DatasourceIncludeFilter + Path - A filter pattern to include specific datasources. Defaults to "*" (all datasources). + The file path where the CSV backup will be exported to. String String - * + None - - DatasourceExcludeFilter + + ProgressAction - A filter pattern to exclude specific datasources. Defaults to null (no exclusions). + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - ExportFormat + + + Export-LMDeviceConfigBackup + + DeviceId - The format for the exported data. Valid values are "csv", "json", or "none". Defaults to "none". + The ID of the device to export configurations from. This parameter is mandatory when using the Device parameter set. - String + Int32 - String + Int32 - None + 0 - ExportPath + InstanceNameFilter - The path where exported files will be saved. Defaults to current directory. + A regex filter to use for filtering Instance names. Defaults to "running|current|PaloAlto". - String + Regex - String + Regex - (Get-Location).Path + [rR]unning|[cC]urrent|[pP]aloAlto - - ProgressAction + + ConfigSourceNameFilter - {{ Fill ProgressAction Description }} + A regex filter to use for filtering ConfigSource names. Defaults to ".*". - ActionPreference + Regex - ActionPreference + Regex - None + .* - - - Export-LMDeviceData - - DeviceHostName + + Path - The hostname of the device to export data from. This parameter is part of a mutually exclusive parameter set. + The file path where the CSV backup will be exported to. String @@ -2078,17 +2646,375 @@ Export-LMDeviceConfigBackup -DeviceId 1 -Path "export-report.csv" None - - StartDate + + ProgressAction - The start date and time for data collection. Defaults to 1 hour ago. + {{ Fill ProgressAction Description }} - DateTime + ActionPreference - DateTime + ActionPreference - (Get-Date).AddHours(-1) + None + + + + + + DeviceGroupId + + The ID of the device group to export configurations from. This parameter is mandatory when using the DeviceGroup parameter set. + + Int32 + + Int32 + + + 0 + + + DeviceId + + The ID of the device to export configurations from. This parameter is mandatory when using the Device parameter set. + + Int32 + + Int32 + + + 0 + + + InstanceNameFilter + + A regex filter to use for filtering Instance names. Defaults to "running|current|PaloAlto". + + Regex + + Regex + + + [rR]unning|[cC]urrent|[pP]aloAlto + + + ConfigSourceNameFilter + + A regex filter to use for filtering ConfigSource names. Defaults to ".*". + + Regex + + Regex + + + .* + + + Path + + The file path where the CSV backup will be exported to. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns an array of device configuration objects if successful. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Export configurations from a device group +Export-LMDeviceConfigBackup -DeviceGroupId 2 -Path "export-report.csv" + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Export configurations from a single device +Export-LMDeviceConfigBackup -DeviceId 1 -Path "export-report.csv" + + + + + + + + + + Export-LMDeviceData + Export + LMDeviceData + + Exports device monitoring data from LogicMonitor. + + + + The Export-LMDeviceData function exports monitoring data from LogicMonitor devices or device groups. It supports exporting data for specific time ranges and can filter datasources. Data can be exported in CSV or JSON format. + + + + Export-LMDeviceData + + DeviceId + + The ID of the device to export data from. This parameter is part of a mutually exclusive parameter set. + + Int32 + + Int32 + + + 0 + + + StartDate + + The start date and time for data collection. Defaults to 1 hour ago. + + DateTime + + DateTime + + + (Get-Date).AddHours(-1) + + + EndDate + + The end date and time for data collection. Defaults to current time. + + DateTime + + DateTime + + + (Get-Date) + + + DatasourceIncludeFilter + + A filter pattern to include specific datasources. Defaults to "*" (all datasources). + + String + + String + + + * + + + DatasourceExcludeFilter + + A filter pattern to exclude specific datasources. Defaults to null (no exclusions). + + String + + String + + + None + + + ExportFormat + + The format for the exported data. Valid values are "csv", "json", or "none". Defaults to "none". + + String + + String + + + None + + + ExportPath + + The path where exported files will be saved. Defaults to current directory. + + String + + String + + + (Get-Location).Path + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Export-LMDeviceData + + DeviceDisplayName + + The display name of the device to export data from. This parameter is part of a mutually exclusive parameter set. + + String + + String + + + None + + + StartDate + + The start date and time for data collection. Defaults to 1 hour ago. + + DateTime + + DateTime + + + (Get-Date).AddHours(-1) + + + EndDate + + The end date and time for data collection. Defaults to current time. + + DateTime + + DateTime + + + (Get-Date) + + + DatasourceIncludeFilter + + A filter pattern to include specific datasources. Defaults to "*" (all datasources). + + String + + String + + + * + + + DatasourceExcludeFilter + + A filter pattern to exclude specific datasources. Defaults to null (no exclusions). + + String + + String + + + None + + + ExportFormat + + The format for the exported data. Valid values are "csv", "json", or "none". Defaults to "none". + + String + + String + + + None + + + ExportPath + + The path where exported files will be saved. Defaults to current directory. + + String + + String + + + (Get-Location).Path + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Export-LMDeviceData + + DeviceHostName + + The hostname of the device to export data from. This parameter is part of a mutually exclusive parameter set. + + String + + String + + + None + + + StartDate + + The start date and time for data collection. Defaults to 1 hour ago. + + DateTime + + DateTime + + + (Get-Date).AddHours(-1) EndDate @@ -2776,6 +3702,124 @@ Export-LMLogicModule -LogicModuleName "SNMP_Network_Interfaces" -Type "datasourc + + + Find-LMDashboardWidget + Find + LMDashboardWidget + + Find list of dashboard widgets containing mention of specified datasources + + + + Find list of dashboard widgets containing mention of specified datasources + + + + Find-LMDashboardWidget + + DatasourceNames + + {{ Fill DatasourceNames Description }} + + String[] + + String[] + + + None + + + GroupPathSearchString + + {{ Fill GroupPathSearchString Description }} + + String + + String + + + * + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + DatasourceNames + + {{ Fill DatasourceNames Description }} + + String[] + + String[] + + + None + + + GroupPathSearchString + + {{ Fill GroupPathSearchString Description }} + + String + + String + + + * + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + DatasourceNames in an array. You can also pipe datasource names to this widget. + + + + + + + + + + Created groups will be placed in a main group called Azure Resources by Subscription in the parent group specified by the -ParentGroupId parameter + + + + + -------------------------- EXAMPLE 1 -------------------------- + Find-LMDashboardWidget -DatasourceNames @("SNMP_NETWORK_INTERFACES","VMWARE_VCETNER_VM_PERFORMANCE") + + + + + + + Get-LMAccessGroup @@ -3152,6 +4196,18 @@ Get-LMAccountStatus False + + CustomColumns + + Array of custom column names to include in the results. + + String[] + + String[] + + + None + BatchSize @@ -3338,6 +4394,18 @@ Get-LMAccountStatus None + + CustomColumns + + Array of custom column names to include in the results. + + String[] + + String[] + + + None + BatchSize @@ -3424,6 +4492,18 @@ Get-LMAccountStatus False + + CustomColumns + + Array of custom column names to include in the results. + + String[] + + String[] + + + None + BatchSize @@ -4504,19 +5584,19 @@ Get-LMAppliesToFunction -Filter $filterObject - Get-LMAuditLogs + Get-LMAuditLog Get - LMAuditLogs + LMAuditLog Retrieves audit logs from LogicMonitor. - The Get-LMAuditLogs function retrieves audit logs from LogicMonitor based on the specified parameters. It supports retrieving logs by ID, by date range, or by applying filters. The function can retrieve up to 10000 logs in a single query. + The Get-LMAuditLog function retrieves audit logs from LogicMonitor based on the specified parameters. It supports retrieving logs by ID, by date range, or by applying filters. The function can retrieve up to 10000 logs in a single query. - Get-LMAuditLogs + Get-LMAuditLog Id @@ -4555,7 +5635,7 @@ Get-LMAppliesToFunction -Filter $filterObject - Get-LMAuditLogs + Get-LMAuditLog SearchString @@ -4618,7 +5698,7 @@ Get-LMAppliesToFunction -Filter $filterObject - Get-LMAuditLogs + Get-LMAuditLog Filter @@ -4772,7 +5852,7 @@ Get-LMAppliesToFunction -Filter $filterObject -------------------------- EXAMPLE 1 -------------------------- #Retrieve audit logs from the last week -Get-LMAuditLogs -StartDate (Get-Date).AddDays(-7) +Get-LMAuditLog -StartDate (Get-Date).AddDays(-7) @@ -4780,7 +5860,7 @@ Get-LMAuditLogs -StartDate (Get-Date).AddDays(-7) -------------------------- EXAMPLE 2 -------------------------- #Search for specific audit logs -Get-LMAuditLogs -SearchString "login" -StartDate (Get-Date).AddDays(-30) +Get-LMAuditLog -SearchString "login" -StartDate (Get-Date).AddDays(-30) @@ -4870,31 +5950,19 @@ Get-LMAWSAccountId - Get-LMCachedAccount + Get-LMAWSExternalId Get - LMCachedAccount + LMAWSExternalId - Retrieves information about cached LogicMonitor account credentials. + Retrieves the AWS External ID associated with the LogicMonitor account. - The Get-LMCachedAccount function retrieves information about cached LogicMonitor account credentials stored in the Logic.Monitor vault. It can return information for a specific cached account or all cached accounts. + The Get-LMAWSExternalId function retrieves the AWS External ID that is associated with the current LogicMonitor account. This ID is used for AWS integration purposes and helps identify the AWS account linked to your LogicMonitor instance. - Get-LMCachedAccount - - CachedAccountName - - The name of the specific cached account to retrieve information for. If not specified, returns information for all cached accounts. - - String - - String - - - None - + Get-LMAWSExternalId ProgressAction @@ -4910,18 +5978,6 @@ Get-LMAWSAccountId - - CachedAccountName - - The name of the specific cached account to retrieve information for. If not specified, returns information for all cached accounts. - - String - - String - - - None - ProgressAction @@ -4948,7 +6004,7 @@ Get-LMAWSAccountId - Returns an array of custom objects containing cached account information including CachedAccountName, Portal, Id, Modified date, and Type. + Returns a string containing the AWS External ID. @@ -4957,92 +6013,40 @@ Get-LMAWSAccountId - This function requires access to the Logic.Monitor vault where credentials are stored. + You must run Connect-LMAccount before running this command. -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all cached accounts -Get-LMCachedAccount - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a specific cached account -Get-LMCachedAccount -CachedAccountName "MyAccount" + #Retrieve the AWS External ID +Get-LMAWSExternalId - - - Get-SecretInfo - - - + - Get-LMCollector + Get-LMCachedAccount Get - LMCollector + LMCachedAccount - Retrieves LogicMonitor collectors. + Retrieves information about cached LogicMonitor account credentials. - The Get-LMCollector function retrieves collector information from LogicMonitor. It can return a single collector by ID or name, or multiple collectors using filters or the filter wizard. + The Get-LMCachedAccount function retrieves information about cached LogicMonitor account credentials stored in the Logic.Monitor vault. It can return information for a specific cached account or all cached accounts. - Get-LMCollector - - Id - - The ID of the collector to retrieve. Part of a mutually exclusive parameter set. - - Int32 - - Int32 - - - 0 - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Get-LMCollector - - Name + Get-LMCachedAccount + + CachedAccountName - The name of the collector to retrieve. Part of a mutually exclusive parameter set. + The name of the specific cached account to retrieve information for. If not specified, returns information for all cached accounts. String @@ -5051,95 +6055,6 @@ Get-LMCachedAccount -CachedAccountName "MyAccount" None - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Get-LMCollector - - Filter - - A filter object to apply when retrieving collectors. Part of a mutually exclusive parameter set. - - Object - - Object - - - None - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Get-LMCollector - - FilterWizard - - Switch to use the filter wizard interface for building the filter. Part of a mutually exclusive parameter set. - - - SwitchParameter - - - False - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - ProgressAction @@ -5155,22 +6070,10 @@ Get-LMCachedAccount -CachedAccountName "MyAccount" - - Id - - The ID of the collector to retrieve. Part of a mutually exclusive parameter set. - - Int32 - - Int32 - - - 0 - - - Name + + CachedAccountName - The name of the collector to retrieve. Part of a mutually exclusive parameter set. + The name of the specific cached account to retrieve information for. If not specified, returns information for all cached accounts. String @@ -5179,42 +6082,299 @@ Get-LMCachedAccount -CachedAccountName "MyAccount" None - - Filter - - A filter object to apply when retrieving collectors. Part of a mutually exclusive parameter set. - - Object - - Object - - - None - - - FilterWizard - - Switch to use the filter wizard interface for building the filter. Part of a mutually exclusive parameter set. - - SwitchParameter - - SwitchParameter - - - False - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns an array of custom objects containing cached account information including CachedAccountName, Portal, Id, Modified date, and Type. + + + + + + + + + This function requires access to the Logic.Monitor vault where credentials are stored. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Retrieve all cached accounts +Get-LMCachedAccount + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve a specific cached account +Get-LMCachedAccount -CachedAccountName "MyAccount" + + + + + + + + Get-SecretInfo + + + + + + + Get-LMCollector + Get + LMCollector + + Retrieves LogicMonitor collectors. + + + + The Get-LMCollector function retrieves collector information from LogicMonitor. It can return a single collector by ID or name, or multiple collectors using filters or the filter wizard. + + + + Get-LMCollector + + Id + + The ID of the collector to retrieve. Part of a mutually exclusive parameter set. + + Int32 + + Int32 + + + 0 + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMCollector + + Name + + The name of the collector to retrieve. Part of a mutually exclusive parameter set. + + String + + String + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMCollector + + Filter + + A filter object to apply when retrieving collectors. Part of a mutually exclusive parameter set. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMCollector + + FilterWizard + + Switch to use the filter wizard interface for building the filter. Part of a mutually exclusive parameter set. + + + SwitchParameter + + + False + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + The ID of the collector to retrieve. Part of a mutually exclusive parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the collector to retrieve. Part of a mutually exclusive parameter set. + + String + + String + + + None + + + Filter + + A filter object to apply when retrieving collectors. Part of a mutually exclusive parameter set. + + Object + + Object + + + None + + + FilterWizard + + Switch to use the filter wizard interface for building the filter. Part of a mutually exclusive parameter set. + + SwitchParameter + + SwitchParameter + + + False + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + ProgressAction @@ -6035,9 +7195,9 @@ Get-LMCollectorInstaller -Name "Collector1" -OSandArch Linux64 -UseEA $true - Get-LMCollectorVersions + Get-LMCollectorVersion Get - LMCollectorVersions + LMCollectorVersion Retrieves available LogicMonitor collector versions. @@ -6047,7 +7207,7 @@ Get-LMCollectorInstaller -Name "Collector1" -OSandArch Linux64 -UseEA $true - Get-LMCollectorVersions + Get-LMCollectorVersion Filter @@ -6086,7 +7246,7 @@ Get-LMCollectorInstaller -Name "Collector1" -OSandArch Linux64 -UseEA $true - Get-LMCollectorVersions + Get-LMCollectorVersion TopVersions @@ -6743,6 +7903,329 @@ Get-LMConfigsourceUpdateHistory -Name "Cisco Config" + + + Get-LMCostOptimizationRecommendation + Get + LMCostOptimizationRecommendation + + Retrieves cloud cost optimization recommendations from LogicMonitor. + + + + The Get-LMCostOptimizationRecommendation function retrieves cloud cost optimization recommendations from a connected LogicMonitor portal. + + + + Get-LMCostOptimizationRecommendation + + Id + + The alphanumeric ID of the cost optimization recommendation to retrieve. Example: 1-2-EBS_UNATTACHED + + String + + String + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 50. + + Int32 + + Int32 + + + 50 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMCostOptimizationRecommendation + + Filter + + A filter object to apply when retrieving cost optimization recommendations. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 50. + + Int32 + + Int32 + + + 50 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + The alphanumeric ID of the cost optimization recommendation to retrieve. Example: 1-2-EBS_UNATTACHED + + String + + String + + + None + + + Filter + + A filter object to apply when retrieving cost optimization recommendations. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 50. + + Int32 + + Int32 + + + 50 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + No input is accepted. + + + + + + + + + + Returns LogicMonitor.CostOptimizationRecommendations objects. + + + + + + + + + You must run Connect-LMAccount before running this command. When using filters, consult the LM API docs for allowed filter fields. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Retrieve all cost optimization recommendations +Get-LMCostOptimizationRecommendation + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve cost optimization recommendations using a filter +Get-LMCostOptimizationRecommendation -Filter 'recommendationCategory -eq "Underutilized AWS EC2 instances"' + + + + + + + + + + Get-LMCostOptimizationRecommendationCategory + Get + LMCostOptimizationRecommendationCategory + + Retrieves cloud cost optimization recommendation categories from LogicMonitor. + + + + The Get-LMCostOptimizationRecommendationCategory function retrieves cloud cost optimization recommendation categories from a connected LogicMonitor portal. + + + + Get-LMCostOptimizationRecommendationCategory + + Filter + + A filter object to apply when retrieving cost optimization recommendation categories. Only recommendationCategory and recommendationStatus are supported for filtering using the equals operator all others are not supported at this time. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 50. + + Int32 + + Int32 + + + 50 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Filter + + A filter object to apply when retrieving cost optimization recommendation categories. Only recommendationCategory and recommendationStatus are supported for filtering using the equals operator all others are not supported at this time. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 50. + + Int32 + + Int32 + + + 50 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + No input is accepted. + + + + + + + + + + Returns LogicMonitor.CostOptimizationRecommendationCategory objects. + + + + + + + + + You must run Connect-LMAccount before running this command. When using filters, consult the LM API docs for allowed filter fields. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Retrieve all cost optimization recommendation categories +Get-LMCostOptimizationRecommendationCategory + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve cost optimization recommendation categories using a filter +Get-LMCostOptimizationRecommendationCategory -Filter 'recommendationCategory -eq "Underutilized AWS EC2 instances"' + + + + + + + Get-LMDashboard @@ -8205,19 +9688,19 @@ Get-LMDatasource -DisplayName "CPU Usage" - Get-LMDatasourceAssociatedDevices + Get-LMDatasourceAssociatedDevice Get - LMDatasourceAssociatedDevices + LMDatasourceAssociatedDevice Retrieves devices associated with a LogicMonitor datasource. - The Get-LMDatasourceAssociatedDevices function retrieves all devices that are associated with a specific datasource. It can identify the datasource by ID, name, or display name. + The Get-LMDatasourceAssociatedDevice function retrieves all devices that are associated with a specific datasource. It can identify the datasource by ID, name, or display name. - Get-LMDatasourceAssociatedDevices + Get-LMDatasourceAssociatedDevice Id @@ -8268,7 +9751,7 @@ Get-LMDatasource -DisplayName "CPU Usage" - Get-LMDatasourceAssociatedDevices + Get-LMDatasourceAssociatedDevice Name @@ -8319,7 +9802,7 @@ Get-LMDatasource -DisplayName "CPU Usage" - Get-LMDatasourceAssociatedDevices + Get-LMDatasourceAssociatedDevice DisplayName @@ -8473,7 +9956,7 @@ Get-LMDatasource -DisplayName "CPU Usage" -------------------------- EXAMPLE 1 -------------------------- #Retrieve devices associated with a datasource by ID -Get-LMDatasourceAssociatedDevices -Id 123 +Get-LMDatasourceAssociatedDevice -Id 123 @@ -8481,7 +9964,7 @@ Get-LMDatasourceAssociatedDevices -Id 123 -------------------------- EXAMPLE 2 -------------------------- #Retrieve devices associated with a datasource by name -Get-LMDatasourceAssociatedDevices -Name "CPU" +Get-LMDatasourceAssociatedDevice -Name "CPU" @@ -10557,9 +12040,9 @@ Get-LMDevice -Delta - Get-LMDeviceAlerts + Get-LMDeviceAlert Get - LMDeviceAlerts + LMDeviceAlert Retrieves alerts for a specific LogicMonitor device. @@ -10569,7 +12052,7 @@ Get-LMDevice -Delta - Get-LMDeviceAlerts + Get-LMDeviceAlert Id @@ -10620,7 +12103,7 @@ Get-LMDevice -Delta - Get-LMDeviceAlerts + Get-LMDeviceAlert Name @@ -10780,19 +12263,19 @@ Get-LMDeviceAlerts -Name "Production-Server" -Filter $filterObject - Get-LMDeviceAlertSettings + Get-LMDeviceAlertSetting Get - LMDeviceAlertSettings + LMDeviceAlertSetting Retrieves alert settings for a specific LogicMonitor device. - The Get-LMDeviceAlertSettings function retrieves the alert configuration settings for a specific device in LogicMonitor. The device can be identified by either ID or name, and the results can be filtered using custom criteria. + The Get-LMDeviceAlertSetting function retrieves the alert configuration settings for a specific device in LogicMonitor. The device can be identified by either ID or name, and the results can be filtered using custom criteria. - Get-LMDeviceAlertSettings + Get-LMDeviceAlertSetting Id @@ -10843,7 +12326,7 @@ Get-LMDeviceAlerts -Name "Production-Server" -Filter $filterObject - Get-LMDeviceAlertSettings + Get-LMDeviceAlertSetting Name @@ -10985,7 +12468,7 @@ Get-LMDeviceAlerts -Name "Production-Server" -Filter $filterObject -------------------------- EXAMPLE 1 -------------------------- #Retrieve alert settings for a device by ID -Get-LMDeviceAlertSettings -Id 123 +Get-LMDeviceAlertSetting -Id 123 @@ -10993,7 +12476,7 @@ Get-LMDeviceAlertSettings -Id 123 -------------------------- EXAMPLE 2 -------------------------- #Retrieve alert settings for a device by name -Get-LMDeviceAlertSettings -Name "Production-Server" +Get-LMDeviceAlertSetting -Name "Production-Server" @@ -12667,19 +14150,19 @@ Get-LMDeviceDatasourceInstance -DatasourceId 123 -Id 456 - Get-LMDeviceDatasourceInstanceAlertRecipients + Get-LMDeviceDatasourceInstanceAlertRecipient Get - LMDeviceDatasourceInstanceAlertRecipients + LMDeviceDatasourceInstanceAlertRecipient Retrieves alert recipients for a specific data point in a LogicMonitor device datasource instance. - The Get-LMDeviceDatasourceInstanceAlertRecipients function retrieves the alert recipients configured for a specific data point within a device's datasource instance. It supports identifying the device and datasource by either ID or name. + The Get-LMDeviceDatasourceInstanceAlertRecipient function retrieves the alert recipients configured for a specific data point within a device's datasource instance. It supports identifying the device and datasource by either ID or name. - Get-LMDeviceDatasourceInstanceAlertRecipients + Get-LMDeviceDatasourceInstanceAlertRecipient DatasourceName @@ -12742,7 +14225,7 @@ Get-LMDeviceDatasourceInstance -DatasourceId 123 -Id 456 - Get-LMDeviceDatasourceInstanceAlertRecipients + Get-LMDeviceDatasourceInstanceAlertRecipient DatasourceName @@ -12805,7 +14288,7 @@ Get-LMDeviceDatasourceInstance -DatasourceId 123 -Id 456 - Get-LMDeviceDatasourceInstanceAlertRecipients + Get-LMDeviceDatasourceInstanceAlertRecipient DatasourceId @@ -12868,7 +14351,7 @@ Get-LMDeviceDatasourceInstance -DatasourceId 123 -Id 456 - Get-LMDeviceDatasourceInstanceAlertRecipients + Get-LMDeviceDatasourceInstanceAlertRecipient DatasourceId @@ -13046,7 +14529,7 @@ Get-LMDeviceDatasourceInstance -DatasourceId 123 -Id 456 -------------------------- EXAMPLE 1 -------------------------- #Retrieve alert recipients using names -Get-LMDeviceDatasourceInstanceAlertRecipients -DatasourceName "Ping" -Name "Server01" -InstanceName "Instance01" -DataPointName "PingLossPercent" +Get-LMDeviceDatasourceInstanceAlertRecipient -DatasourceName "Ping" -Name "Server01" -InstanceName "Instance01" -DataPointName "PingLossPercent" @@ -13054,7 +14537,7 @@ Get-LMDeviceDatasourceInstanceAlertRecipients -DatasourceName "Ping" -Name "Serv -------------------------- EXAMPLE 2 -------------------------- #Retrieve alert recipients using IDs -Get-LMDeviceDatasourceInstanceAlertRecipients -DatasourceId 123 -Id 456 -InstanceName "Instance01" -DataPointName "PingLossPercent" +Get-LMDeviceDatasourceInstanceAlertRecipient -DatasourceId 123 -Id 456 -InstanceName "Instance01" -DataPointName "PingLossPercent" @@ -14140,9 +15623,9 @@ Get-LMDeviceDatasourceInstanceGroup -DatasourceId 123 -Id 456 - Get-LMDeviceDatasourceList + Get-LMDeviceDataSourceList Get - LMDeviceDatasourceList + LMDeviceDataSourceList {{ Fill in the Synopsis }} @@ -14152,11 +15635,11 @@ Get-LMDeviceDatasourceInstanceGroup -DatasourceId 123 -Id 456 - Get-LMDeviceDatasourceList - - BatchSize + Get-LMDeviceDataSourceList + + Id - {{ Fill BatchSize Description }} + {{ Fill Id Description }} Int32 @@ -14177,10 +15660,10 @@ Get-LMDeviceDatasourceInstanceGroup -DatasourceId 123 -Id 456 None - - Id + + BatchSize - {{ Fill Id Description }} + {{ Fill BatchSize Description }} Int32 @@ -14203,15 +15686,15 @@ Get-LMDeviceDatasourceInstanceGroup -DatasourceId 123 -Id 456 - Get-LMDeviceDatasourceList - - BatchSize + Get-LMDeviceDataSourceList + + Name - {{ Fill BatchSize Description }} + {{ Fill Name Description }} - Int32 + String - Int32 + String None @@ -14228,14 +15711,14 @@ Get-LMDeviceDatasourceInstanceGroup -DatasourceId 123 -Id 456 None - - Name + + BatchSize - {{ Fill Name Description }} + {{ Fill BatchSize Description }} - String + Int32 - String + Int32 None @@ -14255,10 +15738,10 @@ Get-LMDeviceDatasourceInstanceGroup -DatasourceId 123 -Id 456 - - BatchSize + + Id - {{ Fill BatchSize Description }} + {{ Fill Id Description }} Int32 @@ -14267,38 +15750,38 @@ Get-LMDeviceDatasourceInstanceGroup -DatasourceId 123 -Id 456 None - - Filter + + Name - {{ Fill Filter Description }} + {{ Fill Name Description }} - Object + String - Object + String None - - Id + + Filter - {{ Fill Id Description }} + {{ Fill Filter Description }} - Int32 + Object - Int32 + Object None - - Name + + BatchSize - {{ Fill Name Description }} + {{ Fill BatchSize Description }} - String + Int32 - String + Int32 None @@ -14873,19 +16356,19 @@ Get-LMDeviceGroup -Filter @{parentId=1;disableAlerting=$false} - Get-LMDeviceGroupAlerts + Get-LMDeviceGroupAlert Get - LMDeviceGroupAlerts + LMDeviceGroupAlert Retrieves alerts for a LogicMonitor device group. - The Get-LMDeviceGroupAlerts function retrieves all alerts associated with a specific device group in LogicMonitor. The device group can be identified by either ID or name, and the results can be filtered. + The Get-LMDeviceGroupAlert function retrieves all alerts associated with a specific device group in LogicMonitor. The device group can be identified by either ID or name, and the results can be filtered. - Get-LMDeviceGroupAlerts + Get-LMDeviceGroupAlert Id @@ -14936,7 +16419,7 @@ Get-LMDeviceGroup -Filter @{parentId=1;disableAlerting=$false} - Get-LMDeviceGroupAlerts + Get-LMDeviceGroupAlert Name @@ -15078,7 +16561,7 @@ Get-LMDeviceGroup -Filter @{parentId=1;disableAlerting=$false} -------------------------- EXAMPLE 1 -------------------------- #Retrieve alerts for a device group by ID -Get-LMDeviceGroupAlerts -Id 123 +Get-LMDeviceGroupAlert -Id 123 @@ -15086,7 +16569,7 @@ Get-LMDeviceGroupAlerts -Id 123 -------------------------- EXAMPLE 2 -------------------------- #Retrieve alerts for a device group by name with filter -Get-LMDeviceGroupAlerts -Name "Production Servers" -Filter $filterObject +Get-LMDeviceGroupAlert -Name "Production Servers" -Filter $filterObject @@ -15716,19 +17199,19 @@ Get-LMDeviceGroupDatasourceList -Name "Production Servers" -Filter $filterObject - Get-LMDeviceGroupDevices + Get-LMDeviceGroupDevice Get - LMDeviceGroupDevices + LMDeviceGroupDevice Retrieves devices belonging to a LogicMonitor device group. - The Get-LMDeviceGroupDevices function retrieves all devices that belong to a specific device group. It supports retrieving devices from subgroups and can filter the results. + The Get-LMDeviceGroupDevice function retrieves all devices that belong to a specific device group. It supports retrieving devices from subgroups and can filter the results. - Get-LMDeviceGroupDevices + Get-LMDeviceGroupDevice Id @@ -15791,7 +17274,7 @@ Get-LMDeviceGroupDatasourceList -Name "Production Servers" -Filter $filterObject - Get-LMDeviceGroupDevices + Get-LMDeviceGroupDevice Name @@ -15957,7 +17440,7 @@ Get-LMDeviceGroupDatasourceList -Name "Production Servers" -Filter $filterObject -------------------------- EXAMPLE 1 -------------------------- #Retrieve devices from a group by ID -Get-LMDeviceGroupDevices -Id 123 +Get-LMDeviceGroupDevice -Id 123 @@ -15965,7 +17448,7 @@ Get-LMDeviceGroupDevices -Id 123 -------------------------- EXAMPLE 2 -------------------------- #Retrieve devices including subgroups -Get-LMDeviceGroupDevices -Name "Production Servers" -IncludeSubGroups $true +Get-LMDeviceGroupDevice -Name "Production Servers" -IncludeSubGroups $true @@ -15975,19 +17458,19 @@ Get-LMDeviceGroupDevices -Name "Production Servers" -IncludeSubGroups $true - Get-LMDeviceGroupGroups + Get-LMDeviceGroupGroup Get - LMDeviceGroupGroups + LMDeviceGroupGroup Retrieves subgroups of a LogicMonitor device group. - The Get-LMDeviceGroupGroups function retrieves all subgroups that belong to a specified device group in LogicMonitor. The parent group can be identified by either ID or name, and the results can be filtered. + The Get-LMDeviceGroupGroup function retrieves all subgroups that belong to a specified device group in LogicMonitor. The parent group can be identified by either ID or name, and the results can be filtered. - Get-LMDeviceGroupGroups + Get-LMDeviceGroupGroup Id @@ -16038,7 +17521,7 @@ Get-LMDeviceGroupDevices -Name "Production Servers" -IncludeSubGroups $true - Get-LMDeviceGroupGroups + Get-LMDeviceGroupGroup Name @@ -16180,7 +17663,7 @@ Get-LMDeviceGroupDevices -Name "Production Servers" -IncludeSubGroups $true -------------------------- EXAMPLE 1 -------------------------- #Retrieve subgroups by parent group ID -Get-LMDeviceGroupGroups -Id 123 +Get-LMDeviceGroupGroup -Id 123 @@ -16188,7 +17671,7 @@ Get-LMDeviceGroupGroups -Id 123 -------------------------- EXAMPLE 2 -------------------------- #Retrieve filtered subgroups by parent group name -Get-LMDeviceGroupGroups -Name "Production" -Filter $filterObject +Get-LMDeviceGroupGroup -Name "Production" -Filter $filterObject @@ -16198,182 +17681,22 @@ Get-LMDeviceGroupGroups -Name "Production" -Filter $filterObject - Get-LMDeviceGroupProperty + Get-LMDeviceGroupGroups Get - LMDeviceGroupProperty + LMDeviceGroupGroups - Retrieves properties of a LogicMonitor device group. + Retrieves subgroups of a LogicMonitor device group. - The Get-LMDeviceGroupProperty function retrieves all properties associated with a specified device group in LogicMonitor. The device group can be identified by either ID or name, and the results can be filtered. + The Get-LMDeviceGroupGroups function retrieves all subgroups that belong to a specified device group in LogicMonitor. The parent group can be identified by either ID or name, and the results can be filtered. - Get-LMDeviceGroupProperty - - Id - - The ID of the device group to retrieve properties from. Required for Id parameter set. - - Int32 - - Int32 - - - 0 - - - Filter - - A filter object to apply when retrieving properties. This parameter is optional. - - Object - - Object - - - None - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Get-LMDeviceGroupProperty - - Name - - The name of the device group to retrieve properties from. Required for Name parameter set. - - String - - String - - - None - - - Filter - - A filter object to apply when retrieving properties. This parameter is optional. - - Object - - Object - - - None - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - + Get-LMDeviceGroupGroups - - - Id - - The ID of the device group to retrieve properties from. Required for Id parameter set. - - Int32 - - Int32 - - - 0 - - - Name - - The name of the device group to retrieve properties from. Required for Name parameter set. - - String - - String - - - None - - - Filter - - A filter object to apply when retrieving properties. This parameter is optional. - - Object - - Object - - - None - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - + @@ -16387,7 +17710,7 @@ Get-LMDeviceGroupGroups -Name "Production" -Filter $filterObject - Returns property objects for the specified device group. + Returns LogicMonitor.DeviceGroup objects. @@ -16402,16 +17725,16 @@ Get-LMDeviceGroupGroups -Name "Production" -Filter $filterObject -------------------------- EXAMPLE 1 -------------------------- - #Retrieve properties by group ID -Get-LMDeviceGroupProperty -Id 123 + #Retrieve subgroups by parent group ID +Get-LMDeviceGroupGroups -Id 123 -------------------------- EXAMPLE 2 -------------------------- - #Retrieve filtered properties by group name -Get-LMDeviceGroupProperty -Name "Production" -Filter $filterObject + #Retrieve filtered subgroups by parent group name +Get-LMDeviceGroupGroups -Name "Production" -Filter $filterObject @@ -16421,23 +17744,23 @@ Get-LMDeviceGroupProperty -Name "Production" -Filter $filterObject - Get-LMDeviceGroupSDT + Get-LMDeviceGroupProperty Get - LMDeviceGroupSDT + LMDeviceGroupProperty - Retrieves Scheduled Downtime (SDT) entries for a LogicMonitor device group. + Retrieves properties of a LogicMonitor device group. - The Get-LMDeviceGroupSDT function retrieves all active Scheduled Downtime entries for a specified device group in LogicMonitor. The device group can be identified by either ID or name, and the results can be filtered. + The Get-LMDeviceGroupProperty function retrieves all properties associated with a specified device group in LogicMonitor. The device group can be identified by either ID or name, and the results can be filtered. - Get-LMDeviceGroupSDT + Get-LMDeviceGroupProperty Id - The ID of the device group to retrieve SDT entries from. Required for Id parameter set. + The ID of the device group to retrieve properties from. Required for Id parameter set. Int32 @@ -16449,7 +17772,230 @@ Get-LMDeviceGroupProperty -Name "Production" -Filter $filterObject Filter - A filter object to apply when retrieving SDT entries. This parameter is optional. + A filter object to apply when retrieving properties. This parameter is optional. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMDeviceGroupProperty + + Name + + The name of the device group to retrieve properties from. Required for Name parameter set. + + String + + String + + + None + + + Filter + + A filter object to apply when retrieving properties. This parameter is optional. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + The ID of the device group to retrieve properties from. Required for Id parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the device group to retrieve properties from. Required for Name parameter set. + + String + + String + + + None + + + Filter + + A filter object to apply when retrieving properties. This parameter is optional. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns property objects for the specified device group. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Retrieve properties by group ID +Get-LMDeviceGroupProperty -Id 123 + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve filtered properties by group name +Get-LMDeviceGroupProperty -Name "Production" -Filter $filterObject + + + + + + + + + + Get-LMDeviceGroupSDT + Get + LMDeviceGroupSDT + + Retrieves Scheduled Downtime (SDT) entries for a LogicMonitor device group. + + + + The Get-LMDeviceGroupSDT function retrieves all active Scheduled Downtime entries for a specified device group in LogicMonitor. The device group can be identified by either ID or name, and the results can be filtered. + + + + Get-LMDeviceGroupSDT + + Id + + The ID of the device group to retrieve SDT entries from. Required for Id parameter set. + + Int32 + + Int32 + + + 0 + + + Filter + + A filter object to apply when retrieving SDT entries. This parameter is optional. Object @@ -17334,19 +18880,19 @@ Get-LMDeviceInstanceList -Name "Production-Server" -CountOnly $true - Get-LMDeviceNetflowEndpoints + Get-LMDeviceNetflowEndpoint Get - LMDeviceNetflowEndpoints + LMDeviceNetflowEndpoint Retrieves Netflow endpoint data for a LogicMonitor device. - The Get-LMDeviceNetflowEndpoints function retrieves Netflow endpoint information for a specified device. It supports time range filtering and can identify the device by either ID or name. + The Get-LMDeviceNetflowEndpoint function retrieves Netflow endpoint information for a specified device. It supports time range filtering and can identify the device by either ID or name. - Get-LMDeviceNetflowEndpoints + Get-LMDeviceNetflowEndpoint Id @@ -17421,7 +18967,7 @@ Get-LMDeviceInstanceList -Name "Production-Server" -CountOnly $true - Get-LMDeviceNetflowEndpoints + Get-LMDeviceNetflowEndpoint Name @@ -17611,7 +19157,7 @@ Get-LMDeviceInstanceList -Name "Production-Server" -CountOnly $true -------------------------- EXAMPLE 1 -------------------------- #Retrieve Netflow endpoints by device ID -Get-LMDeviceNetflowEndpoints -Id 123 +Get-LMDeviceNetflowEndpoint -Id 123 @@ -17619,7 +19165,7 @@ Get-LMDeviceNetflowEndpoints -Id 123 -------------------------- EXAMPLE 2 -------------------------- #Retrieve Netflow endpoints with date range -Get-LMDeviceNetflowEndpoints -Name "Router1" -StartDate (Get-Date).AddDays(-7) +Get-LMDeviceNetflowEndpoint -Name "Router1" -StartDate (Get-Date).AddDays(-7) @@ -17629,19 +19175,19 @@ Get-LMDeviceNetflowEndpoints -Name "Router1" -StartDate (Get-Date).AddDays(-7) - Get-LMDeviceNetflowFlows + Get-LMDeviceNetflowFlow Get - LMDeviceNetflowFlows + LMDeviceNetflowFlow Retrieves Netflow flow data for a LogicMonitor device. - The Get-LMDeviceNetflowFlows function retrieves Netflow flow information for a specified device. It supports time range filtering and can identify the device by either ID or name. + The Get-LMDeviceNetflowFlow function retrieves Netflow flow information for a specified device. It supports time range filtering and can identify the device by either ID or name. - Get-LMDeviceNetflowFlows + Get-LMDeviceNetflowFlow Id @@ -17716,7 +19262,7 @@ Get-LMDeviceNetflowEndpoints -Name "Router1" -StartDate (Get-Date).AddDays(-7) - Get-LMDeviceNetflowFlows + Get-LMDeviceNetflowFlow Name @@ -17906,7 +19452,7 @@ Get-LMDeviceNetflowEndpoints -Name "Router1" -StartDate (Get-Date).AddDays(-7) -------------------------- EXAMPLE 1 -------------------------- #Retrieve Netflow flows by device ID -Get-LMDeviceNetflowFlows -Id 123 +Get-LMDeviceNetflowFlow -Id 123 @@ -17914,7 +19460,7 @@ Get-LMDeviceNetflowFlows -Id 123 -------------------------- EXAMPLE 2 -------------------------- #Retrieve Netflow flows with date range -Get-LMDeviceNetflowFlows -Name "Router1" -StartDate (Get-Date).AddDays(-7) +Get-LMDeviceNetflowFlow -Name "Router1" -StartDate (Get-Date).AddDays(-7) @@ -17924,19 +19470,19 @@ Get-LMDeviceNetflowFlows -Name "Router1" -StartDate (Get-Date).AddDays(-7) - Get-LMDeviceNetflowPorts + Get-LMDeviceNetflowPort Get - LMDeviceNetflowPorts + LMDeviceNetflowPort Retrieves Netflow port data for a LogicMonitor device. - The Get-LMDeviceNetflowPorts function retrieves Netflow port information for a specified device. It supports time range filtering and can identify the device by either ID or name. + The Get-LMDeviceNetflowPort function retrieves Netflow port information for a specified device. It supports time range filtering and can identify the device by either ID or name. - Get-LMDeviceNetflowPorts + Get-LMDeviceNetflowPort Id @@ -18011,7 +19557,7 @@ Get-LMDeviceNetflowFlows -Name "Router1" -StartDate (Get-Date).AddDays(-7) - Get-LMDeviceNetflowPorts + Get-LMDeviceNetflowPort Name @@ -18201,7 +19747,7 @@ Get-LMDeviceNetflowFlows -Name "Router1" -StartDate (Get-Date).AddDays(-7) -------------------------- EXAMPLE 1 -------------------------- #Retrieve Netflow ports by device ID -Get-LMDeviceNetflowPorts -Id 123 +Get-LMDeviceNetflowPort -Id 123 @@ -18209,7 +19755,7 @@ Get-LMDeviceNetflowPorts -Id 123 -------------------------- EXAMPLE 2 -------------------------- #Retrieve Netflow ports with date range -Get-LMDeviceNetflowPorts -Name "Router1" -StartDate (Get-Date).AddDays(-7) +Get-LMDeviceNetflowPort -Name "Router1" -StartDate (Get-Date).AddDays(-7) @@ -18999,23 +20545,23 @@ Get-LMDeviceSDTHistory -Name "Production-Server" - Get-LMEscalationChain + Get-LMDiagnosticSource Get - LMEscalationChain + LMDiagnosticSource - Retrieves escalation chains from LogicMonitor. + Retrieves diagnostic sources from LogicMonitor. - The Get-LMEscalationChain function retrieves escalation chain configurations from LogicMonitor. It can retrieve all chains, a specific chain by ID or name, or filter the results. + The Get-LMDiagnosticSource function retrieves diagnostic source information from LogicMonitor. It can return diagnostic sources by ID, name, or using filters. - Get-LMEscalationChain + Get-LMDiagnosticSource Id - The ID of the specific escalation chain to retrieve. + The ID of the diagnostic source to retrieve. Part of a mutually exclusive parameter set. Int32 @@ -19050,11 +20596,11 @@ Get-LMDeviceSDTHistory -Name "Production-Server" - Get-LMEscalationChain + Get-LMDiagnosticSource Name - The name of the specific escalation chain to retrieve. + The name of the diagnostic source to retrieve. Part of a mutually exclusive parameter set. String @@ -19089,11 +20635,300 @@ Get-LMDeviceSDTHistory -Name "Production-Server" - Get-LMEscalationChain + Get-LMDiagnosticSource + + DisplayName + + The display name of the diagnostic source to retrieve. Part of a mutually exclusive parameter set. + + String + + String + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMDiagnosticSource Filter - A filter object to apply when retrieving escalation chains. + A filter object to apply when retrieving diagnostic sources. Part of a mutually exclusive parameter set. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + The ID of the diagnostic source to retrieve. Part of a mutually exclusive parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the diagnostic source to retrieve. Part of a mutually exclusive parameter set. + + String + + String + + + None + + + DisplayName + + The display name of the diagnostic source to retrieve. Part of a mutually exclusive parameter set. + + String + + String + + + None + + + Filter + + A filter object to apply when retrieving diagnostic sources. Part of a mutually exclusive parameter set. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.DiagnosticSource objects. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + # Retrieve a diagnostic source by ID +Get-LMDiagnosticSource -Id 123 + + + + + + -------------------------- EXAMPLE 2 -------------------------- + # Retrieve a diagnostic source by name +Get-LMDiagnosticSource -Name "Test_DiagnosticSource" + + + + + + + + + + Get-LMEscalationChain + Get + LMEscalationChain + + Retrieves escalation chains from LogicMonitor. + + + + The Get-LMEscalationChain function retrieves escalation chain configurations from LogicMonitor. It can retrieve all chains, a specific chain by ID or name, or filter the results. + + + + Get-LMEscalationChain + + Id + + The ID of the specific escalation chain to retrieve. + + Int32 + + Int32 + + + 0 + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMEscalationChain + + Name + + The name of the specific escalation chain to retrieve. + + String + + String + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMEscalationChain + + Filter + + A filter object to apply when retrieving escalation chains. Object @@ -19475,9 +21310,247 @@ Get-LMEventSource -Name "Windows-Events" - Get-LMIntegrationLogs + Get-LMIntegration + Get + LMIntegration + + Retrieves integrations from LogicMonitor. + + + + The Get-LMIntegration function retrieves integration configurations from LogicMonitor. It can retrieve all integrations, a specific integration by ID or name, or filter the results. + + + + Get-LMIntegration + + Id + + The ID of the specific integration to retrieve. + + Int32 + + Int32 + + + 0 + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMIntegration + + Name + + The name of the specific integration to retrieve. + + String + + String + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMIntegration + + Filter + + A filter object to apply when retrieving integrations. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + The ID of the specific integration to retrieve. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the specific integration to retrieve. + + String + + String + + + None + + + Filter + + A filter object to apply when retrieving integrations. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns integration objects from LogicMonitor. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Retrieve all integrations +Get-LMIntegration + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve a specific integration by name +Get-LMIntegration -Name "Slack-Integration" + + + + + + + + + + Get-LMIntegrationLog Get - LMIntegrationLogs + LMIntegrationLog Retrieves integration audit logs from LogicMonitor. @@ -19487,7 +21560,7 @@ Get-LMEventSource -Name "Windows-Events" - Get-LMIntegrationLogs + Get-LMIntegrationLog Id @@ -19526,7 +21599,7 @@ Get-LMEventSource -Name "Windows-Events" - Get-LMIntegrationLogs + Get-LMIntegrationLog SearchString @@ -19589,7 +21662,7 @@ Get-LMEventSource -Name "Windows-Events" - Get-LMIntegrationLogs + Get-LMIntegrationLog Filter @@ -19743,7 +21816,7 @@ Get-LMEventSource -Name "Windows-Events" -------------------------- EXAMPLE 1 -------------------------- #Retrieve logs for the last 30 days -Get-LMIntegrationLogs +Get-LMIntegrationLog @@ -19751,7 +21824,7 @@ Get-LMIntegrationLogs -------------------------- EXAMPLE 2 -------------------------- #Retrieve logs with a specific search string and date range -Get-LMIntegrationLogs -SearchString "error" -StartDate (Get-Date).AddDays(-7) +Get-LMIntegrationLog -SearchString "error" -StartDate (Get-Date).AddDays(-7) @@ -19795,6 +21868,7 @@ Get-LMIntegrationLogs -SearchString "error" -StartDate (Get-Date).AddDays(-7)DATASOURCE PROPERTYSOURCE CONFIGSOURCE + DIAGNOSTICSOURCE EVENTSOURCE TOPOLOGYSOURCE SNMP_SYSOID_MAP @@ -21449,19 +23523,19 @@ Get-LMNetscanExecution -Name "Network-Discovery" - Get-LMNetscanExecutionDevices + Get-LMNetscanExecutionDevice Get - LMNetscanExecutionDevices + LMNetscanExecutionDevice Retrieves devices discovered during a Netscan execution. - The Get-LMNetscanExecutionDevices function retrieves devices discovered during a specific Netscan execution in LogicMonitor. The Netscan can be identified by either ID or name. + The Get-LMNetscanExecutionDevice function retrieves devices discovered during a specific Netscan execution in LogicMonitor. The Netscan can be identified by either ID or name. - Get-LMNetscanExecutionDevices + Get-LMNetscanExecutionDevice Id @@ -21524,7 +23598,7 @@ Get-LMNetscanExecution -Name "Network-Discovery" - Get-LMNetscanExecutionDevices + Get-LMNetscanExecutionDevice NspName @@ -21678,7 +23752,7 @@ Get-LMNetscanExecution -Name "Network-Discovery" -------------------------- EXAMPLE 1 -------------------------- #Retrieve devices from a specific execution -Get-LMNetscanExecutionDevices -Id 456 -NspId 123 +Get-LMNetscanExecutionDevice -Id 456 -NspId 123 @@ -21686,7 +23760,7 @@ Get-LMNetscanExecutionDevices -Id 456 -NspId 123 -------------------------- EXAMPLE 2 -------------------------- #Retrieve devices using Netscan name -Get-LMNetscanExecutionDevices -Id 456 -NspName "Network-Discovery" +Get-LMNetscanExecutionDevice -Id 456 -NspName "Network-Discovery" @@ -21934,19 +24008,19 @@ Get-LMNetscanGroup -Name "Production-Scans" - Get-LMNormalizedProperties + Get-LMNormalizedProperty Get - LMNormalizedProperties + LMNormalizedProperty Gets normalized property mappings from LogicMonitor. - The Get-LMNormalizedProperties function retrieves normalized property mappings that allow standardizing property names across your LogicMonitor environment. This function only supports the v4 API. + The Get-LMNormalizedProperty function retrieves normalized property mappings that allow standardizing property names across your LogicMonitor environment. This function only supports the v4 API. - Get-LMNormalizedProperties + Get-LMNormalizedProperty ProgressAction @@ -22004,7 +24078,7 @@ Get-LMNetscanGroup -Name "Production-Scans" -------------------------- EXAMPLE 1 -------------------------- #Retrieve all normalized properties -Get-LMNormalizedProperties +Get-LMNormalizedProperty @@ -22570,62 +24644,59 @@ Get-LMPropertySource -Name "Windows-Properties" - Get-LMRecipientGroup + Get-LMRecentlyDeleted Get - LMRecipientGroup + LMRecentlyDeleted - Retrieves recipient groups from LogicMonitor. + Retrieves recently deleted resources from the LogicMonitor recycle bin. - The Get-LMRecipientGroup function retrieves recipient group configurations from LogicMonitor. It can retrieve all groups, a specific group by ID or name, or filter the results. + The Get-LMRecentlyDeleted function queries the LogicMonitor recycle bin for deleted resources within a configurable time range. Results can be filtered by resource type and deleted-by user, and support paging through the API using size, offset, and sort parameters. - Get-LMRecipientGroup - - Id + Get-LMRecentlyDeleted + + ResourceType - The ID of the specific recipient group to retrieve. + Limits results to a specific resource type. Accepted values are All, device, and deviceGroup. Defaults to All. - Int32 + String - Int32 + String - 0 + All - - BatchSize + + DeletedAfter - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The earliest deletion timestamp (inclusive) to return. Defaults to seven days prior when not specified. - Int32 + DateTime - Int32 + DateTime - 1000 + None - - ProgressAction + + DeletedBefore - {{ Fill ProgressAction Description }} + The latest deletion timestamp (exclusive) to return. Defaults to the current time when not specified. - ActionPreference + DateTime - ActionPreference + DateTime None - - - Get-LMRecipientGroup - - Name + + DeletedBy - The name of the specific recipient group to retrieve. + Limits results to items deleted by the specified user principal. String @@ -22634,10 +24705,10 @@ Get-LMPropertySource -Name "Windows-Properties" None - + BatchSize - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The number of records to request per API call (1-1000). Defaults to 1000. Int32 @@ -22646,44 +24717,17 @@ Get-LMPropertySource -Name "Windows-Properties" 1000 - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Get-LMRecipientGroup - - Filter - - A filter object to apply when retrieving recipient groups. - - Object - - Object - - - None - - - BatchSize + + Sort - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + Sort expression passed to the API. Defaults to -deletedOn. - Int32 + String - Int32 + String - 1000 + -deletedOn ProgressAction @@ -22700,46 +24744,58 @@ Get-LMPropertySource -Name "Windows-Properties" - - Id + + ResourceType - The ID of the specific recipient group to retrieve. + Limits results to a specific resource type. Accepted values are All, device, and deviceGroup. Defaults to All. - Int32 + String - Int32 + String - 0 + All - - Name + + DeletedAfter - The name of the specific recipient group to retrieve. + The earliest deletion timestamp (inclusive) to return. Defaults to seven days prior when not specified. - String + DateTime - String + DateTime None - - Filter + + DeletedBefore - A filter object to apply when retrieving recipient groups. + The latest deletion timestamp (exclusive) to return. Defaults to the current time when not specified. - Object + DateTime - Object + DateTime None - + + DeletedBy + + Limits results to items deleted by the specified user principal. + + String + + String + + + None + + BatchSize - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The number of records to request per API call (1-1000). Defaults to 1000. Int32 @@ -22748,6 +24804,18 @@ Get-LMPropertySource -Name "Windows-Properties" 1000 + + Sort + + Sort expression passed to the API. Defaults to -deletedOn. + + String + + String + + + -deletedOn + ProgressAction @@ -22761,46 +24829,26 @@ Get-LMPropertySource -Name "Windows-Properties" None - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns recipient group objects. - - - - - - + + - You must run Connect-LMAccount before running this command. + You must establish a session with Connect-LMAccount prior to calling this function. -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all recipient groups -Get-LMRecipientGroup + Get-LMRecentlyDeleted -ResourceType device -DeletedBy "lmsupport" - + Retrieves every device deleted by the user lmsupport over the past seven days. -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a specific recipient group by name -Get-LMRecipientGroup -Name "Emergency-Contacts" + Get-LMRecentlyDeleted -DeletedAfter (Get-Date).AddDays(-1) -DeletedBefore (Get-Date) -BatchSize 100 -Sort "+deletedOn" - + Retrieves deleted resources from the past 24 hours in ascending order of deletion time. @@ -22808,23 +24856,23 @@ Get-LMRecipientGroup -Name "Emergency-Contacts" - Get-LMReport + Get-LMRecipientGroup Get - LMReport + LMRecipientGroup - Retrieves reports from LogicMonitor. + Retrieves recipient groups from LogicMonitor. - The Get-LMReport function retrieves report configurations from LogicMonitor. It can retrieve all reports, a specific report by ID or name, or filter the results using either a filter object or the filter wizard. + The Get-LMRecipientGroup function retrieves recipient group configurations from LogicMonitor. It can retrieve all groups, a specific group by ID or name, or filter the results. - Get-LMReport + Get-LMRecipientGroup Id - The ID of the specific report to retrieve. + The ID of the specific recipient group to retrieve. Int32 @@ -22859,11 +24907,11 @@ Get-LMRecipientGroup -Name "Emergency-Contacts" - Get-LMReport + Get-LMRecipientGroup Name - The name of the specific report to retrieve. + The name of the specific recipient group to retrieve. String @@ -22898,11 +24946,11 @@ Get-LMRecipientGroup -Name "Emergency-Contacts" - Get-LMReport + Get-LMRecipientGroup Filter - A filter object to apply when retrieving reports. + A filter object to apply when retrieving recipient groups. Object @@ -22936,50 +24984,12 @@ Get-LMRecipientGroup -Name "Emergency-Contacts" None - - Get-LMReport - - FilterWizard - - Switch to enable the filter wizard for building a custom filter interactively. - - - SwitchParameter - - - False - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - Id - The ID of the specific report to retrieve. + The ID of the specific recipient group to retrieve. Int32 @@ -22991,7 +25001,7 @@ Get-LMRecipientGroup -Name "Emergency-Contacts" Name - The name of the specific report to retrieve. + The name of the specific recipient group to retrieve. String @@ -23003,7 +25013,7 @@ Get-LMRecipientGroup -Name "Emergency-Contacts" Filter - A filter object to apply when retrieving reports. + A filter object to apply when retrieving recipient groups. Object @@ -23012,18 +25022,6 @@ Get-LMRecipientGroup -Name "Emergency-Contacts" None - - FilterWizard - - Switch to enable the filter wizard for building a custom filter interactively. - - SwitchParameter - - SwitchParameter - - - False - BatchSize @@ -23062,7 +25060,7 @@ Get-LMRecipientGroup -Name "Emergency-Contacts" - Returns LogicMonitor.Report objects. + Returns recipient group objects. @@ -23077,16 +25075,16 @@ Get-LMRecipientGroup -Name "Emergency-Contacts" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all reports -Get-LMReport + #Retrieve all recipient groups +Get-LMRecipientGroup -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a specific report by name -Get-LMReport -Name "Monthly Usage Report" + #Retrieve a specific recipient group by name +Get-LMRecipientGroup -Name "Emergency-Contacts" @@ -23096,23 +25094,23 @@ Get-LMReport -Name "Monthly Usage Report" - Get-LMReportGroup + Get-LMReport Get - LMReportGroup + LMReport - Retrieves report groups from LogicMonitor. + Retrieves reports from LogicMonitor. - The Get-LMReportGroup function retrieves report group configurations from LogicMonitor. It can retrieve all groups, a specific group by ID or name, or filter the results using either a filter object or the filter wizard. + The Get-LMReport function retrieves report configurations from LogicMonitor. It can retrieve all reports, a specific report by ID or name, or filter the results using either a filter object or the filter wizard. - Get-LMReportGroup + Get-LMReport Id - The ID of the specific report group to retrieve. + The ID of the specific report to retrieve. Int32 @@ -23147,11 +25145,11 @@ Get-LMReport -Name "Monthly Usage Report" - Get-LMReportGroup + Get-LMReport Name - The name of the specific report group to retrieve. + The name of the specific report to retrieve. String @@ -23186,11 +25184,11 @@ Get-LMReport -Name "Monthly Usage Report" - Get-LMReportGroup + Get-LMReport Filter - A filter object to apply when retrieving report groups. + A filter object to apply when retrieving reports. Object @@ -23225,7 +25223,7 @@ Get-LMReport -Name "Monthly Usage Report" - Get-LMReportGroup + Get-LMReport FilterWizard @@ -23267,7 +25265,7 @@ Get-LMReport -Name "Monthly Usage Report" Id - The ID of the specific report group to retrieve. + The ID of the specific report to retrieve. Int32 @@ -23279,7 +25277,7 @@ Get-LMReport -Name "Monthly Usage Report" Name - The name of the specific report group to retrieve. + The name of the specific report to retrieve. String @@ -23291,7 +25289,7 @@ Get-LMReport -Name "Monthly Usage Report" Filter - A filter object to apply when retrieving report groups. + A filter object to apply when retrieving reports. Object @@ -23350,7 +25348,7 @@ Get-LMReport -Name "Monthly Usage Report" - Returns report group objects. + Returns LogicMonitor.Report objects. @@ -23365,16 +25363,16 @@ Get-LMReport -Name "Monthly Usage Report" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all report groups -Get-LMReportGroup + #Retrieve all reports +Get-LMReport -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a specific report group by name -Get-LMReportGroup -Name "Monthly Reports" + #Retrieve a specific report by name +Get-LMReport -Name "Monthly Usage Report" @@ -23384,30 +25382,81 @@ Get-LMReportGroup -Name "Monthly Reports" - Get-LMRepositoryLogicModules + Get-LMReportExecutionTask Get - LMRepositoryLogicModules + LMReportExecutionTask - Retrieves LogicModules from the LogicMonitor repository. + Retrieves the status of a LogicMonitor report execution task. - The Get-LMRepositoryLogicModules function retrieves LogicModules from the LogicMonitor repository. It supports retrieving different types of modules including datasources, property rules, event sources, topology sources, and config sources. + Get-LMReportExecutionTask fetches information about a previously triggered report execution task. Supply the report identifier (ID or name) along with the task ID returned from Invoke-LMReportExecution to check completion status or retrieve the result URL. - Get-LMRepositoryLogicModules - - Type + Get-LMReportExecutionTask + + ReportId - The type of LogicModule to retrieve. Valid values are "datasource", "propertyrules", "eventsource", "topologysource", "configsource". Defaults to "datasource". + The ID of the report whose execution task should be retrieved. + + Int32 + + Int32 + + + 0 + + + TaskId + + The execution task identifier returned when the report was triggered. String String - Datasource + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMReportExecutionTask + + ReportName + + The name of the report whose execution task should be retrieved. + + String + + String + + + None + + + TaskId + + The execution task identifier returned when the report was triggered. + + String + + String + + + None ProgressAction @@ -23424,17 +25473,41 @@ Get-LMReportGroup -Name "Monthly Reports" - - Type + + ReportId - The type of LogicModule to retrieve. Valid values are "datasource", "propertyrules", "eventsource", "topologysource", "configsource". Defaults to "datasource". + The ID of the report whose execution task should be retrieved. + + Int32 + + Int32 + + + 0 + + + ReportName + + The name of the report whose execution task should be retrieved. String String - Datasource + None + + + TaskId + + The execution task identifier returned when the report was triggered. + + String + + String + + + None ProgressAction @@ -23449,26 +25522,8 @@ Get-LMReportGroup -Name "Monthly Reports" None - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor.RepositoryLogicModules objects. - - - - - - + + You must run Connect-LMAccount before running this command. @@ -23477,18 +25532,17 @@ Get-LMReportGroup -Name "Monthly Reports" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all datasource modules -Get-LMRepositoryLogicModules + Invoke-LMReportExecution -Id 42 | Select-Object -ExpandProperty taskId | Get-LMReportExecutionTask -ReportId 42 - + Gets the execution status for the specified report/task combination. -------------------------- EXAMPLE 2 -------------------------- - #Retrieve all event source modules -Get-LMRepositoryLogicModules -Type "eventsource" + $task = Invoke-LMReportExecution -Name "Monthly Availability" +Get-LMReportExecutionTask -ReportName "Monthly Availability" -TaskId $task.taskId - + Checks the task status for the report by name. @@ -23496,23 +25550,23 @@ Get-LMRepositoryLogicModules -Type "eventsource" - Get-LMRole + Get-LMReportGroup Get - LMRole + LMReportGroup - Retrieves roles from LogicMonitor. + Retrieves report groups from LogicMonitor. - The Get-LMRole function retrieves role configurations from LogicMonitor. It can retrieve all roles, a specific role by ID or name, or filter the results. + The Get-LMReportGroup function retrieves report group configurations from LogicMonitor. It can retrieve all groups, a specific group by ID or name, or filter the results using either a filter object or the filter wizard. - Get-LMRole + Get-LMReportGroup Id - The ID of the specific role to retrieve. + The ID of the specific report group to retrieve. Int32 @@ -23547,11 +25601,11 @@ Get-LMRepositoryLogicModules -Type "eventsource" - Get-LMRole + Get-LMReportGroup Name - The name of the specific role to retrieve. + The name of the specific report group to retrieve. String @@ -23586,11 +25640,11 @@ Get-LMRepositoryLogicModules -Type "eventsource" - Get-LMRole + Get-LMReportGroup Filter - A filter object to apply when retrieving roles. + A filter object to apply when retrieving report groups. Object @@ -23624,12 +25678,50 @@ Get-LMRepositoryLogicModules -Type "eventsource" None + + Get-LMReportGroup + + FilterWizard + + Switch to enable the filter wizard for building a custom filter interactively. + + + SwitchParameter + + + False + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + Id - The ID of the specific role to retrieve. + The ID of the specific report group to retrieve. Int32 @@ -23641,7 +25733,7 @@ Get-LMRepositoryLogicModules -Type "eventsource" Name - The name of the specific role to retrieve. + The name of the specific report group to retrieve. String @@ -23653,7 +25745,7 @@ Get-LMRepositoryLogicModules -Type "eventsource" Filter - A filter object to apply when retrieving roles. + A filter object to apply when retrieving report groups. Object @@ -23662,6 +25754,18 @@ Get-LMRepositoryLogicModules -Type "eventsource" None + + FilterWizard + + Switch to enable the filter wizard for building a custom filter interactively. + + SwitchParameter + + SwitchParameter + + + False + BatchSize @@ -23700,7 +25804,7 @@ Get-LMRepositoryLogicModules -Type "eventsource" - Returns LogicMonitor.Role objects. + Returns report group objects. @@ -23715,16 +25819,16 @@ Get-LMRepositoryLogicModules -Type "eventsource" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all roles -Get-LMRole + #Retrieve all report groups +Get-LMReportGroup -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a specific role by name -Get-LMRole -Name "Administrator" + #Retrieve a specific report group by name +Get-LMReportGroup -Name "Monthly Reports" @@ -23734,31 +25838,143 @@ Get-LMRole -Name "Administrator" - Get-LMSDT + Get-LMRepositoryLogicModule Get - LMSDT + LMRepositoryLogicModule - Retrieves Scheduled Down Time (SDT) entries from LogicMonitor. + Retrieves LogicModules from the LogicMonitor repository. - The Get-LMSDT function retrieves SDT entries from LogicMonitor. It can retrieve all SDT entries, a specific entry by ID or name, or filter the results. + The Get-LMRepositoryLogicModule function retrieves LogicModules from the LogicMonitor repository. It supports retrieving different types of modules including datasources, property rules, event sources, topology sources, and config sources. - Get-LMSDT - - Id + Get-LMRepositoryLogicModule + + Type - The ID of the specific SDT entry to retrieve. + The type of LogicModule to retrieve. Valid values are "datasource", "propertyrules", "eventsource", "topologysource", "configsource". Defaults to "datasource". String String + Datasource + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + None + + + + + Type + + The type of LogicModule to retrieve. Valid values are "datasource", "propertyrules", "eventsource", "topologysource", "configsource". Defaults to "datasource". + + String + + String + + + Datasource + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.RepositoryLogicModules objects. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Retrieve all datasource modules +Get-LMRepositoryLogicModule + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve all event source modules +Get-LMRepositoryLogicModule -Type "eventsource" + + + + + + + + + + Get-LMRole + Get + LMRole + + Retrieves roles from LogicMonitor. + + + + The Get-LMRole function retrieves role configurations from LogicMonitor. It can retrieve all roles, a specific role by ID or name, or filter the results. + + + + Get-LMRole + + Id + + The ID of the specific role to retrieve. + + Int32 + + Int32 + + + 0 + BatchSize @@ -23785,11 +26001,11 @@ Get-LMRole -Name "Administrator" - Get-LMSDT + Get-LMRole Name - The name of the specific SDT entry to retrieve. + The name of the specific role to retrieve. String @@ -23824,11 +26040,11 @@ Get-LMRole -Name "Administrator" - Get-LMSDT + Get-LMRole Filter - A filter object to apply when retrieving SDT entries. + A filter object to apply when retrieving roles. Object @@ -23867,19 +26083,19 @@ Get-LMRole -Name "Administrator" Id - The ID of the specific SDT entry to retrieve. + The ID of the specific role to retrieve. - String + Int32 - String + Int32 - None + 0 Name - The name of the specific SDT entry to retrieve. + The name of the specific role to retrieve. String @@ -23891,7 +26107,7 @@ Get-LMRole -Name "Administrator" Filter - A filter object to apply when retrieving SDT entries. + A filter object to apply when retrieving roles. Object @@ -23938,7 +26154,7 @@ Get-LMRole -Name "Administrator" - Returns LogicMonitor.SDT objects. + Returns LogicMonitor.Role objects. @@ -23953,16 +26169,16 @@ Get-LMRole -Name "Administrator" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all SDT entries -Get-LMSDT + #Retrieve all roles +Get-LMRole -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a specific SDT entry by name -Get-LMSDT -Name "Maintenance Window" + #Retrieve a specific role by name +Get-LMRole -Name "Administrator" @@ -23972,35 +26188,35 @@ Get-LMSDT -Name "Maintenance Window" - Get-LMSysOIDMap + Get-LMSDT Get - LMSysOIDMap + LMSDT - Gets LogicMonitor system OID mappings. + Retrieves Scheduled Down Time (SDT) entries from LogicMonitor. - The Get-LMSysOIDMap function retrieves system OID mappings from LogicMonitor. It can retrieve all mappings, a specific mapping by ID or name, or filter the results. + The Get-LMSDT function retrieves SDT entries from LogicMonitor. It can retrieve all SDT entries, a specific entry by ID or name, or filter the results. - Get-LMSysOIDMap + Get-LMSDT Id - Specifies the ID of a specific OID mapping to retrieve. + The ID of the specific SDT entry to retrieve. - Int32 + String - Int32 + String - 0 + None BatchSize - Specifies the number of records to retrieve per API request. Valid values are 1-1000. Default is 1000. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. Int32 @@ -24023,11 +26239,11 @@ Get-LMSDT -Name "Maintenance Window" - Get-LMSysOIDMap + Get-LMSDT Name - Specifies the name of a specific OID mapping to retrieve. + The name of the specific SDT entry to retrieve. String @@ -24039,7 +26255,7 @@ Get-LMSDT -Name "Maintenance Window" BatchSize - Specifies the number of records to retrieve per API request. Valid values are 1-1000. Default is 1000. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. Int32 @@ -24062,11 +26278,11 @@ Get-LMSDT -Name "Maintenance Window" - Get-LMSysOIDMap + Get-LMSDT Filter - Specifies a filter to apply to the results. + A filter object to apply when retrieving SDT entries. Object @@ -24078,7 +26294,7 @@ Get-LMSDT -Name "Maintenance Window" BatchSize - Specifies the number of records to retrieve per API request. Valid values are 1-1000. Default is 1000. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. Int32 @@ -24105,19 +26321,19 @@ Get-LMSDT -Name "Maintenance Window" Id - Specifies the ID of a specific OID mapping to retrieve. + The ID of the specific SDT entry to retrieve. - Int32 + String - Int32 + String - 0 + None Name - Specifies the name of a specific OID mapping to retrieve. + The name of the specific SDT entry to retrieve. String @@ -24129,7 +26345,7 @@ Get-LMSDT -Name "Maintenance Window" Filter - Specifies a filter to apply to the results. + A filter object to apply when retrieving SDT entries. Object @@ -24141,7 +26357,7 @@ Get-LMSDT -Name "Maintenance Window" BatchSize - Specifies the number of records to retrieve per API request. Valid values are 1-1000. Default is 1000. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. Int32 @@ -24176,7 +26392,7 @@ Get-LMSDT -Name "Maintenance Window" - Returns LogicMonitor.SysOIDMap objects. + Returns LogicMonitor.SDT objects. @@ -24191,16 +26407,16 @@ Get-LMSDT -Name "Maintenance Window" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all system OID mappings -Get-LMSysOIDMap + #Retrieve all SDT entries +Get-LMSDT -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a specific OID mapping by name -Get-LMSysOIDMap -Name "\.1\.3\.6\.1\.4\.1\.318\.1\.1\.32" + #Retrieve a specific SDT entry by name +Get-LMSDT -Name "Maintenance Window" @@ -24210,23 +26426,23 @@ Get-LMSysOIDMap -Name "\.1\.3\.6\.1\.4\.1\.318\.1\.1\.32" - Get-LMTopologyMap + Get-LMService Get - LMTopologyMap + LMService - Retrieves topology maps from LogicMonitor. + Retrieves service information from LogicMonitor. - The Get-LMTopologyMap function retrieves topology map configurations from LogicMonitor. It can retrieve all maps, a specific map by ID or name, or filter the results. + The Get-LMService function retrieves service information from LogicMonitor based on specified parameters. It can return a single service by ID or multiple services based on name, display name, filter, or filter wizard. It also supports delta tracking for monitoring changes. - Get-LMTopologyMap + Get-LMService Id - The ID of the specific topology map to retrieve. + The ID of the service to retrieve. Part of a mutually exclusive parameter set. Int32 @@ -24261,11 +26477,61 @@ Get-LMSysOIDMap -Name "\.1\.3\.6\.1\.4\.1\.318\.1\.1\.32" - Get-LMTopologyMap + Get-LMService + + DisplayName + + The display name of the service to retrieve. Part of a mutually exclusive parameter set. + + String + + String + + + None + + + Delta + + Switch to return a deltaId along with the requested data for change tracking. + + + SwitchParameter + + + False + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMService Name - The name of the specific topology map to retrieve. + The name of the service to retrieve. Part of a mutually exclusive parameter set. String @@ -24274,6 +26540,17 @@ Get-LMSysOIDMap -Name "\.1\.3\.6\.1\.4\.1\.318\.1\.1\.32" None + + Delta + + Switch to return a deltaId along with the requested data for change tracking. + + + SwitchParameter + + + False + BatchSize @@ -24300,11 +26577,11 @@ Get-LMSysOIDMap -Name "\.1\.3\.6\.1\.4\.1\.318\.1\.1\.32" - Get-LMTopologyMap + Get-LMService Filter - A filter object to apply when retrieving topology maps. + A filter object to apply when retrieving services. Part of a mutually exclusive parameter set. Object @@ -24313,6 +26590,17 @@ Get-LMSysOIDMap -Name "\.1\.3\.6\.1\.4\.1\.318\.1\.1\.32" None + + Delta + + Switch to return a deltaId along with the requested data for change tracking. + + + SwitchParameter + + + False + BatchSize @@ -24338,140 +26626,41 @@ Get-LMSysOIDMap -Name "\.1\.3\.6\.1\.4\.1\.318\.1\.1\.32" None - - - - Id - - The ID of the specific topology map to retrieve. - - Int32 - - Int32 - - - 0 - - - Name - - The name of the specific topology map to retrieve. - - String - - String - - - None - - - Filter - - A filter object to apply when retrieving topology maps. - - Object - - Object - - - None - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor.TopologyMap objects. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all topology maps -Get-LMTopologyMap - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a specific topology map by name -Get-LMTopologyMap -Name "Network-Topology" - - - - - - - - - - Get-LMTopologyMapData - Get - LMTopologyMapData - - Retrieves data for a specific topology map from LogicMonitor. - - - - The Get-LMTopologyMapData function retrieves the vertex and edge data for a specified topology map in LogicMonitor. The map can be identified by either ID or name. - - - Get-LMTopologyMapData - - Id + Get-LMService + + FilterWizard - The ID of the topology map to retrieve data from. Required for Id parameter set. + Switch to use the filter wizard interface for building the filter. Part of a mutually exclusive parameter set. + + + SwitchParameter + + + False + + + Delta + + Switch to return a deltaId along with the requested data for change tracking. + + + SwitchParameter + + + False + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. Int32 Int32 - 0 + 1000 ProgressAction @@ -24487,11 +26676,49 @@ Get-LMTopologyMap -Name "Network-Topology" - Get-LMTopologyMapData - - Name + Get-LMService + + Delta - The name of the topology map to retrieve data from. Required for Name parameter set. + Switch to return a deltaId along with the requested data for change tracking. + + + SwitchParameter + + + False + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMService + + DeltaId + + The deltaId string for retrieving changes since a previous query. String @@ -24500,6 +26727,18 @@ Get-LMTopologyMap -Name "Network-Topology" None + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + ProgressAction @@ -24515,10 +26754,10 @@ Get-LMTopologyMap -Name "Network-Topology" - + Id - The ID of the topology map to retrieve data from. Required for Id parameter set. + The ID of the service to retrieve. Part of a mutually exclusive parameter set. Int32 @@ -24527,10 +26766,70 @@ Get-LMTopologyMap -Name "Network-Topology" 0 - + + DisplayName + + The display name of the service to retrieve. Part of a mutually exclusive parameter set. + + String + + String + + + None + + Name - The name of the topology map to retrieve data from. Required for Name parameter set. + The name of the service to retrieve. Part of a mutually exclusive parameter set. + + String + + String + + + None + + + Filter + + A filter object to apply when retrieving services. Part of a mutually exclusive parameter set. + + Object + + Object + + + None + + + FilterWizard + + Switch to use the filter wizard interface for building the filter. Part of a mutually exclusive parameter set. + + SwitchParameter + + SwitchParameter + + + False + + + Delta + + Switch to return a deltaId along with the requested data for change tracking. + + SwitchParameter + + SwitchParameter + + + False + + + DeltaId + + The deltaId string for retrieving changes since a previous query. String @@ -24539,6 +26838,18 @@ Get-LMTopologyMap -Name "Network-Topology" None + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + ProgressAction @@ -24565,7 +26876,7 @@ Get-LMTopologyMap -Name "Network-Topology" - Returns LogicMonitor.TopologyMapData objects. + Returns LogicMonitor.Service objects. @@ -24580,16 +26891,16 @@ Get-LMTopologyMap -Name "Network-Topology" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve topology map data by ID -Get-LMTopologyMapData -Id 123 + #Retrieve a service by ID +Get-LMService -Id 123 -------------------------- EXAMPLE 2 -------------------------- - #Retrieve topology map data by name -Get-LMTopologyMapData -Name "Network-Topology" + #Retrieve services with delta tracking +Get-LMService -Delta @@ -24599,23 +26910,23 @@ Get-LMTopologyMapData -Name "Network-Topology" - Get-LMTopologySource + Get-LMServiceMember Get - LMTopologySource + LMServiceMember - Retrieves topology sources from LogicMonitor. + Retrieves service member information from LogicMonitor. - The Get-LMTopologySource function retrieves topology source configurations from LogicMonitor. It can retrieve all sources, a specific source by ID or name, or filter the results. + The Get-LMServiceMember function retrieves service member information from LogicMonitor based on specified parameters. It can return a single service member by ID or multiple service members based on name, display name, filter, or filter wizard. It also supports delta tracking for monitoring changes. - Get-LMTopologySource - + Get-LMServiceMember + Id - The ID of the specific topology source to retrieve. + The ID of the service to retrieve members from. Part of a mutually exclusive parameter set. Int32 @@ -24650,11 +26961,11 @@ Get-LMTopologyMapData -Name "Network-Topology" - Get-LMTopologySource - - Name + Get-LMServiceMember + + DisplayName - The name of the specific topology source to retrieve. + The display name of the service to retrieve members from. Part of a mutually exclusive parameter set. String @@ -24689,15 +27000,15 @@ Get-LMTopologyMapData -Name "Network-Topology" - Get-LMTopologySource - - Filter + Get-LMServiceMember + + Name - A filter object to apply when retrieving topology sources. + The name of the service to retrieve members from. Part of a mutually exclusive parameter set. - Object + String - Object + String None @@ -24729,10 +27040,10 @@ Get-LMTopologyMapData -Name "Network-Topology" - + Id - The ID of the specific topology source to retrieve. + The ID of the service to retrieve members from. Part of a mutually exclusive parameter set. Int32 @@ -24741,10 +27052,10 @@ Get-LMTopologyMapData -Name "Network-Topology" 0 - - Name + + DisplayName - The name of the specific topology source to retrieve. + The display name of the service to retrieve members from. Part of a mutually exclusive parameter set. String @@ -24753,14 +27064,14 @@ Get-LMTopologyMapData -Name "Network-Topology" None - - Filter + + Name - A filter object to apply when retrieving topology sources. + The name of the service to retrieve members from. Part of a mutually exclusive parameter set. - Object + String - Object + String None @@ -24793,7 +27104,7 @@ Get-LMTopologyMapData -Name "Network-Topology" - None. You cannot pipe objects to this command. + None. You can pipe LogicMonitor.Device objects to this command. @@ -24803,7 +27114,7 @@ Get-LMTopologyMapData -Name "Network-Topology" - Returns LogicMonitor.Topologysource objects. + Returns LogicMonitor.ServiceMember objects. @@ -24818,16 +27129,8 @@ Get-LMTopologyMapData -Name "Network-Topology" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all topology sources -Get-LMTopologySource - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a specific topology source by name -Get-LMTopologySource -Name "Network-Discovery" + #Retrieve a service member by ID +Get-LMServiceMember -Id 123 @@ -24837,51 +27140,27 @@ Get-LMTopologySource -Name "Network-Discovery" - Get-LMUnmonitoredDevice + Get-LMServiceTemplate Get - LMUnmonitoredDevice + LMServiceTemplate - Retrieves unmonitored devices from LogicMonitor. + Retrieves service template information from LogicMonitor. - The Get-LMUnmonitoredDevice function retrieves information about devices that are discovered but not currently being monitored in LogicMonitor. + The Get-LMServiceTemplate function retrieves service templates from LogicMonitor. This function only supports the v4 API. - Get-LMUnmonitoredDevice - - Filter + Get-LMServiceTemplate + + ProgressAction - A filter object to apply when retrieving unmonitored devices. + {{ Fill ProgressAction Description }} - Object + ActionPreference - Object - - - None - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference + ActionPreference None @@ -24889,30 +27168,6 @@ Get-LMTopologySource -Name "Network-Discovery" - - Filter - - A filter object to apply when retrieving unmonitored devices. - - Object - - Object - - - None - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - ProgressAction @@ -24939,7 +27194,7 @@ Get-LMTopologySource -Name "Network-Discovery" - Returns LogicMonitor.UnmonitoredDevice objects. + Returns LogicMonitor.ServiceTemplate objects. @@ -24948,22 +27203,14 @@ Get-LMTopologySource -Name "Network-Discovery" - You must run Connect-LMAccount before running this command. + You must run Connect-LMAccount before running this command. This command is reserved for internal use only. -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all unmonitored devices -Get-LMUnmonitoredDevice - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Retrieve unmonitored devices using a filter -Get-LMUnmonitoredDevice -Filter $filterObject + #Retrieve all service templates +Get-LMServiceTemplate @@ -24973,102 +27220,23 @@ Get-LMUnmonitoredDevice -Filter $filterObject - Get-LMUsageMetrics - Get - LMUsageMetrics - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-LMUsageMetrics - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-LMUser + Get-LMSysOIDMap Get - LMUser + LMSysOIDMap - Retrieves LogicMonitor users based on specified parameters. + Gets LogicMonitor system OID mappings. - The Get-LMUser function retrieves LogicMonitor users based on the specified parameters. It supports filtering by ID, username, or custom filter. The function uses the LogicMonitor REST API to make the requests. + The Get-LMSysOIDMap function retrieves system OID mappings from LogicMonitor. It can retrieve all mappings, a specific mapping by ID or name, or filter the results. - Get-LMUser + Get-LMSysOIDMap Id - Specifies the ID of the user to retrieve. This parameter is mutually exclusive with the Name and Filter parameters. + Specifies the ID of a specific OID mapping to retrieve. Int32 @@ -25080,7 +27248,7 @@ Get-LMUnmonitoredDevice -Filter $filterObject BatchSize - Specifies the number of users to retrieve in each batch. The default value is 1000. + Specifies the number of records to retrieve per API request. Valid values are 1-1000. Default is 1000. Int32 @@ -25103,11 +27271,11 @@ Get-LMUnmonitoredDevice -Filter $filterObject - Get-LMUser + Get-LMSysOIDMap Name - Specifies the username of the user to retrieve. This parameter is mutually exclusive with the Id and Filter parameters. + Specifies the name of a specific OID mapping to retrieve. String @@ -25119,7 +27287,7 @@ Get-LMUnmonitoredDevice -Filter $filterObject BatchSize - Specifies the number of users to retrieve in each batch. The default value is 1000. + Specifies the number of records to retrieve per API request. Valid values are 1-1000. Default is 1000. Int32 @@ -25142,11 +27310,11 @@ Get-LMUnmonitoredDevice -Filter $filterObject - Get-LMUser + Get-LMSysOIDMap Filter - Specifies a custom filter to retrieve users based on specific criteria. This parameter is mutually exclusive with the Id and Name parameters. + Specifies a filter to apply to the results. Object @@ -25158,45 +27326,7 @@ Get-LMUnmonitoredDevice -Filter $filterObject BatchSize - Specifies the number of users to retrieve in each batch. The default value is 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Get-LMUser - - FilterWizard - - Specifies the use of the FilterWizard to assist in building a valid filter. This parameter is mutually exclusive with the Id, Name, and Filter parameters. - - - SwitchParameter - - - False - - - BatchSize - - Specifies the number of users to retrieve in each batch. The default value is 1000. + Specifies the number of records to retrieve per API request. Valid values are 1-1000. Default is 1000. Int32 @@ -25223,7 +27353,7 @@ Get-LMUnmonitoredDevice -Filter $filterObject Id - Specifies the ID of the user to retrieve. This parameter is mutually exclusive with the Name and Filter parameters. + Specifies the ID of a specific OID mapping to retrieve. Int32 @@ -25235,7 +27365,7 @@ Get-LMUnmonitoredDevice -Filter $filterObject Name - Specifies the username of the user to retrieve. This parameter is mutually exclusive with the Id and Filter parameters. + Specifies the name of a specific OID mapping to retrieve. String @@ -25247,7 +27377,7 @@ Get-LMUnmonitoredDevice -Filter $filterObject Filter - Specifies a custom filter to retrieve users based on specific criteria. This parameter is mutually exclusive with the Id and Name parameters. + Specifies a filter to apply to the results. Object @@ -25256,22 +27386,10 @@ Get-LMUnmonitoredDevice -Filter $filterObject None - - FilterWizard - - Specifies the use of the FilterWizard to assist in building a valid filter. This parameter is mutually exclusive with the Id, Name, and Filter parameters. - - SwitchParameter - - SwitchParameter - - - False - BatchSize - Specifies the number of users to retrieve in each batch. The default value is 1000. + Specifies the number of records to retrieve per API request. Valid values are 1-1000. Default is 1000. Int32 @@ -25293,34 +27411,44 @@ Get-LMUnmonitoredDevice -Filter $filterObject None - - + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.SysOIDMap objects. + + + + + + - This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command. + You must run Connect-LMAccount before running this command. -------------------------- EXAMPLE 1 -------------------------- - Get-LMUser -Id 123 -Retrieves the user with the specified ID. + #Retrieve all system OID mappings +Get-LMSysOIDMap -------------------------- EXAMPLE 2 -------------------------- - Get-LMUser -Name "username" -Retrieves the user with the specified username. - - - - - - -------------------------- EXAMPLE 3 -------------------------- - Get-LMUser -Filter @{Property = "Value"} -Retrieves users based on the specified custom filter. + #Retrieve a specific OID mapping by name +Get-LMSysOIDMap -Name "\.1\.3\.6\.1\.4\.1\.318\.1\.1\.32" @@ -25330,23 +27458,23 @@ Retrieves users based on the specified custom filter. - Get-LMUserGroup + Get-LMTopologyMap Get - LMUserGroup + LMTopologyMap - Retrieves user group information from LogicMonitor. + Retrieves topology maps from LogicMonitor. - The Get-LMUserGroup function retrieves user group information from LogicMonitor based on specified parameters. It can return a single user group by ID or multiple groups based on name, filter, or filter wizard. + The Get-LMTopologyMap function retrieves topology map configurations from LogicMonitor. It can retrieve all maps, a specific map by ID or name, or filter the results. - Get-LMUserGroup + Get-LMTopologyMap Id - The ID of the user group to retrieve. This parameter is mandatory when using the Id parameter set. + The ID of the specific topology map to retrieve. Int32 @@ -25358,7 +27486,7 @@ Retrieves users based on the specified custom filter. BatchSize - The number of results to return per request. Must be between 1 and 1000. Default is 1000. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. Int32 @@ -25381,11 +27509,11 @@ Retrieves users based on the specified custom filter. - Get-LMUserGroup + Get-LMTopologyMap Name - The name of the user group to retrieve. This parameter is mandatory when using the Name parameter set. + The name of the specific topology map to retrieve. String @@ -25397,7 +27525,7 @@ Retrieves users based on the specified custom filter. BatchSize - The number of results to return per request. Must be between 1 and 1000. Default is 1000. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. Int32 @@ -25420,11 +27548,11 @@ Retrieves users based on the specified custom filter. - Get-LMUserGroup + Get-LMTopologyMap Filter - A filter object to apply when retrieving user groups. This parameter is mandatory when using the Filter parameter set. + A filter object to apply when retrieving topology maps. Object @@ -25436,45 +27564,7 @@ Retrieves users based on the specified custom filter. BatchSize - The number of results to return per request. Must be between 1 and 1000. Default is 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Get-LMUserGroup - - FilterWizard - - A switch parameter to enable the filter wizard interface. This parameter is mandatory when using the FilterWizard parameter set. - - - SwitchParameter - - - False - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Default is 1000. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. Int32 @@ -25501,7 +27591,7 @@ Retrieves users based on the specified custom filter. Id - The ID of the user group to retrieve. This parameter is mandatory when using the Id parameter set. + The ID of the specific topology map to retrieve. Int32 @@ -25513,7 +27603,7 @@ Retrieves users based on the specified custom filter. Name - The name of the user group to retrieve. This parameter is mandatory when using the Name parameter set. + The name of the specific topology map to retrieve. String @@ -25525,7 +27615,7 @@ Retrieves users based on the specified custom filter. Filter - A filter object to apply when retrieving user groups. This parameter is mandatory when using the Filter parameter set. + A filter object to apply when retrieving topology maps. Object @@ -25534,22 +27624,10 @@ Retrieves users based on the specified custom filter. None - - FilterWizard - - A switch parameter to enable the filter wizard interface. This parameter is mandatory when using the FilterWizard parameter set. - - SwitchParameter - - SwitchParameter - - - False - BatchSize - The number of results to return per request. Must be between 1 and 1000. Default is 1000. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. Int32 @@ -25581,7 +27659,16 @@ Retrieves users based on the specified custom filter. - + + + + Returns LogicMonitor.TopologyMap objects. + + + + + + You must run Connect-LMAccount before running this command. @@ -25590,24 +27677,16 @@ Retrieves users based on the specified custom filter. -------------------------- EXAMPLE 1 -------------------------- - #Retrieve a user group by ID -Get-LMUserGroup -Id 1234 + #Retrieve all topology maps +Get-LMTopologyMap -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a user group by name -Get-LMUserGroup -Name "Administrators" - - - - - - -------------------------- EXAMPLE 3 -------------------------- - #Retrieve user groups using a filter -Get-LMUserGroup -Filter $filterObject + #Retrieve a specific topology map by name +Get-LMTopologyMap -Name "Network-Topology" @@ -25617,23 +27696,23 @@ Get-LMUserGroup -Filter $filterObject - Get-LMWebsite + Get-LMTopologyMapData Get - LMWebsite + LMTopologyMapData - Retrieves website monitoring information from LogicMonitor. + Retrieves data for a specific topology map from LogicMonitor. - The Get-LMWebsite function retrieves website monitoring configurations from LogicMonitor. It can retrieve all websites, a specific website by ID or name, filter by type, or use custom filters. + The Get-LMTopologyMapData function retrieves the vertex and edge data for a specified topology map in LogicMonitor. The map can be identified by either ID or name. - Get-LMWebsite - + Get-LMTopologyMapData + Id - The ID of the specific website to retrieve. + The ID of the topology map to retrieve data from. Required for Id parameter set. Int32 @@ -25642,17 +27721,32 @@ Get-LMUserGroup -Filter $filterObject 0 - - BatchSize + + ProgressAction - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference - 1000 + None + + + + Get-LMTopologyMapData + + Name + + The name of the topology map to retrieve data from. Required for Name parameter set. + + String + + String + + + None ProgressAction @@ -25667,19 +27761,116 @@ Get-LMUserGroup -Filter $filterObject None + + + + Id + + The ID of the topology map to retrieve data from. Required for Id parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the topology map to retrieve data from. Required for Name parameter set. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.TopologyMapData objects. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Retrieve topology map data by ID +Get-LMTopologyMapData -Id 123 + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve topology map data by name +Get-LMTopologyMapData -Name "Network-Topology" + + + + + + + + + + Get-LMTopologySource + Get + LMTopologySource + + Retrieves topology sources from LogicMonitor. + + + + The Get-LMTopologySource function retrieves topology source configurations from LogicMonitor. It can retrieve all sources, a specific source by ID or name, or filter the results. + + - Get-LMWebsite + Get-LMTopologySource - Name + Id - The name of the specific website to retrieve. + The ID of the specific topology source to retrieve. - String + Int32 - String + Int32 - None + 0 BatchSize @@ -25707,11 +27898,11 @@ Get-LMUserGroup -Filter $filterObject - Get-LMWebsite + Get-LMTopologySource - Type + Name - The type of website to filter by. Valid values are "Webcheck" or "PingCheck". + The name of the specific topology source to retrieve. String @@ -25746,11 +27937,11 @@ Get-LMUserGroup -Filter $filterObject - Get-LMWebsite + Get-LMTopologySource Filter - A filter object to apply when retrieving websites. + A filter object to apply when retrieving topology sources. Object @@ -25784,50 +27975,12 @@ Get-LMUserGroup -Filter $filterObject None - - Get-LMWebsite - - FilterWizard - - Switch to enable the filter wizard for building a custom filter interactively. - - - SwitchParameter - - - False - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - Id - The ID of the specific website to retrieve. + The ID of the specific topology source to retrieve. Int32 @@ -25839,19 +27992,7 @@ Get-LMUserGroup -Filter $filterObject Name - The name of the specific website to retrieve. - - String - - String - - - None - - - Type - - The type of website to filter by. Valid values are "Webcheck" or "PingCheck". + The name of the specific topology source to retrieve. String @@ -25863,7 +28004,7 @@ Get-LMUserGroup -Filter $filterObject Filter - A filter object to apply when retrieving websites. + A filter object to apply when retrieving topology sources. Object @@ -25872,18 +28013,6 @@ Get-LMUserGroup -Filter $filterObject None - - FilterWizard - - Switch to enable the filter wizard for building a custom filter interactively. - - SwitchParameter - - SwitchParameter - - - False - BatchSize @@ -25922,7 +28051,7 @@ Get-LMUserGroup -Filter $filterObject - Returns LogicMonitor.Website objects. + Returns LogicMonitor.Topologysource objects. @@ -25937,16 +28066,16 @@ Get-LMUserGroup -Filter $filterObject -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all websites -Get-LMWebsite + #Retrieve all topology sources +Get-LMTopologySource -------------------------- EXAMPLE 2 -------------------------- - #Retrieve websites of a specific type -Get-LMWebsite -Type "Webcheck" + #Retrieve a specific topology source by name +Get-LMTopologySource -Name "Network-Discovery" @@ -25956,86 +28085,23 @@ Get-LMWebsite -Type "Webcheck" - Get-LMWebsiteAlerts + Get-LMUnmonitoredDevice Get - LMWebsiteAlerts + LMUnmonitoredDevice - Retrieves alerts for a specific website from LogicMonitor. + Retrieves unmonitored devices from LogicMonitor. - The Get-LMWebsiteAlerts function retrieves alert information for a specified website in LogicMonitor. The website can be identified by either ID or name. + The Get-LMUnmonitoredDevice function retrieves information about devices that are discovered but not currently being monitored in LogicMonitor. - Get-LMWebsiteAlerts - - Id - - The ID of the website to retrieve alerts from. Required for Id parameter set. - - Int32 - - Int32 - - - 0 - - - Filter - - A filter object to apply when retrieving alerts. - - Object - - Object - - - None - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Get-LMWebsiteAlerts - - Name - - The name of the website to retrieve alerts from. Required for Name parameter set. - - String - - String - - - None - - + Get-LMUnmonitoredDevice + Filter - A filter object to apply when retrieving alerts. + A filter object to apply when retrieving unmonitored devices. Object @@ -26044,7 +28110,7 @@ Get-LMWebsite -Type "Webcheck" None - + BatchSize The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. @@ -26071,34 +28137,10 @@ Get-LMWebsite -Type "Webcheck" - - Id - - The ID of the website to retrieve alerts from. Required for Id parameter set. - - Int32 - - Int32 - - - 0 - - - Name - - The name of the website to retrieve alerts from. Required for Name parameter set. - - String - - String - - - None - - + Filter - A filter object to apply when retrieving alerts. + A filter object to apply when retrieving unmonitored devices. Object @@ -26107,7 +28149,7 @@ Get-LMWebsite -Type "Webcheck" None - + BatchSize The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. @@ -26145,7 +28187,7 @@ Get-LMWebsite -Type "Webcheck" - Returns website alert objects. + Returns LogicMonitor.UnmonitoredDevice objects. @@ -26160,16 +28202,16 @@ Get-LMWebsite -Type "Webcheck" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve alerts by website ID -Get-LMWebsiteAlerts -Id 123 + #Retrieve all unmonitored devices +Get-LMUnmonitoredDevice -------------------------- EXAMPLE 2 -------------------------- - #Retrieve alerts for a specific website -Get-LMWebsiteAlerts -Name "www.example.com" + #Retrieve unmonitored devices using a filter +Get-LMUnmonitoredDevice -Filter $filterObject @@ -26179,35 +28221,35 @@ Get-LMWebsiteAlerts -Name "www.example.com" - Get-LMWebsiteCheckpoint + Get-LMUptimeDevice Get - LMWebsiteCheckpoint + LMUptimeDevice - Retrieves website checkpoints from LogicMonitor. + Retrieves LogicMonitor Uptime devices from the v3 device endpoint. - The Get-LMWebsiteCheckpoint function retrieves checkpoint configurations used for website monitoring in LogicMonitor. + The Get-LMUptimeDevice cmdlet returns Uptime monitors (web or ping) that are backed by the LogicMonitor v3 /device/devices endpoint. It supports lookup by ID or name, optional filtering by type or internal/external flag, custom filters, and the interactive filter wizard. All requests automatically enforce the Uptime model so only websiteDevice resources are returned. - Get-LMWebsiteCheckpoint + Get-LMUptimeDevice - Filter + Id - A filter object to apply when retrieving checkpoints. + Specifies the identifier of the Uptime device to retrieve. - Object + Int32 - Object + Int32 - None + 0 BatchSize - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + Controls the number of results returned per request. Must be between 1 and 1000. Default 1000. Int32 @@ -26229,152 +28271,82 @@ Get-LMWebsiteAlerts -Name "www.example.com" None - - - - Filter - - A filter object to apply when retrieving checkpoints. - - Object - - Object - - - None - - - BatchSize - - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - - Int32 - - Int32 - - - 1000 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns website checkpoint objects. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Retrieve all website checkpoints -Get-LMWebsiteCheckpoint - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Retrieve checkpoints using a filter -Get-LMWebsiteCheckpoint -Filter $filterObject - - - - - - - - - - Get-LMWebsiteData - Get - LMWebsiteData - - Retrieves monitoring data for a specific website from LogicMonitor. - - - - The Get-LMWebsiteData function retrieves monitoring data for a specified website and checkpoint in LogicMonitor. The website can be identified by either ID or name. - - - Get-LMWebsiteData - - Id + Get-LMUptimeDevice + + Name - The ID of the website to retrieve data from. Required for Id parameter set. + Specifies the name of the Uptime device to retrieve. + + String + + String + + + None + + + BatchSize + + Controls the number of results returned per request. Must be between 1 and 1000. Default 1000. Int32 Int32 - 0 + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + Get-LMUptimeDevice - StartDate + Type - The start date for retrieving website data. Defaults to 60 minutes ago if not specified. + Filters results by Uptime monitor type. Valid values are webcheck and pingcheck. - DateTime + String - DateTime + String None - EndDate + IsInternal - The end date for retrieving website data. Defaults to current time if not specified. + Filters results by internal (true) or external (false) monitors. - DateTime + Boolean - DateTime + Boolean None - CheckpointId + BatchSize - The ID of the specific checkpoint to retrieve data from. Defaults to 0. + Controls the number of results returned per request. Must be between 1 and 1000. Default 1000. - String + Int32 - String + Int32 - 0 + 1000 ProgressAction @@ -26390,54 +28362,68 @@ Get-LMWebsiteCheckpoint -Filter $filterObject - Get-LMWebsiteData - - Name + Get-LMUptimeDevice + + Filter - The name of the website to retrieve data from. Required for Name parameter set. + Provides a filter object for advanced queries. The Uptime model constraint is applied automatically in addition to the supplied criteria. - String + Object - String + Object None - StartDate + BatchSize - The start date for retrieving website data. Defaults to 60 minutes ago if not specified. + Controls the number of results returned per request. Must be between 1 and 1000. Default 1000. - DateTime + Int32 - DateTime + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference None + + + Get-LMUptimeDevice - EndDate + FilterWizard - The end date for retrieving website data. Defaults to current time if not specified. + Launches the interactive filter wizard and applies the chosen filter along with the Uptime model constraint. - DateTime - DateTime + SwitchParameter - None + False - CheckpointId + BatchSize - The ID of the specific checkpoint to retrieve data from. Defaults to 0. + Controls the number of results returned per request. Must be between 1 and 1000. Default 1000. - String + Int32 - String + Int32 - 0 + 1000 ProgressAction @@ -26454,10 +28440,10 @@ Get-LMWebsiteCheckpoint -Filter $filterObject - + Id - The ID of the website to retrieve data from. Required for Id parameter set. + Specifies the identifier of the Uptime device to retrieve. Int32 @@ -26466,10 +28452,10 @@ Get-LMWebsiteCheckpoint -Filter $filterObject 0 - + Name - The name of the website to retrieve data from. Required for Name parameter set. + Specifies the name of the Uptime device to retrieve. String @@ -26479,40 +28465,64 @@ Get-LMWebsiteCheckpoint -Filter $filterObject None - StartDate + Type - The start date for retrieving website data. Defaults to 60 minutes ago if not specified. + Filters results by Uptime monitor type. Valid values are webcheck and pingcheck. - DateTime + String - DateTime + String None - EndDate + IsInternal - The end date for retrieving website data. Defaults to current time if not specified. + Filters results by internal (true) or external (false) monitors. - DateTime + Boolean - DateTime + Boolean None - CheckpointId + Filter - The ID of the specific checkpoint to retrieve data from. Defaults to 0. + Provides a filter object for advanced queries. The Uptime model constraint is applied automatically in addition to the supplied criteria. - String + Object - String + Object - 0 + None + + + FilterWizard + + Launches the interactive filter wizard and applies the chosen filter along with the Uptime model constraint. + + SwitchParameter + + SwitchParameter + + + False + + + BatchSize + + Controls the number of results returned per request. Must be between 1 and 1000. Default 1000. + + Int32 + + Int32 + + + 1000 ProgressAction @@ -26527,20 +28537,11 @@ Get-LMWebsiteCheckpoint -Filter $filterObject None - - - - None. You cannot pipe objects to this command. - - - - - - + - Returns website monitoring data objects. + LogicMonitor.LMUptimeDevice @@ -26549,24 +28550,29 @@ Get-LMWebsiteCheckpoint -Filter $filterObject - You must run Connect-LMAccount before running this command. + You must run Connect-LMAccount before invoking this cmdlet. Responses are tagged with the LogicMonitor.LMUptimeDevice type information. -------------------------- EXAMPLE 1 -------------------------- - #Retrieve website data by ID -Get-LMWebsiteData -Id 123 + Get-LMUptimeDevice - + Retrieves all Uptime devices across the account. -------------------------- EXAMPLE 2 -------------------------- - #Retrieve website data with custom date range -Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) + Get-LMUptimeDevice -Type webcheck -IsInternal $true - + Retrieves internal web Uptime devices only. + + + + -------------------------- EXAMPLE 3 -------------------------- + Get-LMUptimeDevice -Name "web-int-01" + + Retrieves a specific Uptime device by name. @@ -26574,35 +28580,114 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) - Get-LMWebsiteGroup + Get-LMUsageMetric Get - LMWebsiteGroup + LMUsageMetric - Retrieves website group information from LogicMonitor. + {{ Fill in the Synopsis }} - The Get-LMWebsiteGroup function retrieves website group information from LogicMonitor based on specified parameters. It can return a single website group by ID or multiple groups based on name, filter, or filter wizard. + {{ Fill in the Description }} - Get-LMWebsiteGroup - - Id + Get-LMUsageMetric + + ProgressAction - The ID of the website group to retrieve. This parameter is mandatory when using the Id parameter set. + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference - 0 + None - - BatchSize + + + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-LMUser + Get + LMUser + + Retrieves LogicMonitor users based on specified parameters. + + + + The Get-LMUser function retrieves LogicMonitor users based on the specified parameters. It supports filtering by ID, username, or custom filter. The function uses the LogicMonitor REST API to make the requests. + + + + Get-LMUser + + Id - The number of results to return per request. Must be between 1 and 1000. Default is 1000. + Specifies the ID of the user to retrieve. This parameter is mutually exclusive with the Name and Filter parameters. + + Int32 + + Int32 + + + 0 + + + BatchSize + + Specifies the number of users to retrieve in each batch. The default value is 1000. Int32 @@ -26625,11 +28710,11 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) - Get-LMWebsiteGroup + Get-LMUser Name - The name of the website group to retrieve. This parameter is mandatory when using the Name parameter set. + Specifies the username of the user to retrieve. This parameter is mutually exclusive with the Id and Filter parameters. String @@ -26641,7 +28726,7 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) BatchSize - The number of results to return per request. Must be between 1 and 1000. Default is 1000. + Specifies the number of users to retrieve in each batch. The default value is 1000. Int32 @@ -26664,11 +28749,11 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) - Get-LMWebsiteGroup + Get-LMUser Filter - A filter object to apply when retrieving website groups. This parameter is mandatory when using the Filter parameter set. + Specifies a custom filter to retrieve users based on specific criteria. This parameter is mutually exclusive with the Id and Name parameters. Object @@ -26680,7 +28765,7 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) BatchSize - The number of results to return per request. Must be between 1 and 1000. Default is 1000. + Specifies the number of users to retrieve in each batch. The default value is 1000. Int32 @@ -26703,11 +28788,11 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) - Get-LMWebsiteGroup + Get-LMUser FilterWizard - A switch parameter to enable the filter wizard interface. This parameter is mandatory when using the FilterWizard parameter set. + Specifies the use of the FilterWizard to assist in building a valid filter. This parameter is mutually exclusive with the Id, Name, and Filter parameters. SwitchParameter @@ -26718,7 +28803,7 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) BatchSize - The number of results to return per request. Must be between 1 and 1000. Default is 1000. + Specifies the number of users to retrieve in each batch. The default value is 1000. Int32 @@ -26745,7 +28830,7 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) Id - The ID of the website group to retrieve. This parameter is mandatory when using the Id parameter set. + Specifies the ID of the user to retrieve. This parameter is mutually exclusive with the Name and Filter parameters. Int32 @@ -26757,7 +28842,7 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) Name - The name of the website group to retrieve. This parameter is mandatory when using the Name parameter set. + Specifies the username of the user to retrieve. This parameter is mutually exclusive with the Id and Filter parameters. String @@ -26769,7 +28854,7 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) Filter - A filter object to apply when retrieving website groups. This parameter is mandatory when using the Filter parameter set. + Specifies a custom filter to retrieve users based on specific criteria. This parameter is mutually exclusive with the Id and Name parameters. Object @@ -26781,7 +28866,7 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) FilterWizard - A switch parameter to enable the filter wizard interface. This parameter is mandatory when using the FilterWizard parameter set. + Specifies the use of the FilterWizard to assist in building a valid filter. This parameter is mutually exclusive with the Id, Name, and Filter parameters. SwitchParameter @@ -26793,7 +28878,7 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) BatchSize - The number of results to return per request. Must be between 1 and 1000. Default is 1000. + Specifies the number of users to retrieve in each batch. The default value is 1000. Int32 @@ -26815,52 +28900,34 @@ Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1)None - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor.WebsiteGroup objects. - - - - - - + + - You must run Connect-LMAccount before running this command. + This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command. -------------------------- EXAMPLE 1 -------------------------- - #Retrieve a website group by ID -Get-LMWebsiteGroup -Id 1234 + Get-LMUser -Id 123 +Retrieves the user with the specified ID. -------------------------- EXAMPLE 2 -------------------------- - #Retrieve a website group by name -Get-LMWebsiteGroup -Name "Production" + Get-LMUser -Name "username" +Retrieves the user with the specified username. -------------------------- EXAMPLE 3 -------------------------- - #Retrieve website groups using a filter -Get-LMWebsiteGroup -Filter $filterObject + Get-LMUser -Filter @{Property = "Value"} +Retrieves users based on the specified custom filter. @@ -26870,23 +28937,23 @@ Get-LMWebsiteGroup -Filter $filterObject - Get-LMWebsiteGroupAlerts + Get-LMUserGroup Get - LMWebsiteGroupAlerts + LMUserGroup - Retrieves alerts for a website group from LogicMonitor. + Retrieves user group information from LogicMonitor. - The Get-LMWebsiteGroupAlerts function retrieves alert information for a specified website group in LogicMonitor. The group can be identified by either ID or name. + The Get-LMUserGroup function retrieves user group information from LogicMonitor based on specified parameters. It can return a single user group by ID or multiple groups based on name, filter, or filter wizard. - Get-LMWebsiteGroupAlerts - + Get-LMUserGroup + Id - The ID of the website group to retrieve alerts from. Required for Id parameter set. + The ID of the user group to retrieve. This parameter is mandatory when using the Id parameter set. Int32 @@ -26896,13 +28963,40 @@ Get-LMWebsiteGroup -Filter $filterObject 0 - Filter + BatchSize - A filter object to apply when retrieving alerts. + The number of results to return per request. Must be between 1 and 1000. Default is 1000. - Object + Int32 - Object + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMUserGroup + + Name + + The name of the user group to retrieve. This parameter is mandatory when using the Name parameter set. + + String + + String None @@ -26910,7 +29004,7 @@ Get-LMWebsiteGroup -Filter $filterObject BatchSize - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The number of results to return per request. Must be between 1 and 1000. Default is 1000. Int32 @@ -26933,35 +29027,61 @@ Get-LMWebsiteGroup -Filter $filterObject - Get-LMWebsiteGroupAlerts + Get-LMUserGroup - Name + Filter - The name of the website group to retrieve alerts from. Required for Name parameter set. + A filter object to apply when retrieving user groups. This parameter is mandatory when using the Filter parameter set. - String + Object - String + Object None - Filter + BatchSize - A filter object to apply when retrieving alerts. + The number of results to return per request. Must be between 1 and 1000. Default is 1000. - Object + Int32 - Object + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference None + + + Get-LMUserGroup + + FilterWizard + + A switch parameter to enable the filter wizard interface. This parameter is mandatory when using the FilterWizard parameter set. + + + SwitchParameter + + + False + BatchSize - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The number of results to return per request. Must be between 1 and 1000. Default is 1000. Int32 @@ -26985,10 +29105,10 @@ Get-LMWebsiteGroup -Filter $filterObject - + Id - The ID of the website group to retrieve alerts from. Required for Id parameter set. + The ID of the user group to retrieve. This parameter is mandatory when using the Id parameter set. Int32 @@ -27000,7 +29120,7 @@ Get-LMWebsiteGroup -Filter $filterObject Name - The name of the website group to retrieve alerts from. Required for Name parameter set. + The name of the user group to retrieve. This parameter is mandatory when using the Name parameter set. String @@ -27012,7 +29132,7 @@ Get-LMWebsiteGroup -Filter $filterObject Filter - A filter object to apply when retrieving alerts. + A filter object to apply when retrieving user groups. This parameter is mandatory when using the Filter parameter set. Object @@ -27021,10 +29141,22 @@ Get-LMWebsiteGroup -Filter $filterObject None + + FilterWizard + + A switch parameter to enable the filter wizard interface. This parameter is mandatory when using the FilterWizard parameter set. + + SwitchParameter + + SwitchParameter + + + False + BatchSize - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The number of results to return per request. Must be between 1 and 1000. Default is 1000. Int32 @@ -27056,16 +29188,7 @@ Get-LMWebsiteGroup -Filter $filterObject - - - - Returns website group alert objects. - - - - - - + You must run Connect-LMAccount before running this command. @@ -27074,16 +29197,24 @@ Get-LMWebsiteGroup -Filter $filterObject -------------------------- EXAMPLE 1 -------------------------- - #Retrieve alerts by group ID -Get-LMWebsiteGroupAlerts -Id 123 + #Retrieve a user group by ID +Get-LMUserGroup -Id 1234 -------------------------- EXAMPLE 2 -------------------------- - #Retrieve alerts for a specific group -Get-LMWebsiteGroupAlerts -Name "Production-Websites" + #Retrieve a user group by name +Get-LMUserGroup -Name "Administrators" + + + + + + -------------------------- EXAMPLE 3 -------------------------- + #Retrieve user groups using a filter +Get-LMUserGroup -Filter $filterObject @@ -27093,23 +29224,23 @@ Get-LMWebsiteGroupAlerts -Name "Production-Websites" - Get-LMWebsiteGroupSDT + Get-LMWebsite Get - LMWebsiteGroupSDT + LMWebsite - Retrieves Scheduled Down Time (SDT) entries for a website group from LogicMonitor. + Retrieves website monitoring information from LogicMonitor. - The Get-LMWebsiteGroupSDT function retrieves current SDT entries for a specified website group in LogicMonitor. The group can be identified by either ID or name. + The Get-LMWebsite function retrieves website monitoring configurations from LogicMonitor. It can retrieve all websites, a specific website by ID or name, filter by type, or use custom filters. - Get-LMWebsiteGroupSDT - + Get-LMWebsite + Id - The ID of the website group to retrieve SDT entries from. Required for Id parameter set. + The ID of the specific website to retrieve. Int32 @@ -27119,13 +29250,40 @@ Get-LMWebsiteGroupAlerts -Name "Production-Websites" 0 - Filter + BatchSize - A filter object to apply when retrieving SDT entries. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - Object + Int32 - Object + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMWebsite + + Name + + The name of the specific website to retrieve. + + String + + String None @@ -27156,11 +29314,11 @@ Get-LMWebsiteGroupAlerts -Name "Production-Websites" - Get-LMWebsiteGroupSDT + Get-LMWebsite - Name + Type - The name of the website group to retrieve SDT entries from. Required for Name parameter set. + The type of website to filter by. Valid values are "Webcheck" or "PingCheck". String @@ -27169,10 +29327,37 @@ Get-LMWebsiteGroupAlerts -Name "Production-Websites" None + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMWebsite Filter - A filter object to apply when retrieving SDT entries. + A filter object to apply when retrieving websites. Object @@ -27206,12 +29391,50 @@ Get-LMWebsiteGroupAlerts -Name "Production-Websites" None + + Get-LMWebsite + + FilterWizard + + Switch to enable the filter wizard for building a custom filter interactively. + + + SwitchParameter + + + False + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + - + Id - The ID of the website group to retrieve SDT entries from. Required for Id parameter set. + The ID of the specific website to retrieve. Int32 @@ -27223,7 +29446,19 @@ Get-LMWebsiteGroupAlerts -Name "Production-Websites" Name - The name of the website group to retrieve SDT entries from. Required for Name parameter set. + The name of the specific website to retrieve. + + String + + String + + + None + + + Type + + The type of website to filter by. Valid values are "Webcheck" or "PingCheck". String @@ -27235,7 +29470,7 @@ Get-LMWebsiteGroupAlerts -Name "Production-Websites" Filter - A filter object to apply when retrieving SDT entries. + A filter object to apply when retrieving websites. Object @@ -27244,6 +29479,18 @@ Get-LMWebsiteGroupAlerts -Name "Production-Websites" None + + FilterWizard + + Switch to enable the filter wizard for building a custom filter interactively. + + SwitchParameter + + SwitchParameter + + + False + BatchSize @@ -27282,7 +29529,7 @@ Get-LMWebsiteGroupAlerts -Name "Production-Websites" - Returns website group SDT objects. + Returns LogicMonitor.Website objects. @@ -27297,16 +29544,16 @@ Get-LMWebsiteGroupAlerts -Name "Production-Websites" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve SDT entries by group ID -Get-LMWebsiteGroupSDT -Id 123 + #Retrieve all websites +Get-LMWebsite -------------------------- EXAMPLE 2 -------------------------- - #Retrieve SDT entries for a specific group -Get-LMWebsiteGroupSDT -Name "Production-Websites" + #Retrieve websites of a specific type +Get-LMWebsite -Type "Webcheck" @@ -27316,23 +29563,23 @@ Get-LMWebsiteGroupSDT -Name "Production-Websites" - Get-LMWebsiteGroupSDTHistory + Get-LMWebsiteAlert Get - LMWebsiteGroupSDTHistory + LMWebsiteAlert - Retrieves historical Scheduled Down Time (SDT) entries for a website group from LogicMonitor. + Retrieves alerts for a specific website from LogicMonitor. - The Get-LMWebsiteGroupSDTHistory function retrieves historical SDT entries for a specified website group in LogicMonitor. The group can be identified by either ID or name. + The Get-LMWebsiteAlert function retrieves alert information for a specified website in LogicMonitor. The website can be identified by either ID or name. - Get-LMWebsiteGroupSDTHistory + Get-LMWebsiteAlert Id - The ID of the website group to retrieve SDT history from. Required for Id parameter set. + The ID of the website to retrieve alerts from. Required for Id parameter set. Int32 @@ -27344,7 +29591,7 @@ Get-LMWebsiteGroupSDT -Name "Production-Websites" Filter - A filter object to apply when retrieving SDT history. + A filter object to apply when retrieving alerts. Object @@ -27379,11 +29626,11 @@ Get-LMWebsiteGroupSDT -Name "Production-Websites" - Get-LMWebsiteGroupSDTHistory + Get-LMWebsiteAlert Name - The name of the website group to retrieve SDT history from. Required for Name parameter set. + The name of the website to retrieve alerts from. Required for Name parameter set. String @@ -27395,7 +29642,7 @@ Get-LMWebsiteGroupSDT -Name "Production-Websites" Filter - A filter object to apply when retrieving SDT history. + A filter object to apply when retrieving alerts. Object @@ -27434,7 +29681,7 @@ Get-LMWebsiteGroupSDT -Name "Production-Websites" Id - The ID of the website group to retrieve SDT history from. Required for Id parameter set. + The ID of the website to retrieve alerts from. Required for Id parameter set. Int32 @@ -27446,7 +29693,7 @@ Get-LMWebsiteGroupSDT -Name "Production-Websites" Name - The name of the website group to retrieve SDT history from. Required for Name parameter set. + The name of the website to retrieve alerts from. Required for Name parameter set. String @@ -27458,7 +29705,7 @@ Get-LMWebsiteGroupSDT -Name "Production-Websites" Filter - A filter object to apply when retrieving SDT history. + A filter object to apply when retrieving alerts. Object @@ -27505,7 +29752,7 @@ Get-LMWebsiteGroupSDT -Name "Production-Websites" - Returns historical website group SDT objects. + Returns website alert objects. @@ -27520,16 +29767,16 @@ Get-LMWebsiteGroupSDT -Name "Production-Websites" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve SDT history by group ID -Get-LMWebsiteGroupSDTHistory -Id 123 + #Retrieve alerts by website ID +Get-LMWebsiteAlert -Id 123 -------------------------- EXAMPLE 2 -------------------------- - #Retrieve SDT history for a specific group -Get-LMWebsiteGroupSDTHistory -Name "Production-Websites" + #Retrieve alerts for a specific website +Get-LMWebsiteAlert -Name "www.example.com" @@ -27539,35 +29786,23 @@ Get-LMWebsiteGroupSDTHistory -Name "Production-Websites" - Get-LMWebsiteProperty + Get-LMWebsiteCheckpoint Get - LMWebsiteProperty + LMWebsiteCheckpoint - Retrieves properties for a specific website from LogicMonitor. + Retrieves website checkpoints from LogicMonitor. - The Get-LMWebsiteProperty function retrieves property information for a specified website in LogicMonitor. The website can be identified by either ID or name. + The Get-LMWebsiteCheckpoint function retrieves checkpoint configurations used for website monitoring in LogicMonitor. - Get-LMWebsiteProperty - - Id - - The ID of the website to retrieve properties from. Required for Id parameter set. - - Int32 - - Int32 - - - 0 - + Get-LMWebsiteCheckpoint Filter - A filter object to apply when retrieving properties. + A filter object to apply when retrieving checkpoints. Object @@ -27601,43 +29836,215 @@ Get-LMWebsiteGroupSDTHistory -Name "Production-Websites" None - - Get-LMWebsiteProperty - - Name - - The name of the website to retrieve properties from. Required for Name parameter set. - - String - + + + + Filter + + A filter object to apply when retrieving checkpoints. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns website checkpoint objects. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Retrieve all website checkpoints +Get-LMWebsiteCheckpoint + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve checkpoints using a filter +Get-LMWebsiteCheckpoint -Filter $filterObject + + + + + + + + + + Get-LMWebsiteData + Get + LMWebsiteData + + Retrieves monitoring data for a specific website from LogicMonitor. + + + + The Get-LMWebsiteData function retrieves monitoring data for a specified website and checkpoint in LogicMonitor. The website can be identified by either ID or name. + + + + Get-LMWebsiteData + + Id + + The ID of the website to retrieve data from. Required for Id parameter set. + + Int32 + + Int32 + + + 0 + + + StartDate + + The start date for retrieving website data. Defaults to 60 minutes ago if not specified. + + DateTime + + DateTime + + + None + + + EndDate + + The end date for retrieving website data. Defaults to current time if not specified. + + DateTime + + DateTime + + + None + + + CheckpointId + + The ID of the specific checkpoint to retrieve data from. Defaults to 0. + + String + + String + + + 0 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMWebsiteData + + Name + + The name of the website to retrieve data from. Required for Name parameter set. + + String + String None - Filter + StartDate - A filter object to apply when retrieving properties. + The start date for retrieving website data. Defaults to 60 minutes ago if not specified. - Object + DateTime - Object + DateTime None - BatchSize + EndDate - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The end date for retrieving website data. Defaults to current time if not specified. - Int32 + DateTime - Int32 + DateTime - 1000 + None + + + CheckpointId + + The ID of the specific checkpoint to retrieve data from. Defaults to 0. + + String + + String + + + 0 ProgressAction @@ -27657,7 +30064,7 @@ Get-LMWebsiteGroupSDTHistory -Name "Production-Websites" Id - The ID of the website to retrieve properties from. Required for Id parameter set. + The ID of the website to retrieve data from. Required for Id parameter set. Int32 @@ -27669,7 +30076,7 @@ Get-LMWebsiteGroupSDTHistory -Name "Production-Websites" Name - The name of the website to retrieve properties from. Required for Name parameter set. + The name of the website to retrieve data from. Required for Name parameter set. String @@ -27679,28 +30086,40 @@ Get-LMWebsiteGroupSDTHistory -Name "Production-Websites" None - Filter + StartDate - A filter object to apply when retrieving properties. + The start date for retrieving website data. Defaults to 60 minutes ago if not specified. - Object + DateTime - Object + DateTime None - BatchSize + EndDate - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The end date for retrieving website data. Defaults to current time if not specified. - Int32 + DateTime - Int32 + DateTime - 1000 + None + + + CheckpointId + + The ID of the specific checkpoint to retrieve data from. Defaults to 0. + + String + + String + + + 0 ProgressAction @@ -27728,7 +30147,7 @@ Get-LMWebsiteGroupSDTHistory -Name "Production-Websites" - Returns website property objects. + Returns website monitoring data objects. @@ -27743,16 +30162,16 @@ Get-LMWebsiteGroupSDTHistory -Name "Production-Websites" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve properties by website ID -Get-LMWebsiteProperty -Id 123 + #Retrieve website data by ID +Get-LMWebsiteData -Id 123 -------------------------- EXAMPLE 2 -------------------------- - #Retrieve properties for a specific website -Get-LMWebsiteProperty -Name "www.example.com" + #Retrieve website data with custom date range +Get-LMWebsiteData -Name "www.example.com" -StartDate (Get-Date).AddDays(-1) @@ -27762,23 +30181,23 @@ Get-LMWebsiteProperty -Name "www.example.com" - Get-LMWebsiteSDT + Get-LMWebsiteGroup Get - LMWebsiteSDT + LMWebsiteGroup - Retrieves Scheduled Down Time (SDT) entries for a website from LogicMonitor. + Retrieves website group information from LogicMonitor. - The Get-LMWebsiteSDT function retrieves current SDT entries for a specified website in LogicMonitor. The website can be identified by either ID or name. + The Get-LMWebsiteGroup function retrieves website group information from LogicMonitor based on specified parameters. It can return a single website group by ID or multiple groups based on name, filter, or filter wizard. - Get-LMWebsiteSDT - + Get-LMWebsiteGroup + Id - The ID of the website to retrieve SDT entries from. Required for Id parameter set. + The ID of the website group to retrieve. This parameter is mandatory when using the Id parameter set. Int32 @@ -27788,13 +30207,40 @@ Get-LMWebsiteProperty -Name "www.example.com" 0 - Filter + BatchSize - A filter object to apply when retrieving SDT entries. + The number of results to return per request. Must be between 1 and 1000. Default is 1000. - Object + Int32 - Object + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMWebsiteGroup + + Name + + The name of the website group to retrieve. This parameter is mandatory when using the Name parameter set. + + String + + String None @@ -27802,7 +30248,7 @@ Get-LMWebsiteProperty -Name "www.example.com" BatchSize - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The number of results to return per request. Must be between 1 and 1000. Default is 1000. Int32 @@ -27825,35 +30271,61 @@ Get-LMWebsiteProperty -Name "www.example.com" - Get-LMWebsiteSDT + Get-LMWebsiteGroup - Name + Filter - The name of the website to retrieve SDT entries from. Required for Name parameter set. + A filter object to apply when retrieving website groups. This parameter is mandatory when using the Filter parameter set. - String + Object - String + Object None - Filter + BatchSize - A filter object to apply when retrieving SDT entries. + The number of results to return per request. Must be between 1 and 1000. Default is 1000. - Object + Int32 - Object + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference None + + + Get-LMWebsiteGroup + + FilterWizard + + A switch parameter to enable the filter wizard interface. This parameter is mandatory when using the FilterWizard parameter set. + + + SwitchParameter + + + False + BatchSize - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The number of results to return per request. Must be between 1 and 1000. Default is 1000. Int32 @@ -27877,10 +30349,10 @@ Get-LMWebsiteProperty -Name "www.example.com" - + Id - The ID of the website to retrieve SDT entries from. Required for Id parameter set. + The ID of the website group to retrieve. This parameter is mandatory when using the Id parameter set. Int32 @@ -27892,7 +30364,7 @@ Get-LMWebsiteProperty -Name "www.example.com" Name - The name of the website to retrieve SDT entries from. Required for Name parameter set. + The name of the website group to retrieve. This parameter is mandatory when using the Name parameter set. String @@ -27904,7 +30376,7 @@ Get-LMWebsiteProperty -Name "www.example.com" Filter - A filter object to apply when retrieving SDT entries. + A filter object to apply when retrieving website groups. This parameter is mandatory when using the Filter parameter set. Object @@ -27913,10 +30385,22 @@ Get-LMWebsiteProperty -Name "www.example.com" None + + FilterWizard + + A switch parameter to enable the filter wizard interface. This parameter is mandatory when using the FilterWizard parameter set. + + SwitchParameter + + SwitchParameter + + + False + BatchSize - The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + The number of results to return per request. Must be between 1 and 1000. Default is 1000. Int32 @@ -27951,7 +30435,7 @@ Get-LMWebsiteProperty -Name "www.example.com" - Returns website SDT objects. + Returns LogicMonitor.WebsiteGroup objects. @@ -27966,16 +30450,24 @@ Get-LMWebsiteProperty -Name "www.example.com" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve SDT entries by website ID -Get-LMWebsiteSDT -Id 123 + #Retrieve a website group by ID +Get-LMWebsiteGroup -Id 1234 -------------------------- EXAMPLE 2 -------------------------- - #Retrieve SDT entries for a specific website -Get-LMWebsiteSDT -Name "www.example.com" + #Retrieve a website group by name +Get-LMWebsiteGroup -Name "Production" + + + + + + -------------------------- EXAMPLE 3 -------------------------- + #Retrieve website groups using a filter +Get-LMWebsiteGroup -Filter $filterObject @@ -27985,23 +30477,23 @@ Get-LMWebsiteSDT -Name "www.example.com" - Get-LMWebsiteSDTHistory + Get-LMWebsiteGroupAlert Get - LMWebsiteSDTHistory + LMWebsiteGroupAlert - Retrieves historical Scheduled Down Time (SDT) entries for a website from LogicMonitor. + Retrieves alerts for a website group from LogicMonitor. - The Get-LMWebsiteSDTHistory function retrieves historical SDT entries for a specified website in LogicMonitor. The website can be identified by either ID or name. + The Get-LMWebsiteGroupAlert function retrieves alert information for a specified website group in LogicMonitor. The group can be identified by either ID or name. - Get-LMWebsiteSDTHistory + Get-LMWebsiteGroupAlert Id - The ID of the website to retrieve SDT history from. Required for Id parameter set. + The ID of the website group to retrieve alerts from. Required for Id parameter set. Int32 @@ -28013,7 +30505,7 @@ Get-LMWebsiteSDT -Name "www.example.com" Filter - A filter object to apply when retrieving SDT history. + A filter object to apply when retrieving alerts. Object @@ -28048,11 +30540,11 @@ Get-LMWebsiteSDT -Name "www.example.com" - Get-LMWebsiteSDTHistory + Get-LMWebsiteGroupAlert Name - The name of the website to retrieve SDT history from. Required for Name parameter set. + The name of the website group to retrieve alerts from. Required for Name parameter set. String @@ -28064,7 +30556,7 @@ Get-LMWebsiteSDT -Name "www.example.com" Filter - A filter object to apply when retrieving SDT history. + A filter object to apply when retrieving alerts. Object @@ -28103,7 +30595,7 @@ Get-LMWebsiteSDT -Name "www.example.com" Id - The ID of the website to retrieve SDT history from. Required for Id parameter set. + The ID of the website group to retrieve alerts from. Required for Id parameter set. Int32 @@ -28115,7 +30607,7 @@ Get-LMWebsiteSDT -Name "www.example.com" Name - The name of the website to retrieve SDT history from. Required for Name parameter set. + The name of the website group to retrieve alerts from. Required for Name parameter set. String @@ -28127,7 +30619,7 @@ Get-LMWebsiteSDT -Name "www.example.com" Filter - A filter object to apply when retrieving SDT history. + A filter object to apply when retrieving alerts. Object @@ -28174,7 +30666,7 @@ Get-LMWebsiteSDT -Name "www.example.com" - Returns historical website SDT objects. + Returns website group alert objects. @@ -28189,16 +30681,16 @@ Get-LMWebsiteSDT -Name "www.example.com" -------------------------- EXAMPLE 1 -------------------------- - #Retrieve SDT history by website ID -Get-LMWebsiteSDTHistory -Id 123 + #Retrieve alerts by group ID +Get-LMWebsiteGroupAlert -Id 123 -------------------------- EXAMPLE 2 -------------------------- - #Retrieve SDT history for a specific website -Get-LMWebsiteSDTHistory -Name "www.example.com" + #Retrieve alerts for a specific group +Get-LMWebsiteGroupAlert -Name "Production-Websites" @@ -28208,58 +30700,35 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" - Import-LMDashboard - Import - LMDashboard + Get-LMWebsiteGroupSDT + Get + LMWebsiteGroupSDT - Imports LogicMonitor dashboards from various sources. + Retrieves Scheduled Down Time (SDT) entries for a website group from LogicMonitor. - The Import-LMDashboard function allows you to import LogicMonitor dashboards from different sources, such as local files, GitHub repositories, or LogicMonitor dashboard groups. It supports importing dashboards in JSON format. + The Get-LMWebsiteGroupSDT function retrieves current SDT entries for a specified website group in LogicMonitor. The group can be identified by either ID or name. - Import-LMDashboard - - FilePath - - Specifies the path to a local file or directory containing the JSON dashboard files to import. - - String - - String - - - None - + Get-LMWebsiteGroupSDT - ParentGroupName - - The name of the parent dashboard group where imported dashboards will be placed. - - String - - String - - - None - - - ReplaceAPITokensOnImport + Id - Switch to replace API tokens in imported dashboards with a dynamically generated token. + The ID of the website group to retrieve SDT entries from. Required for Id parameter set. + Int32 - SwitchParameter + Int32 - False + 0 - APIToken + Filter - The API token to use when replacing tokens in imported dashboards. + A filter object to apply when retrieving SDT entries. Object @@ -28269,16 +30738,16 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" None - PrivateUserName + BatchSize - The username of dashboard owner when creating dashboard as private. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - String + Int32 - String + Int32 - None + 1000 ProgressAction @@ -28294,11 +30763,11 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" - Import-LMDashboard - - FilePath + Get-LMWebsiteGroupSDT + + Name - Specifies the path to a local file or directory containing the JSON dashboard files to import. + The name of the website group to retrieve SDT entries from. Required for Name parameter set. String @@ -28307,107 +30776,182 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" None - - ParentGroupId + + Filter - The ID of the parent dashboard group where imported dashboards will be placed. + A filter object to apply when retrieving SDT entries. - String + Object - String + Object None - ReplaceAPITokensOnImport + BatchSize - Switch to replace API tokens in imported dashboards with a dynamically generated token. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + Int32 - SwitchParameter + Int32 - False + 1000 - - APIToken + + ProgressAction - The API token to use when replacing tokens in imported dashboards. + {{ Fill ProgressAction Description }} - Object + ActionPreference - Object - - - None - - - PrivateUserName - - The username of dashboard owner when creating dashboard as private. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference + ActionPreference None + + + + Id + + The ID of the website group to retrieve SDT entries from. Required for Id parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the website group to retrieve SDT entries from. Required for Name parameter set. + + String + + String + + + None + + + Filter + + A filter object to apply when retrieving SDT entries. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns website group SDT objects. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Retrieve SDT entries by group ID +Get-LMWebsiteGroupSDT -Id 123 + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve SDT entries for a specific group +Get-LMWebsiteGroupSDT -Name "Production-Websites" + + + + + + + + + + Get-LMWebsiteGroupSDTHistory + Get + LMWebsiteGroupSDTHistory + + Retrieves historical Scheduled Down Time (SDT) entries for a website group from LogicMonitor. + + + + The Get-LMWebsiteGroupSDTHistory function retrieves historical SDT entries for a specified website group in LogicMonitor. The group can be identified by either ID or name. + + - Import-LMDashboard - - File - - Specifies a single JSON dashboard file to import. - - String - - String - - - None - + Get-LMWebsiteGroupSDTHistory - ParentGroupName - - The name of the parent dashboard group where imported dashboards will be placed. - - String - - String - - - None - - - ReplaceAPITokensOnImport + Id - Switch to replace API tokens in imported dashboards with a dynamically generated token. + The ID of the website group to retrieve SDT history from. Required for Id parameter set. + Int32 - SwitchParameter + Int32 - False + 0 - APIToken + Filter - The API token to use when replacing tokens in imported dashboards. + A filter object to apply when retrieving SDT history. Object @@ -28417,16 +30961,16 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" None - PrivateUserName + BatchSize - The username of dashboard owner when creating dashboard as private. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - String + Int32 - String + Int32 - None + 1000 ProgressAction @@ -28442,23 +30986,11 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" - Import-LMDashboard - - File - - Specifies a single JSON dashboard file to import. - - String - - String - - - None - - - ParentGroupId + Get-LMWebsiteGroupSDTHistory + + Name - The ID of the parent dashboard group where imported dashboards will be placed. + The name of the website group to retrieve SDT history from. Required for Name parameter set. String @@ -28468,20 +31000,9 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" None - ReplaceAPITokensOnImport - - Switch to replace API tokens in imported dashboards with a dynamically generated token. - - - SwitchParameter - - - False - - - APIToken + Filter - The API token to use when replacing tokens in imported dashboards. + A filter object to apply when retrieving SDT history. Object @@ -28491,16 +31012,16 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" None - PrivateUserName + BatchSize - The username of dashboard owner when creating dashboard as private. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - String + Int32 - String + Int32 - None + 1000 ProgressAction @@ -28515,59 +31036,145 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" None + + + + Id + + The ID of the website group to retrieve SDT history from. Required for Id parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the website group to retrieve SDT history from. Required for Name parameter set. + + String + + String + + + None + + + Filter + + A filter object to apply when retrieving SDT history. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns historical website group SDT objects. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Retrieve SDT history by group ID +Get-LMWebsiteGroupSDTHistory -Id 123 + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve SDT history for a specific group +Get-LMWebsiteGroupSDTHistory -Name "Production-Websites" + + + + + + + + + + Get-LMWebsiteProperty + Get + LMWebsiteProperty + + Retrieves properties for a specific website from LogicMonitor. + + + + The Get-LMWebsiteProperty function retrieves property information for a specified website in LogicMonitor. The website can be identified by either ID or name. + + - Import-LMDashboard - - GithubUserRepo - - Specifies the GitHub repository (in the format "username/repo") from which to import JSON dashboard files. - - String - - String - - - None - - - GithubAccessToken - - Specifies the GitHub access token for authenticated requests. Required for large repositories due to API rate limits. - - String - - String - - - None - + Get-LMWebsiteProperty - ParentGroupName - - The name of the parent dashboard group where imported dashboards will be placed. - - String - - String - - - None - - - ReplaceAPITokensOnImport + Id - Switch to replace API tokens in imported dashboards with a dynamically generated token. + The ID of the website to retrieve properties from. Required for Id parameter set. + Int32 - SwitchParameter + Int32 - False + 0 - APIToken + Filter - The API token to use when replacing tokens in imported dashboards. + A filter object to apply when retrieving properties. Object @@ -28577,16 +31184,16 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" None - PrivateUserName + BatchSize - The username of dashboard owner when creating dashboard as private. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - String + Int32 - String + Int32 - None + 1000 ProgressAction @@ -28602,35 +31209,11 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" - Import-LMDashboard - - GithubUserRepo - - Specifies the GitHub repository (in the format "username/repo") from which to import JSON dashboard files. - - String - - String - - - None - - - GithubAccessToken - - Specifies the GitHub access token for authenticated requests. Required for large repositories due to API rate limits. - - String - - String - - - None - + Get-LMWebsiteProperty - ParentGroupId + Name - The ID of the parent dashboard group where imported dashboards will be placed. + The name of the website to retrieve properties from. Required for Name parameter set. String @@ -28640,20 +31223,9 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" None - ReplaceAPITokensOnImport - - Switch to replace API tokens in imported dashboards with a dynamically generated token. - - - SwitchParameter - - - False - - - APIToken + Filter - The API token to use when replacing tokens in imported dashboards. + A filter object to apply when retrieving properties. Object @@ -28663,16 +31235,16 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" None - PrivateUserName + BatchSize - The username of dashboard owner when creating dashboard as private. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - String + Int32 - String + Int32 - None + 1000 ProgressAction @@ -28690,21 +31262,21 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" - FilePath + Id - Specifies the path to a local file or directory containing the JSON dashboard files to import. + The ID of the website to retrieve properties from. Required for Id parameter set. - String + Int32 - String + Int32 - None + 0 - File + Name - Specifies a single JSON dashboard file to import. + The name of the website to retrieve properties from. Required for Name parameter set. String @@ -28713,96 +31285,36 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" None - - GithubUserRepo + + Filter - Specifies the GitHub repository (in the format "username/repo") from which to import JSON dashboard files. + A filter object to apply when retrieving properties. - String + Object - String + Object None - GithubAccessToken + BatchSize - Specifies the GitHub access token for authenticated requests. Required for large repositories due to API rate limits. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - String + Int32 - String + Int32 - None + 1000 - - ParentGroupId + + ProgressAction - The ID of the parent dashboard group where imported dashboards will be placed. + {{ Fill ProgressAction Description }} - String - - String - - - None - - - ParentGroupName - - The name of the parent dashboard group where imported dashboards will be placed. - - String - - String - - - None - - - ReplaceAPITokensOnImport - - Switch to replace API tokens in imported dashboards with a dynamically generated token. - - SwitchParameter - - SwitchParameter - - - False - - - APIToken - - The API token to use when replacing tokens in imported dashboards. - - Object - - Object - - - None - - - PrivateUserName - - The username of dashboard owner when creating dashboard as private. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference + ActionPreference ActionPreference @@ -28823,7 +31335,7 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" - Returns imported dashboard objects. + Returns website property objects. @@ -28838,120 +31350,16 @@ Get-LMWebsiteSDTHistory -Name "www.example.com" -------------------------- EXAMPLE 1 -------------------------- - #Import dashboards from a directory -Import-LMDashboard -FilePath "C:\Dashboards" -ParentGroupId 12345 -ReplaceAPITokensOnImport -APIToken $apiToken + #Retrieve properties by website ID +Get-LMWebsiteProperty -Id 123 -------------------------- EXAMPLE 2 -------------------------- - #Import dashboards from GitHub -Import-LMDashboard -GithubUserRepo "username/repo" -ParentGroupName "MyDashboards" -ReplaceAPITokensOnImport -APIToken $apiToken - - - - - - - - - - Import-LMExchangeModule - Import - LMExchangeModule - - Imports an LM Exchange module into LogicMonitor. - - - - The Import-LMExchangeModule function imports a specified LM Exchange module into your LogicMonitor portal. - - - - Import-LMExchangeModule - - LMExchangeId - - The ID of the LM Exchange module to import. This parameter is mandatory. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - LMExchangeId - - The ID of the LM Exchange module to import. This parameter is mandatory. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns a success message if the import is successful. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Import an LM Exchange module -Import-LMExchangeModule -LMExchangeId "LM12345" + #Retrieve properties for a specific website +Get-LMWebsiteProperty -Name "www.example.com" @@ -28961,54 +31369,54 @@ Import-LMExchangeModule -LMExchangeId "LM12345" - Import-LMLogicModule - Import - LMLogicModule + Get-LMWebsiteSDT + Get + LMWebsiteSDT - Imports a LogicModule into LogicMonitor. + Retrieves Scheduled Down Time (SDT) entries for a website from LogicMonitor. - The Import-LMLogicModule function imports a LogicModule from a file path or file data. Supports various module types including datasource, propertyrules, eventsource, topologysource, configsource, logsource, functions, and oids. + The Get-LMWebsiteSDT function retrieves current SDT entries for a specified website in LogicMonitor. The website can be identified by either ID or name. - Import-LMLogicModule + Get-LMWebsiteSDT - FilePath + Id - The path to the file containing the LogicModule to import. + The ID of the website to retrieve SDT entries from. Required for Id parameter set. - String + Int32 - String + Int32 - None + 0 - Type + Filter - The type of LogicModule. Valid values are "datasource", "propertyrules", "eventsource", "topologysource", "configsource", "logsource", "functions", "oids". Defaults to "datasource". + A filter object to apply when retrieving SDT entries. - String + Object - String + Object - Datasource + None - ForceOverwrite + BatchSize - Whether to overwrite an existing LogicModule with the same name. Defaults to $false. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - Boolean + Int32 - Boolean + Int32 - False + 1000 ProgressAction @@ -29024,42 +31432,42 @@ Import-LMExchangeModule -LMExchangeId "LM12345" - Import-LMLogicModule - - File + Get-LMWebsiteSDT + + Name - The file data of the LogicModule to import. + The name of the website to retrieve SDT entries from. Required for Name parameter set. - Object + String - Object + String None - Type + Filter - The type of LogicModule. Valid values are "datasource", "propertyrules", "eventsource", "topologysource", "configsource", "logsource", "functions", "oids". Defaults to "datasource". + A filter object to apply when retrieving SDT entries. - String + Object - String + Object - Datasource + None - ForceOverwrite + BatchSize - Whether to overwrite an existing LogicModule with the same name. Defaults to $false. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - Boolean + Int32 - Boolean + Int32 - False + 1000 ProgressAction @@ -29077,52 +31485,52 @@ Import-LMExchangeModule -LMExchangeId "LM12345" - FilePath + Id - The path to the file containing the LogicModule to import. + The ID of the website to retrieve SDT entries from. Required for Id parameter set. - String + Int32 - String + Int32 - None + 0 - - File + + Name - The file data of the LogicModule to import. + The name of the website to retrieve SDT entries from. Required for Name parameter set. - Object + String - Object + String None - Type + Filter - The type of LogicModule. Valid values are "datasource", "propertyrules", "eventsource", "topologysource", "configsource", "logsource", "functions", "oids". Defaults to "datasource". + A filter object to apply when retrieving SDT entries. - String + Object - String + Object - Datasource + None - ForceOverwrite + BatchSize - Whether to overwrite an existing LogicModule with the same name. Defaults to $false. + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. - Boolean + Int32 - Boolean + Int32 - False + 1000 ProgressAction @@ -29150,7 +31558,7 @@ Import-LMExchangeModule -LMExchangeId "LM12345" - Returns a success message if the import is successful. + Returns website SDT objects. @@ -29159,22 +31567,22 @@ Import-LMExchangeModule -LMExchangeId "LM12345" - You must run Connect-LMAccount before running this command. Requires PowerShell version 6.1 or higher. + You must run Connect-LMAccount before running this command. -------------------------- EXAMPLE 1 -------------------------- - #Import a datasource module -Import-LMLogicModule -FilePath "C:\LogicModules\datasource.xml" -Type "datasource" -ForceOverwrite $true + #Retrieve SDT entries by website ID +Get-LMWebsiteSDT -Id 123 -------------------------- EXAMPLE 2 -------------------------- - #Import a property rules module -Import-LMLogicModule -File $fileData -Type "propertyrules" + #Retrieve SDT entries for a specific website +Get-LMWebsiteSDT -Name "www.example.com" @@ -29184,23 +31592,74 @@ Import-LMLogicModule -File $fileData -Type "propertyrules" - Import-LMRepositoryLogicModules - Import - LMRepositoryLogicModules + Get-LMWebsiteSDTHistory + Get + LMWebsiteSDTHistory - Imports LogicMonitor repository logic modules. + Retrieves historical Scheduled Down Time (SDT) entries for a website from LogicMonitor. - The Import-LMRepositoryLogicModules function imports specified logic modules from the LogicMonitor repository into your portal. + The Get-LMWebsiteSDTHistory function retrieves historical SDT entries for a specified website in LogicMonitor. The website can be identified by either ID or name. - Import-LMRepositoryLogicModules - - Type + Get-LMWebsiteSDTHistory + + Id - The type of logic modules to import. Valid values are "datasources", "propertyrules", "eventsources", "topologysources", "configsources". + The ID of the website to retrieve SDT history from. Required for Id parameter set. + + Int32 + + Int32 + + + 0 + + + Filter + + A filter object to apply when retrieving SDT history. + + Object + + Object + + + None + + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Get-LMWebsiteSDTHistory + + Name + + The name of the website to retrieve SDT history from. Required for Name parameter set. String @@ -29209,18 +31668,30 @@ Import-LMLogicModule -File $fileData -Type "propertyrules" None - - LogicModuleNames + + Filter - An array of logic module names to import. + A filter object to apply when retrieving SDT history. - String[] + Object - String[] + Object None + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + ProgressAction @@ -29236,10 +31707,22 @@ Import-LMLogicModule -File $fileData -Type "propertyrules" - - Type + + Id - The type of logic modules to import. Valid values are "datasources", "propertyrules", "eventsources", "topologysources", "configsources". + The ID of the website to retrieve SDT history from. Required for Id parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the website to retrieve SDT history from. Required for Name parameter set. String @@ -29248,18 +31731,30 @@ Import-LMLogicModule -File $fileData -Type "propertyrules" None - - LogicModuleNames + + Filter - An array of logic module names to import. + A filter object to apply when retrieving SDT history. - String[] + Object - String[] + Object None + + BatchSize + + The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. + + Int32 + + Int32 + + + 1000 + ProgressAction @@ -29286,7 +31781,7 @@ Import-LMLogicModule -File $fileData -Type "propertyrules" - Returns a success message with the names of imported modules. + Returns historical website SDT objects. @@ -29301,8 +31796,16 @@ Import-LMLogicModule -File $fileData -Type "propertyrules" -------------------------- EXAMPLE 1 -------------------------- - #Import specific datasources -Import-LMRepositoryLogicModules -Type "datasources" -LogicModuleNames "DataSource1", "DataSource2" + #Retrieve SDT history by website ID +Get-LMWebsiteSDTHistory -Id 123 + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Retrieve SDT history for a specific website +Get-LMWebsiteSDTHistory -Name "www.example.com" @@ -29312,77 +31815,70 @@ Import-LMRepositoryLogicModules -Type "datasources" -LogicModuleNames "DataSourc - Invoke-LMActiveDiscovery - Invoke - LMActiveDiscovery + Import-LMDashboard + Import + LMDashboard - Invokes an active discovery task for LogicMonitor devices. + Imports LogicMonitor dashboards from various sources. - The Invoke-LMActiveDiscovery function schedules an active discovery task for LogicMonitor devices. It can target individual devices or device groups using either ID or name. + The Import-LMDashboard function allows you to import LogicMonitor dashboards from different sources, such as local files, GitHub repositories, or LogicMonitor dashboard groups. It supports importing dashboards in JSON format. - Invoke-LMActiveDiscovery - - Id + Import-LMDashboard + + FilePath - The ID of the device to run active discovery on. Required for Id parameter set. + Specifies the path to a local file or directory containing the JSON dashboard files to import. - Int32 + String - Int32 + String - 0 + None - - ProgressAction + + ParentGroupName - {{ Fill ProgressAction Description }} + The name of the parent dashboard group where imported dashboards will be placed. - ActionPreference + String - ActionPreference + String None - - - Invoke-LMActiveDiscovery - - Name + + ReplaceAPITokensOnImport - The name of the device to run active discovery on. Required for Name parameter set. + Switch to replace API tokens in imported dashboards with a dynamically generated token. - String - String + SwitchParameter - None + False - - ProgressAction + + APIToken - {{ Fill ProgressAction Description }} + The API token to use when replacing tokens in imported dashboards. - ActionPreference + Object - ActionPreference + Object None - - - Invoke-LMActiveDiscovery - - GroupId + + PrivateUserName - The ID of the device group to run active discovery on. Required for GroupId parameter set. + The username of dashboard owner when creating dashboard as private. String @@ -29405,11 +31901,378 @@ Import-LMRepositoryLogicModules -Type "datasources" -LogicModuleNames "DataSourc - Invoke-LMActiveDiscovery + Import-LMDashboard - GroupName + FilePath - The name of the device group to run active discovery on. Required for GroupName parameter set. + Specifies the path to a local file or directory containing the JSON dashboard files to import. + + String + + String + + + None + + + ParentGroupId + + The ID of the parent dashboard group where imported dashboards will be placed. + + String + + String + + + None + + + ReplaceAPITokensOnImport + + Switch to replace API tokens in imported dashboards with a dynamically generated token. + + + SwitchParameter + + + False + + + APIToken + + The API token to use when replacing tokens in imported dashboards. + + Object + + Object + + + None + + + PrivateUserName + + The username of dashboard owner when creating dashboard as private. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Import-LMDashboard + + File + + Specifies a single JSON dashboard file to import. + + String + + String + + + None + + + ParentGroupName + + The name of the parent dashboard group where imported dashboards will be placed. + + String + + String + + + None + + + ReplaceAPITokensOnImport + + Switch to replace API tokens in imported dashboards with a dynamically generated token. + + + SwitchParameter + + + False + + + APIToken + + The API token to use when replacing tokens in imported dashboards. + + Object + + Object + + + None + + + PrivateUserName + + The username of dashboard owner when creating dashboard as private. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Import-LMDashboard + + File + + Specifies a single JSON dashboard file to import. + + String + + String + + + None + + + ParentGroupId + + The ID of the parent dashboard group where imported dashboards will be placed. + + String + + String + + + None + + + ReplaceAPITokensOnImport + + Switch to replace API tokens in imported dashboards with a dynamically generated token. + + + SwitchParameter + + + False + + + APIToken + + The API token to use when replacing tokens in imported dashboards. + + Object + + Object + + + None + + + PrivateUserName + + The username of dashboard owner when creating dashboard as private. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Import-LMDashboard + + GithubUserRepo + + Specifies the GitHub repository (in the format "username/repo") from which to import JSON dashboard files. + + String + + String + + + None + + + GithubAccessToken + + Specifies the GitHub access token for authenticated requests. Required for large repositories due to API rate limits. + + String + + String + + + None + + + ParentGroupName + + The name of the parent dashboard group where imported dashboards will be placed. + + String + + String + + + None + + + ReplaceAPITokensOnImport + + Switch to replace API tokens in imported dashboards with a dynamically generated token. + + + SwitchParameter + + + False + + + APIToken + + The API token to use when replacing tokens in imported dashboards. + + Object + + Object + + + None + + + PrivateUserName + + The username of dashboard owner when creating dashboard as private. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Import-LMDashboard + + GithubUserRepo + + Specifies the GitHub repository (in the format "username/repo") from which to import JSON dashboard files. + + String + + String + + + None + + + GithubAccessToken + + Specifies the GitHub access token for authenticated requests. Required for large repositories due to API rate limits. + + String + + String + + + None + + + ParentGroupId + + The ID of the parent dashboard group where imported dashboards will be placed. + + String + + String + + + None + + + ReplaceAPITokensOnImport + + Switch to replace API tokens in imported dashboards with a dynamically generated token. + + + SwitchParameter + + + False + + + APIToken + + The API token to use when replacing tokens in imported dashboards. + + Object + + Object + + + None + + + PrivateUserName + + The username of dashboard owner when creating dashboard as private. String @@ -29433,22 +32296,22 @@ Import-LMRepositoryLogicModules -Type "datasources" -LogicModuleNames "DataSourc - - Id + + FilePath - The ID of the device to run active discovery on. Required for Id parameter set. + Specifies the path to a local file or directory containing the JSON dashboard files to import. - Int32 + String - Int32 + String - 0 + None - Name + File - The name of the device to run active discovery on. Required for Name parameter set. + Specifies a single JSON dashboard file to import. String @@ -29458,9 +32321,21 @@ Import-LMRepositoryLogicModules -Type "datasources" -LogicModuleNames "DataSourc None - GroupId + GithubUserRepo - The ID of the device group to run active discovery on. Required for GroupId parameter set. + Specifies the GitHub repository (in the format "username/repo") from which to import JSON dashboard files. + + String + + String + + + None + + + GithubAccessToken + + Specifies the GitHub access token for authenticated requests. Required for large repositories due to API rate limits. String @@ -29470,9 +32345,57 @@ Import-LMRepositoryLogicModules -Type "datasources" -LogicModuleNames "DataSourc None - GroupName + ParentGroupId - The name of the device group to run active discovery on. Required for GroupName parameter set. + The ID of the parent dashboard group where imported dashboards will be placed. + + String + + String + + + None + + + ParentGroupName + + The name of the parent dashboard group where imported dashboards will be placed. + + String + + String + + + None + + + ReplaceAPITokensOnImport + + Switch to replace API tokens in imported dashboards with a dynamically generated token. + + SwitchParameter + + SwitchParameter + + + False + + + APIToken + + The API token to use when replacing tokens in imported dashboards. + + Object + + Object + + + None + + + PrivateUserName + + The username of dashboard owner when creating dashboard as private. String @@ -29507,7 +32430,7 @@ Import-LMRepositoryLogicModules -Type "datasources" -LogicModuleNames "DataSourc - Returns a success message if the task is scheduled successfully. + Returns imported dashboard objects. @@ -29522,16 +32445,16 @@ Import-LMRepositoryLogicModules -Type "datasources" -LogicModuleNames "DataSourc -------------------------- EXAMPLE 1 -------------------------- - #Run active discovery on a device by ID -Invoke-LMActiveDiscovery -Id 12345 + #Import dashboards from a directory +Import-LMDashboard -FilePath "C:\Dashboards" -ParentGroupId 12345 -ReplaceAPITokensOnImport -APIToken $apiToken -------------------------- EXAMPLE 2 -------------------------- - #Run active discovery on a device group by name -Invoke-LMActiveDiscovery -GroupName "Production-Servers" + #Import dashboards from GitHub +Import-LMDashboard -GithubUserRepo "username/repo" -ParentGroupName "MyDashboards" -ReplaceAPITokensOnImport -APIToken $apiToken @@ -29541,23 +32464,23 @@ Invoke-LMActiveDiscovery -GroupName "Production-Servers" - Invoke-LMAWSAccountTest - Invoke - LMAWSAccountTest + Import-LMDeviceGroupsFromCSV + Import + LMDeviceGroupsFromCSV - Tests AWS account connectivity in LogicMonitor. + Imports list of device groups based on specified CSV file. - The Invoke-LMAWSAccountTest function tests the connection and permissions for an AWS account in LogicMonitor. It verifies access to specified AWS services. + Imports list of device groups based on specified CSV file. You can generate a sample of the CSV file by specifying the -GenerateExampleCSV parameter. - Invoke-LMAWSAccountTest - - ExternalId + Import-LMDeviceGroupsFromCSV + + FilePath - The external ID for AWS cross-account access. + {{ Fill FilePath Description }} String @@ -29566,60 +32489,49 @@ Invoke-LMActiveDiscovery -GroupName "Production-Servers" None - - AccountId + + PassThru - The AWS account ID. + {{ Fill PassThru Description }} - String - String + SwitchParameter - None + False - - AssumedRoleARN + + ProgressAction - The ARN of the IAM role to be assumed. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - CheckedServices + + + Import-LMDeviceGroupsFromCSV + + GenerateExampleCSV - The list of AWS services to test. Defaults to all supported services. + {{ Fill GenerateExampleCSV Description }} - String - String + SwitchParameter - DYNAMODB,EBS,EC2,AUTOSCALING,BACKUP,BACKUPPROTECTEDRESOURCE,TRANSFER,ELASTICACHE,ELB,RDS,REDSHIFT,S3,SNS,SQS,EMR,KINESIS,ROUTE53,ROUTE53HOSTEDZONE,CLOUDSEARCH,LAMBDA,ECR,ECS,ELASTICSEARCH,EFS,SWFWORKFLOW,SWFACTIVITY,APPLICATIONELB,CLOUDFRONT,APIGATEWAY,APIGATEWAYV2,SES,VPN,FIREHOSE,KINESISVIDEO,WORKSPACE,NETWORKELB,NATGATEWAY,DIRECTCONNECT,DIRECTCONNECT_VIRTUALINTERFACE,WORKSPACEDIRECTORY,ELASTICBEANSTALK,DMSREPLICATION,MSKCLUSTER,MSKBROKER,FSX,TRANSITGATEWAY,GLUE,APPSTREAM,MQ,ATHENA,DBCLUSTER,DOCDB,STEPFUNCTIONS,OPSWORKS,CODEBUILD,SAGEMAKER,ROUTE53RESOLVER,DMSREPLICATIONTASKS,EVENTBRIDGE,MEDIACONNECT,MEDIAPACKAGELIVE,MEDIASTORE,MEDIAPACKAGEVOD,MEDIATAILOR,MEDIACONVERT,ELASTICTRANSCODER,COGNITO,TRANSITGATEWAYATTACHMENT,QUICKSIGHT_DASHBOARDS,QUICKSIGHT_DATASETS,PRIVATELINK_ENDPOINTS,PRIVATELINK_SERVICES,GLOBAL_NETWORKS + False - - GroupId + + ProgressAction - The LogicMonitor group ID to associate with the AWS account. Defaults to -1. + {{ Fill ProgressAction Description }} - String - - String - - - -1 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference + ActionPreference ActionPreference @@ -29629,34 +32541,10 @@ Invoke-LMActiveDiscovery -GroupName "Production-Servers" - - ExternalId - - The external ID for AWS cross-account access. - - String - - String - - - None - - - AccountId - - The AWS account ID. - - String - - String - - - None - - - AssumedRoleARN + + FilePath - The ARN of the IAM role to be assumed. + {{ Fill FilePath Description }} String @@ -29665,29 +32553,29 @@ Invoke-LMActiveDiscovery -GroupName "Production-Servers" None - - CheckedServices + + GenerateExampleCSV - The list of AWS services to test. Defaults to all supported services. + {{ Fill GenerateExampleCSV Description }} - String + SwitchParameter - String + SwitchParameter - DYNAMODB,EBS,EC2,AUTOSCALING,BACKUP,BACKUPPROTECTEDRESOURCE,TRANSFER,ELASTICACHE,ELB,RDS,REDSHIFT,S3,SNS,SQS,EMR,KINESIS,ROUTE53,ROUTE53HOSTEDZONE,CLOUDSEARCH,LAMBDA,ECR,ECS,ELASTICSEARCH,EFS,SWFWORKFLOW,SWFACTIVITY,APPLICATIONELB,CLOUDFRONT,APIGATEWAY,APIGATEWAYV2,SES,VPN,FIREHOSE,KINESISVIDEO,WORKSPACE,NETWORKELB,NATGATEWAY,DIRECTCONNECT,DIRECTCONNECT_VIRTUALINTERFACE,WORKSPACEDIRECTORY,ELASTICBEANSTALK,DMSREPLICATION,MSKCLUSTER,MSKBROKER,FSX,TRANSITGATEWAY,GLUE,APPSTREAM,MQ,ATHENA,DBCLUSTER,DOCDB,STEPFUNCTIONS,OPSWORKS,CODEBUILD,SAGEMAKER,ROUTE53RESOLVER,DMSREPLICATIONTASKS,EVENTBRIDGE,MEDIACONNECT,MEDIAPACKAGELIVE,MEDIASTORE,MEDIAPACKAGEVOD,MEDIATAILOR,MEDIACONVERT,ELASTICTRANSCODER,COGNITO,TRANSITGATEWAYATTACHMENT,QUICKSIGHT_DASHBOARDS,QUICKSIGHT_DATASETS,PRIVATELINK_ENDPOINTS,PRIVATELINK_SERVICES,GLOBAL_NETWORKS + False - - GroupId + + PassThru - The LogicMonitor group ID to associate with the AWS account. Defaults to -1. + {{ Fill PassThru Description }} - String + SwitchParameter - String + SwitchParameter - -1 + False ProgressAction @@ -29705,33 +32593,23 @@ Invoke-LMActiveDiscovery -GroupName "Production-Servers" - None. You cannot pipe objects to this command. + None. Does not accept pipeline input. - - - - Returns test results for each AWS service. - - - - - - + - You must run Connect-LMAccount before running this command. + Assumes csv with the headers name,fullpath,description,appliesTo,property1,property2,property[n]. Name and fullpath are the only required fields. -------------------------- EXAMPLE 1 -------------------------- - #Test AWS account connectivity -Invoke-LMAWSAccountTest -ExternalId "123456" -AccountId "987654" -AssumedRoleARN "arn:aws:iam::123456789012:role/MyRole" + Import-LMDeviceGroupsFromCSV -FilePath ./ImportList.csv -PassThru @@ -29741,35 +32619,23 @@ Invoke-LMAWSAccountTest -ExternalId "123456" -AccountId "987654" -AssumedRoleARN - Invoke-LMAzureAccountTest - Invoke - LMAzureAccountTest + Import-LMDevicesFromCSV + Import + LMDevicesFromCSV - Tests Azure account connectivity in LogicMonitor. + Imports devices from a CSV file into LogicMonitor. - The Invoke-LMAzureAccountTest function tests the connection and permissions for an Azure account in LogicMonitor. It verifies access to specified Azure services. + The Import-LMDevicesFromCSV function imports devices from a CSV file into LogicMonitor. It requires a valid CSV file containing device information such as IP address, display name, host group, collector ID, and description. The function checks if the user is logged in and has valid API credentials before importing the devices. - Invoke-LMAzureAccountTest - - ClientId - - The Azure Active Directory application client ID. - - String - - String - - - None - - - SecretKey + Import-LMDevicesFromCSV + + FilePath - The Azure Active Directory application secret key. + Specifies the path to the CSV file containing the device information. This parameter is mandatory when the 'Import' parameter set is used. String @@ -29778,62 +32644,63 @@ Invoke-LMAWSAccountTest -ExternalId "123456" -AccountId "987654" -AssumedRoleARN None - - CheckedServices + + PassThru - The list of Azure services to test. Defaults to all supported services. + Indicates whether to return the imported devices as output. This parameter is optional and can be used with the 'Import' parameter set. - String - String + SwitchParameter - VIRTUALMACHINE,SQLDATABASE,APPSERVICE,EVENTHUB,REDISCACHE,REDISCACHEENTERPRISE,VIRTUALMACHINESCALESET,VIRTUALMACHINESCALESETVM,APPLICATIONGATEWAY,IOTHUB,FUNCTION,SERVICEBUS,MARIADB,MYSQL,MYSQLFLEXIBLE,POSTGRESQL,POSTGRESQLFLEXIBLE,POSTGRESQLCITUS,ANALYSISSERVICE,TABLESTORAGE,BLOBSTORAGE,FILESTORAGE,QUEUESTORAGE,STORAGEACCOUNT,APIMANAGEMENT,COSMOSDB,APPSERVICEPLAN,VIRTUALNETWORKGATEWAY,AUTOMATIONACCOUNT,EXPRESSROUTECIRCUIT,DATALAKEANALYTICS,DATALAKESTORE,APPLICATIONINSIGHTS,FIREWALL,SQLELASTICPOOL,SQLMANAGEDINSTANCE,HDINSIGHT,RECOVERYSERVICES,BACKUPPROTECTEDITEMS,RECOVERYPROTECTEDITEMS,NETWORKINTERFACE,BATCHACCOUNT,LOGICAPPS,DATAFACTORY,PUBLICIP,STREAMANALYTICS,EVENTGRID,LOADBALANCERS,SERVICEFABRICMESH,COGNITIVESEARCH,COGNITIVESERVICES,MLWORKSPACES,FRONTDOORS,KEYVAULT,RELAYNAMESPACES,NOTIFICATIONHUBS,APPSERVICEENVIRONMENT,TRAFFICMANAGER,SIGNALR,VIRTUALDESKTOP,SYNAPSEWORKSPACES,NETAPPPOOLS,DATABRICKS,LOGANALYTICSWORKSPACES,VIRTUALHUBS,VPNGATEWAYS,CDNPROFILE,POWERBIEMBEDDED,CONTAINERREGISTRY,NATGATEWAYS,BOTSERVICES,VIRTUALNETWORKS + False - - SubscriptionIds + + CollectorId - The Azure subscription IDs to test. + Specifies the collector ID to assign to the imported devices. This parameter is optional and can be used with the 'Import' parameter set. - String + Int32 - String + Int32 None - - GroupId + + AutoBalancedCollectorGroupId - The LogicMonitor group ID to associate with the Azure account. Defaults to -1. + Specifies the auto-balanced collector group ID to assign to the imported devices. This parameter is optional and can be used with the 'Import' parameter set. - String + Int32 - String + Int32 - -1 + None - - TenantId + + ProgressAction - The Azure Active Directory tenant ID. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - IsChinaAccount + + + Import-LMDevicesFromCSV + + GenerateExampleCSV - Indicates if this is an Azure China account. Defaults to $false. + Generates an example CSV file with sample device information. This parameter is optional and can be used with the 'Sample' parameter set. - String - String + SwitchParameter False @@ -29853,10 +32720,10 @@ Invoke-LMAWSAccountTest -ExternalId "123456" -AccountId "987654" -AssumedRoleARN - - ClientId + + FilePath - The Azure Active Directory application client ID. + Specifies the path to the CSV file containing the device information. This parameter is mandatory when the 'Import' parameter set is used. String @@ -29865,77 +32732,150 @@ Invoke-LMAWSAccountTest -ExternalId "123456" -AccountId "987654" -AssumedRoleARN None - - SecretKey + + GenerateExampleCSV - The Azure Active Directory application secret key. + Generates an example CSV file with sample device information. This parameter is optional and can be used with the 'Sample' parameter set. - String + SwitchParameter - String + SwitchParameter - None + False - - CheckedServices + + PassThru - The list of Azure services to test. Defaults to all supported services. + Indicates whether to return the imported devices as output. This parameter is optional and can be used with the 'Import' parameter set. - String + SwitchParameter - String + SwitchParameter - VIRTUALMACHINE,SQLDATABASE,APPSERVICE,EVENTHUB,REDISCACHE,REDISCACHEENTERPRISE,VIRTUALMACHINESCALESET,VIRTUALMACHINESCALESETVM,APPLICATIONGATEWAY,IOTHUB,FUNCTION,SERVICEBUS,MARIADB,MYSQL,MYSQLFLEXIBLE,POSTGRESQL,POSTGRESQLFLEXIBLE,POSTGRESQLCITUS,ANALYSISSERVICE,TABLESTORAGE,BLOBSTORAGE,FILESTORAGE,QUEUESTORAGE,STORAGEACCOUNT,APIMANAGEMENT,COSMOSDB,APPSERVICEPLAN,VIRTUALNETWORKGATEWAY,AUTOMATIONACCOUNT,EXPRESSROUTECIRCUIT,DATALAKEANALYTICS,DATALAKESTORE,APPLICATIONINSIGHTS,FIREWALL,SQLELASTICPOOL,SQLMANAGEDINSTANCE,HDINSIGHT,RECOVERYSERVICES,BACKUPPROTECTEDITEMS,RECOVERYPROTECTEDITEMS,NETWORKINTERFACE,BATCHACCOUNT,LOGICAPPS,DATAFACTORY,PUBLICIP,STREAMANALYTICS,EVENTGRID,LOADBALANCERS,SERVICEFABRICMESH,COGNITIVESEARCH,COGNITIVESERVICES,MLWORKSPACES,FRONTDOORS,KEYVAULT,RELAYNAMESPACES,NOTIFICATIONHUBS,APPSERVICEENVIRONMENT,TRAFFICMANAGER,SIGNALR,VIRTUALDESKTOP,SYNAPSEWORKSPACES,NETAPPPOOLS,DATABRICKS,LOGANALYTICSWORKSPACES,VIRTUALHUBS,VPNGATEWAYS,CDNPROFILE,POWERBIEMBEDDED,CONTAINERREGISTRY,NATGATEWAYS,BOTSERVICES,VIRTUALNETWORKS + False - - SubscriptionIds + + CollectorId - The Azure subscription IDs to test. + Specifies the collector ID to assign to the imported devices. This parameter is optional and can be used with the 'Import' parameter set. - String + Int32 - String + Int32 None - - GroupId + + AutoBalancedCollectorGroupId - The LogicMonitor group ID to associate with the Azure account. Defaults to -1. + Specifies the auto-balanced collector group ID to assign to the imported devices. This parameter is optional and can be used with the 'Import' parameter set. - String + Int32 - String + Int32 - -1 + None - - TenantId + + ProgressAction - The Azure Active Directory tenant ID. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - IsChinaAccount + + + + + + - This function requires valid API credentials to connect to LogicMonitor. + - The CSV file must have the following columns: ip, displayname, hostgroup. collectorid, collectorgroupid, description, property.name1, property.name2.. are optional. + - The function creates device groups if they don't exist based on the host group path specified in the CSV file. + - If the collector ID is not specified in the CSV file, the function uses the collector ID specified by the CollectorId parameter. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Import-LMDevicesFromCSV -FilePath "C:\Devices.csv" -CollectorId 1234 +Imports devices from the "Devices.csv" file located at "C:\Devices.csv" and assigns the collector with ID 1234 to the imported devices. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Import-LMDevicesFromCSV -GenerateExampleCSV +Generates an example CSV file named "SampleLMDeviceImportCSV.csv" in the current directory with sample device information. + + + + + + + + + + Import-LMExchangeModule + Import + LMExchangeModule + + Imports an LM Exchange module into LogicMonitor. + + + + The Import-LMExchangeModule function imports a specified LM Exchange module into your LogicMonitor portal. + + + + Import-LMExchangeModule + + LMExchangeId + + The ID of the LM Exchange module to import. This parameter is mandatory. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + LMExchangeId - Indicates if this is an Azure China account. Defaults to $false. + The ID of the LM Exchange module to import. This parameter is mandatory. String String - False + None ProgressAction @@ -29963,7 +32903,7 @@ Invoke-LMAWSAccountTest -ExternalId "123456" -AccountId "987654" -AssumedRoleARN - Returns test results for each Azure service. + Returns a success message if the import is successful. @@ -29978,8 +32918,8 @@ Invoke-LMAWSAccountTest -ExternalId "123456" -AccountId "987654" -AssumedRoleARN -------------------------- EXAMPLE 1 -------------------------- - #Test Azure account connectivity -Invoke-LMAzureAccountTest -ClientId "client-id" -SecretKey "secret-key" -TenantId "tenant-id" -SubscriptionIds "sub-id" + #Import an LM Exchange module +Import-LMExchangeModule -LMExchangeId "LM12345" @@ -29989,23 +32929,23 @@ Invoke-LMAzureAccountTest -ClientId "client-id" -SecretKey "secret-key" -TenantI - Invoke-LMAzureSubscriptionDiscovery - Invoke - LMAzureSubscriptionDiscovery + Import-LMLogicModule + Import + LMLogicModule - Discovers Azure subscriptions for a given tenant. + Imports a LogicModule into LogicMonitor. - The Invoke-LMAzureSubscriptionDiscovery function discovers available Azure subscriptions for a specified Azure tenant using provided credentials. + The Import-LMLogicModule function imports a LogicModule from a file path or file data. Supports various module types including datasource, propertyrules, eventsource, topologysource, configsource, logsource, functions, and oids. - Invoke-LMAzureSubscriptionDiscovery - - ClientId + Import-LMLogicModule + + FilePath - The Azure Active Directory application client ID. + The path to the file containing the LogicModule to import. String @@ -30014,40 +32954,79 @@ Invoke-LMAzureAccountTest -ClientId "client-id" -SecretKey "secret-key" -TenantI None - - SecretKey + + Type - The Azure Active Directory application secret key. + The type of LogicModule. Valid values are "datasource", "propertyrules", "eventsource", "topologysource", "configsource", "logsource", "functions", "oids". Defaults to "datasource". String String + Datasource + + + ForceOverwrite + + Whether to overwrite an existing LogicModule with the same name. Defaults to $false. + + Boolean + + Boolean + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + None - - TenantId + + + Import-LMLogicModule + + File - The Azure Active Directory tenant ID. + The file data of the LogicModule to import. - String + Object - String + Object None - - IsChinaAccount + + Type - Indicates if this is an Azure China account. Defaults to $false. + The type of LogicModule. Valid values are "datasource", "propertyrules", "eventsource", "topologysource", "configsource", "logsource", "functions", "oids". Defaults to "datasource". String String + Datasource + + + ForceOverwrite + + Whether to overwrite an existing LogicModule with the same name. Defaults to $false. + + Boolean + + Boolean + + False @@ -30065,10 +33044,10 @@ Invoke-LMAzureAccountTest -ClientId "client-id" -SecretKey "secret-key" -TenantI - - ClientId + + FilePath - The Azure Active Directory application client ID. + The path to the file containing the LogicModule to import. String @@ -30077,38 +33056,38 @@ Invoke-LMAzureAccountTest -ClientId "client-id" -SecretKey "secret-key" -TenantI None - - SecretKey + + File - The Azure Active Directory application secret key. + The file data of the LogicModule to import. - String + Object - String + Object None - - TenantId + + Type - The Azure Active Directory tenant ID. + The type of LogicModule. Valid values are "datasource", "propertyrules", "eventsource", "topologysource", "configsource", "logsource", "functions", "oids". Defaults to "datasource". String String - None + Datasource - - IsChinaAccount + + ForceOverwrite - Indicates if this is an Azure China account. Defaults to $false. + Whether to overwrite an existing LogicModule with the same name. Defaults to $false. - String + Boolean - String + Boolean False @@ -30139,7 +33118,7 @@ Invoke-LMAzureAccountTest -ClientId "client-id" -SecretKey "secret-key" -TenantI - Returns a list of discovered Azure subscriptions. + Returns a success message if the import is successful. @@ -30148,14 +33127,22 @@ Invoke-LMAzureAccountTest -ClientId "client-id" -SecretKey "secret-key" -TenantI - You must run Connect-LMAccount before running this command. + You must run Connect-LMAccount before running this command. Requires PowerShell version 6.1 or higher. -------------------------- EXAMPLE 1 -------------------------- - #Discover Azure subscriptions -Invoke-LMAzureSubscriptionDiscovery -ClientId "client-id" -SecretKey "secret-key" -TenantId "tenant-id" + #Import a datasource module +Import-LMLogicModule -FilePath "C:\LogicModules\datasource.xml" -Type "datasource" -ForceOverwrite $true + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Import a property rules module +Import-LMLogicModule -File $fileData -Type "propertyrules" @@ -30165,23 +33152,23 @@ Invoke-LMAzureSubscriptionDiscovery -ClientId "client-id" -SecretKey "secret-key - Invoke-LMCloudGroupNetScan - Invoke - LMCloudGroupNetScan + Import-LMRepositoryLogicModule + Import + LMRepositoryLogicModule - Invokes a NetScan task for a cloud device group. + Imports LogicMonitor repository logic modules. - The Invoke-LMCloudGroupNetScan function schedules a NetScan task for a specified cloud device group (AWS, Azure, or GCP) in LogicMonitor. + The Import-LMRepositoryLogicModule function imports specified logic modules from the LogicMonitor repository into your portal. - Invoke-LMCloudGroupNetScan - - Id + Import-LMRepositoryLogicModule + + Type - The ID of the cloud device group. Required for GroupId parameter set. + The type of logic modules to import. Valid values are "datasources", "propertyrules", "eventsources", "topologysources", "configsources". String @@ -30190,29 +33177,14 @@ Invoke-LMAzureSubscriptionDiscovery -ClientId "client-id" -SecretKey "secret-key None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Invoke-LMCloudGroupNetScan - - Name + + LogicModuleNames - The name of the cloud device group. Required for GroupName parameter set. + An array of logic module names to import. - String + String[] - String + String[] None @@ -30232,10 +33204,10 @@ Invoke-LMAzureSubscriptionDiscovery -ClientId "client-id" -SecretKey "secret-key - - Id + + Type - The ID of the cloud device group. Required for GroupId parameter set. + The type of logic modules to import. Valid values are "datasources", "propertyrules", "eventsources", "topologysources", "configsources". String @@ -30244,14 +33216,14 @@ Invoke-LMAzureSubscriptionDiscovery -ClientId "client-id" -SecretKey "secret-key None - - Name + + LogicModuleNames - The name of the cloud device group. Required for GroupName parameter set. + An array of logic module names to import. - String + String[] - String + String[] None @@ -30282,7 +33254,7 @@ Invoke-LMAzureSubscriptionDiscovery -ClientId "client-id" -SecretKey "secret-key - Returns a success message if the task is scheduled successfully. + Returns a success message with the names of imported modules. @@ -30291,22 +33263,14 @@ Invoke-LMAzureSubscriptionDiscovery -ClientId "client-id" -SecretKey "secret-key - You must run Connect-LMAccount before running this command. The target group must be a cloud group (AWS, Azure, or GCP). + You must run Connect-LMAccount before running this command. -------------------------- EXAMPLE 1 -------------------------- - #Run NetScan on a cloud group by ID -Invoke-LMCloudGroupNetScan -Id "12345" - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Run NetScan on a cloud group by name -Invoke-LMCloudGroupNetScan -Name "AWS-Production" + #Import specific datasources +Import-LMRepositoryLogicModule -Type "datasources" -LogicModuleNames "DataSource1", "DataSource2" @@ -30316,23 +33280,23 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" - Invoke-LMCollectorDebugCommand + Invoke-LMActiveDiscovery Invoke - LMCollectorDebugCommand + LMActiveDiscovery - Executes debug commands on a LogicMonitor collector. + Invokes an active discovery task for LogicMonitor devices. - The Invoke-LMCollectorDebugCommand function allows execution of debug, PowerShell, or Groovy commands on a specified LogicMonitor collector. + The Invoke-LMActiveDiscovery function schedules an active discovery task for LogicMonitor devices. It can target individual devices or device groups using either ID or name. - Invoke-LMCollectorDebugCommand - + Invoke-LMActiveDiscovery + Id - The ID of the collector. Required for Id parameter sets. + The ID of the device to run active discovery on. Required for Id parameter set. Int32 @@ -30341,22 +33305,25 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" 0 - - GroovyCommand + + ProgressAction - The Groovy command to execute. Required for Groovy parameter sets. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - CommandHostName - - The hostname context for the command execution. + + + Invoke-LMActiveDiscovery + + Name + + The name of the device to run active discovery on. Required for Name parameter set. String @@ -30365,28 +33332,32 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - - CommandWildValue + + ProgressAction - The wild value context for the command execution. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - IncludeResult + + + Invoke-LMActiveDiscovery + + GroupId - Switch to wait for and include command execution results. + The ID of the device group to run active discovery on. Required for GroupId parameter set. + String - SwitchParameter + String - False + None ProgressAction @@ -30402,35 +33373,159 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" - Invoke-LMCollectorDebugCommand + Invoke-LMActiveDiscovery - Id + GroupName - The ID of the collector. Required for Id parameter sets. + The name of the device group to run active discovery on. Required for GroupName parameter set. - Int32 + String - Int32 + String - 0 + None - - PoshCommand + + ProgressAction - The PowerShell command to execute. Required for Posh parameter sets. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - CommandHostName + + + + + Id + + The ID of the device to run active discovery on. Required for Id parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the device to run active discovery on. Required for Name parameter set. + + String + + String + + + None + + + GroupId + + The ID of the device group to run active discovery on. Required for GroupId parameter set. + + String + + String + + + None + + + GroupName + + The name of the device group to run active discovery on. Required for GroupName parameter set. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns a success message if the task is scheduled successfully. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Run active discovery on a device by ID +Invoke-LMActiveDiscovery -Id 12345 + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Run active discovery on a device group by name +Invoke-LMActiveDiscovery -GroupName "Production-Servers" + + + + + + + + + + Invoke-LMAPIRequest + Invoke + LMAPIRequest + + Executes a custom LogicMonitor API request with full control over endpoint and payload. + + + + The Invoke-LMAPIRequest function provides advanced users with direct access to the LogicMonitor API while leveraging the module's authentication, retry logic, debug utilities, and error handling. This is useful for accessing API endpoints that don't yet have dedicated cmdlets in the module. + + + + Invoke-LMAPIRequest + + ResourcePath - The hostname context for the command execution. + The API resource path (e.g., "/device/devices", "/setting/integrations/123"). Do not include the base URL or query parameters here. String @@ -30439,10 +33534,10 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - - CommandWildValue + + Method - The wild value context for the command execution. + The HTTP method to use. Valid values: GET, POST, PATCH, PUT, DELETE. String @@ -30452,83 +33547,69 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - IncludeResult + QueryParams - Switch to wait for and include command execution results. + Optional hashtable of query parameters to append to the request URL. Example: @{ size = 100; offset = 0; filter = 'name:"test"' } + Hashtable - SwitchParameter + Hashtable - False + None - - ProgressAction + + Data - {{ Fill ProgressAction Description }} + Optional hashtable containing the request body data. Will be automatically converted to JSON. Use this for POST, PATCH, and PUT requests. - ActionPreference + Hashtable - ActionPreference + Hashtable None - - - Invoke-LMCollectorDebugCommand - - Id + + Version - The ID of the collector. Required for Id parameter sets. + The X-Version header value for the API request. Defaults to 3. Some newer API endpoints may require different version numbers. Int32 Int32 - 0 - - - DebugCommand - - The debug command to execute. Required for Debug parameter sets. - - String - - String - - - None + 3 - CommandHostName + ContentType - The hostname context for the command execution. + The Content-Type header for the request. Defaults to "application/json". String String - None + application/json - CommandWildValue + MaxRetries - The wild value context for the command execution. + Maximum number of retry attempts for transient errors. Defaults to 3. Set to 0 to disable retries. - String + Int32 - String + Int32 - None + 3 - IncludeResult + NoRetry - Switch to wait for and include command execution results. + Switch to completely disable retry logic and fail immediately on any error. SwitchParameter @@ -30536,25 +33617,10 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" False - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Invoke-LMCollectorDebugCommand - - Name + + OutFile - The name of the collector. Required for Name parameter sets. + Path to save the response content to a file. Useful for downloading reports or exports. String @@ -30563,10 +33629,10 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - - GroovyCommand + + TypeName - The Groovy command to execute. Required for Groovy parameter sets. + Optional type name to add to the returned objects (e.g., "LogicMonitor.CustomResource"). This enables proper formatting if you have custom format definitions. String @@ -30576,33 +33642,31 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - CommandHostName + AsHashtable - The hostname context for the command execution. + Switch to return the response as a hashtable instead of a PSCustomObject. - String - String + SwitchParameter - None + False - - CommandWildValue + + WhatIf - The wild value context for the command execution. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - IncludeResult + + Confirm - Switch to wait for and include command execution results. + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -30624,11 +33688,11 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" - Invoke-LMCollectorDebugCommand + Invoke-LMAPIRequest - Name + ResourcePath - The name of the collector. Required for Name parameter sets. + The API resource path (e.g., "/device/devices", "/setting/integrations/123"). Do not include the base URL or query parameters here. String @@ -30638,9 +33702,9 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - PoshCommand + Method - The PowerShell command to execute. Required for Posh parameter sets. + The HTTP method to use. Valid values: GET, POST, PATCH, PUT, DELETE. String @@ -30650,21 +33714,21 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - CommandHostName + QueryParams - The hostname context for the command execution. + Optional hashtable of query parameters to append to the request URL. Example: @{ size = 100; offset = 0; filter = 'name:"test"' } - String + Hashtable - String + Hashtable None - CommandWildValue + RawBody - The wild value context for the command execution. + Optional raw string body to send with the request. Use this instead of -Data when you need complete control over the request body format. Mutually exclusive with -Data. String @@ -30674,59 +33738,56 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - IncludeResult + Version - Switch to wait for and include command execution results. + The X-Version header value for the API request. Defaults to 3. Some newer API endpoints may require different version numbers. + Int32 - SwitchParameter + Int32 - False + 3 - - ProgressAction + + ContentType - {{ Fill ProgressAction Description }} + The Content-Type header for the request. Defaults to "application/json". - ActionPreference + String - ActionPreference + String - None + application/json - - - Invoke-LMCollectorDebugCommand - - Name + + MaxRetries - The name of the collector. Required for Name parameter sets. + Maximum number of retry attempts for transient errors. Defaults to 3. Set to 0 to disable retries. - String + Int32 - String + Int32 - None + 3 - - DebugCommand + + NoRetry - The debug command to execute. Required for Debug parameter sets. + Switch to completely disable retry logic and fail immediately on any error. - String - String + SwitchParameter - None + False - CommandHostName + OutFile - The hostname context for the command execution. + Path to save the response content to a file. Useful for downloading reports or exports. String @@ -30736,9 +33797,9 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - CommandWildValue + TypeName - The wild value context for the command execution. + Optional type name to add to the returned objects (e.g., "LogicMonitor.CustomResource"). This enables proper formatting if you have custom format definitions. String @@ -30748,9 +33809,31 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - IncludeResult + AsHashtable - Switch to wait for and include command execution results. + Switch to return the response as a hashtable instead of a PSCustomObject. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -30774,21 +33857,21 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" - Id + ResourcePath - The ID of the collector. Required for Id parameter sets. + The API resource path (e.g., "/device/devices", "/setting/integrations/123"). Do not include the base URL or query parameters here. - Int32 + String - Int32 + String - 0 + None - Name + Method - The name of the collector. Required for Name parameter sets. + The HTTP method to use. Valid values: GET, POST, PATCH, PUT, DELETE. String @@ -30797,22 +33880,34 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - - DebugCommand + + QueryParams - The debug command to execute. Required for Debug parameter sets. + Optional hashtable of query parameters to append to the request URL. Example: @{ size = 100; offset = 0; filter = 'name:"test"' } - String + Hashtable - String + Hashtable None - - PoshCommand + + Data - The PowerShell command to execute. Required for Posh parameter sets. + Optional hashtable containing the request body data. Will be automatically converted to JSON. Use this for POST, PATCH, and PUT requests. + + Hashtable + + Hashtable + + + None + + + RawBody + + Optional raw string body to send with the request. Use this instead of -Data when you need complete control over the request body format. Mutually exclusive with -Data. String @@ -30821,22 +33916,58 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - - GroovyCommand + + Version - The Groovy command to execute. Required for Groovy parameter sets. + The X-Version header value for the API request. Defaults to 3. Some newer API endpoints may require different version numbers. + + Int32 + + Int32 + + + 3 + + + ContentType + + The Content-Type header for the request. Defaults to "application/json". String String - None + application/json - CommandHostName + MaxRetries - The hostname context for the command execution. + Maximum number of retry attempts for transient errors. Defaults to 3. Set to 0 to disable retries. + + Int32 + + Int32 + + + 3 + + + NoRetry + + Switch to completely disable retry logic and fail immediately on any error. + + SwitchParameter + + SwitchParameter + + + False + + + OutFile + + Path to save the response content to a file. Useful for downloading reports or exports. String @@ -30846,9 +33977,9 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - CommandWildValue + TypeName - The wild value context for the command execution. + Optional type name to add to the returned objects (e.g., "LogicMonitor.CustomResource"). This enables proper formatting if you have custom format definitions. String @@ -30858,9 +33989,33 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" None - IncludeResult + AsHashtable - Switch to wait for and include command execution results. + Switch to return the response as a hashtable instead of a PSCustomObject. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -30885,67 +34040,139 @@ Invoke-LMCloudGroupNetScan -Name "AWS-Production" - None. You cannot pipe objects to this command. + None - + You cannot pipe objects to this command. - Returns command execution results if IncludeResult is specified. + System.Object - + Returns the API response as a PSCustomObject by default, or as specified by -AsHashtable. You must run Connect-LMAccount before running this command. + This cmdlet is designed for advanced users who need to: - Access API endpoints not yet covered by dedicated cmdlets + - Test new API features or beta endpoints + - Implement custom workflows requiring direct API access + - Prototype new functionality before requesting cmdlet additions + + For standard operations, use the dedicated cmdlets (Get-LMDevice, New-LMDevice, etc.) as they provide better parameter validation, documentation, and user experience. -------------------------- EXAMPLE 1 -------------------------- - #Execute a debug command -Invoke-LMCollectorDebugCommand -Id 123 -DebugCommand "!account" -IncludeResult + Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method GET - + Get a custom resource not yet supported by a dedicated cmdlet. -------------------------- EXAMPLE 2 -------------------------- - #Execute a PowerShell command -Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" + $data = @{ + name = "My Integration" + type = "slack" + url = "https://hooks.slack.com/services/..." +} +Invoke-LMAPIRequest -ResourcePath "/setting/integrations" -Method POST -Data $data - + Create a resource with custom payload. + + + + -------------------------- EXAMPLE 3 -------------------------- + $updates = @{ + description = "Updated description" +} +Invoke-LMAPIRequest -ResourcePath "/device/devices/123" -Method PATCH -Data $updates + + Update a resource with PATCH. + + + + -------------------------- EXAMPLE 4 -------------------------- + Invoke-LMAPIRequest -ResourcePath "/setting/integrations/456" -Method DELETE + + Delete a resource. + + + + -------------------------- EXAMPLE 5 -------------------------- + $queryParams = @{ + size = 500 + filter = 'status:"active"' + fields = "id,name,status" +} +Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams $queryParams -Version 3 + + Get with query parameters and custom version. + + + + -------------------------- EXAMPLE 6 -------------------------- + $rawJson = '{"name":"test","customField":null}' +Invoke-LMAPIRequest -ResourcePath "/custom/endpoint" -Method POST -RawBody $rawJson + + Use raw body for special formatting requirements. + + + + -------------------------- EXAMPLE 7 -------------------------- + Invoke-LMAPIRequest -ResourcePath "/report/reports/123/download" -Method GET -OutFile "C:\Reports\report.pdf" + + Download a report to file. + + + + -------------------------- EXAMPLE 8 -------------------------- + $offset = 0 +$size = 1000 +$allResults = @() +do { + $response = Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams @{ size = $size; offset = $offset } + $allResults += $response.items + $offset += $size +} while ($allResults.Count -lt $response.total) + + Get paginated results manually. - + + + Module Documentation + https://logicmonitor.github.io/lm-powershell-module-docs/ + + - Invoke-LMDeviceConfigSourceCollection + Invoke-LMAWSAccountTest Invoke - LMDeviceConfigSourceCollection + LMAWSAccountTest - Invokes configuration collection for a device datasource. + Tests AWS account connectivity in LogicMonitor. - The Invoke-LMDeviceConfigSourceCollection function triggers configuration collection for a specified device datasource instance. + The Invoke-LMAWSAccountTest function tests the connection and permissions for an AWS account in LogicMonitor. It verifies access to specified AWS services. - Invoke-LMDeviceConfigSourceCollection - - DatasourceName + Invoke-LMAWSAccountTest + + ExternalId - The name of the datasource. Required for dsName parameter sets. + The external ID for AWS cross-account access. String @@ -30954,10 +34181,10 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" None - - Name + + AccountId - The name of the device. Required for Name parameter sets. + The AWS account ID. String @@ -30966,10 +34193,10 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" None - - InstanceId + + AssumedRoleARN - The ID of the datasource instance. + The ARN of the IAM role to be assumed. String @@ -30978,56 +34205,29 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Invoke-LMDeviceConfigSourceCollection - - DatasourceName + + CheckedServices - The name of the datasource. Required for dsName parameter sets. + The list of AWS services to test. Defaults to all supported services. String String - None - - - Id - - The ID of the device. Required for Id parameter sets. - - Int32 - - Int32 - - - 0 + DYNAMODB,EBS,EC2,AUTOSCALING,BACKUP,BACKUPPROTECTEDRESOURCE,TRANSFER,ELASTICACHE,ELB,RDS,REDSHIFT,S3,SNS,SQS,EMR,KINESIS,ROUTE53,ROUTE53HOSTEDZONE,CLOUDSEARCH,LAMBDA,ECR,ECS,ELASTICSEARCH,EFS,SWFWORKFLOW,SWFACTIVITY,APPLICATIONELB,CLOUDFRONT,APIGATEWAY,APIGATEWAYV2,SES,VPN,FIREHOSE,KINESISVIDEO,WORKSPACE,NETWORKELB,NATGATEWAY,DIRECTCONNECT,DIRECTCONNECT_VIRTUALINTERFACE,WORKSPACEDIRECTORY,ELASTICBEANSTALK,DMSREPLICATION,MSKCLUSTER,MSKBROKER,FSX,TRANSITGATEWAY,GLUE,APPSTREAM,MQ,ATHENA,DBCLUSTER,DOCDB,STEPFUNCTIONS,OPSWORKS,CODEBUILD,SAGEMAKER,ROUTE53RESOLVER,DMSREPLICATIONTASKS,EVENTBRIDGE,MEDIACONNECT,MEDIAPACKAGELIVE,MEDIASTORE,MEDIAPACKAGEVOD,MEDIATAILOR,MEDIACONVERT,ELASTICTRANSCODER,COGNITO,TRANSITGATEWAYATTACHMENT,QUICKSIGHT_DASHBOARDS,QUICKSIGHT_DATASETS,PRIVATELINK_ENDPOINTS,PRIVATELINK_SERVICES,GLOBAL_NETWORKS - - InstanceId + + GroupId - The ID of the datasource instance. + The LogicMonitor group ID to associate with the AWS account. Defaults to -1. String String - None + -1 ProgressAction @@ -31042,36 +34242,137 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process"None + + + + ExternalId + + The external ID for AWS cross-account access. + + String + + String + + + None + + + AccountId + + The AWS account ID. + + String + + String + + + None + + + AssumedRoleARN + + The ARN of the IAM role to be assumed. + + String + + String + + + None + + + CheckedServices + + The list of AWS services to test. Defaults to all supported services. + + String + + String + + + DYNAMODB,EBS,EC2,AUTOSCALING,BACKUP,BACKUPPROTECTEDRESOURCE,TRANSFER,ELASTICACHE,ELB,RDS,REDSHIFT,S3,SNS,SQS,EMR,KINESIS,ROUTE53,ROUTE53HOSTEDZONE,CLOUDSEARCH,LAMBDA,ECR,ECS,ELASTICSEARCH,EFS,SWFWORKFLOW,SWFACTIVITY,APPLICATIONELB,CLOUDFRONT,APIGATEWAY,APIGATEWAYV2,SES,VPN,FIREHOSE,KINESISVIDEO,WORKSPACE,NETWORKELB,NATGATEWAY,DIRECTCONNECT,DIRECTCONNECT_VIRTUALINTERFACE,WORKSPACEDIRECTORY,ELASTICBEANSTALK,DMSREPLICATION,MSKCLUSTER,MSKBROKER,FSX,TRANSITGATEWAY,GLUE,APPSTREAM,MQ,ATHENA,DBCLUSTER,DOCDB,STEPFUNCTIONS,OPSWORKS,CODEBUILD,SAGEMAKER,ROUTE53RESOLVER,DMSREPLICATIONTASKS,EVENTBRIDGE,MEDIACONNECT,MEDIAPACKAGELIVE,MEDIASTORE,MEDIAPACKAGEVOD,MEDIATAILOR,MEDIACONVERT,ELASTICTRANSCODER,COGNITO,TRANSITGATEWAYATTACHMENT,QUICKSIGHT_DASHBOARDS,QUICKSIGHT_DATASETS,PRIVATELINK_ENDPOINTS,PRIVATELINK_SERVICES,GLOBAL_NETWORKS + + + GroupId + + The LogicMonitor group ID to associate with the AWS account. Defaults to -1. + + String + + String + + + -1 + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns test results for each AWS service. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Test AWS account connectivity +Invoke-LMAWSAccountTest -ExternalId "123456" -AccountId "987654" -AssumedRoleARN "arn:aws:iam::123456789012:role/MyRole" + + + + + + + + + + Invoke-LMAzureAccountTest + Invoke + LMAzureAccountTest + + Tests Azure account connectivity in LogicMonitor. + + + + The Invoke-LMAzureAccountTest function tests the connection and permissions for an Azure account in LogicMonitor. It verifies access to specified Azure services. + + - Invoke-LMDeviceConfigSourceCollection - - DatasourceId - - The ID of the datasource. Required for dsId parameter sets. - - Int32 - - Int32 - - - 0 - - - Name - - The name of the device. Required for Name parameter sets. - - String - - String - - - None - - - InstanceId + Invoke-LMAzureAccountTest + + ClientId - The ID of the datasource instance. + The Azure Active Directory application client ID. String @@ -31080,49 +34381,10 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Invoke-LMDeviceConfigSourceCollection - - DatasourceId - - The ID of the datasource. Required for dsId parameter sets. - - Int32 - - Int32 - - - 0 - - - Id - - The ID of the device. Required for Id parameter sets. - - Int32 - - Int32 - - - 0 - - - InstanceId + + SecretKey - The ID of the datasource instance. + The Azure Active Directory application secret key. String @@ -31131,49 +34393,22 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Invoke-LMDeviceConfigSourceCollection - - Id - - The ID of the device. Required for Id parameter sets. - - Int32 - - Int32 - - - 0 - - - HdsId + + CheckedServices - The host datasource ID. Required for HdsId parameter sets. + The list of Azure services to test. Defaults to all supported services. String String - None + VIRTUALMACHINE,SQLDATABASE,APPSERVICE,EVENTHUB,REDISCACHE,REDISCACHEENTERPRISE,VIRTUALMACHINESCALESET,VIRTUALMACHINESCALESETVM,APPLICATIONGATEWAY,IOTHUB,FUNCTION,SERVICEBUS,MARIADB,MYSQL,MYSQLFLEXIBLE,POSTGRESQL,POSTGRESQLFLEXIBLE,POSTGRESQLCITUS,ANALYSISSERVICE,TABLESTORAGE,BLOBSTORAGE,FILESTORAGE,QUEUESTORAGE,STORAGEACCOUNT,APIMANAGEMENT,COSMOSDB,APPSERVICEPLAN,VIRTUALNETWORKGATEWAY,AUTOMATIONACCOUNT,EXPRESSROUTECIRCUIT,DATALAKEANALYTICS,DATALAKESTORE,APPLICATIONINSIGHTS,FIREWALL,SQLELASTICPOOL,SQLMANAGEDINSTANCE,HDINSIGHT,RECOVERYSERVICES,BACKUPPROTECTEDITEMS,RECOVERYPROTECTEDITEMS,NETWORKINTERFACE,BATCHACCOUNT,LOGICAPPS,DATAFACTORY,PUBLICIP,STREAMANALYTICS,EVENTGRID,LOADBALANCERS,SERVICEFABRICMESH,COGNITIVESEARCH,COGNITIVESERVICES,MLWORKSPACES,FRONTDOORS,KEYVAULT,RELAYNAMESPACES,NOTIFICATIONHUBS,APPSERVICEENVIRONMENT,TRAFFICMANAGER,SIGNALR,VIRTUALDESKTOP,SYNAPSEWORKSPACES,NETAPPPOOLS,DATABRICKS,LOGANALYTICSWORKSPACES,VIRTUALHUBS,VPNGATEWAYS,CDNPROFILE,POWERBIEMBEDDED,CONTAINERREGISTRY,NATGATEWAYS,BOTSERVICES,VIRTUALNETWORKS - - InstanceId + + SubscriptionIds - The ID of the datasource instance. + The Azure subscription IDs to test. String @@ -31182,37 +34417,22 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Invoke-LMDeviceConfigSourceCollection - - Name + + GroupId - The name of the device. Required for Name parameter sets. + The LogicMonitor group ID to associate with the Azure account. Defaults to -1. String String - None + -1 - - HdsId + + TenantId - The host datasource ID. Required for HdsId parameter sets. + The Azure Active Directory tenant ID. String @@ -31221,17 +34441,17 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" None - - InstanceId + + IsChinaAccount - The ID of the datasource instance. + Indicates if this is an Azure China account. Defaults to $false. String String - None + False ProgressAction @@ -31248,10 +34468,10 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" - - DatasourceName + + ClientId - The name of the datasource. Required for dsName parameter sets. + The Azure Active Directory application client ID. String @@ -31260,34 +34480,34 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" None - - DatasourceId + + SecretKey - The ID of the datasource. Required for dsId parameter sets. + The Azure Active Directory application secret key. - Int32 + String - Int32 + String - 0 + None - - Id + + CheckedServices - The ID of the device. Required for Id parameter sets. + The list of Azure services to test. Defaults to all supported services. - Int32 + String - Int32 + String - 0 + VIRTUALMACHINE,SQLDATABASE,APPSERVICE,EVENTHUB,REDISCACHE,REDISCACHEENTERPRISE,VIRTUALMACHINESCALESET,VIRTUALMACHINESCALESETVM,APPLICATIONGATEWAY,IOTHUB,FUNCTION,SERVICEBUS,MARIADB,MYSQL,MYSQLFLEXIBLE,POSTGRESQL,POSTGRESQLFLEXIBLE,POSTGRESQLCITUS,ANALYSISSERVICE,TABLESTORAGE,BLOBSTORAGE,FILESTORAGE,QUEUESTORAGE,STORAGEACCOUNT,APIMANAGEMENT,COSMOSDB,APPSERVICEPLAN,VIRTUALNETWORKGATEWAY,AUTOMATIONACCOUNT,EXPRESSROUTECIRCUIT,DATALAKEANALYTICS,DATALAKESTORE,APPLICATIONINSIGHTS,FIREWALL,SQLELASTICPOOL,SQLMANAGEDINSTANCE,HDINSIGHT,RECOVERYSERVICES,BACKUPPROTECTEDITEMS,RECOVERYPROTECTEDITEMS,NETWORKINTERFACE,BATCHACCOUNT,LOGICAPPS,DATAFACTORY,PUBLICIP,STREAMANALYTICS,EVENTGRID,LOADBALANCERS,SERVICEFABRICMESH,COGNITIVESEARCH,COGNITIVESERVICES,MLWORKSPACES,FRONTDOORS,KEYVAULT,RELAYNAMESPACES,NOTIFICATIONHUBS,APPSERVICEENVIRONMENT,TRAFFICMANAGER,SIGNALR,VIRTUALDESKTOP,SYNAPSEWORKSPACES,NETAPPPOOLS,DATABRICKS,LOGANALYTICSWORKSPACES,VIRTUALHUBS,VPNGATEWAYS,CDNPROFILE,POWERBIEMBEDDED,CONTAINERREGISTRY,NATGATEWAYS,BOTSERVICES,VIRTUALNETWORKS - - Name + + SubscriptionIds - The name of the device. Required for Name parameter sets. + The Azure subscription IDs to test. String @@ -31296,22 +34516,22 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" None - - HdsId + + GroupId - The host datasource ID. Required for HdsId parameter sets. + The LogicMonitor group ID to associate with the Azure account. Defaults to -1. String String - None + -1 - - InstanceId + + TenantId - The ID of the datasource instance. + The Azure Active Directory tenant ID. String @@ -31320,6 +34540,18 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" None + + IsChinaAccount + + Indicates if this is an Azure China account. Defaults to $false. + + String + + String + + + False + ProgressAction @@ -31346,7 +34578,7 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" - Returns a success message if the collection is scheduled successfully. + Returns test results for each Azure service. @@ -31361,16 +34593,8 @@ Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" -------------------------- EXAMPLE 1 -------------------------- - #Collect config using datasource name -Invoke-LMDeviceConfigSourceCollection -Name "Device1" -DatasourceName "Config" -InstanceId "123" - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Collect config using datasource ID -Invoke-LMDeviceConfigSourceCollection -Id 456 -DatasourceId 789 -InstanceId "123" + #Test Azure account connectivity +Invoke-LMAzureAccountTest -ClientId "client-id" -SecretKey "secret-key" -TenantId "tenant-id" -SubscriptionIds "sub-id" @@ -31380,23 +34604,23 @@ Invoke-LMDeviceConfigSourceCollection -Id 456 -DatasourceId 789 -InstanceId "123 - Invoke-LMGCPAccountTest + Invoke-LMAzureSubscriptionDiscovery Invoke - LMGCPAccountTest + LMAzureSubscriptionDiscovery - Tests GCP account connectivity in LogicMonitor. + Discovers Azure subscriptions for a given tenant. - The Invoke-LMGCPAccountTest function tests the connection and permissions for a Google Cloud Platform account in LogicMonitor. + The Invoke-LMAzureSubscriptionDiscovery function discovers available Azure subscriptions for a specified Azure tenant using provided credentials. - Invoke-LMGCPAccountTest + Invoke-LMAzureSubscriptionDiscovery - ServiceAccountKey + ClientId - The GCP service account key JSON. + The Azure Active Directory application client ID. String @@ -31406,9 +34630,9 @@ Invoke-LMDeviceConfigSourceCollection -Id 456 -DatasourceId 789 -InstanceId "123 None - ProjectId + SecretKey - The GCP project ID. + The Azure Active Directory application secret key. String @@ -31417,29 +34641,29 @@ Invoke-LMDeviceConfigSourceCollection -Id 456 -DatasourceId 789 -InstanceId "123 None - - CheckedServices + + TenantId - The list of GCP services to test. Defaults to all supported services. + The Azure Active Directory tenant ID. String String - CLOUDRUN,CLOUDDNS,REGIONALHTTPSLOADBALANCER,COMPUTEENGINEAUTOSCALER,COMPUTEENGINE,CLOUDIOT,CLOUDROUTER,CLOUDTASKS,VPNGATEWAY,CLOUDREDIS,CLOUDCOMPOSER,INTERCONNECTATTACHMENT,CLOUDFUNCTION,CLOUDBIGTABLE,CLOUDFILESTORE,CLOUDPUBSUB,CLOUDTRACE,CLOUDSTORAGE,CLOUDDATAPROC,CLOUDINTERCONNECT,CLOUDAIPLATFORM,CLOUDSQL,MANAGEDSERVICEFORMICROSOFTAD,CLOUDFIRESTORE,CLOUDDATAFLOW,CLOUDTPU,CLOUDDLP,APPENGINE,HTTPSLOADBALANCER,CLOUDSPANNER + None - GroupId + IsChinaAccount - The LogicMonitor group ID to associate with the GCP account. Defaults to -1. + Indicates if this is an Azure China account. Defaults to $false. String String - -1 + False ProgressAction @@ -31457,9 +34681,9 @@ Invoke-LMDeviceConfigSourceCollection -Id 456 -DatasourceId 789 -InstanceId "123 - ServiceAccountKey + ClientId - The GCP service account key JSON. + The Azure Active Directory application client ID. String @@ -31469,9 +34693,9 @@ Invoke-LMDeviceConfigSourceCollection -Id 456 -DatasourceId 789 -InstanceId "123 None - ProjectId + SecretKey - The GCP project ID. + The Azure Active Directory application secret key. String @@ -31480,29 +34704,29 @@ Invoke-LMDeviceConfigSourceCollection -Id 456 -DatasourceId 789 -InstanceId "123 None - - CheckedServices + + TenantId - The list of GCP services to test. Defaults to all supported services. + The Azure Active Directory tenant ID. String String - CLOUDRUN,CLOUDDNS,REGIONALHTTPSLOADBALANCER,COMPUTEENGINEAUTOSCALER,COMPUTEENGINE,CLOUDIOT,CLOUDROUTER,CLOUDTASKS,VPNGATEWAY,CLOUDREDIS,CLOUDCOMPOSER,INTERCONNECTATTACHMENT,CLOUDFUNCTION,CLOUDBIGTABLE,CLOUDFILESTORE,CLOUDPUBSUB,CLOUDTRACE,CLOUDSTORAGE,CLOUDDATAPROC,CLOUDINTERCONNECT,CLOUDAIPLATFORM,CLOUDSQL,MANAGEDSERVICEFORMICROSOFTAD,CLOUDFIRESTORE,CLOUDDATAFLOW,CLOUDTPU,CLOUDDLP,APPENGINE,HTTPSLOADBALANCER,CLOUDSPANNER + None - GroupId + IsChinaAccount - The LogicMonitor group ID to associate with the GCP account. Defaults to -1. + Indicates if this is an Azure China account. Defaults to $false. String String - -1 + False ProgressAction @@ -31530,7 +34754,7 @@ Invoke-LMDeviceConfigSourceCollection -Id 456 -DatasourceId 789 -InstanceId "123 - Returns test results for each GCP service. + Returns a list of discovered Azure subscriptions. @@ -31545,8 +34769,8 @@ Invoke-LMDeviceConfigSourceCollection -Id 456 -DatasourceId 789 -InstanceId "123 -------------------------- EXAMPLE 1 -------------------------- - #Test GCP account connectivity -Invoke-LMGCPAccountTest -ServiceAccountKey "key-json" -ProjectId "project-id" + #Discover Azure subscriptions +Invoke-LMAzureSubscriptionDiscovery -ClientId "client-id" -SecretKey "secret-key" -TenantId "tenant-id" @@ -31556,23 +34780,50 @@ Invoke-LMGCPAccountTest -ServiceAccountKey "key-json" -ProjectId "project-id" - Invoke-LMNetScan + Invoke-LMCloudGroupNetScan Invoke - LMNetScan + LMCloudGroupNetScan - Invokes a NetScan task in LogicMonitor. + Invokes a NetScan task for a cloud device group. - The Invoke-LMNetScan function schedules execution of a specified NetScan task in LogicMonitor. + The Invoke-LMCloudGroupNetScan function schedules a NetScan task for a specified cloud device group (AWS, Azure, or GCP) in LogicMonitor. - Invoke-LMNetScan - + Invoke-LMCloudGroupNetScan + Id - The ID of the NetScan to execute. + The ID of the cloud device group. Required for GroupId parameter set. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Invoke-LMCloudGroupNetScan + + Name + + The name of the cloud device group. Required for GroupName parameter set. String @@ -31596,10 +34847,22 @@ Invoke-LMGCPAccountTest -ServiceAccountKey "key-json" -ProjectId "project-id" - + Id - The ID of the NetScan to execute. + The ID of the cloud device group. Required for GroupId parameter set. + + String + + String + + + None + + + Name + + The name of the cloud device group. Required for GroupName parameter set. String @@ -31634,7 +34897,7 @@ Invoke-LMGCPAccountTest -ServiceAccountKey "key-json" -ProjectId "project-id" - Returns a success message if the NetScan is scheduled successfully. + Returns a success message if the task is scheduled successfully. @@ -31643,14 +34906,22 @@ Invoke-LMGCPAccountTest -ServiceAccountKey "key-json" -ProjectId "project-id" - You must run Connect-LMAccount before running this command. + You must run Connect-LMAccount before running this command. The target group must be a cloud group (AWS, Azure, or GCP). -------------------------- EXAMPLE 1 -------------------------- - #Execute a NetScan -Invoke-LMNetScan -Id "12345" + #Run NetScan on a cloud group by ID +Invoke-LMCloudGroupNetScan -Id "12345" + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Run NetScan on a cloud group by name +Invoke-LMCloudGroupNetScan -Name "AWS-Production" @@ -31660,31 +34931,78 @@ Invoke-LMNetScan -Id "12345" - Invoke-LMUserLogoff + Invoke-LMCollectorDebugCommand Invoke - LMUserLogoff + LMCollectorDebugCommand - Forces user logoff in LogicMonitor. + Executes debug commands on a LogicMonitor collector. - The Invoke-LMUserLogoff function forces one or more users to be logged out of their LogicMonitor sessions. + The Invoke-LMCollectorDebugCommand function allows execution of debug, PowerShell, or Groovy commands on a specified LogicMonitor collector. - Invoke-LMUserLogoff - - Usernames + Invoke-LMCollectorDebugCommand + + Id - An array of usernames to log off. + The ID of the collector. Required for Id parameter sets. - String[] + Int32 - String[] + Int32 + + + 0 + + + GroovyCommand + + The Groovy command to execute. Required for Groovy parameter sets. + + String + + String None + + CommandHostName + + The hostname context for the command execution. + + String + + String + + + None + + + CommandWildValue + + The wild value context for the command execution. + + String + + String + + + None + + + IncludeResult + + Switch to wait for and include command execution results. + + + SwitchParameter + + + False + ProgressAction @@ -31698,89 +35016,24 @@ Invoke-LMNetScan -Id "12345" None - - - - Usernames - - An array of usernames to log off. - - String[] - - String[] - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns a success message if the logoff is completed successfully. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Log off multiple users -Invoke-LMUserLogoff -Usernames "user1", "user2" - - - - - - - - - - New-LMAccessGroup - New - LMAccessGroup - - Creates a new LogicMonitor access group. - - - - The New-LMAccessGroup function creates a new access group in LogicMonitor. Access groups control user permissions and access rights for managing modules in the LM exchange and module toolbox. - - - New-LMAccessGroup - - Name + Invoke-LMCollectorDebugCommand + + Id - The name of the access group. This parameter is mandatory. + The ID of the collector. Required for Id parameter sets. + + Int32 + + Int32 + + + 0 + + + PoshCommand + + The PowerShell command to execute. Required for Posh parameter sets. String @@ -31789,10 +35042,10 @@ Invoke-LMUserLogoff -Usernames "user1", "user2" None - - Description + + CommandHostName - The description of the access group. + The hostname context for the command execution. String @@ -31801,10 +35054,10 @@ Invoke-LMUserLogoff -Usernames "user1", "user2" None - - Tenant + + CommandWildValue - The ID of the tenant to which the access group belongs. + The wild value context for the command execution. String @@ -31813,6 +35066,17 @@ Invoke-LMUserLogoff -Usernames "user1", "user2" None + + IncludeResult + + Switch to wait for and include command execution results. + + + SwitchParameter + + + False + ProgressAction @@ -31826,125 +35090,36 @@ Invoke-LMUserLogoff -Usernames "user1", "user2" None - - - - Name - - The name of the access group. This parameter is mandatory. - - String - - String - - - None - - - Description - - The description of the access group. - - String - - String - - - None - - - Tenant - - The ID of the tenant to which the access group belongs. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor.AccessGroup object. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Create a new access group -New-LMAccessGroup -Name "Group1" -Description "Access group for administrators" -Tenant "12345" - - - - - - - - - - New-LMAccessGroupMapping - New - LMAccessGroupMapping - - Creates a new LogicMonitor access group mapping. - - - - The New-LMAccessGroupMapping function creates a mapping between an access group and a logic module in LogicMonitor. - - - New-LMAccessGroupMapping - - AccessGroupIds + Invoke-LMCollectorDebugCommand + + Id - The IDs of the access groups to map. This parameter is mandatory. + The ID of the collector. Required for Id parameter sets. - String[] + Int32 - String[] + Int32 + + + 0 + + + DebugCommand + + The debug command to execute. Required for Debug parameter sets. + + String + + String None - - LogicModuleType + + CommandHostName - The type of logic module. Valid values are "DATASOURCE", "EVENTSOURCE", "BATCHJOB", "JOBMONITOR", "LOGSOURCE", "TOPOLOGYSOURCE", "PROPERTYSOURCE", "APPLIESTO_FUNCTION", "SNMP_SYSOID_MAP". + The hostname context for the command execution. String @@ -31953,17 +35128,28 @@ New-LMAccessGroup -Name "Group1" -Description "Access group for administrators" None - - LogicModuleId + + CommandWildValue - The ID of the logic module to map. This parameter is mandatory. + The wild value context for the command execution. - Int32 + String - Int32 + String - 0 + None + + + IncludeResult + + Switch to wait for and include command execution results. + + + SwitchParameter + + + False ProgressAction @@ -31978,125 +35164,24 @@ New-LMAccessGroup -Name "Group1" -Description "Access group for administrators" None - - - - AccessGroupIds - - The IDs of the access groups to map. This parameter is mandatory. - - String[] - - String[] - - - None - - - LogicModuleType - - The type of logic module. Valid values are "DATASOURCE", "EVENTSOURCE", "BATCHJOB", "JOBMONITOR", "LOGSOURCE", "TOPOLOGYSOURCE", "PROPERTYSOURCE", "APPLIESTO_FUNCTION", "SNMP_SYSOID_MAP". - - String - - String - - - None - - - LogicModuleId - - The ID of the logic module to map. This parameter is mandatory. - - Int32 - - Int32 - - - 0 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns mapping details object. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Create a new access group mapping -New-LMAccessGroupMapping -AccessGroupIds "12345" -LogicModuleType "DATASOURCE" -LogicModuleId "67890" - - - - - - - - - - New-LMAlertAck - New - LMAlertAck - - Creates a new alert acknowledgment in LogicMonitor. - - - - The New-LMAlertAck function acknowledges one or more alerts in LogicMonitor and adds a note to the acknowledgment. - - - New-LMAlertAck - - Ids + Invoke-LMCollectorDebugCommand + + Name - The alert IDs to be acknowledged. This parameter is mandatory. + The name of the collector. Required for Name parameter sets. - String[] + String - String[] + String None - - Note + + GroovyCommand - The note to be added to the acknowledgment. This parameter is mandatory. + The Groovy command to execute. Required for Groovy parameter sets. String @@ -32105,114 +35190,96 @@ New-LMAccessGroupMapping -AccessGroupIds "12345" -LogicModuleType "DATASOURCE" - None - - ProgressAction + + CommandHostName - {{ Fill ProgressAction Description }} + The hostname context for the command execution. - ActionPreference + String - ActionPreference + String None - - - - - Ids - - The alert IDs to be acknowledged. This parameter is mandatory. - - String[] - - String[] - - - None - - - Note - - The note to be added to the acknowledgment. This parameter is mandatory. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns a success message if the acknowledgment is created successfully. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Acknowledge multiple alerts -New-LMAlertAck -Ids @("12345","67890") -Note "Acknowledging alerts" - - - - - - - - - - New-LMAlertEscalation - New - LMAlertEscalation - - Creates a new escalation for a LogicMonitor alert. - - - - The New-LMAlertEscalation function creates a new escalation for a specified alert in LogicMonitor. - - + + CommandWildValue + + The wild value context for the command execution. + + String + + String + + + None + + + IncludeResult + + Switch to wait for and include command execution results. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + - New-LMAlertEscalation - - Id + Invoke-LMCollectorDebugCommand + + Name - The ID of the alert to escalate. This parameter is mandatory. + The name of the collector. Required for Name parameter sets. + + String + + String + + + None + + + PoshCommand + + The PowerShell command to execute. Required for Posh parameter sets. + + String + + String + + + None + + + CommandHostName + + The hostname context for the command execution. + + String + + String + + + None + + + CommandWildValue + + The wild value context for the command execution. String @@ -32221,6 +35288,17 @@ New-LMAlertAck -Ids @("12345","67890") -Note "Acknowledging alerts" None + + IncludeResult + + Switch to wait for and include command execution results. + + + SwitchParameter + + + False + ProgressAction @@ -32234,101 +35312,48 @@ New-LMAlertAck -Ids @("12345","67890") -Note "Acknowledging alerts" None - - - - Id - - The ID of the alert to escalate. This parameter is mandatory. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns a success message if the escalation is created successfully. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Escalate an alert -New-LMAlertEscalation -Id "DS12345" - - - - - - - - - - New-LMAlertNote - New - LMAlertNote - - Creates a new note for LogicMonitor alerts. - - - - The New-LMAlertNote function adds a note to one or more alerts in LogicMonitor. - - - New-LMAlertNote - - Ids + Invoke-LMCollectorDebugCommand + + Name - The alert IDs to add the note to. This parameter is mandatory. + The name of the collector. Required for Name parameter sets. - String[] + String - String[] + String None - - Note + + DebugCommand - The content of the note to add. This parameter is mandatory. + The debug command to execute. Required for Debug parameter sets. + + String + + String + + + None + + + CommandHostName + + The hostname context for the command execution. + + String + + String + + + None + + + CommandWildValue + + The wild value context for the command execution. String @@ -32337,6 +35362,17 @@ New-LMAlertEscalation -Id "DS12345" None + + IncludeResult + + Switch to wait for and include command execution results. + + + SwitchParameter + + + False + ProgressAction @@ -32352,22 +35388,82 @@ New-LMAlertEscalation -Id "DS12345" - - Ids + + Id - The alert IDs to add the note to. This parameter is mandatory. + The ID of the collector. Required for Id parameter sets. - String[] + Int32 - String[] + Int32 + + + 0 + + + Name + + The name of the collector. Required for Name parameter sets. + + String + + String None - - Note + + DebugCommand - The content of the note to add. This parameter is mandatory. + The debug command to execute. Required for Debug parameter sets. + + String + + String + + + None + + + PoshCommand + + The PowerShell command to execute. Required for Posh parameter sets. + + String + + String + + + None + + + GroovyCommand + + The Groovy command to execute. Required for Groovy parameter sets. + + String + + String + + + None + + + CommandHostName + + The hostname context for the command execution. + + String + + String + + + None + + + CommandWildValue + + The wild value context for the command execution. String @@ -32376,6 +35472,18 @@ New-LMAlertEscalation -Id "DS12345" None + + IncludeResult + + Switch to wait for and include command execution results. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction @@ -32402,7 +35510,7 @@ New-LMAlertEscalation -Id "DS12345" - Returns a success message if the note is created successfully. + Returns command execution results if IncludeResult is specified. @@ -32417,8 +35525,16 @@ New-LMAlertEscalation -Id "DS12345" -------------------------- EXAMPLE 1 -------------------------- - #Add a note to multiple alerts -New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" + #Execute a debug command +Invoke-LMCollectorDebugCommand -Id 123 -DebugCommand "!account" -IncludeResult + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Execute a PowerShell command +Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process" @@ -32428,23 +35544,23 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" - New-LMAlertRule - New - LMAlertRule + Invoke-LMDeviceConfigSourceCollection + Invoke + LMDeviceConfigSourceCollection - Creates a new LogicMonitor alert rule. + Invokes configuration collection for a device datasource. - The New-LMAlertRule function creates a new alert rule in LogicMonitor. + The Invoke-LMDeviceConfigSourceCollection function triggers configuration collection for a specified device datasource instance. - New-LMAlertRule - - Name + Invoke-LMDeviceConfigSourceCollection + + DatasourceName - Specifies the name for the alert rule. + The name of the datasource. Required for dsName parameter sets. String @@ -32453,10 +35569,10 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" None - - DataPoint + + Name - Specifies the datapoint name to apply the rule to. + The name of the device. Required for Name parameter sets. String @@ -32465,46 +35581,61 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" None - - SuppressAlertClear + + InstanceId - Indicates whether to suppress alert clear notifications. + The ID of the datasource instance. - Boolean + String - Boolean + String - False + None - - SuppressAlertAckSdt + + ProgressAction - Indicates whether to suppress alert acknowledgement and SDT notifications. + {{ Fill ProgressAction Description }} - Boolean + ActionPreference - Boolean + ActionPreference - False + None - - LevelStr + + + Invoke-LMDeviceConfigSourceCollection + + DatasourceName - Specifies the level string for the alert rule. Valid values: "All", "Critical", "Error", "Warning". + The name of the datasource. Required for dsName parameter sets. String String - All + None - - Description + + Id - Specifies the description for the alert rule. + The ID of the device. Required for Id parameter sets. + + Int32 + + Int32 + + + 0 + + + InstanceId + + The ID of the datasource instance. String @@ -32513,22 +35644,25 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" None - - Priority + + ProgressAction - Specifies the priority level for the alert rule. Valid values: "High", "Medium", "Low". + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference - 0 + None - - EscalatingChainId + + + Invoke-LMDeviceConfigSourceCollection + + DatasourceId - Specifies the ID of the escalation chain to use. + The ID of the datasource. Required for dsId parameter sets. Int32 @@ -32537,58 +35671,112 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" 0 - - EscalationInterval + + Name - Specifies the escalation interval in minutes. + The name of the device. Required for Name parameter sets. - Int32 + String - Int32 + String - 0 + None - - ResourceProperties + + InstanceId - Specifies resource properties to filter on. + The ID of the datasource instance. - Hashtable + String - Hashtable + String None - - Devices + + ProgressAction - Specifies an array of device display names to apply the rule to. + {{ Fill ProgressAction Description }} - String[] + ActionPreference - String[] + ActionPreference None - - DeviceGroups + + + Invoke-LMDeviceConfigSourceCollection + + DatasourceId - Specifies an array of device group full paths to apply the rule to. + The ID of the datasource. Required for dsId parameter sets. - String[] + Int32 - String[] + Int32 + + + 0 + + + Id + + The ID of the device. Required for Id parameter sets. + + Int32 + + Int32 + + + 0 + + + InstanceId + + The ID of the datasource instance. + + String + + String None - - DataSource + + ProgressAction - Specifies the datasource name to apply the rule to. + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Invoke-LMDeviceConfigSourceCollection + + Id + + The ID of the device. Required for Id parameter sets. + + Int32 + + Int32 + + + 0 + + + HdsId + + The host datasource ID. Required for HdsId parameter sets. String @@ -32597,10 +35785,10 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" None - - DataSourceInstanceName + + InstanceId - Specifies the instance name to apply the rule to. + The ID of the datasource instance. String @@ -32609,27 +35797,56 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" None - - WhatIf + + ProgressAction - Shows what would happen if the cmdlet runs. The cmdlet is not run. + {{ Fill ProgressAction Description }} + ActionPreference - SwitchParameter + ActionPreference - False + None - - Confirm + + + Invoke-LMDeviceConfigSourceCollection + + Name - Prompts you for confirmation before running the cmdlet. + The name of the device. Required for Name parameter sets. + String - SwitchParameter + String - False + None + + + HdsId + + The host datasource ID. Required for HdsId parameter sets. + + String + + String + + + None + + + InstanceId + + The ID of the datasource instance. + + String + + String + + + None ProgressAction @@ -32646,10 +35863,10 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" - - Name + + DatasourceName - Specifies the name for the alert rule. + The name of the datasource. Required for dsName parameter sets. String @@ -32658,22 +35875,10 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" None - - Priority - - Specifies the priority level for the alert rule. Valid values: "High", "Medium", "Low". - - Int32 - - Int32 - - - 0 - - - EscalatingChainId + + DatasourceId - Specifies the ID of the escalation chain to use. + The ID of the datasource. Required for dsId parameter sets. Int32 @@ -32682,10 +35887,10 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" 0 - - EscalationInterval + + Id - Specifies the escalation interval in minutes. + The ID of the device. Required for Id parameter sets. Int32 @@ -32694,58 +35899,10 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" 0 - - ResourceProperties - - Specifies resource properties to filter on. - - Hashtable - - Hashtable - - - None - - - Devices - - Specifies an array of device display names to apply the rule to. - - String[] - - String[] - - - None - - - DeviceGroups - - Specifies an array of device group full paths to apply the rule to. - - String[] - - String[] - - - None - - - DataSource - - Specifies the datasource name to apply the rule to. - - String - - String - - - None - - - DataSourceInstanceName + + Name - Specifies the instance name to apply the rule to. + The name of the device. Required for Name parameter sets. String @@ -32754,10 +35911,10 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" None - - DataPoint + + HdsId - Specifies the datapoint name to apply the rule to. + The host datasource ID. Required for HdsId parameter sets. String @@ -32766,46 +35923,10 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" None - - SuppressAlertClear - - Indicates whether to suppress alert clear notifications. - - Boolean - - Boolean - - - False - - - SuppressAlertAckSdt - - Indicates whether to suppress alert acknowledgement and SDT notifications. - - Boolean - - Boolean - - - False - - - LevelStr - - Specifies the level string for the alert rule. Valid values: "All", "Critical", "Error", "Warning". - - String - - String - - - All - - - Description + + InstanceId - Specifies the description for the alert rule. + The ID of the datasource instance. String @@ -32814,30 +35935,6 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" None - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - ProgressAction @@ -32864,7 +35961,7 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" - Returns the response from the API containing the new alert rule information. + Returns a success message if the collection is scheduled successfully. @@ -32873,14 +35970,22 @@ New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" - This function requires a valid LogicMonitor API authentication. + You must run Connect-LMAccount before running this command. -------------------------- EXAMPLE 1 -------------------------- - New-LMAlertRule -Name "New Rule" -Priority 100 -EscalatingChainId 456 -Creates a new alert rule with specified name, priority and escalation chain. + #Collect config using datasource name +Invoke-LMDeviceConfigSourceCollection -Name "Device1" -DatasourceName "Config" -InstanceId "123" + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Collect config using datasource ID +Invoke-LMDeviceConfigSourceCollection -Id 456 -DatasourceId 789 -InstanceId "123" @@ -32890,35 +35995,34 @@ Creates a new alert rule with specified name, priority and escalation chain. - New-LMAPIToken - New - LMAPIToken + Invoke-LMDeviceDedupe + Invoke + LMDeviceDedupe - Creates a new LogicMonitor API token. + List and/or remove duplicte devices from a portal based on a specified device group and set of exclusion criteria. - The New-LMAPIToken function creates a new API token for a specified user in LogicMonitor. + List and/or remove duplicte devices from a portal based on a specified device group and set of exclusion criteria. - New-LMAPIToken + Invoke-LMDeviceDedupe - Id + ListDuplicates - The ID of the user to create the token for. Required for Id parameter set. + {{ Fill ListDuplicates Description }} - String[] - String[] + SwitchParameter - None + False - Note + DeviceGroupId - A note describing the purpose of the API token. + {{ Fill DeviceGroupId Description }} String @@ -32928,27 +36032,40 @@ Creates a new alert rule with specified name, priority and escalation chain.None - CreateDisabled + IpExclusionList - Switch to create the token in a disabled state. + {{ Fill IpExclusionList Description }} + String[] - SwitchParameter + String[] - False + None - Type + SysNameExclusionList - The type of API token to create. Valid values are "LMv1" and "Bearer". Defaults to "LMv1". + {{ Fill SysNameExclusionList Description }} - String + String[] - String + String[] - LMv1 + None + + + ExcludeDeviceType + + Exclude K8s resources by default + + String[] + + String[] + + + @(8) ProgressAction @@ -32964,11 +36081,22 @@ Creates a new alert rule with specified name, priority and escalation chain. - New-LMAPIToken + Invoke-LMDeviceDedupe - Username + RemoveDuplicates - The username to create the token for. Required for Username parameter set. + {{ Fill RemoveDuplicates Description }} + + + SwitchParameter + + + False + + + DeviceGroupId + + {{ Fill DeviceGroupId Description }} String @@ -32978,39 +36106,40 @@ Creates a new alert rule with specified name, priority and escalation chain.None - Note + IpExclusionList - A note describing the purpose of the API token. + {{ Fill IpExclusionList Description }} - String + String[] - String + String[] None - CreateDisabled + SysNameExclusionList - Switch to create the token in a disabled state. + {{ Fill SysNameExclusionList Description }} + String[] - SwitchParameter + String[] - False + None - Type + ExcludeDeviceType - The type of API token to create. Valid values are "LMv1" and "Bearer". Defaults to "LMv1". + Exclude K8s resources by default - String + String[] - String + String[] - LMv1 + @(8) ProgressAction @@ -33028,21 +36157,33 @@ Creates a new alert rule with specified name, priority and escalation chain. - Id + ListDuplicates - The ID of the user to create the token for. Required for Id parameter set. + {{ Fill ListDuplicates Description }} - String[] + SwitchParameter - String[] + SwitchParameter - None + False - Username + RemoveDuplicates - The username to create the token for. Required for Username parameter set. + {{ Fill RemoveDuplicates Description }} + + SwitchParameter + + SwitchParameter + + + False + + + DeviceGroupId + + {{ Fill DeviceGroupId Description }} String @@ -33052,40 +36193,40 @@ Creates a new alert rule with specified name, priority and escalation chain.None - Note + IpExclusionList - A note describing the purpose of the API token. + {{ Fill IpExclusionList Description }} - String + String[] - String + String[] None - CreateDisabled + SysNameExclusionList - Switch to create the token in a disabled state. + {{ Fill SysNameExclusionList Description }} - SwitchParameter + String[] - SwitchParameter + String[] - False + None - Type + ExcludeDeviceType - The type of API token to create. Valid values are "LMv1" and "Bearer". Defaults to "LMv1". + Exclude K8s resources by default - String + String[] - String + String[] - LMv1 + @(8) ProgressAction @@ -33103,41 +36244,23 @@ Creates a new alert rule with specified name, priority and escalation chain. - None. You cannot pipe objects to this command. + None. Does not accept pipeline input. - - - - Returns LogicMonitor.APIToken object. - - - - - - + - You must run Connect-LMAccount before running this command. + Additional arrays can be specified to exclude certain IPs, sysname and devicetypes from being used for duplicate comparison -------------------------- EXAMPLE 1 -------------------------- - #Create a token by user ID -New-LMAPIToken -Id "12345" -Note "API Token for automation" - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Create a token by username -New-LMAPIToken -Username "john.doe" -Type "Bearer" -CreateDisabled + Invoke-LMDeviceDedupe -ListDuplicates -DeviceGroupId 8 @@ -33147,23 +36270,23 @@ New-LMAPIToken -Username "john.doe" -Type "Bearer" -CreateDisabled - New-LMAPIUser - New - LMAPIUser + Invoke-LMGCPAccountTest + Invoke + LMGCPAccountTest - Creates a new LogicMonitor API user. + Tests GCP account connectivity in LogicMonitor. - The New-LMAPIUser function creates a new API-only user in LogicMonitor with specified roles and group memberships. + The Invoke-LMGCPAccountTest function tests the connection and permissions for a Google Cloud Platform account in LogicMonitor. - New-LMAPIUser + Invoke-LMGCPAccountTest - Username + ServiceAccountKey - The username for the new API user. This parameter is mandatory. + The GCP service account key JSON. String @@ -33172,53 +36295,41 @@ New-LMAPIToken -Username "john.doe" -Type "Bearer" -CreateDisabled None - - UserGroups + + ProjectId - The user groups to add the new user to. + The GCP project ID. - String[] + String - String[] + String None - Note + CheckedServices - A note describing the purpose of the API user. + The list of GCP services to test. Defaults to all supported services. String String - None + CLOUDRUN,CLOUDDNS,REGIONALHTTPSLOADBALANCER,COMPUTEENGINEAUTOSCALER,COMPUTEENGINE,CLOUDIOT,CLOUDROUTER,CLOUDTASKS,VPNGATEWAY,CLOUDREDIS,CLOUDCOMPOSER,INTERCONNECTATTACHMENT,CLOUDFUNCTION,CLOUDBIGTABLE,CLOUDFILESTORE,CLOUDPUBSUB,CLOUDTRACE,CLOUDSTORAGE,CLOUDDATAPROC,CLOUDINTERCONNECT,CLOUDAIPLATFORM,CLOUDSQL,MANAGEDSERVICEFORMICROSOFTAD,CLOUDFIRESTORE,CLOUDDATAFLOW,CLOUDTPU,CLOUDDLP,APPENGINE,HTTPSLOADBALANCER,CLOUDSPANNER - RoleNames - - The roles to assign to the user. Defaults to "readonly". - - String[] - - String[] - - - @("readonly") - - - Status + GroupId - The status of the user. Valid values are "active" and "suspended". Defaults to "active". + The LogicMonitor group ID to associate with the GCP account. Defaults to -1. String String - Active + -1 ProgressAction @@ -33236,9 +36347,9 @@ New-LMAPIToken -Username "john.doe" -Type "Bearer" -CreateDisabled - Username + ServiceAccountKey - The username for the new API user. This parameter is mandatory. + The GCP service account key JSON. String @@ -33247,53 +36358,41 @@ New-LMAPIToken -Username "john.doe" -Type "Bearer" -CreateDisabled None - - UserGroups + + ProjectId - The user groups to add the new user to. + The GCP project ID. - String[] + String - String[] + String None - Note + CheckedServices - A note describing the purpose of the API user. + The list of GCP services to test. Defaults to all supported services. String String - None + CLOUDRUN,CLOUDDNS,REGIONALHTTPSLOADBALANCER,COMPUTEENGINEAUTOSCALER,COMPUTEENGINE,CLOUDIOT,CLOUDROUTER,CLOUDTASKS,VPNGATEWAY,CLOUDREDIS,CLOUDCOMPOSER,INTERCONNECTATTACHMENT,CLOUDFUNCTION,CLOUDBIGTABLE,CLOUDFILESTORE,CLOUDPUBSUB,CLOUDTRACE,CLOUDSTORAGE,CLOUDDATAPROC,CLOUDINTERCONNECT,CLOUDAIPLATFORM,CLOUDSQL,MANAGEDSERVICEFORMICROSOFTAD,CLOUDFIRESTORE,CLOUDDATAFLOW,CLOUDTPU,CLOUDDLP,APPENGINE,HTTPSLOADBALANCER,CLOUDSPANNER - RoleNames - - The roles to assign to the user. Defaults to "readonly". - - String[] - - String[] - - - @("readonly") - - - Status + GroupId - The status of the user. Valid values are "active" and "suspended". Defaults to "active". + The LogicMonitor group ID to associate with the GCP account. Defaults to -1. String String - Active + -1 ProgressAction @@ -33321,7 +36420,7 @@ New-LMAPIToken -Username "john.doe" -Type "Bearer" -CreateDisabled - Returns the created user object. + Returns test results for each GCP service. @@ -33336,8 +36435,8 @@ New-LMAPIToken -Username "john.doe" -Type "Bearer" -CreateDisabled -------------------------- EXAMPLE 1 -------------------------- - #Create a new API user -New-LMAPIUser -Username "api.user" -UserGroups @("Group1","Group2") -RoleNames @("admin") -Note "API user for automation" + #Test GCP account connectivity +Invoke-LMGCPAccountTest -ServiceAccountKey "key-json" -ProjectId "project-id" @@ -33347,47 +36446,23 @@ New-LMAPIUser -Username "api.user" -UserGroups @("Group1","Group2") -RoleNames @ - New-LMAppliesToFunction - New - LMAppliesToFunction + Invoke-LMNetScan + Invoke + LMNetScan - Creates a new LogicMonitor Applies To function. + Invokes a NetScan task in LogicMonitor. - The New-LMAppliesToFunction function creates a new Applies To function that can be used in LogicMonitor for targeting resources. + The Invoke-LMNetScan function schedules execution of a specified NetScan task in LogicMonitor. - New-LMAppliesToFunction + Invoke-LMNetScan - Name - - The name of the function. This parameter is mandatory. - - String - - String - - - None - - - Description - - A description of the function's purpose. - - String - - String - - - None - - - AppliesTo + Id - The function code that defines the targeting logic. This parameter is mandatory. + The ID of the NetScan to execute. String @@ -33412,33 +36487,9 @@ New-LMAPIUser -Username "api.user" -UserGroups @("Group1","Group2") -RoleNames @ - Name - - The name of the function. This parameter is mandatory. - - String - - String - - - None - - - Description - - A description of the function's purpose. - - String - - String - - - None - - - AppliesTo + Id - The function code that defines the targeting logic. This parameter is mandatory. + The ID of the NetScan to execute. String @@ -33473,7 +36524,7 @@ New-LMAPIUser -Username "api.user" -UserGroups @("Group1","Group2") -RoleNames @ - Returns the created function object. + Returns a success message if the NetScan is scheduled successfully. @@ -33488,8 +36539,8 @@ New-LMAPIUser -Username "api.user" -UserGroups @("Group1","Group2") -RoleNames @ -------------------------- EXAMPLE 1 -------------------------- - #Create a new Applies To function -New-LMAppliesToFunction -Name "WindowsServers" -AppliesTo "isWindows() && hasCategory('server')" -Description "Targets Windows servers" + #Execute a NetScan +Invoke-LMNetScan -Id "12345" @@ -33499,78 +36550,54 @@ New-LMAppliesToFunction -Name "WindowsServers" -AppliesTo "isWindows() && - New-LMCachedAccount - New - LMCachedAccount + Invoke-LMReportExecution + Invoke + LMReportExecution - Creates a cached LogicMonitor account connection. + Triggers the execution of a LogicMonitor report. - The New-LMCachedAccount function stores LogicMonitor portal credentials securely for use with Connect-LMAccount. + Invoke-LMReportExecution starts an on-demand run of a LogicMonitor report. The report can be identified by ID or name. Optional parameters allow impersonating another admin or overriding the email recipients for the generated output. - New-LMCachedAccount - - AccessId - - The Access ID from your LogicMonitor API credentials. - - String - - String - - - None - + Invoke-LMReportExecution - AccessKey + Id - The Access Key from your LogicMonitor API credentials. + The ID of the report to execute. - String + Int32 - String + Int32 - None + 0 - - AccountName + + WithAdminId - The portal subdomain (e.g., "company" for company.logicmonitor.com). + The admin ID to impersonate when generating the report. Defaults to the current user when omitted. - String + Int32 - String + Int32 - None + 0 - CachedAccountName + ReceiveEmails - The name to use for the cached account. Defaults to AccountName. + One or more email addresses (comma-separated) that should receive the generated report. String String - $AccountName - - - OverwriteExisting - - Whether to overwrite an existing cached account. Defaults to false. - - Boolean - - Boolean - - - False + None ProgressAction @@ -33586,11 +36613,11 @@ New-LMAppliesToFunction -Name "WindowsServers" -AppliesTo "isWindows() && - New-LMCachedAccount + Invoke-LMReportExecution - AccountName + Name - The portal subdomain (e.g., "company" for company.logicmonitor.com). + The name of the report to execute. String @@ -33599,41 +36626,29 @@ New-LMAppliesToFunction -Name "WindowsServers" -AppliesTo "isWindows() && None - - BearerToken + + WithAdminId - The Bearer token for authentication (alternative to AccessId/AccessKey). + The admin ID to impersonate when generating the report. Defaults to the current user when omitted. - String + Int32 - String + Int32 - None + 0 - CachedAccountName + ReceiveEmails - The name to use for the cached account. Defaults to AccountName. + One or more email addresses (comma-separated) that should receive the generated report. String String - $AccountName - - - OverwriteExisting - - Whether to overwrite an existing cached account. Defaults to false. - - Boolean - - Boolean - - - False + None ProgressAction @@ -33651,21 +36666,21 @@ New-LMAppliesToFunction -Name "WindowsServers" -AppliesTo "isWindows() && - AccessId + Id - The Access ID from your LogicMonitor API credentials. + The ID of the report to execute. - String + Int32 - String + Int32 - None + 0 - AccessKey + Name - The Access Key from your LogicMonitor API credentials. + The name of the report to execute. String @@ -33674,22 +36689,22 @@ New-LMAppliesToFunction -Name "WindowsServers" -AppliesTo "isWindows() && None - - AccountName + + WithAdminId - The portal subdomain (e.g., "company" for company.logicmonitor.com). + The admin ID to impersonate when generating the report. Defaults to the current user when omitted. - String + Int32 - String + Int32 - None + 0 - - BearerToken + + ReceiveEmails - The Bearer token for authentication (alternative to AccessId/AccessKey). + One or more email addresses (comma-separated) that should receive the generated report. String @@ -33698,29 +36713,97 @@ New-LMAppliesToFunction -Name "WindowsServers" -AppliesTo "isWindows() && None - - CachedAccountName + + ProgressAction - The name to use for the cached account. Defaults to AccountName. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference - $AccountName + None - - OverwriteExisting + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Invoke-LMReportExecution -Id 42 + + Starts an immediate execution of the report with ID 42 using the current user's context. + + + + -------------------------- EXAMPLE 2 -------------------------- + Invoke-LMReportExecution -Name "Monthly Availability" -WithAdminId 101 -ReceiveEmails "ops@example.com" + + Runs the "Monthly Availability" report as admin ID 101 and emails the results to ops@example.com. + + + + + + + + Invoke-LMUserLogoff + Invoke + LMUserLogoff + + Forces user logoff in LogicMonitor. + + + + The Invoke-LMUserLogoff function forces one or more users to be logged out of their LogicMonitor sessions. + + + + Invoke-LMUserLogoff + + Usernames + + An array of usernames to log off. + + String[] + + String[] + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Usernames - Whether to overwrite an existing cached account. Defaults to false. + An array of usernames to log off. - Boolean + String[] - Boolean + String[] - False + None ProgressAction @@ -33748,7 +36831,7 @@ New-LMAppliesToFunction -Name "WindowsServers" -AppliesTo "isWindows() && - None. Returns success message if account is cached successfully. + Returns a success message if the logoff is completed successfully. @@ -33757,22 +36840,14 @@ New-LMAppliesToFunction -Name "WindowsServers" -AppliesTo "isWindows() && - This command creates a secure vault to store credentials if one doesn't exist. + You must run Connect-LMAccount before running this command. -------------------------- EXAMPLE 1 -------------------------- - #Cache LMv1 credentials -New-LMCachedAccount -AccessId "id123" -AccessKey "key456" -AccountName "company" - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Cache Bearer token -New-LMCachedAccount -BearerToken "token123" -AccountName "company" -CachedAccountName "prod" + #Log off multiple users +Invoke-LMUserLogoff -Usernames "user1", "user2" @@ -33782,23 +36857,23 @@ New-LMCachedAccount -BearerToken "token123" -AccountName "company" -CachedAccoun - New-LMCollector + New-LMAccessGroup New - LMCollector + LMAccessGroup - Creates a new LogicMonitor collector. + Creates a new LogicMonitor access group. - The New-LMCollector function creates a new collector in LogicMonitor with specified configuration settings. + The New-LMAccessGroup function creates a new access group in LogicMonitor. Access groups control user permissions and access rights for managing modules in the LM exchange and module toolbox. - New-LMCollector + New-LMAccessGroup - Description + Name - The description of the collector. This parameter is mandatory. + The name of the access group. This parameter is mandatory. String @@ -33807,125 +36882,51 @@ New-LMCachedAccount -BearerToken "token123" -AccountName "company" -CachedAccoun None - - ResendAlertInterval - - The interval for resending alerts. - - Int32 - - Int32 - - - None - - - SpecifiedCollectorDeviceGroupId - - The ID of the device group for the collector device. - - Int32 - - Int32 - - - None - - BackupAgentId + Description - The ID of the backup collector. + The description of the access group. - Int32 + String - Int32 + String None - CollectorGroupId - - The ID of the collector group to assign the collector to. - - Int32 - - Int32 - - - None - - - Properties - - A hashtable of custom properties for the collector. - - Hashtable - - Hashtable - - - None - - - EnableFailBack - - Whether to enable failback for the collector. - - Boolean - - Boolean - - - None - - - EnableFailOverOnCollectorDevice - - Whether to enable failover on the collector device. - - Boolean - - Boolean - - - None - - - EscalatingChainId + Tenant - The ID of the escalation chain to use. + The ID of the tenant to which the access group belongs. - Int32 + String - Int32 + String None - - AutoCreateCollectorDevice + + WhatIf - Whether to automatically create a device for the collector. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter - None + False - - SuppressAlertClear + + Confirm - Whether to suppress alert clear notifications. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter - None + False ProgressAction @@ -33943,9 +36944,9 @@ New-LMCachedAccount -BearerToken "token123" -AccountName "company" -CachedAccoun - Description + Name - The description of the collector. This parameter is mandatory. + The name of the access group. This parameter is mandatory. String @@ -33955,133 +36956,61 @@ New-LMCachedAccount -BearerToken "token123" -AccountName "company" -CachedAccoun None - BackupAgentId + Description - The ID of the backup collector. + The description of the access group. - Int32 + String - Int32 + String None - CollectorGroupId + Tenant - The ID of the collector group to assign the collector to. + The ID of the tenant to which the access group belongs. - Int32 + String - Int32 + String None - - Properties + + WhatIf - A hashtable of custom properties for the collector. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Hashtable + SwitchParameter - Hashtable + SwitchParameter - None + False - - EnableFailBack + + Confirm - Whether to enable failback for the collector. + Prompts you for confirmation before running the cmdlet. - Boolean + SwitchParameter - Boolean + SwitchParameter - None + False - - EnableFailOverOnCollectorDevice + + ProgressAction - Whether to enable failover on the collector device. + {{ Fill ProgressAction Description }} - Boolean + ActionPreference - Boolean - - - None - - - EscalatingChainId - - The ID of the escalation chain to use. - - Int32 - - Int32 - - - None - - - AutoCreateCollectorDevice - - Whether to automatically create a device for the collector. - - Boolean - - Boolean - - - None - - - SuppressAlertClear - - Whether to suppress alert clear notifications. - - Boolean - - Boolean - - - None - - - ResendAlertInterval - - The interval for resending alerts. - - Int32 - - Int32 - - - None - - - SpecifiedCollectorDeviceGroupId - - The ID of the device group for the collector device. - - Int32 - - Int32 - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference + ActionPreference None @@ -34100,7 +37029,7 @@ New-LMCachedAccount -BearerToken "token123" -AccountName "company" -CachedAccoun - Returns LogicMonitor.Collector object. + Returns LogicMonitor.AccessGroup object. @@ -34115,8 +37044,8 @@ New-LMCachedAccount -BearerToken "token123" -AccountName "company" -CachedAccoun -------------------------- EXAMPLE 1 -------------------------- - #Create a new collector -New-LMCollector -Description "Production Collector" -CollectorGroupId 123 -Properties @{"location"="datacenter1"} + #Create a new access group +New-LMAccessGroup -Name "Group1" -Description "Access group for administrators" -Tenant "12345" @@ -34126,35 +37055,35 @@ New-LMCollector -Description "Production Collector" -CollectorGroupId 123 -Prope - New-LMCollectorGroup + New-LMAccessGroupMapping New - LMCollectorGroup + LMAccessGroupMapping - Creates a new LogicMonitor collector group. + Creates a new LogicMonitor access group mapping. - The New-LMCollectorGroup function creates a new collector group in LogicMonitor with specified configuration settings. + The New-LMAccessGroupMapping function creates a mapping between an access group and a logic module in LogicMonitor. - New-LMCollectorGroup + New-LMAccessGroupMapping - Name + AccessGroupIds - The name of the collector group. This parameter is mandatory. + The IDs of the access groups to map. This parameter is mandatory. - String + String[] - String + String[] None - - Description + + LogicModuleType - The description of the collector group. + The type of logic module. Valid values are "DATASOURCE", "EVENTSOURCE", "BATCHJOB", "JOBMONITOR", "LOGSOURCE", "TOPOLOGYSOURCE", "PROPERTYSOURCE", "APPLIESTO_FUNCTION", "SNMP_SYSOID_MAP". String @@ -34163,41 +37092,39 @@ New-LMCollector -Description "Production Collector" -CollectorGroupId 123 -Prope None - - Properties + + LogicModuleId - A hashtable of custom properties for the collector group. + The ID of the logic module to map. This parameter is mandatory. - Hashtable + Int32 - Hashtable + Int32 - None + 0 - - AutoBalance + + WhatIf - Specifies whether to enable auto-balancing for the collector group. Defaults to $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter False - - AutoBalanceInstanceCountThreshold + + Confirm - The threshold for auto-balancing the collector group. Defaults to 10000. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 10000 + False ProgressAction @@ -34215,21 +37142,21 @@ New-LMCollector -Description "Production Collector" -CollectorGroupId 123 -Prope - Name + AccessGroupIds - The name of the collector group. This parameter is mandatory. + The IDs of the access groups to map. This parameter is mandatory. - String + String[] - String + String[] None - - Description + + LogicModuleType - The description of the collector group. + The type of logic module. Valid values are "DATASOURCE", "EVENTSOURCE", "BATCHJOB", "JOBMONITOR", "LOGSOURCE", "TOPOLOGYSOURCE", "PROPERTYSOURCE", "APPLIESTO_FUNCTION", "SNMP_SYSOID_MAP". String @@ -34238,41 +37165,41 @@ New-LMCollector -Description "Production Collector" -CollectorGroupId 123 -Prope None - - Properties + + LogicModuleId - A hashtable of custom properties for the collector group. + The ID of the logic module to map. This parameter is mandatory. - Hashtable + Int32 - Hashtable + Int32 - None + 0 - - AutoBalance + + WhatIf - Specifies whether to enable auto-balancing for the collector group. Defaults to $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean + SwitchParameter - Boolean + SwitchParameter False - - AutoBalanceInstanceCountThreshold + + Confirm - The threshold for auto-balancing the collector group. Defaults to 10000. + Prompts you for confirmation before running the cmdlet. - Int32 + SwitchParameter - Int32 + SwitchParameter - 10000 + False ProgressAction @@ -34300,7 +37227,7 @@ New-LMCollector -Description "Production Collector" -CollectorGroupId 123 -Prope - Returns LogicMonitor.CollectorGroup object. + Returns mapping details object. @@ -34315,8 +37242,8 @@ New-LMCollector -Description "Production Collector" -CollectorGroupId 123 -Prope -------------------------- EXAMPLE 1 -------------------------- - #Create a new collector group with properties -New-LMCollectorGroup -Name "MyCollectorGroup" -Description "Production collectors" -Properties @{"location"="datacenter1"} + #Create a new access group mapping +New-LMAccessGroupMapping -AccessGroupIds "12345" -LogicModuleType "DATASOURCE" -LogicModuleId "67890" @@ -34326,98 +37253,35 @@ New-LMCollectorGroup -Name "MyCollectorGroup" -Description "Production collector - New-LMDashboardGroup + New-LMAlertAck New - LMDashboardGroup + LMAlertAck - Creates a new LogicMonitor dashboard group. + Creates a new alert acknowledgment in LogicMonitor. - The New-LMDashboardGroup function creates a new dashboard group in LogicMonitor. It can be created under a parent group specified by either ID or name. + The New-LMAlertAck function acknowledges one or more alerts in LogicMonitor and adds a note to the acknowledgment. - New-LMDashboardGroup - - Name - - The name of the dashboard group. This parameter is mandatory. - - String - - String - - - None - - - Description - - The description of the dashboard group. - - String - - String - - - None - - - WidgetTokens - - A hashtable containing widget tokens for the dashboard group. - - Hashtable - - Hashtable - - - None - - - ParentGroupId - - The ID of the parent group. Required for GroupId parameter set. - - Int32 - - Int32 - - - 0 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDashboardGroup - - Name + New-LMAlertAck + + Ids - The name of the dashboard group. This parameter is mandatory. + The alert IDs to be acknowledged. This parameter is mandatory. - String + String[] - String + String[] None - - Description + + Note - The description of the dashboard group. + The note to be added to the acknowledgment. This parameter is mandatory. String @@ -34426,29 +37290,27 @@ New-LMCollectorGroup -Name "MyCollectorGroup" -Description "Production collector None - - WidgetTokens + + WhatIf - A hashtable containing widget tokens for the dashboard group. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Hashtable - Hashtable + SwitchParameter - None + False - - ParentGroupName + + Confirm - The name of the parent group. Required for GroupName parameter set. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -34465,22 +37327,22 @@ New-LMCollectorGroup -Name "MyCollectorGroup" -Description "Production collector - - Name + + Ids - The name of the dashboard group. This parameter is mandatory. + The alert IDs to be acknowledged. This parameter is mandatory. - String + String[] - String + String[] None - - Description + + Note - The description of the dashboard group. + The note to be added to the acknowledgment. This parameter is mandatory. String @@ -34489,41 +37351,29 @@ New-LMCollectorGroup -Name "MyCollectorGroup" -Description "Production collector None - - WidgetTokens - - A hashtable containing widget tokens for the dashboard group. - - Hashtable - - Hashtable - - - None - - - ParentGroupId + + WhatIf - The ID of the parent group. Required for GroupId parameter set. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 + SwitchParameter - Int32 + SwitchParameter - 0 + False - - ParentGroupName + + Confirm - The name of the parent group. Required for GroupName parameter set. + Prompts you for confirmation before running the cmdlet. - String + SwitchParameter - String + SwitchParameter - None + False ProgressAction @@ -34551,7 +37401,7 @@ New-LMCollectorGroup -Name "MyCollectorGroup" -Description "Production collector - Returns the created dashboard group object. + Returns a success message if the acknowledgment is created successfully. @@ -34566,16 +37416,8 @@ New-LMCollectorGroup -Name "MyCollectorGroup" -Description "Production collector -------------------------- EXAMPLE 1 -------------------------- - #Create dashboard group using parent ID -New-LMDashboardGroup -Name "Operations" -Description "Operations dashboards" -ParentGroupId 123 - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Create dashboard group using parent name -New-LMDashboardGroup -Name "Operations" -Description "Operations dashboards" -ParentGroupName "Root" + #Acknowledge multiple alerts +New-LMAlertAck -Ids @("12345","67890") -Note "Acknowledging alerts" @@ -34585,27 +37427,27 @@ New-LMDashboardGroup -Name "Operations" -Description "Operations dashboards" -Pa - New-LMDatasource + New-LMAlertEscalation New - LMDatasource + LMAlertEscalation - Creates a new LogicMonitor datasource. + Creates a new escalation for a LogicMonitor alert. - The New-LMDatasource function creates a new datasource in LogicMonitor using a provided datasource configuration object. + The New-LMAlertEscalation function creates a new escalation for a specified alert in LogicMonitor. - New-LMDatasource - - Datasource + New-LMAlertEscalation + + Id - A PSCustomObject containing the datasource configuration. Must follow the schema model defined in LogicMonitor's API documentation. + The ID of the alert to escalate. This parameter is mandatory. - PSObject + String - PSObject + String None @@ -34647,14 +37489,14 @@ New-LMDashboardGroup -Name "Operations" -Description "Operations dashboards" -Pa - - Datasource + + Id - A PSCustomObject containing the datasource configuration. Must follow the schema model defined in LogicMonitor's API documentation. + The ID of the alert to escalate. This parameter is mandatory. - PSObject + String - PSObject + String None @@ -34709,7 +37551,7 @@ New-LMDashboardGroup -Name "Operations" -Description "Operations dashboards" -Pa - Returns LogicMonitor.Datasource object. + Returns a success message if the escalation is created successfully. @@ -34718,18 +37560,14 @@ New-LMDashboardGroup -Name "Operations" -Description "Operations dashboards" -Pa - You must run Connect-LMAccount before running this command. For datasource schema details, see: https://www.logicmonitor.com/swagger-ui-master/api-v3/dist/#/Datasources/addDatasourceById + You must run Connect-LMAccount before running this command. -------------------------- EXAMPLE 1 -------------------------- - #Create a new datasource -$config = @{ - name = "MyDatasource" - # Additional configuration properties -} -New-LMDatasource -Datasource $config + #Escalate an alert +New-LMAlertEscalation -Id "DS12345" @@ -34739,81 +37577,64 @@ New-LMDatasource -Datasource $config - New-LMDatasourceGraph + New-LMAlertNote New - LMDatasourceGraph + LMAlertNote - Creates a new datasource graph in LogicMonitor. + Creates a new note for LogicMonitor alerts. - The New-LMDatasourceGraph function creates a new graph for a specified datasource in LogicMonitor. + The New-LMAlertNote function adds a note to one or more alerts in LogicMonitor. - New-LMDatasourceGraph - - RawObject - - The raw object representing the graph configuration. Use Get-LMDatasourceGraph to see the expected format. - - Object - - Object - - - None - - - DatasourceId + New-LMAlertNote + + Ids - The ID of the datasource to which the graph will be added. Required for dsId parameter set. + The alert IDs to add the note to. This parameter is mandatory. - Object + String[] - Object + String[] None - - ProgressAction + + Note - {{ Fill ProgressAction Description }} + The content of the note to add. This parameter is mandatory. - ActionPreference + String - ActionPreference + String None - - - New-LMDatasourceGraph - - RawObject + + WhatIf - The raw object representing the graph configuration. Use Get-LMDatasourceGraph to see the expected format. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Object - Object + SwitchParameter - None + False - - DatasourceName + + Confirm - The name of the datasource to which the graph will be added. Required for dsName parameter set. + Prompts you for confirmation before running the cmdlet. - Object - Object + SwitchParameter - None + False ProgressAction @@ -34830,41 +37651,53 @@ New-LMDatasource -Datasource $config - - RawObject + + Ids - The raw object representing the graph configuration. Use Get-LMDatasourceGraph to see the expected format. + The alert IDs to add the note to. This parameter is mandatory. - Object + String[] - Object + String[] None - - DatasourceId + + Note - The ID of the datasource to which the graph will be added. Required for dsId parameter set. + The content of the note to add. This parameter is mandatory. - Object + String - Object + String None - - DatasourceName + + WhatIf - The name of the datasource to which the graph will be added. Required for dsName parameter set. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Object + SwitchParameter - Object + SwitchParameter - None + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False ProgressAction @@ -34892,194 +37725,7 @@ New-LMDatasource -Datasource $config - Returns LogicMonitor.DatasourceGraph object. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Create graph using datasource ID -New-LMDatasourceGraph -RawObject $graphConfig -DatasourceId 123 - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Create graph using datasource name -New-LMDatasourceGraph -RawObject $graphConfig -DatasourceName "MyDatasource" - - - - - - - - - - New-LMDatasourceOverviewGraph - New - LMDatasourceOverviewGraph - - Creates a new datasource overview graph in LogicMonitor. - - - - The New-LMDatasourceOverviewGraph function creates a new overview graph for a specified datasource in LogicMonitor. - - - - New-LMDatasourceOverviewGraph - - RawObject - - The raw object representing the graph configuration. Use Get-LMDatasourceOverviewGraph to see the expected format. - - Object - - Object - - - None - - - DatasourceId - - The ID of the datasource for which to create the overview graph. Required for dsId parameter set. - - Object - - Object - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDatasourceOverviewGraph - - RawObject - - The raw object representing the graph configuration. Use Get-LMDatasourceOverviewGraph to see the expected format. - - Object - - Object - - - None - - - DatasourceName - - The name of the datasource for which to create the overview graph. Required for dsName parameter set. - - Object - - Object - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - RawObject - - The raw object representing the graph configuration. Use Get-LMDatasourceOverviewGraph to see the expected format. - - Object - - Object - - - None - - - DatasourceId - - The ID of the datasource for which to create the overview graph. Required for dsId parameter set. - - Object - - Object - - - None - - - DatasourceName - - The name of the datasource for which to create the overview graph. Required for dsName parameter set. - - Object - - Object - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor.DatasourceGraph object. + Returns a success message if the note is created successfully. @@ -35094,16 +37740,8 @@ New-LMDatasourceGraph -RawObject $graphConfig -DatasourceName "MyDatasource" -------------------------- EXAMPLE 1 -------------------------- - #Create overview graph using datasource ID -New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceId 123 - - - - - - -------------------------- EXAMPLE 2 -------------------------- - #Create overview graph using datasource name -New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceName "MyDatasource" + #Add a note to multiple alerts +New-LMAlertNote -Ids @("12345","67890") -Note "This is a sample note" @@ -35113,23 +37751,23 @@ New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceName "MyDatasou - New-LMDevice + New-LMAlertRule New - LMDevice + LMAlertRule - Creates a new LogicMonitor device. + Creates a new LogicMonitor alert rule. - The New-LMDevice function creates a new device in LogicMonitor with specified configuration settings. + The New-LMAlertRule function creates a new alert rule in LogicMonitor. - New-LMDevice + New-LMAlertRule Name - The name of the device. This parameter is mandatory. + Specifies the name for the alert rule. String @@ -35139,9 +37777,9 @@ New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceName "MyDatasou None - Link + DataPoint - The link associated with the device. + Specifies the datapoint name to apply the rule to. String @@ -35151,172 +37789,170 @@ New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceName "MyDatasou None - DisableAlerting + SuppressAlertClear - Whether to disable alerting for the device. + Indicates whether to suppress alert clear notifications. Boolean Boolean - None + False - EnableNetFlow + SuppressAlertAckSdt - Whether to enable NetFlow for the device. + Indicates whether to suppress alert acknowledgement and SDT notifications. Boolean Boolean - None + False - NetflowCollectorGroupId + LevelStr - The ID of the NetFlow collector group. + Specifies the level string for the alert rule. Valid values: "All", "Critical", "Error", "Warning". - Int32 + String - Int32 + String - None + All - NetflowCollectorId + Description - The ID of the NetFlow collector. + Specifies the description for the alert rule. - Int32 + String - Int32 + String None - - LogCollectorGroupId + + Priority - The ID of the log collector group. + Specifies the priority level for the alert rule. Valid values: "High", "Medium", "Low". Int32 Int32 - None + 0 - - LogCollectorId + + EscalatingChainId - The ID of the log collector. + Specifies the ID of the escalation chain to use. Int32 Int32 - None + 0 - - DisplayName + + EscalationInterval - The display name of the device. This parameter is mandatory. + Specifies the escalation interval in minutes. - String + Int32 - String + Int32 - None + 0 - - Description + + ResourceProperties - The description of the device. + Specifies resource properties to filter on. - String + Hashtable - String + Hashtable None - - PreferredCollectorId + + Devices - The ID of the preferred collector for the device. This parameter is mandatory. + Specifies an array of device display names to apply the rule to. - Int32 + String[] - Int32 + String[] None - - PreferredCollectorGroupId + + DeviceGroups - The ID of the preferred collector group for the device. + Specifies an array of device group full paths to apply the rule to. - Int32 + String[] - Int32 + String[] None - - AutoBalancedCollectorGroupId + + DataSource - The ID of the auto-balanced collector group for the device. + Specifies the datasource name to apply the rule to. - Int32 + String - Int32 + String None - - DeviceType + + DataSourceInstanceName - The type of the device. Defaults to 0. + Specifies the instance name to apply the rule to. - Int32 + String - Int32 + String - 0 + None - - Properties + + WhatIf - A hashtable of custom properties for the device. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Hashtable - Hashtable + SwitchParameter - None + False - - HostGroupIds + + Confirm - An array of host group IDs. Dynamic group IDs will be ignored. + Prompts you for confirmation before running the cmdlet. - String[] - String[] + SwitchParameter - None + False ProgressAction @@ -35336,7 +37972,7 @@ New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceName "MyDatasou Name - The name of the device. This parameter is mandatory. + Specifies the name for the alert rule. String @@ -35346,105 +37982,105 @@ New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceName "MyDatasou None - DisplayName + Priority - The display name of the device. This parameter is mandatory. + Specifies the priority level for the alert rule. Valid values: "High", "Medium", "Low". - String + Int32 - String + Int32 - None + 0 - - Description + + EscalatingChainId - The description of the device. + Specifies the ID of the escalation chain to use. - String + Int32 - String + Int32 - None + 0 - - PreferredCollectorId + + EscalationInterval - The ID of the preferred collector for the device. This parameter is mandatory. + Specifies the escalation interval in minutes. Int32 Int32 - None + 0 - PreferredCollectorGroupId + ResourceProperties - The ID of the preferred collector group for the device. + Specifies resource properties to filter on. - Int32 + Hashtable - Int32 + Hashtable None - AutoBalancedCollectorGroupId + Devices - The ID of the auto-balanced collector group for the device. + Specifies an array of device display names to apply the rule to. - Int32 + String[] - Int32 + String[] None - DeviceType + DeviceGroups - The type of the device. Defaults to 0. + Specifies an array of device group full paths to apply the rule to. - Int32 + String[] - Int32 + String[] - 0 + None - Properties + DataSource - A hashtable of custom properties for the device. + Specifies the datasource name to apply the rule to. - Hashtable + String - Hashtable + String None - HostGroupIds + DataSourceInstanceName - An array of host group IDs. Dynamic group IDs will be ignored. + Specifies the instance name to apply the rule to. - String[] + String - String[] + String None - Link + DataPoint - The link associated with the device. + Specifies the datapoint name to apply the rule to. String @@ -35454,76 +38090,76 @@ New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceName "MyDatasou None - DisableAlerting + SuppressAlertClear - Whether to disable alerting for the device. + Indicates whether to suppress alert clear notifications. Boolean Boolean - None + False - EnableNetFlow + SuppressAlertAckSdt - Whether to enable NetFlow for the device. + Indicates whether to suppress alert acknowledgement and SDT notifications. Boolean Boolean - None + False - NetflowCollectorGroupId + LevelStr - The ID of the NetFlow collector group. + Specifies the level string for the alert rule. Valid values: "All", "Critical", "Error", "Warning". - Int32 + String - Int32 + String - None + All - NetflowCollectorId + Description - The ID of the NetFlow collector. + Specifies the description for the alert rule. - Int32 + String - Int32 + String None - - LogCollectorGroupId + + WhatIf - The ID of the log collector group. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 + SwitchParameter - Int32 + SwitchParameter - None + False - - LogCollectorId + + Confirm - The ID of the log collector. + Prompts you for confirmation before running the cmdlet. - Int32 + SwitchParameter - Int32 + SwitchParameter - None + False ProgressAction @@ -35551,7 +38187,7 @@ New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceName "MyDatasou - Returns LogicMonitor.Device object. + Returns the response from the API containing the new alert rule information. @@ -35560,14 +38196,14 @@ New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceName "MyDatasou - You must run Connect-LMAccount before running this command. + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - #Create a new device -New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 -Properties @{"location"="datacenter1"} + New-LMAlertRule -Name "New Rule" -Priority 100 -EscalatingChainId 456 +Creates a new alert rule with specified name, priority and escalation chain. @@ -35577,35 +38213,35 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - - New-LMDeviceDatasourceInstance + New-LMAPIToken New - LMDeviceDatasourceInstance + LMAPIToken - Creates a new instance of a LogicMonitor device datasource. + Creates a new LogicMonitor API token. - The New-LMDeviceDatasourceInstance function creates a new instance of a LogicMonitor device datasource. It requires valid API credentials and a logged-in session. + The New-LMAPIToken function creates a new API token for a specified user in LogicMonitor. - New-LMDeviceDatasourceInstance + New-LMAPIToken - DisplayName + Id - The display name of the new instance. + The ID of the user to create the token for. Required for Id parameter set. - String + String[] - String + String[] None - - WildValue + + Note - The wild value of the new instance. + A note describing the purpose of the API token. String @@ -35615,236 +38251,50 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - WildValue2 - - The second wild value of the new instance. - - String - - String - - - None - - - Description - - The description of the new instance. - - String - - String - - - None - - - Properties - - A hashtable of custom properties for the new instance. - - Hashtable - - Hashtable - - - None - - - StopMonitoring - - Specifies whether to stop monitoring the new instance. Default is $false. - - Boolean - - Boolean - - - False - - - DisableAlerting + CreateDisabled - Specifies whether to disable alerting for the new instance. Default is $false. + Switch to create the token in a disabled state. - Boolean - Boolean + SwitchParameter False - InstanceGroupId - - The ID of the instance group to which the new instance belongs. - - String - - String - - - None - - - DatasourceName - - The name of the datasource associated with the new instance. Mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. - - String - - String - - - None - - - Name - - The name of the host device associated with the new instance. Mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceDatasourceInstance - - DisplayName - - The display name of the new instance. - - String - - String - - - None - - - WildValue - - The wild value of the new instance. - - String - - String - - - None - - - WildValue2 - - The second wild value of the new instance. - - String - - String - - - None - - - Description + Type - The description of the new instance. + The type of API token to create. Valid values are "LMv1" and "Bearer". Defaults to "LMv1". String String - None - - - Properties - - A hashtable of custom properties for the new instance. - - Hashtable - - Hashtable - - - None + LMv1 - - StopMonitoring + + WhatIf - Specifies whether to stop monitoring the new instance. Default is $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter False - - DisableAlerting + + Confirm - Specifies whether to disable alerting for the new instance. Default is $false. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter False - - InstanceGroupId - - The ID of the instance group to which the new instance belongs. - - String - - String - - - None - - - DatasourceName - - The name of the datasource associated with the new instance. Mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. - - String - - String - - - None - - - Id - - The ID of the host device associated with the new instance. Mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. - - Int32 - - Int32 - - - 0 - ProgressAction @@ -35859,35 +38309,11 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - - New-LMDeviceDatasourceInstance - - DisplayName - - The display name of the new instance. - - String - - String - - - None - + New-LMAPIToken - WildValue - - The wild value of the new instance. - - String - - String - - - None - - - WildValue2 + Username - The second wild value of the new instance. + The username to create the token for. Required for Username parameter set. String @@ -35897,9 +38323,9 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - Description + Note - The description of the new instance. + A note describing the purpose of the API token. String @@ -35909,212 +38335,50 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - Properties - - A hashtable of custom properties for the new instance. - - Hashtable - - Hashtable - - - None - - - StopMonitoring - - Specifies whether to stop monitoring the new instance. Default is $false. - - Boolean - - Boolean - - - False - - - DisableAlerting + CreateDisabled - Specifies whether to disable alerting for the new instance. Default is $false. + Switch to create the token in a disabled state. - Boolean - Boolean + SwitchParameter False - InstanceGroupId - - The ID of the instance group to which the new instance belongs. - - String - - String - - - None - - - DatasourceId - - The ID of the datasource associated with the new instance. Mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - None - - - Name - - The name of the host device associated with the new instance. Mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceDatasourceInstance - - DisplayName - - The display name of the new instance. - - String - - String - - - None - - - WildValue - - The wild value of the new instance. - - String - - String - - - None - - - WildValue2 - - The second wild value of the new instance. - - String - - String - - - None - - - Description + Type - The description of the new instance. + The type of API token to create. Valid values are "LMv1" and "Bearer". Defaults to "LMv1". String String - None - - - Properties - - A hashtable of custom properties for the new instance. - - Hashtable - - Hashtable - - - None + LMv1 - - StopMonitoring + + WhatIf - Specifies whether to stop monitoring the new instance. Default is $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter False - - DisableAlerting + + Confirm - Specifies whether to disable alerting for the new instance. Default is $false. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter False - - InstanceGroupId - - The ID of the instance group to which the new instance belongs. - - String - - String - - - None - - - DatasourceId - - The ID of the datasource associated with the new instance. Mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - None - - - Id - - The ID of the host device associated with the new instance. Mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. - - Int32 - - Int32 - - - 0 - ProgressAction @@ -36131,21 +38395,21 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - - DisplayName + Id - The display name of the new instance. + The ID of the user to create the token for. Required for Id parameter set. - String + String[] - String + String[] None - WildValue + Username - The wild value of the new instance. + The username to create the token for. Required for Username parameter set. String @@ -36155,9 +38419,9 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - WildValue2 + Note - The second wild value of the new instance. + A note describing the purpose of the API token. String @@ -36167,131 +38431,71 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - Description + CreateDisabled - The description of the new instance. + Switch to create the token in a disabled state. - String + SwitchParameter - String + SwitchParameter - None + False - Properties + Type - A hashtable of custom properties for the new instance. + The type of API token to create. Valid values are "LMv1" and "Bearer". Defaults to "LMv1". - Hashtable + String - Hashtable + String - None + LMv1 - - StopMonitoring + + WhatIf - Specifies whether to stop monitoring the new instance. Default is $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean + SwitchParameter - Boolean + SwitchParameter False - - DisableAlerting + + Confirm - Specifies whether to disable alerting for the new instance. Default is $false. + Prompts you for confirmation before running the cmdlet. - Boolean + SwitchParameter - Boolean + SwitchParameter False - - InstanceGroupId + + ProgressAction - The ID of the instance group to which the new instance belongs. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - DatasourceName - - The name of the datasource associated with the new instance. Mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. - - String - - String - - - None - - - DatasourceId - - The ID of the datasource associated with the new instance. Mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - None - - - Id - - The ID of the host device associated with the new instance. Mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. - - Int32 - - Int32 - - - 0 - - - Name - - The name of the host device associated with the new instance. Mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - + + + + + None. You cannot pipe objects to this command. + @@ -36300,7 +38504,7 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - - Returns LogicMonitor.DeviceDatasourceInstance object. + Returns LogicMonitor.APIToken object. @@ -36315,9 +38519,18 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - -------------------------- EXAMPLE 1 -------------------------- - New-LMDeviceDatasourceInstance -DisplayName "Instance 1" -WildValue "Value 1" -Description "This is a new instance" -DatasourceName "DataSource 1" -Name "Host Device 1" + #Create a token by user ID +New-LMAPIToken -Id "12345" -Note "API Token for automation" - This example creates a new instance of a LogicMonitor device datasource with the specified display name, wild value, description, datasource name, and host device name. + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Create a token by username +New-LMAPIToken -Username "john.doe" -Type "Bearer" -CreateDisabled + + @@ -36325,35 +38538,23 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - - New-LMDeviceDatasourceInstanceGroup + New-LMAPIUser New - LMDeviceDatasourceInstanceGroup + LMAPIUser - Creates a new instance group for a LogicMonitor device datasource. + Creates a new LogicMonitor API user. - The New-LMDeviceDatasourceInstanceGroup function creates a new instance group for a LogicMonitor device datasource. It requires the user to be logged in and have valid API credentials. + The New-LMAPIUser function creates a new API-only user in LogicMonitor with specified roles and group memberships. - New-LMDeviceDatasourceInstanceGroup - - InstanceGroupName - - The name of the instance group to create. This parameter is mandatory. - - String - - String - - - None - - - Description + New-LMAPIUser + + Username - The description of the instance group. + The username for the new API user. This parameter is mandatory. String @@ -36362,22 +38563,22 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - - DatasourceName + + UserGroups - The name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + The user groups to add the new user to. - String + String[] - String + String[] None - - Name + + Note - The name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. + A note describing the purpose of the API user. String @@ -36386,68 +38587,51 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceDatasourceInstanceGroup - - InstanceGroupName + + RoleNames - The name of the instance group to create. This parameter is mandatory. + The roles to assign to the user. Defaults to "readonly". - String + String[] - String + String[] - None + @("readonly") - - Description + + Status - The description of the instance group. + The status of the user. Valid values are "active" and "suspended". Defaults to "active". String String - None + Active - - DatasourceName + + WhatIf - The name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - Id + + Confirm - The ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False ProgressAction @@ -36462,48 +38646,161 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None + + + + Username + + The username for the new API user. This parameter is mandatory. + + String + + String + + + None + + + UserGroups + + The user groups to add the new user to. + + String[] + + String[] + + + None + + + Note + + A note describing the purpose of the API user. + + String + + String + + + None + + + RoleNames + + The roles to assign to the user. Defaults to "readonly". + + String[] + + String[] + + + @("readonly") + + + Status + + The status of the user. Valid values are "active" and "suspended". Defaults to "active". + + String + + String + + + Active + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns the created user object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Create a new API user +New-LMAPIUser -Username "api.user" -UserGroups @("Group1","Group2") -RoleNames @("admin") -Note "API user for automation" + + + + + + + + + + New-LMAppliesToFunction + New + LMAppliesToFunction + + Creates a new LogicMonitor Applies To function. + + + + The New-LMAppliesToFunction function creates a new Applies To function that can be used in LogicMonitor for targeting resources. + + - New-LMDeviceDatasourceInstanceGroup - - InstanceGroupName - - The name of the instance group to create. This parameter is mandatory. - - String - - String - - - None - - - Description - - The description of the instance group. - - String - - String - - - None - - - DatasourceId - - The ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - 0 - - + New-LMAppliesToFunction + Name - The name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. + The name of the function. This parameter is mandatory. String @@ -36512,25 +38809,10 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceDatasourceInstanceGroup - - InstanceGroupName + + Description - The name of the instance group to create. This parameter is mandatory. + A description of the function's purpose. String @@ -36539,10 +38821,10 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - - Description + + AppliesTo - The description of the instance group. + The function code that defines the targeting logic. This parameter is mandatory. String @@ -36551,29 +38833,27 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - - DatasourceId + + WhatIf - The ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - Id + + Confirm - The ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False ProgressAction @@ -36590,10 +38870,10 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - - - InstanceGroupName + + Name - The name of the instance group to create. This parameter is mandatory. + The name of the function. This parameter is mandatory. String @@ -36602,10 +38882,10 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - + Description - The description of the instance group. + A description of the function's purpose. String @@ -36614,10 +38894,10 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - - DatasourceName + + AppliesTo - The name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + The function code that defines the targeting logic. This parameter is mandatory. String @@ -36626,41 +38906,29 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - None - - DatasourceId - - The ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - 0 - - - Id + + WhatIf - The ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 + SwitchParameter - Int32 + SwitchParameter - 0 + False - - Name + + Confirm - The name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. + Prompts you for confirmation before running the cmdlet. - String + SwitchParameter - String + SwitchParameter - None + False ProgressAction @@ -36688,7 +38956,7 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - - Returns LogicMonitor.DeviceDatasourceInstanceGroup object. + Returns the created function object. @@ -36703,16 +38971,8 @@ New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 - -------------------------- EXAMPLE 1 -------------------------- - New-LMDeviceDatasourceInstanceGroup -InstanceGroupName "Group1" -Description "Instance group for Device1" -DatasourceName "DataSource1" -Name "Device1" -Creates a new instance group named "Group1" with the description "Instance group for Device1" for the device named "Device1" and the datasource named "DataSource1". - - - - - - -------------------------- EXAMPLE 2 -------------------------- - New-LMDeviceDatasourceInstanceGroup -InstanceGroupName "Group2" -Description "Instance group for Device2" -DatasourceId 123 -Id 456 -Creates a new instance group named "Group2" with the description "Instance group for Device2" for the device with ID 456 and the datasource with ID 123. + #Create a new Applies To function +New-LMAppliesToFunction -Name "WindowsServers" -AppliesTo "isWindows() && hasCategory('server')" -Description "Targets Windows servers" @@ -36722,23 +38982,23 @@ Creates a new instance group named "Group2" with the description "Instance group - New-LMDeviceDatasourceInstanceSDT + New-LMCachedAccount New - LMDeviceDatasourceInstanceSDT + LMCachedAccount - Creates a new SDT entry for a Logic Monitor device datasource instance. + Creates a cached LogicMonitor account connection. - The New-LMDeviceDatasourceInstanceSDT function creates a new SDT entry for an instance of a Logic Monitor device datasource. It allows you to specify various parameters such as comment, start date, end date, timezone, start hour, and start minute. + The New-LMCachedAccount function stores LogicMonitor portal credentials securely for use with Connect-LMAccount. - New-LMDeviceDatasourceInstanceSDT + New-LMCachedAccount - Comment + AccessId - Specifies the comment for the new instance SDT. + The Access ID from your LogicMonitor API credentials. String @@ -36748,132 +39008,21 @@ Creates a new instance group named "Group2" with the description "Instance group None - StartDate + AccessKey - Specifies the start date for the new instance SDT. This parameter is mandatory when using the 'OneTime' parameter set. + The Access Key from your LogicMonitor API credentials. - DateTime + String - DateTime + String None - EndDate + AccountName - Specifies the end date for the new instance SDT. This parameter is mandatory when using the 'OneTime' parameter set. - - DateTime - - DateTime - - - None - - - DeviceDataSourceInstanceId - - Specifies the ID of the device datasource instance for which to create the SDT. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceDatasourceInstanceSDT - - Comment - - Specifies the comment for the new instance SDT. - - String - - String - - - None - - - StartHour - - Specifies the start hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - Specifies the end hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute - - Specifies the end minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - WeekDay - - Specifies the day of the week for the new instance SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. - - String - - String - - - None - - - DeviceDataSourceInstanceId - - Specifies the ID of the device datasource instance for which to create the SDT. + The portal subdomain (e.g., "company" for company.logicmonitor.com). String @@ -36882,116 +39031,51 @@ Creates a new instance group named "Group2" with the description "Instance group None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceDatasourceInstanceSDT - - Comment + + CachedAccountName - Specifies the comment for the new instance SDT. + The name to use for the cached account. Defaults to AccountName. String String - None - - - StartHour - - Specifies the start hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - Specifies the end hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute - - Specifies the end minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 + $AccountName - - WeekDay + + OverwriteExisting - Specifies the day of the week for the new instance SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + Whether to overwrite an existing cached account. Defaults to false. - String + Boolean - String + Boolean - None + False - - WeekOfMonth + + WhatIf - Specifies the week of the month for the new instance SDT. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - DeviceDataSourceInstanceId + + Confirm - Specifies the ID of the device datasource instance for which to create the SDT. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -37007,11 +39091,11 @@ Creates a new instance group named "Group2" with the description "Instance group - New-LMDeviceDatasourceInstanceSDT + New-LMCachedAccount - Comment + AccountName - Specifies the comment for the new instance SDT. + The portal subdomain (e.g., "company" for company.logicmonitor.com). String @@ -37021,69 +39105,9 @@ Creates a new instance group named "Group2" with the description "Instance group None - StartHour - - Specifies the start hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - Specifies the end hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute - - Specifies the end minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - DayOfMonth - - Specifies the day of the month for the new instance SDT. This parameter is mandatory when using the 'Monthly' parameter set. - - Int32 - - Int32 - - - 0 - - - DeviceDataSourceInstanceId + BearerToken - Specifies the ID of the device datasource instance for which to create the SDT. + The Bearer token for authentication (alternative to AccessId/AccessKey). String @@ -37092,92 +39116,51 @@ Creates a new instance group named "Group2" with the description "Instance group None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceDatasourceInstanceSDT - - Comment + + CachedAccountName - Specifies the comment for the new instance SDT. + The name to use for the cached account. Defaults to AccountName. String String - None - - - StartHour - - Specifies the start hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 + $AccountName - - EndHour + + OverwriteExisting - Specifies the end hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. + Whether to overwrite an existing cached account. Defaults to false. - Int32 + Boolean - Int32 + Boolean - 0 + False - - EndMinute + + WhatIf - Specifies the end minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - DeviceDataSourceInstanceId + + Confirm - Specifies the ID of the device datasource instance for which to create the SDT. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -37195,9 +39178,9 @@ Creates a new instance group named "Group2" with the description "Instance group - Comment + AccessId - Specifies the comment for the new instance SDT. + The Access ID from your LogicMonitor API credentials. String @@ -37207,124 +39190,88 @@ Creates a new instance group named "Group2" with the description "Instance group None - StartDate + AccessKey - Specifies the start date for the new instance SDT. This parameter is mandatory when using the 'OneTime' parameter set. + The Access Key from your LogicMonitor API credentials. - DateTime + String - DateTime + String None - EndDate + AccountName - Specifies the end date for the new instance SDT. This parameter is mandatory when using the 'OneTime' parameter set. + The portal subdomain (e.g., "company" for company.logicmonitor.com). - DateTime + String - DateTime + String None - StartHour - - Specifies the start hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - Specifies the end hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute + BearerToken - Specifies the end minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. + The Bearer token for authentication (alternative to AccessId/AccessKey). - Int32 + String - Int32 + String - 0 + None - - WeekDay + + CachedAccountName - Specifies the day of the week for the new instance SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + The name to use for the cached account. Defaults to AccountName. String String - None + $AccountName - - WeekOfMonth + + OverwriteExisting - Specifies the week of the month for the new instance SDT. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + Whether to overwrite an existing cached account. Defaults to false. - String + Boolean - String + Boolean - None + False - - DayOfMonth + + WhatIf - Specifies the day of the month for the new instance SDT. This parameter is mandatory when using the 'Monthly' parameter set. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 + SwitchParameter - Int32 + SwitchParameter - 0 + False - - DeviceDataSourceInstanceId + + Confirm - Specifies the ID of the device datasource instance for which to create the SDT. + Prompts you for confirmation before running the cmdlet. - String + SwitchParameter - String + SwitchParameter - None + False ProgressAction @@ -37352,7 +39299,7 @@ Creates a new instance group named "Group2" with the description "Instance group - Returns LogicMonitor.SDT object. + None. Returns success message if account is cached successfully. @@ -37361,14 +39308,22 @@ Creates a new instance group named "Group2" with the description "Instance group - You must run Connect-LMAccount before running this command. + This command creates a secure vault to store credentials if one doesn't exist. -------------------------- EXAMPLE 1 -------------------------- - New-LMDeviceDatasourceInstanceSDT -Comment "Test SDT Instance" -StartDate (Get-Date) -EndDate (Get-Date).AddDays(7) -StartHour 8 -StartMinute 30 -DeviceDataSourceInstanceId 1234 -Creates a new one-time instance SDT with a comment, start date, end date, start hour, and start minute. + #Cache LMv1 credentials +New-LMCachedAccount -AccessId "id123" -AccessKey "key456" -AccountName "company" + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Cache Bearer token +New-LMCachedAccount -BearerToken "token123" -AccountName "company" -CachedAccountName "prod" @@ -37378,23 +39333,23 @@ Creates a new one-time instance SDT with a comment, start date, end date, start - New-LMDeviceDatasourceSDT + New-LMCollector New - LMDeviceDatasourceSDT + LMCollector - Creates a new device datasource SDT (Scheduled Downtime) in Logic Monitor. + Creates a new LogicMonitor collector. - The New-LMDeviceDatasourceSDT function creates a new device datasource SDT (Scheduled Downtime) in Logic Monitor. It allows you to specify the comment, start date and time, end date and time, and the timezone for the SDT. + The New-LMCollector function creates a new collector in LogicMonitor with specified configuration settings. - New-LMDeviceDatasourceSDT - - Comment + New-LMCollector + + Description - The comment for the SDT. This parameter is mandatory. + The description of the collector. This parameter is mandatory. String @@ -37403,437 +39358,147 @@ Creates a new one-time instance SDT with a comment, start date, end date, start None - - StartDate - - The start date for the SDT. This parameter is mandatory when using the 'OneTime' parameter set. - - DateTime - - DateTime - - - None - - - EndDate - - The end date for the SDT. This parameter is mandatory when using the 'OneTime' parameter set. - - DateTime - - DateTime - - - None - - - DeviceDataSourceId - - The ID of the device datasource for which to create the SDT. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceDatasourceSDT - - Comment - - The comment for the SDT. This parameter is mandatory. - - String - - String - - - None - - - StartHour - - The start hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - The start minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - The end hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute + + ResendAlertInterval - The end minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + The interval for resending alerts. Int32 Int32 - 0 - - - WeekDay - - The day of the week for the SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. - - String - - String - - - None - - - DeviceDataSourceId - - The ID of the device datasource for which to create the SDT. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceDatasourceSDT - - Comment - - The comment for the SDT. This parameter is mandatory. - - String - - String - - None - - StartHour - - The start hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute + + SpecifiedCollectorDeviceGroupId - The start minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + The ID of the device group for the collector device. Int32 Int32 - 0 + None - - EndHour + + BackupAgentId - The end hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + The ID of the backup collector. Int32 Int32 - 0 + None - - EndMinute + + CollectorGroupId - The end minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + The ID of the collector group to assign the collector to. Int32 Int32 - 0 - - - WeekDay - - The day of the week for the SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. - - String - - String - - - None - - - WeekOfMonth - - The week of the month for the SDT. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. - - String - - String - - None - - DeviceDataSourceId + + Properties - The ID of the device datasource for which to create the SDT. + A hashtable of custom properties for the collector. - String + Hashtable - String + Hashtable None - - ProgressAction + + EnableFailBack - {{ Fill ProgressAction Description }} + Whether to enable failback for the collector. - ActionPreference + Boolean - ActionPreference + Boolean None - - - New-LMDeviceDatasourceSDT - - Comment + + EnableFailOverOnCollectorDevice - The comment for the SDT. This parameter is mandatory. + Whether to enable failover on the collector device. - String + Boolean - String + Boolean None - - StartHour - - The start hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - The start minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - The end hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute - - The end minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. - - Int32 - - Int32 - - - 0 - - - DayOfMonth + + EscalatingChainId - The day of the month for the SDT. This parameter is mandatory when using the 'Monthly' parameter set. + The ID of the escalation chain to use. Int32 Int32 - 0 - - - DeviceDataSourceId - - The ID of the device datasource for which to create the SDT. - - String - - String - - None - - ProgressAction + + AutoCreateCollectorDevice - {{ Fill ProgressAction Description }} + Whether to automatically create a device for the collector. - ActionPreference + Boolean - ActionPreference + Boolean None - - - New-LMDeviceDatasourceSDT - - Comment + + SuppressAlertClear - The comment for the SDT. This parameter is mandatory. + Whether to suppress alert clear notifications. - String + Boolean - String + Boolean None - - StartHour - - The start hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - The start minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - The end hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute + + WhatIf - The end minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - DeviceDataSourceId + + Confirm - The ID of the device datasource for which to create the SDT. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -37850,10 +39515,10 @@ Creates a new one-time instance SDT with a comment, start date, end date, start - - Comment + + Description - The comment for the SDT. This parameter is mandatory. + The description of the collector. This parameter is mandatory. String @@ -37862,139 +39527,163 @@ Creates a new one-time instance SDT with a comment, start date, end date, start None - - StartDate + + BackupAgentId - The start date for the SDT. This parameter is mandatory when using the 'OneTime' parameter set. + The ID of the backup collector. - DateTime + Int32 - DateTime + Int32 None - - EndDate + + CollectorGroupId - The end date for the SDT. This parameter is mandatory when using the 'OneTime' parameter set. + The ID of the collector group to assign the collector to. - DateTime + Int32 - DateTime + Int32 None - - StartHour + + Properties - The start hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + A hashtable of custom properties for the collector. - Int32 + Hashtable - Int32 + Hashtable - 0 + None - - StartMinute + + EnableFailBack - The start minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + Whether to enable failback for the collector. - Int32 + Boolean - Int32 + Boolean - 0 + None - - EndHour + + EnableFailOverOnCollectorDevice - The end hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + Whether to enable failover on the collector device. - Int32 + Boolean - Int32 + Boolean - 0 + None - - EndMinute + + EscalatingChainId - The end minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + The ID of the escalation chain to use. Int32 Int32 - 0 + None - - WeekDay + + AutoCreateCollectorDevice - The day of the week for the SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + Whether to automatically create a device for the collector. - String + Boolean - String + Boolean None - - WeekOfMonth + + SuppressAlertClear - The week of the month for the SDT. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + Whether to suppress alert clear notifications. - String + Boolean - String + Boolean None - - DayOfMonth + + ResendAlertInterval - The day of the month for the SDT. This parameter is mandatory when using the 'Monthly' parameter set. + The interval for resending alerts. Int32 Int32 - 0 + None - - DeviceDataSourceId + + SpecifiedCollectorDeviceGroupId - The ID of the device datasource for which to create the SDT. + The ID of the device group for the collector device. - String + Int32 - String + Int32 None - - ProgressAction + + WhatIf - {{ Fill ProgressAction Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ActionPreference + SwitchParameter - ActionPreference + SwitchParameter - None + False - + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -38008,7 +39697,7 @@ Creates a new one-time instance SDT with a comment, start date, end date, start - Returns LogicMonitor.SDT object. + Returns LogicMonitor.Collector object. @@ -38023,32 +39712,8 @@ Creates a new one-time instance SDT with a comment, start date, end date, start -------------------------- EXAMPLE 1 -------------------------- - New-LMDeviceDatasourceSDT -Comment "Maintenance window" -StartDate "2022-01-01 00:00" -EndDate "2022-01-01 06:00" -StartHour 2 -StartMinute 30 -DeviceDataSourceId 123 -Creates a new one-time device datasource SDT with a comment "Maintenance window" starting on January 1, 2022, at 00:00 and ending on the same day at 06:00. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - New-LMDeviceDatasourceSDT -Comment "Daily maintenance" -StartHour 3 -StartMinute 0 -ParameterSet Daily -DeviceDataSourceId 123 -Creates a new daily device datasource SDT with a comment "Daily maintenance" starting at 03:00. - - - - - - -------------------------- EXAMPLE 3 -------------------------- - New-LMDeviceDatasourceSDT -Comment "Monthly maintenance" -StartHour 8 -StartMinute 30 -ParameterSet Monthly -DeviceDataSourceId 123 -Creates a new monthly device datasource SDT with a comment "Monthly maintenance" starting on the 1st day of each month at 08:30. - - - - - - -------------------------- EXAMPLE 4 -------------------------- - New-LMDeviceDatasourceSDT -Comment "Weekly maintenance" -StartHour 10 -StartMinute 0 -ParameterSet Weekly -DeviceDataSourceId 123 -Creates a new weekly device datasource SDT with a comment "Weekly maintenance" starting every Monday at 10:00. + #Create a new collector +New-LMCollector -Description "Production Collector" -CollectorGroupId 123 -Properties @{"location"="datacenter1"} @@ -38058,23 +39723,23 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s - New-LMDeviceGroup + New-LMCollectorGroup New - LMDeviceGroup + LMCollectorGroup - Creates a new LogicMonitor device group. + Creates a new LogicMonitor collector group. - The New-LMDeviceGroup function creates a new LogicMonitor device group with the specified parameters. + The New-LMCollectorGroup function creates a new collector group in LogicMonitor with specified configuration settings. - New-LMDeviceGroup - + New-LMCollectorGroup + Name - The name of the device group. This parameter is mandatory. + The name of the collector group. This parameter is mandatory. String @@ -38083,10 +39748,10 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - + Description - The description of the device group. + The description of the collector group. String @@ -38095,10 +39760,10 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - + Properties - A hashtable of custom properties for the device group. + A hashtable of custom properties for the collector group. Hashtable @@ -38107,22 +39772,10 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - DisableAlerting - - Specifies whether alerting is disabled for the device group. The default value is $false. - - Boolean - - Boolean - - - False - - - EnableNetFlow + + AutoBalance - Specifies whether NetFlow is enabled for the device group. The default value is $false. + Specifies whether to enable auto-balancing for the collector group. Defaults to $false. Boolean @@ -38131,129 +39784,40 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s False - - ParentGroupId + + AutoBalanceInstanceCountThreshold - The ID of the parent device group. This parameter is mandatory when using the 'GroupId' parameter set. + The threshold for auto-balancing the collector group. Defaults to 10000. Int32 Int32 - 0 - - - AppliesTo - - The applies to value for the device group. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceGroup - - Name - - The name of the device group. This parameter is mandatory. - - String - - String - - - None - - - Description - - The description of the device group. - - String - - String - - - None - - - Properties - - A hashtable of custom properties for the device group. - - Hashtable - - Hashtable - - - None + 10000 - - DisableAlerting + + WhatIf - Specifies whether alerting is disabled for the device group. The default value is $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter False - - EnableNetFlow + + Confirm - Specifies whether NetFlow is enabled for the device group. The default value is $false. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter False - - ParentGroupName - - The name of the parent device group. This parameter is mandatory when using the 'GroupName' parameter set. - - String - - String - - - None - - - AppliesTo - - The applies to value for the device group. - - String - - String - - - None - ProgressAction @@ -38269,10 +39833,10 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s - + Name - The name of the device group. This parameter is mandatory. + The name of the collector group. This parameter is mandatory. String @@ -38281,10 +39845,10 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - + Description - The description of the device group. + The description of the collector group. String @@ -38293,10 +39857,10 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - + Properties - A hashtable of custom properties for the device group. + A hashtable of custom properties for the collector group. Hashtable @@ -38305,22 +39869,10 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - DisableAlerting - - Specifies whether alerting is disabled for the device group. The default value is $false. - - Boolean - - Boolean - - - False - - - EnableNetFlow + + AutoBalance - Specifies whether NetFlow is enabled for the device group. The default value is $false. + Specifies whether to enable auto-balancing for the collector group. Defaults to $false. Boolean @@ -38329,41 +39881,41 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s False - - ParentGroupId + + AutoBalanceInstanceCountThreshold - The ID of the parent device group. This parameter is mandatory when using the 'GroupId' parameter set. + The threshold for auto-balancing the collector group. Defaults to 10000. Int32 Int32 - 0 + 10000 - - ParentGroupName + + WhatIf - The name of the parent device group. This parameter is mandatory when using the 'GroupName' parameter set. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String + SwitchParameter - String + SwitchParameter - None + False - - AppliesTo + + Confirm - The applies to value for the device group. + Prompts you for confirmation before running the cmdlet. - String + SwitchParameter - String + SwitchParameter - None + False ProgressAction @@ -38391,7 +39943,7 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s - Returns LogicMonitor.DeviceGroup object. + Returns LogicMonitor.CollectorGroup object. @@ -38400,22 +39952,16 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s - This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command. + You must run Connect-LMAccount before running this command. -------------------------- EXAMPLE 1 -------------------------- - New-LMDeviceGroup -Name "MyDeviceGroup" -Description "This is a test device group" -Properties @{ "Location" = "US"; "Environment" = "Production" } -DisableAlerting $true - - This example creates a new LogicMonitor device group named "MyDeviceGroup" with a description and custom properties. Alerting is disabled for this device group. - - - - -------------------------- EXAMPLE 2 -------------------------- - New-LMDeviceGroup -Name "ChildDeviceGroup" -ParentGroupName "ParentDeviceGroup" + #Create a new collector group with properties +New-LMCollectorGroup -Name "MyCollectorGroup" -Description "Production collectors" -Properties @{"location"="datacenter1"} - This example creates a new LogicMonitor device group named "ChildDeviceGroup" with a specified parent device group. + @@ -38423,23 +39969,23 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s - New-LMDeviceGroupSDT + New-LMDashboardGroup New - LMDeviceGroupSDT + LMDashboardGroup - Creates a new LogicMonitor Device Group Scheduled Downtime. + Creates a new LogicMonitor dashboard group. - The New-LMDeviceGroupSDT function creates a new scheduled downtime for a LogicMonitor device group. This allows you to temporarily disable monitoring for a specific group of devices within your LogicMonitor account. + The New-LMDashboardGroup function creates a new dashboard group in LogicMonitor. It can be created under a parent group specified by either ID or name. - New-LMDeviceGroupSDT + New-LMDashboardGroup - Comment + Name - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + The name of the dashboard group. This parameter is mandatory. String @@ -38448,65 +39994,63 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - StartDate + + Description - Specifies the start date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + The description of the dashboard group. - DateTime + String - DateTime + String None - - EndDate + + WidgetTokens - Specifies the end date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + A hashtable containing widget tokens for the dashboard group. - DateTime + Hashtable - DateTime + Hashtable None - DeviceGroupName + ParentGroupId - Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + The ID of the parent group. Required for GroupId parameter set. - String + Int32 - String + Int32 - None + 0 - - DataSourceId + + WhatIf - {{ Fill DataSourceId Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - 0 + False - - DataSourceName + + Confirm - {{ Fill DataSourceName Description }} + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - All + False ProgressAction @@ -38522,11 +40066,11 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s - New-LMDeviceGroupSDT + New-LMDashboardGroup - Comment + Name - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + The name of the dashboard group. This parameter is mandatory. String @@ -38535,34 +40079,34 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - StartDate + + Description - Specifies the start date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + The description of the dashboard group. - DateTime + String - DateTime + String None - - EndDate + + WidgetTokens - Specifies the end date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + A hashtable containing widget tokens for the dashboard group. - DateTime + Hashtable - DateTime + Hashtable None - DeviceGroupId + ParentGroupName - Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + The name of the parent group. Required for GroupName parameter set. String @@ -38571,152 +40115,27 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - DataSourceId + + WhatIf - {{ Fill DataSourceId Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - 0 + False - - DataSourceName + + Confirm - {{ Fill DataSourceName Description }} + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - All - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceGroupSDT - - Comment - - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. - - String - - String - - - None - - - StartHour - - Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute - - Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - WeekDay - - Specifies the day of the week for weekly or monthly by week SDTs. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. - - String - - String - - - None - - - DeviceGroupId - - Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. - - String - - String - - - None - - - DataSourceId - - {{ Fill DataSourceId Description }} - - String - - String - - - 0 - - - DataSourceName - - {{ Fill DataSourceName Description }} - - String - - String - - - All + False ProgressAction @@ -38731,127 +40150,364 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None + + + + Name + + The name of the dashboard group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the dashboard group. + + String + + String + + + None + + + WidgetTokens + + A hashtable containing widget tokens for the dashboard group. + + Hashtable + + Hashtable + + + None + + + ParentGroupId + + The ID of the parent group. Required for GroupId parameter set. + + Int32 + + Int32 + + + 0 + + + ParentGroupName + + The name of the parent group. Required for GroupName parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns the created dashboard group object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Create dashboard group using parent ID +New-LMDashboardGroup -Name "Operations" -Description "Operations dashboards" -ParentGroupId 123 + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Create dashboard group using parent name +New-LMDashboardGroup -Name "Operations" -Description "Operations dashboards" -ParentGroupName "Root" + + + + + + + + + + New-LMDatasource + New + LMDatasource + + Creates a new LogicMonitor datasource. + + + + The New-LMDatasource function creates a new datasource in LogicMonitor using a provided datasource configuration object. + + - New-LMDeviceGroupSDT - - Comment + New-LMDatasource + + Datasource - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + A PSCustomObject containing the datasource configuration. Must follow the schema model defined in LogicMonitor's API documentation. - String + PSObject - String + PSObject None - - StartHour - - Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour + + WhatIf - Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - EndMinute + + Confirm - Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False - - WeekDay + + ProgressAction - Specifies the day of the week for weekly or monthly by week SDTs. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None + + + + + Datasource + + A PSCustomObject containing the datasource configuration. Must follow the schema model defined in LogicMonitor's API documentation. + + PSObject + + PSObject + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.Datasource object. + + + + + + + + + You must run Connect-LMAccount before running this command. For datasource schema details, see: https://www.logicmonitor.com/swagger-ui-master/api-v3/dist/#/Datasources/addDatasourceById + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Create a new datasource +$config = @{ + name = "MyDatasource" + # Additional configuration properties +} +New-LMDatasource -Datasource $config + + + + + + + + + + New-LMDatasourceGraph + New + LMDatasourceGraph + + Creates a new datasource graph in LogicMonitor. + + + + The New-LMDatasourceGraph function creates a new graph for a specified datasource in LogicMonitor. + + + + New-LMDatasourceGraph - WeekOfMonth + RawObject - Specifies which week of the month for monthly by week SDTs. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + The raw object representing the graph configuration. Use Get-LMDatasourceGraph to see the expected format. - String + Object - String + Object None - DeviceGroupId + DatasourceId - Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + The ID of the datasource to which the graph will be added. Required for dsId parameter set. - String + Object - String + Object None - - DataSourceId + + WhatIf - {{ Fill DataSourceId Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - 0 + False - - DataSourceName + + Confirm - {{ Fill DataSourceName Description }} + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - All + False ProgressAction @@ -38867,114 +40523,52 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s - New-LMDeviceGroupSDT + New-LMDatasourceGraph - Comment + RawObject - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + The raw object representing the graph configuration. Use Get-LMDatasourceGraph to see the expected format. - String + Object - String + Object None - StartHour - - Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute - - Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - DayOfMonth - - Specifies the day of the month for monthly SDTs. This parameter is mandatory when using the 'Monthly' parameter set. - - Int32 - - Int32 - - - 0 - - - DeviceGroupId + DatasourceName - Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + The name of the datasource to which the graph will be added. Required for dsName parameter set. - String + Object - String + Object None - - DataSourceId + + WhatIf - {{ Fill DataSourceId Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - 0 + False - - DataSourceName + + Confirm - {{ Fill DataSourceName Description }} + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - All + False ProgressAction @@ -38989,103 +40583,186 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - New-LMDeviceGroupSDT - - Comment - - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. - - String - - String - - - None - - - StartHour - - Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - + + + + RawObject + + The raw object representing the graph configuration. Use Get-LMDatasourceGraph to see the expected format. + + Object + + Object + + + None + + + DatasourceId + + The ID of the datasource to which the graph will be added. Required for dsId parameter set. + + Object + + Object + + + None + + + DatasourceName + + The name of the datasource to which the graph will be added. Required for dsName parameter set. + + Object + + Object + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.DatasourceGraph object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Create graph using datasource ID +New-LMDatasourceGraph -RawObject $graphConfig -DatasourceId 123 + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Create graph using datasource name +New-LMDatasourceGraph -RawObject $graphConfig -DatasourceName "MyDatasource" + + + + + + + + + + New-LMDatasourceOverviewGraph + New + LMDatasourceOverviewGraph + + Creates a new datasource overview graph in LogicMonitor. + + + + The New-LMDatasourceOverviewGraph function creates a new overview graph for a specified datasource in LogicMonitor. + + + + New-LMDatasourceOverviewGraph - EndMinute + RawObject - Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + The raw object representing the graph configuration. Use Get-LMDatasourceOverviewGraph to see the expected format. - Int32 + Object - Int32 + Object - 0 + None - DeviceGroupId + DatasourceId - Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + The ID of the datasource for which to create the overview graph. Required for dsId parameter set. - String + Object - String + Object None - - DataSourceId + + WhatIf - {{ Fill DataSourceId Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - 0 + False - - DataSourceName + + Confirm - {{ Fill DataSourceName Description }} + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - All + False ProgressAction @@ -39101,83 +40778,205 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s - New-LMDeviceGroupSDT + New-LMDatasourceOverviewGraph - Comment + RawObject - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + The raw object representing the graph configuration. Use Get-LMDatasourceOverviewGraph to see the expected format. - String + Object - String + Object None - StartHour - - Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute + DatasourceName - Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + The name of the datasource for which to create the overview graph. Required for dsName parameter set. - Int32 + Object - Int32 + Object - 0 + None - - EndHour + + WhatIf - Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - EndMinute + + Confirm - Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False - - WeekDay + + ProgressAction - Specifies the day of the week for weekly or monthly by week SDTs. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - DeviceGroupName + + + + + RawObject + + The raw object representing the graph configuration. Use Get-LMDatasourceOverviewGraph to see the expected format. + + Object + + Object + + + None + + + DatasourceId + + The ID of the datasource for which to create the overview graph. Required for dsId parameter set. + + Object + + Object + + + None + + + DatasourceName + + The name of the datasource for which to create the overview graph. Required for dsName parameter set. + + Object + + Object + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.DatasourceGraph object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Create overview graph using datasource ID +New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceId 123 + + + + + + -------------------------- EXAMPLE 2 -------------------------- + #Create overview graph using datasource name +New-LMDatasourceOverviewGraph -RawObject $graphConfig -DatasourceName "MyDatasource" + + + + + + + + + + New-LMDevice + New + LMDevice + + Creates a new LogicMonitor device. + + + + The New-LMDevice function creates a new device in LogicMonitor with specified configuration settings. + + + + New-LMDevice + + Name - Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + The name of the device. This parameter is mandatory. String @@ -39186,109 +40985,94 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - DataSourceId - - {{ Fill DataSourceId Description }} - - String - - String - - - 0 - - - DataSourceName + + Link - {{ Fill DataSourceName Description }} + The link associated with the device. String String - All + None - - ProgressAction + + DisableAlerting - {{ Fill ProgressAction Description }} + Whether to disable alerting for the device. - ActionPreference + Boolean - ActionPreference + Boolean None - - - New-LMDeviceGroupSDT - - Comment + + EnableNetFlow - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + Whether to enable NetFlow for the device. - String + Boolean - String + Boolean None - - StartHour + + NetflowCollectorGroupId - Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + The ID of the NetFlow collector group. Int32 Int32 - 0 + None - - StartMinute + + NetflowCollectorId - Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + The ID of the NetFlow collector. Int32 Int32 - 0 + None - - EndHour + + LogCollectorGroupId - Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + The ID of the log collector group. Int32 Int32 - 0 + None - - EndMinute + + LogCollectorId - Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + The ID of the log collector. Int32 Int32 - 0 + None - - WeekDay + + DisplayName - Specifies the day of the week for weekly or monthly by week SDTs. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + The display name of the device. This parameter is mandatory. String @@ -39297,10 +41081,10 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - WeekOfMonth + + Description - Specifies which week of the month for monthly by week SDTs. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + The description of the device. String @@ -39309,121 +41093,46 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - DeviceGroupName + + PreferredCollectorId - Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + The ID of the preferred collector for the device. This parameter is mandatory. - String + Int32 - String + Int32 None - - DataSourceId + + PreferredCollectorGroupId - {{ Fill DataSourceId Description }} + The ID of the preferred collector group for the device. - String + Int32 - String + Int32 - 0 + None - - DataSourceName + + AutoBalancedCollectorGroupId - {{ Fill DataSourceName Description }} + The ID of the auto-balanced collector group for the device. - String + Int32 - String + Int32 - All + None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceGroupSDT - - Comment - - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. - - String - - String - - - None - - - StartHour - - Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute - - Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - DayOfMonth + + DeviceType - Specifies the day of the month for monthly SDTs. This parameter is mandatory when using the 'Monthly' parameter set. + The type of the device. Defaults to 0. Int32 @@ -39432,152 +41141,51 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s 0 - - DeviceGroupName - - Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. - - String - - String - - - None - - - DataSourceId - - {{ Fill DataSourceId Description }} - - String - - String - - - 0 - - - DataSourceName - - {{ Fill DataSourceName Description }} - - String - - String - - - All - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceGroupSDT - - Comment + + Properties - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + A hashtable of custom properties for the device. - String + Hashtable - String + Hashtable None - - StartHour - - Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour - - Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - EndMinute - - Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - DeviceGroupName + + HostGroupIds - Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + An array of host group IDs. Dynamic group IDs will be ignored. - String + String[] - String + String[] None - - DataSourceId + + WhatIf - {{ Fill DataSourceId Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - 0 + False - - DataSourceName + + Confirm - {{ Fill DataSourceName Description }} + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - All + False ProgressAction @@ -39594,10 +41202,10 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s - - Comment + + Name - Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + The name of the device. This parameter is mandatory. String @@ -39606,70 +41214,70 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - StartDate + + DisplayName - Specifies the start date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + The display name of the device. This parameter is mandatory. - DateTime + String - DateTime + String None - - EndDate + + Description - Specifies the end date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + The description of the device. - DateTime + String - DateTime + String None - - StartHour + + PreferredCollectorId - Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + The ID of the preferred collector for the device. This parameter is mandatory. Int32 Int32 - 0 + None - - StartMinute + + PreferredCollectorGroupId - Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + The ID of the preferred collector group for the device. Int32 Int32 - 0 + None - - EndHour + + AutoBalancedCollectorGroupId - Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + The ID of the auto-balanced collector group for the device. Int32 Int32 - 0 + None - - EndMinute + + DeviceType - Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + The type of the device. Defaults to 0. Int32 @@ -39678,22 +41286,34 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s 0 - - WeekDay + + Properties - Specifies the day of the week for weekly or monthly by week SDTs. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + A hashtable of custom properties for the device. - String + Hashtable - String + Hashtable None - - WeekOfMonth + + HostGroupIds - Specifies which week of the month for monthly by week SDTs. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + An array of host group IDs. Dynamic group IDs will be ignored. + + String[] + + String[] + + + None + + + Link + + The link associated with the device. String @@ -39702,65 +41322,101 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s None - - DayOfMonth + + DisableAlerting - Specifies the day of the month for monthly SDTs. This parameter is mandatory when using the 'Monthly' parameter set. + Whether to disable alerting for the device. + + Boolean + + Boolean + + + None + + + EnableNetFlow + + Whether to enable NetFlow for the device. + + Boolean + + Boolean + + + None + + + NetflowCollectorGroupId + + The ID of the NetFlow collector group. Int32 Int32 - 0 + None - - DeviceGroupId + + NetflowCollectorId - Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + The ID of the NetFlow collector. - String + Int32 - String + Int32 None - - DeviceGroupName + + LogCollectorGroupId - Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + The ID of the log collector group. - String + Int32 - String + Int32 None - - DataSourceId + + LogCollectorId - {{ Fill DataSourceId Description }} + The ID of the log collector. - String + Int32 - String + Int32 - 0 + None - - DataSourceName + + WhatIf - {{ Fill DataSourceName Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String + SwitchParameter - String + SwitchParameter - All + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False ProgressAction @@ -39788,7 +41444,7 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s - Returns LogicMonitor.SDT object. + Returns LogicMonitor.Device object. @@ -39803,8 +41459,8 @@ Creates a new weekly device datasource SDT with a comment "Weekly maintenance" s -------------------------- EXAMPLE 1 -------------------------- - New-LMDeviceGroupSDT -Comment "Maintenance window" -StartDate "2022-01-01 00:00:00" -EndDate "2022-01-01 06:00:00" -StartHour 2 -DeviceGroupName "Production Servers" -Creates a new scheduled downtime for the "Production Servers" device group. + #Create a new device +New-LMDevice -Name "server1" -DisplayName "Server 1" -PreferredCollectorId 123 -Properties @{"location"="datacenter1"} @@ -39814,35 +41470,35 @@ Creates a new scheduled downtime for the "Production Servers" device group. - New-LMDeviceProperty + New-LMDeviceDatasourceInstance New - LMDeviceProperty + LMDeviceDatasourceInstance - Creates a new device property in LogicMonitor. + Creates a new instance of a LogicMonitor device datasource. - The New-LMDeviceProperty function creates a new device property in LogicMonitor. It allows you to specify the property name and value, and either the device ID or device name. + The New-LMDeviceDatasourceInstance function creates a new instance of a LogicMonitor device datasource. It requires valid API credentials and a logged-in session. - New-LMDeviceProperty - - Id + New-LMDeviceDatasourceInstance + + DisplayName - Specifies the ID of the device. This parameter is mandatory when using the 'Id' parameter set. + The display name of the new instance. - Int32 + String - Int32 + String - 0 + None - PropertyName + WildValue - Specifies the name of the property to create. + The wild value of the new instance. String @@ -39851,10 +41507,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - PropertyValue + + WildValue2 - Specifies the value of the property to create. + The second wild value of the new instance. String @@ -39863,25 +41519,58 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - ProgressAction + + Description - {{ Fill ProgressAction Description }} + The description of the new instance. - ActionPreference + String - ActionPreference + String None - - - New-LMDeviceProperty - - Name + + Properties - Specifies the name of the device. This parameter is mandatory when using the 'Name' parameter set. + A hashtable of custom properties for the new instance. + + Hashtable + + Hashtable + + + None + + + StopMonitoring + + Specifies whether to stop monitoring the new instance. Default is $false. + + Boolean + + Boolean + + + False + + + DisableAlerting + + Specifies whether to disable alerting for the new instance. Default is $false. + + Boolean + + Boolean + + + False + + + InstanceGroupId + + The ID of the instance group to which the new instance belongs. String @@ -39891,9 +41580,9 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - PropertyName + DatasourceName - Specifies the name of the property to create. + The name of the datasource associated with the new instance. Mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. String @@ -39902,10 +41591,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - PropertyValue + + Name - Specifies the value of the property to create. + The name of the host device associated with the new instance. Mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. String @@ -39914,6 +41603,28 @@ Creates a new scheduled downtime for the "Production Servers" device group. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -39927,131 +41638,12 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - - - - Id - - Specifies the ID of the device. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the name of the device. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - PropertyName - - Specifies the name of the property to create. - - String - - String - - - None - - - PropertyValue - - Specifies the value of the property to create. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor.DeviceProperty object. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - New-LMDeviceProperty -Id 1234 -PropertyName "Location" -PropertyValue "New York" - - Creates a new device property with the name "Location" and value "New York" for the device with ID 1234. - - - - -------------------------- EXAMPLE 2 -------------------------- - New-LMDeviceProperty -Name "Server01" -PropertyName "Environment" -PropertyValue "Production" - - Creates a new device property with the name "Environment" and value "Production" for the device with the name "Server01". - - - - - - - - New-LMDeviceSDT - New - LMDeviceSDT - - Creates a new Logic Monitor Device Scheduled Down Time (SDT). - - - - The New-LMDeviceSDT function creates a new SDT for a Logic Monitor device. It allows you to specify the comment, start date, end date, timezone, and device ID or device name. - - - New-LMDeviceSDT + New-LMDeviceDatasourceInstance - Comment + DisplayName - Specifies the comment for the SDT. + The display name of the new instance. String @@ -40061,33 +41653,9 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - StartDate - - Specifies the start date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. - - DateTime - - DateTime - - - None - - - EndDate - - Specifies the end date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. - - DateTime - - DateTime - - - None - - - DeviceName + WildValue - Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + The wild value of the new instance. String @@ -40096,25 +41664,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - New-LMDeviceSDT - - Comment + + WildValue2 - Specifies the comment for the SDT. + The second wild value of the new instance. String @@ -40123,61 +41676,58 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - StartDate + + Description - Specifies the start date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. + The description of the new instance. - DateTime + String - DateTime + String None - - EndDate + + Properties - Specifies the end date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. + A hashtable of custom properties for the new instance. - DateTime + Hashtable - DateTime + Hashtable None - - DeviceId + + StopMonitoring - Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + Specifies whether to stop monitoring the new instance. Default is $false. - String + Boolean - String + Boolean - None + False - - ProgressAction + + DisableAlerting - {{ Fill ProgressAction Description }} + Specifies whether to disable alerting for the new instance. Default is $false. - ActionPreference + Boolean - ActionPreference + Boolean - None + False - - - New-LMDeviceSDT - - Comment + + InstanceGroupId - Specifies the comment for the SDT. + The ID of the instance group to which the new instance belongs. String @@ -40187,9 +41737,9 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - DeviceId + DatasourceName - Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + The name of the datasource associated with the new instance. Mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. String @@ -40198,10 +41748,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - StartHour + + Id - Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + The ID of the host device associated with the new instance. Mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. Int32 @@ -40210,46 +41760,47 @@ Creates a new scheduled downtime for the "Production Servers" device group. 0 - - StartMinute + + WhatIf - Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - EndHour + + Confirm - Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False - - EndMinute + + ProgressAction - Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference - 0 + None + + + New-LMDeviceDatasourceInstance - WeekDay + DisplayName - Specifies the day of the week for weekly or monthly by week SDTs. + The display name of the new instance. String @@ -40258,25 +41809,22 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - ProgressAction + + WildValue - {{ Fill ProgressAction Description }} + The wild value of the new instance. - ActionPreference + String - ActionPreference + String None - - - New-LMDeviceSDT - - Comment + + WildValue2 - Specifies the comment for the SDT. + The second wild value of the new instance. String @@ -40285,10 +41833,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - DeviceId + + Description - Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + The description of the new instance. String @@ -40297,58 +41845,70 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - StartHour + + Properties - Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + A hashtable of custom properties for the new instance. - Int32 + Hashtable - Int32 + Hashtable - 0 + None - - StartMinute + + StopMonitoring - Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + Specifies whether to stop monitoring the new instance. Default is $false. - Int32 + Boolean - Int32 + Boolean - 0 + False - - EndHour + + DisableAlerting - Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + Specifies whether to disable alerting for the new instance. Default is $false. - Int32 + Boolean - Int32 + Boolean - 0 + False + + + InstanceGroupId + + The ID of the instance group to which the new instance belongs. + + String + + String + + + None - EndMinute + DatasourceId - Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + The ID of the datasource associated with the new instance. Mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. Int32 Int32 - 0 + None - - WeekDay + + Name - Specifies the day of the week for weekly or monthly by week SDTs. + The name of the host device associated with the new instance. Mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. String @@ -40357,17 +41917,27 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - WeekOfMonth + + WhatIf - Specifies which week of the month for monthly by week SDTs. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False ProgressAction @@ -40383,11 +41953,11 @@ Creates a new scheduled downtime for the "Production Servers" device group. - New-LMDeviceSDT + New-LMDeviceDatasourceInstance - Comment + DisplayName - Specifies the comment for the SDT. + The display name of the new instance. String @@ -40397,9 +41967,9 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - DeviceId + WildValue - Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + The wild value of the new instance. String @@ -40408,85 +41978,70 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - StartHour - - Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute + + WildValue2 - Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + The second wild value of the new instance. - Int32 + String - Int32 + String - 0 + None - - EndHour + + Description - Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + The description of the new instance. - Int32 + String - Int32 + String - 0 + None - - EndMinute + + Properties - Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + A hashtable of custom properties for the new instance. - Int32 + Hashtable - Int32 + Hashtable - 0 + None - - DayOfMonth + + StopMonitoring - Specifies the day of the month for monthly SDTs. + Specifies whether to stop monitoring the new instance. Default is $false. - Int32 + Boolean - Int32 + Boolean - 0 + False - - ProgressAction + + DisableAlerting - {{ Fill ProgressAction Description }} + Specifies whether to disable alerting for the new instance. Default is $false. - ActionPreference + Boolean - ActionPreference + Boolean - None + False - - - New-LMDeviceSDT - - Comment + + InstanceGroupId - Specifies the comment for the SDT. + The ID of the instance group to which the new instance belongs. String @@ -40496,21 +42051,21 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - DeviceId + DatasourceId - Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + The ID of the datasource associated with the new instance. Mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - String + Int32 - String + Int32 None - - StartHour + + Id - Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + The ID of the host device associated with the new instance. Mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. Int32 @@ -40519,41 +42074,27 @@ Creates a new scheduled downtime for the "Production Servers" device group. 0 - - StartMinute + + WhatIf - Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - EndHour + + Confirm - Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 - - - EndMinute - - Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. - - Int32 - - Int32 - - - 0 + False ProgressAction @@ -40568,12 +42109,244 @@ Creates a new scheduled downtime for the "Production Servers" device group.None + + + + DisplayName + + The display name of the new instance. + + String + + String + + + None + + + WildValue + + The wild value of the new instance. + + String + + String + + + None + + + WildValue2 + + The second wild value of the new instance. + + String + + String + + + None + + + Description + + The description of the new instance. + + String + + String + + + None + + + Properties + + A hashtable of custom properties for the new instance. + + Hashtable + + Hashtable + + + None + + + StopMonitoring + + Specifies whether to stop monitoring the new instance. Default is $false. + + Boolean + + Boolean + + + False + + + DisableAlerting + + Specifies whether to disable alerting for the new instance. Default is $false. + + Boolean + + Boolean + + + False + + + InstanceGroupId + + The ID of the instance group to which the new instance belongs. + + String + + String + + + None + + + DatasourceName + + The name of the datasource associated with the new instance. Mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + + String + + String + + + None + + + DatasourceId + + The ID of the datasource associated with the new instance. Mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + + Int32 + + Int32 + + + None + + + Id + + The ID of the host device associated with the new instance. Mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the host device associated with the new instance. Mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.DeviceDatasourceInstance object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMDeviceDatasourceInstance -DisplayName "Instance 1" -WildValue "Value 1" -Description "This is a new instance" -DatasourceName "DataSource 1" -Name "Host Device 1" + + This example creates a new instance of a LogicMonitor device datasource with the specified display name, wild value, description, datasource name, and host device name. + + + + + + + + New-LMDeviceDatasourceInstanceGroup + New + LMDeviceDatasourceInstanceGroup + + Creates a new instance group for a LogicMonitor device datasource. + + + + The New-LMDeviceDatasourceInstanceGroup function creates a new instance group for a LogicMonitor device datasource. It requires the user to be logged in and have valid API credentials. + + - New-LMDeviceSDT + New-LMDeviceDatasourceInstanceGroup - Comment + InstanceGroupName - Specifies the comment for the SDT. + The name of the instance group to create. This parameter is mandatory. String @@ -40582,10 +42355,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - DeviceName + + Description - Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + The description of the instance group. String @@ -40595,64 +42368,50 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - StartHour - - Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute + DatasourceName - Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + The name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. - Int32 + String - Int32 + String - 0 + None - - EndHour + + Name - Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + The name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. - Int32 + String - Int32 + String - 0 + None - - EndMinute + + WhatIf - Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - WeekDay + + Confirm - Specifies the day of the week for weekly or monthly by week SDTs. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -40668,11 +42427,11 @@ Creates a new scheduled downtime for the "Production Servers" device group. - New-LMDeviceSDT + New-LMDeviceDatasourceInstanceGroup - Comment + InstanceGroupName - Specifies the comment for the SDT. + The name of the instance group to create. This parameter is mandatory. String @@ -40681,10 +42440,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - DeviceName + + Description - Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + The description of the instance group. String @@ -40694,45 +42453,21 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - StartHour - - Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour + DatasourceName - Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + The name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. - Int32 + String - Int32 + String - 0 + None - - EndMinute + + Id - Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + The ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. Int32 @@ -40741,29 +42476,27 @@ Creates a new scheduled downtime for the "Production Servers" device group. 0 - - WeekDay + + WhatIf - Specifies the day of the week for weekly or monthly by week SDTs. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - WeekOfMonth + + Confirm - Specifies which week of the month for monthly by week SDTs. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -40779,11 +42512,11 @@ Creates a new scheduled downtime for the "Production Servers" device group. - New-LMDeviceSDT + New-LMDeviceDatasourceInstanceGroup - Comment + InstanceGroupName - Specifies the comment for the SDT. + The name of the instance group to create. This parameter is mandatory. String @@ -40792,10 +42525,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - DeviceName + + Description - Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + The description of the instance group. String @@ -40805,21 +42538,9 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - StartHour - - Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute + DatasourceId - Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + The ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. Int32 @@ -40828,41 +42549,39 @@ Creates a new scheduled downtime for the "Production Servers" device group. 0 - - EndHour + + Name - Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + The name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. - Int32 + String - Int32 + String - 0 + None - - EndMinute + + WhatIf - Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - DayOfMonth + + Confirm - Specifies the day of the month for monthly SDTs. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False ProgressAction @@ -40878,11 +42597,11 @@ Creates a new scheduled downtime for the "Production Servers" device group. - New-LMDeviceSDT + New-LMDeviceDatasourceInstanceGroup - Comment + InstanceGroupName - Specifies the comment for the SDT. + The name of the instance group to create. This parameter is mandatory. String @@ -40891,10 +42610,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - DeviceName + + Description - Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + The description of the instance group. String @@ -40904,9 +42623,9 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - StartHour + DatasourceId - Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + The ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. Int32 @@ -40915,10 +42634,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. 0 - - StartMinute + + Id - Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + The ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. Int32 @@ -40927,29 +42646,27 @@ Creates a new scheduled downtime for the "Production Servers" device group. 0 - - EndHour + + WhatIf - Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - EndMinute + + Confirm - Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False ProgressAction @@ -40967,9 +42684,9 @@ Creates a new scheduled downtime for the "Production Servers" device group. - Comment + InstanceGroupName - Specifies the comment for the SDT. + The name of the instance group to create. This parameter is mandatory. String @@ -40978,48 +42695,24 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - StartDate + + Description - Specifies the start date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. + The description of the instance group. - DateTime + String - DateTime + String None - EndDate + DatasourceName - Specifies the end date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. + The name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. - DateTime - - DateTime - - - None - - - DeviceId - - Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. - - String - - String - - - None - - - DeviceName - - Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. - - String + String String @@ -41027,33 +42720,9 @@ Creates a new scheduled downtime for the "Production Servers" device group.None - StartHour - - Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. - - Int32 - - Int32 - - - 0 - - - StartMinute - - Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. - - Int32 - - Int32 - - - 0 - - - EndHour + DatasourceId - Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + The ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. Int32 @@ -41062,10 +42731,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. 0 - - EndMinute + + Id - Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + The ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. Int32 @@ -41074,10 +42743,10 @@ Creates a new scheduled downtime for the "Production Servers" device group. 0 - - WeekDay + + Name - Specifies the day of the week for weekly or monthly by week SDTs. + The name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. String @@ -41086,29 +42755,29 @@ Creates a new scheduled downtime for the "Production Servers" device group. None - - WeekOfMonth + + WhatIf - Specifies which week of the month for monthly by week SDTs. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String + SwitchParameter - String + SwitchParameter - None + False - - DayOfMonth + + Confirm - Specifies the day of the month for monthly SDTs. + Prompts you for confirmation before running the cmdlet. - Int32 + SwitchParameter - Int32 + SwitchParameter - 0 + False ProgressAction @@ -41136,7 +42805,7 @@ Creates a new scheduled downtime for the "Production Servers" device group. - Returns LogicMonitor.SDT object. + Returns LogicMonitor.DeviceDatasourceInstanceGroup object. @@ -41151,8 +42820,16 @@ Creates a new scheduled downtime for the "Production Servers" device group. -------------------------- EXAMPLE 1 -------------------------- - New-LMDeviceSDT -Comment "Maintenance window" -StartDate "2022-01-01 00:00:00" -EndDate "2022-01-01 06:00:00" -DeviceId "12345" -Creates a one-time SDT for the device with ID "12345". + New-LMDeviceDatasourceInstanceGroup -InstanceGroupName "Group1" -Description "Instance group for Device1" -DatasourceName "DataSource1" -Name "Device1" +Creates a new instance group named "Group1" with the description "Instance group for Device1" for the device named "Device1" and the datasource named "DataSource1". + + + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMDeviceDatasourceInstanceGroup -InstanceGroupName "Group2" -Description "Instance group for Device2" -DatasourceId 123 -Id 456 +Creates a new instance group named "Group2" with the description "Instance group for Device2" for the device with ID 456 and the datasource with ID 123. @@ -41162,47 +42839,23 @@ Creates a one-time SDT for the device with ID "12345". - New-LMEnhancedNetScan + New-LMDeviceDatasourceInstanceSDT New - LMEnhancedNetScan + LMDeviceDatasourceInstanceSDT - Creates a new enhanced network scan in LogicMonitor. + Creates a new SDT entry for a Logic Monitor device datasource instance. - The New-LMEnhancedNetScan function creates a new enhanced network scan in LogicMonitor. It allows you to specify various parameters such as the collector ID, name, net scan group name, custom credentials, filters, description, exclude duplicate type, method, next start, next start epoch, Groovy script, credential group ID, and credential group name. + The New-LMDeviceDatasourceInstanceSDT function creates a new SDT entry for an instance of a Logic Monitor device datasource. It allows you to specify various parameters such as comment, start date, end date, timezone, start hour, and start minute. - New-LMEnhancedNetScan - - CollectorId - - The ID of the collector where the network scan will be executed. - - String - - String - - - None - - - NextStartEpoch - - The next start epoch for the network scan. Default value is "0". - - String - - String - - - 0 - - - GroovyScript + New-LMDeviceDatasourceInstanceSDT + + Comment - The Groovy script to be executed during the network scan. + Specifies the comment for the new instance SDT. String @@ -41211,34 +42864,34 @@ Creates a one-time SDT for the device with ID "12345". None - - CredentialGroupId + + StartDate - The ID of the credential group to be used for the network scan. + Specifies the start date for the new instance SDT. This parameter is mandatory when using the 'OneTime' parameter set. - String + DateTime - String + DateTime None - - CredentialGroupName + + EndDate - The name of the credential group to be used for the network scan. + Specifies the end date for the new instance SDT. This parameter is mandatory when using the 'OneTime' parameter set. - String + DateTime - String + DateTime None - - Name + + DeviceDataSourceInstanceId - The name of the network scan. + Specifies the ID of the device datasource instance for which to create the SDT. String @@ -41247,46 +42900,47 @@ Creates a one-time SDT for the device with ID "12345". None - - NetScanGroupName + + WhatIf - The name of the net scan group. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - CustomCredentials + + Confirm - A list of custom credentials to be used for the network scan. + Prompts you for confirmation before running the cmdlet. - System.Collections.Generic.List`1[System.Management.Automation.PSObject] - System.Collections.Generic.List`1[System.Management.Automation.PSObject] + SwitchParameter - None + False - - Filters + + ProgressAction - A list of filters to be applied to the network scan. + {{ Fill ProgressAction Description }} - System.Collections.Generic.List`1[System.Management.Automation.PSObject] + ActionPreference - System.Collections.Generic.List`1[System.Management.Automation.PSObject] + ActionPreference None - - Description + + + New-LMDeviceDatasourceInstanceSDT + + Comment - A description of the network scan. + Specifies the comment for the new instance SDT. String @@ -41295,275 +42949,70 @@ Creates a one-time SDT for the device with ID "12345". None - - ExcludeDuplicateType + + StartHour - The type of duplicates to be excluded. Default value is "1". + Specifies the start hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - String + Int32 - String + Int32 - 1 + 0 - - Method + + StartMinute - The method to be used for the network scan. Default value is "enhancedScript". + Specifies the start minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - String + Int32 - String + Int32 - EnhancedScript + 0 - - NextStart + + EndHour - The next start time for the network scan. Default value is "manual". + Specifies the end hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - String + Int32 - String + Int32 - Manual + 0 - - ProgressAction + + EndMinute - {{ Fill ProgressAction Description }} + Specifies the end minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - ActionPreference + Int32 - ActionPreference + Int32 - None + 0 - - - - - CollectorId - - The ID of the collector where the network scan will be executed. - - String - - String - - - None - - - Name - - The name of the network scan. - - String - - String - - - None - - - NetScanGroupName - - The name of the net scan group. - - String - - String - - - None - - - CustomCredentials - - A list of custom credentials to be used for the network scan. - - System.Collections.Generic.List`1[System.Management.Automation.PSObject] - - System.Collections.Generic.List`1[System.Management.Automation.PSObject] - - - None - - - Filters - - A list of filters to be applied to the network scan. - - System.Collections.Generic.List`1[System.Management.Automation.PSObject] - - System.Collections.Generic.List`1[System.Management.Automation.PSObject] - - - None - - - Description - - A description of the network scan. - - String - - String - - - None - - - ExcludeDuplicateType - - The type of duplicates to be excluded. Default value is "1". - - String - - String - - - 1 - - - Method - - The method to be used for the network scan. Default value is "enhancedScript". - - String - - String - - - EnhancedScript - - - NextStart - - The next start time for the network scan. Default value is "manual". - - String - - String - - - Manual - - - NextStartEpoch - - The next start epoch for the network scan. Default value is "0". - - String - - String - - - 0 - - - GroovyScript - - The Groovy script to be executed during the network scan. - - String - - String - - - None - - - CredentialGroupId - - The ID of the credential group to be used for the network scan. - - String - - String - - - None - - - CredentialGroupName - - The name of the credential group to be used for the network scan. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - - For more information about LogicMonitor network scans, refer to the LogicMonitor documentation. - - - - - -------------------------- EXAMPLE 1 -------------------------- - New-LMEnhancedNetScan -CollectorId "12345" -Name "MyNetScan" -NetScanGroupName "Group1" -CustomCredentials $customCreds -Filters $filters -Description "This is a network scan" -ExcludeDuplicateType "1" -Method "enhancedScript" -NextStart "manual" -NextStartEpoch "0" -GroovyScript "script" -CredentialGroupId "67890" -CredentialGroupName "Group2" - - This example creates a new enhanced network scan with the specified parameters. - - - - - - - - New-LMLogicModule - New - LMLogicModule - - Creates a new Logic Module in LogicMonitor. - - - - The New-LMLogicModule function creates a new Logic Module in LogicMonitor. It supports various types of modules including datasources, property rules, topology sources, event sources, log sources, and config sources. - - - - New-LMLogicModule - - LogicModule + + WeekDay - A PSCustomObject containing the Logic Module configuration. Must follow the schema model defined in LogicMonitor's API documentation. + Specifies the day of the week for the new instance SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. - PSObject + String - PSObject + String None - - Type + + DeviceDataSourceInstanceId - The type of Logic Module to create. Valid values are: datasources, propertyrules, topologysources, eventsources, logsources, configsources + Specifies the ID of the device datasource instance for which to create the SDT. String @@ -41607,128 +43056,12 @@ Creates a one-time SDT for the device with ID "12345". None - - - - LogicModule - - A PSCustomObject containing the Logic Module configuration. Must follow the schema model defined in LogicMonitor's API documentation. - - PSObject - - PSObject - - - None - - - Type - - The type of Logic Module to create. Valid values are: datasources, propertyrules, topologysources, eventsources, logsources, configsources - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor object of the appropriate type based on the Type parameter: LogicMonitor.Datasource, LogicMonitor.PropertySource, LogicMonitor.TopologySource, LogicMonitor.EventSource, LogicMonitor.LogSource, LogicMonitor.ConfigSource - - - - - - - - - You must run Connect-LMAccount before running this command. For Logic Module schema details, see: https://www.logicmonitor.com/swagger-ui-master/api-v3/dist/#/Datasources/addDatasourceById - - - - - -------------------------- EXAMPLE 1 -------------------------- - $config = @{ - name = "MyLogicModule" - # Additional configuration properties -} -New-LMLogicModule -LogicModule $config -Type "datasources" - - - - - - - - - - New-LMLogPartition - New - LMLogPartition - - Creates a new LogicMonitor Log Partition. - - - - The New-LMLogPartition function creates a new LogicMonitor Log Partition. - - - New-LMLogPartition - - Name + New-LMDeviceDatasourceInstanceSDT + + Comment - The name of the new log partition. + Specifies the comment for the new instance SDT. String @@ -41737,22 +43070,22 @@ New-LMLogicModule -LogicModule $config -Type "datasources" None - - Description + + StartHour - The description of the new log partition. + Specifies the start hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - String + Int32 - String + Int32 - None + 0 - - Retention + + StartMinute - The retention in days of the new log partition. + Specifies the start minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. Int32 @@ -41761,10 +43094,34 @@ New-LMLogicModule -LogicModule $config -Type "datasources" 0 - - Status + + EndHour - The status of the new log partition. Possible values are "active" or "inactive". + Specifies the end hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for the new instance SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. String @@ -41773,10 +43130,10 @@ New-LMLogicModule -LogicModule $config -Type "datasources" None - - Tenant + + WeekOfMonth - The tenant of the new log partition. + Specifies the week of the month for the new instance SDT. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. String @@ -41785,10 +43142,10 @@ New-LMLogicModule -LogicModule $config -Type "datasources" None - - Sku + + DeviceDataSourceInstanceId - The sku of the new log partition. If not specified, the sku from the default log partition will be used. Its recommended to not specify this parameter and let the function determine the sku. + Specifies the ID of the device datasource instance for which to create the SDT. String @@ -41797,6 +43154,28 @@ New-LMLogicModule -LogicModule $config -Type "datasources" None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -41810,149 +43189,12 @@ New-LMLogicModule -LogicModule $config -Type "datasources" None - - - - Name - - The name of the new log partition. - - String - - String - - - None - - - Description - - The description of the new log partition. - - String - - String - - - None - - - Retention - - The retention in days of the new log partition. - - Int32 - - Int32 - - - 0 - - - Status - - The status of the new log partition. Possible values are "active" or "inactive". - - String - - String - - - None - - - Tenant - - The tenant of the new log partition. - - String - - String - - - None - - - Sku - - The sku of the new log partition. If not specified, the sku from the default log partition will be used. Its recommended to not specify this parameter and let the function determine the sku. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor.LogPartition object. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Create a new log partition -New-LMLogPartition -Name "customerA" -Description "Customer A Log Partition" -Retention 30 -Status "active" -Tenant "customerA" - - - - - - - - - - New-LMNetScan - New - LMNetScan - - Creates a new network scan in LogicMonitor. - - - - The New-LMNetScan function is used to create a new network scan in LogicMonitor. It sends a POST request to the LogicMonitor API to create the network scan with the specified parameters. - - - New-LMNetScan - - CollectorId + New-LMDeviceDatasourceInstanceSDT + + Comment - The ID of the collector to use for the network scan. This parameter is mandatory. + Specifies the comment for the new instance SDT. String @@ -41961,70 +43203,70 @@ New-LMLogPartition -Name "customerA" -Description "Customer A Log Partition" -Re None - - Schedule + + StartHour - {{ Fill Schedule Description }} + Specifies the start hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - PSObject + Int32 - PSObject + Int32 - None + 0 - - SubnetRange + + StartMinute - The subnet range to scan. This parameter is mandatory. + Specifies the start minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - String + Int32 - String + Int32 - None + 0 - - CredentialGroupId + + EndHour - The ID of the credential group to use for the network scan. + Specifies the end hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - String + Int32 - String + Int32 - None + 0 - - CredentialGroupName + + EndMinute - The name of the credential group to use for the network scan. + Specifies the end minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - String + Int32 - String + Int32 - None + 0 - - ChangeNameToken + + DayOfMonth - The token to use for changing the name of discovered devices. The default value is "##REVERSEDNS##". + Specifies the day of the month for the new instance SDT. This parameter is mandatory when using the 'Monthly' parameter set. - String + Int32 - String + Int32 - ##REVERSEDNS## + 0 - - Name + + DeviceDataSourceInstanceId - The name of the network scan. This parameter is mandatory. + Specifies the ID of the device datasource instance for which to create the SDT. String @@ -42033,89 +43275,136 @@ New-LMLogPartition -Name "customerA" -Description "Customer A Log Partition" -Re None - - Description + + WhatIf - The description of the network scan. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference None - - ExcludeDuplicateType + + + New-LMDeviceDatasourceInstanceSDT + + Comment - The type of duplicate exclusion to apply. The default value is "1". + Specifies the comment for the new instance SDT. String String - 1 + None - - IgnoreSystemIpDuplicates + + StartHour - Specifies whether to ignore duplicate system IPs. The default value is $false. + Specifies the start hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - Boolean + Int32 - Boolean + Int32 - False + 0 - - Method + + StartMinute - The method to use for the network scan. Only "nmap" is supported. The default value is "nmap". + Specifies the start minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - String + Int32 - String + Int32 - Nmap + 0 - - NextStart + + EndHour - The next start time for the network scan. The default value is "manual". + Specifies the end hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - String + Int32 - String + Int32 - Manual + 0 - - NextStartEpoch + + EndMinute - The next start time epoch for the network scan. The default value is "0". + Specifies the end minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - String + Int32 - String + Int32 0 - - NetScanGroupId + + DeviceDataSourceInstanceId - The ID of the network scan group to assign the network scan to. The default value is "1". + Specifies the ID of the device datasource instance for which to create the SDT. String String - 1 + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False ProgressAction @@ -42132,10 +43421,10 @@ New-LMLogPartition -Name "customerA" -Description "Customer A Log Partition" -Re - - CollectorId + + Comment - The ID of the collector to use for the network scan. This parameter is mandatory. + Specifies the comment for the new instance SDT. String @@ -42144,118 +43433,82 @@ New-LMLogPartition -Name "customerA" -Description "Customer A Log Partition" -Re None - - Name + + StartDate - The name of the network scan. This parameter is mandatory. + Specifies the start date for the new instance SDT. This parameter is mandatory when using the 'OneTime' parameter set. - String + DateTime - String + DateTime None - - Description + + EndDate - The description of the network scan. + Specifies the end date for the new instance SDT. This parameter is mandatory when using the 'OneTime' parameter set. - String + DateTime - String + DateTime None - - ExcludeDuplicateType - - The type of duplicate exclusion to apply. The default value is "1". - - String - - String - - - 1 - - - IgnoreSystemIpDuplicates - - Specifies whether to ignore duplicate system IPs. The default value is $false. - - Boolean - - Boolean - - - False - - - Method - - The method to use for the network scan. Only "nmap" is supported. The default value is "nmap". - - String - - String - - - Nmap - - - NextStart + + StartHour - The next start time for the network scan. The default value is "manual". + Specifies the start hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - String + Int32 - String + Int32 - Manual + 0 - - NextStartEpoch + + StartMinute - The next start time epoch for the network scan. The default value is "0". + Specifies the start minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - String + Int32 - String + Int32 0 - - NetScanGroupId + + EndHour - The ID of the network scan group to assign the network scan to. The default value is "1". + Specifies the end hour for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 23. - String + Int32 - String + Int32 - 1 + 0 - - Schedule + + EndMinute - {{ Fill Schedule Description }} + Specifies the end minute for the new instance SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. The value must be between 0 and 59. - PSObject + Int32 - PSObject + Int32 - None + 0 - - SubnetRange + + WeekDay - The subnet range to scan. This parameter is mandatory. + Specifies the day of the week for the new instance SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. String @@ -42264,10 +43517,10 @@ New-LMLogPartition -Name "customerA" -Description "Customer A Log Partition" -Re None - - CredentialGroupId + + WeekOfMonth - The ID of the credential group to use for the network scan. + Specifies the week of the month for the new instance SDT. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. String @@ -42276,139 +43529,53 @@ New-LMLogPartition -Name "customerA" -Description "Customer A Log Partition" -Re None - - CredentialGroupName + + DayOfMonth - The name of the credential group to use for the network scan. + Specifies the day of the month for the new instance SDT. This parameter is mandatory when using the 'Monthly' parameter set. - String + Int32 - String + Int32 - None + 0 - - ChangeNameToken + + DeviceDataSourceInstanceId - The token to use for changing the name of discovered devices. The default value is "##REVERSEDNS##". + Specifies the ID of the device datasource instance for which to create the SDT. String String - ##REVERSEDNS## - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - None - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - New-LMNetScan -CollectorId "12345" -Name "MyNetScan" -SubnetRange "192.168.0.0/24" -Creates a new network scan with the specified collector ID, name, and subnet range. - - - - - - - - - - New-LMNetscanGroup - New - LMNetscanGroup - - Creates a new LogicMonitor Netscan Group. - - - - The New-LMNetscanGroup function creates a new Netscan Group in LogicMonitor. It allows you to specify a name and optional description for the group. - - - - New-LMNetscanGroup - - Name - - Specifies the name of the Netscan Group. This parameter is mandatory. - - String - - String - - - None - - - Description - - Specifies the description for the Netscan Group. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - Name + + WhatIf - Specifies the name of the Netscan Group. This parameter is mandatory. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String + SwitchParameter - String + SwitchParameter - None + False - - Description + + Confirm - Specifies the description for the Netscan Group. + Prompts you for confirmation before running the cmdlet. - String + SwitchParameter - String + SwitchParameter - None + False ProgressAction @@ -42436,7 +43603,7 @@ Creates a new network scan with the specified collector ID, name, and subnet ran - Returns LogicMonitor.NetScanGroup object. + Returns LogicMonitor.SDT object. @@ -42451,8 +43618,8 @@ Creates a new network scan with the specified collector ID, name, and subnet ran -------------------------- EXAMPLE 1 -------------------------- - New-LMNetscanGroup -Name "Group1" -Description "This is a sample group" -Creates a new Netscan Group with the name "Group1" and the description "This is a sample group". + New-LMDeviceDatasourceInstanceSDT -Comment "Test SDT Instance" -StartDate (Get-Date) -EndDate (Get-Date).AddDays(7) -StartHour 8 -StartMinute 30 -DeviceDataSourceInstanceId 1234 +Creates a new one-time instance SDT with a comment, start date, end date, start hour, and start minute. @@ -42462,23 +43629,23 @@ Creates a new Netscan Group with the name "Group1" and the description "This is - New-LMNormalizedProperties + New-LMDeviceDatasourceSDT New - LMNormalizedProperties + LMDeviceDatasourceSDT - Creates normalized properties in LogicMonitor. + Creates a new device datasource SDT (Scheduled Downtime) in Logic Monitor. - The New-LMNormalizedProperties cmdlet creates normalized properties in LogicMonitor. Normalized properties allow you to map multiple host properties to a single alias that can be used across your environment. + The New-LMDeviceDatasourceSDT function creates a new device datasource SDT (Scheduled Downtime) in Logic Monitor. It allows you to specify the comment, start date and time, end date and time, and the timezone for the SDT. - New-LMNormalizedProperties - - Alias + New-LMDeviceDatasourceSDT + + Comment - The alias name for the normalized property. + The comment for the SDT. This parameter is mandatory. String @@ -42487,18 +43654,64 @@ Creates a new Netscan Group with the name "Group1" and the description "This is None - - Properties + + StartDate - An array of host property names to map to the alias. + The start date for the SDT. This parameter is mandatory when using the 'OneTime' parameter set. - Array + DateTime - Array + DateTime + + + None + + + EndDate + + The end date for the SDT. This parameter is mandatory when using the 'OneTime' parameter set. + + DateTime + + DateTime None + + DeviceDataSourceId + + The ID of the device datasource for which to create the SDT. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -42512,101 +43725,12 @@ Creates a new Netscan Group with the name "Group1" and the description "This is None - - - - Alias - - The alias name for the normalized property. - - String - - String - - - None - - - Properties - - An array of host property names to map to the alias. - - Array - - Array - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor.NormalizedProperties object. - - - - - - - - - You must run Connect-LMAccount before running this command. Reserved for internal use. - - - - - -------------------------- EXAMPLE 1 -------------------------- - #Creates a normalized property with alias "location" mapped to multiple source properties. -New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sysLocation", "auto.meraki.location") - - - - - - - - - - New-LMOpsNote - New - LMOpsNote - - Creates a new LogicMonitor OpsNote. - - - - The New-LMOpsNote function is used to create a new OpsNote in LogicMonitor. OpsNotes are used to document important information or events related to monitoring. - - - New-LMOpsNote - - Note + New-LMDeviceDatasourceSDT + + Comment - Specifies the content of the OpsNote. This parameter is mandatory. + The comment for the SDT. This parameter is mandatory. String @@ -42615,66 +43739,100 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - NoteDate + + StartHour - Specifies the date and time of the OpsNote. If not provided, the current date and time will be used. + The start hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. - DateTime + Int32 - DateTime + Int32 - None + 0 - - Tags + + StartMinute - Specifies an array of tags to associate with the OpsNote. + The start minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. - String[] + Int32 - String[] + Int32 - None + 0 - - DeviceGroupIds + + EndHour - Specifies an array of device group IDs to associate with the OpsNote. + The end hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. - String[] + Int32 - String[] + Int32 - None + 0 - - WebsiteIds + + EndMinute - Specifies an array of website IDs to associate with the OpsNote. + The end minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. - String[] + Int32 - String[] + Int32 + + + 0 + + + WeekDay + + The day of the week for the SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + + String + + String None - - DeviceIds + + DeviceDataSourceId - Specifies an array of device IDs to associate with the OpsNote. + The ID of the device datasource for which to create the SDT. - String[] + String - String[] + String None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -42688,80 +43846,16937 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - - - Note - - Specifies the content of the OpsNote. This parameter is mandatory. - - String - - String - - - None - - - NoteDate - - Specifies the date and time of the OpsNote. If not provided, the current date and time will be used. - - DateTime + + New-LMDeviceDatasourceSDT + + Comment + + The comment for the SDT. This parameter is mandatory. + + String + + String + + + None + + + StartHour + + The start hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + The start minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + The end hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + The end minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + The day of the week for the SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + + String + + String + + + None + + + WeekOfMonth + + The week of the month for the SDT. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + + String + + String + + + None + + + DeviceDataSourceId + + The ID of the device datasource for which to create the SDT. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceDatasourceSDT + + Comment + + The comment for the SDT. This parameter is mandatory. + + String + + String + + + None + + + StartHour + + The start hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + The start minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + The end hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + The end minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + + Int32 + + Int32 + + + 0 + + + DayOfMonth + + The day of the month for the SDT. This parameter is mandatory when using the 'Monthly' parameter set. + + Int32 + + Int32 + + + 0 + + + DeviceDataSourceId + + The ID of the device datasource for which to create the SDT. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceDatasourceSDT + + Comment + + The comment for the SDT. This parameter is mandatory. + + String + + String + + + None + + + StartHour + + The start hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + The start minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + The end hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + The end minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + + Int32 + + Int32 + + + 0 + + + DeviceDataSourceId + + The ID of the device datasource for which to create the SDT. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + The comment for the SDT. This parameter is mandatory. + + String + + String + + + None + + + StartDate + + The start date for the SDT. This parameter is mandatory when using the 'OneTime' parameter set. + + DateTime + + DateTime + + + None + + + EndDate + + The end date for the SDT. This parameter is mandatory when using the 'OneTime' parameter set. + + DateTime DateTime None - - Tags + + StartHour + + The start hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + The start minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + The end hour for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + The end minute for the SDT. This parameter is mandatory when using the 'Daily', 'Monthly', 'MonthlyByWeek', or 'Weekly' parameter sets. Must be a value between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + The day of the week for the SDT. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + + String + + String + + + None + + + WeekOfMonth + + The week of the month for the SDT. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + + String + + String + + + None + + + DayOfMonth + + The day of the month for the SDT. This parameter is mandatory when using the 'Monthly' parameter set. + + Int32 + + Int32 + + + 0 + + + DeviceDataSourceId + + The ID of the device datasource for which to create the SDT. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.SDT object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMDeviceDatasourceSDT -Comment "Maintenance window" -StartDate "2022-01-01 00:00" -EndDate "2022-01-01 06:00" -StartHour 2 -StartMinute 30 -DeviceDataSourceId 123 +Creates a new one-time device datasource SDT with a comment "Maintenance window" starting on January 1, 2022, at 00:00 and ending on the same day at 06:00. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMDeviceDatasourceSDT -Comment "Daily maintenance" -StartHour 3 -StartMinute 0 -ParameterSet Daily -DeviceDataSourceId 123 +Creates a new daily device datasource SDT with a comment "Daily maintenance" starting at 03:00. + + + + + + -------------------------- EXAMPLE 3 -------------------------- + New-LMDeviceDatasourceSDT -Comment "Monthly maintenance" -StartHour 8 -StartMinute 30 -ParameterSet Monthly -DeviceDataSourceId 123 +Creates a new monthly device datasource SDT with a comment "Monthly maintenance" starting on the 1st day of each month at 08:30. + + + + + + -------------------------- EXAMPLE 4 -------------------------- + New-LMDeviceDatasourceSDT -Comment "Weekly maintenance" -StartHour 10 -StartMinute 0 -ParameterSet Weekly -DeviceDataSourceId 123 +Creates a new weekly device datasource SDT with a comment "Weekly maintenance" starting every Monday at 10:00. + + + + + + + + + + New-LMDeviceGroup + New + LMDeviceGroup + + Creates a new LogicMonitor device group. + + + + The New-LMDeviceGroup function creates a new LogicMonitor device group with the specified parameters. + + + + New-LMDeviceGroup + + Name + + The name of the device group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the device group. + + String + + String + + + None + + + Properties + + A hashtable of custom properties for the device group. + + Hashtable + + Hashtable + + + None + + + Extra + + Specifies a object of extra properties for the device group. Used for LM Cloud resource groups + + Object + + Object + + + None + + + DefaultCollectorId + + {{ Fill DefaultCollectorId Description }} + + Int32 + + Int32 + + + 0 + + + DefaultAutoBalancedCollectorGroupId + + {{ Fill DefaultAutoBalancedCollectorGroupId Description }} + + Int32 + + Int32 + + + 0 + + + DefaultCollectorGroupId + + {{ Fill DefaultCollectorGroupId Description }} + + Int32 + + Int32 + + + 0 + + + DisableAlerting + + Specifies whether alerting is disabled for the device group. The default value is $false. + + Boolean + + Boolean + + + False + + + EnableNetFlow + + Specifies whether NetFlow is enabled for the device group. The default value is $false. + + Boolean + + Boolean + + + False + + + ParentGroupId + + The ID of the parent device group. This parameter is mandatory when using the 'GroupId' parameter set. + + Int32 + + Int32 + + + 0 + + + AppliesTo + + The applies to value for the device group. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroup + + Name + + The name of the device group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the device group. + + String + + String + + + None + + + Properties + + A hashtable of custom properties for the device group. + + Hashtable + + Hashtable + + + None + + + Extra + + Specifies a object of extra properties for the device group. Used for LM Cloud resource groups + + Object + + Object + + + None + + + DefaultCollectorId + + {{ Fill DefaultCollectorId Description }} + + Int32 + + Int32 + + + 0 + + + DefaultAutoBalancedCollectorGroupId + + {{ Fill DefaultAutoBalancedCollectorGroupId Description }} + + Int32 + + Int32 + + + 0 + + + DefaultCollectorGroupId + + {{ Fill DefaultCollectorGroupId Description }} + + Int32 + + Int32 + + + 0 + + + DisableAlerting + + Specifies whether alerting is disabled for the device group. The default value is $false. + + Boolean + + Boolean + + + False + + + EnableNetFlow + + Specifies whether NetFlow is enabled for the device group. The default value is $false. + + Boolean + + Boolean + + + False + + + ParentGroupName + + The name of the parent device group. This parameter is mandatory when using the 'GroupName' parameter set. + + String + + String + + + None + + + AppliesTo + + The applies to value for the device group. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + The name of the device group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the device group. + + String + + String + + + None + + + Properties + + A hashtable of custom properties for the device group. + + Hashtable + + Hashtable + + + None + + + Extra + + Specifies a object of extra properties for the device group. Used for LM Cloud resource groups + + Object + + Object + + + None + + + DefaultCollectorId + + {{ Fill DefaultCollectorId Description }} + + Int32 + + Int32 + + + 0 + + + DefaultAutoBalancedCollectorGroupId + + {{ Fill DefaultAutoBalancedCollectorGroupId Description }} + + Int32 + + Int32 + + + 0 + + + DefaultCollectorGroupId + + {{ Fill DefaultCollectorGroupId Description }} + + Int32 + + Int32 + + + 0 + + + DisableAlerting + + Specifies whether alerting is disabled for the device group. The default value is $false. + + Boolean + + Boolean + + + False + + + EnableNetFlow + + Specifies whether NetFlow is enabled for the device group. The default value is $false. + + Boolean + + Boolean + + + False + + + ParentGroupId + + The ID of the parent device group. This parameter is mandatory when using the 'GroupId' parameter set. + + Int32 + + Int32 + + + 0 + + + ParentGroupName + + The name of the parent device group. This parameter is mandatory when using the 'GroupName' parameter set. + + String + + String + + + None + + + AppliesTo + + The applies to value for the device group. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.DeviceGroup object. + + + + + + + + + This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMDeviceGroup -Name "MyDeviceGroup" -Description "This is a test device group" -Properties @{ "Location" = "US"; "Environment" = "Production" } -DisableAlerting $true + + This example creates a new LogicMonitor device group named "MyDeviceGroup" with a description and custom properties. Alerting is disabled for this device group. + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMDeviceGroup -Name "ChildDeviceGroup" -ParentGroupName "ParentDeviceGroup" + + This example creates a new LogicMonitor device group named "ChildDeviceGroup" with a specified parent device group. + + + + + + + + New-LMDeviceGroupProperty + New + LMDeviceGroupProperty + + Creates a new device group property in LogicMonitor. + + + + The New-LMDeviceGroupProperty function creates a new device group property in LogicMonitor. It allows you to specify the property name and value, and either the device group ID or device group name. + + + + New-LMDeviceGroupProperty + + Id + + Specifies the ID of the device group. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + PropertyName + + Specifies the name of the property to create. + + String + + String + + + None + + + PropertyValue + + Specifies the value of the property to create. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroupProperty + + Name + + Specifies the name of the device group. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + PropertyName + + Specifies the name of the property to create. + + String + + String + + + None + + + PropertyValue + + Specifies the value of the property to create. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the ID of the device group. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the device group. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + PropertyName + + Specifies the name of the property to create. + + String + + String + + + None + + + PropertyValue + + Specifies the value of the property to create. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe device group objects to this command. + + + + + + + + + + Returns LogicMonitor.DeviceGroupProperty object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMDeviceGroupProperty -Id 1234 -PropertyName "Location" -PropertyValue "New York" + + Creates a new device group property with the name "Location" and value "New York" for the device group with ID 1234. + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMDeviceGroupProperty -Name "Servers" -PropertyName "Environment" -PropertyValue "Production" + + Creates a new device group property with the name "Environment" and value "Production" for the device group with the name "Servers". + + + + + + + + New-LMDeviceGroupSDT + New + LMDeviceGroupSDT + + Creates a new LogicMonitor Device Group Scheduled Downtime. + + + + The New-LMDeviceGroupSDT function creates a new scheduled downtime for a LogicMonitor device group. This allows you to temporarily disable monitoring for a specific group of devices within your LogicMonitor account. + + + + New-LMDeviceGroupSDT + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartDate + + Specifies the start date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + + DateTime + + DateTime + + + None + + + EndDate + + Specifies the end date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + + DateTime + + DateTime + + + None + + + DeviceGroupName + + Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroupSDT + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartDate + + Specifies the start date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + + DateTime + + DateTime + + + None + + + EndDate + + Specifies the end date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + + DateTime + + DateTime + + + None + + + DeviceGroupId + + Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroupSDT + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartHour + + Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for weekly or monthly by week SDTs. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + + String + + String + + + None + + + DeviceGroupId + + Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroupSDT + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartHour + + Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for weekly or monthly by week SDTs. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + + String + + String + + + None + + + WeekOfMonth + + Specifies which week of the month for monthly by week SDTs. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + + String + + String + + + None + + + DeviceGroupId + + Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroupSDT + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartHour + + Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + DayOfMonth + + Specifies the day of the month for monthly SDTs. This parameter is mandatory when using the 'Monthly' parameter set. + + Int32 + + Int32 + + + 0 + + + DeviceGroupId + + Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroupSDT + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartHour + + Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + DeviceGroupId + + Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroupSDT + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartHour + + Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for weekly or monthly by week SDTs. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + + String + + String + + + None + + + DeviceGroupName + + Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroupSDT + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartHour + + Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for weekly or monthly by week SDTs. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + + String + + String + + + None + + + WeekOfMonth + + Specifies which week of the month for monthly by week SDTs. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + + String + + String + + + None + + + DeviceGroupName + + Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroupSDT + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartHour + + Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + DayOfMonth + + Specifies the day of the month for monthly SDTs. This parameter is mandatory when using the 'Monthly' parameter set. + + Int32 + + Int32 + + + 0 + + + DeviceGroupName + + Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceGroupSDT + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartHour + + Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + DeviceGroupName + + Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Specifies the comment for the scheduled downtime. This comment will be displayed in the LogicMonitor UI. + + String + + String + + + None + + + StartDate + + Specifies the start date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + + DateTime + + DateTime + + + None + + + EndDate + + Specifies the end date and time for the scheduled downtime. This parameter is mandatory when using the 'OneTime-DeviceGroupId' or 'OneTime-DeviceGroupName' parameter sets. + + DateTime + + DateTime + + + None + + + StartHour + + Specifies the start hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for the scheduled downtime. This parameter is mandatory when using recurring parameter sets. The value must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for weekly or monthly by week SDTs. This parameter is mandatory when using the 'Weekly' or 'MonthlyByWeek' parameter sets. + + String + + String + + + None + + + WeekOfMonth + + Specifies which week of the month for monthly by week SDTs. This parameter is mandatory when using the 'MonthlyByWeek' parameter set. + + String + + String + + + None + + + DayOfMonth + + Specifies the day of the month for monthly SDTs. This parameter is mandatory when using the 'Monthly' parameter set. + + Int32 + + Int32 + + + 0 + + + DeviceGroupId + + Specifies the ID of the device group. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + DeviceGroupName + + Specifies the name of the device group. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.SDT object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMDeviceGroupSDT -Comment "Maintenance window" -StartDate "2022-01-01 00:00:00" -EndDate "2022-01-01 06:00:00" -StartHour 2 -DeviceGroupName "Production Servers" +Creates a new scheduled downtime for the "Production Servers" device group. + + + + + + + + + + New-LMDeviceProperty + New + LMDeviceProperty + + Creates a new device property in LogicMonitor. + + + + The New-LMDeviceProperty function creates a new device property in LogicMonitor. It allows you to specify the property name and value, and either the device ID or device name. + + + + New-LMDeviceProperty + + Id + + Specifies the ID of the device. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + PropertyName + + Specifies the name of the property to create. + + String + + String + + + None + + + PropertyValue + + Specifies the value of the property to create. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceProperty + + Name + + Specifies the name of the device. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + PropertyName + + Specifies the name of the property to create. + + String + + String + + + None + + + PropertyValue + + Specifies the value of the property to create. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the ID of the device. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the device. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + PropertyName + + Specifies the name of the property to create. + + String + + String + + + None + + + PropertyValue + + Specifies the value of the property to create. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.DeviceProperty object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMDeviceProperty -Id 1234 -PropertyName "Location" -PropertyValue "New York" + + Creates a new device property with the name "Location" and value "New York" for the device with ID 1234. + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMDeviceProperty -Name "Server01" -PropertyName "Environment" -PropertyValue "Production" + + Creates a new device property with the name "Environment" and value "Production" for the device with the name "Server01". + + + + + + + + New-LMDeviceSDT + New + LMDeviceSDT + + Creates a new Logic Monitor Device Scheduled Down Time (SDT). + + + + The New-LMDeviceSDT function creates a new SDT for a Logic Monitor device. It allows you to specify the comment, start date, end date, timezone, and device ID or device name. + + + + New-LMDeviceSDT + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + StartDate + + Specifies the start date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. + + DateTime + + DateTime + + + None + + + EndDate + + Specifies the end date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. + + DateTime + + DateTime + + + None + + + DeviceName + + Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceSDT + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + StartDate + + Specifies the start date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. + + DateTime + + DateTime + + + None + + + EndDate + + Specifies the end date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. + + DateTime + + DateTime + + + None + + + DeviceId + + Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceSDT + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + DeviceId + + Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + StartHour + + Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for weekly or monthly by week SDTs. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceSDT + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + DeviceId + + Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + StartHour + + Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for weekly or monthly by week SDTs. + + String + + String + + + None + + + WeekOfMonth + + Specifies which week of the month for monthly by week SDTs. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceSDT + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + DeviceId + + Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + StartHour + + Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + DayOfMonth + + Specifies the day of the month for monthly SDTs. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceSDT + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + DeviceId + + Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + StartHour + + Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceSDT + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + DeviceName + + Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + StartHour + + Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for weekly or monthly by week SDTs. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceSDT + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + DeviceName + + Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + StartHour + + Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for weekly or monthly by week SDTs. + + String + + String + + + None + + + WeekOfMonth + + Specifies which week of the month for monthly by week SDTs. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceSDT + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + DeviceName + + Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + StartHour + + Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + DayOfMonth + + Specifies the day of the month for monthly SDTs. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMDeviceSDT + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + DeviceName + + Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + StartHour + + Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Specifies the comment for the SDT. + + String + + String + + + None + + + StartDate + + Specifies the start date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. + + DateTime + + DateTime + + + None + + + EndDate + + Specifies the end date and time for the SDT. This parameter is mandatory when using the 'OneTime-DeviceId' or 'OneTime-DeviceName' parameter sets. + + DateTime + + DateTime + + + None + + + DeviceId + + Specifies the ID of the device. This parameter is mandatory when using ID-based parameter sets. + + String + + String + + + None + + + DeviceName + + Specifies the name of the device. This parameter is mandatory when using name-based parameter sets. + + String + + String + + + None + + + StartHour + + Specifies the start hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + StartMinute + + Specifies the start minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + EndHour + + Specifies the end hour for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 23. + + Int32 + + Int32 + + + 0 + + + EndMinute + + Specifies the end minute for recurring SDTs. This parameter is mandatory when using recurring parameter sets. Must be between 0 and 59. + + Int32 + + Int32 + + + 0 + + + WeekDay + + Specifies the day of the week for weekly or monthly by week SDTs. + + String + + String + + + None + + + WeekOfMonth + + Specifies which week of the month for monthly by week SDTs. + + String + + String + + + None + + + DayOfMonth + + Specifies the day of the month for monthly SDTs. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.SDT object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMDeviceSDT -Comment "Maintenance window" -StartDate "2022-01-01 00:00:00" -EndDate "2022-01-01 06:00:00" -DeviceId "12345" +Creates a one-time SDT for the device with ID "12345". + + + + + + + + + + New-LMDiagnosticSource + New + LMDiagnosticSource + + Creates a new LogicMonitor diagnostic source. + + + + The New-LMDiagnosticSource function creates a new diagnostic source in LogicMonitor using a provided diagnostic source configuration object. + + + + New-LMDiagnosticSource + + DiagnosticSource + + A PSCustomObject containing the diagnostic source configuration. Must follow the schema model defined in LogicMonitor's API documentation. + + PSObject + + PSObject + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + DiagnosticSource + + A PSCustomObject containing the diagnostic source configuration. Must follow the schema model defined in LogicMonitor's API documentation. + + PSObject + + PSObject + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.DiagnosticSource object. + + + + + + + + + You must run Connect-LMAccount before running this command. For diagnostic source schema details, see: https://www.logicmonitor.com/swagger-ui-master/api-v3/dist/#/DiagnosticSources/addDiagnosticSource + + + + + -------------------------- EXAMPLE 1 -------------------------- + # Create a new diagnostic source +$config = @{ + name = "MyDiagnosticSource" + # Additional configuration properties +} +New-LMDiagnosticSource -DiagnosticSource $config + + + + + + + + + + New-LMEnhancedNetscan + New + LMEnhancedNetscan + + Creates a new enhanced network scan in LogicMonitor. + + + + The New-LMEnhancedNetScan function creates a new enhanced network scan in LogicMonitor. It allows you to specify various parameters such as the collector ID, name, net scan group name, custom credentials, filters, description, exclude duplicate type, method, next start, next start epoch, Groovy script, credential group ID, and credential group name. + + + + New-LMEnhancedNetscan + + CollectorId + + The ID of the collector where the network scan will be executed. + + String + + String + + + None + + + NextStartEpoch + + The next start epoch for the network scan. Default value is "0". + + String + + String + + + 0 + + + GroovyScript + + The Groovy script to be executed during the network scan. + + String + + String + + + None + + + CredentialGroupId + + The ID of the credential group to be used for the network scan. + + String + + String + + + None + + + CredentialGroupName + + The name of the credential group to be used for the network scan. + + String + + String + + + None + + + Name + + The name of the network scan. + + String + + String + + + None + + + NetScanGroupName + + The name of the net scan group. + + String + + String + + + None + + + CustomCredentials + + A list of custom credentials to be used for the network scan. + + System.Collections.Generic.List`1[System.Management.Automation.PSObject] + + System.Collections.Generic.List`1[System.Management.Automation.PSObject] + + + None + + + Filters + + A list of filters to be applied to the network scan. + + System.Collections.Generic.List`1[System.Management.Automation.PSObject] + + System.Collections.Generic.List`1[System.Management.Automation.PSObject] + + + None + + + Description + + A description of the network scan. + + String + + String + + + None + + + ExcludeDuplicateType + + The type of duplicates to be excluded. Default value is "1". + + String + + String + + + 1 + + + Method + + The method to be used for the network scan. Default value is "enhancedScript". + + String + + String + + + EnhancedScript + + + NextStart + + The next start time for the network scan. Default value is "manual". + + String + + String + + + Manual + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + CollectorId + + The ID of the collector where the network scan will be executed. + + String + + String + + + None + + + Name + + The name of the network scan. + + String + + String + + + None + + + NetScanGroupName + + The name of the net scan group. + + String + + String + + + None + + + CustomCredentials + + A list of custom credentials to be used for the network scan. + + System.Collections.Generic.List`1[System.Management.Automation.PSObject] + + System.Collections.Generic.List`1[System.Management.Automation.PSObject] + + + None + + + Filters + + A list of filters to be applied to the network scan. + + System.Collections.Generic.List`1[System.Management.Automation.PSObject] + + System.Collections.Generic.List`1[System.Management.Automation.PSObject] + + + None + + + Description + + A description of the network scan. + + String + + String + + + None + + + ExcludeDuplicateType + + The type of duplicates to be excluded. Default value is "1". + + String + + String + + + 1 + + + Method + + The method to be used for the network scan. Default value is "enhancedScript". + + String + + String + + + EnhancedScript + + + NextStart + + The next start time for the network scan. Default value is "manual". + + String + + String + + + Manual + + + NextStartEpoch + + The next start epoch for the network scan. Default value is "0". + + String + + String + + + 0 + + + GroovyScript + + The Groovy script to be executed during the network scan. + + String + + String + + + None + + + CredentialGroupId + + The ID of the credential group to be used for the network scan. + + String + + String + + + None + + + CredentialGroupName + + The name of the credential group to be used for the network scan. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + For more information about LogicMonitor network scans, refer to the LogicMonitor documentation. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMEnhancedNetScan -CollectorId "12345" -Name "MyNetScan" -NetScanGroupName "Group1" -CustomCredentials $customCreds -Filters $filters -Description "This is a network scan" -ExcludeDuplicateType "1" -Method "enhancedScript" -NextStart "manual" -NextStartEpoch "0" -GroovyScript "script" -CredentialGroupId "67890" -CredentialGroupName "Group2" + + This example creates a new enhanced network scan with the specified parameters. + + + + + + + + New-LMLogicModule + New + LMLogicModule + + Creates a new Logic Module in LogicMonitor. + + + + The New-LMLogicModule function creates a new Logic Module in LogicMonitor. It supports various types of modules including datasources, property rules, topology sources, event sources, log sources, and config sources. + + + + New-LMLogicModule + + LogicModule + + A PSCustomObject containing the Logic Module configuration. Must follow the schema model defined in LogicMonitor's API documentation. + + PSObject + + PSObject + + + None + + + Type + + The type of Logic Module to create. Valid values are: datasources, propertyrules, topologysources, eventsources, logsources, configsources + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + LogicModule + + A PSCustomObject containing the Logic Module configuration. Must follow the schema model defined in LogicMonitor's API documentation. + + PSObject + + PSObject + + + None + + + Type + + The type of Logic Module to create. Valid values are: datasources, propertyrules, topologysources, eventsources, logsources, configsources + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor object of the appropriate type based on the Type parameter: LogicMonitor.Datasource, LogicMonitor.PropertySource, LogicMonitor.TopologySource, LogicMonitor.EventSource, LogicMonitor.LogSource, LogicMonitor.ConfigSource + + + + + + + + + You must run Connect-LMAccount before running this command. For Logic Module schema details, see: https://www.logicmonitor.com/swagger-ui-master/api-v3/dist/#/Datasources/addDatasourceById + + + + + -------------------------- EXAMPLE 1 -------------------------- + $config = @{ + name = "MyLogicModule" + # Additional configuration properties +} +New-LMLogicModule -LogicModule $config -Type "datasources" + + + + + + + + + + New-LMLogPartition + New + LMLogPartition + + Creates a new LogicMonitor Log Partition. + + + + The New-LMLogPartition function creates a new LogicMonitor Log Partition. + + + + New-LMLogPartition + + Name + + The name of the new log partition. + + String + + String + + + None + + + Description + + The description of the new log partition. + + String + + String + + + None + + + Retention + + The retention in days of the new log partition. + + Int32 + + Int32 + + + 0 + + + Status + + The status of the new log partition. Possible values are "active" or "inactive". + + String + + String + + + None + + + Tenant + + The tenant of the new log partition. + + String + + String + + + None + + + Sku + + The sku of the new log partition. If not specified, the sku from the default log partition will be used. Its recommended to not specify this parameter and let the function determine the sku. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + The name of the new log partition. + + String + + String + + + None + + + Description + + The description of the new log partition. + + String + + String + + + None + + + Retention + + The retention in days of the new log partition. + + Int32 + + Int32 + + + 0 + + + Status + + The status of the new log partition. Possible values are "active" or "inactive". + + String + + String + + + None + + + Tenant + + The tenant of the new log partition. + + String + + String + + + None + + + Sku + + The sku of the new log partition. If not specified, the sku from the default log partition will be used. Its recommended to not specify this parameter and let the function determine the sku. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.LogPartition object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Create a new log partition +New-LMLogPartition -Name "customerA" -Description "Customer A Log Partition" -Retention 30 -Status "active" -Tenant "customerA" + + + + + + + + + + New-LMNetscan + New + LMNetscan + + Creates a new network scan in LogicMonitor. + + + + The New-LMNetScan function is used to create a new network scan in LogicMonitor. It sends a POST request to the LogicMonitor API to create the network scan with the specified parameters. + + + + New-LMNetscan + + CollectorId + + The ID of the collector to use for the network scan. This parameter is mandatory. + + String + + String + + + None + + + Schedule + + {{ Fill Schedule Description }} + + PSObject + + PSObject + + + None + + + SubnetRange + + The subnet range to scan. This parameter is mandatory. + + String + + String + + + None + + + CredentialGroupId + + The ID of the credential group to use for the network scan. + + String + + String + + + None + + + CredentialGroupName + + The name of the credential group to use for the network scan. + + String + + String + + + None + + + ChangeNameToken + + The token to use for changing the name of discovered devices. The default value is "##REVERSEDNS##". + + String + + String + + + ##REVERSEDNS## + + + Name + + The name of the network scan. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the network scan. + + String + + String + + + None + + + ExcludeDuplicateType + + The type of duplicate exclusion to apply. The default value is "1". + + String + + String + + + 1 + + + IgnoreSystemIpDuplicates + + Specifies whether to ignore duplicate system IPs. The default value is $false. + + Boolean + + Boolean + + + False + + + Method + + The method to use for the network scan. Only "nmap" is supported. The default value is "nmap". + + String + + String + + + Nmap + + + NextStart + + The next start time for the network scan. The default value is "manual". + + String + + String + + + Manual + + + NextStartEpoch + + The next start time epoch for the network scan. The default value is "0". + + String + + String + + + 0 + + + NetScanGroupId + + The ID of the network scan group to assign the network scan to. The default value is "1". + + String + + String + + + 1 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + CollectorId + + The ID of the collector to use for the network scan. This parameter is mandatory. + + String + + String + + + None + + + Name + + The name of the network scan. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the network scan. + + String + + String + + + None + + + ExcludeDuplicateType + + The type of duplicate exclusion to apply. The default value is "1". + + String + + String + + + 1 + + + IgnoreSystemIpDuplicates + + Specifies whether to ignore duplicate system IPs. The default value is $false. + + Boolean + + Boolean + + + False + + + Method + + The method to use for the network scan. Only "nmap" is supported. The default value is "nmap". + + String + + String + + + Nmap + + + NextStart + + The next start time for the network scan. The default value is "manual". + + String + + String + + + Manual + + + NextStartEpoch + + The next start time epoch for the network scan. The default value is "0". + + String + + String + + + 0 + + + NetScanGroupId + + The ID of the network scan group to assign the network scan to. The default value is "1". + + String + + String + + + 1 + + + Schedule + + {{ Fill Schedule Description }} + + PSObject + + PSObject + + + None + + + SubnetRange + + The subnet range to scan. This parameter is mandatory. + + String + + String + + + None + + + CredentialGroupId + + The ID of the credential group to use for the network scan. + + String + + String + + + None + + + CredentialGroupName + + The name of the credential group to use for the network scan. + + String + + String + + + None + + + ChangeNameToken + + The token to use for changing the name of discovered devices. The default value is "##REVERSEDNS##". + + String + + String + + + ##REVERSEDNS## + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMNetScan -CollectorId "12345" -Name "MyNetScan" -SubnetRange "192.168.0.0/24" +Creates a new network scan with the specified collector ID, name, and subnet range. + + + + + + + + + + New-LMNetscanGroup + New + LMNetscanGroup + + Creates a new LogicMonitor Netscan Group. + + + + The New-LMNetscanGroup function creates a new Netscan Group in LogicMonitor. It allows you to specify a name and optional description for the group. + + + + New-LMNetscanGroup + + Name + + Specifies the name of the Netscan Group. This parameter is mandatory. + + String + + String + + + None + + + Description + + Specifies the description for the Netscan Group. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Specifies the name of the Netscan Group. This parameter is mandatory. + + String + + String + + + None + + + Description + + Specifies the description for the Netscan Group. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.NetScanGroup object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMNetscanGroup -Name "Group1" -Description "This is a sample group" +Creates a new Netscan Group with the name "Group1" and the description "This is a sample group". + + + + + + + + + + New-LMNormalizedProperty + New + LMNormalizedProperty + + Creates normalized properties in LogicMonitor. + + + + The New-LMNormalizedProperty cmdlet creates normalized properties in LogicMonitor. Normalized properties allow you to map multiple host properties to a single alias that can be used across your environment. + + + + New-LMNormalizedProperty + + Alias + + The alias name for the normalized property. + + String + + String + + + None + + + Properties + + An array of host property names to map to the alias. + + Array + + Array + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Alias + + The alias name for the normalized property. + + String + + String + + + None + + + Properties + + An array of host property names to map to the alias. + + Array + + Array + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.NormalizedProperties object. + + + + + + + + + You must run Connect-LMAccount before running this command. Reserved for internal use. + + + + + -------------------------- EXAMPLE 1 -------------------------- + #Creates a normalized property with alias "location" mapped to multiple source properties. +New-LMNormalizedProperty -Alias "location" -Properties @("location", "snmp.sysLocation", "auto.meraki.location") + + + + + + + + + + New-LMOpsNote + New + LMOpsNote + + Creates a new LogicMonitor OpsNote. + + + + The New-LMOpsNote function is used to create a new OpsNote in LogicMonitor. OpsNotes are used to document important information or events related to monitoring. + + + + New-LMOpsNote + + Note + + Specifies the content of the OpsNote. This parameter is mandatory. + + String + + String + + + None + + + NoteDate + + Specifies the date and time of the OpsNote. If not provided, the current date and time will be used. + + DateTime + + DateTime + + + None + + + Tags + + Specifies an array of tags to associate with the OpsNote. + + String[] + + String[] + + + None + + + DeviceGroupIds + + Specifies an array of device group IDs to associate with the OpsNote. + + String[] + + String[] + + + None + + + WebsiteIds + + Specifies an array of website IDs to associate with the OpsNote. + + String[] + + String[] + + + None + + + DeviceIds + + Specifies an array of device IDs to associate with the OpsNote. + + String[] + + String[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Note + + Specifies the content of the OpsNote. This parameter is mandatory. + + String + + String + + + None + + + NoteDate + + Specifies the date and time of the OpsNote. If not provided, the current date and time will be used. + + DateTime + + DateTime + + + None + + + Tags + + Specifies an array of tags to associate with the OpsNote. + + String[] + + String[] + + + None + + + DeviceGroupIds + + Specifies an array of device group IDs to associate with the OpsNote. + + String[] + + String[] + + + None + + + WebsiteIds + + Specifies an array of website IDs to associate with the OpsNote. + + String[] + + String[] + + + None + + + DeviceIds + + Specifies an array of device IDs to associate with the OpsNote. + + String[] + + String[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.OpsNote object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMOpsNote -Note "Server maintenance scheduled for tomorrow" -NoteDate (Get-Date).AddDays(1) -Tags "maintenance", "server" + + This example creates a new OpsNote with the content "Server maintenance scheduled for tomorrow" and a note date set to tomorrow. It also associates the tags "maintenance" and "server" with the OpsNote. + + + + + + + + New-LMPushMetricDataPoint + New + LMPushMetricDataPoint + + Creates a new data point object for pushing metric data to LogicMonitor. + + + + The New-LMPushMetricDataPoint function creates a new data point object that can be used to push metric data to LogicMonitor. The function accepts an array of data points, where each data point consists of a name and a value. The function also allows you to specify the data point type, aggregation type, and percentile value. + + + + New-LMPushMetricDataPoint + + DataPointsArray + + An optional parameter that allows you to pass an existing array of data points. If not provided, a new array will be created. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None + + + DataPoints + + A mandatory parameter that accepts an array of data points. Each data point should be an object with a Name and a Value property. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None + + + DataPointType + + Specifies the type of the data point. Valid values are "counter", "derive", and "gauge". The default value is "gauge". + + String + + String + + + Gauge + + + DataPointAggregationType + + Specifies the aggregation type of the data point. Valid values are "min", "max", "avg", "sum", "none", and "percentile". The default value is "none". + + String + + String + + + None + + + PercentileValue + + Specifies the percentile value for the data point. This parameter is only applicable when the DataPointAggregationType is set to "percentile". The value should be between 0 and 100. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + DataPointsArray + + An optional parameter that allows you to pass an existing array of data points. If not provided, a new array will be created. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None + + + DataPoints + + A mandatory parameter that accepts an array of data points. Each data point should be an object with a Name and a Value property. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None + + + DataPointType + + Specifies the type of the data point. Valid values are "counter", "derive", and "gauge". The default value is "gauge". + + String + + String + + + Gauge + + + DataPointAggregationType + + Specifies the aggregation type of the data point. Valid values are "min", "max", "avg", "sum", "none", and "percentile". The default value is "none". + + String + + String + + + None + + + PercentileValue + + Specifies the percentile value for the data point. This parameter is only applicable when the DataPointAggregationType is set to "percentile". The value should be between 0 and 100. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.DataPoint object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + $datapoints = @( + [PSCustomObject]@{ + Name = "CPUUsage" + Value = 80 + }, + [PSCustomObject]@{ + Name = "MemoryUsage" + Value = 60 + } +) + + New-LMPushMetricDataPoint -DataPoints $datapoints -DataPointType "gauge" -DataPointAggregationType "avg" + This example creates two data points for CPU usage and memory usage, and sets the data point type to "gauge" and the aggregation type to "avg". + + + + + + + + New-LMPushMetricInstance + New + LMPushMetricInstance + + Creates a new instance of a LogicMonitor push metric. + + + + The New-LMPushMetricInstance function is used to create a new instance of a LogicMonitor push metric. It adds the instance to the specified instances array and returns the updated array. + + + + New-LMPushMetricInstance + + InstancesArrary + + The array of existing instances to which the new instance will be added. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None + + + InstanceName + + The name of the new instance. + + String + + String + + + None + + + InstanceDisplayName + + The display name of the new instance. If not specified, the InstanceName will be used as the display name. + + String + + String + + + None + + + InstanceDescription + + The description of the new instance. + + String + + String + + + None + + + InstanceProperties + + A hashtable containing additional properties for the new instance. + + Hashtable + + Hashtable + + + None + + + Datapoints + + The list of datapoints associated with the new instance. Datapoints should be the results of the New-LMPushMetricDataPoint function. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + InstancesArrary + + The array of existing instances to which the new instance will be added. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None + + + InstanceName + + The name of the new instance. + + String + + String + + + None + + + InstanceDisplayName + + The display name of the new instance. If not specified, the InstanceName will be used as the display name. + + String + + String + + + None + + + InstanceDescription + + The description of the new instance. + + String + + String + + + None + + + InstanceProperties + + A hashtable containing additional properties for the new instance. + + Hashtable + + Hashtable + + + None + + + Datapoints + + The list of datapoints associated with the new instance. Datapoints should be the results of the New-LMPushMetricDataPoint function. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.Instance object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + $instances = New-LMPushMetricInstance -InstancesArrary $instances -InstanceName "Instance1" -InstanceDisplayName "Instance 1" -InstanceDescription "This is instance 1" -InstanceProperties @{Property1 = "Value1"; Property2 = "Value2"} -Datapoints $datapoints + + This example creates a new instance with the specified parameters and adds it to the existing instances array. + + + + + + + + New-LMRecipient + New + LMRecipient + + Creates a new LogicMonitor recipient object. + + + + The New-LMRecipient function creates a new LogicMonitor recipient object that can be used with recipient groups. The recipient can be an admin user, arbitrary email, or another recipient group. + + + + New-LMRecipient + + Type + + The type of recipient. Must be one of: ADMIN, ARBITRARY, or GROUP. + + String + + String + + + None + + + Addr + + The address of the recipient. For ADMIN/ARBITRARY this is an email address, for GROUP this is the group name. + + String + + String + + + None + + + Method + + The notification method for ADMIN recipients. Not used for GROUP type. Possible values: email, sms, voice, smsemail or the name of an existing integration + + String + + String + + + None + + + Contact + + Optional contact information for the recipient. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Type + + The type of recipient. Must be one of: ADMIN, ARBITRARY, or GROUP. + + String + + String + + + None + + + Addr + + The address of the recipient. For ADMIN/ARBITRARY this is an email address, for GROUP this is the group name. + + String + + String + + + None + + + Method + + The notification method for ADMIN recipients. Not used for GROUP type. Possible values: email, sms, voice, smsemail or the name of an existing integration + + String + + String + + + None + + + Contact + + Optional contact information for the recipient. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns a hashtable containing the recipient configuration. + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMRecipient -Type ADMIN -Addr "admin@company.com" -Method "email" +Creates a new admin recipient that will receive email notifications. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMRecipient -Type GROUP -Addr "EmergencyContacts" +Creates a new recipient that references an existing recipient group. + + + + + + + + + + New-LMRecipientGroup + New + LMRecipientGroup + + Creates a new LogicMonitor recipient group. + + + + The New-LMRecipientGroup function creates a new LogicMonitor recipient group with the specified parameters. + + + + New-LMRecipientGroup + + Name + + The name of the recipient group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the recipient group. + + String + + String + + + None + + + Recipients + + A object containing the recipients for the recipient group. The object must contain a "method", "type" and "addr" key. + + Array + + Array + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + The name of the recipient group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the recipient group. + + String + + String + + + None + + + Recipients + + A object containing the recipients for the recipient group. The object must contain a "method", "type" and "addr" key. + + Array + + Array + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.RecipientGroup object. + + + + + + + + + This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + $recipients = @( + New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'email' + New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'sms' + New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'voice' + New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'smsemail' + New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method '<name_of_existing_integration>' + New-LMRecipient -Type 'ARBITRARY' -Addr 'someone@other.com' -Method 'email' + New-LMRecipient -Type 'GROUP' -Addr 'Helpdesk' +) +New-LMRecipientGroup -Name "MyRecipientGroup" -Description "This is a test recipient group" -Recipients $recipients +This example creates a new LogicMonitor recipient group named "MyRecipientGroup" with a description and recipients built using the New-LMRecipient function. + + + + + + + + + + New-LMReportGroup + New + LMReportGroup + + Creates a new LogicMonitor report group. + + + + The New-LMReportGroup function creates a new report group in LogicMonitor. It requires the name of the report group as a mandatory parameter and an optional description. + + + + New-LMReportGroup + + Name + + The name of the report group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the report group. This parameter is optional. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + The name of the report group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the report group. This parameter is optional. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.ReportGroup object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMReportGroup -Name "MyReportGroup" -Description "This is a sample report group" + + This example creates a new report group with the name "MyReportGroup" and the description "This is a sample report group". + + + + + + + + New-LMRole + New + LMRole + + Creates a new Logic Monitor role with specified privileges. + + + + The New-LMRole function creates a new Logic Monitor role with the specified privileges and settings. It allows you to customize various permissions and options for the role. + + + + New-LMRole + + Name + + Specifies the name of the role. + + String + + String + + + None + + + CustomHelpLabel + + Specifies a custom label for the help button in the Logic Monitor UI. + + String + + String + + + None + + + CustomHelpURL + + Specifies a custom URL for the help button in the Logic Monitor UI. + + String + + String + + + None + + + Description + + Specifies a description for the role. + + String + + String + + + None + + + RequireEULA + + Indicates whether the user must accept the End User License Agreement (EULA) before using the role. + + + SwitchParameter + + + False + + + TwoFARequired + + Indicates whether two-factor authentication is required for the role. Default value is $true. + + Boolean + + Boolean + + + True + + + RoleGroupId + + Specifies the ID of the role group to which the role belongs. Default value is 1. + + String + + String + + + 1 + + + DashboardsPermission + + Specifies the permission level for dashboards. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + ResourcePermission + + Specifies the permission level for resources. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + LogsPermission + + Specifies the permission level for logs. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + WebsitesPermission + + Specifies the permission level for websites. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + SavedMapsPermission + + Specifies the permission level for saved maps. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + ReportsPermission + + Specifies the permission level for reports. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + LMXToolBoxPermission + + Specifies the permission level for LMX Toolbox. Valid values are "view", "manage", "commit", "publish", or "none". Default value is "none". + + String + + String + + + None + + + LMXPermission + + Specifies the permission level for LMX. Valid values are "view", "install", or "none". Default value is "none". + + String + + String + + + None + + + SettingsPermission + + Specifies the permission level for settings. Valid values are "view", "manage", "none", "manage-collectors", or "view-collectors". Default value is "none". + + String + + String + + + None + + + CreatePrivateDashboards + + Indicates whether the role can create private dashboards. + + + SwitchParameter + + + False + + + AllowWidgetSharing + + Indicates whether the role can share widgets. + + + SwitchParameter + + + False + + + ConfigTabRequiresManagePermission + + Indicates whether the role requires manage permission for the Config tab. + + + SwitchParameter + + + False + + + AllowedToViewMapsTab + + Indicates whether the role can view the Maps tab. + + + SwitchParameter + + + False + + + AllowedToManageResourceDashboards + + Indicates whether the role can manage resource dashboards. + + + SwitchParameter + + + False + + + ViewTraces + + Indicates whether the role can view traces. + + + SwitchParameter + + + False + + + ViewSupport + + Indicates whether the role can view support. + + + SwitchParameter + + + False + + + EnableRemoteSessionForResources + + Indicates whether the role can enable remote session for resources. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMRole + + Name + + Specifies the name of the role. + + String + + String + + + None + + + CustomHelpLabel + + Specifies a custom label for the help button in the Logic Monitor UI. + + String + + String + + + None + + + CustomHelpURL + + Specifies a custom URL for the help button in the Logic Monitor UI. + + String + + String + + + None + + + Description + + Specifies a description for the role. + + String + + String + + + None + + + RequireEULA + + Indicates whether the user must accept the End User License Agreement (EULA) before using the role. + + + SwitchParameter + + + False + + + TwoFARequired + + Indicates whether two-factor authentication is required for the role. Default value is $true. + + Boolean + + Boolean + + + True + + + RoleGroupId + + Specifies the ID of the role group to which the role belongs. Default value is 1. + + String + + String + + + 1 + + + CustomPrivilegesObject + + Specifies a custom privileges object for the role. + + PSObject + + PSObject + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Specifies the name of the role. + + String + + String + + + None + + + CustomHelpLabel + + Specifies a custom label for the help button in the Logic Monitor UI. + + String + + String + + + None + + + CustomHelpURL + + Specifies a custom URL for the help button in the Logic Monitor UI. + + String + + String + + + None + + + Description + + Specifies a description for the role. + + String + + String + + + None + + + RequireEULA + + Indicates whether the user must accept the End User License Agreement (EULA) before using the role. + + SwitchParameter + + SwitchParameter + + + False + + + TwoFARequired + + Indicates whether two-factor authentication is required for the role. Default value is $true. + + Boolean + + Boolean + + + True + + + RoleGroupId + + Specifies the ID of the role group to which the role belongs. Default value is 1. + + String + + String + + + 1 + + + DashboardsPermission + + Specifies the permission level for dashboards. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + ResourcePermission + + Specifies the permission level for resources. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + LogsPermission + + Specifies the permission level for logs. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + WebsitesPermission + + Specifies the permission level for websites. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + SavedMapsPermission + + Specifies the permission level for saved maps. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + ReportsPermission + + Specifies the permission level for reports. Valid values are "view", "manage", or "none". Default value is "none". + + String + + String + + + None + + + LMXToolBoxPermission + + Specifies the permission level for LMX Toolbox. Valid values are "view", "manage", "commit", "publish", or "none". Default value is "none". + + String + + String + + + None + + + LMXPermission + + Specifies the permission level for LMX. Valid values are "view", "install", or "none". Default value is "none". + + String + + String + + + None + + + SettingsPermission + + Specifies the permission level for settings. Valid values are "view", "manage", "none", "manage-collectors", or "view-collectors". Default value is "none". + + String + + String + + + None + + + CreatePrivateDashboards + + Indicates whether the role can create private dashboards. + + SwitchParameter + + SwitchParameter + + + False + + + AllowWidgetSharing + + Indicates whether the role can share widgets. + + SwitchParameter + + SwitchParameter + + + False + + + ConfigTabRequiresManagePermission + + Indicates whether the role requires manage permission for the Config tab. + + SwitchParameter + + SwitchParameter + + + False + + + AllowedToViewMapsTab + + Indicates whether the role can view the Maps tab. + + SwitchParameter + + SwitchParameter + + + False + + + AllowedToManageResourceDashboards + + Indicates whether the role can manage resource dashboards. + + SwitchParameter + + SwitchParameter + + + False + + + ViewTraces + + Indicates whether the role can view traces. + + SwitchParameter + + SwitchParameter + + + False + + + ViewSupport + + Indicates whether the role can view support. + + SwitchParameter + + SwitchParameter + + + False + + + EnableRemoteSessionForResources + + Indicates whether the role can enable remote session for resources. + + SwitchParameter + + SwitchParameter + + + False + + + CustomPrivilegesObject + + Specifies a custom privileges object for the role. + + PSObject + + PSObject + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.Role object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMRole -Name "MyRole" -Description "Custom role with limited permissions" -DashboardsPermission "view" -ResourcePermission "manage" + + This example creates a new Logic Monitor role named "MyRole" with a description and limited permissions for dashboards and resources. + + + + + + + + New-LMServiceGroup + New + LMServiceGroup + + Creates a new LogicMonitor Service group. + + + + The New-LMServiceGroup function creates a new LogicMonitor Service group with the specified parameters. + + + + New-LMServiceGroup + + Name + + The name of the Service group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the Service group. + + String + + String + + + None + + + Properties + + A hashtable of custom properties for the Service group. + + Hashtable + + Hashtable + + + None + + + DisableAlerting + + Specifies whether alerting is disabled for the Service group. The default value is $false. + + Boolean + + Boolean + + + False + + + ParentGroupId + + The ID of the parent Service group. This parameter is mandatory when using the 'GroupId' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMServiceGroup + + Name + + The name of the Service group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the Service group. + + String + + String + + + None + + + Properties + + A hashtable of custom properties for the Service group. + + Hashtable + + Hashtable + + + None + + + DisableAlerting + + Specifies whether alerting is disabled for the Service group. The default value is $false. + + Boolean + + Boolean + + + False + + + ParentGroupName + + The name of the parent Service group. This parameter is mandatory when using the 'GroupName' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + The name of the Service group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the Service group. + + String + + String + + + None + + + Properties + + A hashtable of custom properties for the Service group. + + Hashtable + + Hashtable + + + None + + + DisableAlerting + + Specifies whether alerting is disabled for the Service group. The default value is $false. + + Boolean + + Boolean + + + False + + + ParentGroupId + + The ID of the parent Service group. This parameter is mandatory when using the 'GroupId' parameter set. + + Int32 + + Int32 + + + 0 + + + ParentGroupName + + The name of the parent Service group. This parameter is mandatory when using the 'GroupName' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.DeviceGroup object. + + + + + + + + + This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMServiceGroup -Name "MyServiceGroup" -Description "This is a test Service group" -Properties @{ "Location" = "US"; "Environment" = "Production" } + + This example creates a new LogicMonitor Service group named "MyServiceGroup" with a description and custom properties. + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMServiceGroup -Name "ChildServiceGroup" -ParentGroupName "ParentServiceGroup" + + This example creates a new LogicMonitor Service group named "ChildServiceGroup" with a specified parent Service group. + + + + + + + + New-LMServiceTemplate + New + LMServiceTemplate + + Creates a new LogicMonitor Service template. + + + + The New-LMServiceTemplate function creates a new LogicMonitor Service template with the specified parameters. + + + + New-LMServiceTemplate + + Name + + The name of the Service template. This parameter is mandatory. + + String + + String + + + None + + + MembershipEvaluationInterval + + The membership evaluation interval in minutes. Default is 30. + + String + + String + + + 30 + + + FilterType + + The filter type. Default is "2". + + String + + String + + + 2 + + + ResourceGroupRecords + + {{ Fill ResourceGroupRecords Description }} + + Array + + Array + + + @() + + + Criticality + + {{ Fill Criticality Description }} + + Array + + Array + + + @() + + + StaticGroup + + {{ Fill StaticGroup Description }} + + Array + + Array + + + @() + + + Description + + The description of the Service template. + + String + + String + + + None + + + Cardinality + + Array of cardinality properties with name and type properties. + + Array + + Array + + + None + + + PropertySelector + + Array of property selector objects for filtering. + + Array + + Array + + + None + + + Properties + + Array of properties to add to the services with id, value, and type. + + Array + + Array + + + None + + + ServiceNamingPattern + + Array of strings defining the service naming pattern. + + Array + + Array + + + None + + + CreateGroup + + Specifies whether to create groups for the service. Default is $true. + + Boolean + + Boolean + + + True + + + GroupNamingPattern + + Array of strings defining the group naming pattern. + + Array + + Array + + + None + + + DefaultCriticality + + The default criticality level. Default is "Medium". + + String + + String + + + Medium + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + The name of the Service template. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the Service template. + + String + + String + + + None + + + Cardinality + + Array of cardinality properties with name and type properties. + + Array + + Array + + + None + + + PropertySelector + + Array of property selector objects for filtering. + + Array + + Array + + + None + + + Properties + + Array of properties to add to the services with id, value, and type. + + Array + + Array + + + None + + + ServiceNamingPattern + + Array of strings defining the service naming pattern. + + Array + + Array + + + None + + + CreateGroup + + Specifies whether to create groups for the service. Default is $true. + + Boolean + + Boolean + + + True + + + GroupNamingPattern + + Array of strings defining the group naming pattern. + + Array + + Array + + + None + + + DefaultCriticality + + The default criticality level. Default is "Medium". + + String + + String + + + Medium + + + MembershipEvaluationInterval + + The membership evaluation interval in minutes. Default is 30. + + String + + String + + + 30 + + + FilterType + + The filter type. Default is "2". + + String + + String + + + 2 + + + ResourceGroupRecords + + {{ Fill ResourceGroupRecords Description }} + + Array + + Array + + + @() + + + Criticality + + {{ Fill Criticality Description }} + + Array + + Array + + + @() + + + StaticGroup + + {{ Fill StaticGroup Description }} + + Array + + Array + + + @() + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.ServiceTemplate object. + + + + + + + + + This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMServiceTemplate -Name "Application Services by Site" -Description "Default LM service template for application services" + + This example creates a new LogicMonitor Service template with basic parameters. + + + + + + + + New-LMUptimeDevice + New + LMUptimeDevice + + Creates a LogicMonitor Uptime device using the v3 device endpoint. + + + + The New-LMUptimeDevice cmdlet provisions an Uptime web or ping monitor (internal or external) through the LogicMonitor v3 device endpoint. It builds the appropriate payload shape, applies validation to enforce supported combinations, and submits the request with the required X-Version header. Supported monitor types include: - Internal Web Checks + - External Web Checks + - Internal Ping Checks + - External Ping Checks + + + + New-LMUptimeDevice + + Name + + Specifies the device name. Required for every parameter set. + + String + + String + + + None + + + HostGroupIds + + Specifies one or more device group identifiers to assign to the Uptime device. + + String[] + + String[] + + + None + + + Description + + Provides an optional description for the device. + + String + + String + + + None + + + PollingInterval + + Sets the polling interval in minutes. Valid values are 1-10, 30, or 60. + + Int32 + + Int32 + + + 5 + + + AlertTriggerInterval + + {{ Fill AlertTriggerInterval Description }} + + Int32 + + Int32 + + + 1 + + + GlobalSmAlertCond + + Defines the global synthetic alert condition threshold. + + String + + String + + + All + + + OverallAlertLevel + + Specifies the alert level for overall checks. Valid values are warn, error, or critical. + + String + + String + + + Warn + + + IndividualAlertLevel + + Specifies the alert level for individual checks. Valid values are warn, error, or critical. + + String + + String + + + Error + + + IndividualSmAlertEnable + + Indicates whether individual synthetic alerts are enabled. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultLocationSetting + + Indicates whether default location settings should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultAlertSetting + + Indicates whether default alert settings should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + Properties + + Provides a hashtable of custom properties for the device. Keys map to property names. + + Object + + Object + + + None + + + Template + + Specifies an optional website template identifier. + + String + + String + + + None + + + Domain + + Specifies the domain for web checks. Required for web parameter sets. + + String + + String + + + None + + + FolderPath + + Specifies the folder path to use for web checks. Defaults to empty string. + + String + + String + + + None + + + StatusCode + + Specifies the expected status code for web checks. Defaults to 200. + + String + + String + + + 200 + + + Keyword + + Specifies the keyword to match for web checks. Defaults to empty string. + + String + + String + + + None + + + Schema + + Defines the HTTP schema (http or https) for web checks. Defaults to https. + + String + + String + + + Https + + + IgnoreSSL + + Indicates whether SSL warnings should be ignored for web checks. Defaults to $true. + + Boolean + + Boolean + + + True + + + PageLoadAlertTimeInMS + + Specifies the page load alert threshold in milliseconds for web checks. + + Int32 + + Int32 + + + 30000 + + + AlertExpr + + Specifies the SSL alert expression for web checks. + + String + + String + + + None + + + TriggerSSLStatusAlert + + Indicates whether SSL status alerts are enabled for web checks. + + Boolean + + Boolean + + + False + + + TriggerSSLExpirationAlert + + Indicates whether SSL expiration alerts are enabled for web checks. + + Boolean + + Boolean + + + False + + + Steps + + Provides the scripted step definitions for web checks. Defaults to a single GET script step when omitted. + + Hashtable[] + + Hashtable[] + + + None + + + TestLocationCollectorIds + + Specifies collector identifiers for internal checks. Required for internal parameter sets. + + Int32[] + + Int32[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMUptimeDevice + + Name + + Specifies the device name. Required for every parameter set. + + String + + String + + + None + + + HostGroupIds + + Specifies one or more device group identifiers to assign to the Uptime device. + + String[] + + String[] + + + None + + + Description + + Provides an optional description for the device. + + String + + String + + + None + + + PollingInterval + + Sets the polling interval in minutes. Valid values are 1-10, 30, or 60. + + Int32 + + Int32 + + + 5 + + + AlertTriggerInterval + + {{ Fill AlertTriggerInterval Description }} + + Int32 + + Int32 + + + 1 + + + GlobalSmAlertCond + + Defines the global synthetic alert condition threshold. + + String + + String + + + All + + + OverallAlertLevel + + Specifies the alert level for overall checks. Valid values are warn, error, or critical. + + String + + String + + + Warn + + + IndividualAlertLevel + + Specifies the alert level for individual checks. Valid values are warn, error, or critical. + + String + + String + + + Error + + + IndividualSmAlertEnable + + Indicates whether individual synthetic alerts are enabled. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultLocationSetting + + Indicates whether default location settings should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultAlertSetting + + Indicates whether default alert settings should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + Properties + + Provides a hashtable of custom properties for the device. Keys map to property names. + + Object + + Object + + + None + + + Template + + Specifies an optional website template identifier. + + String + + String + + + None + + + Domain + + Specifies the domain for web checks. Required for web parameter sets. + + String + + String + + + None + + + FolderPath + + Specifies the folder path to use for web checks. Defaults to empty string. + + String + + String + + + None + + + StatusCode + + Specifies the expected status code for web checks. Defaults to 200. + + String + + String + + + 200 + + + Keyword + + Specifies the keyword to match for web checks. Defaults to empty string. + + String + + String + + + None + + + Schema + + Defines the HTTP schema (http or https) for web checks. Defaults to https. + + String + + String + + + Https + + + IgnoreSSL + + Indicates whether SSL warnings should be ignored for web checks. Defaults to $true. + + Boolean + + Boolean + + + True + + + PageLoadAlertTimeInMS + + Specifies the page load alert threshold in milliseconds for web checks. + + Int32 + + Int32 + + + 30000 + + + AlertExpr + + Specifies the SSL alert expression for web checks. + + String + + String + + + None + + + TriggerSSLStatusAlert + + Indicates whether SSL status alerts are enabled for web checks. + + Boolean + + Boolean + + + False + + + TriggerSSLExpirationAlert + + Indicates whether SSL expiration alerts are enabled for web checks. + + Boolean + + Boolean + + + False + + + Steps + + Provides the scripted step definitions for web checks. Defaults to a single GET script step when omitted. + + Hashtable[] + + Hashtable[] + + + None + + + TestLocationSmgIds + + Specifies synthetic monitoring group identifiers for external checks. + + Int32[] + + Int32[] + + + None + + + TestLocationAll + + Indicates that all public locations should be used for external checks. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMUptimeDevice + + Name + + Specifies the device name. Required for every parameter set. + + String + + String + + + None + + + HostGroupIds + + Specifies one or more device group identifiers to assign to the Uptime device. + + String[] + + String[] + + + None + + + Description + + Provides an optional description for the device. + + String + + String + + + None + + + PollingInterval + + Sets the polling interval in minutes. Valid values are 1-10, 30, or 60. + + Int32 + + Int32 + + + 5 + + + AlertTriggerInterval + + {{ Fill AlertTriggerInterval Description }} + + Int32 + + Int32 + + + 1 + + + GlobalSmAlertCond + + Defines the global synthetic alert condition threshold. + + String + + String + + + All + + + OverallAlertLevel + + Specifies the alert level for overall checks. Valid values are warn, error, or critical. + + String + + String + + + Warn + + + IndividualAlertLevel + + Specifies the alert level for individual checks. Valid values are warn, error, or critical. + + String + + String + + + Error + + + IndividualSmAlertEnable + + Indicates whether individual synthetic alerts are enabled. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultLocationSetting + + Indicates whether default location settings should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultAlertSetting + + Indicates whether default alert settings should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + Properties + + Provides a hashtable of custom properties for the device. Keys map to property names. + + Object + + Object + + + None + + + Template + + Specifies an optional website template identifier. + + String + + String + + + None + + + Hostname + + {{ Fill Hostname Description }} + + String + + String + + + None + + + Count + + Specifies ping attempts per collection for ping checks. Valid values: 5, 10, 15, 20, 30, 60. + + Int32 + + Int32 + + + 5 + + + PercentPktsNotReceiveInTime + + Defines the packet loss percentage threshold for ping checks. + + Int32 + + Int32 + + + 80 + + + TimeoutInMSPktsNotReceive + + Defines the packet response timeout threshold in milliseconds for ping checks. + + Int32 + + Int32 + + + 500 + + + TestLocationSmgIds + + Specifies synthetic monitoring group identifiers for external checks. + + Int32[] + + Int32[] + + + None + + + TestLocationAll + + Indicates that all public locations should be used for external checks. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMUptimeDevice + + Name + + Specifies the device name. Required for every parameter set. + + String + + String + + + None + + + HostGroupIds + + Specifies one or more device group identifiers to assign to the Uptime device. + + String[] + + String[] + + + None + + + Description + + Provides an optional description for the device. + + String + + String + + + None + + + PollingInterval + + Sets the polling interval in minutes. Valid values are 1-10, 30, or 60. + + Int32 + + Int32 + + + 5 + + + AlertTriggerInterval + + {{ Fill AlertTriggerInterval Description }} + + Int32 + + Int32 + + + 1 + + + GlobalSmAlertCond + + Defines the global synthetic alert condition threshold. + + String + + String + + + All + + + OverallAlertLevel + + Specifies the alert level for overall checks. Valid values are warn, error, or critical. + + String + + String + + + Warn + + + IndividualAlertLevel + + Specifies the alert level for individual checks. Valid values are warn, error, or critical. + + String + + String + + + Error + + + IndividualSmAlertEnable + + Indicates whether individual synthetic alerts are enabled. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultLocationSetting + + Indicates whether default location settings should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultAlertSetting + + Indicates whether default alert settings should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + Properties + + Provides a hashtable of custom properties for the device. Keys map to property names. + + Object + + Object + + + None + + + Template + + Specifies an optional website template identifier. + + String + + String + + + None + + + Hostname + + {{ Fill Hostname Description }} + + String + + String + + + None + + + Count + + Specifies ping attempts per collection for ping checks. Valid values: 5, 10, 15, 20, 30, 60. + + Int32 + + Int32 + + + 5 + + + PercentPktsNotReceiveInTime + + Defines the packet loss percentage threshold for ping checks. + + Int32 + + Int32 + + + 80 + + + TimeoutInMSPktsNotReceive + + Defines the packet response timeout threshold in milliseconds for ping checks. + + Int32 + + Int32 + + + 500 + + + TestLocationCollectorIds + + Specifies collector identifiers for internal checks. Required for internal parameter sets. + + Int32[] + + Int32[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Specifies the device name. Required for every parameter set. + + String + + String + + + None + + + HostGroupIds + + Specifies one or more device group identifiers to assign to the Uptime device. + + String[] + + String[] + + + None + + + Description + + Provides an optional description for the device. + + String + + String + + + None + + + PollingInterval + + Sets the polling interval in minutes. Valid values are 1-10, 30, or 60. + + Int32 + + Int32 + + + 5 + + + AlertTriggerInterval + + {{ Fill AlertTriggerInterval Description }} + + Int32 + + Int32 + + + 1 + + + GlobalSmAlertCond + + Defines the global synthetic alert condition threshold. + + String + + String + + + All + + + OverallAlertLevel + + Specifies the alert level for overall checks. Valid values are warn, error, or critical. + + String + + String + + + Warn + + + IndividualAlertLevel + + Specifies the alert level for individual checks. Valid values are warn, error, or critical. + + String + + String + + + Error + + + IndividualSmAlertEnable + + Indicates whether individual synthetic alerts are enabled. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultLocationSetting + + Indicates whether default location settings should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultAlertSetting + + Indicates whether default alert settings should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + Properties + + Provides a hashtable of custom properties for the device. Keys map to property names. + + Object + + Object + + + None + + + Template + + Specifies an optional website template identifier. + + String + + String + + + None + + + Domain + + Specifies the domain for web checks. Required for web parameter sets. + + String + + String + + + None + + + FolderPath + + Specifies the folder path to use for web checks. Defaults to empty string. + + String + + String + + + None + + + StatusCode + + Specifies the expected status code for web checks. Defaults to 200. + + String + + String + + + 200 + + + Keyword + + Specifies the keyword to match for web checks. Defaults to empty string. + + String + + String + + + None + + + Schema + + Defines the HTTP schema (http or https) for web checks. Defaults to https. + + String + + String + + + Https + + + IgnoreSSL + + Indicates whether SSL warnings should be ignored for web checks. Defaults to $true. + + Boolean + + Boolean + + + True + + + PageLoadAlertTimeInMS + + Specifies the page load alert threshold in milliseconds for web checks. + + Int32 + + Int32 + + + 30000 + + + AlertExpr + + Specifies the SSL alert expression for web checks. + + String + + String + + + None + + + TriggerSSLStatusAlert + + Indicates whether SSL status alerts are enabled for web checks. + + Boolean + + Boolean + + + False + + + TriggerSSLExpirationAlert + + Indicates whether SSL expiration alerts are enabled for web checks. + + Boolean + + Boolean + + + False + + + Steps + + Provides the scripted step definitions for web checks. Defaults to a single GET script step when omitted. + + Hashtable[] + + Hashtable[] + + + None + + + Hostname + + {{ Fill Hostname Description }} + + String + + String + + + None + + + Count + + Specifies ping attempts per collection for ping checks. Valid values: 5, 10, 15, 20, 30, 60. + + Int32 + + Int32 + + + 5 + + + PercentPktsNotReceiveInTime + + Defines the packet loss percentage threshold for ping checks. + + Int32 + + Int32 + + + 80 + + + TimeoutInMSPktsNotReceive + + Defines the packet response timeout threshold in milliseconds for ping checks. + + Int32 + + Int32 + + + 500 + + + TestLocationCollectorIds + + Specifies collector identifiers for internal checks. Required for internal parameter sets. + + Int32[] + + Int32[] + + + None + + + TestLocationSmgIds + + Specifies synthetic monitoring group identifiers for external checks. + + Int32[] + + Int32[] + + + None + + + TestLocationAll + + Indicates that all public locations should be used for external checks. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + LogicMonitor.LMUptimeDevice + + + + + + + + + You must run Connect-LMAccount before invoking this cmdlet. This function sends requests to /device/devices with X-Version 3 and returns LogicMonitor.LMUptimeDevice objects. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMUptimeDevice -Name "web-int-01" -HostGroupIds 17 -Domain "app.example.com" -TestLocationCollectorIds 12 + + Creates a new internal web uptime check against app.example.com using collector 12. + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMUptimeDevice -Name "web-ext-01" -HostGroupIds 17 -Domain "app.example.com" -TestLocationSmgIds 2,3,4 + + Creates a new external web uptime check using the specified public locations. + + + + -------------------------- EXAMPLE 3 -------------------------- + New-LMUptimeDevice -Name "ping-int-01" -HostGroupIds 17 -Host "intranet.local" -TestLocationCollectorIds 5 + + Creates an internal ping uptime check that targets intranet.local. + + + + -------------------------- EXAMPLE 4 -------------------------- + New-LMUptimeDevice -Name "ping-ext-01" -HostGroupIds 17 -Host "api.example.net" -TestLocationSmgIds 2,4 + + Creates an external ping uptime check using the provided public locations. + + + + + + + + New-LMUptimeWebStep + New + LMUptimeWebStep + + Creates a LogicMonitor Uptime web step definition. + + + + New-LMUptimeWebStep generates a hashtable describing a single web step compatible with the New-LMUptimeDevice and Set-LMUptimeDevice cmdlets. Separate parameter sets target external (config) steps and internal (script-capable) steps while enforcing the appropriate schema constraints. + + + + New-LMUptimeWebStep + + Name + + Step name. Defaults to "__step0". + + String + + String + + + __step0 + + + Url + + Relative or absolute URL to execute. Defaults to empty string. + + String + + String + + + None + + + HttpMethod + + HTTP method executed by the step. Valid values: GET, HEAD, POST. Defaults to GET. + + String + + String + + + GET + + + HttpVersion + + HTTP protocol version. Valid values: 1, 1.1. Defaults to 1.1. + + String + + String + + + 1.1 + + + Type + + Controls whether the step is treated as external (config) or internal (script). External set uses Type "config"; internal may use "script" or "config". + + String + + String + + + None + + + Enable + + Indicates whether the step is enabled. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultRoot + + Indicates whether the default root should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + Schema + + HTTP schema value (http or https). Defaults to https. + + String + + String + + + Https + + + FollowRedirection + + Indicates whether redirects are automatically followed. Defaults to $true. + + Boolean + + Boolean + + + True + + + FullPageLoad + + Indicates whether full page load is required. Defaults to $false. + + Boolean + + Boolean + + + False + + + RequireAuth + + Indicates whether authentication is required. Defaults to $false. + + Boolean + + Boolean + + + False + + + AuthType + + Authentication type when RequireAuth is true. Defaults to basic. + + String + + String + + + Basic + + + AuthUserName + + Authentication username. + + String + + String + + + None + + + AuthPassword + + Authentication password. + + String + + String + + + None + + + AuthDomain + + Authentication domain. + + String + + String + + + None + + + HttpHeaders + + Optional HTTP headers string. + + String + + String + + + None + + + HttpBody + + Optional HTTP body content. + + String + + String + + + None + + + RequestType + + Request type. External steps support config only; internal steps allow config or script. + + String + + String + + + Config + + + ResponseType + + Response type. External steps support plain text/string, glob expression, JSON, XML, multi line key value pair; internal steps additionally support script. + + String + + String + + + Plain text/string + + + MatchType + + Match type used for response evaluation. Defaults to plain. + + String + + String + + + Plain + + + Keyword + + Keyword used during response evaluation. + + String + + String + + + None + + + InvertMatch + + Switch to invert keyword matching behaviour. + + + SwitchParameter + + + False + + + StatusCode + + Expected status code string. + + String + + String + + + None + + + Path + + Optional path field for JSON/XPATH matching. + + String + + String + + + None + + + Label + + Optional step label. + + String + + String + + + None + + + Description + + Optional step description. + + String + + String + + + None + + + TimeoutInSeconds + + Optional timeout expressed in seconds. + + Int32 + + Int32 + + + None + + + PostDataEditType + + POST data edit type (Raw or Formatted Data). + + String + + String + + + None + + + ResponseScript + + Response script content (internal parameter set only). + + String + + String + + + None + + + RequestScript + + Request script content (internal parameter set only). + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Step name. Defaults to "__step0". + + String + + String + + + __step0 + + + Url + + Relative or absolute URL to execute. Defaults to empty string. + + String + + String + + + None + + + HttpMethod + + HTTP method executed by the step. Valid values: GET, HEAD, POST. Defaults to GET. + + String + + String + + + GET + + + HttpVersion + + HTTP protocol version. Valid values: 1, 1.1. Defaults to 1.1. + + String + + String + + + 1.1 + + + Type + + Controls whether the step is treated as external (config) or internal (script). External set uses Type "config"; internal may use "script" or "config". + + String + + String + + + None + + + Enable + + Indicates whether the step is enabled. Defaults to $true. + + Boolean + + Boolean + + + True + + + UseDefaultRoot + + Indicates whether the default root should be used. Defaults to $true. + + Boolean + + Boolean + + + True + + + Schema + + HTTP schema value (http or https). Defaults to https. + + String + + String + + + Https + + + FollowRedirection + + Indicates whether redirects are automatically followed. Defaults to $true. + + Boolean + + Boolean + + + True + + + FullPageLoad + + Indicates whether full page load is required. Defaults to $false. + + Boolean + + Boolean + + + False + + + RequireAuth + + Indicates whether authentication is required. Defaults to $false. + + Boolean + + Boolean + + + False + + + AuthType + + Authentication type when RequireAuth is true. Defaults to basic. + + String + + String + + + Basic + + + AuthUserName + + Authentication username. + + String + + String + + + None + + + AuthPassword + + Authentication password. + + String + + String + + + None + + + AuthDomain + + Authentication domain. + + String + + String + + + None + + + HttpHeaders + + Optional HTTP headers string. + + String + + String + + + None + + + HttpBody + + Optional HTTP body content. + + String + + String + + + None + + + RequestType + + Request type. External steps support config only; internal steps allow config or script. + + String + + String + + + Config + + + ResponseType + + Response type. External steps support plain text/string, glob expression, JSON, XML, multi line key value pair; internal steps additionally support script. + + String + + String + + + Plain text/string + + + MatchType + + Match type used for response evaluation. Defaults to plain. + + String + + String + + + Plain + + + Keyword + + Keyword used during response evaluation. + + String + + String + + + None + + + InvertMatch + + Switch to invert keyword matching behaviour. + + SwitchParameter + + SwitchParameter + + + False + + + StatusCode + + Expected status code string. + + String + + String + + + None + + + Path + + Optional path field for JSON/XPATH matching. + + String + + String + + + None + + + Label + + Optional step label. + + String + + String + + + None + + + Description + + Optional step description. + + String + + String + + + None + + + TimeoutInSeconds + + Optional timeout expressed in seconds. + + Int32 + + Int32 + + + None + + + PostDataEditType + + POST data edit type (Raw or Formatted Data). + + String + + String + + + None + + + ResponseScript + + Response script content (internal parameter set only). + + String + + String + + + None + + + RequestScript + + Request script content (internal parameter set only). + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + Hashtable describing an uptime web step. + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMUptimeWebStep -Type External -Name '__home' -Url '/' -Keyword 'Welcome' -StatusCode '200' + + + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMUptimeWebStep -Type Internal -RequestType script -RequestScript $scriptBlock + + + + + + + + + + New-LMUser + New + LMUser + + Creates a new LogicMonitor user. + + + + The New-LMUser function creates a new user in LogicMonitor with the specified parameters. + + + + New-LMUser + + Username + + The username of the new user. This parameter is mandatory. + + String + + String + + + None + + + Note + + A note or description for the new user. + + String + + String + + + None + + + RoleNames + + An array of role names to assign to the new user. The default value is "readonly". + + String[] + + String[] + + + @("readonly") + + + SmsEmail + + The SMS email address for the new user. + + String + + String + + + None + + + SmsEmailFormat + + The format of SMS emails for the new user. Valid values are "sms" and "fulltext". The default value is "sms". + + String + + String + + + Sms + + + Status + + The status of the new user. Valid values are "active" and "suspended". The default value is "active". + + String + + String + + + Active + + + Timezone + + The timezone for the new user. Valid values are listed in the function code. + + String + + String + + + None + + + TwoFAEnabled + + Specifies whether two-factor authentication (2FA) is enabled for the new user. The default value is $false. + + Boolean + + Boolean + + + False + + + Views + + An array of views that the new user should have access to. Valid values are listed in the function code. + + String[] + + String[] + + + @("All") + + + Email + + The email address of the new user. This parameter is mandatory. + + String + + String + + + None + + + AcceptEULA + + Specifies whether the user has accepted the End User License Agreement (EULA). The default value is $false. + + Boolean + + Boolean + + + False + + + Password + + The password for the new user. + + String + + String + + + None + + + UserGroups + + An array of user group names to which the new user should be added. + + String[] + + String[] + + + None + + + FirstName + + The first name of the new user. + + String + + String + + + None + + + LastName + + The last name of the new user. + + String + + String + + + None + + + ForcePasswordChange + + Specifies whether the new user should be forced to change their password on first login. The default value is $true. + + Boolean + + Boolean + + + True + + + Phone + + The phone number of the new user. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Username + + The username of the new user. This parameter is mandatory. + + String + + String + + + None + + + Email + + The email address of the new user. This parameter is mandatory. + + String + + String + + + None + + + AcceptEULA + + Specifies whether the user has accepted the End User License Agreement (EULA). The default value is $false. + + Boolean + + Boolean + + + False + + + Password + + The password for the new user. + + String + + String + + + None + + + UserGroups + + An array of user group names to which the new user should be added. + + String[] + + String[] + + + None + + + FirstName + + The first name of the new user. + + String + + String + + + None + + + LastName + + The last name of the new user. + + String + + String + + + None + + + ForcePasswordChange + + Specifies whether the new user should be forced to change their password on first login. The default value is $true. + + Boolean + + Boolean + + + True + + + Phone + + The phone number of the new user. + + String + + String + + + None + + + Note + + A note or description for the new user. + + String + + String + + + None + + + RoleNames + + An array of role names to assign to the new user. The default value is "readonly". + + String[] + + String[] + + + @("readonly") + + + SmsEmail + + The SMS email address for the new user. + + String + + String + + + None + + + SmsEmailFormat + + The format of SMS emails for the new user. Valid values are "sms" and "fulltext". The default value is "sms". + + String + + String + + + Sms + + + Status + + The status of the new user. Valid values are "active" and "suspended". The default value is "active". + + String + + String + + + Active + + + Timezone + + The timezone for the new user. Valid values are listed in the function code. + + String + + String + + + None + + + TwoFAEnabled + + Specifies whether two-factor authentication (2FA) is enabled for the new user. The default value is $false. + + Boolean + + Boolean + + + False + + + Views + + An array of views that the new user should have access to. Valid values are listed in the function code. + + String[] + + String[] + + + @("All") + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.User object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMUser -Username "john.doe" -Email "john.doe@example.com" -Password "P@ssw0rd" -RoleNames @("admin") -Views @("Dashboards", "Reports") + + This example creates a new LogicMonitor user with the username "john.doe", email "john.doe@example.com", password "P@ssw0rd", role "admin", and access to the "Dashboards" and "Reports" views. + + + + + + + + New-LMWebsite + New + LMWebsite + + Creates a new LogicMonitor website or ping check. + + + + The New-LMWebsite function is used to create a new LogicMonitor website or ping check. It allows you to specify various parameters such as the type of check (website or ping), the name of the check, the description, and other settings related to monitoring and alerting. + + + + New-LMWebsite + + WebCheck + + Specifies that the check type is a website check. This parameter is mutually exclusive with the PingCheck parameter. + + + SwitchParameter + + + False + + + Name + + Specifies the name of the check. + + String + + String + + + None + + + IsInternal + + Specifies whether the check is internal or external. By default, it is set to $false. + + Boolean + + Boolean + + + False + + + Description + + Specifies the description of the check. + + String + + String + + + None + + + DisableAlerting + + Specifies whether alerting is disabled for the check. + + Boolean + + Boolean + + + None + + + StopMonitoring + + Specifies whether monitoring is stopped for the check. + + Boolean + + Boolean + + + None + + + UseDefaultAlertSetting + + Specifies whether to use the default alert settings for the check. + + Boolean + + Boolean + + + True + + + UseDefaultLocationSetting + + Specifies whether to use the default location settings for the check. + + Boolean + + Boolean + + + True + + + TriggerSSLStatusAlert + + Specifies whether to trigger an alert when the SSL status of the website check changes. + + Boolean + + Boolean + + + None + + + TriggerSSLExpirationAlert + + Specifies whether to trigger an alert when the SSL certificate of the website check is about to expire. + + Boolean + + Boolean + + + None + + + GroupId + + Specifies the ID of the group to which the check belongs. + + String + + String + + + None + + + WebsiteDomain + + Specifies the domain of the website to check. + + String + + String + + + None + + + HttpType + + Specifies the HTTP type to use for the website check. The valid values are "http" and "https". The default value is "https". + + String + + String + + + Https + + + SSLAlertThresholds + + Specifies the SSL alert thresholds for the website check. + + String[] + + String[] + + + None + + + PageLoadAlertTimeInMS + + Specifies the page load alert time in milliseconds for the website check. + + Int32 + + Int32 + + + None + + + IgnoreSSL + + Specifies whether to ignore SSL errors for the website check. + + Boolean + + Boolean + + + None + + + FailedCount + + Specifies the number of consecutive failed checks required to trigger an alert. The valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 30, and 60. + + Int32 + + Int32 + + + None + + + OverallAlertLevel + + Specifies the overall alert level for the check. The valid values are "warn", "error", and "critical". + + String + + String + + + None + + + IndividualAlertLevel + + Specifies the individual alert level for the check. The valid values are "warn", "error", and "critical". + + String + + String + + + None + + + Properties + + Specifies additional custom properties for the check. + + Hashtable + + Hashtable + + + None + + + PropertiesMethod + + Specifies the method to use for handling custom properties. The valid values are "Add", "Replace", and "Refresh". + + String + + String + + + Replace + + + PollingInterval + + Specifies the polling interval for the check. + + Int32 + + Int32 + + + None + + + WebsiteSteps + + Specifies the steps to perform for the website check. + + Object[] + + Object[] + + + None + + + CheckPoints + + Specifies the check points for the check. This is a legacy parameter and has been replaced with the TestLocation* parameters and may be removed in a future version. + + Object[] + + Object[] + + + None + + + TestLocationAll + + Specifies whether to test from all locations. This parameter is only valid for external checks and cannot be used with TestLocationCollectorIds or TestLocationSmgIds. + + Boolean + + Boolean + + + None + + + TestLocationCollectorIds + + Specifies the collector IDs to use for testing. Can only be used when IsInternal is true. Cannot be used with TestLocationAll or TestLocationSmgIds. + + Int32[] + + Int32[] + + + None + + + TestLocationSmgIds + + Specifies the collector group IDs to use for testing. Can only be used when IsInternal is false. Cannot be used with TestLocationAll or TestLocationCollectorIds. Available collector group IDs correspond to LogicMonitor regions: - 2 = US - Washington DC + - 3 = Europe - Dublin + - 4 = US - Oregon + - 5 = Asia - Singapore + - 6 = Australia - Sydney + + Int32[] + + Int32[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMWebsite + + PingCheck + + Specifies that the check type is a ping check. This parameter is mutually exclusive with the WebCheck parameter. + + + SwitchParameter + + + False + + + Name + + Specifies the name of the check. + + String + + String + + + None + + + IsInternal + + Specifies whether the check is internal or external. By default, it is set to $false. + + Boolean + + Boolean + + + False + + + Description + + Specifies the description of the check. + + String + + String + + + None + + + DisableAlerting + + Specifies whether alerting is disabled for the check. + + Boolean + + Boolean + + + None + + + StopMonitoring + + Specifies whether monitoring is stopped for the check. + + Boolean + + Boolean + + + None + + + UseDefaultAlertSetting + + Specifies whether to use the default alert settings for the check. + + Boolean + + Boolean + + + True + + + UseDefaultLocationSetting + + Specifies whether to use the default location settings for the check. + + Boolean + + Boolean + + + True + + + GroupId + + Specifies the ID of the group to which the check belongs. + + String + + String + + + None + + + PingAddress + + Specifies the address to ping for the ping check. + + String + + String + + + None + + + PingCount + + Specifies the number of pings to send for the ping check. The valid values are 5, 10, 15, 20, 30, and 60. + + Int32 + + Int32 + + + None + + + PingTimeout + + Specifies the timeout for the ping check. + + Int32 + + Int32 + + + None + + + PingPercentNotReceived + + Specifies the percentage of packets not received in time for the ping check. The valid values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100. + + Int32 + + Int32 + + + None + + + FailedCount + + Specifies the number of consecutive failed checks required to trigger an alert. The valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 30, and 60. + + Int32 + + Int32 + + + None + + + OverallAlertLevel + + Specifies the overall alert level for the check. The valid values are "warn", "error", and "critical". + + String + + String + + + None + + + IndividualAlertLevel + + Specifies the individual alert level for the check. The valid values are "warn", "error", and "critical". + + String + + String + + + None + + + Properties + + Specifies additional custom properties for the check. + + Hashtable + + Hashtable + + + None + + + PropertiesMethod + + Specifies the method to use for handling custom properties. The valid values are "Add", "Replace", and "Refresh". + + String + + String + + + Replace + + + PollingInterval + + Specifies the polling interval for the check. + + Int32 + + Int32 + + + None + + + TestLocationAll + + Specifies whether to test from all locations. This parameter is only valid for external checks and cannot be used with TestLocationCollectorIds or TestLocationSmgIds. + + Boolean + + Boolean + + + None + + + TestLocationCollectorIds + + Specifies the collector IDs to use for testing. Can only be used when IsInternal is true. Cannot be used with TestLocationAll or TestLocationSmgIds. + + Int32[] + + Int32[] + + + None + + + TestLocationSmgIds + + Specifies the collector group IDs to use for testing. Can only be used when IsInternal is false. Cannot be used with TestLocationAll or TestLocationCollectorIds. Available collector group IDs correspond to LogicMonitor regions: - 2 = US - Washington DC + - 3 = Europe - Dublin + - 4 = US - Oregon + - 5 = Asia - Singapore + - 6 = Australia - Sydney + + Int32[] + + Int32[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + WebCheck + + Specifies that the check type is a website check. This parameter is mutually exclusive with the PingCheck parameter. + + SwitchParameter + + SwitchParameter + + + False + + + PingCheck + + Specifies that the check type is a ping check. This parameter is mutually exclusive with the WebCheck parameter. + + SwitchParameter + + SwitchParameter + + + False + + + Name + + Specifies the name of the check. + + String + + String + + + None + + + IsInternal + + Specifies whether the check is internal or external. By default, it is set to $false. + + Boolean + + Boolean + + + False + + + Description + + Specifies the description of the check. + + String + + String + + + None + + + DisableAlerting + + Specifies whether alerting is disabled for the check. + + Boolean + + Boolean + + + None + + + StopMonitoring + + Specifies whether monitoring is stopped for the check. + + Boolean + + Boolean + + + None + + + UseDefaultAlertSetting + + Specifies whether to use the default alert settings for the check. + + Boolean + + Boolean + + + True + + + UseDefaultLocationSetting + + Specifies whether to use the default location settings for the check. + + Boolean + + Boolean + + + True + + + TriggerSSLStatusAlert + + Specifies whether to trigger an alert when the SSL status of the website check changes. + + Boolean + + Boolean + + + None + + + TriggerSSLExpirationAlert + + Specifies whether to trigger an alert when the SSL certificate of the website check is about to expire. + + Boolean + + Boolean + + + None + + + GroupId + + Specifies the ID of the group to which the check belongs. + + String + + String + + + None + + + PingAddress + + Specifies the address to ping for the ping check. + + String + + String + + + None + + + WebsiteDomain + + Specifies the domain of the website to check. + + String + + String + + + None + + + HttpType + + Specifies the HTTP type to use for the website check. The valid values are "http" and "https". The default value is "https". + + String + + String + + + Https + + + SSLAlertThresholds + + Specifies the SSL alert thresholds for the website check. + + String[] + + String[] + + + None + + + PingCount + + Specifies the number of pings to send for the ping check. The valid values are 5, 10, 15, 20, 30, and 60. + + Int32 + + Int32 + + + None + + + PingTimeout + + Specifies the timeout for the ping check. + + Int32 + + Int32 + + + None + + + PageLoadAlertTimeInMS + + Specifies the page load alert time in milliseconds for the website check. + + Int32 + + Int32 + + + None + + + IgnoreSSL + + Specifies whether to ignore SSL errors for the website check. + + Boolean + + Boolean + + + None + + + PingPercentNotReceived + + Specifies the percentage of packets not received in time for the ping check. The valid values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100. + + Int32 + + Int32 + + + None + + + FailedCount + + Specifies the number of consecutive failed checks required to trigger an alert. The valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 30, and 60. + + Int32 + + Int32 + + + None + + + OverallAlertLevel + + Specifies the overall alert level for the check. The valid values are "warn", "error", and "critical". + + String + + String + + + None + + + IndividualAlertLevel + + Specifies the individual alert level for the check. The valid values are "warn", "error", and "critical". + + String + + String + + + None + + + Properties + + Specifies additional custom properties for the check. + + Hashtable + + Hashtable + + + None + + + PropertiesMethod + + Specifies the method to use for handling custom properties. The valid values are "Add", "Replace", and "Refresh". + + String + + String + + + Replace + + + PollingInterval + + Specifies the polling interval for the check. + + Int32 + + Int32 + + + None + + + WebsiteSteps + + Specifies the steps to perform for the website check. + + Object[] + + Object[] + + + None + + + CheckPoints + + Specifies the check points for the check. This is a legacy parameter and has been replaced with the TestLocation* parameters and may be removed in a future version. + + Object[] + + Object[] + + + None + + + TestLocationAll + + Specifies whether to test from all locations. This parameter is only valid for external checks and cannot be used with TestLocationCollectorIds or TestLocationSmgIds. + + Boolean + + Boolean + + + None + + + TestLocationCollectorIds + + Specifies the collector IDs to use for testing. Can only be used when IsInternal is true. Cannot be used with TestLocationAll or TestLocationSmgIds. + + Int32[] + + Int32[] + + + None + + + TestLocationSmgIds + + Specifies the collector group IDs to use for testing. Can only be used when IsInternal is false. Cannot be used with TestLocationAll or TestLocationCollectorIds. Available collector group IDs correspond to LogicMonitor regions: - 2 = US - Washington DC + - 3 = Europe - Dublin + - 4 = US - Oregon + - 5 = Asia - Singapore + - 6 = Australia - Sydney + + Int32[] + + Int32[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.Website object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMWebsite -WebCheck -Name "Example Website" -WebsiteDomain "example.com" -HttpType "https" -GroupId "12345" -OverallAlertLevel "error" -IndividualAlertLevel "warn" + + This example creates a new LogicMonitor website check for the website "example.com" with HTTPS protocol. It assigns the check to the group with ID "12345" and sets the overall alert level to "error" and the individual alert level to "warn". + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMWebsite -PingCheck -Name "Example Ping" -PingAddress "192.168.1.1" -PingCount 5 -PingTimeout 1000 -GroupId "12345" -OverallAlertLevel "warn" -IndividualAlertLevel "warn" + + This example creates a new LogicMonitor ping check for the IP address "192.168.1.1". It sends 5 pings with a timeout of 1000 milliseconds. It assigns the check to the group with ID "12345" and sets the overall alert level and individual alert level to "warn". + + + + -------------------------- EXAMPLE 3 -------------------------- + New-LMWebsite -WebCheck -Name "External Website" -WebsiteDomain "example.com" -IsInternal $false -TestLocationSmgIds @(2, 3, 4) + + This example creates a new LogicMonitor website check for an external website "example.com". It configures the check to test from specific LogicMonitor regions (US - Washington DC, Europe - Dublin, and US - Oregon). + + + + -------------------------- EXAMPLE 4 -------------------------- + New-LMWebsite -WebCheck -Name "Internal Website" -WebsiteDomain "internal.example.com" -IsInternal $true -TestLocationCollectorIds @(1, 2, 3) + + This example creates a new LogicMonitor website check for an internal website "internal.example.com". It configures the check to test from specific collectors with IDs 1, 2, and 3. + + + + + + + + New-LMWebsiteGroup + New + LMWebsiteGroup + + Creates a new LogicMonitor website group. + + + + The New-LMWebsiteGroup function creates a new website group in LogicMonitor. It allows you to specify the name, description, properties, and parent group of the website group. + + + + New-LMWebsiteGroup + + Name + + The name of the website group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the website group. + + String + + String + + + None + + + Properties + + A hashtable of custom properties for the website group. + + Hashtable + + Hashtable + + + None + + + DisableAlerting + + Specifies whether to disable alerting for the website group. By default, alerting is enabled. + + Boolean + + Boolean + + + False + + + StopMonitoring + + Specifies whether to stop monitoring the website group. By default, monitoring is not stopped. + + Boolean + + Boolean + + + False + + + ParentGroupId + + The ID of the parent group. This parameter is mandatory if the ParentGroupName parameter is not specified. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + New-LMWebsiteGroup + + Name + + The name of the website group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the website group. + + String + + String + + + None + + + Properties + + A hashtable of custom properties for the website group. + + Hashtable + + Hashtable + + + None + + + DisableAlerting + + Specifies whether to disable alerting for the website group. By default, alerting is enabled. + + Boolean + + Boolean + + + False + + + StopMonitoring + + Specifies whether to stop monitoring the website group. By default, monitoring is not stopped. + + Boolean + + Boolean + + + False + + + ParentGroupName + + The name of the parent group. This parameter is mandatory if the ParentGroupId parameter is not specified. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + The name of the website group. This parameter is mandatory. + + String + + String + + + None + + + Description + + The description of the website group. + + String + + String + + + None + + + Properties + + A hashtable of custom properties for the website group. + + Hashtable + + Hashtable + + + None + + + DisableAlerting + + Specifies whether to disable alerting for the website group. By default, alerting is enabled. + + Boolean + + Boolean + + + False + + + StopMonitoring + + Specifies whether to stop monitoring the website group. By default, monitoring is not stopped. + + Boolean + + Boolean + + + False + + + ParentGroupId + + The ID of the parent group. This parameter is mandatory if the ParentGroupName parameter is not specified. + + Int32 + + Int32 + + + 0 + + + ParentGroupName + + The name of the parent group. This parameter is mandatory if the ParentGroupId parameter is not specified. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.WebsiteGroup object. + + + + + + + + + You must run Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-LMWebsiteGroup -Name "MyWebsiteGroup" -Description "This is my website group" -ParentGroupId 1234 + + This example creates a new website group with the name "MyWebsiteGroup", description "This is my website group", and parent group ID 1234. + + + + -------------------------- EXAMPLE 2 -------------------------- + New-LMWebsiteGroup -Name "MyWebsiteGroup" -Description "This is my website group" -ParentGroupName "ParentGroup" + + This example creates a new website group with the name "MyWebsiteGroup", description "This is my website group", and parent group name "ParentGroup". + + + + + + + + Remove-LMAccessGroup + Remove + LMAccessGroup + + Removes a LogicMonitor access group. + + + + The Remove-LMAccessGroup function removes a LogicMonitor access group based on the specified ID or name. + + + + Remove-LMAccessGroup + + Id + + The ID of the access group to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMAccessGroup + + Name + + The name of the access group to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + The ID of the access group to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the access group to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed access group and a success message confirming the removal. + + + + + + + + + This function requires a valid LogicMonitor API authentication. Make sure to log in using Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMAccessGroup -Id 123 +Removes the access group with the ID 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMAccessGroup -Name "MyAccessGroup" +Removes the access group with the name "MyAccessGroup". + + + + + + + + + + Remove-LMAlertRule + Remove + LMAlertRule + + Removes a LogicMonitor alert rule. + + + + The Remove-LMAlertRule function removes a LogicMonitor alert rule based on the specified ID or name. + + + + Remove-LMAlertRule + + Id + + The ID of the alert rule to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMAlertRule + + Name + + The name of the alert rule to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + The ID of the alert rule to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the alert rule to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed alert rule and a success message confirming the removal. + + + + + + + + + This function requires a valid LogicMonitor API authentication. Make sure to log in using Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMAlertRule -Id 123 +Removes the alert rule with the ID 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMAlertRule -Name "MyAlertRule" +Removes the alert rule with the name "MyAlertRule". + + + + + + + + + + Remove-LMAPIToken + Remove + LMAPIToken + + Removes an API token from Logic Monitor. + + + + The Remove-LMAPIToken function is used to remove an API token from Logic Monitor. It supports removing the token by specifying either the token's ID, the user's ID and token's ID, or the user's name and token's ID. + + + + Remove-LMAPIToken + + UserId + + The ID of the user associated with the API token. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + APITokenId + + The ID of the API token. This parameter is mandatory when using the 'Id' or 'Name' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMAPIToken + + UserName + + The name of the user associated with the API token. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + APITokenId + + The ID of the API token. This parameter is mandatory when using the 'Id' or 'Name' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMAPIToken + + AccessId + + The access ID of the API token. This parameter is mandatory when using the 'AccessId' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + UserId + + The ID of the user associated with the API token. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + UserName + + The name of the user associated with the API token. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + AccessId + + The access ID of the API token. This parameter is mandatory when using the 'AccessId' parameter set. + + String + + String + + + None + + + APITokenId + + The ID of the API token. This parameter is mandatory when using the 'Id' or 'Name' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe API token objects to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed API token and a success message confirming the removal. + + + + + + + + + This function requires a valid API authentication. Make sure to log in using Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMAPIToken -UserId 1234 -APITokenId 5678 +Removes the API token with ID 5678 associated with the user with ID 1234. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMAPIToken -UserName "john.doe" -APITokenId 5678 +Removes the API token with ID 5678 associated with the user with name "john.doe". + + + + + + -------------------------- EXAMPLE 3 -------------------------- + Remove-LMAPIToken -AccessId "abcd1234" +Removes the API token with the specified access ID. + + + + + + + + + + Remove-LMAppliesToFunction + Remove + LMAppliesToFunction + + Removes an AppliesTo function from LogicMonitor. + + + + The Remove-LMAppliesToFunction function removes an AppliesTo function from LogicMonitor. It can be used to remove a function either by its name or its ID. + + + + Remove-LMAppliesToFunction + + Name + + Specifies the name of the AppliesTo function to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMAppliesToFunction + + Id + + Specifies the ID of the AppliesTo function to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Specifies the name of the AppliesTo function to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + Id + + Specifies the ID of the AppliesTo function to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed AppliesTo function and a success message confirming the removal. + + + + + + + + + This function requires a valid LogicMonitor API authentication. Make sure to log in using Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMAppliesToFunction -Name "MyAppliesToFunction" +Removes the AppliesTo function with the name "MyAppliesToFunction". + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMAppliesToFunction -Id 12345 +Removes the AppliesTo function with the ID 12345. + + + + + + + + + + Remove-LMCachedAccount + Remove + LMCachedAccount + + Removes cached account information from the Logic.Monitor vault. + + + + The Remove-LMCachedAccount function is used to remove cached account information from the Logic.Monitor vault. It provides two parameter sets: 'Single' and 'All'. When using the 'Single' parameter set, you can specify a single cached account to remove. When using the 'All' parameter set, all cached accounts will be removed. + + + + Remove-LMCachedAccount + + CachedAccountName + + Specifies the name of the cached account to remove. This parameter is used with the 'Single' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMCachedAccount + + RemoveAllEntries + + Indicates that all cached accounts should be removed. This parameter is used with the 'All' parameter set. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + CachedAccountName + + Specifies the name of the cached account to remove. This parameter is used with the 'Single' parameter set. + + String + + String + + + None + + + RemoveAllEntries + + Indicates that all cached accounts should be removed. This parameter is used with the 'All' parameter set. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe objects to this function. + + + + + + + + + + This function does not generate any output. + + + + + + + + + This function operates on the local credential vault and does not require API authentication. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMCachedAccount -CachedAccountName "JohnDoe" +Removes the cached account with the name "JohnDoe" from the Logic.Monitor vault. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMCachedAccount -RemoveAllEntries +Removes all cached accounts from the Logic.Monitor vault. + + + + + + + + + + Remove-LMCollector + Remove + LMCollector + + Removes a LogicMonitor Collector. + + + + The Remove-LMCollector function removes a LogicMonitor Collector based on the provided Id or Name. + + + + Remove-LMCollector + + Id + + Specifies the Id of the Collector to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMCollector + + Name + + Specifies the Name of the Collector to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the Id of the Collector to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the Name of the Collector to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe objects to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed collector and a success message confirming the removal. + + + + + + + + + This function requires valid API credentials to be logged in. Use Connect-LMAccount to log in before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMCollector -Id 123 +Removes the Collector with Id 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMCollector -Name "Collector1" +Removes the Collector with Name "Collector1". + + + + + + + + + + Remove-LMCollectorGroup + Remove + LMCollectorGroup + + Removes a LogicMonitor Collector Group. + + + + The Remove-LMCollectorGroup function removes a LogicMonitor Collector Group based on the provided Id or Name. + + + + Remove-LMCollectorGroup + + Id + + Specifies the Id of the Collector Group to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMCollectorGroup + + Name + + Specifies the Name of the Collector Group to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the Id of the Collector Group to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the Name of the Collector Group to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe objects to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed collector group and a success message confirming the removal. + + + + + + + + + This function requires valid API credentials to be logged in. Use Connect-LMAccount to log in before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMCollectorGroup -Id 123 +Removes the Collector Group with Id 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMCollectorGroup -Name "Group1" +Removes the Collector Group with Name "Group1". + + + + + + + + + + Remove-LMConfigsource + Remove + LMConfigsource + + Removes a LogicMonitor configsource. + + + + The Remove-LMConfigsource function removes a LogicMonitor configsource based on the specified Id or Name. + + + + Remove-LMConfigsource + + Id + + Specifies the Id of the configsource to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMConfigsource + + Name + + Specifies the Name of the configsource to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the Id of the configsource to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the Name of the configsource to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe objects to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed configsource and a success message confirming the removal. + + + + + + + + + Please ensure you are logged in before running any commands. Use Connect-LMAccount to login and try again. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMConfigsource -Id 123 +Removes the configsource with Id 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMConfigsource -Name "ConfigSource1" +Removes the configsource with the name "ConfigSource1". + + + + + + + + + + Remove-LMDashboard + Remove + LMDashboard + + Removes a LogicMonitor dashboard. + + + + The Remove-LMDashboard function is used to remove a LogicMonitor dashboard. It supports removing a dashboard by either its ID or name. + + + + Remove-LMDashboard + + Id + + Specifies the ID of the dashboard to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDashboard + + Name + + Specifies the name of the dashboard to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the ID of the dashboard to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the dashboard to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe input to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed dashboard and a message indicating the success of the removal operation. + + + + + + + + + This function requires a valid LogicMonitor API authentication. Make sure you are logged in before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMDashboard -Id 123 +Removes the dashboard with ID 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDashboard -Name "My Dashboard" +Removes the dashboard with the name "My Dashboard". + + + + + + + + + + Remove-LMDashboardGroup + Remove + LMDashboardGroup + + Removes a LogicMonitor dashboard group. + + + + The Remove-LMDashboardGroup function removes a LogicMonitor dashboard group based on the specified Id or Name. + + + + Remove-LMDashboardGroup + + Id + + The Id of the dashboard group to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDashboardGroup + + Name + + The name of the dashboard group to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + The Id of the dashboard group to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the dashboard group to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed dashboard group and a success message confirming the removal. + + + + + + + + + This function requires a valid LogicMonitor API authentication. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMDashboardGroup -Id 123 +Removes the dashboard group with Id 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDashboardGroup -Name "MyDashboardGroup" +Removes the dashboard group with the name "MyDashboardGroup". + + + + + + + + + + Remove-LMDashboardWidget + Remove + LMDashboardWidget + + Removes a dashboard widget from Logic Monitor. + + + + The Remove-LMDashboardWidget function removes a dashboard widget from Logic Monitor. It can remove a widget either by its ID or by its name. + + + + Remove-LMDashboardWidget + + Id + + The ID of the widget to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDashboardWidget + + Name + + The name of the widget to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + The ID of the widget to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The name of the widget to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe objects to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed widget and a message indicating the success of the removal operation. + + + + + + + + + This function requires a valid API authentication to Logic Monitor. Make sure to log in using Connect-LMAccount before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMDashboardWidget -Id 123 +Removes the dashboard widget with ID 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDashboardWidget -Name "Widget Name" +Removes the dashboard widget with the specified name. + + + + + + + + + + Remove-LMDatasource + Remove + LMDatasource + + Removes a LogicMonitor datasource. + + + + The Remove-LMDatasource function removes a LogicMonitor datasource based on the specified parameters. It requires the user to be logged in and have valid API credentials. + + + + Remove-LMDatasource + + Id + + Specifies the ID of the datasource to be removed. This parameter is mandatory and can be provided as an integer. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDatasource + + Name + + Specifies the name of the datasource to be removed. This parameter is mandatory when using the 'Name' parameter set and can be provided as a string. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDatasource + + DisplayName + + Specifies the display name of the datasource to be removed. This parameter is mandatory when using the 'DisplayName' parameter set and can be provided as a string. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the ID of the datasource to be removed. This parameter is mandatory and can be provided as an integer. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the datasource to be removed. This parameter is mandatory when using the 'Name' parameter set and can be provided as a string. + + String + + String + + + None + + + DisplayName + + Specifies the display name of the datasource to be removed. This parameter is mandatory when using the 'DisplayName' parameter set and can be provided as a string. + + String + + String + + + None + + + WhatIf - Specifies an array of tags to associate with the OpsNote. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String[] + SwitchParameter - String[] + SwitchParameter - None + False - - DeviceGroupIds + + Confirm - Specifies an array of device group IDs to associate with the OpsNote. + Prompts you for confirmation before running the cmdlet. - String[] + SwitchParameter - String[] + SwitchParameter - None + False - - WebsiteIds + + ProgressAction - Specifies an array of website IDs to associate with the OpsNote. + {{ Fill ProgressAction Description }} - String[] + ActionPreference - String[] + ActionPreference None - - DeviceIds + + + + + You can pipe input to this function. + - Specifies an array of device IDs to associate with the OpsNote. + - String[] + + + + - String[] + Returns a PSCustomObject containing the ID of the removed datasource and a success message confirming the removal. + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMDatasource -Id 123 +Removes the datasource with the ID 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDatasource -Name "MyDatasource" +Removes the datasource with the name "MyDatasource". + + + + + + -------------------------- EXAMPLE 3 -------------------------- + Remove-LMDatasource -DisplayName "My Datasource" +Removes the datasource with the display name "My Datasource". + + + + + + + + + + Remove-LMDevice + Remove + LMDevice + + Removes a LogicMonitor device. + + + + The Remove-LMDevice function removes a LogicMonitor device based on either its ID or name. It supports both hard delete and soft delete options. + + + + Remove-LMDevice + + Id + + Specifies the ID of the device to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + HardDelete + + Indicates whether the device should be hard deleted. If set to $true, the device will be permanently deleted. If set to $false (default), the device will be moved to the Recycle Bin. + + Boolean + + Boolean + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDevice + + Name + + Specifies the name of the device to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + HardDelete + + Indicates whether the device should be hard deleted. If set to $true, the device will be permanently deleted. If set to $false (default), the device will be moved to the Recycle Bin. + + Boolean + + Boolean + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the ID of the device to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the device to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String None + + HardDelete + + Indicates whether the device should be hard deleted. If set to $true, the device will be permanently deleted. If set to $false (default), the device will be moved to the Recycle Bin. + + Boolean + + Boolean + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction @@ -42778,7 +60793,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - None. You cannot pipe objects to this command. + You can pipe input to this function. @@ -42788,7 +60803,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - Returns LogicMonitor.OpsNote object. + Returns a PSCustomObject containing the ID of the removed device and a message indicating the success of the removal operation. @@ -42797,15 +60812,32 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - You must run Connect-LMAccount before running this command. + -------------------------- EXAMPLE 1 -------------------------- - New-LMOpsNote -Note "Server maintenance scheduled for tomorrow" -NoteDate (Get-Date).AddDays(1) -Tags "maintenance", "server" + Remove-LMDevice -Id 12345 +Removes the LogicMonitor device with ID 12345. - This example creates a new OpsNote with the content "Server maintenance scheduled for tomorrow" and a note date set to tomorrow. It also associates the tags "maintenance" and "server" with the OpsNote. + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDevice -Name "MyDevice" +Removes the LogicMonitor device with the name "MyDevice". + + + + + + -------------------------- EXAMPLE 3 -------------------------- + Remove-LMDevice -Name "MyDevice" -HardDelete $true +Permanently deletes the LogicMonitor device with the name "MyDevice". + + @@ -42813,59 +60845,302 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - New-LMPushMetricDataPoint - New - LMPushMetricDataPoint + Remove-LMDeviceDatasourceInstance + Remove + LMDeviceDatasourceInstance - Creates a new data point object for pushing metric data to LogicMonitor. + Removes a device datasource instance from Logic Monitor. - The New-LMPushMetricDataPoint function creates a new data point object that can be used to push metric data to LogicMonitor. The function accepts an array of data points, where each data point consists of a name and a value. The function also allows you to specify the data point type, aggregation type, and percentile value. + The Remove-LMDeviceDatasourceInstance function removes a device datasource instance from Logic Monitor. It requires valid API credentials and the user must be logged in before running this command. - New-LMPushMetricDataPoint - - DataPointsArray + Remove-LMDeviceDatasourceInstance + + DatasourceName + + Specifies the name of the datasource. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + + String + + String + + + None + + + DeviceName + + {{ Fill DeviceName Description }} + + String + + String + + + None + + + WildValue + + Specifies the wildcard value associated with the datasource instance. + + String + + String + + + None + + + InstanceId + + {{ Fill InstanceId Description }} + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDeviceDatasourceInstance + + DatasourceName + + Specifies the name of the datasource. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + + String + + String + + + None + + + DeviceId + + {{ Fill DeviceId Description }} + + Int32 + + Int32 + + + 0 + + + WildValue + + Specifies the wildcard value associated with the datasource instance. + + String + + String + + + None + + + InstanceId + + {{ Fill InstanceId Description }} + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDeviceDatasourceInstance + + DatasourceId + + Specifies the ID of the datasource. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + + Int32 + + Int32 + + + 0 + + + DeviceName + + {{ Fill DeviceName Description }} + + String + + String + + + None + + + WildValue - An optional parameter that allows you to pass an existing array of data points. If not provided, a new array will be created. + Specifies the wildcard value associated with the datasource instance. - System.Collections.Generic.List`1[System.Object] + String - System.Collections.Generic.List`1[System.Object] + String None - - DataPoints + + InstanceId - A mandatory parameter that accepts an array of data points. Each data point should be an object with a Name and a Value property. + {{ Fill InstanceId Description }} - System.Collections.Generic.List`1[System.Object] + Int32 - System.Collections.Generic.List`1[System.Object] + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference None - - DataPointType + + + Remove-LMDeviceDatasourceInstance + + DatasourceId - Specifies the type of the data point. Valid values are "counter", "derive", and "gauge". The default value is "gauge". + Specifies the ID of the datasource. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - String + Int32 - String + Int32 - Gauge + 0 - - DataPointAggregationType + + DeviceId - Specifies the aggregation type of the data point. Valid values are "min", "max", "avg", "sum", "none", and "percentile". The default value is "none". + {{ Fill DeviceId Description }} + + Int32 + + Int32 + + + 0 + + + WildValue + + Specifies the wildcard value associated with the datasource instance. String @@ -42874,10 +61149,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - PercentileValue + + InstanceId - Specifies the percentile value for the data point. This parameter is only applicable when the DataPointAggregationType is set to "percentile". The value should be between 0 and 100. + {{ Fill InstanceId Description }} Int32 @@ -42886,6 +61161,28 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys 0 + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -42901,46 +61198,58 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - - DataPointsArray + + DatasourceName - An optional parameter that allows you to pass an existing array of data points. If not provided, a new array will be created. + Specifies the name of the datasource. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. - System.Collections.Generic.List`1[System.Object] + String - System.Collections.Generic.List`1[System.Object] + String None - - DataPoints + + DatasourceId - A mandatory parameter that accepts an array of data points. Each data point should be an object with a Name and a Value property. + Specifies the ID of the datasource. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - System.Collections.Generic.List`1[System.Object] + Int32 - System.Collections.Generic.List`1[System.Object] + Int32 - None + 0 - - DataPointType + + DeviceId - Specifies the type of the data point. Valid values are "counter", "derive", and "gauge". The default value is "gauge". + {{ Fill DeviceId Description }} + + Int32 + + Int32 + + + 0 + + + DeviceName + + {{ Fill DeviceName Description }} String String - Gauge + None - - DataPointAggregationType + + WildValue - Specifies the aggregation type of the data point. Valid values are "min", "max", "avg", "sum", "none", and "percentile". The default value is "none". + Specifies the wildcard value associated with the datasource instance. String @@ -42949,10 +61258,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - PercentileValue + + InstanceId - Specifies the percentile value for the data point. This parameter is only applicable when the DataPointAggregationType is set to "percentile". The value should be between 0 and 100. + {{ Fill InstanceId Description }} Int32 @@ -42961,6 +61270,30 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys 0 + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction @@ -42977,7 +61310,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - None. You cannot pipe objects to this command. + None. @@ -42987,7 +61320,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - Returns LogicMonitor.DataPoint object. + Returns a PSCustomObject containing the instance ID and a message confirming the successful removal of the datasource instance. @@ -42996,25 +61329,24 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - You must run Connect-LMAccount before running this command. + -------------------------- EXAMPLE 1 -------------------------- - $datapoints = @( - [PSCustomObject]@{ - Name = "CPUUsage" - Value = 80 - }, - [PSCustomObject]@{ - Name = "MemoryUsage" - Value = 60 - } -) + Remove-LMDeviceDatasourceInstance -Name "MyDevice" -DatasourceName "MyDatasource" -WildValue "12345" +Removes the device datasource instance with the specified device name, datasource name, and wildcard value. - New-LMPushMetricDataPoint -DataPoints $datapoints -DataPointType "gauge" -DataPointAggregationType "avg" - This example creates two data points for CPU usage and memory usage, and sets the data point type to "gauge" and the aggregation type to "avg". + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDeviceDatasourceInstance -Id 123 -DatasourceId 456 -WildValue "67890" +Removes the device datasource instance with the specified device ID, datasource ID, and wildcard value. + + @@ -43022,35 +61354,47 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - New-LMPushMetricInstance - New - LMPushMetricInstance + Remove-LMDeviceDatasourceInstanceGroup + Remove + LMDeviceDatasourceInstanceGroup - Creates a new instance of a LogicMonitor push metric. + Removes a LogicMonitor device datasource instance group. - The New-LMPushMetricInstance function is used to create a new instance of a LogicMonitor push metric. It adds the instance to the specified instances array and returns the updated array. + The Remove-LMDeviceDatasourceInstanceGroup function removes a LogicMonitor device datasource instance group based on the provided parameters. It requires valid API credentials and a logged-in session. - New-LMPushMetricInstance - - InstancesArrary + Remove-LMDeviceDatasourceInstanceGroup + + DatasourceName - The array of existing instances to which the new instance will be added. + Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. - System.Collections.Generic.List`1[System.Object] + String - System.Collections.Generic.List`1[System.Object] + String None - - InstanceName + + Id - The name of the new instance. + Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + + Int32 + + Int32 + + + 0 + + + InstanceGroupName + + Specifies the name of the instance group to be removed. This parameter is mandatory. String @@ -43059,10 +61403,47 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - InstanceDisplayName + + WhatIf - The display name of the new instance. If not specified, the InstanceName will be used as the display name. + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDeviceDatasourceInstanceGroup + + DatasourceName + + Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. String @@ -43071,10 +61452,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - InstanceDescription + + Name - The description of the new instance. + Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. String @@ -43083,29 +61464,39 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - InstanceProperties + + InstanceGroupId - A hashtable containing additional properties for the new instance. + Specifies the ID of the instance group to be removed. This parameter is mandatory. - Hashtable + String - Hashtable + String None - - Datapoints + + WhatIf - The list of datapoints associated with the new instance. Datapoints should be the results of the New-LMPushMetricDataPoint function. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - System.Collections.Generic.List`1[System.Object] - System.Collections.Generic.List`1[System.Object] + SwitchParameter - None + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False ProgressAction @@ -43120,148 +61511,36 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - - - InstancesArrary - - The array of existing instances to which the new instance will be added. - - System.Collections.Generic.List`1[System.Object] - - System.Collections.Generic.List`1[System.Object] - - - None - - - InstanceName - - The name of the new instance. - - String - - String - - - None - - - InstanceDisplayName - - The display name of the new instance. If not specified, the InstanceName will be used as the display name. - - String - - String - - - None - - - InstanceDescription - - The description of the new instance. - - String - - String - - - None - - - InstanceProperties - - A hashtable containing additional properties for the new instance. - - Hashtable - - Hashtable - - - None - - - Datapoints - - The list of datapoints associated with the new instance. Datapoints should be the results of the New-LMPushMetricDataPoint function. - - System.Collections.Generic.List`1[System.Object] - - System.Collections.Generic.List`1[System.Object] - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor.Instance object. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - $instances = New-LMPushMetricInstance -InstancesArrary $instances -InstanceName "Instance1" -InstanceDisplayName "Instance 1" -InstanceDescription "This is instance 1" -InstanceProperties @{Property1 = "Value1"; Property2 = "Value2"} -Datapoints $datapoints - - This example creates a new instance with the specified parameters and adds it to the existing instances array. - - - - - - - - New-LMReportGroup - New - LMReportGroup - - Creates a new LogicMonitor report group. - - - - The New-LMReportGroup function creates a new report group in LogicMonitor. It requires the name of the report group as a mandatory parameter and an optional description. - - - New-LMReportGroup - + Remove-LMDeviceDatasourceInstanceGroup + + DatasourceName + + Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + + String + + String + + + None + + Name - The name of the report group. This parameter is mandatory. + Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. + + String + + String + + + None + + + InstanceGroupName + + Specifies the name of the instance group to be removed. This parameter is mandatory. String @@ -43270,17 +61549,27 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - Description + + WhatIf - The description of the report group. This parameter is optional. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False ProgressAction @@ -43295,100 +61584,12 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - - - Name - - The name of the report group. This parameter is mandatory. - - String - - String - - - None - - - Description - - The description of the report group. This parameter is optional. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this command. - - - - - - - - - - Returns LogicMonitor.ReportGroup object. - - - - - - - - - You must run Connect-LMAccount before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - New-LMReportGroup -Name "MyReportGroup" -Description "This is a sample report group" - - This example creates a new report group with the name "MyReportGroup" and the description "This is a sample report group". - - - - - - - - New-LMRole - New - LMRole - - Creates a new Logic Monitor role with specified privileges. - - - - The New-LMRole function creates a new Logic Monitor role with the specified privileges and settings. It allows you to customize various permissions and options for the role. - - - New-LMRole + Remove-LMDeviceDatasourceInstanceGroup - Name + DatasourceName - Specifies the name of the role. + Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. String @@ -43397,10 +61598,22 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - CustomHelpLabel + + Id - Specifies a custom label for the help button in the Logic Monitor UI. + Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + + Int32 + + Int32 + + + 0 + + + InstanceGroupId + + Specifies the ID of the instance group to be removed. This parameter is mandatory. String @@ -43409,10 +61622,59 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - CustomHelpURL + + WhatIf - Specifies a custom URL for the help button in the Logic Monitor UI. + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDeviceDatasourceInstanceGroup + + DatasourceId + + Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. String @@ -43421,10 +61683,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - Description + + InstanceGroupId - Specifies a description for the role. + Specifies the ID of the instance group to be removed. This parameter is mandatory. String @@ -43433,10 +61695,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - RequireEULA + + WhatIf - Indicates whether the user must accept the End User License Agreement (EULA) before using the role. + Shows what would happen if the cmdlet runs. The cmdlet is not run. SwitchParameter @@ -43444,34 +61706,48 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys False - - TwoFARequired + + Confirm - Indicates whether two-factor authentication is required for the role. Default value is $true. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter - True + False - - RoleGroupId + + ProgressAction - Specifies the ID of the role group to which the role belongs. Default value is 1. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference - 1 + None - - DashboardsPermission + + + Remove-LMDeviceDatasourceInstanceGroup + + DatasourceId - Specifies the permission level for dashboards. Valid values are "view", "manage", or "none". Default value is "none". + Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. String @@ -43480,10 +61756,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - ResourcePermission + + InstanceGroupName - Specifies the permission level for resources. Valid values are "view", "manage", or "none". Default value is "none". + Specifies the name of the instance group to be removed. This parameter is mandatory. String @@ -43492,22 +61768,71 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - LogsPermission + + WhatIf - Specifies the permission level for logs. Valid values are "view", "manage", or "none". Default value is "none". + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference None - - WebsitesPermission + + + Remove-LMDeviceDatasourceInstanceGroup + + DatasourceId - Specifies the permission level for websites. Valid values are "view", "manage", or "none". Default value is "none". + Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + + Int32 + + Int32 + + + 0 + + + Id + + Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + + Int32 + + Int32 + + + 0 + + + InstanceGroupId + + Specifies the ID of the instance group to be removed. This parameter is mandatory. String @@ -43516,22 +61841,71 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - SavedMapsPermission + + WhatIf - Specifies the permission level for saved maps. Valid values are "view", "manage", or "none". Default value is "none". + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference None - - ReportsPermission + + + Remove-LMDeviceDatasourceInstanceGroup + + DatasourceId - Specifies the permission level for reports. Valid values are "view", "manage", or "none". Default value is "none". + Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + + Int32 + + Int32 + + + 0 + + + Id + + Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + + Int32 + + Int32 + + + 0 + + + InstanceGroupName + + Specifies the name of the instance group to be removed. This parameter is mandatory. String @@ -43540,22 +61914,59 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - LMXToolBoxPermission + + WhatIf - Specifies the permission level for LMX Toolbox. Valid values are "view", "manage", "commit", "publish", or "none". Default value is "none". + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference None - - LMXPermission + + + Remove-LMDeviceDatasourceInstanceGroup + + Id - Specifies the permission level for LMX. Valid values are "view", "install", or "none". Default value is "none". + Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + + Int32 + + Int32 + + + 0 + + + HdsId + + Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the 'Id-HdsId' or 'Name-HdsId' parameter sets. String @@ -43564,10 +61975,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - SettingsPermission + + InstanceGroupId - Specifies the permission level for settings. Valid values are "view", "manage", "none", "manage-collectors", or "view-collectors". Default value is "none". + Specifies the ID of the instance group to be removed. This parameter is mandatory. String @@ -43576,10 +61987,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - CreatePrivateDashboards + + WhatIf - Indicates whether the role can create private dashboards. + Shows what would happen if the cmdlet runs. The cmdlet is not run. SwitchParameter @@ -43587,10 +61998,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys False - - AllowWidgetSharing + + Confirm - Indicates whether the role can share widgets. + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -43598,54 +62009,61 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys False - - ConfigTabRequiresManagePermission + + ProgressAction - Indicates whether the role requires manage permission for the Config tab. + {{ Fill ProgressAction Description }} + ActionPreference - SwitchParameter + ActionPreference - False + None - - AllowedToViewMapsTab + + + Remove-LMDeviceDatasourceInstanceGroup + + Id - Indicates whether the role can view the Maps tab. + Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + Int32 - SwitchParameter + Int32 - False + 0 - - AllowedToManageResourceDashboards + + HdsId - Indicates whether the role can manage resource dashboards. + Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the 'Id-HdsId' or 'Name-HdsId' parameter sets. + String - SwitchParameter + String - False + None - - ViewTraces + + InstanceGroupName - Indicates whether the role can view traces. + Specifies the name of the instance group to be removed. This parameter is mandatory. + String - SwitchParameter + String - False + None - - ViewSupport + + WhatIf - Indicates whether the role can view support. + Shows what would happen if the cmdlet runs. The cmdlet is not run. SwitchParameter @@ -43653,10 +62071,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys False - - EnableRemoteSessionForResources + + Confirm - Indicates whether the role can enable remote session for resources. + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -43678,11 +62096,11 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - New-LMRole - + Remove-LMDeviceDatasourceInstanceGroup + Name - Specifies the name of the role. + Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. String @@ -43691,10 +62109,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - CustomHelpLabel + + HdsId - Specifies a custom label for the help button in the Logic Monitor UI. + Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the 'Id-HdsId' or 'Name-HdsId' parameter sets. String @@ -43703,10 +62121,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - CustomHelpURL + + InstanceGroupId - Specifies a custom URL for the help button in the Logic Monitor UI. + Specifies the ID of the instance group to be removed. This parameter is mandatory. String @@ -43715,22 +62133,21 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - Description + + WhatIf - Specifies a description for the role. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - RequireEULA + + Confirm - Indicates whether the user must accept the End User License Agreement (EULA) before using the role. + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -43738,42 +62155,79 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys False - - TwoFARequired + + ProgressAction - Indicates whether two-factor authentication is required for the role. Default value is $true. + {{ Fill ProgressAction Description }} - Boolean + ActionPreference - Boolean + ActionPreference - True + None - - RoleGroupId + + + Remove-LMDeviceDatasourceInstanceGroup + + Name - Specifies the ID of the role group to which the role belongs. Default value is 1. + Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. String String - 1 + None - CustomPrivilegesObject + HdsId - Specifies a custom privileges object for the role. + Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the 'Id-HdsId' or 'Name-HdsId' parameter sets. - PSObject + String - PSObject + String + + + None + + + InstanceGroupName + + Specifies the name of the instance group to be removed. This parameter is mandatory. + + String + + String None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -43790,45 +62244,9 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - Name - - Specifies the name of the role. - - String - - String - - - None - - - CustomHelpLabel - - Specifies a custom label for the help button in the Logic Monitor UI. - - String - - String - - - None - - - CustomHelpURL - - Specifies a custom URL for the help button in the Logic Monitor UI. - - String - - String - - - None - - - Description + DatasourceName - Specifies a description for the role. + Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. String @@ -43837,70 +62255,34 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - RequireEULA - - Indicates whether the user must accept the End User License Agreement (EULA) before using the role. - - SwitchParameter - - SwitchParameter - - - False - - - TwoFARequired - - Indicates whether two-factor authentication is required for the role. Default value is $true. - - Boolean - - Boolean - - - True - - - RoleGroupId - - Specifies the ID of the role group to which the role belongs. Default value is 1. - - String - - String - - - 1 - - - DashboardsPermission + + DatasourceId - Specifies the permission level for dashboards. Valid values are "view", "manage", or "none". Default value is "none". + Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - String + Int32 - String + Int32 - None + 0 - - ResourcePermission + + Id - Specifies the permission level for resources. Valid values are "view", "manage", or "none". Default value is "none". + Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. - String + Int32 - String + Int32 - None + 0 - - LogsPermission + + Name - Specifies the permission level for logs. Valid values are "view", "manage", or "none". Default value is "none". + Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. String @@ -43909,10 +62291,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - WebsitesPermission + + HdsId - Specifies the permission level for websites. Valid values are "view", "manage", or "none". Default value is "none". + Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the 'Id-HdsId' or 'Name-HdsId' parameter sets. String @@ -43921,10 +62303,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - SavedMapsPermission + + InstanceGroupName - Specifies the permission level for saved maps. Valid values are "view", "manage", or "none". Default value is "none". + Specifies the name of the instance group to be removed. This parameter is mandatory. String @@ -43933,10 +62315,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - ReportsPermission + + InstanceGroupId - Specifies the permission level for reports. Valid values are "view", "manage", or "none". Default value is "none". + Specifies the ID of the instance group to be removed. This parameter is mandatory. String @@ -43945,130 +62327,301 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - LMXToolBoxPermission + + WhatIf - Specifies the permission level for LMX Toolbox. Valid values are "view", "manage", "commit", "publish", or "none". Default value is "none". + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String + SwitchParameter - String + SwitchParameter - None + False - - LMXPermission + + Confirm - Specifies the permission level for LMX. Valid values are "view", "install", or "none". Default value is "none". + Prompts you for confirmation before running the cmdlet. - String + SwitchParameter - String + SwitchParameter - None + False - - SettingsPermission + + ProgressAction - Specifies the permission level for settings. Valid values are "view", "manage", "none", "manage-collectors", or "view-collectors". Default value is "none". + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - CreatePrivateDashboards - - Indicates whether the role can create private dashboards. - - SwitchParameter + + + - SwitchParameter - + None. - False - - - AllowWidgetSharing - Indicates whether the role can share widgets. + - SwitchParameter + + + + - SwitchParameter - + Returns a PSCustomObject containing the instance ID and a message confirming the successful removal of the instance group. - False - - - ConfigTabRequiresManagePermission - Indicates whether the role requires manage permission for the Config tab. + - SwitchParameter - - SwitchParameter - - - False - - - AllowedToViewMapsTab + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMDeviceDatasourceInstanceGroup -DatasourceName "CPU" -Name "Server01" -InstanceGroupName "Group1" +Removes the instance group named "Group1" associated with the "CPU" datasource on the device named "Server01". + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDeviceDatasourceInstanceGroup -DatasourceId 123 -Id 456 -InstanceGroupName "Group2" +Removes the instance group named "Group2" associated with the datasource ID 123 on the device ID 456. + + + + + + + + + + Remove-LMDeviceGroup + Remove + LMDeviceGroup + + Removes a LogicMonitor device group. + + + + The Remove-LMDeviceGroup function is used to remove a LogicMonitor device group. It supports removing the group by either its ID or name. The function requires valid API credentials to be logged in. + + + + Remove-LMDeviceGroup + + Id + + Specifies the ID of the device group to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + DeleteHostsandChildren + + Specifies whether to delete the hosts and their children within the device group. By default, this parameter is set to $false. + + Boolean + + Boolean + + + False + + + HardDelete + + Specifies whether to perform a hard delete, which permanently removes the device group and its associated data. By default, this parameter is set to $false. + + Boolean + + Boolean + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDeviceGroup + + Name + + Specifies the name of the device group to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + DeleteHostsandChildren + + Specifies whether to delete the hosts and their children within the device group. By default, this parameter is set to $false. + + Boolean + + Boolean + + + False + + + HardDelete + + Specifies whether to perform a hard delete, which permanently removes the device group and its associated data. By default, this parameter is set to $false. + + Boolean + + Boolean + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id - Indicates whether the role can view the Maps tab. + Specifies the ID of the device group to be removed. This parameter is mandatory when using the 'Id' parameter set. - SwitchParameter + Int32 - SwitchParameter + Int32 - False + 0 - - AllowedToManageResourceDashboards + + Name - Indicates whether the role can manage resource dashboards. + Specifies the name of the device group to be removed. This parameter is mandatory when using the 'Name' parameter set. - SwitchParameter + String - SwitchParameter + String - False + None - ViewTraces + DeleteHostsandChildren - Indicates whether the role can view traces. + Specifies whether to delete the hosts and their children within the device group. By default, this parameter is set to $false. - SwitchParameter + Boolean - SwitchParameter + Boolean False - ViewSupport + HardDelete - Indicates whether the role can view support. + Specifies whether to perform a hard delete, which permanently removes the device group and its associated data. By default, this parameter is set to $false. - SwitchParameter + Boolean - SwitchParameter + Boolean False - - EnableRemoteSessionForResources + + WhatIf - Indicates whether the role can enable remote session for resources. + Shows what would happen if the cmdlet runs. The cmdlet is not run. SwitchParameter @@ -44077,17 +62630,17 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys False - - CustomPrivilegesObject + + Confirm - Specifies a custom privileges object for the role. + Prompts you for confirmation before running the cmdlet. - PSObject + SwitchParameter - PSObject + SwitchParameter - None + False ProgressAction @@ -44105,7 +62658,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - None. You cannot pipe objects to this command. + None. @@ -44115,7 +62668,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - Returns LogicMonitor.Role object. + Returns a PSCustomObject containing the ID of the removed device group and a message confirming the successful removal. @@ -44124,15 +62677,24 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - You must run Connect-LMAccount before running this command. + This function requires valid API credentials to be logged in. Use the Connect-LMAccount function to log in before running any commands. -------------------------- EXAMPLE 1 -------------------------- - New-LMRole -Name "MyRole" -Description "Custom role with limited permissions" -DashboardsPermission "view" -ResourcePermission "manage" + Remove-LMDeviceGroup -Id 12345 +Removes the device group with the specified ID. - This example creates a new Logic Monitor role named "MyRole" with a description and limited permissions for dashboards and resources. + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDeviceGroup -Name "MyDeviceGroup" +Removes the device group with the specified name. + + @@ -44140,95 +62702,35 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - New-LMUser - New - LMUser + Remove-LMDeviceGroupProperty + Remove + LMDeviceGroupProperty - Creates a new LogicMonitor user. + Removes a property from a LogicMonitor device group. - The New-LMUser function creates a new user in LogicMonitor with the specified parameters. + The Remove-LMDeviceGroupProperty function removes a specified property from a LogicMonitor device group. It can remove the property either by providing the device group ID or the device group name. - New-LMUser - - Username - - The username of the new user. This parameter is mandatory. - - String - - String - - - None - - - Note - - A note or description for the new user. - - String - - String - - - None - - - RoleNames - - An array of role names to assign to the new user. The default value is "readonly". - - String[] - - String[] - - - @("readonly") - - - SmsEmail - - The SMS email address for the new user. - - String - - String - - - None - - - SmsEmailFormat - - The format of SMS emails for the new user. Valid values are "sms" and "fulltext". The default value is "sms". - - String - - String - - - Sms - - - Status + Remove-LMDeviceGroupProperty + + Id - The status of the new user. Valid values are "active" and "suspended". The default value is "active". + The ID of the device group from which the property should be removed. This parameter is mandatory when using the 'Id' parameter set. - String + Int32 - String + Int32 - Active + 0 - - Timezone + + PropertyName - The timezone for the new user. Valid values are listed in the function code. + The name of the property to be removed. This parameter is mandatory. String @@ -44237,82 +62739,47 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - TwoFAEnabled + + WhatIf - Specifies whether two-factor authentication (2FA) is enabled for the new user. The default value is $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter False - - Views - - An array of views that the new user should have access to. Valid values are listed in the function code. - - String[] - - String[] - - - @("All") - - - Email - - The email address of the new user. This parameter is mandatory. - - String - - String - - - None - - - AcceptEULA + + Confirm - Specifies whether the user has accepted the End User License Agreement (EULA). The default value is $false. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter False - - Password - - The password for the new user. - - String - - String - - - None - - - UserGroups + + ProgressAction - An array of user group names to which the new user should be added. + {{ Fill ProgressAction Description }} - String[] + ActionPreference - String[] + ActionPreference None - - FirstName + + + Remove-LMDeviceGroupProperty + + Name - The first name of the new user. + The name of the device group from which the property should be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -44321,10 +62788,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - LastName + + PropertyName - The last name of the new user. + The name of the property to be removed. This parameter is mandatory. String @@ -44333,29 +62800,27 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - ForcePasswordChange + + WhatIf - Specifies whether the new user should be forced to change their password on first login. The default value is $true. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter - True + False - - Phone + + Confirm - The phone number of the new user. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -44372,22 +62837,22 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - - Username + + Id - The username of the new user. This parameter is mandatory. + The ID of the device group from which the property should be removed. This parameter is mandatory when using the 'Id' parameter set. - String + Int32 - String + Int32 - None + 0 - - Email + + Name - The email address of the new user. This parameter is mandatory. + The name of the device group from which the property should be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -44396,22 +62861,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - AcceptEULA - - Specifies whether the user has accepted the End User License Agreement (EULA). The default value is $false. - - Boolean - - Boolean - - - False - - - Password + + PropertyName - The password for the new user. + The name of the property to be removed. This parameter is mandatory. String @@ -44420,94 +62873,241 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - UserGroups + + WhatIf - An array of user group names to which the new user should be added. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String[] + SwitchParameter - String[] + SwitchParameter - None + False - - FirstName + + Confirm - The first name of the new user. + Prompts you for confirmation before running the cmdlet. - String + SwitchParameter - String + SwitchParameter - None + False - - LastName + + ProgressAction - The last name of the new user. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - ForcePasswordChange - - Specifies whether the new user should be forced to change their password on first login. The default value is $true. - - Boolean + + + - Boolean - + None. - True - - - Phone - The phone number of the new user. + - String + + + + - String - + Returns a PSCustomObject containing the ID of the device group and a message confirming the successful removal of the property. - None - - - Note - A note or description for the new user. + - String - - String - - - None - - - RoleNames + + + + + This function requires a valid LogicMonitor API authentication. Make sure you are logged in before running any commands. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMDeviceGroupProperty -Id 1234 -PropertyName "Property1" +Removes the property named "Property1" from the device with ID 1234. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDeviceGroupProperty -Name "Device1" -PropertyName "Property2" +Removes the property named "Property2" from the device with the name "Device1". + + + + + + + + + + Remove-LMDeviceProperty + Remove + LMDeviceProperty + + Removes a property from a LogicMonitor device. + + + + The Remove-LMDeviceProperty function removes a specified property from a LogicMonitor device. It can remove the property either by providing the device ID or the device name. + + + + Remove-LMDeviceProperty + + Id + + The ID of the device from which the property should be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + PropertyName + + The name of the property to be removed. This parameter is mandatory. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMDeviceProperty + + Name + + The name of the device from which the property should be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + PropertyName + + The name of the property to be removed. This parameter is mandatory. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id - An array of role names to assign to the new user. The default value is "readonly". + The ID of the device from which the property should be removed. This parameter is mandatory when using the 'Id' parameter set. - String[] + Int32 - String[] + Int32 - @("readonly") + 0 - - SmsEmail + + Name - The SMS email address for the new user. + The name of the device from which the property should be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -44516,34 +63116,10 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - SmsEmailFormat - - The format of SMS emails for the new user. Valid values are "sms" and "fulltext". The default value is "sms". - - String - - String - - - Sms - - - Status - - The status of the new user. Valid values are "active" and "suspended". The default value is "active". - - String - - String - - - Active - - - Timezone + + PropertyName - The timezone for the new user. Valid values are listed in the function code. + The name of the property to be removed. This parameter is mandatory. String @@ -44552,29 +63128,29 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - TwoFAEnabled + + WhatIf - Specifies whether two-factor authentication (2FA) is enabled for the new user. The default value is $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean + SwitchParameter - Boolean + SwitchParameter False - - Views + + Confirm - An array of views that the new user should have access to. Valid values are listed in the function code. + Prompts you for confirmation before running the cmdlet. - String[] + SwitchParameter - String[] + SwitchParameter - @("All") + False ProgressAction @@ -44592,7 +63168,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - None. You cannot pipe objects to this command. + None. @@ -44602,7 +63178,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - Returns LogicMonitor.User object. + Returns a PSCustomObject containing the ID of the device and a message confirming the successful removal of the property. @@ -44611,15 +63187,24 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - You must run Connect-LMAccount before running this command. + This function requires a valid LogicMonitor API authentication. Make sure you are logged in before running any commands. -------------------------- EXAMPLE 1 -------------------------- - New-LMUser -Username "john.doe" -Email "john.doe@example.com" -Password "P@ssw0rd" -RoleNames @("admin") -Views @("Dashboards", "Reports") + Remove-LMDeviceProperty -Id 1234 -PropertyName "Property1" +Removes the property named "Property1" from the device with ID 1234. - This example creates a new LogicMonitor user with the username "john.doe", email "john.doe@example.com", password "P@ssw0rd", role "admin", and access to the "Dashboards" and "Reports" views. + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDeviceProperty -Name "Device1" -PropertyName "Property2" +Removes the property named "Property2" from the device with the name "Device1". + + @@ -44627,226 +63212,291 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - New-LMWebsite - New - LMWebsite + Remove-LMDiagnosticSource + Remove + LMDiagnosticSource - Creates a new LogicMonitor website or ping check. + Removes a LogicMonitor diagnostic source. - The New-LMWebsite function is used to create a new LogicMonitor website or ping check. It allows you to specify various parameters such as the type of check (website or ping), the name of the check, the description, and other settings related to monitoring and alerting. + The Remove-LMDiagnosticSource function removes a LogicMonitor diagnostic source based on the specified parameters. It requires the user to be logged in and have valid API credentials. - New-LMWebsite - - WebCheck - - Specifies that the check type is a website check. This parameter is mutually exclusive with the PingCheck parameter. - - - SwitchParameter - - - False - - - Name + Remove-LMDiagnosticSource + + Id - Specifies the name of the check. + Specifies the ID of the diagnostic source to be removed. This parameter is mandatory and can be provided as an integer. - String + Int32 - String + Int32 - None + 0 - - IsInternal + + WhatIf - Specifies whether the check is internal or external. By default, it is set to $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter False - - Description - - Specifies the description of the check. - - String - - String - - - None - - - DisableAlerting + + Confirm - Specifies whether alerting is disabled for the check. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter - None + False - - StopMonitoring + + ProgressAction - Specifies whether monitoring is stopped for the check. + {{ Fill ProgressAction Description }} - Boolean + ActionPreference - Boolean + ActionPreference None - - UseDefaultAlertSetting - - Specifies whether to use the default alert settings for the check. - - Boolean - - Boolean - - - True - - - UseDefaultLocationSetting - - Specifies whether to use the default location settings for the check. - - Boolean - - Boolean - - - True - - - TriggerSSLStatusAlert + + + Remove-LMDiagnosticSource + + Name - Specifies whether to trigger an alert when the SSL status of the website check changes. + Specifies the name of the diagnostic source to be removed. This parameter is mandatory when using the 'Name' parameter set and can be provided as a string. - Boolean + String - Boolean + String None - - TriggerSSLExpirationAlert + + WhatIf - Specifies whether to trigger an alert when the SSL certificate of the website check is about to expire. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter - None + False - - GroupId + + Confirm - Specifies the ID of the group to which the check belongs. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False - - WebsiteDomain + + ProgressAction - Specifies the domain of the website to check. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - HttpType - - Specifies the HTTP type to use for the website check. The valid values are "http" and "https". The default value is "https". - - String - - String - - - Https - - - SSLAlertThresholds + + + + + Id + + Specifies the ID of the diagnostic source to be removed. This parameter is mandatory and can be provided as an integer. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the diagnostic source to be removed. This parameter is mandatory when using the 'Name' parameter set and can be provided as a string. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe input to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed diagnostic source and a success message confirming the removal. + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMDiagnosticSource -Id 123 +Removes the diagnostic source with the ID 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMDiagnosticSource -Name "MyDiagnosticSource" +Removes the diagnostic source with the name "MyDiagnosticSource". + + + + + + + + + + Remove-LMEscalationChain + Remove + LMEscalationChain + + Removes a LogicMonitor escalation chain. + + + + The Remove-LMEscalationChain function removes a LogicMonitor escalation chain based on either its ID or name. + + + + Remove-LMEscalationChain + + Id - Specifies the SSL alert thresholds for the website check. + Specifies the ID of the escalation chain to be removed. This parameter is mandatory when using the 'Id' parameter set. - String[] + Int32 - String[] + Int32 - None + 0 - - PageLoadAlertTimeInMS + + WhatIf - Specifies the page load alert time in milliseconds for the website check. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - None + False - - IgnoreSSL + + Confirm - Specifies whether to ignore SSL errors for the website check. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter - None + False - - FailedCount + + ProgressAction - Specifies the number of consecutive failed checks required to trigger an alert. The valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 30, and 60. + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference None - - OverallAlertLevel + + + Remove-LMEscalationChain + + Name - Specifies the overall alert level for the check. The valid values are "warn", "error", and "critical". + Specifies the name of the escalation chain to be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -44855,117 +63505,197 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - IndividualAlertLevel + + WhatIf - Specifies the individual alert level for the check. The valid values are "warn", "error", and "critical". + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - Properties + + Confirm - Specifies additional custom properties for the check. + Prompts you for confirmation before running the cmdlet. - Hashtable - Hashtable + SwitchParameter - None + False - - PropertiesMethod + + ProgressAction - Specifies the method to use for handling custom properties. The valid values are "Add", "Replace", and "Refresh". + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference - Replace + None - - PollingInterval + + + + + Id + + Specifies the ID of the escalation chain to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the escalation chain to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe input to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed escalation chain and a message indicating the success of the removal operation. + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMEscalationChain -Id 12345 +Removes the LogicMonitor escalation chain with ID 12345. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMEscalationChain -Name "Critical-Alerts" +Removes the LogicMonitor escalation chain with the name "Critical-Alerts". + + + + + + + + + + Remove-LMIntegration + Remove + LMIntegration + + Removes a LogicMonitor integration. + + + + The Remove-LMIntegration function removes a LogicMonitor integration based on either its ID or name. + + + + Remove-LMIntegration + + Id - Specifies the polling interval for the check. + Specifies the ID of the integration to be removed. This parameter is mandatory when using the 'Id' parameter set. Int32 Int32 - None - - - WebsiteSteps - - Specifies the steps to perform for the website check. - - Object[] - - Object[] - - - None - - - CheckPoints - - Specifies the check points for the check. This is a legacy parameter and has been replaced with the TestLocation* parameters and may be removed in a future version. - - Object[] - - Object[] - - - None - - - TestLocationAll - - Specifies whether to test from all locations. This parameter is only valid for external checks and cannot be used with TestLocationCollectorIds or TestLocationSmgIds. - - Boolean - - Boolean - - - None + 0 - - TestLocationCollectorIds + + WhatIf - Specifies the collector IDs to use for testing. Can only be used when IsInternal is true. Cannot be used with TestLocationAll or TestLocationSmgIds. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32[] - Int32[] + SwitchParameter - None + False - - TestLocationSmgIds + + Confirm - Specifies the collector group IDs to use for testing. Can only be used when IsInternal is false. Cannot be used with TestLocationAll or TestLocationCollectorIds. Available collector group IDs correspond to LogicMonitor regions: - 2 = US - Washington DC - - 3 = Europe - Dublin - - 4 = US - Oregon - - 5 = Asia - Singapore - - 6 = Australia - Sydney + Prompts you for confirmation before running the cmdlet. - Int32[] - Int32[] + SwitchParameter - None + False ProgressAction @@ -44981,22 +63711,11 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - New-LMWebsite - - PingCheck - - Specifies that the check type is a ping check. This parameter is mutually exclusive with the WebCheck parameter. - - - SwitchParameter - - - False - + Remove-LMIntegration Name - Specifies the name of the check. + Specifies the name of the integration to be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -45005,94 +63724,217 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - IsInternal + + WhatIf - Specifies whether the check is internal or external. By default, it is set to $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter False - - Description + + Confirm - Specifies the description of the check. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False - - DisableAlerting + + ProgressAction - Specifies whether alerting is disabled for the check. + {{ Fill ProgressAction Description }} - Boolean + ActionPreference - Boolean + ActionPreference None - - StopMonitoring + + + + + Id + + Specifies the ID of the integration to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the integration to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe input to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed integration and a message indicating the success of the removal operation. + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMIntegration -Id 12345 +Removes the LogicMonitor integration with ID 12345. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMIntegration -Name "Slack-Integration" +Removes the LogicMonitor integration with the name "Slack-Integration". + + + + + + + + + + Remove-LMLogPartition + Remove + LMLogPartition + + Removes a LogicMonitor log partition. + + + + The Remove-LMLogPartition function removes a LogicMonitor log partition based on the specified Id or Name. It requires a valid API authentication and authorization. + + + + Remove-LMLogPartition + + Id - Specifies whether monitoring is stopped for the check. + The Id of the log partition to be removed. This parameter is mandatory when using the 'Id' parameter set. - Boolean + Int32 - Boolean + Int32 - None + 0 - - UseDefaultAlertSetting + + WhatIf - Specifies whether to use the default alert settings for the check. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter - True + False - - UseDefaultLocationSetting + + Confirm - Specifies whether to use the default location settings for the check. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter - True + False - - GroupId + + ProgressAction - Specifies the ID of the group to which the check belongs. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None + + + Remove-LMLogPartition - PingAddress + Name - Specifies the address to ping for the ping check. + The Name of the log partition to be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -45101,153 +63943,246 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - PingCount + + WhatIf - Specifies the number of pings to send for the ping check. The valid values are 5, 10, 15, 20, 30, and 60. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - None + False - - PingTimeout + + Confirm - Specifies the timeout for the ping check. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - None + False - - PingPercentNotReceived + + ProgressAction - Specifies the percentage of packets not received in time for the ping check. The valid values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100. + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference None - - FailedCount + + + + + Id + + The Id of the log partition to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + The Name of the log partition to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this function. + + + + + + + + + + Returns a PSCustomObject containing the ID of the removed log partition and a success message confirming the removal. + + + + + + + + + This function requires a valid API authentication and authorization. Use Connect-LMAccount to log in before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMLogPartition -Id 123 +Removes the LogicMonitor log partition with the Id 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMLogPartition -Name "customerA" +Removes the LogicMonitor log partition with the Name "customerA". + + + + + + + + + + Remove-LMLogsource + Remove + LMLogsource + + Removes a LogicMonitor log source. + + + + The Remove-LMLogsource function removes a specified log source from LogicMonitor. The log source can be identified by either its ID or name. + + + + Remove-LMLogsource + + Id - Specifies the number of consecutive failed checks required to trigger an alert. The valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 30, and 60. + Specifies the ID of the log source to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 Int32 - None - - - OverallAlertLevel - - Specifies the overall alert level for the check. The valid values are "warn", "error", and "critical". - - String - - String - - - None - - - IndividualAlertLevel - - Specifies the individual alert level for the check. The valid values are "warn", "error", and "critical". - - String - - String - - - None + 0 - - Properties + + WhatIf - Specifies additional custom properties for the check. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Hashtable - Hashtable + SwitchParameter - None + False - - PropertiesMethod + + Confirm - Specifies the method to use for handling custom properties. The valid values are "Add", "Replace", and "Refresh". + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - Replace + False - - PollingInterval + + ProgressAction - Specifies the polling interval for the check. + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference None - - TestLocationAll + + + Remove-LMLogsource + + Name - Specifies whether to test from all locations. This parameter is only valid for external checks and cannot be used with TestLocationCollectorIds or TestLocationSmgIds. + Specifies the name of the log source to remove. This parameter is mandatory when using the 'Name' parameter set. - Boolean + String - Boolean + String None - - TestLocationCollectorIds + + WhatIf - Specifies the collector IDs to use for testing. Can only be used when IsInternal is true. Cannot be used with TestLocationAll or TestLocationSmgIds. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32[] - Int32[] + SwitchParameter - None + False - - TestLocationSmgIds + + Confirm - Specifies the collector group IDs to use for testing. Can only be used when IsInternal is false. Cannot be used with TestLocationAll or TestLocationCollectorIds. Available collector group IDs correspond to LogicMonitor regions: - 2 = US - Washington DC - - 3 = Europe - Dublin - - 4 = US - Oregon - - 5 = Asia - Singapore - - 6 = Australia - Sydney + Prompts you for confirmation before running the cmdlet. - Int32[] - Int32[] + SwitchParameter - None + False ProgressAction @@ -45264,34 +64199,22 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - - WebCheck - - Specifies that the check type is a website check. This parameter is mutually exclusive with the PingCheck parameter. - - SwitchParameter - - SwitchParameter - - - False - - - PingCheck + + Id - Specifies that the check type is a ping check. This parameter is mutually exclusive with the WebCheck parameter. + Specifies the ID of the log source to remove. This parameter is mandatory when using the 'Id' parameter set. - SwitchParameter + Int32 - SwitchParameter + Int32 - False + 0 Name - Specifies the name of the check. + Specifies the name of the log source to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -45300,130 +64223,436 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - IsInternal + + WhatIf - Specifies whether the check is internal or external. By default, it is set to $false. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean + SwitchParameter - Boolean + SwitchParameter False - - Description + + Confirm - Specifies the description of the check. + Prompts you for confirmation before running the cmdlet. - String + SwitchParameter - String + SwitchParameter - None + False - - DisableAlerting + + ProgressAction - Specifies whether alerting is disabled for the check. + {{ Fill ProgressAction Description }} - Boolean + ActionPreference - Boolean + ActionPreference None - - StopMonitoring + + + + + You can pipe objects to this function. + - Specifies whether monitoring is stopped for the check. + - Boolean + + + + - Boolean - + Returns a PSCustomObject containing the ID of the removed log source and a message confirming the successful removal. - None - - - UseDefaultAlertSetting - Specifies whether to use the default alert settings for the check. + - Boolean + + + + + This function requires a valid LogicMonitor API authentication. Make sure you are logged in before running any commands. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMLogsource -Id 123 +Removes the log source with ID 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMLogsource -Name "MyLogSource" +Removes the log source named "MyLogSource". + + + + + + + + + + Remove-LMNetscan + Remove + LMNetscan + + Removes a LogicMonitor Netscan. + + + + The Remove-LMNetscan function is used to remove a LogicMonitor Netscan. It supports removing a Netscan by either its Id or Name. + + + + Remove-LMNetscan + + Id + + Specifies the Id of the Netscan to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMNetscan + + Name + + Specifies the Name of the Netscan to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the Id of the Netscan to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 - Boolean + Int32 - True + 0 - - UseDefaultLocationSetting + + Name - Specifies whether to use the default location settings for the check. + Specifies the Name of the Netscan to remove. This parameter is mandatory when using the 'Name' parameter set. - Boolean + String - Boolean + String - True + None - - TriggerSSLStatusAlert + + WhatIf - Specifies whether to trigger an alert when the SSL status of the website check changes. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean + SwitchParameter - Boolean + SwitchParameter - None + False - - TriggerSSLExpirationAlert + + Confirm - Specifies whether to trigger an alert when the SSL certificate of the website check is about to expire. + Prompts you for confirmation before running the cmdlet. - Boolean + SwitchParameter - Boolean + SwitchParameter - None + False - - GroupId + + ProgressAction - Specifies the ID of the group to which the check belongs. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - PingAddress + + + + + You can pipe input to this function. + - Specifies the address to ping for the ping check. + - String + + + + + + Returns a PSCustomObject containing the ID of the removed Netscan and a message indicating the success of the removal operation. + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMNetscan -Id 123 +Removes the Netscan with Id 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMNetscan -Name "MyNetscan" +Removes the Netscan with the name "MyNetscan". + + + + + + + + + + Remove-LMNetscanGroup + Remove + LMNetscanGroup + + Removes a LogicMonitor NetScan group. + + + + The Remove-LMNetscanGroup function removes a LogicMonitor NetScan group based on the specified ID or name. It requires valid API credentials to be logged in. + + + + Remove-LMNetscanGroup + + Id + + Specifies the ID of the NetScan group to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMNetscanGroup + + Name + + Specifies the name of the NetScan group to remove. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the ID of the NetScan group to remove. This parameter is mandatory when using the 'Id' parameter set. + + Int32 - String + Int32 - None + 0 - WebsiteDomain + Name - Specifies the domain of the website to check. + Specifies the name of the NetScan group to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -45432,118 +64661,306 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - HttpType + + WhatIf - Specifies the HTTP type to use for the website check. The valid values are "http" and "https". The default value is "https". + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String + SwitchParameter - String + SwitchParameter - Https + False - - SSLAlertThresholds + + Confirm - Specifies the SSL alert thresholds for the website check. + Prompts you for confirmation before running the cmdlet. - String[] + SwitchParameter - String[] + SwitchParameter - None + False - - PingCount + + ProgressAction - Specifies the number of pings to send for the ping check. The valid values are 5, 10, 15, 20, 30, and 60. + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference None - - PingTimeout + + + + + You can pipe objects to this function. + - Specifies the timeout for the ping check. + - Int32 + + + + - Int32 - + Returns a PSCustomObject containing the ID of the removed NetScan group and a message indicating the success of the removal operation. - None - - - PageLoadAlertTimeInMS - Specifies the page load alert time in milliseconds for the website check. + - Int32 + + + + + This function requires valid API credentials to be logged in. Use the Connect-LMAccount function to log in before running any commands. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMNetscanGroup -Id 123 +Removes the NetScan group with ID 123. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Remove-LMNetscanGroup -Name "MyGroup" +Removes the NetScan group with the name "MyGroup". + + + + + + + + + + Remove-LMNormalizedProperty + Remove + LMNormalizedProperty + + Removes normalized properties from LogicMonitor. + + + + The Remove-LMNormalizedProperty cmdlet removes normalized properties from LogicMonitor. + + + + Remove-LMNormalizedProperty + + Alias + + The alias name of the normalized property to remove. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Alias + + The alias name of the normalized property to remove. + + String - Int32 + String None - - IgnoreSSL + + WhatIf - Specifies whether to ignore SSL errors for the website check. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean + SwitchParameter - Boolean + SwitchParameter - None + False - - PingPercentNotReceived + + Confirm - Specifies the percentage of packets not received in time for the ping check. The valid values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100. + Prompts you for confirmation before running the cmdlet. - Int32 + SwitchParameter - Int32 + SwitchParameter - None + False - - FailedCount + + ProgressAction - Specifies the number of consecutive failed checks required to trigger an alert. The valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 30, and 60. + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference None - - OverallAlertLevel + + + + + None. + - Specifies the overall alert level for the check. The valid values are "warn", "error", and "critical". + - String + + + + - String - + Returns the response from the API after removing the normalized property. - None - - - IndividualAlertLevel - Specifies the individual alert level for the check. The valid values are "warn", "error", and "critical". + + + + + + + This function requires valid API credentials to be logged in. Use Connect-LMAccount to log in before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMNormalizedProperty -Alias "location" +Removes the normalized property with alias "location". + + + + + + + + + + Remove-LMOpsNote + Remove + LMOpsNote + + Removes an OpsNote from LogicMonitor. + + + + The Remove-LMOpsNote function removes an OpsNote from LogicMonitor. It requires the user to be logged in and have valid API credentials. + + + + Remove-LMOpsNote + + Id + + Specifies the ID of the OpsNote to be removed. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the ID of the OpsNote to be removed. String @@ -45552,105 +64969,240 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - Properties + + WhatIf - Specifies additional custom properties for the check. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Hashtable + SwitchParameter - Hashtable + SwitchParameter - None + False - - PropertiesMethod + + Confirm - Specifies the method to use for handling custom properties. The valid values are "Add", "Replace", and "Refresh". + Prompts you for confirmation before running the cmdlet. - String + SwitchParameter - String + SwitchParameter - Replace + False - - PollingInterval + + ProgressAction - Specifies the polling interval for the check. + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference None - - WebsiteSteps + + + + + You can pipe objects to this function. + - Specifies the steps to perform for the website check. + - Object[] + + + + - Object[] - + Returns a PSCustomObject containing the ID of the removed OpsNote and a message indicating the success of the removal operation. - None - - - CheckPoints - Specifies the check points for the check. This is a legacy parameter and has been replaced with the TestLocation* parameters and may be removed in a future version. + - Object[] + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-LMOpsNote -Id "12345" +Removes the OpsNote with the ID "12345" from LogicMonitor. + + + + + + + + + + Remove-LMPropertysource + Remove + LMPropertysource + + Removes a property source from LogicMonitor. + + + + The Remove-LMPropertysource function removes a property source from LogicMonitor. It can remove a property source either by its ID or by its name. + + + + Remove-LMPropertysource + + Id + + Specifies the ID of the property source to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Remove-LMPropertysource + + Name + + Specifies the name of the property source to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + Specifies the ID of the property source to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 - Object[] + Int32 - None + 0 - - TestLocationAll + + Name - Specifies whether to test from all locations. This parameter is only valid for external checks and cannot be used with TestLocationCollectorIds or TestLocationSmgIds. + Specifies the name of the property source to be removed. This parameter is mandatory when using the 'Name' parameter set. - Boolean + String - Boolean + String None - - TestLocationCollectorIds + + WhatIf - Specifies the collector IDs to use for testing. Can only be used when IsInternal is true. Cannot be used with TestLocationAll or TestLocationSmgIds. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32[] + SwitchParameter - Int32[] + SwitchParameter - None + False - - TestLocationSmgIds + + Confirm - Specifies the collector group IDs to use for testing. Can only be used when IsInternal is false. Cannot be used with TestLocationAll or TestLocationCollectorIds. Available collector group IDs correspond to LogicMonitor regions: - 2 = US - Washington DC - - 3 = Europe - Dublin - - 4 = US - Oregon - - 5 = Asia - Singapore - - 6 = Australia - Sydney + Prompts you for confirmation before running the cmdlet. - Int32[] + SwitchParameter - Int32[] + SwitchParameter - None + False ProgressAction @@ -45668,7 +65220,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - None. You cannot pipe objects to this command. + You can pipe input to this function. @@ -45678,7 +65230,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - Returns LogicMonitor.Website object. + Returns a PSCustomObject containing the ID of the removed property source and a message indicating the success of the removal operation. @@ -45687,36 +65239,24 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - You must run Connect-LMAccount before running this command. + -------------------------- EXAMPLE 1 -------------------------- - New-LMWebsite -WebCheck -Name "Example Website" -WebsiteDomain "example.com" -HttpType "https" -GroupId "12345" -OverallAlertLevel "error" -IndividualAlertLevel "warn" + Remove-LMPropertysource -Id 123 +Removes the property source with ID 123. - This example creates a new LogicMonitor website check for the website "example.com" with HTTPS protocol. It assigns the check to the group with ID "12345" and sets the overall alert level to "error" and the individual alert level to "warn". + -------------------------- EXAMPLE 2 -------------------------- - New-LMWebsite -PingCheck -Name "Example Ping" -PingAddress "192.168.1.1" -PingCount 5 -PingTimeout 1000 -GroupId "12345" -OverallAlertLevel "warn" -IndividualAlertLevel "warn" - - This example creates a new LogicMonitor ping check for the IP address "192.168.1.1". It sends 5 pings with a timeout of 1000 milliseconds. It assigns the check to the group with ID "12345" and sets the overall alert level and individual alert level to "warn". - - - - -------------------------- EXAMPLE 3 -------------------------- - New-LMWebsite -WebCheck -Name "External Website" -WebsiteDomain "example.com" -IsInternal $false -TestLocationSmgIds @(2, 3, 4) - - This example creates a new LogicMonitor website check for an external website "example.com". It configures the check to test from specific LogicMonitor regions (US - Washington DC, Europe - Dublin, and US - Oregon). - - - - -------------------------- EXAMPLE 4 -------------------------- - New-LMWebsite -WebCheck -Name "Internal Website" -WebsiteDomain "internal.example.com" -IsInternal $true -TestLocationCollectorIds @(1, 2, 3) + Remove-LMPropertysource -Name "MyPropertySource" +Removes the property source with the name "MyPropertySource". - This example creates a new LogicMonitor website check for an internal website "internal.example.com". It configures the check to test from specific collectors with IDs 1, 2, and 3. + @@ -45724,90 +65264,183 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - New-LMWebsiteGroup - New - LMWebsiteGroup + Remove-LMRecentlyDeleted + Remove + LMRecentlyDeleted - Creates a new LogicMonitor website group. + Permanently removes one or more resources from the LogicMonitor recycle bin. - The New-LMWebsiteGroup function creates a new website group in LogicMonitor. It allows you to specify the name, description, properties, and parent group of the website group. + The Remove-LMRecentlyDeleted function submits a batch delete request for the provided recycle identifiers, permanently removing the associated resources from the recycle bin. - New-LMWebsiteGroup - - Name + Remove-LMRecentlyDeleted + + RecycleId - The name of the website group. This parameter is mandatory. + One or more recycle identifiers representing deleted resources. Accepts pipeline input and property names of Id. - String + String[] - String + String[] None - - Description + + WhatIf - The description of the website group. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - Properties + + Confirm - A hashtable of custom properties for the website group. + Prompts you for confirmation before running the cmdlet. - Hashtable - Hashtable + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference None - - DisableAlerting + + + + + RecycleId + + One or more recycle identifiers representing deleted resources. Accepts pipeline input and property names of Id. + + String[] + + String[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + You must establish a session with Connect-LMAccount prior to calling this function. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Get-LMRecentlyDeleted -ResourceType deviceGroup -DeletedBy "lmsupport" | Select-Object -First 3 -ExpandProperty id | Remove-LMRecentlyDeleted + + Permanently deletes the first three device groups currently in the recycle bin for the user lmsupport. + + + + + + + + Remove-LMRecipientGroup + Remove + LMRecipientGroup + + Removes a LogicMonitor recipient group. + + + + The Remove-LMRecipientGroup function removes a LogicMonitor recipient group based on the specified Id or Name. It requires valid API credentials to be logged in. + + + + Remove-LMRecipientGroup + + Id - Specifies whether to disable alerting for the website group. By default, alerting is enabled. + The Id of the recipient group to remove. This parameter is mandatory when using the 'Id' parameter set. - Boolean + Int32 - Boolean + Int32 - False + 0 - - StopMonitoring + + WhatIf - Specifies whether to stop monitoring the website group. By default, monitoring is not stopped. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter False - - ParentGroupId + + Confirm - The ID of the parent group. This parameter is mandatory if the ParentGroupName parameter is not specified. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False ProgressAction @@ -45823,23 +65456,11 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - New-LMWebsiteGroup + Remove-LMRecipientGroup Name - The name of the website group. This parameter is mandatory. - - String - - String - - - None - - - Description - - The description of the website group. + The name of the recipient group to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -45848,54 +65469,28 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - Properties - - A hashtable of custom properties for the website group. - - Hashtable - - Hashtable - - - None - - - DisableAlerting + + WhatIf - Specifies whether to disable alerting for the website group. By default, alerting is enabled. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter False - - StopMonitoring + + Confirm - Specifies whether to stop monitoring the website group. By default, monitoring is not stopped. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter False - - ParentGroupName - - The name of the parent group. This parameter is mandatory if the ParentGroupId parameter is not specified. - - String - - String - - - None - ProgressAction @@ -45911,22 +65506,22 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - - Name + + Id - The name of the website group. This parameter is mandatory. + The Id of the recipient group to remove. This parameter is mandatory when using the 'Id' parameter set. - String + Int32 - String + Int32 - None + 0 - - Description + + Name - The description of the website group. + The name of the recipient group to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -45935,66 +65530,30 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys None - - Properties - - A hashtable of custom properties for the website group. - - Hashtable - - Hashtable - - - None - - - DisableAlerting + + WhatIf - Specifies whether to disable alerting for the website group. By default, alerting is enabled. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean + SwitchParameter - Boolean + SwitchParameter False - - StopMonitoring + + Confirm - Specifies whether to stop monitoring the website group. By default, monitoring is not stopped. + Prompts you for confirmation before running the cmdlet. - Boolean + SwitchParameter - Boolean + SwitchParameter False - - ParentGroupId - - The ID of the parent group. This parameter is mandatory if the ParentGroupName parameter is not specified. - - Int32 - - Int32 - - - 0 - - - ParentGroupName - - The name of the parent group. This parameter is mandatory if the ParentGroupId parameter is not specified. - - String - - String - - - None - ProgressAction @@ -46011,7 +65570,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - None. You cannot pipe objects to this command. + You can pipe input to this function. @@ -46021,7 +65580,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - Returns LogicMonitor.WebsiteGroup object. + Returns a PSCustomObject containing the ID of the removed recipient group and a success message confirming the removal. @@ -46030,22 +65589,24 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - You must run Connect-LMAccount before running this command. + -------------------------- EXAMPLE 1 -------------------------- - New-LMWebsiteGroup -Name "MyWebsiteGroup" -Description "This is my website group" -ParentGroupId 1234 + Remove-LMRecipientGroup -Id 123 +Removes the recipient group with Id 123. - This example creates a new website group with the name "MyWebsiteGroup", description "This is my website group", and parent group ID 1234. + -------------------------- EXAMPLE 2 -------------------------- - New-LMWebsiteGroup -Name "MyWebsiteGroup" -Description "This is my website group" -ParentGroupName "ParentGroup" + Remove-LMRecipientGroup -Name "MyRecipientGroup" +Removes the recipient group with the name "MyRecipientGroup". - This example creates a new website group with the name "MyWebsiteGroup", description "This is my website group", and parent group name "ParentGroup". + @@ -46053,23 +65614,23 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - Remove-LMAccessGroup + Remove-LMReport Remove - LMAccessGroup + LMReport - Removes a LogicMonitor access group. + Removes a LogicMonitor report. - The Remove-LMAccessGroup function removes a LogicMonitor access group based on the specified ID or name. + The Remove-LMReport function removes a LogicMonitor report based on the specified report ID or name. It requires a valid API authentication and authorization. - Remove-LMAccessGroup + Remove-LMReport Id - The ID of the access group to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the report to be removed. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -46114,11 +65675,11 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - Remove-LMAccessGroup + Remove-LMReport Name - The name of the access group to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the report to be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -46167,7 +65728,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys Id - The ID of the access group to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the report to be removed. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -46179,7 +65740,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys Name - The name of the access group to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the report to be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -46228,7 +65789,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - None. You cannot pipe objects to this command. + You can pipe input to this function. @@ -46238,7 +65799,7 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - Returns a PSCustomObject containing the ID of the removed access group and a success message confirming the removal. + Returns a PSCustomObject containing the ID of the removed report and a message indicating the success of the removal operation. @@ -46247,22 +65808,22 @@ New-LMNormalizedProperties -Alias "location" -Properties @("location", "snmp.sys - This function requires a valid LogicMonitor API authentication. Make sure to log in using Connect-LMAccount before running this command. + This function requires a valid API authentication and authorization. Use Connect-LMAccount to log in before running this command. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMAccessGroup -Id 123 -Removes the access group with the ID 123. + Remove-LMReport -Id 123 +Removes the report with ID 123. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMAccessGroup -Name "MyAccessGroup" -Removes the access group with the name "MyAccessGroup". + Remove-LMReport -Name "MyReport" +Removes the report with the name "MyReport". @@ -46272,23 +65833,23 @@ Removes the access group with the name "MyAccessGroup". - Remove-LMAlertRule + Remove-LMReportGroup Remove - LMAlertRule + LMReportGroup - Removes a LogicMonitor alert rule. + Removes a LogicMonitor report group. - The Remove-LMAlertRule function removes a LogicMonitor alert rule based on the specified ID or name. + The Remove-LMReportGroup function removes a LogicMonitor report group based on the specified Id or Name. It requires valid API credentials to be logged in. - Remove-LMAlertRule + Remove-LMReportGroup Id - The ID of the alert rule to remove. This parameter is mandatory when using the 'Id' parameter set. + The Id of the report group to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -46333,11 +65894,11 @@ Removes the access group with the name "MyAccessGroup". - Remove-LMAlertRule + Remove-LMReportGroup Name - The name of the alert rule to remove. This parameter is mandatory when using the 'Name' parameter set. + The name of the report group to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -46386,7 +65947,7 @@ Removes the access group with the name "MyAccessGroup". Id - The ID of the alert rule to remove. This parameter is mandatory when using the 'Id' parameter set. + The Id of the report group to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -46398,7 +65959,7 @@ Removes the access group with the name "MyAccessGroup". Name - The name of the alert rule to remove. This parameter is mandatory when using the 'Name' parameter set. + The name of the report group to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -46447,7 +66008,7 @@ Removes the access group with the name "MyAccessGroup". - None. You cannot pipe objects to this command. + You can pipe input to this function. @@ -46457,7 +66018,7 @@ Removes the access group with the name "MyAccessGroup". - Returns a PSCustomObject containing the ID of the removed alert rule and a success message confirming the removal. + Returns a PSCustomObject containing the ID of the removed report group and a success message confirming the removal. @@ -46466,22 +66027,22 @@ Removes the access group with the name "MyAccessGroup". - This function requires a valid LogicMonitor API authentication. Make sure to log in using Connect-LMAccount before running this command. + -------------------------- EXAMPLE 1 -------------------------- - Remove-LMAlertRule -Id 123 -Removes the alert rule with the ID 123. + Remove-LMReportGroup -Id 123 +Removes the report group with Id 123. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMAlertRule -Name "MyAlertRule" -Removes the alert rule with the name "MyAlertRule". + Remove-LMReportGroup -Name "MyReportGroup" +Removes the report group with the name "MyReportGroup". @@ -46491,96 +66052,23 @@ Removes the alert rule with the name "MyAlertRule". - Remove-LMAPIToken + Remove-LMRole Remove - LMAPIToken + LMRole - Removes an API token from Logic Monitor. + Removes a LogicMonitor role. - The Remove-LMAPIToken function is used to remove an API token from Logic Monitor. It supports removing the token by specifying either the token's ID, the user's ID and token's ID, or the user's name and token's ID. + The Remove-LMRole function removes a LogicMonitor role based on the specified Id or Name. It requires a valid API authentication and authorization. - Remove-LMAPIToken - - UserId - - The ID of the user associated with the API token. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - APITokenId - - The ID of the API token. This parameter is mandatory when using the 'Id' or 'Name' parameter set. - - Int32 - - Int32 - - - 0 - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Remove-LMAPIToken - - UserName - - The name of the user associated with the API token. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - APITokenId + Remove-LMRole + + Id - The ID of the API token. This parameter is mandatory when using the 'Id' or 'Name' parameter set. + The Id of the role to be removed. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -46625,11 +66113,11 @@ Removes the alert rule with the name "MyAlertRule". - Remove-LMAPIToken - - AccessId + Remove-LMRole + + Name - The access ID of the API token. This parameter is mandatory when using the 'AccessId' parameter set. + The Name of the role to be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -46675,10 +66163,10 @@ Removes the alert rule with the name "MyAlertRule". - - UserId + + Id - The ID of the user associated with the API token. This parameter is mandatory when using the 'Id' parameter set. + The Id of the role to be removed. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -46688,21 +66176,9 @@ Removes the alert rule with the name "MyAlertRule". 0 - UserName - - The name of the user associated with the API token. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - AccessId + Name - The access ID of the API token. This parameter is mandatory when using the 'AccessId' parameter set. + The Name of the role to be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -46711,18 +66187,6 @@ Removes the alert rule with the name "MyAlertRule". None - - APITokenId - - The ID of the API token. This parameter is mandatory when using the 'Id' or 'Name' parameter set. - - Int32 - - Int32 - - - 0 - WhatIf @@ -46763,7 +66227,7 @@ Removes the alert rule with the name "MyAlertRule". - You can pipe API token objects to this function. + None. You cannot pipe objects to this function. @@ -46773,7 +66237,7 @@ Removes the alert rule with the name "MyAlertRule". - Returns a PSCustomObject containing the ID of the removed API token and a success message confirming the removal. + Returns a PSCustomObject containing the ID of the removed role and a success message confirming the removal. @@ -46782,30 +66246,22 @@ Removes the alert rule with the name "MyAlertRule". - This function requires a valid API authentication. Make sure to log in using Connect-LMAccount before running this command. + This function requires a valid API authentication and authorization. Use Connect-LMAccount to log in before running this command. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMAPIToken -UserId 1234 -APITokenId 5678 -Removes the API token with ID 5678 associated with the user with ID 1234. + Remove-LMRole -Id 123 +Removes the LogicMonitor role with the Id 123. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMAPIToken -UserName "john.doe" -APITokenId 5678 -Removes the API token with ID 5678 associated with the user with name "john.doe". - - - - - - -------------------------- EXAMPLE 3 -------------------------- - Remove-LMAPIToken -AccessId "abcd1234" -Removes the API token with the specified access ID. + Remove-LMRole -Name "Admin" +Removes the LogicMonitor role with the Name "Admin". @@ -46815,23 +66271,23 @@ Removes the API token with the specified access ID. - Remove-LMAppliesToFunction + Remove-LMSDT Remove - LMAppliesToFunction + LMSDT - Removes an AppliesTo function from LogicMonitor. + Removes a Scheduled Down Time (SDT) entry from LogicMonitor. - The Remove-LMAppliesToFunction function removes an AppliesTo function from LogicMonitor. It can be used to remove a function either by its name or its ID. + The Remove-LMSDT function removes a specified SDT entry from LogicMonitor using its ID. - Remove-LMAppliesToFunction - - Name + Remove-LMSDT + + Id - Specifies the name of the AppliesTo function to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the ID of the SDT entry to remove. This parameter is mandatory. String @@ -46875,61 +66331,12 @@ Removes the API token with the specified access ID. None - - Remove-LMAppliesToFunction - - Id - - Specifies the ID of the AppliesTo function to be removed. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Name + + Id - Specifies the name of the AppliesTo function to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the ID of the SDT entry to remove. This parameter is mandatory. String @@ -46938,18 +66345,6 @@ Removes the API token with the specified access ID. None - - Id - - Specifies the ID of the AppliesTo function to be removed. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - WhatIf @@ -46990,7 +66385,7 @@ Removes the API token with the specified access ID. - None. You cannot pipe objects to this function. + You can pipe objects to this function. @@ -47000,7 +66395,7 @@ Removes the API token with the specified access ID. - Returns a PSCustomObject containing the ID of the removed AppliesTo function and a success message confirming the removal. + Returns a PSCustomObject containing the ID of the removed SDT entry and a success message confirming the removal. @@ -47009,22 +66404,14 @@ Removes the API token with the specified access ID. - This function requires a valid LogicMonitor API authentication. Make sure to log in using Connect-LMAccount before running this command. + -------------------------- EXAMPLE 1 -------------------------- - Remove-LMAppliesToFunction -Name "MyAppliesToFunction" -Removes the AppliesTo function with the name "MyAppliesToFunction". - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMAppliesToFunction -Id 12345 -Removes the AppliesTo function with the ID 12345. + Remove-LMSDT -Id "12345" +Removes the SDT entry with ID "12345". @@ -47034,30 +66421,54 @@ Removes the AppliesTo function with the ID 12345. - Remove-LMCachedAccount + Remove-LMServiceGroup Remove - LMCachedAccount + LMServiceGroup - Removes cached account information from the Logic.Monitor vault. + Removes a LogicMonitor Service group. - The Remove-LMCachedAccount function is used to remove cached account information from the Logic.Monitor vault. It provides two parameter sets: 'Single' and 'All'. When using the 'Single' parameter set, you can specify a single cached account to remove. When using the 'All' parameter set, all cached accounts will be removed. + The Remove-LMServiceGroup function is used to remove a LogicMonitor Service group. It supports removing the group by either its ID or name. The function requires valid API credentials to be logged in. - Remove-LMCachedAccount - - CachedAccountName + Remove-LMServiceGroup + + Id - Specifies the name of the cached account to remove. This parameter is used with the 'Single' parameter set. + Specifies the ID of the Service group to be removed. This parameter is mandatory when using the 'Id' parameter set. - String + Int32 - String + Int32 - None + 0 + + + DeleteHostsandChildren + + Specifies whether to delete the service group and their children services within the Service group. By default, this parameter is set to $false. + + Boolean + + Boolean + + + False + + + HardDelete + + Specifies whether to perform a hard delete, which permanently removes the Service group and its associated data. By default, this parameter is set to $false. + + Boolean + + Boolean + + + False WhatIf @@ -47095,14 +66506,39 @@ Removes the AppliesTo function with the ID 12345. - Remove-LMCachedAccount + Remove-LMServiceGroup + + Name + + Specifies the name of the Service group to be removed. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + - RemoveAllEntries + DeleteHostsandChildren - Indicates that all cached accounts should be removed. This parameter is used with the 'All' parameter set. + Specifies whether to delete the service group and their children services within the Service group. By default, this parameter is set to $false. + Boolean - SwitchParameter + Boolean + + + False + + + HardDelete + + Specifies whether to perform a hard delete, which permanently removes the Service group and its associated data. By default, this parameter is set to $false. + + Boolean + + Boolean False @@ -47144,10 +66580,22 @@ Removes the AppliesTo function with the ID 12345. - - CachedAccountName + + Id - Specifies the name of the cached account to remove. This parameter is used with the 'Single' parameter set. + Specifies the ID of the Service group to be removed. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the Service group to be removed. This parameter is mandatory when using the 'Name' parameter set. String @@ -47157,13 +66605,25 @@ Removes the AppliesTo function with the ID 12345. None - RemoveAllEntries + DeleteHostsandChildren - Indicates that all cached accounts should be removed. This parameter is used with the 'All' parameter set. + Specifies whether to delete the service group and their children services within the Service group. By default, this parameter is set to $false. - SwitchParameter + Boolean - SwitchParameter + Boolean + + + False + + + HardDelete + + Specifies whether to perform a hard delete, which permanently removes the Service group and its associated data. By default, this parameter is set to $false. + + Boolean + + Boolean False @@ -47208,7 +66668,7 @@ Removes the AppliesTo function with the ID 12345. - You can pipe objects to this function. + None. @@ -47218,7 +66678,7 @@ Removes the AppliesTo function with the ID 12345. - This function does not generate any output. + Returns a PSCustomObject containing the ID of the removed Service group and a message confirming the successful removal. @@ -47227,22 +66687,22 @@ Removes the AppliesTo function with the ID 12345. - This function operates on the local credential vault and does not require API authentication. + This function requires valid API credentials to be logged in. Use the Connect-LMAccount function to log in before running any commands. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMCachedAccount -CachedAccountName "JohnDoe" -Removes the cached account with the name "JohnDoe" from the Logic.Monitor vault. + Remove-LMServiceGroup -Id 12345 +Removes the Service group with the specified ID. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMCachedAccount -RemoveAllEntries -Removes all cached accounts from the Logic.Monitor vault. + Remove-LMServiceGroup -Name "MyServiceGroup" +Removes the Service group with the specified name. @@ -47252,79 +66712,42 @@ Removes all cached accounts from the Logic.Monitor vault. - Remove-LMCollectorGroup + Remove-LMServiceTemplate Remove - LMCollectorGroup + LMServiceTemplate - Removes a LogicMonitor Collector Group. + Removes a LogicMonitor Service template. - The Remove-LMCollectorGroup function removes a LogicMonitor Collector Group based on the provided Id or Name. + The Remove-LMServiceTemplate function removes a LogicMonitor Service template by ID. - Remove-LMCollectorGroup - + Remove-LMServiceTemplate + Id - Specifies the Id of the Collector Group to remove. This parameter is mandatory when using the 'Id' parameter set. + The ID of the Service template to remove. This parameter is mandatory. - Int32 - - Int32 - - - 0 - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference + String - ActionPreference + String None - - - Remove-LMCollectorGroup - - Name + + DeleteHard - Specifies the Name of the Collector Group to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies whether to perform a hard delete. Default is $false (soft delete). - String + Boolean - String + Boolean - None + False WhatIf @@ -47363,29 +66786,29 @@ Removes all cached accounts from the Logic.Monitor vault. - + Id - Specifies the Id of the Collector Group to remove. This parameter is mandatory when using the 'Id' parameter set. + The ID of the Service template to remove. This parameter is mandatory. - Int32 + String - Int32 + String - 0 + None - - Name + + DeleteHard - Specifies the Name of the Collector Group to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies whether to perform a hard delete. Default is $false (soft delete). - String + Boolean - String + Boolean - None + False WhatIf @@ -47427,7 +66850,7 @@ Removes all cached accounts from the Logic.Monitor vault. - You can pipe objects to this function. + None. You cannot pipe objects to this command. @@ -47437,7 +66860,7 @@ Removes all cached accounts from the Logic.Monitor vault. - Returns a PSCustomObject containing the ID of the removed collector group and a success message confirming the removal. + Returns a PSCustomObject containing the ID of the removed service template and a success message confirming the removal. @@ -47446,22 +66869,22 @@ Removes all cached accounts from the Logic.Monitor vault. - This function requires valid API credentials to be logged in. Use Connect-LMAccount to log in before running this command. + -------------------------- EXAMPLE 1 -------------------------- - Remove-LMCollectorGroup -Id 123 -Removes the Collector Group with Id 123. + Remove-LMServiceTemplate -Id 6 +This example removes the LogicMonitor Service template with ID 6 using soft delete. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMCollectorGroup -Name "Group1" -Removes the Collector Group with Name "Group1". + Remove-LMServiceTemplate -Id 6 -DeleteHard $true +This example removes the LogicMonitor Service template with ID 6 using hard delete. @@ -47471,23 +66894,23 @@ Removes the Collector Group with Name "Group1". - Remove-LMConfigsource + Remove-LMTopologysource Remove - LMConfigsource + LMTopologysource - Removes a LogicMonitor configsource. + Removes a topology source from LogicMonitor. - The Remove-LMConfigsource function removes a LogicMonitor configsource based on the specified Id or Name. + The Remove-LMTopologysource function removes a topology source from LogicMonitor using either its ID or name. - Remove-LMConfigsource + Remove-LMTopologysource Id - Specifies the Id of the configsource to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the topology source to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -47532,11 +66955,11 @@ Removes the Collector Group with Name "Group1". - Remove-LMConfigsource + Remove-LMTopologysource Name - Specifies the Name of the configsource to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the topology source to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -47585,7 +67008,7 @@ Removes the Collector Group with Name "Group1". Id - Specifies the Id of the configsource to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the topology source to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -47597,7 +67020,7 @@ Removes the Collector Group with Name "Group1". Name - Specifies the Name of the configsource to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the topology source to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -47656,7 +67079,7 @@ Removes the Collector Group with Name "Group1". - Returns a PSCustomObject containing the ID of the removed configsource and a success message confirming the removal. + Returns a PSCustomObject containing the ID of the removed topology source and a success message confirming the removal. @@ -47665,22 +67088,22 @@ Removes the Collector Group with Name "Group1". - Please ensure you are logged in before running any commands. Use Connect-LMAccount to login and try again. + -------------------------- EXAMPLE 1 -------------------------- - Remove-LMConfigsource -Id 123 -Removes the configsource with Id 123. + Remove-LMTopologysource -Id 123 +Removes the topology source with ID 123. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMConfigsource -Name "ConfigSource1" -Removes the configsource with the name "ConfigSource1". + Remove-LMTopologysource -Name "MyTopologySource" +Removes the topology source with the name "MyTopologySource". @@ -47690,76 +67113,27 @@ Removes the configsource with the name "ConfigSource1". - Remove-LMDashboard + Remove-LMUnmonitoredDevice Remove - LMDashboard + LMUnmonitoredDevice - Removes a LogicMonitor dashboard. + Removes unmonitored devices from LogicMonitor. - The Remove-LMDashboard function is used to remove a LogicMonitor dashboard. It supports removing a dashboard by either its ID or name. + The Remove-LMUnmonitoredDevice function removes one or more unmonitored devices from LogicMonitor using their IDs. - Remove-LMDashboard - - Id - - Specifies the ID of the dashboard to remove. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Remove-LMDashboard + Remove-LMUnmonitoredDevice - Name + Ids - Specifies the name of the dashboard to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies an array of IDs for the unmonitored devices to remove. - String + String[] - String + String[] None @@ -47801,26 +67175,14 @@ Removes the configsource with the name "ConfigSource1". - - Id - - Specifies the ID of the dashboard to remove. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - Name + Ids - Specifies the name of the dashboard to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies an array of IDs for the unmonitored devices to remove. - String + String[] - String + String[] None @@ -47865,7 +67227,7 @@ Removes the configsource with the name "ConfigSource1". - You can pipe input to this function. + None. @@ -47875,7 +67237,7 @@ Removes the configsource with the name "ConfigSource1". - Returns a PSCustomObject containing the ID of the removed dashboard and a message indicating the success of the removal operation. + Returns a LogicMonitor.UnmonitoredDevice object containing information about the removed devices. @@ -47884,22 +67246,14 @@ Removes the configsource with the name "ConfigSource1". - This function requires a valid LogicMonitor API authentication. Make sure you are logged in before running this command. + -------------------------- EXAMPLE 1 -------------------------- - Remove-LMDashboard -Id 123 -Removes the dashboard with ID 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMDashboard -Name "My Dashboard" -Removes the dashboard with the name "My Dashboard". + Remove-LMUnmonitoredDevice -Ids "123","456" +Removes the unmonitored devices with IDs "123" and "456". @@ -47909,23 +67263,23 @@ Removes the dashboard with the name "My Dashboard". - Remove-LMDashboardGroup + Remove-LMUptimeDevice Remove - LMDashboardGroup + LMUptimeDevice - Removes a LogicMonitor dashboard group. + Removes a LogicMonitor Uptime device using the v3 device endpoint. - The Remove-LMDashboardGroup function removes a LogicMonitor dashboard group based on the specified Id or Name. + The Remove-LMUptimeDevice cmdlet deletes an Uptime monitor (web or ping) from LogicMonitor via the v3 device endpoint. It accepts either the numerical identifier or resolves the identifier from a device name, and submits a DELETE request with the required X-Version header. - Remove-LMDashboardGroup + Remove-LMUptimeDevice Id - The Id of the dashboard group to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the device identifier to remove. Accepts pipeline input by property name. Int32 @@ -47934,6 +67288,18 @@ Removes the dashboard with the name "My Dashboard". 0 + + HardDelete + + Indicates whether to permanently delete the device. When $false (default), the device is moved to the recycle bin. + + Boolean + + Boolean + + + False + WhatIf @@ -47970,11 +67336,11 @@ Removes the dashboard with the name "My Dashboard". - Remove-LMDashboardGroup + Remove-LMUptimeDevice Name - The name of the dashboard group to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the device name to remove. The cmdlet resolves the device and then removes it. String @@ -47983,6 +67349,18 @@ Removes the dashboard with the name "My Dashboard". None + + HardDelete + + Indicates whether to permanently delete the device. When $false (default), the device is moved to the recycle bin. + + Boolean + + Boolean + + + False + WhatIf @@ -48023,7 +67401,7 @@ Removes the dashboard with the name "My Dashboard". Id - The Id of the dashboard group to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the device identifier to remove. Accepts pipeline input by property name. Int32 @@ -48035,7 +67413,7 @@ Removes the dashboard with the name "My Dashboard". Name - The name of the dashboard group to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the device name to remove. The cmdlet resolves the device and then removes it. String @@ -48044,6 +67422,18 @@ Removes the dashboard with the name "My Dashboard". None + + HardDelete + + Indicates whether to permanently delete the device. When $false (default), the device is moved to the recycle bin. + + Boolean + + Boolean + + + False + WhatIf @@ -48081,20 +67471,11 @@ Removes the dashboard with the name "My Dashboard". None - - - - None. - - - - - - + - Returns a PSCustomObject containing the ID of the removed dashboard group and a success message confirming the removal. + System.Management.Automation.PSCustomObject @@ -48103,24 +67484,22 @@ Removes the dashboard with the name "My Dashboard". - This function requires a valid LogicMonitor API authentication. + You must run Connect-LMAccount before invoking this cmdlet. Requests target /device/devices/{id}?deleteHard={bool} with X-Version 3. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMDashboardGroup -Id 123 -Removes the dashboard group with Id 123. + Remove-LMUptimeDevice -Id 42 - + Removes the Uptime device with ID 42. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMDashboardGroup -Name "MyDashboardGroup" -Removes the dashboard group with the name "MyDashboardGroup". + Remove-LMUptimeDevice -Name "web-int-01" - + Resolves the device ID by name and removes the corresponding Uptime device. @@ -48128,23 +67507,23 @@ Removes the dashboard group with the name "MyDashboardGroup". - Remove-LMDashboardWidget + Remove-LMUser Remove - LMDashboardWidget + LMUser - Removes a dashboard widget from Logic Monitor. + Removes a user from LogicMonitor. - The Remove-LMDashboardWidget function removes a dashboard widget from Logic Monitor. It can remove a widget either by its ID or by its name. + The Remove-LMUser function removes a user from LogicMonitor using either their ID or name. - Remove-LMDashboardWidget + Remove-LMUser Id - The ID of the widget to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the user to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -48189,11 +67568,11 @@ Removes the dashboard group with the name "MyDashboardGroup". - Remove-LMDashboardWidget + Remove-LMUser Name - The name of the widget to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the user to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -48242,7 +67621,7 @@ Removes the dashboard group with the name "MyDashboardGroup". Id - The ID of the widget to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the user to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -48254,7 +67633,7 @@ Removes the dashboard group with the name "MyDashboardGroup". Name - The name of the widget to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the user to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -48313,7 +67692,7 @@ Removes the dashboard group with the name "MyDashboardGroup". - Returns a PSCustomObject containing the ID of the removed widget and a message indicating the success of the removal operation. + Returns a PSCustomObject containing the ID of the removed user and a success message confirming the removal. @@ -48322,22 +67701,22 @@ Removes the dashboard group with the name "MyDashboardGroup". - This function requires a valid API authentication to Logic Monitor. Make sure to log in using Connect-LMAccount before running this command. + -------------------------- EXAMPLE 1 -------------------------- - Remove-LMDashboardWidget -Id 123 -Removes the dashboard widget with ID 123. + Remove-LMUser -Id 123 +Removes the user with ID 123. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMDashboardWidget -Name "Widget Name" -Removes the dashboard widget with the specified name. + Remove-LMUser -Name "JohnDoe" +Removes the user with the name "JohnDoe". @@ -48347,23 +67726,23 @@ Removes the dashboard widget with the specified name. - Remove-LMDatasource + Remove-LMWebsite Remove - LMDatasource + LMWebsite - Removes a LogicMonitor datasource. + Removes a website from LogicMonitor. - The Remove-LMDatasource function removes a LogicMonitor datasource based on the specified parameters. It requires the user to be logged in and have valid API credentials. + The Remove-LMWebsite function removes a website from LogicMonitor using either its ID or name. - Remove-LMDatasource + Remove-LMWebsite Id - Specifies the ID of the datasource to be removed. This parameter is mandatory and can be provided as an integer. + Specifies the ID of the website to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -48408,60 +67787,11 @@ Removes the dashboard widget with the specified name. - Remove-LMDatasource + Remove-LMWebsite Name - Specifies the name of the datasource to be removed. This parameter is mandatory when using the 'Name' parameter set and can be provided as a string. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Remove-LMDatasource - - DisplayName - - Specifies the display name of the datasource to be removed. This parameter is mandatory when using the 'DisplayName' parameter set and can be provided as a string. + Specifies the name of the website to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -48510,7 +67840,7 @@ Removes the dashboard widget with the specified name. Id - Specifies the ID of the datasource to be removed. This parameter is mandatory and can be provided as an integer. + Specifies the ID of the website to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -48522,19 +67852,7 @@ Removes the dashboard widget with the specified name. Name - Specifies the name of the datasource to be removed. This parameter is mandatory when using the 'Name' parameter set and can be provided as a string. - - String - - String - - - None - - - DisplayName - - Specifies the display name of the datasource to be removed. This parameter is mandatory when using the 'DisplayName' parameter set and can be provided as a string. + Specifies the name of the website to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -48583,7 +67901,7 @@ Removes the dashboard widget with the specified name. - You can pipe input to this function. + You can pipe objects to this function. @@ -48593,7 +67911,7 @@ Removes the dashboard widget with the specified name. - Returns a PSCustomObject containing the ID of the removed datasource and a success message confirming the removal. + Returns a PSCustomObject containing the ID of the removed website and a success message confirming the removal. @@ -48608,24 +67926,16 @@ Removes the dashboard widget with the specified name. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMDatasource -Id 123 -Removes the datasource with the ID 123. + Remove-LMWebsite -Id 123 +Removes the website with ID 123. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMDatasource -Name "MyDatasource" -Removes the datasource with the name "MyDatasource". - - - - - - -------------------------- EXAMPLE 3 -------------------------- - Remove-LMDatasource -DisplayName "My Datasource" -Removes the datasource with the display name "My Datasource". + Remove-LMWebsite -Name "MyWebsite" +Removes the website with the name "MyWebsite". @@ -48635,23 +67945,23 @@ Removes the datasource with the display name "My Datasource". - Remove-LMDevice + Remove-LMWebsiteGroup Remove - LMDevice + LMWebsiteGroup - Removes a LogicMonitor device. + Removes a website group from LogicMonitor. - The Remove-LMDevice function removes a LogicMonitor device based on either its ID or name. It supports both hard delete and soft delete options. + The Remove-LMWebsiteGroup function removes a website group from LogicMonitor using either its ID or name. - Remove-LMDevice + Remove-LMWebsiteGroup Id - Specifies the ID of the device to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the website group to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -48661,9 +67971,9 @@ Removes the datasource with the display name "My Datasource". 0 - HardDelete + DeleteHostsandChildren - Indicates whether the device should be hard deleted. If set to $true, the device will be permanently deleted. If set to $false (default), the device will be moved to the Recycle Bin. + Specifies whether to delete the hosts and their children within the website group. Default value is $false. Boolean @@ -48708,11 +68018,11 @@ Removes the datasource with the display name "My Datasource". - Remove-LMDevice + Remove-LMWebsiteGroup Name - Specifies the name of the device to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the website group to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -48722,9 +68032,9 @@ Removes the datasource with the display name "My Datasource". None - HardDelete + DeleteHostsandChildren - Indicates whether the device should be hard deleted. If set to $true, the device will be permanently deleted. If set to $false (default), the device will be moved to the Recycle Bin. + Specifies whether to delete the hosts and their children within the website group. Default value is $false. Boolean @@ -48773,7 +68083,7 @@ Removes the datasource with the display name "My Datasource". Id - Specifies the ID of the device to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the website group to remove. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -48785,7 +68095,7 @@ Removes the datasource with the display name "My Datasource". Name - Specifies the name of the device to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the website group to remove. This parameter is mandatory when using the 'Name' parameter set. String @@ -48795,9 +68105,9 @@ Removes the datasource with the display name "My Datasource". None - HardDelete + DeleteHostsandChildren - Indicates whether the device should be hard deleted. If set to $true, the device will be permanently deleted. If set to $false (default), the device will be moved to the Recycle Bin. + Specifies whether to delete the hosts and their children within the website group. Default value is $false. Boolean @@ -48846,7 +68156,7 @@ Removes the datasource with the display name "My Datasource". - You can pipe input to this function. + You can pipe objects to this function. @@ -48856,7 +68166,7 @@ Removes the datasource with the display name "My Datasource". - Returns a PSCustomObject containing the ID of the removed device and a message indicating the success of the removal operation. + Returns a PSCustomObject containing the ID of the removed website group and a success message confirming the removal. @@ -48871,24 +68181,16 @@ Removes the datasource with the display name "My Datasource". -------------------------- EXAMPLE 1 -------------------------- - Remove-LMDevice -Id 12345 -Removes the LogicMonitor device with ID 12345. + Remove-LMWebsiteGroup -Id 123 +Removes the website group with ID 123. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMDevice -Name "MyDevice" -Removes the LogicMonitor device with the name "MyDevice". - - - - - - -------------------------- EXAMPLE 3 -------------------------- - Remove-LMDevice -Name "MyDevice" -HardDelete $true -Permanently deletes the LogicMonitor device with the name "MyDevice". + Remove-LMWebsiteGroup -Name "MyGroup" -DeleteHostsandChildren $true +Removes the website group named "MyGroup" and all its child items. @@ -48898,152 +68200,31 @@ Permanently deletes the LogicMonitor device with the name "MyDevice". - Remove-LMDeviceDatasourceInstance - Remove - LMDeviceDatasourceInstance + Restore-LMRecentlyDeleted + Restore + LMRecentlyDeleted - Removes a device datasource instance from Logic Monitor. + Restores one or more resources from the LogicMonitor recycle bin. - The Remove-LMDeviceDatasourceInstance function removes a device datasource instance from Logic Monitor. It requires valid API credentials and the user must be logged in before running this command. + The Restore-LMRecentlyDeleted function issues a batch restore request for the provided recycle identifiers, returning the selected resources to their original state when possible. - Remove-LMDeviceDatasourceInstance - - DatasourceName + Restore-LMRecentlyDeleted + + RecycleId - Specifies the name of the datasource. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + One or more recycle identifiers representing deleted resources. Accepts pipeline input and property names of Id. - String - - String - - - None - - - DeviceName - - {{ Fill DeviceName Description }} - - String - - String - - - None - - - WildValue - - Specifies the wildcard value associated with the datasource instance. - - String - - String - - - None - - - InstanceId - - {{ Fill InstanceId Description }} - - Int32 - - Int32 - - - 0 - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Remove-LMDeviceDatasourceInstance - - DatasourceName - - Specifies the name of the datasource. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. - - String - - String - - - None - - - DeviceId - - {{ Fill DeviceId Description }} - - Int32 - - Int32 - - - 0 - - - WildValue - - Specifies the wildcard value associated with the datasource instance. - - String + String[] - String + String[] None - - InstanceId - - {{ Fill InstanceId Description }} - - Int32 - - Int32 - - - 0 - WhatIf @@ -49079,36 +68260,94 @@ Permanently deletes the LogicMonitor device with the name "MyDevice". None + + + + RecycleId + + One or more recycle identifiers representing deleted resources. Accepts pipeline input and property names of Id. + + String[] + + String[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + You must establish a session with Connect-LMAccount prior to calling this function. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Get-LMRecentlyDeleted -ResourceType device -DeletedBy "lmsupport" | Select-Object -First 5 -ExpandProperty id | Restore-LMRecentlyDeleted + + Restores the five most recently deleted devices by lmsupport. + + + + + + + + Send-LMLogMessage + Send + LMLogMessage + + Sends log messages to LogicMonitor. + + + + The Send-LMLogMessage function sends log messages to LogicMonitor for logging and monitoring purposes. It supports sending a single message or an array of messages. + + - Remove-LMDeviceDatasourceInstance - - DatasourceId - - Specifies the ID of the datasource. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - 0 - - - DeviceName - - {{ Fill DeviceName Description }} - - String - - String - - - None - - - WildValue + Send-LMLogMessage + + Message - Specifies the wildcard value associated with the datasource instance. + Specifies the log message to send. This parameter is mandatory when using the 'SingleMessage' parameter set. String @@ -49117,39 +68356,41 @@ Permanently deletes the LogicMonitor device with the name "MyDevice". None - - InstanceId + + Timestamp - {{ Fill InstanceId Description }} + Specifies the timestamp for the log message. If not provided, the current UTC timestamp will be used. This parameter is mandatory when using the 'SingleMessage' parameter set. - Int32 + String - Int32 + String - 0 + None - - WhatIf + + resourceMapping - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the resource mapping for the log message. This parameter is mandatory when using the 'SingleMessage' parameter set. + Hashtable - SwitchParameter + Hashtable - False + None - - Confirm + + Metadata - Prompts you for confirmation before running the cmdlet. + Specifies additional metadata to include with the log message. This parameter is optional when using the 'SingleMessage' parameter set. + Hashtable - SwitchParameter + Hashtable - False + None ProgressAction @@ -49165,77 +68406,19 @@ Permanently deletes the LogicMonitor device with the name "MyDevice". - Remove-LMDeviceDatasourceInstance - - DatasourceId - - Specifies the ID of the datasource. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - 0 - + Send-LMLogMessage - DeviceId - - {{ Fill DeviceId Description }} - - Int32 - - Int32 - - - 0 - - - WildValue + MessageArray - Specifies the wildcard value associated with the datasource instance. + Specifies an array of log messages to send. This parameter is mandatory when using the 'MessageList' parameter set. - String + Object - String + Object None - - InstanceId - - {{ Fill InstanceId Description }} - - Int32 - - Int32 - - - 0 - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - ProgressAction @@ -49252,9 +68435,9 @@ Permanently deletes the LogicMonitor device with the name "MyDevice". - DatasourceName + Message - Specifies the name of the datasource. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + Specifies the log message to send. This parameter is mandatory when using the 'SingleMessage' parameter set. String @@ -49263,34 +68446,10 @@ Permanently deletes the LogicMonitor device with the name "MyDevice". None - - DatasourceId - - Specifies the ID of the datasource. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - 0 - - - DeviceId - - {{ Fill DeviceId Description }} - - Int32 - - Int32 - - - 0 - - - DeviceName + + Timestamp - {{ Fill DeviceName Description }} + Specifies the timestamp for the log message. If not provided, the current UTC timestamp will be used. This parameter is mandatory when using the 'SingleMessage' parameter set. String @@ -49299,53 +68458,41 @@ Permanently deletes the LogicMonitor device with the name "MyDevice". None - - WildValue + + resourceMapping - Specifies the wildcard value associated with the datasource instance. + Specifies the resource mapping for the log message. This parameter is mandatory when using the 'SingleMessage' parameter set. - String + Hashtable - String + Hashtable None - - InstanceId - - {{ Fill InstanceId Description }} - - Int32 - - Int32 - - - 0 - - - WhatIf + + Metadata - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies additional metadata to include with the log message. This parameter is optional when using the 'SingleMessage' parameter set. - SwitchParameter + Hashtable - SwitchParameter + Hashtable - False + None - - Confirm + + MessageArray - Prompts you for confirmation before running the cmdlet. + Specifies an array of log messages to send. This parameter is mandatory when using the 'MessageList' parameter set. - SwitchParameter + Object - SwitchParameter + Object - False + None ProgressAction @@ -49360,20 +68507,11 @@ Permanently deletes the LogicMonitor device with the name "MyDevice". None - - - - None. - - - - - - + - Returns a PSCustomObject containing the instance ID and a message confirming the successful removal of the datasource instance. + Outputs a success message if the log message was accepted successfully, or an error message if the operation failed. @@ -49388,16 +68526,16 @@ Permanently deletes the LogicMonitor device with the name "MyDevice". -------------------------- EXAMPLE 1 -------------------------- - Remove-LMDeviceDatasourceInstance -Name "MyDevice" -DatasourceName "MyDatasource" -WildValue "12345" -Removes the device datasource instance with the specified device name, datasource name, and wildcard value. + Send-LMLogMessage -Message "This is a test log message" -resourceMapping @{ 'system.deviceId' = '12345' } -Metadata @{ 'key1' = 'value1' } +Sends a single log message with the specified message, resource mapping, and metadata. -------------------------- EXAMPLE 2 -------------------------- - Remove-LMDeviceDatasourceInstance -Id 123 -DatasourceId 456 -WildValue "67890" -Removes the device datasource instance with the specified device ID, datasource ID, and wildcard value. + Send-LMLogMessage -MessageArray $MessageObjectsArray +Sends an array of log message objects. @@ -49407,23 +68545,23 @@ Removes the device datasource instance with the specified device ID, datasource - Remove-LMDeviceDatasourceInstanceGroup - Remove - LMDeviceDatasourceInstanceGroup + Send-LMPushMetric + Send + LMPushMetric - Removes a LogicMonitor device datasource instance group. + Sends a push metric to LogicMonitor. - The Remove-LMDeviceDatasourceInstanceGroup function removes a LogicMonitor device datasource instance group based on the provided parameters. It requires valid API credentials and a logged-in session. + The Send-LMPushMetric function sends a push metric to LogicMonitor. It allows you to create a new resource or update an existing resource with the specified metric data. - Remove-LMDeviceDatasourceInstanceGroup - - DatasourceName + Send-LMPushMetric + + NewResourceHostName - Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + Specifies the hostname of the new resource to be created. This parameter is required if you want to create a new resource. String @@ -49432,22 +68570,46 @@ Removes the device datasource instance with the specified device ID, datasource None - - Id + + NewResourceDescription - Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + Specifies the description of the new resource to be created. This parameter is required if you want to create a new resource. - Int32 + String - Int32 + String - 0 + None - InstanceGroupName + ResourceIds - Specifies the name of the instance group to be removed. This parameter is mandatory. + Specifies the resource IDs to use for resource mapping. This parameter is mandatory. + + Hashtable + + Hashtable + + + None + + + ResourceProperties + + Specifies the properties of the resources to be updated. This parameter is optional. + + Hashtable + + Hashtable + + + None + + + DatasourceId + + Specifies the ID of the datasource. This parameter is required if the datasource name is not specified. String @@ -49456,27 +68618,41 @@ Removes the device datasource instance with the specified device ID, datasource None - - WhatIf + + DatasourceDisplayName - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the display name of the datasource. This parameter is optional and defaults to the datasource name if not specified. + String - SwitchParameter + String - False + None - - Confirm + + DatasourceGroup - Prompts you for confirmation before running the cmdlet. + Specifies the group of the datasource. This parameter is optional and defaults to "PushModules" if not specified. + String - SwitchParameter + String - False + None + + + Instances + + Specifies the instances of the resources to be updated. This parameter is mandatory and should contain results from the New-LMPushMetricInstance function. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None ProgressAction @@ -49492,11 +68668,11 @@ Removes the device datasource instance with the specified device ID, datasource - Remove-LMDeviceDatasourceInstanceGroup - - DatasourceName + Send-LMPushMetric + + NewResourceHostName - Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + Specifies the hostname of the new resource to be created. This parameter is required if you want to create a new resource. String @@ -49505,10 +68681,10 @@ Removes the device datasource instance with the specified device ID, datasource None - - Name + + NewResourceDescription - Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. + Specifies the description of the new resource to be created. This parameter is required if you want to create a new resource. String @@ -49518,9 +68694,33 @@ Removes the device datasource instance with the specified device ID, datasource None - InstanceGroupId + ResourceIds - Specifies the ID of the instance group to be removed. This parameter is mandatory. + Specifies the resource IDs to use for resource mapping. This parameter is mandatory. + + Hashtable + + Hashtable + + + None + + + ResourceProperties + + Specifies the properties of the resources to be updated. This parameter is optional. + + Hashtable + + Hashtable + + + None + + + DatasourceName + + Specifies the name of the datasource. This parameter is required if the datasource ID is not specified. String @@ -49529,27 +68729,41 @@ Removes the device datasource instance with the specified device ID, datasource None - - WhatIf + + DatasourceDisplayName - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the display name of the datasource. This parameter is optional and defaults to the datasource name if not specified. + String - SwitchParameter + String - False + None - - Confirm + + DatasourceGroup - Prompts you for confirmation before running the cmdlet. + Specifies the group of the datasource. This parameter is optional and defaults to "PushModules" if not specified. + String - SwitchParameter + String - False + None + + + Instances + + Specifies the instances of the resources to be updated. This parameter is mandatory and should contain results from the New-LMPushMetricInstance function. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None ProgressAction @@ -49564,12 +68778,167 @@ Removes the device datasource instance with the specified device ID, datasource None + + + + NewResourceHostName + + Specifies the hostname of the new resource to be created. This parameter is required if you want to create a new resource. + + String + + String + + + None + + + NewResourceDescription + + Specifies the description of the new resource to be created. This parameter is required if you want to create a new resource. + + String + + String + + + None + + + ResourceIds + + Specifies the resource IDs to use for resource mapping. This parameter is mandatory. + + Hashtable + + Hashtable + + + None + + + ResourceProperties + + Specifies the properties of the resources to be updated. This parameter is optional. + + Hashtable + + Hashtable + + + None + + + DatasourceId + + Specifies the ID of the datasource. This parameter is required if the datasource name is not specified. + + String + + String + + + None + + + DatasourceName + + Specifies the name of the datasource. This parameter is required if the datasource ID is not specified. + + String + + String + + + None + + + DatasourceDisplayName + + Specifies the display name of the datasource. This parameter is optional and defaults to the datasource name if not specified. + + String + + String + + + None + + + DatasourceGroup + + Specifies the group of the datasource. This parameter is optional and defaults to "PushModules" if not specified. + + String + + String + + + None + + + Instances + + Specifies the instances of the resources to be updated. This parameter is mandatory and should contain results from the New-LMPushMetricInstance function. + + System.Collections.Generic.List`1[System.Object] + + System.Collections.Generic.List`1[System.Object] + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + This function requires a valid API authentication. Make sure you are logged in before running any commands using Connect-LMAccount. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Send-LMPushMetric -NewResourceHostName "NewResource" -NewResourceDescription "New Resource Description" -ResourceIds @{"system.deviceId"="12345"} -ResourceProperties @{"Property1"="Value1"} -DatasourceId "123" -Instances $Instances +Creates a new resource and sends metric data for the specified instances. + + + + + + + + + + Send-LMWebhookMessage + Send + LMWebhookMessage + + Sends webhook events to LogicMonitor. + + + + The Send-LMWebhookMessage function submits webhook messages to LogicMonitor for ingestion via the Webhook LogSource endpoint. Provide an array of events to transmit; each entry is converted into a JSON payload. Optional common properties can be merged into every event to support downstream parsing in LogicMonitor. + + - Remove-LMDeviceDatasourceInstanceGroup - - DatasourceName + Send-LMWebhookMessage + + SourceName - Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + Specifies the LogicMonitor LogSource identifier used in the ingest URL. This typically matches the sourceName configured in LogicMonitor. String @@ -49578,45 +68947,34 @@ Removes the device datasource instance with the specified device ID, datasource None - - Name + + Messages - Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. + {{ Fill Messages Description }} - String + Object[] - String + Object[] None - - InstanceGroupName + + Properties - Specifies the name of the instance group to be removed. This parameter is mandatory. + Specifies additional key/value pairs that are merged into every event payload before sending. - String + Hashtable - String + Hashtable None - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm + + PassThru - Prompts you for confirmation before running the cmdlet. + {{ Fill PassThru Description }} SwitchParameter @@ -49637,24 +68995,116 @@ Removes the device datasource instance with the specified device ID, datasource None + + + + SourceName + + Specifies the LogicMonitor LogSource identifier used in the ingest URL. This typically matches the sourceName configured in LogicMonitor. + + String + + String + + + None + + + Messages + + {{ Fill Messages Description }} + + Object[] + + Object[] + + + None + + + Properties + + Specifies additional key/value pairs that are merged into every event payload before sending. + + Hashtable + + Hashtable + + + None + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + Outputs a confirmation message for each accepted webhook event, or an error message if the request fails. When -PassThru is specified, returns PSCustomObject entries containing status, payload, and optional error details for each attempted message. + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Send-LMWebhookMessage -SourceName "Meraki_CustomerA" -Events $Messages -Properties @{ accountId = '12345' } +Sends each event in `$Messages` to the Meraki webhook LogSource, appending the `accountId` property to every payload. + + + + + + + + + + Set-LMAccessGroup + Set + LMAccessGroup + + Sets the properties of a LogicMonitor access group. + + + + The Set-LMAccessGroup function is used to set the properties of a LogicMonitor access group. It allows you to specify the access group either by its ID or by its name. You can set the new name, description, and tenant ID for the access group. + + - Remove-LMDeviceDatasourceInstanceGroup - - DatasourceName - - Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. - - String - - String - - - None - - + Set-LMAccessGroup + Id - Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + Specifies the ID of the access group. This parameter is used when you want to set the properties of the access group by its ID. Int32 @@ -49663,10 +69113,10 @@ Removes the device datasource instance with the specified device ID, datasource 0 - - InstanceGroupId + + NewName - Specifies the ID of the instance group to be removed. This parameter is mandatory. + Specifies the new name for the access group. String @@ -49675,59 +69125,10 @@ Removes the device datasource instance with the specified device ID, datasource None - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Remove-LMDeviceDatasourceInstanceGroup - - DatasourceId - - Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - 0 - - - Name + + Description - Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. + Specifies the new description for the access group. String @@ -49736,10 +69137,10 @@ Removes the device datasource instance with the specified device ID, datasource None - - InstanceGroupId + + Tenant - Specifies the ID of the instance group to be removed. This parameter is mandatory. + Specifies the tenant ID for the access group. String @@ -49784,23 +69185,23 @@ Removes the device datasource instance with the specified device ID, datasource - Remove-LMDeviceDatasourceInstanceGroup - - DatasourceId + Set-LMAccessGroup + + Name - Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + Specifies the name of the access group. This parameter is used when you want to set the properties of the access group by its name. - Int32 + String - Int32 + String - 0 + None - - Name + + NewName - Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. + Specifies the new name for the access group. String @@ -49809,10 +69210,22 @@ Removes the device datasource instance with the specified device ID, datasource None - - InstanceGroupName + + Description - Specifies the name of the instance group to be removed. This parameter is mandatory. + Specifies the new description for the access group. + + String + + String + + + None + + + Tenant + + Specifies the tenant ID for the access group. String @@ -49856,12 +69269,151 @@ Removes the device datasource instance with the specified device ID, datasource None + + + + Id + + Specifies the ID of the access group. This parameter is used when you want to set the properties of the access group by its ID. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the access group. This parameter is used when you want to set the properties of the access group by its name. + + String + + String + + + None + + + NewName + + Specifies the new name for the access group. + + String + + String + + + None + + + Description + + Specifies the new description for the access group. + + String + + String + + + None + + + Tenant + + Specifies the tenant ID for the access group. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + This function requires you to be logged in and have valid API credentials. Use the Connect-LMAccount function to log in before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Set-LMAccessGroup -Id 123 -NewName "New Access Group" -Description "This is a new access group" -Tenant "abc123" +Sets the properties of the access group with ID 123. The new name is set to "New Access Group", the description is set to "This is a new access group", and the tenant ID is set to "abc123". + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Set-LMAccessGroup -Name "Old Access Group" -NewName "New Access Group" -Description "This is a new access group" -Tenant "abc123" +Sets the properties of the access group with name "Old Access Group". The new name is set to "New Access Group", the description is set to "This is a new access group", and the tenant ID is set to "abc123". + + + + + + + + + + Set-LMAlertRule + Set + LMAlertRule + + Updates a LogicMonitor alert rule configuration. + + + + The Set-LMAlertRule function modifies an existing alert rule in LogicMonitor. + + - Remove-LMDeviceDatasourceInstanceGroup + Set-LMAlertRule - DatasourceId + Id - Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + Specifies the ID of the alert rule to modify. Int32 @@ -49870,95 +69422,94 @@ Removes the device datasource instance with the specified device ID, datasource 0 - - Id + + NewName - Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + {{ Fill NewName Description }} - Int32 + String - Int32 + String - 0 + None - - InstanceGroupId + + Priority - Specifies the ID of the instance group to be removed. This parameter is mandatory. + Specifies the priority level for the alert rule. Valid values: "High", "Medium", "Low". - String + Int32 - String + Int32 - None + 0 - - WhatIf + + EscalatingChainId - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the ID of the escalation chain to use. + Int32 - SwitchParameter + Int32 - False + 0 - - Confirm + + EscalationInterval - Prompts you for confirmation before running the cmdlet. + Specifies the escalation interval in minutes. + Int32 - SwitchParameter + Int32 - False + 0 - - ProgressAction + + ResourceProperties - {{ Fill ProgressAction Description }} + Specifies resource properties to filter on. - ActionPreference + Hashtable - ActionPreference + Hashtable None - - - Remove-LMDeviceDatasourceInstanceGroup - - DatasourceId + + Devices - Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + Specifies an array of device display names to apply the rule to. - Int32 + String[] - Int32 + String[] - 0 + None - - Id + + DeviceGroups - Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + Specifies an array of device group full paths to apply the rule to. - Int32 + String[] - Int32 + String[] - 0 + None - - InstanceGroupName + + DataSource - Specifies the name of the instance group to be removed. This parameter is mandatory. + Specifies the datasource name to apply the rule to. String @@ -49967,59 +69518,58 @@ Removes the device datasource instance with the specified device ID, datasource None - - WhatIf + + DataSourceInstanceName - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the instance name to apply the rule to. + String - SwitchParameter + String - False + None - - Confirm + + DataPoint - Prompts you for confirmation before running the cmdlet. + Specifies the datapoint name to apply the rule to. + String - SwitchParameter + String - False + None - - ProgressAction + + SuppressAlertClear - {{ Fill ProgressAction Description }} + Indicates whether to suppress alert clear notifications. - ActionPreference + Boolean - ActionPreference + Boolean - None + False - - - Remove-LMDeviceDatasourceInstanceGroup - - Id + + SuppressAlertAckSdt - Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + Indicates whether to suppress alert acknowledgement and SDT notifications. - Int32 + Boolean - Int32 + Boolean - 0 + False - - HdsId + + LevelStr - Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the 'Id-HdsId' or 'Name-HdsId' parameter sets. + Specifies the level string for the alert rule. Valid values: "All", "Critical", "Error", "Warning". String @@ -50028,10 +69578,10 @@ Removes the device datasource instance with the specified device ID, datasource None - - InstanceGroupId + + Description - Specifies the ID of the instance group to be removed. This parameter is mandatory. + Specifies the description for the alert rule. String @@ -50076,11 +69626,11 @@ Removes the device datasource instance with the specified device ID, datasource - Remove-LMDeviceDatasourceInstanceGroup - + Set-LMAlertRule + Id - Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + Specifies the ID of the alert rule to modify. Int32 @@ -50090,9 +69640,9 @@ Removes the device datasource instance with the specified device ID, datasource 0 - HdsId + Name - Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the 'Id-HdsId' or 'Name-HdsId' parameter sets. + Specifies the name for the alert rule. String @@ -50101,10 +69651,10 @@ Removes the device datasource instance with the specified device ID, datasource None - - InstanceGroupName + + NewName - Specifies the name of the instance group to be removed. This parameter is mandatory. + {{ Fill NewName Description }} String @@ -50113,71 +69663,82 @@ Removes the device datasource instance with the specified device ID, datasource None - - WhatIf + + Priority - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the priority level for the alert rule. Valid values: "High", "Medium", "Low". + Int32 - SwitchParameter + Int32 - False + 0 - - Confirm + + EscalatingChainId - Prompts you for confirmation before running the cmdlet. + Specifies the ID of the escalation chain to use. + Int32 - SwitchParameter + Int32 - False + 0 - - ProgressAction + + EscalationInterval - {{ Fill ProgressAction Description }} + Specifies the escalation interval in minutes. - ActionPreference + Int32 - ActionPreference + Int32 + + + 0 + + + ResourceProperties + + Specifies resource properties to filter on. + + Hashtable + + Hashtable None - - - Remove-LMDeviceDatasourceInstanceGroup - - Name + + Devices - Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. + Specifies an array of device display names to apply the rule to. - String + String[] - String + String[] None - - HdsId + + DeviceGroups - Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the 'Id-HdsId' or 'Name-HdsId' parameter sets. + Specifies an array of device group full paths to apply the rule to. - String + String[] - String + String[] None - - InstanceGroupId + + DataSource - Specifies the ID of the instance group to be removed. This parameter is mandatory. + Specifies the datasource name to apply the rule to. String @@ -50186,59 +69747,58 @@ Removes the device datasource instance with the specified device ID, datasource None - - WhatIf + + DataSourceInstanceName - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the instance name to apply the rule to. + String - SwitchParameter + String - False + None - - Confirm + + DataPoint - Prompts you for confirmation before running the cmdlet. + Specifies the datapoint name to apply the rule to. + String - SwitchParameter + String - False + None - - ProgressAction + + SuppressAlertClear - {{ Fill ProgressAction Description }} + Indicates whether to suppress alert clear notifications. - ActionPreference + Boolean - ActionPreference + Boolean - None + False - - - Remove-LMDeviceDatasourceInstanceGroup - - Name + + SuppressAlertAckSdt - Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. + Indicates whether to suppress alert acknowledgement and SDT notifications. - String + Boolean - String + Boolean - None + False - - HdsId + + LevelStr - Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the 'Id-HdsId' or 'Name-HdsId' parameter sets. + Specifies the level string for the alert rule. Valid values: "All", "Critical", "Error", "Warning". String @@ -50247,10 +69807,10 @@ Removes the device datasource instance with the specified device ID, datasource None - - InstanceGroupName + + Description - Specifies the name of the instance group to be removed. This parameter is mandatory. + Specifies the description for the alert rule. String @@ -50297,9 +69857,21 @@ Removes the device datasource instance with the specified device ID, datasource - DatasourceName + Id - Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets. + Specifies the ID of the alert rule to modify. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name for the alert rule. String @@ -50308,10 +69880,22 @@ Removes the device datasource instance with the specified device ID, datasource None - - DatasourceId + + NewName - Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets. + {{ Fill NewName Description }} + + String + + String + + + None + + + Priority + + Specifies the priority level for the alert rule. Valid values: "High", "Medium", "Low". Int32 @@ -50320,10 +69904,10 @@ Removes the device datasource instance with the specified device ID, datasource 0 - - Id + + EscalatingChainId - Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets. This parameter can also be specified using the 'DeviceId' alias. + Specifies the ID of the escalation chain to use. Int32 @@ -50332,10 +69916,58 @@ Removes the device datasource instance with the specified device ID, datasource 0 - - Name + + EscalationInterval - Specifies the name of the device associated with the instance group. This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets. This parameter can also be specified using the 'DeviceName' alias. + Specifies the escalation interval in minutes. + + Int32 + + Int32 + + + 0 + + + ResourceProperties + + Specifies resource properties to filter on. + + Hashtable + + Hashtable + + + None + + + Devices + + Specifies an array of device display names to apply the rule to. + + String[] + + String[] + + + None + + + DeviceGroups + + Specifies an array of device group full paths to apply the rule to. + + String[] + + String[] + + + None + + + DataSource + + Specifies the datasource name to apply the rule to. String @@ -50344,10 +69976,10 @@ Removes the device datasource instance with the specified device ID, datasource None - - HdsId + + DataSourceInstanceName - Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the 'Id-HdsId' or 'Name-HdsId' parameter sets. + Specifies the instance name to apply the rule to. String @@ -50356,10 +69988,10 @@ Removes the device datasource instance with the specified device ID, datasource None - - InstanceGroupName + + DataPoint - Specifies the name of the instance group to be removed. This parameter is mandatory. + Specifies the datapoint name to apply the rule to. String @@ -50368,10 +70000,46 @@ Removes the device datasource instance with the specified device ID, datasource None - - InstanceGroupId + + SuppressAlertClear - Specifies the ID of the instance group to be removed. This parameter is mandatory. + Indicates whether to suppress alert clear notifications. + + Boolean + + Boolean + + + False + + + SuppressAlertAckSdt + + Indicates whether to suppress alert acknowledgement and SDT notifications. + + Boolean + + Boolean + + + False + + + LevelStr + + Specifies the level string for the alert rule. Valid values: "All", "Critical", "Error", "Warning". + + String + + String + + + None + + + Description + + Specifies the description for the alert rule. String @@ -50420,7 +70088,7 @@ Removes the device datasource instance with the specified device ID, datasource - None. + You can pipe alert rule objects containing Id properties to this function. @@ -50430,7 +70098,7 @@ Removes the device datasource instance with the specified device ID, datasource - Returns a PSCustomObject containing the instance ID and a message confirming the successful removal of the instance group. + Returns the response from the API containing the updated alert rule information. @@ -50439,22 +70107,14 @@ Removes the device datasource instance with the specified device ID, datasource - + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMDeviceDatasourceInstanceGroup -DatasourceName "CPU" -Name "Server01" -InstanceGroupName "Group1" -Removes the instance group named "Group1" associated with the "CPU" datasource on the device named "Server01". - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMDeviceDatasourceInstanceGroup -DatasourceId 123 -Id 456 -InstanceGroupName "Group2" -Removes the instance group named "Group2" associated with the datasource ID 123 on the device ID 456. + Set-LMAlertRule -Id 123 -Name "Updated Rule" -Priority 100 -EscalatingChainId 456 +Updates the alert rule with new name, priority and escalation chain. @@ -50464,23 +70124,35 @@ Removes the instance group named "Group2" associated with the datasource ID 123 - Remove-LMDeviceGroup - Remove - LMDeviceGroup + Set-LMAPIToken + Set + LMAPIToken - Removes a LogicMonitor device group. + Updates a LogicMonitor API token's properties. - The Remove-LMDeviceGroup function is used to remove a LogicMonitor device group. It supports removing the group by either its ID or name. The function requires valid API credentials to be logged in. + The Set-LMAPIToken function modifies the properties of an existing API token in LogicMonitor, including its note and status. - Remove-LMDeviceGroup + Set-LMAPIToken + + AdminId + + Specifies the ID of the admin user who owns the token. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + Id - Specifies the ID of the device group to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the API token to modify. Int32 @@ -50490,28 +70162,28 @@ Removes the instance group named "Group2" associated with the datasource ID 123 0 - DeleteHostsandChildren + Note - Specifies whether to delete the hosts and their children within the device group. By default, this parameter is set to $false. + Specifies a new note for the API token. - Boolean + String - Boolean + String - False + None - HardDelete + Status - Specifies whether to perform a hard delete, which permanently removes the device group and its associated data. By default, this parameter is set to $false. + Specifies the new status for the API token. Valid values are "active" or "suspended". - Boolean + String - Boolean + String - False + None WhatIf @@ -50549,11 +70221,11 @@ Removes the instance group named "Group2" associated with the datasource ID 123 - Remove-LMDeviceGroup + Set-LMAPIToken - Name + AdminName - Specifies the name of the device group to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the admin user who owns the token. This parameter is mandatory when using the 'Name' parameter set. String @@ -50562,29 +70234,41 @@ Removes the instance group named "Group2" associated with the datasource ID 123 None + + Id + + Specifies the ID of the API token to modify. + + Int32 + + Int32 + + + 0 + - DeleteHostsandChildren + Note - Specifies whether to delete the hosts and their children within the device group. By default, this parameter is set to $false. + Specifies a new note for the API token. - Boolean + String - Boolean + String - False + None - HardDelete + Status - Specifies whether to perform a hard delete, which permanently removes the device group and its associated data. By default, this parameter is set to $false. + Specifies the new status for the API token. Valid values are "active" or "suspended". - Boolean + String - Boolean + String - False + None WhatIf @@ -50624,9 +70308,9 @@ Removes the instance group named "Group2" associated with the datasource ID 123 - Id + AdminId - Specifies the ID of the device group to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the admin user who owns the token. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -50636,9 +70320,9 @@ Removes the instance group named "Group2" associated with the datasource ID 123 0 - Name + AdminName - Specifies the name of the device group to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the admin user who owns the token. This parameter is mandatory when using the 'Name' parameter set. String @@ -50647,29 +70331,41 @@ Removes the instance group named "Group2" associated with the datasource ID 123 None + + Id + + Specifies the ID of the API token to modify. + + Int32 + + Int32 + + + 0 + - DeleteHostsandChildren + Note - Specifies whether to delete the hosts and their children within the device group. By default, this parameter is set to $false. + Specifies a new note for the API token. - Boolean + String - Boolean + String - False + None - HardDelete + Status - Specifies whether to perform a hard delete, which permanently removes the device group and its associated data. By default, this parameter is set to $false. + Specifies the new status for the API token. Valid values are "active" or "suspended". - Boolean + String - Boolean + String - False + None WhatIf @@ -50711,7 +70407,7 @@ Removes the instance group named "Group2" associated with the datasource ID 123 - None. + You can pipe objects containing AdminId and Id properties to this function. @@ -50721,7 +70417,7 @@ Removes the instance group named "Group2" associated with the datasource ID 123 - Returns a PSCustomObject containing the ID of the removed device group and a message confirming the successful removal. + Returns a LogicMonitor.APIToken object containing the updated token information. @@ -50730,22 +70426,14 @@ Removes the instance group named "Group2" associated with the datasource ID 123 - This function requires valid API credentials to be logged in. Use the Connect-LMAccount function to log in before running any commands. + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMDeviceGroup -Id 12345 -Removes the device group with the specified ID. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMDeviceGroup -Name "MyDeviceGroup" -Removes the device group with the specified name. + Set-LMAPIToken -AdminId 123 -Id 456 -Note "Updated token" -Status "suspended" +Updates the API token with ID 456 owned by admin 123 with a new note and status. @@ -50755,35 +70443,59 @@ Removes the device group with the specified name. - Remove-LMDeviceGroupProperty - Remove - LMDeviceGroupProperty + Set-LMAppliesToFunction + Set + LMAppliesToFunction - Removes a property from a LogicMonitor device group. + Updates a LogicMonitor AppliesTo function. - The Remove-LMDeviceGroupProperty function removes a specified property from a LogicMonitor device group. It can remove the property either by providing the device group ID or the device group name. + The Set-LMAppliesToFunction function modifies an existing AppliesTo function in LogicMonitor, allowing updates to its name, description, and AppliesTo code. - Remove-LMDeviceGroupProperty + Set-LMAppliesToFunction - Id + Name - The ID of the device group from which the property should be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the current name of the AppliesTo function. This parameter is mandatory when using the 'Name' parameter set. - Int32 + String - Int32 + String - 0 + None - - PropertyName + + NewName - The name of the property to be removed. This parameter is mandatory. + Specifies the new name for the AppliesTo function. + + String + + String + + + None + + + Description + + Specifies a new description for the AppliesTo function. + + String + + String + + + None + + + AppliesTo + + Specifies the new AppliesTo code for the function. String @@ -50828,11 +70540,11 @@ Removes the device group with the specified name. - Remove-LMDeviceGroupProperty - - Name + Set-LMAppliesToFunction + + NewName - The name of the device group from which the property should be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the new name for the AppliesTo function. String @@ -50841,10 +70553,34 @@ Removes the device group with the specified name. None - - PropertyName + + Id - The name of the property to be removed. This parameter is mandatory. + Specifies the ID of the AppliesTo function to modify. + + String + + String + + + None + + + Description + + Specifies a new description for the AppliesTo function. + + String + + String + + + None + + + AppliesTo + + Specifies the new AppliesTo code for the function. String @@ -50891,21 +70627,45 @@ Removes the device group with the specified name. + Name + + Specifies the current name of the AppliesTo function. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + NewName + + Specifies the new name for the AppliesTo function. + + String + + String + + + None + + Id - The ID of the device group from which the property should be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the AppliesTo function to modify. - Int32 + String - Int32 + String - 0 + None - - Name + + Description - The name of the device group from which the property should be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies a new description for the AppliesTo function. String @@ -50914,10 +70674,10 @@ Removes the device group with the specified name. None - - PropertyName + + AppliesTo - The name of the property to be removed. This parameter is mandatory. + Specifies the new AppliesTo code for the function. String @@ -50966,7 +70726,7 @@ Removes the device group with the specified name. - None. + You can pipe objects containing Id properties to this function. @@ -50976,7 +70736,7 @@ Removes the device group with the specified name. - Returns a PSCustomObject containing the ID of the device group and a message confirming the successful removal of the property. + Returns a LogicMonitor.AppliesToFunction object containing the updated function information. @@ -50985,22 +70745,14 @@ Removes the device group with the specified name. - This function requires a valid LogicMonitor API authentication. Make sure you are logged in before running any commands. + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMDeviceGroupProperty -Id 1234 -PropertyName "Property1" -Removes the property named "Property1" from the device with ID 1234. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMDeviceGroupProperty -Name "Device1" -PropertyName "Property2" -Removes the property named "Property2" from the device with the name "Device1". + Set-LMAppliesToFunction -Id 123 -NewName "UpdatedFunction" -Description "New description" +Updates the AppliesTo function with ID 123 with a new name and description. @@ -51010,23 +70762,23 @@ Removes the property named "Property2" from the device with the name "Device1".< - Remove-LMDeviceProperty - Remove - LMDeviceProperty + Set-LMCollector + Set + LMCollector - Removes a property from a LogicMonitor device. + Updates a LogicMonitor collector's configuration. - The Remove-LMDeviceProperty function removes a specified property from a LogicMonitor device. It can remove the property either by providing the device ID or the device name. + The Set-LMCollector function modifies an existing collector's settings in LogicMonitor, including its description, backup agent, group, and various properties. - Remove-LMDeviceProperty - + Set-LMCollector + Id - The ID of the device from which the property should be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the collector to modify. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -51035,10 +70787,10 @@ Removes the property named "Property2" from the device with the name "Device1".< 0 - - PropertyName + + Description - The name of the property to be removed. This parameter is mandatory. + Specifies a new description for the collector. String @@ -51047,6 +70799,114 @@ Removes the property named "Property2" from the device with the name "Device1".< None + + BackupAgentId + + Specifies the ID of the backup collector. + + Int32 + + Int32 + + + None + + + CollectorGroupId + + Specifies the ID of the collector group to which this collector should belong. + + Int32 + + Int32 + + + None + + + Properties + + Specifies a hashtable of custom properties to set for the collector. + + Hashtable + + Hashtable + + + None + + + EnableFailBack + + Specifies whether to enable fail-back functionality. + + Boolean + + Boolean + + + None + + + EnableFailOverOnCollectorDevice + + Specifies whether to enable fail-over on the collector device. + + Boolean + + Boolean + + + None + + + EscalatingChainId + + Specifies the ID of the escalation chain. + + Int32 + + Int32 + + + None + + + SuppressAlertClear + + Specifies whether to suppress alert clear notifications. + + Boolean + + Boolean + + + None + + + ResendAlertInterval + + Specifies the interval for resending alerts. + + Int32 + + Int32 + + + None + + + SpecifiedCollectorDeviceGroupId + + Specifies the ID of the device group for the collector. + + Int32 + + Int32 + + + None + WhatIf @@ -51083,11 +70943,11 @@ Removes the property named "Property2" from the device with the name "Device1".< - Remove-LMDeviceProperty + Set-LMCollector Name - The name of the device from which the property should be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the collector to modify. This parameter is mandatory when using the 'Name' parameter set. String @@ -51096,10 +70956,10 @@ Removes the property named "Property2" from the device with the name "Device1".< None - - PropertyName + + Description - The name of the property to be removed. This parameter is mandatory. + Specifies a new description for the collector. String @@ -51108,6 +70968,114 @@ Removes the property named "Property2" from the device with the name "Device1".< None + + BackupAgentId + + Specifies the ID of the backup collector. + + Int32 + + Int32 + + + None + + + CollectorGroupId + + Specifies the ID of the collector group to which this collector should belong. + + Int32 + + Int32 + + + None + + + Properties + + Specifies a hashtable of custom properties to set for the collector. + + Hashtable + + Hashtable + + + None + + + EnableFailBack + + Specifies whether to enable fail-back functionality. + + Boolean + + Boolean + + + None + + + EnableFailOverOnCollectorDevice + + Specifies whether to enable fail-over on the collector device. + + Boolean + + Boolean + + + None + + + EscalatingChainId + + Specifies the ID of the escalation chain. + + Int32 + + Int32 + + + None + + + SuppressAlertClear + + Specifies whether to suppress alert clear notifications. + + Boolean + + Boolean + + + None + + + ResendAlertInterval + + Specifies the interval for resending alerts. + + Int32 + + Int32 + + + None + + + SpecifiedCollectorDeviceGroupId + + Specifies the ID of the device group for the collector. + + Int32 + + Int32 + + + None + WhatIf @@ -51145,38 +71113,146 @@ Removes the property named "Property2" from the device with the name "Device1".< - + Id - The ID of the device from which the property should be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the collector to modify. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the collector to modify. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + Description + + Specifies a new description for the collector. + + String + + String + + + None + + + BackupAgentId + + Specifies the ID of the backup collector. + + Int32 + + Int32 + + + None + + + CollectorGroupId + + Specifies the ID of the collector group to which this collector should belong. + + Int32 + + Int32 + + + None + + + Properties + + Specifies a hashtable of custom properties to set for the collector. + + Hashtable + + Hashtable + + + None + + + EnableFailBack + + Specifies whether to enable fail-back functionality. + + Boolean + + Boolean + + + None + + + EnableFailOverOnCollectorDevice + + Specifies whether to enable fail-over on the collector device. + + Boolean + + Boolean + + + None + + + EscalatingChainId + + Specifies the ID of the escalation chain. + + Int32 + + Int32 + + + None + + + SuppressAlertClear + + Specifies whether to suppress alert clear notifications. - Int32 + Boolean - Int32 + Boolean - 0 + None - - Name + + ResendAlertInterval - The name of the device from which the property should be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the interval for resending alerts. - String + Int32 - String + Int32 None - - PropertyName + + SpecifiedCollectorDeviceGroupId - The name of the property to be removed. This parameter is mandatory. + Specifies the ID of the device group for the collector. - String + Int32 - String + Int32 None @@ -51221,7 +71297,7 @@ Removes the property named "Property2" from the device with the name "Device1".< - None. + You can pipe objects containing Id properties to this function. @@ -51231,7 +71307,7 @@ Removes the property named "Property2" from the device with the name "Device1".< - Returns a PSCustomObject containing the ID of the device and a message confirming the successful removal of the property. + Returns a LogicMonitor.Collector object containing the updated collector information. @@ -51240,22 +71316,14 @@ Removes the property named "Property2" from the device with the name "Device1".< - This function requires a valid LogicMonitor API authentication. Make sure you are logged in before running any commands. + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMDeviceProperty -Id 1234 -PropertyName "Property1" -Removes the property named "Property1" from the device with ID 1234. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMDeviceProperty -Name "Device1" -PropertyName "Property2" -Removes the property named "Property2" from the device with the name "Device1". + Set-LMCollector -Id 123 -Description "Updated collector" -EnableFailBack $true +Updates the collector with ID 123 with a new description and enables fail-back. @@ -51265,23 +71333,23 @@ Removes the property named "Property2" from the device with the name "Device1".< - Remove-LMLogPartition - Remove - LMLogPartition + Set-LMCollectorConfig + Set + LMCollectorConfig - Removes a LogicMonitor log partition. + Updates a LogicMonitor collector's configuration settings. - The Remove-LMLogPartition function removes a LogicMonitor log partition based on the specified Id or Name. It requires a valid API authentication and authorization. + The Set-LMCollectorConfig function modifies detailed configuration settings for a collector, including SNMP settings, script settings, and various other parameters. This operation will restart the collector. - Remove-LMLogPartition - + Set-LMCollectorConfig + Id - The Id of the log partition to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the collector to configure. Int32 @@ -51290,266 +71358,178 @@ Removes the property named "Property2" from the device with the name "Device1".< 0 - - WhatIf + + SnmpThreadPool - Shows what would happen if the cmdlet runs. The cmdlet is not run. + {{ Fill SnmpThreadPool Description }} + Int32 - SwitchParameter + Int32 - False + None - - Confirm + + SnmpPduTimeout - Prompts you for confirmation before running the cmdlet. + {{ Fill SnmpPduTimeout Description }} + Int32 - SwitchParameter + Int32 - False + None - - ProgressAction + + ScriptThreadPool - {{ Fill ProgressAction Description }} + {{ Fill ScriptThreadPool Description }} - ActionPreference + Int32 - ActionPreference + Int32 None - - - Remove-LMLogPartition - - Name + + ScriptTimeout - The Name of the log partition to be removed. This parameter is mandatory when using the 'Name' parameter set. + {{ Fill ScriptTimeout Description }} - String + Int32 - String + Int32 None - - WhatIf + + BatchScriptThreadPool - Shows what would happen if the cmdlet runs. The cmdlet is not run. + {{ Fill BatchScriptThreadPool Description }} + Int32 - SwitchParameter + Int32 - False + None - - Confirm + + BatchScriptTimeout - Prompts you for confirmation before running the cmdlet. + {{ Fill BatchScriptTimeout Description }} + Int32 - SwitchParameter + Int32 - False + None - - ProgressAction + + PowerShellSPSEProcessCountMin - {{ Fill ProgressAction Description }} + {{ Fill PowerShellSPSEProcessCountMin Description }} - ActionPreference + Int32 - ActionPreference + Int32 None - - - - - Id - - The Id of the log partition to be removed. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - Name - - The Name of the log partition to be removed. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. You cannot pipe objects to this function. - - - - - - - - - - Returns a PSCustomObject containing the ID of the removed log partition and a success message confirming the removal. - - - - - - - - - This function requires a valid API authentication and authorization. Use Connect-LMAccount to log in before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMLogPartition -Id 123 -Removes the LogicMonitor log partition with the Id 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMLogPartition -Name "customerA" -Removes the LogicMonitor log partition with the Name "customerA". - - - - - - - - - - Remove-LMLogsource - Remove - LMLogsource - - Removes a LogicMonitor log source. - - - - The Remove-LMLogsource function removes a specified log source from LogicMonitor. The log source can be identified by either its ID or name. - - - - Remove-LMLogsource - - Id + + PowerShellSPSEProcessCountMax - Specifies the ID of the log source to remove. This parameter is mandatory when using the 'Id' parameter set. + {{ Fill PowerShellSPSEProcessCountMax Description }} Int32 Int32 - 0 + None - - WhatIf + + NetflowEnable - Shows what would happen if the cmdlet runs. The cmdlet is not run. + {{ Fill NetflowEnable Description }} + Boolean - SwitchParameter + Boolean - False + None - - Confirm + + NbarEnable - Prompts you for confirmation before running the cmdlet. + {{ Fill NbarEnable Description }} + Boolean - SwitchParameter + Boolean - False + None - - ProgressAction + + NetflowPorts - {{ Fill ProgressAction Description }} + {{ Fill NetflowPorts Description }} - ActionPreference + String[] - ActionPreference + String[] None - - - Remove-LMLogsource - - Name + + SflowPorts - Specifies the name of the log source to remove. This parameter is mandatory when using the 'Name' parameter set. + {{ Fill SflowPorts Description }} + + String[] + + String[] + + + None + + + LMLogsSyslogEnable + + {{ Fill LMLogsSyslogEnable Description }} + + Boolean + + Boolean + + + None + + + LMLogsSyslogHostnameFormat + + {{ Fill LMLogsSyslogHostnameFormat Description }} + + String + + String + + + None + + + LMLogsSyslogPropertyName + + {{ Fill LMLogsSyslogPropertyName Description }} String @@ -51558,6 +71538,18 @@ Removes the LogicMonitor log partition with the Name "customerA". None + + WaitForRestart + + Indicates whether to wait for the collector restart to complete. + [Additional parameters for snippet configuration omitted for brevity] + + + SwitchParameter + + + False + WhatIf @@ -51593,133 +71585,12 @@ Removes the LogicMonitor log partition with the Name "customerA". None - - - - Id - - Specifies the ID of the log source to remove. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the name of the log source to remove. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe objects to this function. - - - - - - - - - - Returns a PSCustomObject containing the ID of the removed log source and a message confirming the successful removal. - - - - - - - - - This function requires a valid LogicMonitor API authentication. Make sure you are logged in before running any commands. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMLogsource -Id 123 -Removes the log source with ID 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMLogsource -Name "MyLogSource" -Removes the log source named "MyLogSource". - - - - - - - - - - Remove-LMNetscan - Remove - LMNetscan - - Removes a LogicMonitor Netscan. - - - - The Remove-LMNetscan function is used to remove a LogicMonitor Netscan. It supports removing a Netscan by either its Id or Name. - - - Remove-LMNetscan - + Set-LMCollectorConfig + Id - Specifies the Id of the Netscan to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the collector to configure. Int32 @@ -51728,47 +71599,70 @@ Removes the log source named "MyLogSource". 0 - - WhatIf + + CollectorSize + + Specifies the size of the collector. Valid values are "nano", "small", "medium", "large", "extra_large", "double_extra_large". + + String + + String + + + None + + + CollectorConf + + Specifies the collector configuration file content. + + String + + String + + + None + + + SbproxyConf - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the sbproxy configuration file content. + String - SwitchParameter + String - False + None - - Confirm + + WatchdogConf - Prompts you for confirmation before running the cmdlet. + Specifies the watchdog configuration file content. + String - SwitchParameter + String - False + None - - ProgressAction + + WebsiteConf - {{ Fill ProgressAction Description }} + Specifies the website configuration file content. - ActionPreference + String - ActionPreference + String None - - - Remove-LMNetscan - - Name + + WrapperConf - Specifies the Name of the Netscan to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the wrapper configuration file content. String @@ -51777,6 +71671,18 @@ Removes the log source named "MyLogSource". None + + WaitForRestart + + Indicates whether to wait for the collector restart to complete. + [Additional parameters for snippet configuration omitted for brevity] + + + SwitchParameter + + + False + WhatIf @@ -51812,456 +71718,192 @@ Removes the log source named "MyLogSource". None - - - - Id - - Specifies the Id of the Netscan to remove. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the Name of the Netscan to remove. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe input to this function. - - - - - - - - - - Returns a PSCustomObject containing the ID of the removed Netscan and a message indicating the success of the removal operation. - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMNetscan -Id 123 -Removes the Netscan with Id 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMNetscan -Name "MyNetscan" -Removes the Netscan with the name "MyNetscan". - - - - - - - - - - Remove-LMNetscanGroup - Remove - LMNetscanGroup - - Removes a LogicMonitor NetScan group. - - - - The Remove-LMNetscanGroup function removes a LogicMonitor NetScan group based on the specified ID or name. It requires valid API credentials to be logged in. - - - Remove-LMNetscanGroup - - Id + Set-LMCollectorConfig + + Name - Specifies the ID of the NetScan group to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the name of the collector to configure. + + String + + String + + + None + + + SnmpThreadPool + + {{ Fill SnmpThreadPool Description }} Int32 Int32 - 0 + None - - WhatIf + + SnmpPduTimeout - Shows what would happen if the cmdlet runs. The cmdlet is not run. + {{ Fill SnmpPduTimeout Description }} + Int32 - SwitchParameter + Int32 - False + None - - Confirm + + ScriptThreadPool - Prompts you for confirmation before running the cmdlet. + {{ Fill ScriptThreadPool Description }} + Int32 - SwitchParameter + Int32 - False + None - - ProgressAction + + ScriptTimeout - {{ Fill ProgressAction Description }} + {{ Fill ScriptTimeout Description }} - ActionPreference + Int32 - ActionPreference + Int32 None - - - Remove-LMNetscanGroup - - Name + + BatchScriptThreadPool - Specifies the name of the NetScan group to remove. This parameter is mandatory when using the 'Name' parameter set. + {{ Fill BatchScriptThreadPool Description }} - String + Int32 - String + Int32 None - - WhatIf + + BatchScriptTimeout - Shows what would happen if the cmdlet runs. The cmdlet is not run. + {{ Fill BatchScriptTimeout Description }} + Int32 - SwitchParameter + Int32 - False + None - - Confirm + + PowerShellSPSEProcessCountMin - Prompts you for confirmation before running the cmdlet. + {{ Fill PowerShellSPSEProcessCountMin Description }} + + Int32 + + Int32 + + + None + + + PowerShellSPSEProcessCountMax + + {{ Fill PowerShellSPSEProcessCountMax Description }} + Int32 - SwitchParameter + Int32 - False + None - - ProgressAction + + NetflowEnable - {{ Fill ProgressAction Description }} + {{ Fill NetflowEnable Description }} - ActionPreference + Boolean - ActionPreference + Boolean None - - - - - Id - - Specifies the ID of the NetScan group to remove. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the name of the NetScan group to remove. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe objects to this function. - - - - - - - - - - Returns a PSCustomObject containing the ID of the removed NetScan group and a message indicating the success of the removal operation. - - - - - - - - - This function requires valid API credentials to be logged in. Use the Connect-LMAccount function to log in before running any commands. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMNetscanGroup -Id 123 -Removes the NetScan group with ID 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMNetscanGroup -Name "MyGroup" -Removes the NetScan group with the name "MyGroup". - - - - - - - - - - Remove-LMNormalizedProperties - Remove - LMNormalizedProperties - - Removes normalized properties from LogicMonitor. - - - - The Remove-LMNormalizedProperties cmdlet removes normalized properties from LogicMonitor. - - - - Remove-LMNormalizedProperties - - Alias + + NbarEnable - The alias name of the normalized property to remove. + {{ Fill NbarEnable Description }} - String + Boolean - String + Boolean None - - ProgressAction + + NetflowPorts - {{ Fill ProgressAction Description }} + {{ Fill NetflowPorts Description }} - ActionPreference + String[] - ActionPreference + String[] None - - - - - Alias - - The alias name of the normalized property to remove. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. - - - - - - - - - - Returns the response from the API after removing the normalized property. - - - - - - - - - This function requires valid API credentials to be logged in. Use Connect-LMAccount to log in before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMNormalizedProperties -Alias "location" -Removes the normalized property with alias "location". - - - - - - - - - - Remove-LMOpsNote - Remove - LMOpsNote - - Removes an OpsNote from LogicMonitor. - - - - The Remove-LMOpsNote function removes an OpsNote from LogicMonitor. It requires the user to be logged in and have valid API credentials. - - - - Remove-LMOpsNote - - Id + + SflowPorts + + {{ Fill SflowPorts Description }} + + String[] + + String[] + + + None + + + LMLogsSyslogEnable - Specifies the ID of the OpsNote to be removed. + {{ Fill LMLogsSyslogEnable Description }} + + Boolean + + Boolean + + + None + + + LMLogsSyslogHostnameFormat + + {{ Fill LMLogsSyslogHostnameFormat Description }} + + String + + String + + + None + + + LMLogsSyslogPropertyName + + {{ Fill LMLogsSyslogPropertyName Description }} String @@ -52270,6 +71912,18 @@ Removes the normalized property with alias "location". None + + WaitForRestart + + Indicates whether to wait for the collector restart to complete. + [Additional parameters for snippet configuration omitted for brevity] + + + SwitchParameter + + + False + WhatIf @@ -52305,162 +71959,84 @@ Removes the normalized property with alias "location". None - - - - Id - - Specifies the ID of the OpsNote to be removed. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe objects to this function. - - - - - - - - - - Returns a PSCustomObject containing the ID of the removed OpsNote and a message indicating the success of the removal operation. - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMOpsNote -Id "12345" -Removes the OpsNote with the ID "12345" from LogicMonitor. - - - - - - - - - - Remove-LMPropertysource - Remove - LMPropertysource - - Removes a property source from LogicMonitor. - - - - The Remove-LMPropertysource function removes a property source from LogicMonitor. It can remove a property source either by its ID or by its name. - - - Remove-LMPropertysource - - Id + Set-LMCollectorConfig + + Name - Specifies the ID of the property source to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the name of the collector to configure. - Int32 + String - Int32 + String - 0 + None - - WhatIf + + CollectorSize - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the size of the collector. Valid values are "nano", "small", "medium", "large", "extra_large", "double_extra_large". + String - SwitchParameter + String - False + None - - Confirm + + CollectorConf - Prompts you for confirmation before running the cmdlet. + Specifies the collector configuration file content. + String - SwitchParameter + String - False + None - - ProgressAction + + SbproxyConf - {{ Fill ProgressAction Description }} + Specifies the sbproxy configuration file content. - ActionPreference + String - ActionPreference + String None - - - Remove-LMPropertysource - - Name + + WatchdogConf - Specifies the name of the property source to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the watchdog configuration file content. + + String + + String + + + None + + + WebsiteConf + + Specifies the website configuration file content. + + String + + String + + + None + + + WrapperConf + + Specifies the wrapper configuration file content. String @@ -52469,6 +72045,18 @@ Removes the OpsNote with the ID "12345" from LogicMonitor. None + + WaitForRestart + + Indicates whether to wait for the collector restart to complete. + [Additional parameters for snippet configuration omitted for brevity] + + + SwitchParameter + + + False + WhatIf @@ -52506,10 +72094,10 @@ Removes the OpsNote with the ID "12345" from LogicMonitor. - + Id - Specifies the ID of the property source to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the collector to configure. Int32 @@ -52518,10 +72106,262 @@ Removes the OpsNote with the ID "12345" from LogicMonitor. 0 - + Name - Specifies the name of the property source to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the collector to configure. + + String + + String + + + None + + + CollectorSize + + Specifies the size of the collector. Valid values are "nano", "small", "medium", "large", "extra_large", "double_extra_large". + + String + + String + + + None + + + CollectorConf + + Specifies the collector configuration file content. + + String + + String + + + None + + + SbproxyConf + + Specifies the sbproxy configuration file content. + + String + + String + + + None + + + WatchdogConf + + Specifies the watchdog configuration file content. + + String + + String + + + None + + + WebsiteConf + + Specifies the website configuration file content. + + String + + String + + + None + + + WrapperConf + + Specifies the wrapper configuration file content. + + String + + String + + + None + + + SnmpThreadPool + + {{ Fill SnmpThreadPool Description }} + + Int32 + + Int32 + + + None + + + SnmpPduTimeout + + {{ Fill SnmpPduTimeout Description }} + + Int32 + + Int32 + + + None + + + ScriptThreadPool + + {{ Fill ScriptThreadPool Description }} + + Int32 + + Int32 + + + None + + + ScriptTimeout + + {{ Fill ScriptTimeout Description }} + + Int32 + + Int32 + + + None + + + BatchScriptThreadPool + + {{ Fill BatchScriptThreadPool Description }} + + Int32 + + Int32 + + + None + + + BatchScriptTimeout + + {{ Fill BatchScriptTimeout Description }} + + Int32 + + Int32 + + + None + + + PowerShellSPSEProcessCountMin + + {{ Fill PowerShellSPSEProcessCountMin Description }} + + Int32 + + Int32 + + + None + + + PowerShellSPSEProcessCountMax + + {{ Fill PowerShellSPSEProcessCountMax Description }} + + Int32 + + Int32 + + + None + + + NetflowEnable + + {{ Fill NetflowEnable Description }} + + Boolean + + Boolean + + + None + + + NbarEnable + + {{ Fill NbarEnable Description }} + + Boolean + + Boolean + + + None + + + NetflowPorts + + {{ Fill NetflowPorts Description }} + + String[] + + String[] + + + None + + + SflowPorts + + {{ Fill SflowPorts Description }} + + String[] + + String[] + + + None + + + LMLogsSyslogEnable + + {{ Fill LMLogsSyslogEnable Description }} + + Boolean + + Boolean + + + None + + + LMLogsSyslogHostnameFormat + + {{ Fill LMLogsSyslogHostnameFormat Description }} + + String + + String + + + None + + + LMLogsSyslogPropertyName + + {{ Fill LMLogsSyslogPropertyName Description }} String @@ -52530,6 +72370,19 @@ Removes the OpsNote with the ID "12345" from LogicMonitor. None + + WaitForRestart + + Indicates whether to wait for the collector restart to complete. + [Additional parameters for snippet configuration omitted for brevity] + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -52570,7 +72423,7 @@ Removes the OpsNote with the ID "12345" from LogicMonitor. - You can pipe input to this function. + You can pipe objects containing Id properties to this function. @@ -52580,7 +72433,7 @@ Removes the OpsNote with the ID "12345" from LogicMonitor. - Returns a PSCustomObject containing the ID of the removed property source and a message indicating the success of the removal operation. + Returns a string indicating the status of the configuration update and restart operation. @@ -52589,22 +72442,14 @@ Removes the OpsNote with the ID "12345" from LogicMonitor. - + This function requires a valid LogicMonitor API authentication and will restart the collector. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMPropertysource -Id 123 -Removes the property source with ID 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMPropertysource -Name "MyPropertySource" -Removes the property source with the name "MyPropertySource". + Set-LMCollectorConfig -Id 123 -CollectorSize "medium" -WaitForRestart +Updates the collector size and waits for the restart to complete. @@ -52614,23 +72459,23 @@ Removes the property source with the name "MyPropertySource". - Remove-LMReport - Remove - LMReport + Set-LMCollectorGroup + Set + LMCollectorGroup - Removes a LogicMonitor report. + Updates a LogicMonitor collector group's configuration. - The Remove-LMReport function removes a LogicMonitor report based on the specified report ID or name. It requires a valid API authentication and authorization. + The Set-LMCollectorGroup function modifies an existing collector group's settings, including its name, description, properties, and auto-balance settings. - Remove-LMReport - + Set-LMCollectorGroup + Id - Specifies the ID of the report to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the collector group to modify. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -52639,6 +72484,66 @@ Removes the property source with the name "MyPropertySource". 0 + + NewName + + Specifies the new name for the collector group. + + String + + String + + + None + + + Description + + Specifies a new description for the collector group. + + String + + String + + + None + + + Properties + + Specifies a hashtable of custom properties to set for the collector group. + + Hashtable + + Hashtable + + + None + + + AutoBalance + + Specifies whether to enable auto-balancing for the collector group. + + Boolean + + Boolean + + + None + + + AutoBalanceInstanceCountThreshold + + Specifies the threshold for auto-balancing the collector group. + + Int32 + + Int32 + + + None + WhatIf @@ -52675,11 +72580,11 @@ Removes the property source with the name "MyPropertySource". - Remove-LMReport - + Set-LMCollectorGroup + Name - Specifies the name of the report to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the collector group. This parameter is mandatory when using the 'Name' parameter set. String @@ -52688,6 +72593,66 @@ Removes the property source with the name "MyPropertySource". None + + NewName + + Specifies the new name for the collector group. + + String + + String + + + None + + + Description + + Specifies a new description for the collector group. + + String + + String + + + None + + + Properties + + Specifies a hashtable of custom properties to set for the collector group. + + Hashtable + + Hashtable + + + None + + + AutoBalance + + Specifies whether to enable auto-balancing for the collector group. + + Boolean + + Boolean + + + None + + + AutoBalanceInstanceCountThreshold + + Specifies the threshold for auto-balancing the collector group. + + Int32 + + Int32 + + + None + WhatIf @@ -52725,10 +72690,10 @@ Removes the property source with the name "MyPropertySource". - + Id - Specifies the ID of the report to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the collector group to modify. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -52737,10 +72702,22 @@ Removes the property source with the name "MyPropertySource". 0 - + Name - Specifies the name of the report to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the collector group. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + NewName + + Specifies the new name for the collector group. String @@ -52749,6 +72726,54 @@ Removes the property source with the name "MyPropertySource". None + + Description + + Specifies a new description for the collector group. + + String + + String + + + None + + + Properties + + Specifies a hashtable of custom properties to set for the collector group. + + Hashtable + + Hashtable + + + None + + + AutoBalance + + Specifies whether to enable auto-balancing for the collector group. + + Boolean + + Boolean + + + None + + + AutoBalanceInstanceCountThreshold + + Specifies the threshold for auto-balancing the collector group. + + Int32 + + Int32 + + + None + WhatIf @@ -52789,7 +72814,7 @@ Removes the property source with the name "MyPropertySource". - You can pipe input to this function. + You can pipe objects containing Id properties to this function. @@ -52799,7 +72824,7 @@ Removes the property source with the name "MyPropertySource". - Returns a PSCustomObject containing the ID of the removed report and a message indicating the success of the removal operation. + Returns a LogicMonitor.CollectorGroup object containing the updated group information. @@ -52808,22 +72833,14 @@ Removes the property source with the name "MyPropertySource". - This function requires a valid API authentication and authorization. Use Connect-LMAccount to log in before running this command. + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMReport -Id 123 -Removes the report with ID 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMReport -Name "MyReport" -Removes the report with the name "MyReport". + Set-LMCollectorGroup -Id 123 -NewName "Updated Group" -AutoBalance $true +Updates the collector group with ID 123 with a new name and enables auto-balancing. @@ -52833,30 +72850,138 @@ Removes the report with the name "MyReport". - Remove-LMReportGroup - Remove - LMReportGroup + Set-LMConfigsource + Set + LMConfigsource - Removes a LogicMonitor report group. + Updates a LogicMonitor config source configuration. - The Remove-LMReportGroup function removes a LogicMonitor report group based on the specified Id or Name. It requires valid API credentials to be logged in. + The Set-LMConfigsource function modifies an existing config source in LogicMonitor, allowing updates to its name, display name, description, applies to settings, and other properties. - Remove-LMReportGroup + Set-LMConfigsource Id - The Id of the report group to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the config source to modify. This parameter is mandatory when using the 'Id' parameter set. - Int32 + String - Int32 + String - 0 + None + + + NewName + + Specifies the new name for the config source. + + String + + String + + + None + + + DisplayName + + Specifies the new display name for the config source. + + String + + String + + + None + + + Description + + Specifies the new description for the config source. + + String + + String + + + None + + + appliesTo + + Specifies the new applies to expression for the config source. + + String + + String + + + None + + + TechNotes + + Specifies the new technical notes for the config source. + + String + + String + + + None + + + Tags + + Specifies an array of tags to associate with the config source. + + String[] + + String[] + + + None + + + TagsMethod + + Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". + + String + + String + + + Refresh + + + PollingIntervalInSeconds + + Specifies the polling interval in seconds. Valid values are "3600", "14400", "28800", "86400". + + String + + String + + + None + + + ConfigChecks + + Specifies the configuration checks object for the config source. + + PSObject + + PSObject + + + None WhatIf @@ -52894,11 +73019,107 @@ Removes the report with the name "MyReport". - Remove-LMReportGroup + Set-LMConfigsource Name - The name of the report group to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the config source. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + NewName + + Specifies the new name for the config source. + + String + + String + + + None + + + DisplayName + + Specifies the new display name for the config source. + + String + + String + + + None + + + Description + + Specifies the new description for the config source. + + String + + String + + + None + + + appliesTo + + Specifies the new applies to expression for the config source. + + String + + String + + + None + + + TechNotes + + Specifies the new technical notes for the config source. + + String + + String + + + None + + + Tags + + Specifies an array of tags to associate with the config source. + + String[] + + String[] + + + None + + + TagsMethod + + Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". + + String + + String + + + Refresh + + + PollingIntervalInSeconds + + Specifies the polling interval in seconds. Valid values are "3600", "14400", "28800", "86400". String @@ -52907,6 +73128,18 @@ Removes the report with the name "MyReport". None + + ConfigChecks + + Specifies the configuration checks object for the config source. + + PSObject + + PSObject + + + None + WhatIf @@ -52947,19 +73180,115 @@ Removes the report with the name "MyReport". Id - The Id of the report group to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the config source to modify. This parameter is mandatory when using the 'Id' parameter set. + + String + + String + + + None + + + Name + + Specifies the current name of the config source. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + NewName + + Specifies the new name for the config source. + + String + + String + + + None + + + DisplayName + + Specifies the new display name for the config source. - Int32 + String - Int32 + String - 0 + None - - Name + + Description - The name of the report group to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the new description for the config source. + + String + + String + + + None + + + appliesTo + + Specifies the new applies to expression for the config source. + + String + + String + + + None + + + TechNotes + + Specifies the new technical notes for the config source. + + String + + String + + + None + + + Tags + + Specifies an array of tags to associate with the config source. + + String[] + + String[] + + + None + + + TagsMethod + + Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". + + String + + String + + + Refresh + + + PollingIntervalInSeconds + + Specifies the polling interval in seconds. Valid values are "3600", "14400", "28800", "86400". String @@ -52968,6 +73297,18 @@ Removes the report with the name "MyReport". None + + ConfigChecks + + Specifies the configuration checks object for the config source. + + PSObject + + PSObject + + + None + WhatIf @@ -53008,7 +73349,7 @@ Removes the report with the name "MyReport". - You can pipe input to this function. + You can pipe objects containing Id properties to this function. @@ -53018,7 +73359,7 @@ Removes the report with the name "MyReport". - Returns a PSCustomObject containing the ID of the removed report group and a success message confirming the removal. + Returns a LogicMonitor.Datasource object containing the updated config source information. @@ -53027,22 +73368,14 @@ Removes the report with the name "MyReport". - + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMReportGroup -Id 123 -Removes the report group with Id 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMReportGroup -Name "MyReportGroup" -Removes the report group with the name "MyReportGroup". + Set-LMConfigsource -Id 123 -NewName "UpdatedSource" -Description "New description" +Updates the config source with ID 123 with a new name and description. @@ -53052,30 +73385,138 @@ Removes the report group with the name "MyReportGroup". - Remove-LMRole - Remove - LMRole + Set-LMDatasource + Set + LMDatasource - Removes a LogicMonitor role. + Updates a LogicMonitor datasource configuration. - The Remove-LMRole function removes a LogicMonitor role based on the specified Id or Name. It requires a valid API authentication and authorization. + The Set-LMDatasource function modifies an existing datasource in LogicMonitor, allowing updates to its name, display name, description, applies to settings, and other properties. - Remove-LMRole + Set-LMDatasource Id - The Id of the role to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the datasource to modify. This parameter is mandatory when using the 'Id' parameter set. - Int32 + String - Int32 + String - 0 + None + + + NewName + + Specifies the new name for the datasource. + + String + + String + + + None + + + DisplayName + + Specifies the new display name for the datasource. + + String + + String + + + None + + + Description + + Specifies the new description for the datasource. + + String + + String + + + None + + + Tags + + Specifies an array of tags to associate with the datasource. + + String[] + + String[] + + + None + + + TagsMethod + + Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". + + String + + String + + + Refresh + + + appliesTo + + Specifies the new applies to expression for the datasource. + + String + + String + + + None + + + TechNotes + + Specifies the new technical notes for the datasource. + + String + + String + + + None + + + PollingIntervalInSeconds + + Specifies the polling interval in seconds. + + String + + String + + + None + + + Datapoints + + Specifies the datapoints configuration object for the datasource. + + PSObject + + PSObject + + + None WhatIf @@ -53113,11 +73554,107 @@ Removes the report group with the name "MyReportGroup". - Remove-LMRole + Set-LMDatasource Name - The Name of the role to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the datasource. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + NewName + + Specifies the new name for the datasource. + + String + + String + + + None + + + DisplayName + + Specifies the new display name for the datasource. + + String + + String + + + None + + + Description + + Specifies the new description for the datasource. + + String + + String + + + None + + + Tags + + Specifies an array of tags to associate with the datasource. + + String[] + + String[] + + + None + + + TagsMethod + + Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". + + String + + String + + + Refresh + + + appliesTo + + Specifies the new applies to expression for the datasource. + + String + + String + + + None + + + TechNotes + + Specifies the new technical notes for the datasource. + + String + + String + + + None + + + PollingIntervalInSeconds + + Specifies the polling interval in seconds. String @@ -53126,6 +73663,18 @@ Removes the report group with the name "MyReportGroup". None + + Datapoints + + Specifies the datapoints configuration object for the datasource. + + PSObject + + PSObject + + + None + WhatIf @@ -53166,19 +73715,19 @@ Removes the report group with the name "MyReportGroup". Id - The Id of the role to be removed. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the datasource to modify. This parameter is mandatory when using the 'Id' parameter set. - Int32 + String - Int32 + String - 0 + None Name - The Name of the role to be removed. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the datasource. This parameter is mandatory when using the 'Name' parameter set. String @@ -53187,156 +73736,94 @@ Removes the report group with the name "MyReportGroup". None - - WhatIf + + NewName - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the new name for the datasource. - SwitchParameter + String - SwitchParameter + String - False + None - - Confirm + + DisplayName - Prompts you for confirmation before running the cmdlet. + Specifies the new display name for the datasource. - SwitchParameter + String - SwitchParameter + String - False + None - - ProgressAction + + Description - {{ Fill ProgressAction Description }} + Specifies the new description for the datasource. - ActionPreference + String - ActionPreference + String None - - - - - None. You cannot pipe objects to this function. - + + Tags - + Specifies an array of tags to associate with the datasource. - - - - + String[] - Returns a PSCustomObject containing the ID of the removed role and a success message confirming the removal. + String[] + + None + + + TagsMethod - - - - - - - This function requires a valid API authentication and authorization. Use Connect-LMAccount to log in before running this command. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMRole -Id 123 -Removes the LogicMonitor role with the Id 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMRole -Name "Admin" -Removes the LogicMonitor role with the Name "Admin". - - - - - - - - - - Remove-LMSDT - Remove - LMSDT - - Removes a Scheduled Down Time (SDT) entry from LogicMonitor. - - - - The Remove-LMSDT function removes a specified SDT entry from LogicMonitor using its ID. - - - - Remove-LMSDT - - Id - - Specifies the ID of the SDT entry to remove. This parameter is mandatory. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - Id + Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". + + String + + String + + + Refresh + + + appliesTo - Specifies the ID of the SDT entry to remove. This parameter is mandatory. + Specifies the new applies to expression for the datasource. + + String + + String + + + None + + + TechNotes + + Specifies the new technical notes for the datasource. + + String + + String + + + None + + + PollingIntervalInSeconds + + Specifies the polling interval in seconds. String @@ -53345,6 +73832,18 @@ Removes the LogicMonitor role with the Name "Admin". None + + Datapoints + + Specifies the datapoints configuration object for the datasource. + + PSObject + + PSObject + + + None + WhatIf @@ -53385,7 +73884,7 @@ Removes the LogicMonitor role with the Name "Admin". - You can pipe objects to this function. + You can pipe objects containing Id properties to this function. @@ -53395,7 +73894,7 @@ Removes the LogicMonitor role with the Name "Admin". - Returns a PSCustomObject containing the ID of the removed SDT entry and a success message confirming the removal. + Returns a LogicMonitor.Datasource object containing the updated datasource information. @@ -53404,14 +73903,14 @@ Removes the LogicMonitor role with the Name "Admin". - + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMSDT -Id "12345" -Removes the SDT entry with ID "12345". + Set-LMDatasource -Id 123 -NewName "UpdatedSource" -Description "New description" +Updates the datasource with ID 123 with a new name and description. @@ -53421,30 +73920,234 @@ Removes the SDT entry with ID "12345". - Remove-LMTopologysource - Remove - LMTopologysource + Set-LMDevice + Set + LMDevice - Removes a topology source from LogicMonitor. + Updates a LogicMonitor device configuration. - The Remove-LMTopologysource function removes a topology source from LogicMonitor using either its ID or name. + The Set-LMDevice function modifies an existing device in LogicMonitor, allowing updates to its name, display name, description, collector settings, and various other properties. - Remove-LMTopologysource + Set-LMDevice Id - Specifies the ID of the topology source to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the device to modify. This parameter is mandatory when using the 'Id' parameter set. + + String + + String + + + None + + + NewName + + Specifies the new name for the device. + + String + + String + + + None + + + DisplayName + + Specifies the new display name for the device. + + String + + String + + + None + + + Description + + Specifies the new description for the device. + + String + + String + + + None + + + PreferredCollectorId + + Specifies the ID of the preferred collector for the device. Int32 Int32 - 0 + None + + + PreferredCollectorGroupId + + Specifies the ID of the preferred collector group for the device. + + Int32 + + Int32 + + + None + + + AutoBalancedCollectorGroupId + + Specifies the ID of the auto-balanced collector group for the device. + + Int32 + + Int32 + + + None + + + Properties + + Specifies a hashtable of custom properties for the device. + + Hashtable + + Hashtable + + + None + + + HostGroupIds + + Specifies an array of host group IDs to associate with the device. + + String[] + + String[] + + + None + + + PropertiesMethod + + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + + String + + String + + + Replace + + + Link + + Specifies the URL link associated with the device. + + String + + String + + + None + + + DisableAlerting + + Specifies whether to disable alerting for the device. + + Boolean + + Boolean + + + None + + + EnableNetFlow + + Specifies whether to enable NetFlow for the device. + + Boolean + + Boolean + + + None + + + NetflowCollectorGroupId + + Specifies the ID of the NetFlow collector group. + + Int32 + + Int32 + + + None + + + NetflowCollectorId + + Specifies the ID of the NetFlow collector. + + Int32 + + Int32 + + + None + + + EnableLogCollector + + Specifies whether to enable log collection for the device. + + Boolean + + Boolean + + + None + + + LogCollectorGroupId + + Specifies the ID of the log collector group. + + Int32 + + Int32 + + + None + + + LogCollectorId + + Specifies the ID of the log collector. + + Int32 + + Int32 + + + None WhatIf @@ -53482,11 +74185,11 @@ Removes the SDT entry with ID "12345". - Remove-LMTopologysource + Set-LMDevice Name - Specifies the name of the topology source to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the device. This parameter is mandatory when using the 'Name' parameter set. String @@ -53495,168 +74198,94 @@ Removes the SDT entry with ID "12345". None - - WhatIf + + NewName - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the new name for the device. + String - SwitchParameter + String - False + None - - Confirm + + DisplayName - Prompts you for confirmation before running the cmdlet. + Specifies the new display name for the device. + String - SwitchParameter + String - False + None - - ProgressAction + + Description - {{ Fill ProgressAction Description }} + Specifies the new description for the device. - ActionPreference + String - ActionPreference + String None - - - - - Id - - Specifies the ID of the topology source to remove. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the name of the topology source to remove. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe objects to this function. - - - - - - - - - - Returns a PSCustomObject containing the ID of the removed topology source and a success message confirming the removal. - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMTopologysource -Id 123 -Removes the topology source with ID 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMTopologysource -Name "MyTopologySource" -Removes the topology source with the name "MyTopologySource". - - - - - - - - - - Remove-LMUnmonitoredDevice - Remove - LMUnmonitoredDevice - - Removes unmonitored devices from LogicMonitor. - - - - The Remove-LMUnmonitoredDevice function removes one or more unmonitored devices from LogicMonitor using their IDs. - - - - Remove-LMUnmonitoredDevice - - Ids + + PreferredCollectorId - Specifies an array of IDs for the unmonitored devices to remove. + Specifies the ID of the preferred collector for the device. + + Int32 + + Int32 + + + None + + + PreferredCollectorGroupId + + Specifies the ID of the preferred collector group for the device. + + Int32 + + Int32 + + + None + + + AutoBalancedCollectorGroupId + + Specifies the ID of the auto-balanced collector group for the device. + + Int32 + + Int32 + + + None + + + Properties + + Specifies a hashtable of custom properties for the device. + + Hashtable + + Hashtable + + + None + + + HostGroupIds + + Specifies an array of host group IDs to associate with the device. String[] @@ -53665,201 +74294,110 @@ Removes the topology source with the name "MyTopologySource". None - - WhatIf + + PropertiesMethod - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + String - SwitchParameter + String + + + Replace + + + Link + + Specifies the URL link associated with the device. + + String + + String - False + None - - Confirm + + DisableAlerting - Prompts you for confirmation before running the cmdlet. + Specifies whether to disable alerting for the device. + Boolean - SwitchParameter + Boolean - False + None - - ProgressAction + + EnableNetFlow - {{ Fill ProgressAction Description }} + Specifies whether to enable NetFlow for the device. - ActionPreference + Boolean - ActionPreference + Boolean None - - - - - Ids - - Specifies an array of IDs for the unmonitored devices to remove. - - String[] - - String[] - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. - - - - - - - - - - Returns a LogicMonitor.UnmonitoredDevice object containing information about the removed devices. - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMUnmonitoredDevice -Ids "123","456" -Removes the unmonitored devices with IDs "123" and "456". - - - - - - - - - - Remove-LMUser - Remove - LMUser - - Removes a user from LogicMonitor. - - - - The Remove-LMUser function removes a user from LogicMonitor using either their ID or name. - - - - Remove-LMUser - - Id + + NetflowCollectorGroupId - Specifies the ID of the user to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the NetFlow collector group. Int32 Int32 - 0 + None - - WhatIf + + NetflowCollectorId - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the ID of the NetFlow collector. + Int32 - SwitchParameter + Int32 - False + None - - Confirm + + EnableLogCollector - Prompts you for confirmation before running the cmdlet. + Specifies whether to enable log collection for the device. + Boolean - SwitchParameter + Boolean - False + None - - ProgressAction + + LogCollectorGroupId - {{ Fill ProgressAction Description }} + Specifies the ID of the log collector group. - ActionPreference + Int32 - ActionPreference + Int32 None - - - Remove-LMUser - - Name + + LogCollectorId - Specifies the name of the user to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the ID of the log collector. - String + Int32 - String + Int32 None @@ -53904,19 +74442,19 @@ Removes the unmonitored devices with IDs "123" and "456". Id - Specifies the ID of the user to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the device to modify. This parameter is mandatory when using the 'Id' parameter set. - Int32 + String - Int32 + String - 0 + None Name - Specifies the name of the user to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the device. This parameter is mandatory when using the 'Name' parameter set. String @@ -53925,221 +74463,206 @@ Removes the unmonitored devices with IDs "123" and "456". None - - WhatIf + + NewName - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the new name for the device. - SwitchParameter + String - SwitchParameter + String - False + None - - Confirm + + DisplayName - Prompts you for confirmation before running the cmdlet. + Specifies the new display name for the device. - SwitchParameter + String - SwitchParameter + String - False + None - - ProgressAction + + Description - {{ Fill ProgressAction Description }} + Specifies the new description for the device. - ActionPreference + String - ActionPreference + String None - - - + + PreferredCollectorId + + Specifies the ID of the preferred collector for the device. + + Int32 - You can pipe objects to this function. + Int32 + + None + + + PreferredCollectorGroupId - + Specifies the ID of the preferred collector group for the device. - - - - + Int32 - Returns a PSCustomObject containing the ID of the removed user and a success message confirming the removal. + Int32 + + None + + + AutoBalancedCollectorGroupId - + Specifies the ID of the auto-balanced collector group for the device. - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMUser -Id 123 -Removes the user with ID 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMUser -Name "JohnDoe" -Removes the user with the name "JohnDoe". - - - - - - - - - - Remove-LMWebsite - Remove - LMWebsite - - Removes a website from LogicMonitor. - - - - The Remove-LMWebsite function removes a website from LogicMonitor using either its ID or name. - - - - Remove-LMWebsite - - Id - - Specifies the ID of the website to remove. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Remove-LMWebsite - - Name - - Specifies the name of the website to remove. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - Id + Int32 + + Int32 + + + None + + + Properties + + Specifies a hashtable of custom properties for the device. + + Hashtable + + Hashtable + + + None + + + HostGroupIds + + Specifies an array of host group IDs to associate with the device. + + String[] + + String[] + + + None + + + PropertiesMethod + + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + + String + + String + + + Replace + + + Link + + Specifies the URL link associated with the device. + + String + + String + + + None + + + DisableAlerting + + Specifies whether to disable alerting for the device. + + Boolean + + Boolean + + + None + + + EnableNetFlow + + Specifies whether to enable NetFlow for the device. + + Boolean + + Boolean + + + None + + + NetflowCollectorGroupId + + Specifies the ID of the NetFlow collector group. + + Int32 + + Int32 + + + None + + + NetflowCollectorId + + Specifies the ID of the NetFlow collector. + + Int32 + + Int32 + + + None + + + EnableLogCollector + + Specifies whether to enable log collection for the device. + + Boolean + + Boolean + + + None + + + LogCollectorGroupId - Specifies the ID of the website to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the log collector group. Int32 Int32 - 0 + None - - Name + + LogCollectorId - Specifies the name of the website to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies the ID of the log collector. - String + Int32 - String + Int32 None @@ -54184,7 +74707,7 @@ Removes the user with the name "JohnDoe". - You can pipe objects to this function. + You can pipe objects containing Id properties to this function. @@ -54194,7 +74717,7 @@ Removes the user with the name "JohnDoe". - Returns a PSCustomObject containing the ID of the removed website and a success message confirming the removal. + Returns a LogicMonitor.Device object containing the updated device information. @@ -54203,22 +74726,14 @@ Removes the user with the name "JohnDoe". - + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Remove-LMWebsite -Id 123 -Removes the website with ID 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMWebsite -Name "MyWebsite" -Removes the website with the name "MyWebsite". + Set-LMDevice -Id 123 -NewName "UpdatedDevice" -Description "New description" +Updates the device with ID 123 with a new name and description. @@ -54228,103 +74743,162 @@ Removes the website with the name "MyWebsite". - Remove-LMWebsiteGroup - Remove - LMWebsiteGroup + Set-LMDeviceDatasourceInstance + Set + LMDeviceDatasourceInstance - Removes a website group from LogicMonitor. + Updates a LogicMonitor device datasource instance configuration. - The Remove-LMWebsiteGroup function removes a website group from LogicMonitor using either its ID or name. + The Set-LMDeviceDatasourceInstance function modifies an existing device datasource instance in LogicMonitor, allowing updates to its display name, wild values, description, and various other properties. - Remove-LMWebsiteGroup - - Id + Set-LMDeviceDatasourceInstance + + DisplayName - Specifies the ID of the website group to remove. This parameter is mandatory when using the 'Id' parameter set. + Specifies the new display name for the instance. - Int32 + String - Int32 + String - 0 + None - DeleteHostsandChildren + WildValue - Specifies whether to delete the hosts and their children within the website group. Default value is $false. + Specifies the first wild value for the instance. - Boolean + String - Boolean + String - False + None - - WhatIf + + WildValue2 - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies the second wild value for the instance. + String - SwitchParameter + String - False + None - - Confirm + + Description - Prompts you for confirmation before running the cmdlet. + Specifies the description for the instance. + String - SwitchParameter + String - False + None - - ProgressAction + + Properties - {{ Fill ProgressAction Description }} + Specifies a hashtable of custom properties for the instance. - ActionPreference + Hashtable - ActionPreference + Hashtable None - - - Remove-LMWebsiteGroup - - Name + + PropertiesMethod - Specifies the name of the website group to remove. This parameter is mandatory when using the 'Name' parameter set. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". String String + Replace + + + StopMonitoring + + Specifies whether to stop monitoring the instance. + + Boolean + + Boolean + + None - DeleteHostsandChildren + DisableAlerting - Specifies whether to delete the hosts and their children within the website group. Default value is $false. + Specifies whether to disable alerting for the instance. Boolean Boolean - False + None + + + InstanceGroupId + + Specifies the ID of the instance group to which the instance belongs. + + String + + String + + + None + + + InstanceId + + Specifies the ID of the instance to update. + + String + + String + + + None + + + DatasourceName + + Specifies the name of the datasource associated with the instance. + + String + + String + + + None + + + Name + + Specifies the name of the device associated with the instance. + + String + + String + + + None WhatIf @@ -54361,145 +74935,12 @@ Removes the website with the name "MyWebsite". None - - - - Id - - Specifies the ID of the website group to remove. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the name of the website group to remove. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - DeleteHostsandChildren - - Specifies whether to delete the hosts and their children within the website group. Default value is $false. - - Boolean - - Boolean - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe objects to this function. - - - - - - - - - - Returns a PSCustomObject containing the ID of the removed website group and a success message confirming the removal. - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-LMWebsiteGroup -Id 123 -Removes the website group with ID 123. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Remove-LMWebsiteGroup -Name "MyGroup" -DeleteHostsandChildren $true -Removes the website group named "MyGroup" and all its child items. - - - - - - - - - - Send-LMLogMessage - Send - LMLogMessage - - Sends log messages to LogicMonitor. - - - - The Send-LMLogMessage function sends log messages to LogicMonitor for logging and monitoring purposes. It supports sending a single message or an array of messages. - - - Send-LMLogMessage - - Message + Set-LMDeviceDatasourceInstance + + DisplayName - Specifies the log message to send. This parameter is mandatory when using the 'SingleMessage' parameter set. + Specifies the new display name for the instance. String @@ -54509,9 +74950,9 @@ Removes the website group named "MyGroup" and all its child items. None - Timestamp + WildValue - Specifies the timestamp for the log message. If not provided, the current UTC timestamp will be used. This parameter is mandatory when using the 'SingleMessage' parameter set. + Specifies the first wild value for the instance. String @@ -54520,200 +74961,82 @@ Removes the website group named "MyGroup" and all its child items. None - - resourceMapping + + WildValue2 - Specifies the resource mapping for the log message. This parameter is mandatory when using the 'SingleMessage' parameter set. + Specifies the second wild value for the instance. - Hashtable + String - Hashtable + String None - Metadata + Description - Specifies additional metadata to include with the log message. This parameter is optional when using the 'SingleMessage' parameter set. + Specifies the description for the instance. - Hashtable + String - Hashtable + String None - - ProgressAction + + Properties - {{ Fill ProgressAction Description }} + Specifies a hashtable of custom properties for the instance. - ActionPreference + Hashtable - ActionPreference + Hashtable None - - - Send-LMLogMessage - - MessageArray + + PropertiesMethod - Specifies an array of log messages to send. This parameter is mandatory when using the 'MessageList' parameter set. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". - Object + String - Object + String - None + Replace - - ProgressAction + + StopMonitoring - {{ Fill ProgressAction Description }} + Specifies whether to stop monitoring the instance. - ActionPreference + Boolean - ActionPreference + Boolean + + + None + + + DisableAlerting + + Specifies whether to disable alerting for the instance. + + Boolean + + Boolean None - - - - - Message - - Specifies the log message to send. This parameter is mandatory when using the 'SingleMessage' parameter set. - - String - - String - - - None - - - Timestamp - - Specifies the timestamp for the log message. If not provided, the current UTC timestamp will be used. This parameter is mandatory when using the 'SingleMessage' parameter set. - - String - - String - - - None - - - resourceMapping - - Specifies the resource mapping for the log message. This parameter is mandatory when using the 'SingleMessage' parameter set. - - Hashtable - - Hashtable - - - None - - - Metadata - - Specifies additional metadata to include with the log message. This parameter is optional when using the 'SingleMessage' parameter set. - - Hashtable - - Hashtable - - - None - - - MessageArray - - Specifies an array of log messages to send. This parameter is mandatory when using the 'MessageList' parameter set. - - Object - - Object - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - - Outputs a success message if the log message was accepted successfully, or an error message if the operation failed. - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Send-LMLogMessage -Message "This is a test log message" -resourceMapping @{ 'system.deviceId' = '12345' } -Metadata @{ 'key1' = 'value1' } -Sends a single log message with the specified message, resource mapping, and metadata. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Send-LMLogMessage -MessageArray $MessageObjectsArray -Sends an array of log message objects. - - - - - - - - - - Send-LMPushMetric - Send - LMPushMetric - - Sends a push metric to LogicMonitor. - - - - The Send-LMPushMetric function sends a push metric to LogicMonitor. It allows you to create a new resource or update an existing resource with the specified metric data. - - - - Send-LMPushMetric - NewResourceHostName + InstanceGroupId - Specifies the hostname of the new resource to be created. This parameter is required if you want to create a new resource. + Specifies the ID of the instance group to which the instance belongs. String @@ -54722,10 +75045,10 @@ Sends an array of log message objects. None - - NewResourceDescription + + InstanceId - Specifies the description of the new resource to be created. This parameter is required if you want to create a new resource. + Specifies the ID of the instance to update. String @@ -54735,33 +75058,70 @@ Sends an array of log message objects. None - ResourceIds + DatasourceName - Specifies the resource IDs to use for resource mapping. This parameter is mandatory. + Specifies the name of the datasource associated with the instance. - Hashtable + String - Hashtable + String None - - ResourceProperties + + Id - Specifies the properties of the resources to be updated. This parameter is optional. + Specifies the ID of the device associated with the instance. - Hashtable + String - Hashtable + String None - - DatasourceId + + WhatIf - Specifies the ID of the datasource. This parameter is required if the datasource name is not specified. + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Set-LMDeviceDatasourceInstance + + DisplayName + + Specifies the new display name for the instance. String @@ -54771,9 +75131,9 @@ Sends an array of log message objects. None - DatasourceDisplayName + WildValue - Specifies the display name of the datasource. This parameter is optional and defaults to the datasource name if not specified. + Specifies the first wild value for the instance. String @@ -54783,9 +75143,9 @@ Sends an array of log message objects. None - DatasourceGroup + WildValue2 - Specifies the group of the datasource. This parameter is optional and defaults to "PushModules" if not specified. + Specifies the second wild value for the instance. String @@ -54794,85 +75154,82 @@ Sends an array of log message objects. None - - Instances + + Description - Specifies the instances of the resources to be updated. This parameter is mandatory and should contain results from the New-LMPushMetricInstance function. + Specifies the description for the instance. - System.Collections.Generic.List`1[System.Object] + String - System.Collections.Generic.List`1[System.Object] + String None - - ProgressAction + + Properties - {{ Fill ProgressAction Description }} + Specifies a hashtable of custom properties for the instance. - ActionPreference + Hashtable - ActionPreference + Hashtable None - - - Send-LMPushMetric - NewResourceHostName + PropertiesMethod - Specifies the hostname of the new resource to be created. This parameter is required if you want to create a new resource. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". String String - None + Replace - NewResourceDescription + StopMonitoring - Specifies the description of the new resource to be created. This parameter is required if you want to create a new resource. + Specifies whether to stop monitoring the instance. - String + Boolean - String + Boolean None - - ResourceIds + + DisableAlerting - Specifies the resource IDs to use for resource mapping. This parameter is mandatory. + Specifies whether to disable alerting for the instance. - Hashtable + Boolean - Hashtable + Boolean None - ResourceProperties + InstanceGroupId - Specifies the properties of the resources to be updated. This parameter is optional. + Specifies the ID of the instance group to which the instance belongs. - Hashtable + String - Hashtable + String None - - DatasourceName + + InstanceId - Specifies the name of the datasource. This parameter is required if the datasource ID is not specified. + Specifies the ID of the instance to update. String @@ -54881,10 +75238,10 @@ Sends an array of log message objects. None - - DatasourceDisplayName + + DatasourceId - Specifies the display name of the datasource. This parameter is optional and defaults to the datasource name if not specified. + Specifies the ID of the datasource associated with the instance. String @@ -54893,10 +75250,10 @@ Sends an array of log message objects. None - - DatasourceGroup + + Name - Specifies the group of the datasource. This parameter is optional and defaults to "PushModules" if not specified. + Specifies the name of the device associated with the instance. String @@ -54905,17 +75262,27 @@ Sends an array of log message objects. None - - Instances + + WhatIf - Specifies the instances of the resources to be updated. This parameter is mandatory and should contain results from the New-LMPushMetricInstance function. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - System.Collections.Generic.List`1[System.Object] - System.Collections.Generic.List`1[System.Object] + SwitchParameter - None + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False ProgressAction @@ -54930,179 +75297,24 @@ Sends an array of log message objects. None - - - - NewResourceHostName - - Specifies the hostname of the new resource to be created. This parameter is required if you want to create a new resource. - - String - - String - - - None - - - NewResourceDescription - - Specifies the description of the new resource to be created. This parameter is required if you want to create a new resource. - - String - - String - - - None - - - ResourceIds - - Specifies the resource IDs to use for resource mapping. This parameter is mandatory. - - Hashtable - - Hashtable - - - None - - - ResourceProperties - - Specifies the properties of the resources to be updated. This parameter is optional. - - Hashtable - - Hashtable - - - None - - - DatasourceId - - Specifies the ID of the datasource. This parameter is required if the datasource name is not specified. - - String - - String - - - None - - - DatasourceName - - Specifies the name of the datasource. This parameter is required if the datasource ID is not specified. - - String - - String - - - None - - - DatasourceDisplayName - - Specifies the display name of the datasource. This parameter is optional and defaults to the datasource name if not specified. - - String - - String - - - None - - - DatasourceGroup - - Specifies the group of the datasource. This parameter is optional and defaults to "PushModules" if not specified. - - String - - String - - - None - - - Instances - - Specifies the instances of the resources to be updated. This parameter is mandatory and should contain results from the New-LMPushMetricInstance function. - - System.Collections.Generic.List`1[System.Object] - - System.Collections.Generic.List`1[System.Object] - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - - This function requires a valid API authentication. Make sure you are logged in before running any commands using Connect-LMAccount. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Send-LMPushMetric -NewResourceHostName "NewResource" -NewResourceDescription "New Resource Description" -ResourceIds @{"system.deviceId"="12345"} -ResourceProperties @{"Property1"="Value1"} -DatasourceId "123" -Instances $Instances -Creates a new resource and sends metric data for the specified instances. - - - - - - - - - - Set-LMAccessGroup - Set - LMAccessGroup - - Sets the properties of a LogicMonitor access group. - - - - The Set-LMAccessGroup function is used to set the properties of a LogicMonitor access group. It allows you to specify the access group either by its ID or by its name. You can set the new name, description, and tenant ID for the access group. - - - Set-LMAccessGroup - - Id + Set-LMDeviceDatasourceInstance + + DisplayName - Specifies the ID of the access group. This parameter is used when you want to set the properties of the access group by its ID. + Specifies the new display name for the instance. - Int32 + String - Int32 + String - 0 + None - NewName + WildValue - Specifies the new name for the access group. + Specifies the first wild value for the instance. String @@ -55112,9 +75324,9 @@ Creates a new resource and sends metric data for the specified instances.None - Description + WildValue2 - Specifies the new description for the access group. + Specifies the second wild value for the instance. String @@ -55124,9 +75336,9 @@ Creates a new resource and sends metric data for the specified instances.None - Tenant + Description - Specifies the tenant ID for the access group. + Specifies the description for the instance. String @@ -55135,37 +75347,58 @@ Creates a new resource and sends metric data for the specified instances. None - - ProgressAction + + Properties - {{ Fill ProgressAction Description }} + Specifies a hashtable of custom properties for the instance. - ActionPreference + Hashtable - ActionPreference + Hashtable None - - - Set-LMAccessGroup - Name + PropertiesMethod - Specifies the name of the access group. This parameter is used when you want to set the properties of the access group by its name. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". String String + Replace + + + StopMonitoring + + Specifies whether to stop monitoring the instance. + + Boolean + + Boolean + + None - NewName + DisableAlerting - Specifies the new name for the access group. + Specifies whether to disable alerting for the instance. + + Boolean + + Boolean + + + None + + + InstanceGroupId + + Specifies the ID of the instance group to which the instance belongs. String @@ -55174,10 +75407,10 @@ Creates a new resource and sends metric data for the specified instances. None - - Description + + InstanceId - Specifies the new description for the access group. + Specifies the ID of the instance to update. String @@ -55186,10 +75419,22 @@ Creates a new resource and sends metric data for the specified instances. None - - Tenant + + DatasourceId - Specifies the tenant ID for the access group. + Specifies the ID of the datasource associated with the instance. + + String + + String + + + None + + + Id + + Specifies the ID of the device associated with the instance. String @@ -55198,6 +75443,28 @@ Creates a new resource and sends metric data for the specified instances. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -55213,22 +75480,106 @@ Creates a new resource and sends metric data for the specified instances. - - Id + + DisplayName + + Specifies the new display name for the instance. + + String + + String + + + None + + + WildValue + + Specifies the first wild value for the instance. + + String + + String + + + None + + + WildValue2 + + Specifies the second wild value for the instance. + + String + + String + + + None + + + Description + + Specifies the description for the instance. + + String + + String + + + None + + + Properties + + Specifies a hashtable of custom properties for the instance. + + Hashtable + + Hashtable + + + None + + + PropertiesMethod - Specifies the ID of the access group. This parameter is used when you want to set the properties of the access group by its ID. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". - Int32 + String - Int32 + String - 0 + Replace - Name + StopMonitoring - Specifies the name of the access group. This parameter is used when you want to set the properties of the access group by its name. + Specifies whether to stop monitoring the instance. + + Boolean + + Boolean + + + None + + + DisableAlerting + + Specifies whether to disable alerting for the instance. + + Boolean + + Boolean + + + None + + + InstanceGroupId + + Specifies the ID of the instance group to which the instance belongs. String @@ -55237,10 +75588,10 @@ Creates a new resource and sends metric data for the specified instances. None - - NewName + + InstanceId - Specifies the new name for the access group. + Specifies the ID of the instance to update. String @@ -55249,10 +75600,10 @@ Creates a new resource and sends metric data for the specified instances. None - - Description + + DatasourceName - Specifies the new description for the access group. + Specifies the name of the datasource associated with the instance. String @@ -55261,10 +75612,34 @@ Creates a new resource and sends metric data for the specified instances. None - - Tenant + + DatasourceId - Specifies the tenant ID for the access group. + Specifies the ID of the datasource associated with the instance. + + String + + String + + + None + + + Id + + Specifies the ID of the device associated with the instance. + + String + + String + + + None + + + Name + + Specifies the name of the device associated with the instance. String @@ -55273,6 +75648,30 @@ Creates a new resource and sends metric data for the specified instances. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction @@ -55286,26 +75685,36 @@ Creates a new resource and sends metric data for the specified instances.None - - + + + + You can pipe objects containing InstanceId, DatasourceId, and Id properties to this function. + + + + + + + + + + Returns a LogicMonitor.DeviceDatasourceInstance object containing the updated instance information. + + + + + + - This function requires you to be logged in and have valid API credentials. Use the Connect-LMAccount function to log in before running this command. + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Set-LMAccessGroup -Id 123 -NewName "New Access Group" -Description "This is a new access group" -Tenant "abc123" -Sets the properties of the access group with ID 123. The new name is set to "New Access Group", the description is set to "This is a new access group", and the tenant ID is set to "abc123". - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Set-LMAccessGroup -Name "Old Access Group" -NewName "New Access Group" -Description "This is a new access group" -Tenant "abc123" -Sets the properties of the access group with name "Old Access Group". The new name is set to "New Access Group", the description is set to "This is a new access group", and the tenant ID is set to "abc123". + Set-LMDeviceDatasourceInstance -InstanceId 123 -DisplayName "Updated Instance" -Description "New description" +Updates the instance with ID 123 with a new display name and description. @@ -55315,35 +75724,59 @@ Sets the properties of the access group with name "Old Access Group". The new na - Set-LMAlertRule + Set-LMDeviceDatasourceInstanceAlertSetting Set - LMAlertRule + LMDeviceDatasourceInstanceAlertSetting - Updates a LogicMonitor alert rule configuration. + Updates alert settings for a LogicMonitor device datasource instance. - The Set-LMAlertRule function modifies an existing alert rule in LogicMonitor. + The Set-LMDeviceDatasourceInstanceAlertSetting function modifies alert settings for a specific device datasource instance in LogicMonitor. - Set-LMAlertRule + Set-LMDeviceDatasourceInstanceAlertSetting - Id + DatasourceName - Specifies the ID of the alert rule to modify. + Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. - Int32 + String - Int32 + String - 0 + None - - NewName + + Name - {{ Fill NewName Description }} + Specifies the name of the device. Can be specified using the 'DeviceName' alias. + + String + + String + + + None + + + DatapointName + + Specifies the name of the datapoint for which to configure alerts. + + String + + String + + + None + + + InstanceName + + Specifies the name of the instance for which to configure alerts. String @@ -55353,9 +75786,45 @@ Sets the properties of the access group with name "Old Access Group". The new na None - Priority + DisableAlerting - Specifies the priority level for the alert rule. Valid values: "High", "Medium", "Low". + Specifies whether to disable alerting for this instance. + + Boolean + + Boolean + + + None + + + AlertExpressionNote + + Specifies a note for the alert expression. + + String + + String + + + None + + + AlertExpression + + Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + + String + + String + + + None + + + AlertClearTransitionInterval + + Specifies the interval for alert clear transitions. Must be between 0 and 60. Int32 @@ -55364,10 +75833,10 @@ Sets the properties of the access group with name "Old Access Group". The new na 0 - - EscalatingChainId + + AlertTransitionInterval - Specifies the ID of the escalation chain to use. + Specifies the interval for alert transitions. Must be between 0 and 60. Int32 @@ -55376,10 +75845,10 @@ Sets the properties of the access group with name "Old Access Group". The new na 0 - - EscalationInterval + + AlertForNoData - Specifies the escalation interval in minutes. + Specifies the alert level for no data conditions. Must be between 1 and 4. Int32 @@ -55388,46 +75857,47 @@ Sets the properties of the access group with name "Old Access Group". The new na 0 - - ResourceProperties + + WhatIf - Specifies resource properties to filter on. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Hashtable - Hashtable + SwitchParameter - None + False - - Devices + + Confirm - Specifies an array of device display names to apply the rule to. + Prompts you for confirmation before running the cmdlet. - String[] - String[] + SwitchParameter - None + False - - DeviceGroups + + ProgressAction - Specifies an array of device group full paths to apply the rule to. + {{ Fill ProgressAction Description }} - String[] + ActionPreference - String[] + ActionPreference None - - DataSource + + + Set-LMDeviceDatasourceInstanceAlertSetting + + DatasourceName - Specifies the datasource name to apply the rule to. + Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. String @@ -55436,22 +75906,22 @@ Sets the properties of the access group with name "Old Access Group". The new na None - - DataSourceInstanceName + + Id - Specifies the instance name to apply the rule to. + Specifies the ID of the device. Can be specified using the 'DeviceId' alias. - String + Int32 - String + Int32 - None + 0 - - DataPoint + + DatapointName - Specifies the datapoint name to apply the rule to. + Specifies the name of the datapoint for which to configure alerts. String @@ -55460,34 +75930,34 @@ Sets the properties of the access group with name "Old Access Group". The new na None - - SuppressAlertClear + + InstanceName - Indicates whether to suppress alert clear notifications. + Specifies the name of the instance for which to configure alerts. - Boolean + String - Boolean + String - False + None - SuppressAlertAckSdt + DisableAlerting - Indicates whether to suppress alert acknowledgement and SDT notifications. + Specifies whether to disable alerting for this instance. Boolean Boolean - False + None - LevelStr + AlertExpressionNote - Specifies the level string for the alert rule. Valid values: "All", "Critical", "Error", "Warning". + Specifies a note for the alert expression. String @@ -55496,10 +75966,10 @@ Sets the properties of the access group with name "Old Access Group". The new na None - - Description + + AlertExpression - Specifies the description for the alert rule. + Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". String @@ -55508,6 +75978,42 @@ Sets the properties of the access group with name "Old Access Group". The new na None + + AlertClearTransitionInterval + + Specifies the interval for alert clear transitions. Must be between 0 and 60. + + Int32 + + Int32 + + + 0 + + + AlertTransitionInterval + + Specifies the interval for alert transitions. Must be between 0 and 60. + + Int32 + + Int32 + + + 0 + + + AlertForNoData + + Specifies the alert level for no data conditions. Must be between 1 and 4. + + Int32 + + Int32 + + + 0 + WhatIf @@ -55544,11 +76050,11 @@ Sets the properties of the access group with name "Old Access Group". The new na - Set-LMAlertRule - - Id + Set-LMDeviceDatasourceInstanceAlertSetting + + DatasourceId - Specifies the ID of the alert rule to modify. + Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. Int32 @@ -55557,10 +76063,10 @@ Sets the properties of the access group with name "Old Access Group". The new na 0 - + Name - Specifies the name for the alert rule. + Specifies the name of the device. Can be specified using the 'DeviceName' alias. String @@ -55569,10 +76075,22 @@ Sets the properties of the access group with name "Old Access Group". The new na None - - NewName + + DatapointName - {{ Fill NewName Description }} + Specifies the name of the datapoint for which to configure alerts. + + String + + String + + + None + + + InstanceName + + Specifies the name of the instance for which to configure alerts. String @@ -55582,9 +76100,45 @@ Sets the properties of the access group with name "Old Access Group". The new na None - Priority + DisableAlerting - Specifies the priority level for the alert rule. Valid values: "High", "Medium", "Low". + Specifies whether to disable alerting for this instance. + + Boolean + + Boolean + + + None + + + AlertExpressionNote + + Specifies a note for the alert expression. + + String + + String + + + None + + + AlertExpression + + Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + + String + + String + + + None + + + AlertClearTransitionInterval + + Specifies the interval for alert clear transitions. Must be between 0 and 60. Int32 @@ -55593,10 +76147,10 @@ Sets the properties of the access group with name "Old Access Group". The new na 0 - - EscalatingChainId + + AlertTransitionInterval - Specifies the ID of the escalation chain to use. + Specifies the interval for alert transitions. Must be between 0 and 60. Int32 @@ -55605,10 +76159,10 @@ Sets the properties of the access group with name "Old Access Group". The new na 0 - - EscalationInterval + + AlertForNoData - Specifies the escalation interval in minutes. + Specifies the alert level for no data conditions. Must be between 1 and 4. Int32 @@ -55617,46 +76171,83 @@ Sets the properties of the access group with name "Old Access Group". The new na 0 - - ResourceProperties + + WhatIf - Specifies resource properties to filter on. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Hashtable - Hashtable + SwitchParameter - None + False - - Devices + + Confirm - Specifies an array of device display names to apply the rule to. + Prompts you for confirmation before running the cmdlet. - String[] - String[] + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference None - - DeviceGroups + + + Set-LMDeviceDatasourceInstanceAlertSetting + + DatasourceId - Specifies an array of device group full paths to apply the rule to. + Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. - String[] + Int32 + + Int32 + + + 0 + + + Id + + Specifies the ID of the device. Can be specified using the 'DeviceId' alias. + + Int32 + + Int32 + + + 0 + + + DatapointName + + Specifies the name of the datapoint for which to configure alerts. + + String - String[] + String None - - DataSource + + InstanceName - Specifies the datasource name to apply the rule to. + Specifies the name of the instance for which to configure alerts. String @@ -55666,21 +76257,21 @@ Sets the properties of the access group with name "Old Access Group". The new na None - DataSourceInstanceName + DisableAlerting - Specifies the instance name to apply the rule to. + Specifies whether to disable alerting for this instance. - String + Boolean - String + Boolean None - DataPoint + AlertExpressionNote - Specifies the datapoint name to apply the rule to. + Specifies a note for the alert expression. String @@ -55689,53 +76280,53 @@ Sets the properties of the access group with name "Old Access Group". The new na None - - SuppressAlertClear + + AlertExpression - Indicates whether to suppress alert clear notifications. + Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". - Boolean + String - Boolean + String - False + None - - SuppressAlertAckSdt + + AlertClearTransitionInterval - Indicates whether to suppress alert acknowledgement and SDT notifications. + Specifies the interval for alert clear transitions. Must be between 0 and 60. - Boolean + Int32 - Boolean + Int32 - False + 0 - - LevelStr + + AlertTransitionInterval - Specifies the level string for the alert rule. Valid values: "All", "Critical", "Error", "Warning". + Specifies the interval for alert transitions. Must be between 0 and 60. - String + Int32 - String + Int32 - None + 0 - - Description + + AlertForNoData - Specifies the description for the alert rule. + Specifies the alert level for no data conditions. Must be between 1 and 4. - String + Int32 - String + Int32 - None + 0 WhatIf @@ -55775,33 +76366,9 @@ Sets the properties of the access group with name "Old Access Group". The new na - Id - - Specifies the ID of the alert rule to modify. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the name for the alert rule. - - String - - String - - - None - - - NewName + DatasourceName - {{ Fill NewName Description }} + Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. String @@ -55810,22 +76377,10 @@ Sets the properties of the access group with name "Old Access Group". The new na None - - Priority - - Specifies the priority level for the alert rule. Valid values: "High", "Medium", "Low". - - Int32 - - Int32 - - - 0 - - - EscalatingChainId + + DatasourceId - Specifies the ID of the escalation chain to use. + Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. Int32 @@ -55834,10 +76389,10 @@ Sets the properties of the access group with name "Old Access Group". The new na 0 - - EscalationInterval + + Id - Specifies the escalation interval in minutes. + Specifies the ID of the device. Can be specified using the 'DeviceId' alias. Int32 @@ -55846,58 +76401,58 @@ Sets the properties of the access group with name "Old Access Group". The new na 0 - - ResourceProperties + + Name - Specifies resource properties to filter on. + Specifies the name of the device. Can be specified using the 'DeviceName' alias. - Hashtable + String - Hashtable + String None - - Devices + + DatapointName - Specifies an array of device display names to apply the rule to. + Specifies the name of the datapoint for which to configure alerts. - String[] + String - String[] + String None - - DeviceGroups + + InstanceName - Specifies an array of device group full paths to apply the rule to. + Specifies the name of the instance for which to configure alerts. - String[] + String - String[] + String None - DataSource + DisableAlerting - Specifies the datasource name to apply the rule to. + Specifies whether to disable alerting for this instance. - String + Boolean - String + Boolean None - DataSourceInstanceName + AlertExpressionNote - Specifies the instance name to apply the rule to. + Specifies a note for the alert expression. String @@ -55906,10 +76461,10 @@ Sets the properties of the access group with name "Old Access Group". The new na None - - DataPoint + + AlertExpression - Specifies the datapoint name to apply the rule to. + Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". String @@ -55918,53 +76473,41 @@ Sets the properties of the access group with name "Old Access Group". The new na None - - SuppressAlertClear - - Indicates whether to suppress alert clear notifications. - - Boolean - - Boolean - - - False - - - SuppressAlertAckSdt + + AlertClearTransitionInterval - Indicates whether to suppress alert acknowledgement and SDT notifications. + Specifies the interval for alert clear transitions. Must be between 0 and 60. - Boolean + Int32 - Boolean + Int32 - False + 0 - - LevelStr + + AlertTransitionInterval - Specifies the level string for the alert rule. Valid values: "All", "Critical", "Error", "Warning". + Specifies the interval for alert transitions. Must be between 0 and 60. - String + Int32 - String + Int32 - None + 0 - - Description + + AlertForNoData - Specifies the description for the alert rule. + Specifies the alert level for no data conditions. Must be between 1 and 4. - String + Int32 - String + Int32 - None + 0 WhatIf @@ -56006,7 +76549,7 @@ Sets the properties of the access group with name "Old Access Group". The new na - You can pipe alert rule objects containing Id properties to this function. + None. @@ -56016,7 +76559,7 @@ Sets the properties of the access group with name "Old Access Group". The new na - Returns the response from the API containing the updated alert rule information. + Returns a LogicMonitor.AlertSetting object containing the updated alert settings. @@ -56031,8 +76574,8 @@ Sets the properties of the access group with name "Old Access Group". The new na -------------------------- EXAMPLE 1 -------------------------- - Set-LMAlertRule -Id 123 -Name "Updated Rule" -Priority 100 -EscalatingChainId 456 -Updates the alert rule with new name, priority and escalation chain. + 90" +Updates the alert settings for the CPU Usage datapoint on the specified device. @@ -56042,47 +76585,47 @@ Updates the alert rule with new name, priority and escalation chain. - Set-LMAPIToken + Set-LMDeviceGroup Set - LMAPIToken + LMDeviceGroup - Updates a LogicMonitor API token's properties. + Updates a LogicMonitor device group configuration. - The Set-LMAPIToken function modifies the properties of an existing API token in LogicMonitor, including its note and status. + The Set-LMDeviceGroup function modifies an existing device group in LogicMonitor, allowing updates to its name, description, properties, and various other settings. - Set-LMAPIToken + Set-LMDeviceGroup - AdminId + Id - Specifies the ID of the admin user who owns the token. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the device group to modify. - Int32 + String - Int32 + String - 0 + None - - Id + + NewName - Specifies the ID of the API token to modify. + Specifies the new name for the device group. - Int32 + String - Int32 + String - 0 + None - Note + Description - Specifies a new note for the API token. + Specifies the new description for the device group. String @@ -56092,82 +76635,105 @@ Updates the alert rule with new name, priority and escalation chain. None - Status + Properties - Specifies the new status for the API token. Valid values are "active" or "suspended". + Specifies a hashtable of custom properties for the device group. - String + Hashtable - String + Hashtable None - - WhatIf + + Extra - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies a object of extra properties for the device group. Used for LM Cloud resource groups + Object - SwitchParameter + Object - False + None - - Confirm + + DefaultCollectorId - Prompts you for confirmation before running the cmdlet. + {{ Fill DefaultCollectorId Description }} + Int32 - SwitchParameter + Int32 - False + None - - ProgressAction + + DefaultAutoBalancedCollectorGroupId - {{ Fill ProgressAction Description }} + {{ Fill DefaultAutoBalancedCollectorGroupId Description }} - ActionPreference + Int32 - ActionPreference + Int32 None - - - Set-LMAPIToken - - AdminName + + DefaultCollectorGroupId - Specifies the name of the admin user who owns the token. This parameter is mandatory when using the 'Name' parameter set. + {{ Fill DefaultCollectorGroupId Description }} + + Int32 + + Int32 + + + None + + + PropertiesMethod + + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". String String + Replace + + + DisableAlerting + + Specifies whether to disable alerting for the device group. + + Boolean + + Boolean + + None - - Id + + EnableNetFlow - Specifies the ID of the API token to modify. + Specifies whether to enable NetFlow for the device group. - Int32 + Boolean - Int32 + Boolean - 0 + None - Note + AppliesTo - Specifies a new note for the API token. + Specifies the applies to expression for the device group. String @@ -56177,13 +76743,13 @@ Updates the alert rule with new name, priority and escalation chain. None - Status + ParentGroupId - Specifies the new status for the API token. Valid values are "active" or "suspended". + Specifies the ID of the parent group. - String + Int32 - String + Int32 None @@ -56209,175 +76775,26 @@ Updates the alert rule with new name, priority and escalation chain. False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - AdminId - - Specifies the ID of the admin user who owns the token. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - AdminName - - Specifies the name of the admin user who owns the token. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - Id - - Specifies the ID of the API token to modify. - - Int32 - - Int32 - - - 0 - - - Note - - Specifies a new note for the API token. - - String - - String - - - None - - - Status - - Specifies the new status for the API token. Valid values are "active" or "suspended". - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe objects containing AdminId and Id properties to this function. - - - - - - - - - - Returns a LogicMonitor.APIToken object containing the updated token information. - - - - - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMAPIToken -AdminId 123 -Id 456 -Note "Updated token" -Status "suspended" -Updates the API token with ID 456 owned by admin 123 with a new note and status. - - - - - - - - - - Set-LMAppliesToFunction - Set - LMAppliesToFunction - - Updates a LogicMonitor AppliesTo function. - - - - The Set-LMAppliesToFunction function modifies an existing AppliesTo function in LogicMonitor, allowing updates to its name, description, and AppliesTo code. - - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + - Set-LMAppliesToFunction - - Name + Set-LMDeviceGroup + + Id - Specifies the current name of the AppliesTo function. This parameter is mandatory when using the 'Name' parameter set. + Specifies the ID of the device group to modify. String @@ -56389,7 +76806,7 @@ Updates the API token with ID 456 owned by admin 123 with a new note and status. NewName - Specifies the new name for the AppliesTo function. + Specifies the new name for the device group. String @@ -56401,7 +76818,7 @@ Updates the API token with ID 456 owned by admin 123 with a new note and status. Description - Specifies a new description for the AppliesTo function. + Specifies the new description for the device group. String @@ -56411,82 +76828,105 @@ Updates the API token with ID 456 owned by admin 123 with a new note and status. None - AppliesTo + Properties - Specifies the new AppliesTo code for the function. + Specifies a hashtable of custom properties for the device group. - String + Hashtable - String + Hashtable None - - WhatIf + + Extra - Shows what would happen if the cmdlet runs. The cmdlet is not run. + Specifies a object of extra properties for the device group. Used for LM Cloud resource groups + Object - SwitchParameter + Object - False + None - - Confirm + + DefaultCollectorId - Prompts you for confirmation before running the cmdlet. + {{ Fill DefaultCollectorId Description }} + Int32 - SwitchParameter + Int32 - False + None - - ProgressAction + + DefaultAutoBalancedCollectorGroupId - {{ Fill ProgressAction Description }} + {{ Fill DefaultAutoBalancedCollectorGroupId Description }} - ActionPreference + Int32 - ActionPreference + Int32 None - - - Set-LMAppliesToFunction - NewName + DefaultCollectorGroupId - Specifies the new name for the AppliesTo function. + {{ Fill DefaultCollectorGroupId Description }} - String + Int32 - String + Int32 None - - Id + + PropertiesMethod - Specifies the ID of the AppliesTo function to modify. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". String String + Replace + + + DisableAlerting + + Specifies whether to disable alerting for the device group. + + Boolean + + Boolean + + None - Description + EnableNetFlow - Specifies a new description for the AppliesTo function. + Specifies whether to enable NetFlow for the device group. + + Boolean + + Boolean + + + None + + + AppliesTo + + Specifies the applies to expression for the device group. String @@ -56496,9 +76936,9 @@ Updates the API token with ID 456 owned by admin 123 with a new note and status. None - AppliesTo + ParentGroupName - Specifies the new AppliesTo code for the function. + Specifies the name of the parent group. String @@ -56542,173 +76982,24 @@ Updates the API token with ID 456 owned by admin 123 with a new note and status. None - - - - Name - - Specifies the current name of the AppliesTo function. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - NewName - - Specifies the new name for the AppliesTo function. - - String - - String - - - None - - - Id - - Specifies the ID of the AppliesTo function to modify. - - String - - String - - - None - - - Description - - Specifies a new description for the AppliesTo function. - - String - - String - - - None - - - AppliesTo - - Specifies the new AppliesTo code for the function. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe objects containing Id properties to this function. - - - - - - - - - - Returns a LogicMonitor.AppliesToFunction object containing the updated function information. - - - - - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMAppliesToFunction -Id 123 -NewName "UpdatedFunction" -Description "New description" -Updates the AppliesTo function with ID 123 with a new name and description. - - - - - - - - - - Set-LMCollector - Set - LMCollector - - Updates a LogicMonitor collector's configuration. - - - - The Set-LMCollector function modifies an existing collector's settings in LogicMonitor, including its description, backup agent, group, and various properties. - - - Set-LMCollector - - Id + Set-LMDeviceGroup + + Name - Specifies the ID of the collector to modify. This parameter is mandatory when using the 'Id' parameter set. + Specifies the current name of the device group. - Int32 + String - Int32 + String - 0 + None - Description + NewName - Specifies a new description for the collector. + Specifies the new name for the device group. String @@ -56718,69 +77009,69 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - BackupAgentId + Description - Specifies the ID of the backup collector. + Specifies the new description for the device group. - Int32 + String - Int32 + String None - CollectorGroupId + Properties - Specifies the ID of the collector group to which this collector should belong. + Specifies a hashtable of custom properties for the device group. - Int32 + Hashtable - Int32 + Hashtable None - Properties + Extra - Specifies a hashtable of custom properties to set for the collector. + Specifies a object of extra properties for the device group. Used for LM Cloud resource groups - Hashtable + Object - Hashtable + Object None - EnableFailBack + DefaultCollectorId - Specifies whether to enable fail-back functionality. + {{ Fill DefaultCollectorId Description }} - Boolean + Int32 - Boolean + Int32 None - EnableFailOverOnCollectorDevice + DefaultAutoBalancedCollectorGroupId - Specifies whether to enable fail-over on the collector device. + {{ Fill DefaultAutoBalancedCollectorGroupId Description }} - Boolean + Int32 - Boolean + Int32 None - EscalatingChainId + DefaultCollectorGroupId - Specifies the ID of the escalation chain. + {{ Fill DefaultCollectorGroupId Description }} Int32 @@ -56790,9 +77081,21 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - SuppressAlertClear + PropertiesMethod - Specifies whether to suppress alert clear notifications. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + + String + + String + + + Replace + + + DisableAlerting + + Specifies whether to disable alerting for the device group. Boolean @@ -56802,25 +77105,37 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - ResendAlertInterval + EnableNetFlow - Specifies the interval for resending alerts. + Specifies whether to enable NetFlow for the device group. - Int32 + Boolean - Int32 + Boolean None - SpecifiedCollectorDeviceGroupId + AppliesTo - Specifies the ID of the device group for the collector. + Specifies the applies to expression for the device group. - Int32 + String - Int32 + String + + + None + + + ParentGroupName + + Specifies the name of the parent group. + + String + + String None @@ -56861,11 +77176,11 @@ Updates the AppliesTo function with ID 123 with a new name and description. - Set-LMCollector + Set-LMDeviceGroup Name - Specifies the name of the collector to modify. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the device group. String @@ -56875,9 +77190,9 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - Description + NewName - Specifies a new description for the collector. + Specifies the new name for the device group. String @@ -56887,69 +77202,69 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - BackupAgentId + Description - Specifies the ID of the backup collector. + Specifies the new description for the device group. - Int32 + String - Int32 + String None - CollectorGroupId + Properties - Specifies the ID of the collector group to which this collector should belong. + Specifies a hashtable of custom properties for the device group. - Int32 + Hashtable - Int32 + Hashtable None - Properties + Extra - Specifies a hashtable of custom properties to set for the collector. + Specifies a object of extra properties for the device group. Used for LM Cloud resource groups - Hashtable + Object - Hashtable + Object None - EnableFailBack + DefaultCollectorId - Specifies whether to enable fail-back functionality. + {{ Fill DefaultCollectorId Description }} - Boolean + Int32 - Boolean + Int32 None - EnableFailOverOnCollectorDevice + DefaultAutoBalancedCollectorGroupId - Specifies whether to enable fail-over on the collector device. + {{ Fill DefaultAutoBalancedCollectorGroupId Description }} - Boolean + Int32 - Boolean + Int32 None - EscalatingChainId + DefaultCollectorGroupId - Specifies the ID of the escalation chain. + {{ Fill DefaultCollectorGroupId Description }} Int32 @@ -56959,9 +77274,21 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - SuppressAlertClear + PropertiesMethod - Specifies whether to suppress alert clear notifications. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + + String + + String + + + Replace + + + DisableAlerting + + Specifies whether to disable alerting for the device group. Boolean @@ -56971,21 +77298,33 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - ResendAlertInterval + EnableNetFlow - Specifies the interval for resending alerts. + Specifies whether to enable NetFlow for the device group. - Int32 + Boolean - Int32 + Boolean None - SpecifiedCollectorDeviceGroupId + AppliesTo - Specifies the ID of the device group for the collector. + Specifies the applies to expression for the device group. + + String + + String + + + None + + + ParentGroupId + + Specifies the ID of the parent group. Int32 @@ -57034,19 +77373,31 @@ Updates the AppliesTo function with ID 123 with a new name and description. Id - Specifies the ID of the collector to modify. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the device group to modify. - Int32 + String - Int32 + String - 0 + None Name - Specifies the name of the collector to modify. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the device group. + + String + + String + + + None + + + NewName + + Specifies the new name for the device group. String @@ -57058,7 +77409,7 @@ Updates the AppliesTo function with ID 123 with a new name and description. Description - Specifies a new description for the collector. + Specifies the new description for the device group. String @@ -57068,9 +77419,33 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - BackupAgentId + Properties - Specifies the ID of the backup collector. + Specifies a hashtable of custom properties for the device group. + + Hashtable + + Hashtable + + + None + + + Extra + + Specifies a object of extra properties for the device group. Used for LM Cloud resource groups + + Object + + Object + + + None + + + DefaultCollectorId + + {{ Fill DefaultCollectorId Description }} Int32 @@ -57080,9 +77455,9 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - CollectorGroupId + DefaultAutoBalancedCollectorGroupId - Specifies the ID of the collector group to which this collector should belong. + {{ Fill DefaultAutoBalancedCollectorGroupId Description }} Int32 @@ -57092,33 +77467,33 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - Properties + DefaultCollectorGroupId - Specifies a hashtable of custom properties to set for the collector. + {{ Fill DefaultCollectorGroupId Description }} - Hashtable + Int32 - Hashtable + Int32 None - EnableFailBack + PropertiesMethod - Specifies whether to enable fail-back functionality. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". - Boolean + String - Boolean + String - None + Replace - EnableFailOverOnCollectorDevice + DisableAlerting - Specifies whether to enable fail-over on the collector device. + Specifies whether to disable alerting for the device group. Boolean @@ -57128,33 +77503,33 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - EscalatingChainId + EnableNetFlow - Specifies the ID of the escalation chain. + Specifies whether to enable NetFlow for the device group. - Int32 + Boolean - Int32 + Boolean None - SuppressAlertClear + AppliesTo - Specifies whether to suppress alert clear notifications. + Specifies the applies to expression for the device group. - Boolean + String - Boolean + String None - ResendAlertInterval + ParentGroupId - Specifies the interval for resending alerts. + Specifies the ID of the parent group. Int32 @@ -57164,13 +77539,13 @@ Updates the AppliesTo function with ID 123 with a new name and description.None - SpecifiedCollectorDeviceGroupId + ParentGroupName - Specifies the ID of the device group for the collector. + Specifies the name of the parent group. - Int32 + String - Int32 + String None @@ -57225,7 +77600,7 @@ Updates the AppliesTo function with ID 123 with a new name and description. - Returns a LogicMonitor.Collector object containing the updated collector information. + Returns a LogicMonitor.DeviceGroup object containing the updated group information. @@ -57240,8 +77615,8 @@ Updates the AppliesTo function with ID 123 with a new name and description. -------------------------- EXAMPLE 1 -------------------------- - Set-LMCollector -Id 123 -Description "Updated collector" -EnableFailBack $true -Updates the collector with ID 123 with a new description and enables fail-back. + Set-LMDeviceGroup -Id 123 -NewName "Updated Group" -Description "New description" +Updates the device group with ID 123 with a new name and description. @@ -57251,222 +77626,126 @@ Updates the collector with ID 123 with a new description and enables fail-back.< - Set-LMCollectorConfig + Set-LMDeviceGroupDatasourceAlertSetting Set - LMCollectorConfig + LMDeviceGroupDatasourceAlertSetting - Updates a LogicMonitor collector's configuration settings. + Updates alert settings for a LogicMonitor device group datasource. - The Set-LMCollectorConfig function modifies detailed configuration settings for a collector, including SNMP settings, script settings, and various other parameters. This operation will restart the collector. + The Set-LMDeviceGroupDatasourceAlertSetting function modifies alert settings for a specific device group datasource in LogicMonitor. - Set-LMCollectorConfig - - Id + Set-LMDeviceGroupDatasourceAlertSetting + + DatasourceName - Specifies the ID of the collector to configure. + Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. - Int32 + String - Int32 + String - 0 + None - - SnmpThreadPool + + Name - {{ Fill SnmpThreadPool Description }} + Specifies the name of the device group. - Int32 + String - Int32 + String None - - SnmpPduTimeout + + DatapointName - {{ Fill SnmpPduTimeout Description }} + Specifies the name of the datapoint for which to configure alerts. - Int32 + String - Int32 + String None - ScriptThreadPool + DisableAlerting - {{ Fill ScriptThreadPool Description }} + Specifies whether to disable alerting for this datasource. - Int32 + Boolean - Int32 + Boolean None - ScriptTimeout + AlertExpressionNote - {{ Fill ScriptTimeout Description }} + Specifies a note for the alert expression. - Int32 + String - Int32 + String None - - BatchScriptThreadPool + + AlertExpression - {{ Fill BatchScriptThreadPool Description }} + Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". - Int32 + String - Int32 + String None - - BatchScriptTimeout + + AlertClearTransitionInterval - {{ Fill BatchScriptTimeout Description }} + Specifies the interval for alert clear transitions. Must be between 0 and 60. Int32 Int32 - None + 0 - - PowerShellSPSEProcessCountMin + + AlertTransitionInterval - {{ Fill PowerShellSPSEProcessCountMin Description }} + Specifies the interval for alert transitions. Must be between 0 and 60. Int32 Int32 - None + 0 - - PowerShellSPSEProcessCountMax + + AlertForNoData - {{ Fill PowerShellSPSEProcessCountMax Description }} + Specifies the alert level for no data conditions. Must be between 1 and 4. Int32 Int32 - None - - - NetflowEnable - - {{ Fill NetflowEnable Description }} - - Boolean - - Boolean - - - None - - - NbarEnable - - {{ Fill NbarEnable Description }} - - Boolean - - Boolean - - - None - - - NetflowPorts - - {{ Fill NetflowPorts Description }} - - String[] - - String[] - - - None - - - SflowPorts - - {{ Fill SflowPorts Description }} - - String[] - - String[] - - - None - - - LMLogsSyslogEnable - - {{ Fill LMLogsSyslogEnable Description }} - - Boolean - - Boolean - - - None - - - LMLogsSyslogHostnameFormat - - {{ Fill LMLogsSyslogHostnameFormat Description }} - - String - - String - - - None - - - LMLogsSyslogPropertyName - - {{ Fill LMLogsSyslogPropertyName Description }} - - String - - String - - - None - - - WaitForRestart - - Indicates whether to wait for the collector restart to complete. - [Additional parameters for snippet configuration omitted for brevity] - - - SwitchParameter - - - False + 0 WhatIf @@ -57504,11 +77783,23 @@ Updates the collector with ID 123 with a new description and enables fail-back.< - Set-LMCollectorConfig - + Set-LMDeviceGroupDatasourceAlertSetting + + DatasourceName + + Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. + + String + + String + + + None + + Id - Specifies the ID of the collector to configure. + Specifies the ID of the device group. Int32 @@ -57517,10 +77808,10 @@ Updates the collector with ID 123 with a new description and enables fail-back.< 0 - - CollectorSize + + DatapointName - Specifies the size of the collector. Valid values are "nano", "small", "medium", "large", "extra_large", "double_extra_large". + Specifies the name of the datapoint for which to configure alerts. String @@ -57530,21 +77821,21 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - CollectorConf + DisableAlerting - Specifies the collector configuration file content. + Specifies whether to disable alerting for this datasource. - String + Boolean - String + Boolean None - SbproxyConf + AlertExpressionNote - Specifies the sbproxy configuration file content. + Specifies a note for the alert expression. String @@ -57553,10 +77844,10 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - - WatchdogConf + + AlertExpression - Specifies the watchdog configuration file content. + Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". String @@ -57565,41 +77856,41 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - - WebsiteConf + + AlertClearTransitionInterval - Specifies the website configuration file content. + Specifies the interval for alert clear transitions. Must be between 0 and 60. - String + Int32 - String + Int32 - None + 0 - - WrapperConf + + AlertTransitionInterval - Specifies the wrapper configuration file content. + Specifies the interval for alert transitions. Must be between 0 and 60. - String + Int32 - String + Int32 - None + 0 - - WaitForRestart + + AlertForNoData - Indicates whether to wait for the collector restart to complete. - [Additional parameters for snippet configuration omitted for brevity] + Specifies the alert level for no data conditions. Must be between 1 and 4. + Int32 - SwitchParameter + Int32 - False + 0 WhatIf @@ -57637,210 +77928,114 @@ Updates the collector with ID 123 with a new description and enables fail-back.< - Set-LMCollectorConfig - - Name - - Specifies the name of the collector to configure. - - String - - String - - - None - - - SnmpThreadPool + Set-LMDeviceGroupDatasourceAlertSetting + + DatasourceId - {{ Fill SnmpThreadPool Description }} + Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. Int32 Int32 - None + 0 - - SnmpPduTimeout + + Name - {{ Fill SnmpPduTimeout Description }} + Specifies the name of the device group. - Int32 + String - Int32 + String None - - ScriptThreadPool + + DatapointName - {{ Fill ScriptThreadPool Description }} + Specifies the name of the datapoint for which to configure alerts. - Int32 + String - Int32 + String None - ScriptTimeout + DisableAlerting - {{ Fill ScriptTimeout Description }} + Specifies whether to disable alerting for this datasource. - Int32 + Boolean - Int32 + Boolean None - BatchScriptThreadPool + AlertExpressionNote - {{ Fill BatchScriptThreadPool Description }} + Specifies a note for the alert expression. - Int32 + String - Int32 + String None - - BatchScriptTimeout + + AlertExpression - {{ Fill BatchScriptTimeout Description }} + Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". - Int32 + String - Int32 + String None - - PowerShellSPSEProcessCountMin + + AlertClearTransitionInterval - {{ Fill PowerShellSPSEProcessCountMin Description }} + Specifies the interval for alert clear transitions. Must be between 0 and 60. Int32 Int32 - None + 0 - - PowerShellSPSEProcessCountMax + + AlertTransitionInterval - {{ Fill PowerShellSPSEProcessCountMax Description }} + Specifies the interval for alert transitions. Must be between 0 and 60. Int32 Int32 - None - - - NetflowEnable - - {{ Fill NetflowEnable Description }} - - Boolean - - Boolean - - - None - - - NbarEnable - - {{ Fill NbarEnable Description }} - - Boolean - - Boolean - - - None - - - NetflowPorts - - {{ Fill NetflowPorts Description }} - - String[] - - String[] - - - None - - - SflowPorts - - {{ Fill SflowPorts Description }} - - String[] - - String[] - - - None - - - LMLogsSyslogEnable - - {{ Fill LMLogsSyslogEnable Description }} - - Boolean - - Boolean - - - None - - - LMLogsSyslogHostnameFormat - - {{ Fill LMLogsSyslogHostnameFormat Description }} - - String - - String - - - None - - - LMLogsSyslogPropertyName - - {{ Fill LMLogsSyslogPropertyName Description }} - - String - - String - - - None + 0 - - WaitForRestart + + AlertForNoData - Indicates whether to wait for the collector restart to complete. - [Additional parameters for snippet configuration omitted for brevity] + Specifies the alert level for no data conditions. Must be between 1 and 4. + Int32 - SwitchParameter + Int32 - False + 0 WhatIf @@ -57878,23 +78073,35 @@ Updates the collector with ID 123 with a new description and enables fail-back.< - Set-LMCollectorConfig - - Name + Set-LMDeviceGroupDatasourceAlertSetting + + DatasourceId - Specifies the name of the collector to configure. + Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. - String + Int32 - String + Int32 - None + 0 - - CollectorSize + + Id - Specifies the size of the collector. Valid values are "nano", "small", "medium", "large", "extra_large", "double_extra_large". + Specifies the ID of the device group. + + Int32 + + Int32 + + + 0 + + + DatapointName + + Specifies the name of the datapoint for which to configure alerts. String @@ -57904,21 +78111,21 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - CollectorConf + DisableAlerting - Specifies the collector configuration file content. + Specifies whether to disable alerting for this datasource. - String + Boolean - String + Boolean None - SbproxyConf + AlertExpressionNote - Specifies the sbproxy configuration file content. + Specifies a note for the alert expression. String @@ -57927,10 +78134,10 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - - WatchdogConf + + AlertExpression - Specifies the watchdog configuration file content. + Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". String @@ -57939,41 +78146,41 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - - WebsiteConf + + AlertClearTransitionInterval - Specifies the website configuration file content. + Specifies the interval for alert clear transitions. Must be between 0 and 60. - String + Int32 - String + Int32 - None + 0 - - WrapperConf + + AlertTransitionInterval - Specifies the wrapper configuration file content. + Specifies the interval for alert transitions. Must be between 0 and 60. - String + Int32 - String + Int32 - None + 0 - - WaitForRestart + + AlertForNoData - Indicates whether to wait for the collector restart to complete. - [Additional parameters for snippet configuration omitted for brevity] + Specifies the alert level for no data conditions. Must be between 1 and 4. + Int32 - SwitchParameter + Int32 - False + 0 WhatIf @@ -58012,22 +78219,10 @@ Updates the collector with ID 123 with a new description and enables fail-back.< - - Id - - Specifies the ID of the collector to configure. - - Int32 - - Int32 - - - 0 - - - Name + + DatasourceName - Specifies the name of the collector to configure. + Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. String @@ -58036,34 +78231,34 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - - CollectorSize + + DatasourceId - Specifies the size of the collector. Valid values are "nano", "small", "medium", "large", "extra_large", "double_extra_large". + Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. - String + Int32 - String + Int32 - None + 0 - - CollectorConf + + Id - Specifies the collector configuration file content. + Specifies the ID of the device group. - String + Int32 - String + Int32 - None + 0 - - SbproxyConf + + Name - Specifies the sbproxy configuration file content. + Specifies the name of the device group. String @@ -58072,10 +78267,10 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - - WatchdogConf + + DatapointName - Specifies the watchdog configuration file content. + Specifies the name of the datapoint for which to configure alerts. String @@ -58085,21 +78280,21 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - WebsiteConf + DisableAlerting - Specifies the website configuration file content. + Specifies whether to disable alerting for this datasource. - String + Boolean - String + Boolean None - WrapperConf + AlertExpressionNote - Specifies the wrapper configuration file content. + Specifies a note for the alert expression. String @@ -58108,166 +78303,317 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - - SnmpThreadPool - - {{ Fill SnmpThreadPool Description }} - - Int32 - - Int32 - - - None - - - SnmpPduTimeout + + AlertExpression - {{ Fill SnmpPduTimeout Description }} + Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". - Int32 + String - Int32 + String None - - ScriptThreadPool + + AlertClearTransitionInterval - {{ Fill ScriptThreadPool Description }} + Specifies the interval for alert clear transitions. Must be between 0 and 60. Int32 Int32 - None + 0 - - ScriptTimeout + + AlertTransitionInterval - {{ Fill ScriptTimeout Description }} + Specifies the interval for alert transitions. Must be between 0 and 60. Int32 Int32 - None + 0 - - BatchScriptThreadPool + + AlertForNoData - {{ Fill BatchScriptThreadPool Description }} + Specifies the alert level for no data conditions. Must be between 1 and 4. Int32 Int32 - None + 0 - - BatchScriptTimeout + + WhatIf - {{ Fill BatchScriptTimeout Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 + SwitchParameter - Int32 + SwitchParameter - None + False - - PowerShellSPSEProcessCountMin + + Confirm - {{ Fill PowerShellSPSEProcessCountMin Description }} + Prompts you for confirmation before running the cmdlet. - Int32 + SwitchParameter - Int32 + SwitchParameter - None + False - - PowerShellSPSEProcessCountMax + + ProgressAction - {{ Fill PowerShellSPSEProcessCountMax Description }} + {{ Fill ProgressAction Description }} - Int32 + ActionPreference - Int32 + ActionPreference None - - NetflowEnable - - {{ Fill NetflowEnable Description }} - - Boolean + + + - Boolean - + None. - None - - - NbarEnable - {{ Fill NbarEnable Description }} + - Boolean + + + + - Boolean - + Returns a LogicMonitor.DeviceGroupDatasourceAlertSetting object containing the updated alert settings. - None - - - NetflowPorts - {{ Fill NetflowPorts Description }} + - String[] - - String[] - - - None - - - SflowPorts + + + + + This function requires a valid LogicMonitor API authentication. + + + + + -------------------------- EXAMPLE 1 -------------------------- + 90" +Updates the alert settings for the CPU Usage datapoint on the specified device group. + + + + + + + + + + Set-LMDeviceGroupProperty + Set + LMDeviceGroupProperty + + Updates a property value for a LogicMonitor device group. + + + + The Set-LMDeviceGroupProperty function modifies the value of a specific property for a device group in LogicMonitor. + + + + Set-LMDeviceGroupProperty + + Id + + Specifies the ID of the device group. This parameter is mandatory when using the 'Id' parameter set. + + Int32 + + Int32 + + + 0 + + + PropertyName + + Specifies the name of the property to update. + + String + + String + + + None + + + PropertyValue + + Specifies the new value for the property. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Set-LMDeviceGroupProperty + + Name + + Specifies the name of the device group. This parameter is mandatory when using the 'Name' parameter set. + + String + + String + + + None + + + PropertyName + + Specifies the name of the property to update. + + String + + String + + + None + + + PropertyValue + + Specifies the new value for the property. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id - {{ Fill SflowPorts Description }} + Specifies the ID of the device group. This parameter is mandatory when using the 'Id' parameter set. - String[] + Int32 - String[] + Int32 - None + 0 - - LMLogsSyslogEnable + + Name - {{ Fill LMLogsSyslogEnable Description }} + Specifies the name of the device group. This parameter is mandatory when using the 'Name' parameter set. - Boolean + String - Boolean + String None - - LMLogsSyslogHostnameFormat + + PropertyName - {{ Fill LMLogsSyslogHostnameFormat Description }} + Specifies the name of the property to update. String @@ -58276,10 +78622,10 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - - LMLogsSyslogPropertyName + + PropertyValue - {{ Fill LMLogsSyslogPropertyName Description }} + Specifies the new value for the property. String @@ -58288,19 +78634,6 @@ Updates the collector with ID 123 with a new description and enables fail-back.< None - - WaitForRestart - - Indicates whether to wait for the collector restart to complete. - [Additional parameters for snippet configuration omitted for brevity] - - SwitchParameter - - SwitchParameter - - - False - WhatIf @@ -58341,7 +78674,7 @@ Updates the collector with ID 123 with a new description and enables fail-back.< - You can pipe objects containing Id properties to this function. + You can pipe device group objects containing Id properties to this function. @@ -58351,7 +78684,7 @@ Updates the collector with ID 123 with a new description and enables fail-back.< - Returns a string indicating the status of the configuration update and restart operation. + Returns the response from the API indicating the success of the property update. @@ -58360,14 +78693,14 @@ Updates the collector with ID 123 with a new description and enables fail-back.< - This function requires a valid LogicMonitor API authentication and will restart the collector. + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Set-LMCollectorConfig -Id 123 -CollectorSize "medium" -WaitForRestart -Updates the collector size and waits for the restart to complete. + Set-LMDeviceGroupProperty -Id 123 -PropertyName "Location" -PropertyValue "New York" +Updates the "Location" property to "New York" for the device group with ID 123. @@ -58377,87 +78710,51 @@ Updates the collector size and waits for the restart to complete. - Set-LMCollectorGroup - Set - LMCollectorGroup - - Updates a LogicMonitor collector group's configuration. - - - - The Set-LMCollectorGroup function modifies an existing collector group's settings, including its name, description, properties, and auto-balance settings. - - - - Set-LMCollectorGroup - - Id - - Specifies the ID of the collector group to modify. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - NewName - - Specifies the new name for the collector group. - - String - - String - - - None - - - Description - - Specifies a new description for the collector group. - - String - - String - - - None - - - Properties + Set-LMDeviceProperty + Set + LMDeviceProperty + + Updates a property value for a LogicMonitor device. + + + + The Set-LMDeviceProperty function modifies the value of a specific property for a device in LogicMonitor. + + + + Set-LMDeviceProperty + + Id - Specifies a hashtable of custom properties to set for the collector group. + Specifies the ID of the device. This parameter is mandatory when using the 'Id' parameter set. - Hashtable + Int32 - Hashtable + Int32 - None + 0 - - AutoBalance + + PropertyName - Specifies whether to enable auto-balancing for the collector group. + Specifies the name of the property to update. - Boolean + String - Boolean + String None - - AutoBalanceInstanceCountThreshold + + PropertyValue - Specifies the threshold for auto-balancing the collector group. + Specifies the new value for the property. - Int32 + String - Int32 + String None @@ -58498,11 +78795,11 @@ Updates the collector size and waits for the restart to complete. - Set-LMCollectorGroup - + Set-LMDeviceProperty + Name - Specifies the current name of the collector group. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the device. This parameter is mandatory when using the 'Name' parameter set. String @@ -58511,10 +78808,10 @@ Updates the collector size and waits for the restart to complete. None - - NewName + + PropertyName - Specifies the new name for the collector group. + Specifies the name of the property to update. String @@ -58523,10 +78820,10 @@ Updates the collector size and waits for the restart to complete. None - - Description + + PropertyValue - Specifies a new description for the collector group. + Specifies the new value for the property. String @@ -58535,42 +78832,6 @@ Updates the collector size and waits for the restart to complete. None - - Properties - - Specifies a hashtable of custom properties to set for the collector group. - - Hashtable - - Hashtable - - - None - - - AutoBalance - - Specifies whether to enable auto-balancing for the collector group. - - Boolean - - Boolean - - - None - - - AutoBalanceInstanceCountThreshold - - Specifies the threshold for auto-balancing the collector group. - - Int32 - - Int32 - - - None - WhatIf @@ -58608,10 +78869,10 @@ Updates the collector size and waits for the restart to complete. - + Id - Specifies the ID of the collector group to modify. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the device. This parameter is mandatory when using the 'Id' parameter set. Int32 @@ -58620,10 +78881,10 @@ Updates the collector size and waits for the restart to complete. 0 - + Name - Specifies the current name of the collector group. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the device. This parameter is mandatory when using the 'Name' parameter set. String @@ -58632,10 +78893,10 @@ Updates the collector size and waits for the restart to complete. None - - NewName + + PropertyName - Specifies the new name for the collector group. + Specifies the name of the property to update. String @@ -58644,10 +78905,10 @@ Updates the collector size and waits for the restart to complete. None - - Description + + PropertyValue - Specifies a new description for the collector group. + Specifies the new value for the property. String @@ -58656,42 +78917,6 @@ Updates the collector size and waits for the restart to complete. None - - Properties - - Specifies a hashtable of custom properties to set for the collector group. - - Hashtable - - Hashtable - - - None - - - AutoBalance - - Specifies whether to enable auto-balancing for the collector group. - - Boolean - - Boolean - - - None - - - AutoBalanceInstanceCountThreshold - - Specifies the threshold for auto-balancing the collector group. - - Int32 - - Int32 - - - None - WhatIf @@ -58742,7 +78967,7 @@ Updates the collector size and waits for the restart to complete. - Returns a LogicMonitor.CollectorGroup object containing the updated group information. + Returns the response from the API indicating the success of the property update. @@ -58757,8 +78982,8 @@ Updates the collector size and waits for the restart to complete. -------------------------- EXAMPLE 1 -------------------------- - Set-LMCollectorGroup -Id 123 -NewName "Updated Group" -AutoBalance $true -Updates the collector group with ID 123 with a new name and enables auto-balancing. + Set-LMDeviceProperty -Id 123 -PropertyName "Location" -PropertyValue "New York" +Updates the "Location" property to "New York" for the device with ID 123. @@ -58768,23 +78993,23 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci - Set-LMConfigsource + Set-LMDiagnosticSource Set - LMConfigsource + LMDiagnosticSource - Updates a LogicMonitor config source configuration. + Updates a LogicMonitor diagnostic source configuration. - The Set-LMConfigsource function modifies an existing config source in LogicMonitor, allowing updates to its name, display name, description, applies to settings, and other properties. + The Set-LMDiagnosticSource function modifies an existing diagnostic source in LogicMonitor, allowing updates to its name, description, group, script, tags, technology, appliesTo, and other properties. - Set-LMConfigsource + Set-LMDiagnosticSource Id - Specifies the ID of the config source to modify. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the diagnostic source to modify. This parameter is mandatory when using the 'Id' parameter set. String @@ -58796,19 +79021,7 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci NewName - Specifies the new name for the config source. - - String - - String - - - None - - - DisplayName - - Specifies the new display name for the config source. + Specifies the new name for the diagnostic source. String @@ -58820,7 +79033,7 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci Description - Specifies the new description for the config source. + Specifies the new description for the diagnostic source. String @@ -58830,9 +79043,9 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci None - appliesTo + Group - Specifies the new applies to expression for the config source. + Specifies the group for the diagnostic source. String @@ -58842,9 +79055,9 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci None - TechNotes + GroovyScript - Specifies the new technical notes for the config source. + Specifies the Groovy script for the diagnostic source. String @@ -58856,31 +79069,19 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci Tags - Specifies an array of tags to associate with the config source. - - String[] - - String[] - - - None - - - TagsMethod - - Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". + Specifies tags to associate with the diagnostic source. String String - Refresh + None - PollingIntervalInSeconds + Technology - Specifies the polling interval in seconds. Valid values are "3600", "14400", "28800", "86400". + Specifies the technology details for the diagnostic source. String @@ -58890,13 +79091,13 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci None - ConfigChecks + AppliesTo - Specifies the configuration checks object for the config source. + Specifies the appliesTo expression for the diagnostic source. - PSObject + String - PSObject + String None @@ -58937,11 +79138,11 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci - Set-LMConfigsource + Set-LMDiagnosticSource Name - Specifies the current name of the config source. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the diagnostic source. This parameter is mandatory when using the 'Name' parameter set. String @@ -58953,19 +79154,7 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci NewName - Specifies the new name for the config source. - - String - - String - - - None - - - DisplayName - - Specifies the new display name for the config source. + Specifies the new name for the diagnostic source. String @@ -58977,7 +79166,7 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci Description - Specifies the new description for the config source. + Specifies the new description for the diagnostic source. String @@ -58987,9 +79176,9 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci None - appliesTo + Group - Specifies the new applies to expression for the config source. + Specifies the group for the diagnostic source. String @@ -58999,9 +79188,9 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci None - TechNotes + GroovyScript - Specifies the new technical notes for the config source. + Specifies the Groovy script for the diagnostic source. String @@ -59013,31 +79202,19 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci Tags - Specifies an array of tags to associate with the config source. - - String[] - - String[] - - - None - - - TagsMethod - - Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". + Specifies tags to associate with the diagnostic source. String String - Refresh + None - PollingIntervalInSeconds + Technology - Specifies the polling interval in seconds. Valid values are "3600", "14400", "28800", "86400". + Specifies the technology details for the diagnostic source. String @@ -59047,13 +79224,13 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci None - ConfigChecks + AppliesTo - Specifies the configuration checks object for the config source. + Specifies the appliesTo expression for the diagnostic source. - PSObject + String - PSObject + String None @@ -59098,7 +79275,7 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci Id - Specifies the ID of the config source to modify. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the diagnostic source to modify. This parameter is mandatory when using the 'Id' parameter set. String @@ -59110,7 +79287,7 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci Name - Specifies the current name of the config source. This parameter is mandatory when using the 'Name' parameter set. + Specifies the current name of the diagnostic source. This parameter is mandatory when using the 'Name' parameter set. String @@ -59122,19 +79299,7 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci NewName - Specifies the new name for the config source. - - String - - String - - - None - - - DisplayName - - Specifies the new display name for the config source. + Specifies the new name for the diagnostic source. String @@ -59146,7 +79311,7 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci Description - Specifies the new description for the config source. + Specifies the new description for the diagnostic source. String @@ -59156,9 +79321,9 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci None - appliesTo + Group - Specifies the new applies to expression for the config source. + Specifies the group for the diagnostic source. String @@ -59168,9 +79333,9 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci None - TechNotes + GroovyScript - Specifies the new technical notes for the config source. + Specifies the Groovy script for the diagnostic source. String @@ -59182,31 +79347,19 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci Tags - Specifies an array of tags to associate with the config source. - - String[] - - String[] - - - None - - - TagsMethod - - Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". + Specifies tags to associate with the diagnostic source. String String - Refresh + None - PollingIntervalInSeconds + Technology - Specifies the polling interval in seconds. Valid values are "3600", "14400", "28800", "86400". + Specifies the technology details for the diagnostic source. String @@ -59216,13 +79369,13 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci None - ConfigChecks + AppliesTo - Specifies the configuration checks object for the config source. + Specifies the appliesTo expression for the diagnostic source. - PSObject + String - PSObject + String None @@ -59277,7 +79430,7 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci - Returns a LogicMonitor.Datasource object containing the updated config source information. + Returns a LogicMonitor.DiagnosticSource object containing the updated diagnostic source information. @@ -59292,8 +79445,8 @@ Updates the collector group with ID 123 with a new name and enables auto-balanci -------------------------- EXAMPLE 1 -------------------------- - Set-LMConfigsource -Id 123 -NewName "UpdatedSource" -Description "New description" -Updates the config source with ID 123 with a new name and description. + Set-LMDiagnosticSource -Id 123 -NewName "UpdatedSource" -Description "New description" +Updates the diagnostic source with ID 123 with a new name and description. @@ -59303,59 +79456,35 @@ Updates the config source with ID 123 with a new name and description. - Set-LMDatasource + Set-LMLogPartition Set - LMDatasource + LMLogPartition - Updates a LogicMonitor datasource configuration. + Updates a LogicMonitor Log Partition configuration. - The Set-LMDatasource function modifies an existing datasource in LogicMonitor, allowing updates to its name, display name, description, applies to settings, and other properties. + The Set-LMLogPartition function modifies an existing log partition in LogicMonitor. - Set-LMDatasource - + Set-LMLogPartition + Id - Specifies the ID of the datasource to modify. This parameter is mandatory when using the 'Id' parameter set. - - String - - String - - - None - - - NewName - - Specifies the new name for the datasource. - - String - - String - - - None - - - DisplayName - - Specifies the new display name for the datasource. + Specifies the ID of the log partition to modify. - String + Int32 - String + Int32 - None + 0 Description - Specifies the new description for the datasource. + Specifies the new description for the log partition. String @@ -59365,45 +79494,21 @@ Updates the config source with ID 123 with a new name and description.None - Tags - - Specifies an array of tags to associate with the datasource. - - String[] - - String[] - - - None - - - TagsMethod - - Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". - - String - - String - - - Refresh - - - appliesTo + Retention - Specifies the new applies to expression for the datasource. + Specifies the new retention for the log partition. - String + Int32 - String + Int32 None - TechNotes + Sku - Specifies the new technical notes for the datasource. + Specifies the new sku for the log partition. String @@ -59413,9 +79518,9 @@ Updates the config source with ID 123 with a new name and description.None - PollingIntervalInSeconds + Status - Specifies the polling interval in seconds. + Specifies the new status for the log partition. Possible values are "active" or "inactive". String @@ -59424,18 +79529,6 @@ Updates the config source with ID 123 with a new name and description. None - - Datapoints - - Specifies the datapoints configuration object for the datasource. - - PSObject - - PSObject - - - None - WhatIf @@ -59472,35 +79565,11 @@ Updates the config source with ID 123 with a new name and description. - Set-LMDatasource - - Name - - Specifies the current name of the datasource. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - NewName - - Specifies the new name for the datasource. - - String - - String - - - None - + Set-LMLogPartition - DisplayName + Name - Specifies the new display name for the datasource. + Specifies the current name of the log partition. String @@ -59512,7 +79581,7 @@ Updates the config source with ID 123 with a new name and description. Description - Specifies the new description for the datasource. + Specifies the new description for the log partition. String @@ -59522,45 +79591,21 @@ Updates the config source with ID 123 with a new name and description.None - Tags - - Specifies an array of tags to associate with the datasource. - - String[] - - String[] - - - None - - - TagsMethod - - Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". - - String - - String - - - Refresh - - - appliesTo + Retention - Specifies the new applies to expression for the datasource. + Specifies the new retention for the log partition. - String + Int32 - String + Int32 None - TechNotes + Sku - Specifies the new technical notes for the datasource. + Specifies the new sku for the log partition. String @@ -59570,9 +79615,9 @@ Updates the config source with ID 123 with a new name and description.None - PollingIntervalInSeconds + Status - Specifies the polling interval in seconds. + Specifies the new status for the log partition. Possible values are "active" or "inactive". String @@ -59581,18 +79626,6 @@ Updates the config source with ID 123 with a new name and description. None - - Datapoints - - Specifies the datapoints configuration object for the datasource. - - PSObject - - PSObject - - - None - WhatIf @@ -59629,47 +79662,23 @@ Updates the config source with ID 123 with a new name and description. - - - Id - - Specifies the ID of the datasource to modify. This parameter is mandatory when using the 'Id' parameter set. - - String - - String - - - None - - - Name - - Specifies the current name of the datasource. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - NewName + + + Id - Specifies the new name for the datasource. + Specifies the ID of the log partition to modify. - String + Int32 - String + Int32 - None + 0 - DisplayName + Name - Specifies the new display name for the datasource. + Specifies the current name of the log partition. String @@ -59681,7 +79690,7 @@ Updates the config source with ID 123 with a new name and description. Description - Specifies the new description for the datasource. + Specifies the new description for the log partition. String @@ -59691,45 +79700,21 @@ Updates the config source with ID 123 with a new name and description.None - Tags - - Specifies an array of tags to associate with the datasource. - - String[] - - String[] - - - None - - - TagsMethod - - Specifies how to handle existing tags. Valid values are "Add" or "Refresh". Default is "Refresh". - - String - - String - - - Refresh - - - appliesTo + Retention - Specifies the new applies to expression for the datasource. + Specifies the new retention for the log partition. - String + Int32 - String + Int32 None - TechNotes + Sku - Specifies the new technical notes for the datasource. + Specifies the new sku for the log partition. String @@ -59739,9 +79724,9 @@ Updates the config source with ID 123 with a new name and description.None - PollingIntervalInSeconds + Status - Specifies the polling interval in seconds. + Specifies the new status for the log partition. Possible values are "active" or "inactive". String @@ -59750,18 +79735,6 @@ Updates the config source with ID 123 with a new name and description. None - - Datapoints - - Specifies the datapoints configuration object for the datasource. - - PSObject - - PSObject - - - None - WhatIf @@ -59802,7 +79775,7 @@ Updates the config source with ID 123 with a new name and description. - You can pipe objects containing Id properties to this function. + None. @@ -59812,7 +79785,7 @@ Updates the config source with ID 123 with a new name and description. - Returns a LogicMonitor.Datasource object containing the updated datasource information. + Returns a LogicMonitor.LogPartition object containing the updated log partition information. @@ -59827,8 +79800,8 @@ Updates the config source with ID 123 with a new name and description. -------------------------- EXAMPLE 1 -------------------------- - Set-LMDatasource -Id 123 -NewName "UpdatedSource" -Description "New description" -Updates the datasource with ID 123 with a new name and description. + Set-LMLogPartition -Id 123 -Description "New description" -Retention 30 -Status "active" +Updates the log partition with ID 123 with a new description, retention, and status. @@ -59838,143 +79811,96 @@ Updates the datasource with ID 123 with a new name and description. - Set-LMDevice + Set-LMLogPartitionAction Set - LMDevice + LMLogPartitionAction - Updates a LogicMonitor device configuration. + Updates a LogicMonitor Log Partition configuration to either pause or resume log ingestion. - The Set-LMDevice function modifies an existing device in LogicMonitor, allowing updates to its name, display name, description, collector settings, and various other properties. + The Set-LMLogPartitionAction function modifies an existing log partition action in LogicMonitor. - Set-LMDevice - + Set-LMLogPartitionAction + Id - Specifies the ID of the device to modify. This parameter is mandatory when using the 'Id' parameter set. - - String - - String - - - None - - - NewName - - Specifies the new name for the device. - - String - - String - - - None - - - DisplayName - - Specifies the new display name for the device. - - String - - String - - - None - - - Description - - Specifies the new description for the device. - - String - - String - - - None - - - PreferredCollectorId - - Specifies the ID of the preferred collector for the device. + Specifies the ID of the log partition action to modify. Int32 Int32 - None + 0 - - PreferredCollectorGroupId + + Action - Specifies the ID of the preferred collector group for the device. + Specifies the new action for the log partition. Possible values are "pause" or "resume". - Int32 + String - Int32 + String None - - AutoBalancedCollectorGroupId + + WhatIf - Specifies the ID of the auto-balanced collector group for the device. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - None + False - - Properties + + Confirm - Specifies a hashtable of custom properties for the device. + Prompts you for confirmation before running the cmdlet. - Hashtable - Hashtable + SwitchParameter - None + False - - HostGroupIds + + ProgressAction - Specifies an array of host group IDs to associate with the device. + {{ Fill ProgressAction Description }} - String[] + ActionPreference - String[] + ActionPreference None + + + Set-LMLogPartitionAction - PropertiesMethod + Name - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + Specifies the current name of the log partition to modify. String String - Replace + None - - Link + + Action - Specifies the URL link associated with the device. + Specifies the new action for the log partition. Possible values are "pause" or "resume". String @@ -59983,90 +79909,6 @@ Updates the datasource with ID 123 with a new name and description. None - - DisableAlerting - - Specifies whether to disable alerting for the device. - - Boolean - - Boolean - - - None - - - EnableNetFlow - - Specifies whether to enable NetFlow for the device. - - Boolean - - Boolean - - - None - - - NetflowCollectorGroupId - - Specifies the ID of the NetFlow collector group. - - Int32 - - Int32 - - - None - - - NetflowCollectorId - - Specifies the ID of the NetFlow collector. - - Int32 - - Int32 - - - None - - - EnableLogCollector - - Specifies whether to enable log collection for the device. - - Boolean - - Boolean - - - None - - - LogCollectorGroupId - - Specifies the ID of the log collector group. - - Int32 - - Int32 - - - None - - - LogCollectorId - - Specifies the ID of the log collector. - - Int32 - - Int32 - - - None - WhatIf @@ -60102,12 +79944,137 @@ Updates the datasource with ID 123 with a new name and description. None + + + + Id + + Specifies the ID of the log partition action to modify. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the current name of the log partition to modify. + + String + + String + + + None + + + Action + + Specifies the new action for the log partition. Possible values are "pause" or "resume". + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. + + + + + + + + + + Returns a LogicMonitor.LogPartition object containing the updated log partition information. + + + + + + + + + This function requires a valid LogicMonitor API authentication. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Set-LMLogPartitionAction -Id 123 -Action "pause" +Updates the log partition with ID 123 to pause log ingestion. + + + + + + + + + + Set-LMNetScan + Set + LMNetScan + + Updates a LogicMonitor NetScan configuration. + + + + The Set-LMNetscan function modifies an existing NetScan configuration in LogicMonitor. + + - Set-LMDevice - - Name + Set-LMNetScan + + CollectorId - Specifies the current name of the device. This parameter is mandatory when using the 'Name' parameter set. + Specifies the ID of the collector to use for the NetScan. String @@ -60116,10 +80083,10 @@ Updates the datasource with ID 123 with a new name and description. None - - NewName + + NetScanGroupId - Specifies the new name for the device. + Specifies the ID of the NetScan group. String @@ -60128,10 +80095,10 @@ Updates the datasource with ID 123 with a new name and description. None - - DisplayName + + SubnetRange - Specifies the new display name for the device. + Specifies the subnet range to scan. String @@ -60140,10 +80107,10 @@ Updates the datasource with ID 123 with a new name and description. None - - Description + + CredentialGroupId - Specifies the new description for the device. + Specifies the ID of the credential group. String @@ -60152,82 +80119,58 @@ Updates the datasource with ID 123 with a new name and description. None - - PreferredCollectorId - - Specifies the ID of the preferred collector for the device. - - Int32 - - Int32 - - - None - - - PreferredCollectorGroupId - - Specifies the ID of the preferred collector group for the device. - - Int32 - - Int32 - - - None - - - AutoBalancedCollectorGroupId + + CredentialGroupName - Specifies the ID of the auto-balanced collector group for the device. + Specifies the name of the credential group. - Int32 + String - Int32 + String None - - Properties + + Schedule - Specifies a hashtable of custom properties for the device. + Specifies the scanning schedule configuration. - Hashtable + PSObject - Hashtable + PSObject None - - HostGroupIds + + ChangeNameToken - Specifies an array of host group IDs to associate with the device. + Specifies the token for changing names. - String[] + String - String[] + String None - - PropertiesMethod + + PortList - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + Specifies the list of ports to scan. String String - Replace + None - - Link + + Name - Specifies the URL link associated with the device. + Specifies the name of the NetScan. String @@ -60236,86 +80179,86 @@ Updates the datasource with ID 123 with a new name and description. None - - DisableAlerting + + Id - Specifies whether to disable alerting for the device. + Specifies the ID of the NetScan to modify. - Boolean + String - Boolean + String None - - - EnableNetFlow + + + Description - Specifies whether to enable NetFlow for the device. + Specifies the description for the NetScan. - Boolean + String - Boolean + String None - - NetflowCollectorGroupId + + ExcludeDuplicateType - Specifies the ID of the NetFlow collector group. + Specifies the type of duplicates to exclude. - Int32 + String - Int32 + String None - - NetflowCollectorId + + IgnoreSystemIpDuplpicates - Specifies the ID of the NetFlow collector. + Specifies whether to ignore system IP duplicates. - Int32 + Boolean - Int32 + Boolean None - - EnableLogCollector + + Method - Specifies whether to enable log collection for the device. + Specifies the scanning method to use. - Boolean + String - Boolean + String None - - LogCollectorGroupId + + NextStart - Specifies the ID of the log collector group. + Specifies when the next scan should start. - Int32 + String - Int32 + String None - - LogCollectorId + + NextStartEpoch - Specifies the ID of the log collector. + Specifies when the next scan should start in epoch time. - Int32 + String - Int32 + String None @@ -60357,10 +80300,10 @@ Updates the datasource with ID 123 with a new name and description. - - Id + + CollectorId - Specifies the ID of the device to modify. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the collector to use for the NetScan. String @@ -60369,10 +80312,10 @@ Updates the datasource with ID 123 with a new name and description. None - + Name - Specifies the current name of the device. This parameter is mandatory when using the 'Name' parameter set. + Specifies the name of the NetScan. String @@ -60381,10 +80324,10 @@ Updates the datasource with ID 123 with a new name and description. None - - NewName + + Id - Specifies the new name for the device. + Specifies the ID of the NetScan to modify. String @@ -60393,10 +80336,10 @@ Updates the datasource with ID 123 with a new name and description. None - - DisplayName + + Description - Specifies the new display name for the device. + Specifies the description for the NetScan. String @@ -60405,10 +80348,10 @@ Updates the datasource with ID 123 with a new name and description. None - - Description + + ExcludeDuplicateType - Specifies the new description for the device. + Specifies the type of duplicates to exclude. String @@ -60417,82 +80360,46 @@ Updates the datasource with ID 123 with a new name and description. None - - PreferredCollectorId - - Specifies the ID of the preferred collector for the device. - - Int32 - - Int32 - - - None - - - PreferredCollectorGroupId - - Specifies the ID of the preferred collector group for the device. - - Int32 - - Int32 - - - None - - - AutoBalancedCollectorGroupId - - Specifies the ID of the auto-balanced collector group for the device. - - Int32 - - Int32 - - - None - - - Properties + + IgnoreSystemIpDuplpicates - Specifies a hashtable of custom properties for the device. + Specifies whether to ignore system IP duplicates. - Hashtable + Boolean - Hashtable + Boolean None - - HostGroupIds + + Method - Specifies an array of host group IDs to associate with the device. + Specifies the scanning method to use. - String[] + String - String[] + String None - - PropertiesMethod + + NextStart - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + Specifies when the next scan should start. String String - Replace + None - - Link + + NextStartEpoch - Specifies the URL link associated with the device. + Specifies when the next scan should start in epoch time. String @@ -60501,86 +80408,86 @@ Updates the datasource with ID 123 with a new name and description. None - - DisableAlerting + + NetScanGroupId - Specifies whether to disable alerting for the device. + Specifies the ID of the NetScan group. - Boolean + String - Boolean + String None - - EnableNetFlow + + SubnetRange - Specifies whether to enable NetFlow for the device. + Specifies the subnet range to scan. - Boolean + String - Boolean + String None - - NetflowCollectorGroupId + + CredentialGroupId - Specifies the ID of the NetFlow collector group. + Specifies the ID of the credential group. - Int32 + String - Int32 + String None - - NetflowCollectorId + + CredentialGroupName - Specifies the ID of the NetFlow collector. + Specifies the name of the credential group. - Int32 + String - Int32 + String None - - EnableLogCollector + + Schedule - Specifies whether to enable log collection for the device. + Specifies the scanning schedule configuration. - Boolean + PSObject - Boolean + PSObject None - - LogCollectorGroupId + + ChangeNameToken - Specifies the ID of the log collector group. + Specifies the token for changing names. - Int32 + String - Int32 + String None - - LogCollectorId + + PortList - Specifies the ID of the log collector. + Specifies the list of ports to scan. - Int32 + String - Int32 + String None @@ -60635,7 +80542,7 @@ Updates the datasource with ID 123 with a new name and description. - Returns a LogicMonitor.Device object containing the updated device information. + Returns a LogicMonitor.NetScan object containing the updated scan configuration. @@ -60650,8 +80557,8 @@ Updates the datasource with ID 123 with a new name and description. -------------------------- EXAMPLE 1 -------------------------- - Set-LMDevice -Id 123 -NewName "UpdatedDevice" -Description "New description" -Updates the device with ID 123 with a new name and description. + Set-LMNetscan -Id 123 -Name "UpdatedScan" -Description "New description" +Updates the NetScan with ID 123 with a new name and description. @@ -60661,324 +80568,35 @@ Updates the device with ID 123 with a new name and description. - Set-LMDeviceDatasourceInstance + Set-LMNetscanGroup Set - LMDeviceDatasourceInstance + LMNetscanGroup - Updates a LogicMonitor device datasource instance configuration. + Updates a LogicMonitor NetScan group configuration. - The Set-LMDeviceDatasourceInstance function modifies an existing device datasource instance in LogicMonitor, allowing updates to its display name, wild values, description, and various other properties. - - - - Set-LMDeviceDatasourceInstance - - DisplayName - - Specifies the new display name for the instance. - - String - - String - - - None - - - WildValue - - Specifies the first wild value for the instance. - - String - - String - - - None - - - WildValue2 - - Specifies the second wild value for the instance. - - String - - String - - - None - - - Description - - Specifies the description for the instance. - - String - - String - - - None - - - Properties - - Specifies a hashtable of custom properties for the instance. - - Hashtable - - Hashtable - - - None - - - PropertiesMethod - - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". - - String - - String - - - Replace - - - StopMonitoring - - Specifies whether to stop monitoring the instance. - - Boolean - - Boolean - - - None - - - DisableAlerting - - Specifies whether to disable alerting for the instance. - - Boolean - - Boolean - - - None - - - InstanceGroupId - - Specifies the ID of the instance group to which the instance belongs. - - String - - String - - - None - - - InstanceId - - Specifies the ID of the instance to update. - - String - - String - - - None - - - DatasourceName - - Specifies the name of the datasource associated with the instance. - - String - - String - - - None - - - Name - - Specifies the name of the device associated with the instance. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Set-LMDeviceDatasourceInstance - - DisplayName - - Specifies the new display name for the instance. - - String - - String - - - None - - - WildValue - - Specifies the first wild value for the instance. - - String - - String - - - None - - - WildValue2 - - Specifies the second wild value for the instance. - - String - - String - - - None - - - Description - - Specifies the description for the instance. - - String - - String - - - None - - - Properties - - Specifies a hashtable of custom properties for the instance. - - Hashtable - - Hashtable - - - None - - - PropertiesMethod - - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". - - String - - String - - - Replace - - - StopMonitoring - - Specifies whether to stop monitoring the instance. - - Boolean - - Boolean - - - None - - - DisableAlerting + The Set-LMNetscanGroup function modifies an existing NetScan group in LogicMonitor. + + + + Set-LMNetscanGroup + + Id - Specifies whether to disable alerting for the instance. + Specifies the ID of the NetScan group to modify. - Boolean + Int32 - Boolean + Int32 - None + 0 - InstanceGroupId - - Specifies the ID of the instance group to which the instance belongs. - - String - - String - - - None - - - InstanceId - - Specifies the ID of the instance to update. - - String - - String - - - None - - - DatasourceName + NewName - Specifies the name of the datasource associated with the instance. + Specifies the new name for the NetScan group. String @@ -60987,10 +80605,10 @@ Updates the device with ID 123 with a new name and description. None - - Id + + Description - Specifies the ID of the device associated with the instance. + Specifies the new description for the NetScan group. String @@ -61035,23 +80653,11 @@ Updates the device with ID 123 with a new name and description. - Set-LMDeviceDatasourceInstance - - DisplayName - - Specifies the new display name for the instance. - - String - - String - - - None - + Set-LMNetscanGroup - WildValue + Name - Specifies the first wild value for the instance. + Specifies the current name of the NetScan group. String @@ -61061,9 +80667,9 @@ Updates the device with ID 123 with a new name and description. None - WildValue2 + NewName - Specifies the second wild value for the instance. + Specifies the new name for the NetScan group. String @@ -61075,91 +80681,193 @@ Updates the device with ID 123 with a new name and description. Description - Specifies the description for the instance. - - String - - String - - - None - - - Properties - - Specifies a hashtable of custom properties for the instance. - - Hashtable - - Hashtable - - - None - - - PropertiesMethod - - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + Specifies the new description for the NetScan group. String String - Replace - - - StopMonitoring - - Specifies whether to stop monitoring the instance. - - Boolean - - Boolean - - None - - DisableAlerting + + WhatIf - Specifies whether to disable alerting for the instance. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter - None + False - - InstanceGroupId + + Confirm - Specifies the ID of the instance group to which the instance belongs. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False - - InstanceId + + ProgressAction - Specifies the ID of the instance to update. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - DatasourceId + + + + + Id + + Specifies the ID of the NetScan group to modify. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the current name of the NetScan group. + + String + + String + + + None + + + NewName + + Specifies the new name for the NetScan group. + + String + + String + + + None + + + Description + + Specifies the new description for the NetScan group. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe objects containing Id properties to this function. + + + + + + + + + + Returns a LogicMonitor.NetScanGroup object containing the updated group information. + + + + + + + + + This function requires a valid LogicMonitor API authentication. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Set-LMNetscanGroup -Id 123 -NewName "Updated Group" -Description "New description" +Updates the NetScan group with ID 123 with a new name and description. + + + + + + + + + + Set-LMNewUserMessage + Set + LMNewUserMessage + + Updates the new user message template in LogicMonitor. + + + + The Set-LMNewUserMessage function modifies the message template that is sent to new users in LogicMonitor. + + + + Set-LMNewUserMessage + + MessageBody - Specifies the ID of the datasource associated with the instance. + Specifies the body content of the message template. String @@ -61168,10 +80876,10 @@ Updates the device with ID 123 with a new name and description. None - - Name + + MessageSubject - Specifies the name of the device associated with the instance. + Specifies the subject line of the message template. String @@ -61215,36 +80923,125 @@ Updates the device with ID 123 with a new name and description. None + + + + MessageBody + + Specifies the body content of the message template. + + String + + String + + + None + + + MessageSubject + + Specifies the subject line of the message template. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. + + + + + + + + + + Returns the response from the API indicating the success of the update. + + + + + + + + + This function requires a valid LogicMonitor API authentication. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Set-LMNewUserMessage -MessageBody "Welcome to our monitoring system" -MessageSubject "Welcome to LogicMonitor" +Updates the new user message template with the specified subject and body. + + + + + + + + + + Set-LMNormalizedProperty + Set + LMNormalizedProperty + + Updates normalized properties in LogicMonitor. + + + + The Set-LMNormalizedProperty cmdlet updates normalized properties in LogicMonitor. Normalized properties allow you to map multiple host properties to a single alias that can be used across your environment. + + - Set-LMDeviceDatasourceInstance - - DisplayName - - Specifies the new display name for the instance. - - String - - String - - - None - - - WildValue - - Specifies the first wild value for the instance. - - String - - String - - - None - - - WildValue2 + Set-LMNormalizedProperty + + Alias - Specifies the second wild value for the instance. + The alias name for the normalized property. String @@ -61253,82 +81050,70 @@ Updates the device with ID 123 with a new name and description. None - - Description + + Add - Specifies the description for the instance. + Indicates that properties should be added to the existing normalized property. - String - String + SwitchParameter - None + False - + Properties - Specifies a hashtable of custom properties for the instance. + An array of host property names to map to the alias. - Hashtable + Array - Hashtable + Array None - - PropertiesMethod - - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". - - String - - String - - - Replace - - - StopMonitoring + + WhatIf - Specifies whether to stop monitoring the instance. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Boolean - Boolean + SwitchParameter - None + False - - DisableAlerting + + Confirm - Specifies whether to disable alerting for the instance. + Prompts you for confirmation before running the cmdlet. - Boolean - Boolean + SwitchParameter - None + False - - InstanceGroupId + + ProgressAction - Specifies the ID of the instance group to which the instance belongs. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None - - InstanceId + + + Set-LMNormalizedProperty + + Alias - Specifies the ID of the instance to update. + The alias name for the normalized property. String @@ -61338,25 +81123,24 @@ Updates the device with ID 123 with a new name and description. None - DatasourceId + Remove - Specifies the ID of the datasource associated with the instance. + Indicates that properties should be removed from the existing normalized property. - String - String + SwitchParameter - None + False - - Id + + Properties - Specifies the ID of the device associated with the instance. + An array of host property names to map to the alias. - String + Array - String + Array None @@ -61398,130 +81182,10 @@ Updates the device with ID 123 with a new name and description. - - DisplayName - - Specifies the new display name for the instance. - - String - - String - - - None - - - WildValue - - Specifies the first wild value for the instance. - - String - - String - - - None - - - WildValue2 - - Specifies the second wild value for the instance. - - String - - String - - - None - - - Description - - Specifies the description for the instance. - - String - - String - - - None - - - Properties - - Specifies a hashtable of custom properties for the instance. - - Hashtable - - Hashtable - - - None - - - PropertiesMethod - - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". - - String - - String - - - Replace - - - StopMonitoring - - Specifies whether to stop monitoring the instance. - - Boolean - - Boolean - - - None - - - DisableAlerting - - Specifies whether to disable alerting for the instance. - - Boolean - - Boolean - - - None - - - InstanceGroupId - - Specifies the ID of the instance group to which the instance belongs. - - String - - String - - - None - - - InstanceId - - Specifies the ID of the instance to update. - - String - - String - - - None - - DatasourceName + Alias - Specifies the name of the datasource associated with the instance. + The alias name for the normalized property. String @@ -61531,37 +81195,37 @@ Updates the device with ID 123 with a new name and description. None - DatasourceId + Add - Specifies the ID of the datasource associated with the instance. + Indicates that properties should be added to the existing normalized property. - String + SwitchParameter - String + SwitchParameter - None + False - - Id + + Remove - Specifies the ID of the device associated with the instance. + Indicates that properties should be removed from the existing normalized property. - String + SwitchParameter - String + SwitchParameter - None + False - - Name + + Properties - Specifies the name of the device associated with the instance. + An array of host property names to map to the alias. - String + Array - String + Array None @@ -61606,7 +81270,7 @@ Updates the device with ID 123 with a new name and description. - You can pipe objects containing InstanceId, DatasourceId, and Id properties to this function. + None. @@ -61616,7 +81280,7 @@ Updates the device with ID 123 with a new name and description. - Returns a LogicMonitor.DeviceDatasourceInstance object containing the updated instance information. + Returns a message indicating the success of the operation. @@ -61625,14 +81289,22 @@ Updates the device with ID 123 with a new name and description. - This function requires a valid LogicMonitor API authentication. + This function requires a valid LogicMonitor API authentication and uses API v4. -------------------------- EXAMPLE 1 -------------------------- - Set-LMDeviceDatasourceInstance -InstanceId 123 -DisplayName "Updated Instance" -Description "New description" -Updates the instance with ID 123 with a new display name and description. + Set-LMNormalizedProperty -Add -Alias "location" -Properties @("location", "snmp.sysLocation", "auto.meraki.location") +Updates a normalized property with alias "location" to include the new properties. + + + + + + -------------------------- EXAMPLE 2 -------------------------- + Set-LMNormalizedProperty -Remove -Alias "location" -Properties @("auto.meraki.location") +Removes the "auto.meraki.location" property from the "location" alias. @@ -61642,23 +81314,23 @@ Updates the instance with ID 123 with a new display name and description. - Set-LMDeviceDatasourceInstanceAlertSetting + Set-LMOpsNote Set - LMDeviceDatasourceInstanceAlertSetting + LMOpsNote - Updates alert settings for a LogicMonitor device datasource instance. + Updates an operations note in LogicMonitor. - The Set-LMDeviceDatasourceInstanceAlertSetting function modifies alert settings for a specific device datasource instance in LogicMonitor. + The Set-LMOpsNote function modifies an existing operations note in LogicMonitor. - Set-LMDeviceDatasourceInstanceAlertSetting - - DatasourceName + Set-LMOpsNote + + Id - Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. + Specifies the ID of the operations note to modify. String @@ -61667,10 +81339,10 @@ Updates the instance with ID 123 with a new display name and description. None - - Name + + Note - Specifies the name of the device. Can be specified using the 'DeviceName' alias. + Specifies the new content for the note. String @@ -61679,101 +81351,76 @@ Updates the instance with ID 123 with a new display name and description. None - - DatapointName + + NoteDate - Specifies the name of the datapoint for which to configure alerts. + Specifies the date and time for the note. - String + DateTime - String + DateTime None - - InstanceName + + Tags - Specifies the name of the instance for which to configure alerts. + Specifies an array of tags to associate with the note. - String + String[] - String + String[] None - - DisableAlerting + + DeviceGroupIds - Specifies whether to disable alerting for this instance. + Specifies an array of device group IDs to associate with the note. - Boolean + String[] - Boolean + String[] None - - AlertExpressionNote + + WebsiteIds - Specifies a note for the alert expression. + Specifies an array of website IDs to associate with the note. - String + String[] - String + String[] None - - AlertExpression + + DeviceIds - Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + Specifies an array of device IDs to associate with the note. - String + String[] - String + String[] None - - AlertClearTransitionInterval - - Specifies the interval for alert clear transitions. Must be between 0 and 60. - - Int32 - - Int32 - - - 0 - - - AlertTransitionInterval - - Specifies the interval for alert transitions. Must be between 0 and 60. - - Int32 - - Int32 - - - 0 - - - AlertForNoData + + ClearTags - Specifies the alert level for no data conditions. Must be between 1 and 4. + Indicates whether to clear all existing tags. - Int32 - Int32 + SwitchParameter - 0 + False WhatIf @@ -61810,12 +81457,197 @@ Updates the instance with ID 123 with a new display name and description.None + + + + Id + + Specifies the ID of the operations note to modify. + + String + + String + + + None + + + Note + + Specifies the new content for the note. + + String + + String + + + None + + + NoteDate + + Specifies the date and time for the note. + + DateTime + + DateTime + + + None + + + Tags + + Specifies an array of tags to associate with the note. + + String[] + + String[] + + + None + + + ClearTags + + Indicates whether to clear all existing tags. + + SwitchParameter + + SwitchParameter + + + False + + + DeviceGroupIds + + Specifies an array of device group IDs to associate with the note. + + String[] + + String[] + + + None + + + WebsiteIds + + Specifies an array of website IDs to associate with the note. + + String[] + + String[] + + + None + + + DeviceIds + + Specifies an array of device IDs to associate with the note. + + String[] + + String[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + You can pipe objects containing Id properties to this function. + + + + + + + + + + Returns the response from the API containing the updated operations note information. + + + + + + + + + This function requires a valid LogicMonitor API authentication. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Set-LMOpsNote -Id 123 -Note "Updated information" -Tags @("maintenance", "planned") +Updates the operations note with ID 123 with new content and tags. + + + + + + + + + + Set-LMPortalInfo + Set + LMPortalInfo + + Updates LogicMonitor portal settings. + + + + The Set-LMPortalInfo function modifies various portal-wide settings in LogicMonitor, including whitelisting, two-factor authentication, alert totals, and session timeouts. + + - Set-LMDeviceDatasourceInstanceAlertSetting - - DatasourceName + Set-LMPortalInfo + + Whitelist - Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. + Specifies IP addresses/ranges to whitelist for portal access. String @@ -61824,46 +81656,34 @@ Updates the instance with ID 123 with a new display name and description. None - - Id - - Specifies the ID of the device. Can be specified using the 'DeviceId' alias. - - Int32 - - Int32 - - - 0 - - - DatapointName + + RequireTwoFA - Specifies the name of the datapoint for which to configure alerts. + Specifies whether to require two-factor authentication for all users. - String + Boolean - String + Boolean None - - InstanceName + + IncludeACKinAlertTotals - Specifies the name of the instance for which to configure alerts. + Specifies whether to include acknowledged alerts in alert totals. - String + Boolean - String + Boolean None - - DisableAlerting + + IncludeSDTinAlertTotals - Specifies whether to disable alerting for this instance. + Specifies whether to include alerts in SDT in alert totals. Boolean @@ -61872,22 +81692,22 @@ Updates the instance with ID 123 with a new display name and description. None - - AlertExpressionNote + + EnableRemoteSession - Specifies a note for the alert expression. + Specifies whether to enable remote session functionality. - String + Boolean - String + Boolean None - - AlertExpression + + CompanyDisplayName - Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + Specifies the company name to display in the portal. String @@ -61896,41 +81716,28 @@ Updates the instance with ID 123 with a new display name and description. None - - AlertClearTransitionInterval - - Specifies the interval for alert clear transitions. Must be between 0 and 60. - - Int32 - - Int32 - - - 0 - - - AlertTransitionInterval + + UserSessionTimeoutInMin - Specifies the interval for alert transitions. Must be between 0 and 60. + Specifies the session timeout in minutes. Valid values: 30, 60, 120, 240, 480, 1440, 10080, 43200. Int32 Int32 - 0 + None - - AlertForNoData + + ClearWhitelist - Specifies the alert level for no data conditions. Must be between 1 and 4. + Indicates whether to clear the existing whitelist. - Int32 - Int32 + SwitchParameter - 0 + False WhatIf @@ -61967,24 +81774,209 @@ Updates the instance with ID 123 with a new display name and description.None + + + + Whitelist + + Specifies IP addresses/ranges to whitelist for portal access. + + String + + String + + + None + + + ClearWhitelist + + Indicates whether to clear the existing whitelist. + + SwitchParameter + + SwitchParameter + + + False + + + RequireTwoFA + + Specifies whether to require two-factor authentication for all users. + + Boolean + + Boolean + + + None + + + IncludeACKinAlertTotals + + Specifies whether to include acknowledged alerts in alert totals. + + Boolean + + Boolean + + + None + + + IncludeSDTinAlertTotals + + Specifies whether to include alerts in SDT in alert totals. + + Boolean + + Boolean + + + None + + + EnableRemoteSession + + Specifies whether to enable remote session functionality. + + Boolean + + Boolean + + + None + + + CompanyDisplayName + + Specifies the company name to display in the portal. + + String + + String + + + None + + + UserSessionTimeoutInMin + + Specifies the session timeout in minutes. Valid values: 30, 60, 120, 240, 480, 1440, 10080, 43200. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. + + + + + + + + + + Returns the response from the API containing the updated portal settings. + + + + + + + + + This function requires a valid LogicMonitor API authentication. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Set-LMPortalInfo -RequireTwoFA $true -UserSessionTimeoutInMin 60 -CompanyDisplayName "My Company" +Updates the portal settings to require 2FA, set session timeout to 60 minutes, and update company display name. + + + + + + + + + + Set-LMPropertysource + Set + LMPropertysource + + Updates a LogicMonitor property source configuration. + + + + The Set-LMPropertysource function modifies an existing property source in LogicMonitor. + + - Set-LMDeviceDatasourceInstanceAlertSetting - - DatasourceId + Set-LMPropertysource + + Id - Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. + Specifies the ID of the property source to modify. - Int32 + String - Int32 + String - 0 + None - - Name + + NewName - Specifies the name of the device. Can be specified using the 'DeviceName' alias. + Specifies the new name for the property source. String @@ -61993,10 +81985,10 @@ Updates the instance with ID 123 with a new display name and description. None - - DatapointName + + Description - Specifies the name of the datapoint for which to configure alerts. + Specifies the description for the property source. String @@ -62005,10 +81997,10 @@ Updates the instance with ID 123 with a new display name and description. None - - InstanceName + + appliesTo - Specifies the name of the instance for which to configure alerts. + Specifies the applies to expression for the property source. String @@ -62018,76 +82010,76 @@ Updates the instance with ID 123 with a new display name and description.None - DisableAlerting + TechNotes - Specifies whether to disable alerting for this instance. + Specifies technical notes for the property source. - Boolean + String - Boolean + String None - AlertExpressionNote + Tags - Specifies a note for the alert expression. + Specifies an array of tags to associate with the property source. - String + String[] - String + String[] None - - AlertExpression + + TagsMethod - Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + Specifies how to handle tags. Valid values: "Add" (append to existing), "Refresh" (replace existing). String String - None + Refresh - - AlertClearTransitionInterval + + Group - Specifies the interval for alert clear transitions. Must be between 0 and 60. + Specifies the group for the property source. - Int32 + String - Int32 + String - 0 + None - - AlertTransitionInterval + + ScriptType - Specifies the interval for alert transitions. Must be between 0 and 60. + Specifies the script type. Valid values: "embed", "powerShell". - Int32 + String - Int32 + String - 0 + None - - AlertForNoData + + Script - Specifies the alert level for no data conditions. Must be between 1 and 4. + Specifies the script content. - Int32 + String - Int32 + String - 0 + None WhatIf @@ -62125,35 +82117,35 @@ Updates the instance with ID 123 with a new display name and description. - Set-LMDeviceDatasourceInstanceAlertSetting + Set-LMPropertysource - DatasourceId + Name - Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. + Specifies the current name of the property source. - Int32 + String - Int32 + String - 0 + None - - Id + + NewName - Specifies the ID of the device. Can be specified using the 'DeviceId' alias. + Specifies the new name for the property source. - Int32 + String - Int32 + String - 0 + None - - DatapointName + + Description - Specifies the name of the datapoint for which to configure alerts. + Specifies the description for the property source. String @@ -62162,10 +82154,10 @@ Updates the instance with ID 123 with a new display name and description. None - - InstanceName + + appliesTo - Specifies the name of the instance for which to configure alerts. + Specifies the applies to expression for the property source. String @@ -62175,76 +82167,76 @@ Updates the instance with ID 123 with a new display name and description.None - DisableAlerting + TechNotes - Specifies whether to disable alerting for this instance. + Specifies technical notes for the property source. - Boolean + String - Boolean + String None - AlertExpressionNote + Tags - Specifies a note for the alert expression. + Specifies an array of tags to associate with the property source. - String + String[] - String + String[] None - - AlertExpression + + TagsMethod - Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + Specifies how to handle tags. Valid values: "Add" (append to existing), "Refresh" (replace existing). String String - None + Refresh - - AlertClearTransitionInterval + + Group - Specifies the interval for alert clear transitions. Must be between 0 and 60. + Specifies the group for the property source. - Int32 + String - Int32 + String - 0 + None - - AlertTransitionInterval + + ScriptType - Specifies the interval for alert transitions. Must be between 0 and 60. + Specifies the script type. Valid values: "embed", "powerShell". - Int32 + String - Int32 + String - 0 + None - - AlertForNoData + + Script - Specifies the alert level for no data conditions. Must be between 1 and 4. + Specifies the script content. - Int32 + String - Int32 + String - 0 + None WhatIf @@ -62283,10 +82275,10 @@ Updates the instance with ID 123 with a new display name and description. - - DatasourceName + + Id - Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. + Specifies the ID of the property source to modify. String @@ -62296,33 +82288,33 @@ Updates the instance with ID 123 with a new display name and description.None - DatasourceId + Name - Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. + Specifies the current name of the property source. - Int32 + String - Int32 + String - 0 + None - - Id + + NewName - Specifies the ID of the device. Can be specified using the 'DeviceId' alias. + Specifies the new name for the property source. - Int32 + String - Int32 + String - 0 + None - - Name + + Description - Specifies the name of the device. Can be specified using the 'DeviceName' alias. + Specifies the description for the property source. String @@ -62331,10 +82323,10 @@ Updates the instance with ID 123 with a new display name and description. None - - DatapointName + + appliesTo - Specifies the name of the datapoint for which to configure alerts. + Specifies the applies to expression for the property source. String @@ -62343,10 +82335,10 @@ Updates the instance with ID 123 with a new display name and description. None - - InstanceName + + TechNotes - Specifies the name of the instance for which to configure alerts. + Specifies technical notes for the property source. String @@ -62356,33 +82348,33 @@ Updates the instance with ID 123 with a new display name and description.None - DisableAlerting + Tags - Specifies whether to disable alerting for this instance. + Specifies an array of tags to associate with the property source. - Boolean + String[] - Boolean + String[] None - AlertExpressionNote + TagsMethod - Specifies a note for the alert expression. + Specifies how to handle tags. Valid values: "Add" (append to existing), "Refresh" (replace existing). String String - None + Refresh - - AlertExpression + + Group - Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + Specifies the group for the property source. String @@ -62391,41 +82383,29 @@ Updates the instance with ID 123 with a new display name and description. None - - AlertClearTransitionInterval - - Specifies the interval for alert clear transitions. Must be between 0 and 60. - - Int32 - - Int32 - - - 0 - - - AlertTransitionInterval + + ScriptType - Specifies the interval for alert transitions. Must be between 0 and 60. + Specifies the script type. Valid values: "embed", "powerShell". - Int32 + String - Int32 + String - 0 + None - - AlertForNoData + + Script - Specifies the alert level for no data conditions. Must be between 1 and 4. + Specifies the script content. - Int32 + String - Int32 + String - 0 + None WhatIf @@ -62477,7 +82457,7 @@ Updates the instance with ID 123 with a new display name and description. - Returns a LogicMonitor.AlertSetting object containing the updated alert settings. + Returns a LogicMonitor.Propertysource object containing the updated configuration. @@ -62492,8 +82472,8 @@ Updates the instance with ID 123 with a new display name and description. -------------------------- EXAMPLE 1 -------------------------- - 90" -Updates the alert settings for the CPU Usage datapoint on the specified device. + Set-LMPropertysource -Id 123 -NewName "UpdatedSource" -Description "New description" -Tags @("prod", "windows") +Updates the property source with new name, description, and tags. @@ -62503,107 +82483,47 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< - Set-LMDeviceGroup + Set-LMPushModuleDeviceProperty Set - LMDeviceGroup + LMPushModuleDeviceProperty - Updates a LogicMonitor device group configuration. + Updates a device property using the LogicMonitor Push Module. - The Set-LMDeviceGroup function modifies an existing device group in LogicMonitor, allowing updates to its name, description, properties, and various other settings. + The Set-LMPushModuleDeviceProperty function modifies a property value for a device using the LogicMonitor Push Module API. - Set-LMDeviceGroup - + Set-LMPushModuleDeviceProperty + Id - Specifies the ID of the device group to modify. - - String - - String - - - None - - - NewName - - Specifies the new name for the device group. - - String - - String - - - None - - - Description - - Specifies the new description for the device group. - - String - - String - - - None - - - Properties - - Specifies a hashtable of custom properties for the device group. + Specifies the ID of the device. - Hashtable + Int32 - Hashtable + Int32 - None + 0 - - PropertiesMethod + + PropertyName - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + Specifies the name of the property to update. String String - Replace - - - DisableAlerting - - Specifies whether to disable alerting for the device group. - - Boolean - - Boolean - - - None - - - EnableNetFlow - - Specifies whether to enable NetFlow for the device group. - - Boolean - - Boolean - - None - - AppliesTo + + PropertyValue - Specifies the applies to expression for the device group. + Specifies the new value for the property. String @@ -62612,18 +82532,6 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None - - ParentGroupId - - Specifies the ID of the parent group. - - Int32 - - Int32 - - - None - WhatIf @@ -62660,95 +82568,23 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< - Set-LMDeviceGroup - - Id - - Specifies the ID of the device group to modify. - - String - - String - - - None - - - NewName - - Specifies the new name for the device group. - - String - - String - - - None - - - Description - - Specifies the new description for the device group. - - String - - String - - - None - - - Properties - - Specifies a hashtable of custom properties for the device group. - - Hashtable - - Hashtable - - - None - - - PropertiesMethod + Set-LMPushModuleDeviceProperty + + Name - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + Specifies the name of the device. String String - Replace - - - DisableAlerting - - Specifies whether to disable alerting for the device group. - - Boolean - - Boolean - - - None - - - EnableNetFlow - - Specifies whether to enable NetFlow for the device group. - - Boolean - - Boolean - - None - - AppliesTo + + PropertyName - Specifies the applies to expression for the device group. + Specifies the name of the property to update. String @@ -62757,10 +82593,10 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None - - ParentGroupName + + PropertyValue - Specifies the name of the parent group. + Specifies the new value for the property. String @@ -62804,36 +82640,161 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None + + + + Id + + Specifies the ID of the device. + + Int32 + + Int32 + + + 0 + + + Name + + Specifies the name of the device. + + String + + String + + + None + + + PropertyName + + Specifies the name of the property to update. + + String + + String + + + None + + + PropertyValue + + Specifies the new value for the property. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. + + + + + + + + + + Returns the response from the API indicating the success of the property update. + + + + + + + + + This function requires a valid LogicMonitor API authentication. + + + + + -------------------------- EXAMPLE 1 -------------------------- + Set-LMPushModuleDeviceProperty -Id 123 -PropertyName "location" -PropertyValue "New York" +Updates the location property for device ID 123. + + + + + + + + + + Set-LMPushModuleInstanceProperty + Set + LMPushModuleInstanceProperty + + Updates an instance property using the LogicMonitor Push Module. + + + + The Set-LMPushModuleInstanceProperty function modifies a property value for a datasource instance using the LogicMonitor Push Module API. + + - Set-LMDeviceGroup + Set-LMPushModuleInstanceProperty - Name - - Specifies the current name of the device group. - - String - - String - - - None - - - NewName + DeviceId - Specifies the new name for the device group. + Specifies the ID of the device. - String + Int32 - String + Int32 - None + 0 - - Description + + DataSourceName - Specifies the new description for the device group. + Specifies the name of the datasource. String @@ -62842,58 +82803,22 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None - - Properties - - Specifies a hashtable of custom properties for the device group. - - Hashtable - - Hashtable - - - None - - - PropertiesMethod + + InstanceName - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + Specifies the name of the instance. String String - Replace - - - DisableAlerting - - Specifies whether to disable alerting for the device group. - - Boolean - - Boolean - - - None - - - EnableNetFlow - - Specifies whether to enable NetFlow for the device group. - - Boolean - - Boolean - - None - - AppliesTo + + PropertyName - Specifies the applies to expression for the device group. + Specifies the name of the property to update. String @@ -62902,10 +82827,10 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None - - ParentGroupName + + PropertyValue - Specifies the name of the parent group. + Specifies the new value for the property. String @@ -62950,23 +82875,11 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< - Set-LMDeviceGroup + Set-LMPushModuleInstanceProperty - Name - - Specifies the current name of the device group. - - String - - String - - - None - - - NewName + DeviceName - Specifies the new name for the device group. + Specifies the name of the device. String @@ -62975,10 +82888,10 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None - - Description + + DataSourceName - Specifies the new description for the device group. + Specifies the name of the datasource. String @@ -62987,58 +82900,22 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None - - Properties - - Specifies a hashtable of custom properties for the device group. - - Hashtable - - Hashtable - - - None - - - PropertiesMethod + + InstanceName - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + Specifies the name of the instance. String String - Replace - - - DisableAlerting - - Specifies whether to disable alerting for the device group. - - Boolean - - Boolean - - None - - EnableNetFlow - - Specifies whether to enable NetFlow for the device group. - - Boolean - - Boolean - - - None - - - AppliesTo + + PropertyName - Specifies the applies to expression for the device group. + Specifies the name of the property to update. String @@ -63047,14 +82924,14 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None - - ParentGroupId + + PropertyValue - Specifies the ID of the parent group. + Specifies the new value for the property. - Int32 + String - Int32 + String None @@ -63096,34 +82973,22 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< - - Id - - Specifies the ID of the device group to modify. - - String - - String - - - None - - Name + DeviceId - Specifies the current name of the device group. + Specifies the ID of the device. - String + Int32 - String + Int32 - None + 0 - - NewName + + DeviceName - Specifies the new name for the device group. + Specifies the name of the device. String @@ -63132,10 +82997,10 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None - - Description + + DataSourceName - Specifies the new description for the device group. + Specifies the name of the datasource. String @@ -63144,58 +83009,22 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None - - Properties - - Specifies a hashtable of custom properties for the device group. - - Hashtable - - Hashtable - - - None - - - PropertiesMethod + + InstanceName - Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". + Specifies the name of the instance. String String - Replace - - - DisableAlerting - - Specifies whether to disable alerting for the device group. - - Boolean - - Boolean - - - None - - - EnableNetFlow - - Specifies whether to enable NetFlow for the device group. - - Boolean - - Boolean - - None - - AppliesTo + + PropertyName - Specifies the applies to expression for the device group. + Specifies the name of the property to update. String @@ -63204,22 +83033,10 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< None - - ParentGroupId - - Specifies the ID of the parent group. - - Int32 - - Int32 - - - None - - - ParentGroupName + + PropertyValue - Specifies the name of the parent group. + Specifies the new value for the property. String @@ -63268,7 +83085,7 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< - You can pipe objects containing Id properties to this function. + None. @@ -63278,7 +83095,7 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< - Returns a LogicMonitor.DeviceGroup object containing the updated group information. + Returns the response from the API indicating the success of the property update. @@ -63293,8 +83110,8 @@ Updates the alert settings for the CPU Usage datapoint on the specified device.< -------------------------- EXAMPLE 1 -------------------------- - Set-LMDeviceGroup -Id 123 -NewName "Updated Group" -Description "New description" -Updates the device group with ID 123 with a new name and description. + Set-LMPushModuleInstanceProperty -DeviceId 123 -DataSourceName "CPU" -InstanceName "Total" -PropertyName "threshold" -PropertyValue "90" +Updates the threshold property for the CPU Total instance on device ID 123. @@ -63304,35 +83121,23 @@ Updates the device group with ID 123 with a new name and description. - Set-LMDeviceGroupDatasourceAlertSetting + Set-LMRecipientGroup Set - LMDeviceGroupDatasourceAlertSetting + LMRecipientGroup - Updates alert settings for a LogicMonitor device group datasource. + Update a LogicMonitor recipient group. - The Set-LMDeviceGroupDatasourceAlertSetting function modifies alert settings for a specific device group datasource in LogicMonitor. + The Set-LMRecipientGroup function updates a LogicMonitor recipient group with the specified parameters. - Set-LMDeviceGroupDatasourceAlertSetting - - DatasourceName - - Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. - - String - - String - - - None - - - Name + Set-LMRecipientGroup + + Id - Specifies the name of the device group. + The id of the recipient group. This parameter is mandatory. String @@ -63341,10 +83146,10 @@ Updates the device group with ID 123 with a new name and description. None - - DatapointName + + NewName - Specifies the name of the datapoint for which to configure alerts. + The new name of the recipient group. This parameter is optional. String @@ -63354,21 +83159,9 @@ Updates the device group with ID 123 with a new name and description. None - DisableAlerting - - Specifies whether to disable alerting for this datasource. - - Boolean - - Boolean - - - None - - - AlertExpressionNote + Description - Specifies a note for the alert expression. + The description of the recipient group. This parameter is optional. String @@ -63377,53 +83170,39 @@ Updates the device group with ID 123 with a new name and description. None - - AlertExpression + + Recipients - Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + A object containing the recipients for the recipient group. - String + PSObject - String + PSObject None - - AlertClearTransitionInterval - - Specifies the interval for alert clear transitions. Must be between 0 and 60. - - Int32 - - Int32 - - - 0 - - - AlertTransitionInterval + + WhatIf - Specifies the interval for alert transitions. Must be between 0 and 60. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - AlertForNoData + + Confirm - Specifies the alert level for no data conditions. Must be between 1 and 4. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False ProgressAction @@ -63439,11 +83218,11 @@ Updates the device group with ID 123 with a new name and description. - Set-LMDeviceGroupDatasourceAlertSetting + Set-LMRecipientGroup - DatasourceName + Name - Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. + The name of the recipient group to lookup instead of the id. This parameter is optional. String @@ -63452,22 +83231,10 @@ Updates the device group with ID 123 with a new name and description. None - - Id - - Specifies the ID of the device group. - - Int32 - - Int32 - - - 0 - - - DatapointName + + NewName - Specifies the name of the datapoint for which to configure alerts. + The new name of the recipient group. This parameter is optional. String @@ -63477,21 +83244,9 @@ Updates the device group with ID 123 with a new name and description. None - DisableAlerting - - Specifies whether to disable alerting for this datasource. - - Boolean - - Boolean - - - None - - - AlertExpressionNote + Description - Specifies a note for the alert expression. + The description of the recipient group. This parameter is optional. String @@ -63500,53 +83255,39 @@ Updates the device group with ID 123 with a new name and description. None - - AlertExpression + + Recipients - Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + A object containing the recipients for the recipient group. - String + PSObject - String + PSObject None - - AlertClearTransitionInterval - - Specifies the interval for alert clear transitions. Must be between 0 and 60. - - Int32 - - Int32 - - - 0 - - - AlertTransitionInterval + + WhatIf - Specifies the interval for alert transitions. Must be between 0 and 60. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - AlertForNoData + + Confirm - Specifies the alert level for no data conditions. Must be between 1 and 4. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False ProgressAction @@ -63561,96 +83302,170 @@ Updates the device group with ID 123 with a new name and description. None + + + + Id + + The id of the recipient group. This parameter is mandatory. + + String + + String + + + None + + + Name + + The name of the recipient group to lookup instead of the id. This parameter is optional. + + String + + String + + + None + + + NewName + + The new name of the recipient group. This parameter is optional. + + String + + String + + + None + + + Description + + The description of the recipient group. This parameter is optional. + + String + + String + + + None + + + Recipients + + A object containing the recipients for the recipient group. + + PSObject + + PSObject + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None. You cannot pipe objects to this command. + + + + + + + + + + Returns LogicMonitor.RecipientGroup object. + + + + + + + + + This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command. + + + + + -------------------------- EXAMPLE 1 -------------------------- + $recipients = @( + New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'email' + New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'sms' + New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'voice' + New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'smsemail' + New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method '<name_of_existing_integration>' + New-LMRecipient -Type 'ARBITRARY' -Addr 'someone@other.com' -Method 'email' + New-LMRecipient -Type 'GROUP' -Addr 'Helpdesk' +) +Set-LMRecipientGroup -Id "1234567890" -NewName "MyRecipientGroupUpdated" -Description "This is a test recipient group updated" -Recipients $recipients +This example updates a LogicMonitor recipient group named "MyRecipientGroupUpdated" with a description and recipients built using the New-LMRecipient function. + + + + + + + + + + Set-LMReportGroup + Set + LMReportGroup + + Updates a LogicMonitor report group configuration. + + + + The Set-LMReportGroup function modifies an existing report group in LogicMonitor. + + - Set-LMDeviceGroupDatasourceAlertSetting - - DatasourceId - - Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the name of the device group. - - String - - String - - - None - - - DatapointName - - Specifies the name of the datapoint for which to configure alerts. - - String - - String - - - None - - - DisableAlerting - - Specifies whether to disable alerting for this datasource. - - Boolean - - Boolean - - - None - - - AlertExpressionNote - - Specifies a note for the alert expression. - - String - - String - - - None - - - AlertExpression - - Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". - - String - - String - - - None - - - AlertClearTransitionInterval - - Specifies the interval for alert clear transitions. Must be between 0 and 60. - - Int32 - - Int32 - - - 0 - - - AlertTransitionInterval + Set-LMReportGroup + + Id - Specifies the interval for alert transitions. Must be between 0 and 60. + Specifies the ID of the report group to modify. Int32 @@ -63659,85 +83474,83 @@ Updates the device group with ID 123 with a new name and description. 0 - - AlertForNoData + + NewName - Specifies the alert level for no data conditions. Must be between 1 and 4. + Specifies the new name for the report group. - Int32 + String - Int32 + String - 0 + None - - ProgressAction + + Description - {{ Fill ProgressAction Description }} + Specifies the new description for the report group. - ActionPreference + String - ActionPreference + String None - - - Set-LMDeviceGroupDatasourceAlertSetting - - DatasourceId + + WhatIf - Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - Id + + Confirm - Specifies the ID of the device group. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False - - DatapointName + + ProgressAction - Specifies the name of the datapoint for which to configure alerts. + {{ Fill ProgressAction Description }} - String + ActionPreference - String + ActionPreference None + + + Set-LMReportGroup - DisableAlerting + Name - Specifies whether to disable alerting for this datasource. + Specifies the current name of the report group. - Boolean + String - Boolean + String None - AlertExpressionNote + NewName - Specifies a note for the alert expression. + Specifies the new name for the report group. String @@ -63746,10 +83559,10 @@ Updates the device group with ID 123 with a new name and description. None - - AlertExpression + + Description - Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + Specifies the new description for the report group. String @@ -63758,41 +83571,27 @@ Updates the device group with ID 123 with a new name and description. None - - AlertClearTransitionInterval - - Specifies the interval for alert clear transitions. Must be between 0 and 60. - - Int32 - - Int32 - - - 0 - - - AlertTransitionInterval + + WhatIf - Specifies the interval for alert transitions. Must be between 0 and 60. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 - Int32 + SwitchParameter - 0 + False - - AlertForNoData + + Confirm - Specifies the alert level for no data conditions. Must be between 1 and 4. + Prompts you for confirmation before running the cmdlet. - Int32 - Int32 + SwitchParameter - 0 + False ProgressAction @@ -63809,34 +83608,10 @@ Updates the device group with ID 123 with a new name and description. - - DatasourceName - - Specifies the name of the datasource. Required when using the 'Id-dsName' or 'Name-dsName' parameter sets. - - String - - String - - - None - - - DatasourceId - - Specifies the ID of the datasource. Required when using the 'Id-dsId' or 'Name-dsId' parameter sets. - - Int32 - - Int32 - - - 0 - - + Id - Specifies the ID of the device group. + Specifies the ID of the report group to modify. Int32 @@ -63845,22 +83620,10 @@ Updates the device group with ID 123 with a new name and description. 0 - + Name - Specifies the name of the device group. - - String - - String - - - None - - - DatapointName - - Specifies the name of the datapoint for which to configure alerts. + Specifies the current name of the report group. String @@ -63870,21 +83633,9 @@ Updates the device group with ID 123 with a new name and description. None - DisableAlerting - - Specifies whether to disable alerting for this datasource. - - Boolean - - Boolean - - - None - - - AlertExpressionNote + NewName - Specifies a note for the alert expression. + Specifies the new name for the report group. String @@ -63893,10 +83644,10 @@ Updates the device group with ID 123 with a new name and description. None - - AlertExpression + + Description - Specifies the alert expression in the format "(01:00 02:00) > -100 timezone=America/New_York". + Specifies the new description for the report group. String @@ -63905,41 +83656,29 @@ Updates the device group with ID 123 with a new name and description. None - - AlertClearTransitionInterval - - Specifies the interval for alert clear transitions. Must be between 0 and 60. - - Int32 - - Int32 - - - 0 - - - AlertTransitionInterval + + WhatIf - Specifies the interval for alert transitions. Must be between 0 and 60. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32 + SwitchParameter - Int32 + SwitchParameter - 0 + False - - AlertForNoData + + Confirm - Specifies the alert level for no data conditions. Must be between 1 and 4. + Prompts you for confirmation before running the cmdlet. - Int32 + SwitchParameter - Int32 + SwitchParameter - 0 + False ProgressAction @@ -63967,7 +83706,7 @@ Updates the device group with ID 123 with a new name and description. - Returns a LogicMonitor.DeviceGroupDatasourceAlertSetting object containing the updated alert settings. + Returns a LogicMonitor.NetScanGroup object containing the updated group information. @@ -63982,8 +83721,8 @@ Updates the device group with ID 123 with a new name and description. -------------------------- EXAMPLE 1 -------------------------- - 90" -Updates the alert settings for the CPU Usage datapoint on the specified device group. + Set-LMReportGroup -Id 123 -NewName "Updated Reports" -Description "New description" +Updates the report group with ID 123 with a new name and description. @@ -63993,35 +83732,35 @@ Updates the alert settings for the CPU Usage datapoint on the specified device g - Set-LMDeviceProperty + Set-LMRole Set - LMDeviceProperty + LMRole - Updates a property value for a LogicMonitor device. + Updates a LogicMonitor role configuration. - The Set-LMDeviceProperty function modifies the value of a specific property for a device in LogicMonitor. + The Set-LMRole function modifies an existing role in LogicMonitor, including its permissions and privileges. - Set-LMDeviceProperty + Set-LMRole Id - Specifies the ID of the device. This parameter is mandatory when using the 'Id' parameter set. + Specifies the ID of the role to modify. - Int32 + String - Int32 + String - 0 + None - - PropertyName + + NewName - Specifies the name of the property to update. + Specifies the new name for the role. String @@ -64030,10 +83769,10 @@ Updates the alert settings for the CPU Usage datapoint on the specified device g None - - PropertyValue + + CustomHelpLabel - Specifies the new value for the property. + Specifies the custom help label for the role. String @@ -64042,25 +83781,22 @@ Updates the alert settings for the CPU Usage datapoint on the specified device g None - - ProgressAction + + CustomHelpURL - {{ Fill ProgressAction Description }} + Specifies the custom help URL for the role. - ActionPreference + String - ActionPreference + String None - - - Set-LMDeviceProperty - - Name + + Description - Specifies the name of the device. This parameter is mandatory when using the 'Name' parameter set. + Specifies the description for the role. String @@ -64069,10 +83805,32 @@ Updates the alert settings for the CPU Usage datapoint on the specified device g None - - PropertyName + + RequireEULA - Specifies the name of the property to update. + Indicates whether to require EULA acceptance. + + + SwitchParameter + + + False + + + TwoFARequired + + Indicates whether to require two-factor authentication. + + + SwitchParameter + + + False + + + RoleGroupId + + Specifies the role group ID. String @@ -64081,17 +83839,223 @@ Updates the alert settings for the CPU Usage datapoint on the specified device g None - - PropertyValue + + DashboardsPermission - Specifies the new value for the property. + Specifies dashboard permissions. Valid values: "view", "manage", "none". + + String + + String + + + None + + + ResourcePermission + + Specifies resource permissions. Valid values: "view", "manage", "none". + + String + + String + + + None + + + LMXToolBoxPermission + + {{ Fill LMXToolBoxPermission Description }} + + String + + String + + + None + + + LMXPermission + + {{ Fill LMXPermission Description }} + + String + + String + + + None + + + LogsPermission + + {{ Fill LogsPermission Description }} + + String + + String + + + None + + + WebsitesPermission + + {{ Fill WebsitesPermission Description }} + + String + + String + + + None + + + SavedMapsPermission + + {{ Fill SavedMapsPermission Description }} + + String + + String + + + None + + + ReportsPermission + + {{ Fill ReportsPermission Description }} + + String + + String + + + None + + + SettingsPermission + + Specifies settings permissions. Valid values: "view", "manage", "none", "manage-collectors", "view-collectors". String String - None + None + + + CreatePrivateDashboards + + {{ Fill CreatePrivateDashboards Description }} + + + SwitchParameter + + + False + + + AllowWidgetSharing + + {{ Fill AllowWidgetSharing Description }} + + + SwitchParameter + + + False + + + ConfigTabRequiresManagePermission + + {{ Fill ConfigTabRequiresManagePermission Description }} + + + SwitchParameter + + + False + + + AllowedToViewMapsTab + + {{ Fill AllowedToViewMapsTab Description }} + + + SwitchParameter + + + False + + + AllowedToManageResourceDashboards + + {{ Fill AllowedToManageResourceDashboards Description }} + + + SwitchParameter + + + False + + + ViewTraces + + {{ Fill ViewTraces Description }} + + + SwitchParameter + + + False + + + ViewSupport + + {{ Fill ViewSupport Description }} + + + SwitchParameter + + + False + + + EnableRemoteSessionForResources + + {{ Fill EnableRemoteSessionForResources Description }} + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False ProgressAction @@ -64106,137 +84070,24 @@ Updates the alert settings for the CPU Usage datapoint on the specified device g None - - - - Id - - Specifies the ID of the device. This parameter is mandatory when using the 'Id' parameter set. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the name of the device. This parameter is mandatory when using the 'Name' parameter set. - - String - - String - - - None - - - PropertyName - - Specifies the name of the property to update. - - String - - String - - - None - - - PropertyValue - - Specifies the new value for the property. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe objects containing Id properties to this function. - - - - - - - - - - Returns the response from the API indicating the success of the property update. - - - - - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMDeviceProperty -Id 123 -PropertyName "Location" -PropertyValue "New York" -Updates the "Location" property to "New York" for the device with ID 123. - - - - - - - - - - Set-LMLogPartition - Set - LMLogPartition - - Updates a LogicMonitor Log Partition configuration. - - - - The Set-LMLogPartition function modifies an existing log partition in LogicMonitor. - - - Set-LMLogPartition - + Set-LMRole + Id - Specifies the ID of the log partition to modify. + Specifies the ID of the role to modify. - Int32 + String - Int32 + String - 0 + None - Description + NewName - Specifies the new description for the log partition. + Specifies the new name for the role. String @@ -64246,21 +84097,21 @@ Updates the "Location" property to "New York" for the device with ID 123.None - Retention + CustomHelpLabel - Specifies the new retention for the log partition. + Specifies the custom help label for the role. - Int32 + String - Int32 + String None - Sku + CustomHelpURL - Specifies the new sku for the log partition. + Specifies the custom help URL for the role. String @@ -64270,9 +84121,9 @@ Updates the "Location" property to "New York" for the device with ID 123.None - Status + Description - Specifies the new status for the log partition. Possible values are "active" or "inactive". + Specifies the description for the role. String @@ -64281,37 +84132,32 @@ Updates the "Location" property to "New York" for the device with ID 123. None - - ProgressAction + + RequireEULA - {{ Fill ProgressAction Description }} + Indicates whether to require EULA acceptance. - ActionPreference - ActionPreference + SwitchParameter - None + False - - - Set-LMLogPartition - Name + TwoFARequired - Specifies the current name of the log partition. + Indicates whether to require two-factor authentication. - String - String + SwitchParameter - None + False - Description + RoleGroupId - Specifies the new description for the log partition. + Specifies the role group ID. String @@ -64320,41 +84166,39 @@ Updates the "Location" property to "New York" for the device with ID 123. None - - Retention + + CustomPrivilegesObject - Specifies the new retention for the log partition. + Specifies custom privileges for the role. - Int32 + PSObject - Int32 + PSObject None - - Sku + + WhatIf - Specifies the new sku for the log partition. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - Status + + Confirm - Specifies the new status for the log partition. Possible values are "active" or "inactive". + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -64369,161 +84213,24 @@ Updates the "Location" property to "New York" for the device with ID 123.None - - - - Id - - Specifies the ID of the log partition to modify. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the current name of the log partition. - - String - - String - - - None - - - Description - - Specifies the new description for the log partition. - - String - - String - - - None - - - Retention - - Specifies the new retention for the log partition. - - Int32 - - Int32 - - - None - - - Sku - - Specifies the new sku for the log partition. - - String - - String - - - None - - - Status - - Specifies the new status for the log partition. Possible values are "active" or "inactive". - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. - - - - - - - - - - Returns a LogicMonitor.LogPartition object containing the updated log partition information. - - - - - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMLogPartition -Id 123 -Description "New description" -Retention 30 -Status "active" -Updates the log partition with ID 123 with a new description, retention, and status. - - - - - - - - - - Set-LMLogPartitionAction - Set - LMLogPartitionAction - - Updates a LogicMonitor Log Partition configuration to either pause or resume log ingestion. - - - - The Set-LMLogPartitionAction function modifies an existing log partition action in LogicMonitor. - - - Set-LMLogPartitionAction - - Id + Set-LMRole + + Name - Specifies the ID of the log partition action to modify. + Specifies the current name of the role. - Int32 + String - Int32 + String - 0 + None - - Action + + NewName - Specifies the new action for the log partition. Possible values are "pause" or "resume". + Specifies the new name for the role. String @@ -64532,25 +84239,22 @@ Updates the log partition with ID 123 with a new description, retention, and sta None - - ProgressAction + + CustomHelpLabel - {{ Fill ProgressAction Description }} + Specifies the custom help label for the role. - ActionPreference + String - ActionPreference + String None - - - Set-LMLogPartitionAction - Name + CustomHelpURL - Specifies the current name of the log partition to modify. + Specifies the custom help URL for the role. String @@ -64559,10 +84263,10 @@ Updates the log partition with ID 123 with a new description, retention, and sta None - - Action + + Description - Specifies the new action for the log partition. Possible values are "pause" or "resume". + Specifies the description for the role. String @@ -64571,126 +84275,32 @@ Updates the log partition with ID 123 with a new description, retention, and sta None - - ProgressAction + + RequireEULA - {{ Fill ProgressAction Description }} + Indicates whether to require EULA acceptance. - ActionPreference - ActionPreference + SwitchParameter - None + False - - - - - Id - - Specifies the ID of the log partition action to modify. - - Int32 - - Int32 - - - 0 - - - Name - - Specifies the current name of the log partition to modify. - - String - - String - - - None - - - Action - - Specifies the new action for the log partition. Possible values are "pause" or "resume". - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. - - - - - - - - - - Returns a LogicMonitor.LogPartition object containing the updated log partition information. - - - - - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMLogPartitionAction -Id 123 -Action "pause" -Updates the log partition with ID 123 to pause log ingestion. - - - - - - - - - - Set-LMNetscan - Set - LMNetscan - - Updates a LogicMonitor NetScan configuration. - - - - The Set-LMNetscan function modifies an existing NetScan configuration in LogicMonitor. - - - - Set-LMNetscan - - CollectorId + + TwoFARequired + + Indicates whether to require two-factor authentication. + + + SwitchParameter + + + False + + + RoleGroupId - Specifies the ID of the collector to use for the NetScan. + Specifies the role group ID. String @@ -64699,10 +84309,10 @@ Updates the log partition with ID 123 to pause log ingestion. None - - NetScanGroupId + + DashboardsPermission - Specifies the ID of the NetScan group. + Specifies dashboard permissions. Valid values: "view", "manage", "none". String @@ -64711,10 +84321,10 @@ Updates the log partition with ID 123 to pause log ingestion. None - - SubnetRange + + ResourcePermission - Specifies the subnet range to scan. + Specifies resource permissions. Valid values: "view", "manage", "none". String @@ -64723,10 +84333,10 @@ Updates the log partition with ID 123 to pause log ingestion. None - - CredentialGroupId + + LMXToolBoxPermission - Specifies the ID of the credential group. + {{ Fill LMXToolBoxPermission Description }} String @@ -64735,10 +84345,10 @@ Updates the log partition with ID 123 to pause log ingestion. None - - CredentialGroupName + + LMXPermission - Specifies the name of the credential group. + {{ Fill LMXPermission Description }} String @@ -64747,22 +84357,22 @@ Updates the log partition with ID 123 to pause log ingestion. None - - Schedule + + LogsPermission - Specifies the scanning schedule configuration. + {{ Fill LogsPermission Description }} - PSObject + String - PSObject + String None - - ChangeNameToken + + WebsitesPermission - Specifies the token for changing names. + {{ Fill WebsitesPermission Description }} String @@ -64771,10 +84381,10 @@ Updates the log partition with ID 123 to pause log ingestion. None - - PortList + + SavedMapsPermission - Specifies the list of ports to scan. + {{ Fill SavedMapsPermission Description }} String @@ -64783,10 +84393,10 @@ Updates the log partition with ID 123 to pause log ingestion. None - - Name + + ReportsPermission - Specifies the name of the NetScan. + {{ Fill ReportsPermission Description }} String @@ -64795,10 +84405,10 @@ Updates the log partition with ID 123 to pause log ingestion. None - - Id + + SettingsPermission - Specifies the ID of the NetScan to modify. + Specifies settings permissions. Valid values: "view", "manage", "none", "manage-collectors", "view-collectors". String @@ -64807,77 +84417,115 @@ Updates the log partition with ID 123 to pause log ingestion. None - - Description + + CreatePrivateDashboards - Specifies the description for the NetScan. + {{ Fill CreatePrivateDashboards Description }} - String - String + SwitchParameter - None + False - - ExcludeDuplicateType + + AllowWidgetSharing - Specifies the type of duplicates to exclude. + {{ Fill AllowWidgetSharing Description }} - String - String + SwitchParameter - None + False - - IgnoreSystemIpDuplpicates + + ConfigTabRequiresManagePermission - Specifies whether to ignore system IP duplicates. + {{ Fill ConfigTabRequiresManagePermission Description }} - Boolean - Boolean + SwitchParameter - None + False - - Method + + AllowedToViewMapsTab - Specifies the scanning method to use. + {{ Fill AllowedToViewMapsTab Description }} - String - String + SwitchParameter - None + False - - NextStart + + AllowedToManageResourceDashboards - Specifies when the next scan should start. + {{ Fill AllowedToManageResourceDashboards Description }} - String - String + SwitchParameter - None + False - - NextStartEpoch + + ViewTraces - Specifies when the next scan should start in epoch time. + {{ Fill ViewTraces Description }} - String - String + SwitchParameter - None + False + + + ViewSupport + + {{ Fill ViewSupport Description }} + + + SwitchParameter + + + False + + + EnableRemoteSessionForResources + + {{ Fill EnableRemoteSessionForResources Description }} + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False ProgressAction @@ -64892,281 +84540,24 @@ Updates the log partition with ID 123 to pause log ingestion. None - - - - CollectorId - - Specifies the ID of the collector to use for the NetScan. - - String - - String - - - None - - - Name - - Specifies the name of the NetScan. - - String - - String - - - None - - - Id - - Specifies the ID of the NetScan to modify. - - String - - String - - - None - - - Description - - Specifies the description for the NetScan. - - String - - String - - - None - - - ExcludeDuplicateType - - Specifies the type of duplicates to exclude. - - String - - String - - - None - - - IgnoreSystemIpDuplpicates - - Specifies whether to ignore system IP duplicates. - - Boolean - - Boolean - - - None - - - Method - - Specifies the scanning method to use. - - String - - String - - - None - - - NextStart - - Specifies when the next scan should start. - - String - - String - - - None - - - NextStartEpoch - - Specifies when the next scan should start in epoch time. - - String - - String - - - None - - - NetScanGroupId - - Specifies the ID of the NetScan group. - - String - - String - - - None - - - SubnetRange - - Specifies the subnet range to scan. - - String - - String - - - None - - - CredentialGroupId - - Specifies the ID of the credential group. - - String - - String - - - None - - - CredentialGroupName - - Specifies the name of the credential group. - - String - - String - - - None - - - Schedule - - Specifies the scanning schedule configuration. - - PSObject - - PSObject - - - None - - - ChangeNameToken - - Specifies the token for changing names. - - String - - String - - - None - - - PortList - - Specifies the list of ports to scan. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe objects containing Id properties to this function. - - - - - - - - - - Returns a LogicMonitor.NetScan object containing the updated scan configuration. - - - - - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMNetscan -Id 123 -Name "UpdatedScan" -Description "New description" -Updates the NetScan with ID 123 with a new name and description. - - - - - - - - - - Set-LMNetscanGroup - Set - LMNetscanGroup - - Updates a LogicMonitor NetScan group configuration. - - - - The Set-LMNetscanGroup function modifies an existing NetScan group in LogicMonitor. - - - Set-LMNetscanGroup - - Id + Set-LMRole + + Name - Specifies the ID of the NetScan group to modify. + Specifies the current name of the role. - Int32 + String - Int32 + String - 0 + None NewName - Specifies the new name for the NetScan group. + Specifies the new name for the role. String @@ -65176,9 +84567,9 @@ Updates the NetScan with ID 123 with a new name and description. None - Description + CustomHelpLabel - Specifies the new description for the NetScan group. + Specifies the custom help label for the role. String @@ -65187,56 +84578,97 @@ Updates the NetScan with ID 123 with a new name and description. None - - ProgressAction + + CustomHelpURL - {{ Fill ProgressAction Description }} + Specifies the custom help URL for the role. - ActionPreference + String - ActionPreference + String None - - - Set-LMNetscanGroup - Name + Description - Specifies the current name of the NetScan group. + Specifies the description for the role. + + String + + String + + + None + + + RequireEULA + + Indicates whether to require EULA acceptance. + + + SwitchParameter + + + False + + + TwoFARequired + + Indicates whether to require two-factor authentication. + + + SwitchParameter + + + False + + + RoleGroupId + + Specifies the role group ID. + + String + + String + + + None + + + CustomPrivilegesObject + + Specifies custom privileges for the role. - String + PSObject - String + PSObject None - - NewName + + WhatIf - Specifies the new name for the NetScan group. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - Description + + Confirm - Specifies the new description for the NetScan group. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -65253,22 +84685,22 @@ Updates the NetScan with ID 123 with a new name and description. - + Id - Specifies the ID of the NetScan group to modify. + Specifies the ID of the role to modify. - Int32 + String - Int32 + String - 0 + None - + Name - Specifies the current name of the NetScan group. + Specifies the current name of the role. String @@ -65280,7 +84712,7 @@ Updates the NetScan with ID 123 with a new name and description. NewName - Specifies the new name for the NetScan group. + Specifies the new name for the role. String @@ -65290,9 +84722,9 @@ Updates the NetScan with ID 123 with a new name and description. None - Description + CustomHelpLabel - Specifies the new description for the NetScan group. + Specifies the custom help label for the role. String @@ -65301,114 +84733,58 @@ Updates the NetScan with ID 123 with a new name and description. None - - ProgressAction + + CustomHelpURL - {{ Fill ProgressAction Description }} + Specifies the custom help URL for the role. - ActionPreference + String - ActionPreference + String None - - - + + Description + + Specifies the description for the role. + + String - You can pipe objects containing Id properties to this function. + String + + None + + + RequireEULA - + Indicates whether to require EULA acceptance. - - - - + SwitchParameter - Returns a LogicMonitor.NetScanGroup object containing the updated group information. + SwitchParameter + + False + + + TwoFARequired - + Indicates whether to require two-factor authentication. - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMNetscanGroup -Id 123 -NewName "Updated Group" -Description "New description" -Updates the NetScan group with ID 123 with a new name and description. - - - - - - - - - - Set-LMNewUserMessage - Set - LMNewUserMessage - - Updates the new user message template in LogicMonitor. - - - - The Set-LMNewUserMessage function modifies the message template that is sent to new users in LogicMonitor. - - - - Set-LMNewUserMessage - - MessageBody - - Specifies the body content of the message template. - - String - - String - - - None - - - MessageSubject - - Specifies the subject line of the message template. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - MessageBody + SwitchParameter + + SwitchParameter + + + False + + + RoleGroupId - Specifies the body content of the message template. + Specifies the role group ID. String @@ -65417,10 +84793,10 @@ Updates the NetScan group with ID 123 with a new name and description. None - - MessageSubject + + DashboardsPermission - Specifies the subject line of the message template. + Specifies dashboard permissions. Valid values: "view", "manage", "none". String @@ -65429,175 +84805,58 @@ Updates the NetScan group with ID 123 with a new name and description. None - - ProgressAction + + ResourcePermission - {{ Fill ProgressAction Description }} + Specifies resource permissions. Valid values: "view", "manage", "none". - ActionPreference + String - ActionPreference + String None - - - + + LMXToolBoxPermission + + {{ Fill LMXToolBoxPermission Description }} + + String - None. + String + + None + + + LMXPermission - + {{ Fill LMXPermission Description }} - - - - + String - Returns the response from the API indicating the success of the update. + String + + None + + + LogsPermission - + {{ Fill LogsPermission Description }} - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMNewUserMessage -MessageBody "Welcome to our monitoring system" -MessageSubject "Welcome to LogicMonitor" -Updates the new user message template with the specified subject and body. - - - - - - - - - - Set-LMNormalizedProperties - Set - LMNormalizedProperties - - Updates normalized properties in LogicMonitor. - - - - The Set-LMNormalizedProperties cmdlet updates normalized properties in LogicMonitor. Normalized properties allow you to map multiple host properties to a single alias that can be used across your environment. - - - - Set-LMNormalizedProperties - - Alias - - The alias name for the normalized property. - - String - - String - - - None - - - Add - - Indicates that properties should be added to the existing normalized property. - - - SwitchParameter - - - False - - - Properties - - An array of host property names to map to the alias. - - Array - - Array - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Set-LMNormalizedProperties - - Alias - - The alias name for the normalized property. - - String - - String - - - None - - - Remove - - Indicates that properties should be removed from the existing normalized property. - - - SwitchParameter - - - False - - - Properties - - An array of host property names to map to the alias. - - Array - - Array - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - Alias + String + + String + + + None + + + WebsitesPermission - The alias name for the normalized property. + {{ Fill WebsitesPermission Description }} String @@ -65606,10 +84865,46 @@ Updates the new user message template with the specified subject and body. None - - Add + + SavedMapsPermission - Indicates that properties should be added to the existing normalized property. + {{ Fill SavedMapsPermission Description }} + + String + + String + + + None + + + ReportsPermission + + {{ Fill ReportsPermission Description }} + + String + + String + + + None + + + SettingsPermission + + Specifies settings permissions. Valid values: "view", "manage", "none", "manage-collectors", "view-collectors". + + String + + String + + + None + + + CreatePrivateDashboards + + {{ Fill CreatePrivateDashboards Description }} SwitchParameter @@ -65618,10 +84913,82 @@ Updates the new user message template with the specified subject and body. False - - Remove + + AllowWidgetSharing - Indicates that properties should be removed from the existing normalized property. + {{ Fill AllowWidgetSharing Description }} + + SwitchParameter + + SwitchParameter + + + False + + + ConfigTabRequiresManagePermission + + {{ Fill ConfigTabRequiresManagePermission Description }} + + SwitchParameter + + SwitchParameter + + + False + + + AllowedToViewMapsTab + + {{ Fill AllowedToViewMapsTab Description }} + + SwitchParameter + + SwitchParameter + + + False + + + AllowedToManageResourceDashboards + + {{ Fill AllowedToManageResourceDashboards Description }} + + SwitchParameter + + SwitchParameter + + + False + + + ViewTraces + + {{ Fill ViewTraces Description }} + + SwitchParameter + + SwitchParameter + + + False + + + ViewSupport + + {{ Fill ViewSupport Description }} + + SwitchParameter + + SwitchParameter + + + False + + + EnableRemoteSessionForResources + + {{ Fill EnableRemoteSessionForResources Description }} SwitchParameter @@ -65631,16 +84998,40 @@ Updates the new user message template with the specified subject and body.False - Properties + CustomPrivilegesObject - An array of host property names to map to the alias. + Specifies custom privileges for the role. + + PSObject + + PSObject + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. - Array + SwitchParameter - Array + SwitchParameter - None + False ProgressAction @@ -65668,7 +85059,7 @@ Updates the new user message template with the specified subject and body. - Returns a message indicating the success of the operation. + Returns a LogicMonitor.Role object containing the updated role configuration. @@ -65677,22 +85068,14 @@ Updates the new user message template with the specified subject and body. - This function requires a valid LogicMonitor API authentication and uses API v4. + This function requires a valid LogicMonitor API authentication. -------------------------- EXAMPLE 1 -------------------------- - Set-LMNormalizedProperties -Add -Alias "location" -Properties @("location", "snmp.sysLocation", "auto.meraki.location") -Updates a normalized property with alias "location" to include the new properties. - - - - - - -------------------------- EXAMPLE 2 -------------------------- - Set-LMNormalizedProperties -Remove -Alias "location" -Properties @("auto.meraki.location") -Removes the "auto.meraki.location" property from the "location" alias. + Set-LMRole -Id 123 -NewName "Updated Role" -Description "New description" -DashboardsPermission "view" +Updates the role with new name, description, and dashboard permissions. @@ -65702,23 +85085,23 @@ Removes the "auto.meraki.location" property from the "location" alias. - Set-LMOpsNote + Set-LMSDT Set - LMOpsNote + LMSDT - Updates an operations note in LogicMonitor. + Updates a Scheduled Down Time (SDT) entry in LogicMonitor. - The Set-LMOpsNote function modifies an existing operations note in LogicMonitor. + The Set-LMSDT function modifies an existing SDT entry in LogicMonitor, allowing updates to both one-time and recurring schedules. - Set-LMOpsNote - + Set-LMSDT + Id - Specifies the ID of the operations note to modify. + Specifies the ID of the SDT entry to modify. String @@ -65727,10 +85110,10 @@ Removes the "auto.meraki.location" property from the "location" alias. None - - Note + + Comment - Specifies the new content for the note. + Specifies a comment for the SDT entry. String @@ -65739,10 +85122,10 @@ Removes the "auto.meraki.location" property from the "location" alias. None - - NoteDate + + StartDate - Specifies the date and time for the note. + Specifies the start date and time for one-time SDT. DateTime @@ -65751,305 +85134,143 @@ Removes the "auto.meraki.location" property from the "location" alias. None - - Tags + + EndDate - Specifies an array of tags to associate with the note. + Specifies the end date and time for one-time SDT. - String[] + DateTime - String[] + DateTime None - - DeviceGroupIds + + WhatIf - Specifies an array of device group IDs to associate with the note. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String[] - String[] + SwitchParameter - None + False - - WebsiteIds + + Confirm - Specifies an array of website IDs to associate with the note. + Prompts you for confirmation before running the cmdlet. - String[] - String[] + SwitchParameter - None + False - - DeviceIds + + ProgressAction - Specifies an array of device IDs to associate with the note. + {{ Fill ProgressAction Description }} - String[] + ActionPreference - String[] + ActionPreference None - - ClearTags + + + Set-LMSDT + + Id - Indicates whether to clear all existing tags. + Specifies the ID of the SDT entry to modify. + String - SwitchParameter + String - False + None - - ProgressAction + + Comment - {{ Fill ProgressAction Description }} + Specifies a comment for the SDT entry. - ActionPreference + String - ActionPreference + String None - - - - - Id - - Specifies the ID of the operations note to modify. - - String - - String - - - None - - - Note - - Specifies the new content for the note. - - String - - String - - - None - - - NoteDate - - Specifies the date and time for the note. - - DateTime - - DateTime - - - None - - - Tags - - Specifies an array of tags to associate with the note. - - String[] - - String[] - - - None - - - ClearTags - - Indicates whether to clear all existing tags. - - SwitchParameter - - SwitchParameter - - - False - - - DeviceGroupIds - - Specifies an array of device group IDs to associate with the note. - - String[] - - String[] - - - None - - - WebsiteIds - - Specifies an array of website IDs to associate with the note. - - String[] - - String[] - - - None - - - DeviceIds - - Specifies an array of device IDs to associate with the note. - - String[] - - String[] - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - You can pipe objects containing Id properties to this function. - - - - - - - - - - Returns the response from the API containing the updated operations note information. - - - - - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMOpsNote -Id 123 -Note "Updated information" -Tags @("maintenance", "planned") -Updates the operations note with ID 123 with new content and tags. - - - - - - - - - - Set-LMPortalInfo - Set - LMPortalInfo - - Updates LogicMonitor portal settings. - - - - The Set-LMPortalInfo function modifies various portal-wide settings in LogicMonitor, including whitelisting, two-factor authentication, alert totals, and session timeouts. - - - - Set-LMPortalInfo - - Whitelist + + StartHour - Specifies IP addresses/ranges to whitelist for portal access. + Specifies the start hour (0-23) for recurring SDT. - String + Int32 - String + Int32 None - - RequireTwoFA + + StartMinute - Specifies whether to require two-factor authentication for all users. + Specifies the start minute (0-59) for recurring SDT. - Boolean + Int32 - Boolean + Int32 None - - IncludeACKinAlertTotals + + EndHour - Specifies whether to include acknowledged alerts in alert totals. + Specifies the end hour (0-23) for recurring SDT. - Boolean + Int32 - Boolean + Int32 None - - IncludeSDTinAlertTotals + + EndMinute - Specifies whether to include alerts in SDT in alert totals. + Specifies the end minute (0-59) for recurring SDT. - Boolean + Int32 - Boolean + Int32 None - - EnableRemoteSession + + WeekDay - Specifies whether to enable remote session functionality. + Specifies the day of the week for recurring SDT. - Boolean + String - Boolean + String None - - CompanyDisplayName + + WeekOfMonth - Specifies the company name to display in the portal. + Specifies which week of the month for recurring SDT. Valid values: "First", "Second", "Third", "Fourth", "Last". String @@ -66058,10 +85279,10 @@ Updates the operations note with ID 123 with new content and tags. None - - UserSessionTimeoutInMin + + DayOfMonth - Specifies the session timeout in minutes. Valid values: 30, 60, 120, 240, 480, 1440, 10080, 43200. + Specifies the day of the month (1-31) for recurring SDT. Int32 @@ -66070,10 +85291,21 @@ Updates the operations note with ID 123 with new content and tags. None - - ClearWhitelist + + WhatIf - Indicates whether to clear the existing whitelist. + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -66096,10 +85328,10 @@ Updates the operations note with ID 123 with new content and tags. - - Whitelist + + Id - Specifies IP addresses/ranges to whitelist for portal access. + Specifies the ID of the SDT entry to modify. String @@ -66109,69 +85341,93 @@ Updates the operations note with ID 123 with new content and tags. None - ClearWhitelist + Comment - Indicates whether to clear the existing whitelist. + Specifies a comment for the SDT entry. - SwitchParameter + String - SwitchParameter + String - False + None - - RequireTwoFA + + StartDate - Specifies whether to require two-factor authentication for all users. + Specifies the start date and time for one-time SDT. - Boolean + DateTime - Boolean + DateTime None - - IncludeACKinAlertTotals + + EndDate - Specifies whether to include acknowledged alerts in alert totals. + Specifies the end date and time for one-time SDT. - Boolean + DateTime - Boolean + DateTime None - - IncludeSDTinAlertTotals + + StartHour - Specifies whether to include alerts in SDT in alert totals. + Specifies the start hour (0-23) for recurring SDT. - Boolean + Int32 - Boolean + Int32 None - - EnableRemoteSession + + StartMinute - Specifies whether to enable remote session functionality. + Specifies the start minute (0-59) for recurring SDT. - Boolean + Int32 - Boolean + Int32 None - - CompanyDisplayName + + EndHour - Specifies the company name to display in the portal. + Specifies the end hour (0-23) for recurring SDT. + + Int32 + + Int32 + + + None + + + EndMinute + + Specifies the end minute (0-59) for recurring SDT. + + Int32 + + Int32 + + + None + + + WeekDay + + Specifies the day of the week for recurring SDT. String @@ -66180,10 +85436,22 @@ Updates the operations note with ID 123 with new content and tags. None - - UserSessionTimeoutInMin + + WeekOfMonth - Specifies the session timeout in minutes. Valid values: 30, 60, 120, 240, 480, 1440, 10080, 43200. + Specifies which week of the month for recurring SDT. Valid values: "First", "Second", "Third", "Fourth", "Last". + + String + + String + + + None + + + DayOfMonth + + Specifies the day of the month (1-31) for recurring SDT. Int32 @@ -66192,6 +85460,30 @@ Updates the operations note with ID 123 with new content and tags. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction @@ -66218,7 +85510,7 @@ Updates the operations note with ID 123 with new content and tags. - Returns the response from the API containing the updated portal settings. + Returns the response from the API containing the updated SDT configuration. @@ -66233,8 +85525,8 @@ Updates the operations note with ID 123 with new content and tags. -------------------------- EXAMPLE 1 -------------------------- - Set-LMPortalInfo -RequireTwoFA $true -UserSessionTimeoutInMin 60 -CompanyDisplayName "My Company" -Updates the portal settings to require 2FA, set session timeout to 60 minutes, and update company display name. + Set-LMSDT -Id 123 -StartDate "2024-01-01 00:00" -EndDate "2024-01-02 00:00" -Comment "Extended maintenance" +Updates a one-time SDT entry with new dates and comment. @@ -66244,23 +85536,47 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a - Set-LMPropertysource + Set-LMServiceGroup Set - LMPropertysource + LMServiceGroup - Updates a LogicMonitor property source configuration. + Updates a LogicMonitor Service group configuration. - The Set-LMPropertysource function modifies an existing property source in LogicMonitor. + The Set-LMServiceGroup function modifies an existing Service group in LogicMonitor, allowing updates to its name, description, properties, and various other settings. - Set-LMPropertysource + Set-LMServiceGroup Id - Specifies the ID of the property source to modify. + Specifies the ID of the Service group to modify. + + String + + String + + + None + + + NewName + + Specifies the new name for the Service group. + + String + + String + + + None + + + Description + + Specifies the new description for the Service group. String @@ -66270,21 +85586,94 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a None - NewName + Properties - Specifies the new name for the property source. + Specifies a hashtable of custom properties for the Service group. + + Hashtable + + Hashtable + + + None + + + PropertiesMethod + + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". String String + Replace + + + DisableAlerting + + Specifies whether to disable alerting for the Service group. + + Boolean + + Boolean + + None - Description + ParentGroupId - Specifies the description for the property source. + Specifies the ID of the parent group. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Set-LMServiceGroup + + Id + + Specifies the ID of the Service group to modify. String @@ -66294,9 +85683,9 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a None - appliesTo + NewName - Specifies the applies to expression for the property source. + Specifies the new name for the Service group. String @@ -66306,9 +85695,9 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a None - TechNotes + Description - Specifies technical notes for the property source. + Specifies the new description for the Service group. String @@ -66318,45 +85707,45 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a None - Tags + Properties - Specifies an array of tags to associate with the property source. + Specifies a hashtable of custom properties for the Service group. - String[] + Hashtable - String[] + Hashtable None - TagsMethod + PropertiesMethod - Specifies how to handle tags. Valid values: "Add" (append to existing), "Refresh" (replace existing). + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". String String - Refresh + Replace - Group + DisableAlerting - Specifies the group for the property source. + Specifies whether to disable alerting for the Service group. - String + Boolean - String + Boolean None - ScriptType + ParentGroupName - Specifies the script type. Valid values: "embed", "powerShell". + Specifies the name of the parent group. String @@ -66365,17 +85754,27 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a None - - Script + + WhatIf - Specifies the script content. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False ProgressAction @@ -66391,11 +85790,11 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a - Set-LMPropertysource + Set-LMServiceGroup Name - Specifies the current name of the property source. + Specifies the current name of the Service group. String @@ -66407,7 +85806,7 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a NewName - Specifies the new name for the property source. + Specifies the new name for the Service group. String @@ -66419,7 +85818,7 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a Description - Specifies the description for the property source. + Specifies the new description for the Service group. String @@ -66429,57 +85828,45 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a None - appliesTo + Properties - Specifies the applies to expression for the property source. + Specifies a hashtable of custom properties for the Service group. - String + Hashtable - String + Hashtable None - TechNotes + PropertiesMethod - Specifies technical notes for the property source. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". String String - None + Replace - Tags + DisableAlerting - Specifies an array of tags to associate with the property source. + Specifies whether to disable alerting for the Service group. - String[] + Boolean - String[] + Boolean None - TagsMethod - - Specifies how to handle tags. Valid values: "Add" (append to existing), "Refresh" (replace existing). - - String - - String - - - Refresh - - - Group + ParentGroupName - Specifies the group for the property source. + Specifies the name of the parent group. String @@ -66488,29 +85875,27 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a None - - ScriptType + + WhatIf - Specifies the script type. Valid values: "embed", "powerShell". + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - Script + + Confirm - Specifies the script content. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -66525,221 +85910,24 @@ Updates the portal settings to require 2FA, set session timeout to 60 minutes, a None - - - - Id - - Specifies the ID of the property source to modify. - - String - - String - - - None - - - Name - - Specifies the current name of the property source. - - String - - String - - - None - - - NewName - - Specifies the new name for the property source. - - String - - String - - - None - - - Description - - Specifies the description for the property source. - - String - - String - - - None - - - appliesTo - - Specifies the applies to expression for the property source. - - String - - String - - - None - - - TechNotes - - Specifies technical notes for the property source. - - String - - String - - - None - - - Tags - - Specifies an array of tags to associate with the property source. - - String[] - - String[] - - - None - - - TagsMethod - - Specifies how to handle tags. Valid values: "Add" (append to existing), "Refresh" (replace existing). - - String - - String - - - Refresh - - - Group - - Specifies the group for the property source. - - String - - String - - - None - - - ScriptType - - Specifies the script type. Valid values: "embed", "powerShell". - - String - - String - - - None - - - Script - - Specifies the script content. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. - - - - - - - - - - Returns a LogicMonitor.Propertysource object containing the updated configuration. - - - - - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMPropertysource -Id 123 -NewName "UpdatedSource" -Description "New description" -Tags @("prod", "windows") -Updates the property source with new name, description, and tags. - - - - - - - - - - Set-LMPushModuleDeviceProperty - Set - LMPushModuleDeviceProperty - - Updates a device property using the LogicMonitor Push Module. - - - - The Set-LMPushModuleDeviceProperty function modifies a property value for a device using the LogicMonitor Push Module API. - - - Set-LMPushModuleDeviceProperty + Set-LMServiceGroup - Id + Name - Specifies the ID of the device. + Specifies the current name of the Service group. - Int32 + String - Int32 + String - 0 + None - - PropertyName + + NewName - Specifies the name of the property to update. + Specifies the new name for the Service group. String @@ -66748,10 +85936,10 @@ Updates the property source with new name, description, and tags. None - - PropertyValue + + Description - Specifies the new value for the property. + Specifies the new description for the Service group. String @@ -66760,57 +85948,76 @@ Updates the property source with new name, description, and tags. None - - ProgressAction + + Properties - {{ Fill ProgressAction Description }} + Specifies a hashtable of custom properties for the Service group. - ActionPreference + Hashtable - ActionPreference + Hashtable None - - - Set-LMPushModuleDeviceProperty - - Name + + PropertiesMethod - Specifies the name of the device. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". String String - None + Replace - - PropertyName + + DisableAlerting - Specifies the name of the property to update. + Specifies whether to disable alerting for the Service group. - String + Boolean - String + Boolean None - - PropertyValue + + ParentGroupId - Specifies the new value for the property. + Specifies the ID of the parent group. - String + Int32 - String + Int32 None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -66826,46 +86033,106 @@ Updates the property source with new name, description, and tags. - + Id - Specifies the ID of the device. + Specifies the ID of the Service group to modify. + + String + + String + + + None + + + Name + + Specifies the current name of the Service group. + + String + + String + + + None + + + NewName + + Specifies the new name for the Service group. + + String + + String + + + None + + + Description + + Specifies the new description for the Service group. + + String + + String + + + None + + + Properties + + Specifies a hashtable of custom properties for the Service group. - Int32 + Hashtable - Int32 + Hashtable - 0 + None - - Name + + PropertiesMethod - Specifies the name of the device. + Specifies how to handle existing properties. Valid values are "Add", "Replace", or "Refresh". Default is "Replace". String String + Replace + + + DisableAlerting + + Specifies whether to disable alerting for the Service group. + + Boolean + + Boolean + + None - - PropertyName + + ParentGroupId - Specifies the name of the property to update. + Specifies the ID of the parent group. - String + Int32 - String + Int32 None - - PropertyValue + + ParentGroupName - Specifies the new value for the property. + Specifies the name of the parent group. String @@ -66874,6 +86141,30 @@ Updates the property source with new name, description, and tags. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction @@ -66890,7 +86181,7 @@ Updates the property source with new name, description, and tags. - None. + You can pipe objects containing Id properties to this function. @@ -66900,7 +86191,7 @@ Updates the property source with new name, description, and tags. - Returns the response from the API indicating the success of the property update. + Returns a LogicMonitor.DeviceGroup object containing the updated group information. @@ -66915,8 +86206,8 @@ Updates the property source with new name, description, and tags. -------------------------- EXAMPLE 1 -------------------------- - Set-LMPushModuleDeviceProperty -Id 123 -PropertyName "location" -PropertyValue "New York" -Updates the location property for device ID 123. + Set-LMServiceGroup -Id 123 -NewName "Updated Group" -Description "New description" +Updates the Service group with ID 123 with a new name and description. @@ -66926,35 +86217,35 @@ Updates the location property for device ID 123. - Set-LMPushModuleInstanceProperty + Set-LMTopologysource Set - LMPushModuleInstanceProperty + LMTopologysource - Updates an instance property using the LogicMonitor Push Module. + Updates a LogicMonitor topology source configuration. - The Set-LMPushModuleInstanceProperty function modifies a property value for a datasource instance using the LogicMonitor Push Module API. + The Set-LMTopologysource function modifies an existing topology source in LogicMonitor. - Set-LMPushModuleInstanceProperty - - DeviceId + Set-LMTopologysource + + Id - Specifies the ID of the device. + Specifies the ID of the topology source to modify. - Int32 + String - Int32 + String - 0 + None - - DataSourceName + + NewName - Specifies the name of the datasource. + Specifies the new name for the topology source. String @@ -66963,10 +86254,10 @@ Updates the location property for device ID 123. None - - InstanceName + + Description - Specifies the name of the instance. + Specifies the description for the topology source. String @@ -66975,10 +86266,10 @@ Updates the location property for device ID 123. None - - PropertyName + + appliesTo - Specifies the name of the property to update. + Specifies the applies to expression for the topology source. String @@ -66987,10 +86278,46 @@ Updates the location property for device ID 123. None - - PropertyValue + + TechNotes - Specifies the new value for the property. + Specifies technical notes for the topology source. + + String + + String + + + None + + + PollingIntervalInSeconds + + Specifies the polling interval in seconds. Valid values: 1800, 3600, 7200, 21600. + + Int32 + + Int32 + + + None + + + Group + + Specifies the group for the topology source. + + String + + String + + + None + + + ScriptType + + Specifies the script type. Valid values: "embed", "powerShell". String @@ -66999,6 +86326,40 @@ Updates the location property for device ID 123. None + + Script + + Specifies the script content. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -67013,11 +86374,11 @@ Updates the location property for device ID 123. - Set-LMPushModuleInstanceProperty + Set-LMTopologysource - DeviceName + Name - Specifies the name of the device. + Specifies the current name of the topology source. String @@ -67026,10 +86387,10 @@ Updates the location property for device ID 123. None - - DataSourceName + + NewName - Specifies the name of the datasource. + Specifies the new name for the topology source. String @@ -67038,10 +86399,10 @@ Updates the location property for device ID 123. None - - InstanceName + + Description - Specifies the name of the instance. + Specifies the description for the topology source. String @@ -67050,10 +86411,10 @@ Updates the location property for device ID 123. None - - PropertyName + + appliesTo - Specifies the name of the property to update. + Specifies the applies to expression for the topology source. String @@ -67062,10 +86423,58 @@ Updates the location property for device ID 123. None - - PropertyValue + + TechNotes - Specifies the new value for the property. + Specifies technical notes for the topology source. + + String + + String + + + None + + + PollingIntervalInSeconds + + Specifies the polling interval in seconds. Valid values: 1800, 3600, 7200, 21600. + + Int32 + + Int32 + + + None + + + Group + + Specifies the group for the topology source. + + String + + String + + + None + + + ScriptType + + Specifies the script type. Valid values: "embed", "powerShell". + + String + + String + + + None + + + Script + + Specifies the script content. String @@ -67074,6 +86483,28 @@ Updates the location property for device ID 123. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -67089,22 +86520,22 @@ Updates the location property for device ID 123. - - DeviceId + + Id - Specifies the ID of the device. + Specifies the ID of the topology source to modify. - Int32 + String - Int32 + String - 0 + None - DeviceName + Name - Specifies the name of the device. + Specifies the current name of the topology source. String @@ -67113,10 +86544,10 @@ Updates the location property for device ID 123. None - - DataSourceName + + NewName - Specifies the name of the datasource. + Specifies the new name for the topology source. String @@ -67125,10 +86556,10 @@ Updates the location property for device ID 123. None - - InstanceName + + Description - Specifies the name of the instance. + Specifies the description for the topology source. String @@ -67137,10 +86568,10 @@ Updates the location property for device ID 123. None - - PropertyName + + appliesTo - Specifies the name of the property to update. + Specifies the applies to expression for the topology source. String @@ -67149,10 +86580,58 @@ Updates the location property for device ID 123. None - - PropertyValue + + TechNotes - Specifies the new value for the property. + Specifies technical notes for the topology source. + + String + + String + + + None + + + PollingIntervalInSeconds + + Specifies the polling interval in seconds. Valid values: 1800, 3600, 7200, 21600. + + Int32 + + Int32 + + + None + + + Group + + Specifies the group for the topology source. + + String + + String + + + None + + + ScriptType + + Specifies the script type. Valid values: "embed", "powerShell". + + String + + String + + + None + + + Script + + Specifies the script content. String @@ -67161,6 +86640,30 @@ Updates the location property for device ID 123. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction @@ -67187,7 +86690,7 @@ Updates the location property for device ID 123. - Returns the response from the API indicating the success of the property update. + Returns a LogicMonitor.Topologysource object containing the updated configuration. @@ -67202,8 +86705,8 @@ Updates the location property for device ID 123. -------------------------- EXAMPLE 1 -------------------------- - Set-LMPushModuleInstanceProperty -DeviceId 123 -DataSourceName "CPU" -InstanceName "Total" -PropertyName "threshold" -PropertyValue "90" -Updates the threshold property for the CPU Total instance on device ID 123. + Set-LMTopologysource -Id 123 -NewName "UpdatedSource" -Description "New description" +Updates the topology source with new name and description. @@ -67213,47 +86716,47 @@ Updates the threshold property for the CPU Total instance on device ID 123. - Set-LMReportGroup + Set-LMUnmonitoredDevice Set - LMReportGroup + LMUnmonitoredDevice - Updates a LogicMonitor report group configuration. + Updates unmonitored devices in LogicMonitor. - The Set-LMReportGroup function modifies an existing report group in LogicMonitor. + The Set-LMUnmonitoredDevice function modifies unmonitored devices in LogicMonitor by assigning them to a device group. - Set-LMReportGroup - - Id + Set-LMUnmonitoredDevice + + Ids - Specifies the ID of the report group to modify. + Specifies an array of unmonitored device IDs to update. - Int32 + String[] - Int32 + String[] - 0 + None - - NewName + + DeviceGroupId - Specifies the new name for the report group. + Specifies the ID of the device group to assign the devices to. - String + Int32 - String + Int32 - None + 0 - + Description - Specifies the new description for the report group. + Specifies a description for the devices. String @@ -67262,56 +86765,39 @@ Updates the threshold property for the CPU Total instance on device ID 123. None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Set-LMReportGroup - - Name + + CollectorId - Specifies the current name of the report group. + Specifies the ID of the collector to assign to the devices. Default is 0. - String + Int32 - String + Int32 - None + 0 - - NewName + + WhatIf - Specifies the new name for the report group. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - Description + + Confirm - Specifies the new description for the report group. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -67328,10 +86814,22 @@ Updates the threshold property for the CPU Total instance on device ID 123. - - Id + + Ids + + Specifies an array of unmonitored device IDs to update. + + String[] + + String[] + + + None + + + DeviceGroupId - Specifies the ID of the report group to modify. + Specifies the ID of the device group to assign the devices to. Int32 @@ -67340,10 +86838,10 @@ Updates the threshold property for the CPU Total instance on device ID 123. 0 - - Name + + Description - Specifies the current name of the report group. + Specifies a description for the devices. String @@ -67352,29 +86850,41 @@ Updates the threshold property for the CPU Total instance on device ID 123. None - - NewName + + CollectorId - Specifies the new name for the report group. + Specifies the ID of the collector to assign to the devices. Default is 0. - String + Int32 - String + Int32 - None + 0 - - Description + + WhatIf - Specifies the new description for the report group. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String + SwitchParameter - String + SwitchParameter - None + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False ProgressAction @@ -67402,7 +86912,7 @@ Updates the threshold property for the CPU Total instance on device ID 123. - Returns a LogicMonitor.NetScanGroup object containing the updated group information. + Returns a LogicMonitor.Device object containing the updated device information. @@ -67417,8 +86927,8 @@ Updates the threshold property for the CPU Total instance on device ID 123. -------------------------- EXAMPLE 1 -------------------------- - Set-LMReportGroup -Id 123 -NewName "Updated Reports" -Description "New description" -Updates the report group with ID 123 with a new name and description. + #Assigns the specified unmonitored devices to the device group and sets their description. +Set-LMUnmonitoredDevice -Ids @("123", "456") -DeviceGroupId 789 -Description "New devices" @@ -67428,47 +86938,47 @@ Updates the report group with ID 123 with a new name and description. - Set-LMRole + Set-LMUptimeDevice Set - LMRole + LMUptimeDevice - Updates a LogicMonitor role configuration. + Updates an existing LogicMonitor Uptime device using the v3 device endpoint. - The Set-LMRole function modifies an existing role in LogicMonitor, including its permissions and privileges. + The Set-LMUptimeDevice cmdlet updates internal or external Uptime monitors (web or ping) by submitting a PATCH request to the LogicMonitor v3 device endpoint. It resolves the device ID from name when necessary, validates location combinations, and constructs the appropriate payload structure before issuing the request. - Set-LMRole + Set-LMUptimeDevice Id - Specifies the ID of the role to modify. + Specifies the device identifier to update. Accepts pipeline input by property name. - String + Int32 - String + Int32 - None + 0 - NewName + PropertiesMethod - Specifies the new name for the role. + Determines how custom properties are applied when supplied. Valid values are Add, Replace, or Refresh. String String - None + Replace - CustomHelpLabel + Description - Specifies the custom help label for the role. + Updates the description of the Uptime device. String @@ -67478,55 +86988,57 @@ Updates the report group with ID 123 with a new name and description. None - CustomHelpURL + HostGroupIds - Specifies the custom help URL for the role. + Sets the group identifiers assigned to the Uptime device. - String + String[] - String + String[] None - Description + PollingInterval - Specifies the description for the role. + Configures the polling interval in minutes. - String + Int32 - String + Int32 None - RequireEULA + AlertTriggerInterval - Indicates whether to require EULA acceptance. + Specifies the number of consecutive failures before alerting. + Int32 - SwitchParameter + Int32 - False + None - TwoFARequired + GlobalSmAlertCond - Indicates whether to require two-factor authentication. + Sets the synthetic monitoring global alert condition (all, half, moreThanOne, any). + String - SwitchParameter + String - False + None - RoleGroupId + OverallAlertLevel - Specifies the role group ID. + Configures the overall alert level (warn, error, critical). String @@ -67536,9 +87048,9 @@ Updates the report group with ID 123 with a new name and description. None - DashboardsPermission + IndividualAlertLevel - Specifies dashboard permissions. Valid values: "view", "manage", "none". + Configures the individual alert level (warn, error, critical). String @@ -67548,57 +87060,57 @@ Updates the report group with ID 123 with a new name and description. None - ResourcePermission + IndividualSmAlertEnable - Specifies resource permissions. Valid values: "view", "manage", "none". + Enables or disables individual synthetic alerts. - String + Boolean - String + Boolean None - LMXToolBoxPermission + UseDefaultLocationSetting - {{ Fill LMXToolBoxPermission Description }} + Controls whether default location settings are used for the Uptime device. - String + Boolean - String + Boolean None - LMXPermission + UseDefaultAlertSetting - {{ Fill LMXPermission Description }} + Controls whether default alert settings are used for the Uptime device. - String + Boolean - String + Boolean None - LogsPermission + Properties - {{ Fill LogsPermission Description }} + Hashtable of custom properties to apply to the Uptime device. - String + Hashtable - String + Hashtable None - WebsitesPermission + Template - {{ Fill WebsitesPermission Description }} + Specifies an optional template identifier. String @@ -67608,45 +87120,44 @@ Updates the report group with ID 123 with a new name and description. None - SavedMapsPermission + TestLocationCollectorIds - {{ Fill SavedMapsPermission Description }} + Specifies collector identifiers for internal checks. - String + Int32[] - String + Int32[] None - ReportsPermission + TestLocationSmgIds - {{ Fill ReportsPermission Description }} + Specifies synthetic monitoring group identifiers for external checks. - String + Int32[] - String + Int32[] None - SettingsPermission + TestLocationAll - Specifies settings permissions. Valid values: "view", "manage", "none", "manage-collectors", "view-collectors". + Indicates that all public locations should be used for external checks. - String - String + SwitchParameter - None + False - - CreatePrivateDashboards + + WhatIf - {{ Fill CreatePrivateDashboards Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. SwitchParameter @@ -67654,10 +87165,10 @@ Updates the report group with ID 123 with a new name and description. False - - AllowWidgetSharing + + Confirm - {{ Fill AllowWidgetSharing Description }} + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -67665,91 +87176,97 @@ Updates the report group with ID 123 with a new name and description. False - - ConfigTabRequiresManagePermission + + ProgressAction - {{ Fill ConfigTabRequiresManagePermission Description }} + {{ Fill ProgressAction Description }} + ActionPreference - SwitchParameter + ActionPreference - False + None - - AllowedToViewMapsTab + + + Set-LMUptimeDevice + + Id - {{ Fill AllowedToViewMapsTab Description }} + Specifies the device identifier to update. Accepts pipeline input by property name. + Int32 - SwitchParameter + Int32 - False + 0 - AllowedToManageResourceDashboards + PropertiesMethod - {{ Fill AllowedToManageResourceDashboards Description }} + Determines how custom properties are applied when supplied. Valid values are Add, Replace, or Refresh. + String - SwitchParameter + String - False + Replace - ViewTraces + Description - {{ Fill ViewTraces Description }} + Updates the description of the Uptime device. + String - SwitchParameter + String - False + None - ViewSupport + HostGroupIds - {{ Fill ViewSupport Description }} + Sets the group identifiers assigned to the Uptime device. + String[] - SwitchParameter + String[] - False + None - EnableRemoteSessionForResources + PollingInterval - {{ Fill EnableRemoteSessionForResources Description }} + Configures the polling interval in minutes. + Int32 - SwitchParameter + Int32 - False + None - - ProgressAction + + AlertTriggerInterval - {{ Fill ProgressAction Description }} + Specifies the number of consecutive failures before alerting. - ActionPreference + Int32 - ActionPreference + Int32 None - - - Set-LMRole - - Id + + GlobalSmAlertCond - Specifies the ID of the role to modify. + Sets the synthetic monitoring global alert condition (all, half, moreThanOne, any). String @@ -67759,9 +87276,9 @@ Updates the report group with ID 123 with a new name and description. None - NewName + OverallAlertLevel - Specifies the new name for the role. + Configures the overall alert level (warn, error, critical). String @@ -67771,9 +87288,9 @@ Updates the report group with ID 123 with a new name and description. None - CustomHelpLabel + IndividualAlertLevel - Specifies the custom help label for the role. + Configures the individual alert level (warn, error, critical). String @@ -67783,9 +87300,57 @@ Updates the report group with ID 123 with a new name and description. None - CustomHelpURL + IndividualSmAlertEnable - Specifies the custom help URL for the role. + Enables or disables individual synthetic alerts. + + Boolean + + Boolean + + + None + + + UseDefaultLocationSetting + + Controls whether default location settings are used for the Uptime device. + + Boolean + + Boolean + + + None + + + UseDefaultAlertSetting + + Controls whether default alert settings are used for the Uptime device. + + Boolean + + Boolean + + + None + + + Properties + + Hashtable of custom properties to apply to the Uptime device. + + Hashtable + + Hashtable + + + None + + + Template + + Specifies an optional template identifier. String @@ -67795,9 +87360,9 @@ Updates the report group with ID 123 with a new name and description. None - Description + Hostname - Specifies the description for the role. + Updates the hostname/IP for ping checks. String @@ -67807,51 +87372,98 @@ Updates the report group with ID 123 with a new name and description. None - RequireEULA + Count - Indicates whether to require EULA acceptance. + Sets the number of ping attempts per polling cycle. + Int32 - SwitchParameter + Int32 - False + None - TwoFARequired + PercentPktsNotReceiveInTime - Indicates whether to require two-factor authentication. + Defines the allowed packet loss percentage before alerting. + Int32 - SwitchParameter + Int32 - False + None - RoleGroupId + TimeoutInMSPktsNotReceive - Specifies the role group ID. + Defines the timeout threshold in milliseconds for ping checks. - String + Int32 - String + Int32 None - - CustomPrivilegesObject + + TestLocationCollectorIds - Specifies custom privileges for the role. + Specifies collector identifiers for internal checks. - PSObject + Int32[] - PSObject + Int32[] + + + None + + + TestLocationSmgIds + + Specifies synthetic monitoring group identifiers for external checks. + + Int32[] + + Int32[] None + + TestLocationAll + + Indicates that all public locations should be used for external checks. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -67866,35 +87478,35 @@ Updates the report group with ID 123 with a new name and description. - Set-LMRole - - Name + Set-LMUptimeDevice + + Id - Specifies the current name of the role. + Specifies the device identifier to update. Accepts pipeline input by property name. - String + Int32 - String + Int32 - None + 0 - NewName + PropertiesMethod - Specifies the new name for the role. + Determines how custom properties are applied when supplied. Valid values are Add, Replace, or Refresh. String String - None + Replace - CustomHelpLabel + Description - Specifies the custom help label for the role. + Updates the description of the Uptime device. String @@ -67904,55 +87516,57 @@ Updates the report group with ID 123 with a new name and description. None - CustomHelpURL + HostGroupIds - Specifies the custom help URL for the role. + Sets the group identifiers assigned to the Uptime device. - String + String[] - String + String[] None - Description + PollingInterval - Specifies the description for the role. + Configures the polling interval in minutes. - String + Int32 - String + Int32 None - RequireEULA + AlertTriggerInterval - Indicates whether to require EULA acceptance. + Specifies the number of consecutive failures before alerting. + Int32 - SwitchParameter + Int32 - False + None - TwoFARequired + GlobalSmAlertCond - Indicates whether to require two-factor authentication. + Sets the synthetic monitoring global alert condition (all, half, moreThanOne, any). + String - SwitchParameter + String - False + None - RoleGroupId + OverallAlertLevel - Specifies the role group ID. + Configures the overall alert level (warn, error, critical). String @@ -67962,9 +87576,9 @@ Updates the report group with ID 123 with a new name and description. None - DashboardsPermission + IndividualAlertLevel - Specifies dashboard permissions. Valid values: "view", "manage", "none". + Configures the individual alert level (warn, error, critical). String @@ -67974,57 +87588,57 @@ Updates the report group with ID 123 with a new name and description. None - ResourcePermission + IndividualSmAlertEnable - Specifies resource permissions. Valid values: "view", "manage", "none". + Enables or disables individual synthetic alerts. - String + Boolean - String + Boolean None - LMXToolBoxPermission + UseDefaultLocationSetting - {{ Fill LMXToolBoxPermission Description }} + Controls whether default location settings are used for the Uptime device. - String + Boolean - String + Boolean None - LMXPermission + UseDefaultAlertSetting - {{ Fill LMXPermission Description }} + Controls whether default alert settings are used for the Uptime device. - String + Boolean - String + Boolean None - LogsPermission + Properties - {{ Fill LogsPermission Description }} + Hashtable of custom properties to apply to the Uptime device. - String + Hashtable - String + Hashtable None - WebsitesPermission + Template - {{ Fill WebsitesPermission Description }} + Specifies an optional template identifier. String @@ -68034,9 +87648,9 @@ Updates the report group with ID 123 with a new name and description. None - SavedMapsPermission + Domain - {{ Fill SavedMapsPermission Description }} + Updates the domain for web checks. String @@ -68046,9 +87660,9 @@ Updates the report group with ID 123 with a new name and description. None - ReportsPermission + Schema - {{ Fill ReportsPermission Description }} + Defines the HTTP schema (http or https) for web checks. String @@ -68058,9 +87672,33 @@ Updates the report group with ID 123 with a new name and description. None - SettingsPermission + IgnoreSSL - Specifies settings permissions. Valid values: "view", "manage", "none", "manage-collectors", "view-collectors". + Enables or disables SSL certificate validation warnings. + + Boolean + + Boolean + + + None + + + PageLoadAlertTimeInMS + + Sets the page load alert threshold for web checks. + + Int32 + + Int32 + + + None + + + AlertExpr + + Configures the SSL alert expression for web checks. String @@ -68070,64 +87708,69 @@ Updates the report group with ID 123 with a new name and description. None - CreatePrivateDashboards + TriggerSSLStatusAlert - {{ Fill CreatePrivateDashboards Description }} + Enables or disables SSL status alerts. + Boolean - SwitchParameter + Boolean - False + None - AllowWidgetSharing + TriggerSSLExpirationAlert - {{ Fill AllowWidgetSharing Description }} + Enables or disables SSL expiration alerts. + Boolean - SwitchParameter + Boolean - False + None - ConfigTabRequiresManagePermission + Steps - {{ Fill ConfigTabRequiresManagePermission Description }} + Provides an array of step definitions for web checks. + Hashtable[] - SwitchParameter + Hashtable[] - False + None - AllowedToViewMapsTab + TestLocationCollectorIds - {{ Fill AllowedToViewMapsTab Description }} + Specifies collector identifiers for internal checks. + Int32[] - SwitchParameter + Int32[] - False + None - AllowedToManageResourceDashboards + TestLocationSmgIds - {{ Fill AllowedToManageResourceDashboards Description }} + Specifies synthetic monitoring group identifiers for external checks. + Int32[] - SwitchParameter + Int32[] - False + None - ViewTraces + TestLocationAll - {{ Fill ViewTraces Description }} + Indicates that all public locations should be used for external checks. SwitchParameter @@ -68135,10 +87778,10 @@ Updates the report group with ID 123 with a new name and description. False - - ViewSupport + + WhatIf - {{ Fill ViewSupport Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. SwitchParameter @@ -68146,10 +87789,10 @@ Updates the report group with ID 123 with a new name and description. False - - EnableRemoteSessionForResources + + Confirm - {{ Fill EnableRemoteSessionForResources Description }} + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -68171,11 +87814,11 @@ Updates the report group with ID 123 with a new name and description. - Set-LMRole + Set-LMUptimeDevice Name - Specifies the current name of the role. + Specifies the device name to update. The cmdlet resolves the corresponding ID prior to issuing the request. String @@ -68185,9 +87828,21 @@ Updates the report group with ID 123 with a new name and description. None - NewName + PropertiesMethod - Specifies the new name for the role. + Determines how custom properties are applied when supplied. Valid values are Add, Replace, or Refresh. + + String + + String + + + Replace + + + Description + + Updates the description of the Uptime device. String @@ -68197,9 +87852,45 @@ Updates the report group with ID 123 with a new name and description. None - CustomHelpLabel + HostGroupIds - Specifies the custom help label for the role. + Sets the group identifiers assigned to the Uptime device. + + String[] + + String[] + + + None + + + PollingInterval + + Configures the polling interval in minutes. + + Int32 + + Int32 + + + None + + + AlertTriggerInterval + + Specifies the number of consecutive failures before alerting. + + Int32 + + Int32 + + + None + + + GlobalSmAlertCond + + Sets the synthetic monitoring global alert condition (all, half, moreThanOne, any). String @@ -68209,9 +87900,9 @@ Updates the report group with ID 123 with a new name and description. None - CustomHelpURL + OverallAlertLevel - Specifies the custom help URL for the role. + Configures the overall alert level (warn, error, critical). String @@ -68221,9 +87912,9 @@ Updates the report group with ID 123 with a new name and description. None - Description + IndividualAlertLevel - Specifies the description for the role. + Configures the individual alert level (warn, error, critical). String @@ -68233,503 +87924,170 @@ Updates the report group with ID 123 with a new name and description. None - RequireEULA + IndividualSmAlertEnable - Indicates whether to require EULA acceptance. + Enables or disables individual synthetic alerts. + Boolean - SwitchParameter + Boolean - False + None - TwoFARequired + UseDefaultLocationSetting - Indicates whether to require two-factor authentication. + Controls whether default location settings are used for the Uptime device. + Boolean - SwitchParameter + Boolean - False + None - RoleGroupId + UseDefaultAlertSetting - Specifies the role group ID. + Controls whether default alert settings are used for the Uptime device. - String + Boolean - String + Boolean None - - CustomPrivilegesObject + + Properties - Specifies custom privileges for the role. + Hashtable of custom properties to apply to the Uptime device. - PSObject + Hashtable - PSObject + Hashtable None - - ProgressAction + + Template - {{ Fill ProgressAction Description }} + Specifies an optional template identifier. - ActionPreference + String - ActionPreference + String None - - - - - Id - - Specifies the ID of the role to modify. - - String - - String - - - None - - - Name - - Specifies the current name of the role. - - String - - String - - - None - - - NewName - - Specifies the new name for the role. - - String - - String - - - None - - - CustomHelpLabel - - Specifies the custom help label for the role. - - String - - String - - - None - - - CustomHelpURL - - Specifies the custom help URL for the role. - - String - - String - - - None - - - Description - - Specifies the description for the role. - - String - - String - - - None - - - RequireEULA - - Indicates whether to require EULA acceptance. - - SwitchParameter - - SwitchParameter - - - False - - - TwoFARequired - - Indicates whether to require two-factor authentication. - - SwitchParameter - - SwitchParameter - - - False - - - RoleGroupId - - Specifies the role group ID. - - String - - String - - - None - - - DashboardsPermission - - Specifies dashboard permissions. Valid values: "view", "manage", "none". - - String - - String - - - None - - - ResourcePermission - - Specifies resource permissions. Valid values: "view", "manage", "none". - - String - - String - - - None - - - LMXToolBoxPermission - - {{ Fill LMXToolBoxPermission Description }} - - String - - String - - - None - - - LMXPermission - - {{ Fill LMXPermission Description }} - - String - - String - - - None - - - LogsPermission - - {{ Fill LogsPermission Description }} - - String - - String - - - None - - - WebsitesPermission - - {{ Fill WebsitesPermission Description }} - - String - - String - - - None - - - SavedMapsPermission - - {{ Fill SavedMapsPermission Description }} - - String - - String - - - None - - - ReportsPermission - - {{ Fill ReportsPermission Description }} - - String - - String - - - None - - - SettingsPermission - - Specifies settings permissions. Valid values: "view", "manage", "none", "manage-collectors", "view-collectors". - - String - - String - - - None - - - CreatePrivateDashboards - - {{ Fill CreatePrivateDashboards Description }} - - SwitchParameter - - SwitchParameter - - - False - - - AllowWidgetSharing - - {{ Fill AllowWidgetSharing Description }} - - SwitchParameter - - SwitchParameter - - - False - - - ConfigTabRequiresManagePermission - - {{ Fill ConfigTabRequiresManagePermission Description }} - - SwitchParameter - - SwitchParameter - - - False - - - AllowedToViewMapsTab - - {{ Fill AllowedToViewMapsTab Description }} - - SwitchParameter - - SwitchParameter - - - False - - - AllowedToManageResourceDashboards - - {{ Fill AllowedToManageResourceDashboards Description }} - - SwitchParameter - - SwitchParameter - - - False - - - ViewTraces - - {{ Fill ViewTraces Description }} - - SwitchParameter - - SwitchParameter - - - False - - - ViewSupport - - {{ Fill ViewSupport Description }} - - SwitchParameter - - SwitchParameter - - - False - - - EnableRemoteSessionForResources - - {{ Fill EnableRemoteSessionForResources Description }} - - SwitchParameter - - SwitchParameter - - - False - - - CustomPrivilegesObject - - Specifies custom privileges for the role. - - PSObject - - PSObject - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. - - - - - - - - - - Returns a LogicMonitor.Role object containing the updated role configuration. - - - - - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMRole -Id 123 -NewName "Updated Role" -Description "New description" -DashboardsPermission "view" -Updates the role with new name, description, and dashboard permissions. - - - - - - - - - - Set-LMSDT - Set - LMSDT - - Updates a Scheduled Down Time (SDT) entry in LogicMonitor. - - - - The Set-LMSDT function modifies an existing SDT entry in LogicMonitor, allowing updates to both one-time and recurring schedules. - - - - Set-LMSDT - - Id + + Hostname + + Updates the hostname/IP for ping checks. + + String + + String + + + None + + + Count - Specifies the ID of the SDT entry to modify. + Sets the number of ping attempts per polling cycle. - String + Int32 - String + Int32 None - Comment + PercentPktsNotReceiveInTime - Specifies a comment for the SDT entry. + Defines the allowed packet loss percentage before alerting. - String + Int32 - String + Int32 None - StartDate + TimeoutInMSPktsNotReceive - Specifies the start date and time for one-time SDT. + Defines the timeout threshold in milliseconds for ping checks. - DateTime + Int32 - DateTime + Int32 None - EndDate + TestLocationCollectorIds - Specifies the end date and time for one-time SDT. + Specifies collector identifiers for internal checks. - DateTime + Int32[] - DateTime + Int32[] + + + None + + + TestLocationSmgIds + + Specifies synthetic monitoring group identifiers for external checks. + + Int32[] + + Int32[] None + + TestLocationAll + + Indicates that all public locations should be used for external checks. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -68744,11 +88102,11 @@ Updates the role with new name, description, and dashboard permissions. - Set-LMSDT + Set-LMUptimeDevice - Id + Name - Specifies the ID of the SDT entry to modify. + Specifies the device name to update. The cmdlet resolves the corresponding ID prior to issuing the request. String @@ -68758,9 +88116,21 @@ Updates the role with new name, description, and dashboard permissions.None - Comment + PropertiesMethod - Specifies a comment for the SDT entry. + Determines how custom properties are applied when supplied. Valid values are Add, Replace, or Refresh. + + String + + String + + + Replace + + + Description + + Updates the description of the Uptime device. String @@ -68770,21 +88140,21 @@ Updates the role with new name, description, and dashboard permissions.None - StartHour + HostGroupIds - Specifies the start hour (0-23) for recurring SDT. + Sets the group identifiers assigned to the Uptime device. - Int32 + String[] - Int32 + String[] None - StartMinute + PollingInterval - Specifies the start minute (0-59) for recurring SDT. + Configures the polling interval in minutes. Int32 @@ -68794,9 +88164,9 @@ Updates the role with new name, description, and dashboard permissions.None - EndHour + AlertTriggerInterval - Specifies the end hour (0-23) for recurring SDT. + Specifies the number of consecutive failures before alerting. Int32 @@ -68806,21 +88176,21 @@ Updates the role with new name, description, and dashboard permissions.None - EndMinute + GlobalSmAlertCond - Specifies the end minute (0-59) for recurring SDT. + Sets the synthetic monitoring global alert condition (all, half, moreThanOne, any). - Int32 + String - Int32 + String None - WeekDay + OverallAlertLevel - Specifies the day of the week for recurring SDT. + Configures the overall alert level (warn, error, critical). String @@ -68830,9 +88200,9 @@ Updates the role with new name, description, and dashboard permissions.None - WeekOfMonth + IndividualAlertLevel - Specifies which week of the month for recurring SDT. Valid values: "First", "Second", "Third", "Fourth", "Last". + Configures the individual alert level (warn, error, critical). String @@ -68842,9 +88212,105 @@ Updates the role with new name, description, and dashboard permissions.None - DayOfMonth + IndividualSmAlertEnable - Specifies the day of the month (1-31) for recurring SDT. + Enables or disables individual synthetic alerts. + + Boolean + + Boolean + + + None + + + UseDefaultLocationSetting + + Controls whether default location settings are used for the Uptime device. + + Boolean + + Boolean + + + None + + + UseDefaultAlertSetting + + Controls whether default alert settings are used for the Uptime device. + + Boolean + + Boolean + + + None + + + Properties + + Hashtable of custom properties to apply to the Uptime device. + + Hashtable + + Hashtable + + + None + + + Template + + Specifies an optional template identifier. + + String + + String + + + None + + + Domain + + Updates the domain for web checks. + + String + + String + + + None + + + Schema + + Defines the HTTP schema (http or https) for web checks. + + String + + String + + + None + + + IgnoreSSL + + Enables or disables SSL certificate validation warnings. + + Boolean + + Boolean + + + None + + + PageLoadAlertTimeInMS + + Sets the page load alert threshold for web checks. Int32 @@ -68853,6 +88319,111 @@ Updates the role with new name, description, and dashboard permissions. None + + AlertExpr + + Configures the SSL alert expression for web checks. + + String + + String + + + None + + + TriggerSSLStatusAlert + + Enables or disables SSL status alerts. + + Boolean + + Boolean + + + None + + + TriggerSSLExpirationAlert + + Enables or disables SSL expiration alerts. + + Boolean + + Boolean + + + None + + + Steps + + Provides an array of step definitions for web checks. + + Hashtable[] + + Hashtable[] + + + None + + + TestLocationCollectorIds + + Specifies collector identifiers for internal checks. + + Int32[] + + Int32[] + + + None + + + TestLocationSmgIds + + Specifies synthetic monitoring group identifiers for external checks. + + Int32[] + + Int32[] + + + None + + + TestLocationAll + + Indicates that all public locations should be used for external checks. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -68866,209 +88437,12 @@ Updates the role with new name, description, and dashboard permissions.None - - - - Id - - Specifies the ID of the SDT entry to modify. - - String - - String - - - None - - - Comment - - Specifies a comment for the SDT entry. - - String - - String - - - None - - - StartDate - - Specifies the start date and time for one-time SDT. - - DateTime - - DateTime - - - None - - - EndDate - - Specifies the end date and time for one-time SDT. - - DateTime - - DateTime - - - None - - - StartHour - - Specifies the start hour (0-23) for recurring SDT. - - Int32 - - Int32 - - - None - - - StartMinute - - Specifies the start minute (0-59) for recurring SDT. - - Int32 - - Int32 - - - None - - - EndHour - - Specifies the end hour (0-23) for recurring SDT. - - Int32 - - Int32 - - - None - - - EndMinute - - Specifies the end minute (0-59) for recurring SDT. - - Int32 - - Int32 - - - None - - - WeekDay - - Specifies the day of the week for recurring SDT. - - String - - String - - - None - - - WeekOfMonth - - Specifies which week of the month for recurring SDT. Valid values: "First", "Second", "Third", "Fourth", "Last". - - String - - String - - - None - - - DayOfMonth - - Specifies the day of the month (1-31) for recurring SDT. - - Int32 - - Int32 - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - None. - - - - - - - - - - Returns the response from the API containing the updated SDT configuration. - - - - - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMSDT -Id 123 -StartDate "2024-01-01 00:00" -EndDate "2024-01-02 00:00" -Comment "Extended maintenance" -Updates a one-time SDT entry with new dates and comment. - - - - - - - - - - Set-LMTopologysource - Set - LMTopologysource - - Updates a LogicMonitor topology source configuration. - - - - The Set-LMTopologysource function modifies an existing topology source in LogicMonitor. - - - Set-LMTopologysource - - Id + Set-LMUptimeDevice + + Name - Specifies the ID of the topology source to modify. + Specifies the device name to update. The cmdlet resolves the corresponding ID prior to issuing the request. String @@ -69078,21 +88452,21 @@ Updates a one-time SDT entry with new dates and comment. None - NewName + PropertiesMethod - Specifies the new name for the topology source. + Determines how custom properties are applied when supplied. Valid values are Add, Replace, or Refresh. String String - None + Replace Description - Specifies the description for the topology source. + Updates the description of the Uptime device. String @@ -69102,33 +88476,33 @@ Updates a one-time SDT entry with new dates and comment. None - appliesTo + HostGroupIds - Specifies the applies to expression for the topology source. + Sets the group identifiers assigned to the Uptime device. - String + String[] - String + String[] None - TechNotes + PollingInterval - Specifies technical notes for the topology source. + Configures the polling interval in minutes. - String + Int32 - String + Int32 None - PollingIntervalInSeconds + AlertTriggerInterval - Specifies the polling interval in seconds. Valid values: 1800, 3600, 7200, 21600. + Specifies the number of consecutive failures before alerting. Int32 @@ -69138,9 +88512,9 @@ Updates a one-time SDT entry with new dates and comment. None - Group + GlobalSmAlertCond - Specifies the group for the topology source. + Sets the synthetic monitoring global alert condition (all, half, moreThanOne, any). String @@ -69150,9 +88524,9 @@ Updates a one-time SDT entry with new dates and comment. None - ScriptType + OverallAlertLevel - Specifies the script type. Valid values: "embed", "powerShell". + Configures the overall alert level (warn, error, critical). String @@ -69162,9 +88536,9 @@ Updates a one-time SDT entry with new dates and comment. None - Script + IndividualAlertLevel - Specifies the script content. + Configures the individual alert level (warn, error, critical). String @@ -69173,61 +88547,58 @@ Updates a one-time SDT entry with new dates and comment. None - - ProgressAction + + IndividualSmAlertEnable - {{ Fill ProgressAction Description }} + Enables or disables individual synthetic alerts. - ActionPreference + Boolean - ActionPreference + Boolean None - - - Set-LMTopologysource - - Name + + UseDefaultLocationSetting - Specifies the current name of the topology source. + Controls whether default location settings are used for the Uptime device. - String + Boolean - String + Boolean None - NewName + UseDefaultAlertSetting - Specifies the new name for the topology source. + Controls whether default alert settings are used for the Uptime device. - String + Boolean - String + Boolean None - Description + Properties - Specifies the description for the topology source. + Hashtable of custom properties to apply to the Uptime device. - String + Hashtable - String + Hashtable None - appliesTo + Template - Specifies the applies to expression for the topology source. + Specifies an optional template identifier. String @@ -69237,64 +88608,61 @@ Updates a one-time SDT entry with new dates and comment. None - TechNotes + TestLocationCollectorIds - Specifies technical notes for the topology source. + Specifies collector identifiers for internal checks. - String + Int32[] - String + Int32[] None - PollingIntervalInSeconds + TestLocationSmgIds - Specifies the polling interval in seconds. Valid values: 1800, 3600, 7200, 21600. + Specifies synthetic monitoring group identifiers for external checks. - Int32 + Int32[] - Int32 + Int32[] None - Group + TestLocationAll - Specifies the group for the topology source. + Indicates that all public locations should be used for external checks. - String - String + SwitchParameter - None + False - - ScriptType + + WhatIf - Specifies the script type. Valid values: "embed", "powerShell". + Shows what would happen if the cmdlet runs. The cmdlet is not run. - String - String + SwitchParameter - None + False - - Script + + Confirm - Specifies the script content. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None + False ProgressAction @@ -69314,19 +88682,19 @@ Updates a one-time SDT entry with new dates and comment. Id - Specifies the ID of the topology source to modify. + Specifies the device identifier to update. Accepts pipeline input by property name. - String + Int32 - String + Int32 - None + 0 Name - Specifies the current name of the topology source. + Specifies the device name to update. The cmdlet resolves the corresponding ID prior to issuing the request. String @@ -69336,21 +88704,21 @@ Updates a one-time SDT entry with new dates and comment. None - NewName + PropertiesMethod - Specifies the new name for the topology source. + Determines how custom properties are applied when supplied. Valid values are Add, Replace, or Refresh. String String - None + Replace Description - Specifies the description for the topology source. + Updates the description of the Uptime device. String @@ -69360,33 +88728,33 @@ Updates a one-time SDT entry with new dates and comment. None - appliesTo + HostGroupIds - Specifies the applies to expression for the topology source. + Sets the group identifiers assigned to the Uptime device. - String + String[] - String + String[] None - TechNotes + PollingInterval - Specifies technical notes for the topology source. + Configures the polling interval in minutes. - String + Int32 - String + Int32 None - PollingIntervalInSeconds + AlertTriggerInterval - Specifies the polling interval in seconds. Valid values: 1800, 3600, 7200, 21600. + Specifies the number of consecutive failures before alerting. Int32 @@ -69396,9 +88764,9 @@ Updates a one-time SDT entry with new dates and comment. None - Group + GlobalSmAlertCond - Specifies the group for the topology source. + Sets the synthetic monitoring global alert condition (all, half, moreThanOne, any). String @@ -69408,9 +88776,9 @@ Updates a one-time SDT entry with new dates and comment. None - ScriptType + OverallAlertLevel - Specifies the script type. Valid values: "embed", "powerShell". + Configures the overall alert level (warn, error, critical). String @@ -69420,9 +88788,9 @@ Updates a one-time SDT entry with new dates and comment. None - Script + IndividualAlertLevel - Specifies the script content. + Configures the individual alert level (warn, error, critical). String @@ -69431,162 +88799,118 @@ Updates a one-time SDT entry with new dates and comment. None - - ProgressAction + + IndividualSmAlertEnable - {{ Fill ProgressAction Description }} + Enables or disables individual synthetic alerts. - ActionPreference + Boolean - ActionPreference + Boolean None - - - + + UseDefaultLocationSetting + + Controls whether default location settings are used for the Uptime device. + + Boolean - None. + Boolean + + None + + + UseDefaultAlertSetting - + Controls whether default alert settings are used for the Uptime device. - - - - + Boolean - Returns a LogicMonitor.Topologysource object containing the updated configuration. + Boolean + + None + + + Properties - + Hashtable of custom properties to apply to the Uptime device. - - - - - This function requires a valid LogicMonitor API authentication. - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-LMTopologysource -Id 123 -NewName "UpdatedSource" -Description "New description" -Updates the topology source with new name and description. - - - - - - - - - - Set-LMUnmonitoredDevice - Set - LMUnmonitoredDevice - - Updates unmonitored devices in LogicMonitor. - - - - The Set-LMUnmonitoredDevice function modifies unmonitored devices in LogicMonitor by assigning them to a device group. - - - - Set-LMUnmonitoredDevice - - Ids - - Specifies an array of unmonitored device IDs to update. - - String[] - - String[] - - - None - - - DeviceGroupId - - Specifies the ID of the device group to assign the devices to. - - Int32 - - Int32 - - - 0 - - - Description - - Specifies a description for the devices. - - String - - String - - - None - - - CollectorId - - Specifies the ID of the collector to assign to the devices. Default is 0. - - Int32 - - Int32 - - - 0 - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - - - Ids + Hashtable + + Hashtable + + + None + + + Template - Specifies an array of unmonitored device IDs to update. + Specifies an optional template identifier. - String[] + String - String[] + String None - - DeviceGroupId + + Domain - Specifies the ID of the device group to assign the devices to. + Updates the domain for web checks. + + String + + String + + + None + + + Schema + + Defines the HTTP schema (http or https) for web checks. + + String + + String + + + None + + + IgnoreSSL + + Enables or disables SSL certificate validation warnings. + + Boolean + + Boolean + + + None + + + PageLoadAlertTimeInMS + + Sets the page load alert threshold for web checks. Int32 Int32 - 0 + None - - Description + + AlertExpr - Specifies a description for the devices. + Configures the SSL alert expression for web checks. String @@ -69595,17 +88919,149 @@ Updates the topology source with new name and description. None - - CollectorId + + TriggerSSLStatusAlert - Specifies the ID of the collector to assign to the devices. Default is 0. + Enables or disables SSL status alerts. + + Boolean + + Boolean + + + None + + + TriggerSSLExpirationAlert + + Enables or disables SSL expiration alerts. + + Boolean + + Boolean + + + None + + + Steps + + Provides an array of step definitions for web checks. + + Hashtable[] + + Hashtable[] + + + None + + + Hostname + + Updates the hostname/IP for ping checks. + + String + + String + + + None + + + Count + + Sets the number of ping attempts per polling cycle. Int32 Int32 - 0 + None + + + PercentPktsNotReceiveInTime + + Defines the allowed packet loss percentage before alerting. + + Int32 + + Int32 + + + None + + + TimeoutInMSPktsNotReceive + + Defines the timeout threshold in milliseconds for ping checks. + + Int32 + + Int32 + + + None + + + TestLocationCollectorIds + + Specifies collector identifiers for internal checks. + + Int32[] + + Int32[] + + + None + + + TestLocationSmgIds + + Specifies synthetic monitoring group identifiers for external checks. + + Int32[] + + Int32[] + + + None + + + TestLocationAll + + Indicates that all public locations should be used for external checks. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False ProgressAction @@ -69620,20 +89076,11 @@ Updates the topology source with new name and description. None - - - - None. - - - - - - + - Returns a LogicMonitor.Device object containing the updated device information. + LogicMonitor.LMUptimeDevice @@ -69642,16 +89089,22 @@ Updates the topology source with new name and description. - This function requires a valid LogicMonitor API authentication. + You must run Connect-LMAccount before invoking this cmdlet. Requests are issued to /device/devices/{id} with X-Version 3 and return LogicMonitor.LMUptimeDevice objects. -------------------------- EXAMPLE 1 -------------------------- - #Assigns the specified unmonitored devices to the device group and sets their description. -Set-LMUnmonitoredDevice -Ids @("123", "456") -DeviceGroupId 789 -Description "New devices" + Set-LMUptimeDevice -Id 123 -PollingInterval 10 -Transition 2 - + Updates the polling interval and transition threshold for the uptime device with ID 123. + + + + -------------------------- EXAMPLE 2 -------------------------- + Set-LMUptimeDevice -Name "web-ext-01" -TestLocationSmgIds 2,4,6 -TriggerSSLStatusAlert $true + + Resolves the ID from the device name and updates external web check locations and SSL alerts. @@ -69888,6 +89341,28 @@ Set-LMUnmonitoredDevice -Ids @("123", "456") -DeviceGroupId 789 -Description "Ne None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -70119,6 +89594,28 @@ Set-LMUnmonitoredDevice -Ids @("123", "456") -DeviceGroupId 789 -Description "Ne None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -70362,6 +89859,30 @@ Set-LMUnmonitoredDevice -Ids @("123", "456") -DeviceGroupId 789 -Description "Ne None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction @@ -70838,7 +90359,7 @@ Sets the user data for the user with Name "JohnDoe" for the dashboard with Id "6 None - + SSLAlertThresholds {{ Fill SSLAlertThresholds Description }} @@ -70987,289 +90508,333 @@ Sets the user data for the user with Name "JohnDoe" for the dashboard with Id "6 None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - - Set-LMWebsite - - Id - - Specifies the ID of the website to modify. - - String - - String - - - None - - - Name - - Specifies the name for the website. - - String - - String - - - None - - - IsInternal - - Indicates whether the website is internal. - - Boolean - - Boolean - - - None - - - Description - - Specifies the description for the website. - - String - - String - - - None - - - DisableAlerting - - Indicates whether to disable alerting for the website. - - Boolean - - Boolean - - - None - - - StopMonitoring - - Indicates whether to stop monitoring the website. - - Boolean - - Boolean - - - None - - - UseDefaultAlertSetting - - Indicates whether to use default alert settings. - - Boolean - - Boolean - - - None - - - UseDefaultLocationSetting - - Indicates whether to use default location settings. - - Boolean - - Boolean - - - None - - - GroupId - - Specifies the group ID for the website. - - String - - String - - - None - - - PingAddress - - {{ Fill PingAddress Description }} - - String - - String - - - None - - - PingCount - - {{ Fill PingCount Description }} - - Int32 - - Int32 - - - None - - - PingTimeout - - {{ Fill PingTimeout Description }} - - Int32 - - Int32 - - - None - - - PingPercentNotReceived - - {{ Fill PingPercentNotReceived Description }} - - Int32 - - Int32 - - - None - - - FailedCount - - {{ Fill FailedCount Description }} - - Int32 - - Int32 - - - None - - - OverallAlertLevel - - {{ Fill OverallAlertLevel Description }} - - String - - String - - - None - - - IndividualAlertLevel - - {{ Fill IndividualAlertLevel Description }} - - String - - String - - - None - - - Properties - - Specifies a hashtable of custom properties for the website. - - Hashtable - - Hashtable - - - None - - - PropertiesMethod - - Specifies how to handle properties. Valid values: "Add", "Replace", "Refresh". - - String - - String - - - Replace - - - PollingInterval - - Specifies the polling interval. Valid values: 1-10, 30, 60. - - Int32 - - Int32 - - - None - - - TestLocationAll - - Indicates whether to test from all locations. Cannot be used with TestLocationCollectorIds or TestLocationSmgIds. - - Boolean - - Boolean - - - None - - - TestLocationCollectorIds + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Set-LMWebsite + + Id + + Specifies the ID of the website to modify. + + String + + String + + + None + + + Name + + Specifies the name for the website. + + String + + String + + + None + + + IsInternal + + Indicates whether the website is internal. + + Boolean + + Boolean + + + None + + + Description + + Specifies the description for the website. + + String + + String + + + None + + + DisableAlerting + + Indicates whether to disable alerting for the website. + + Boolean + + Boolean + + + None + + + StopMonitoring + + Indicates whether to stop monitoring the website. + + Boolean + + Boolean + + + None + + + UseDefaultAlertSetting + + Indicates whether to use default alert settings. + + Boolean + + Boolean + + + None + + + UseDefaultLocationSetting + + Indicates whether to use default location settings. + + Boolean + + Boolean + + + None + + + GroupId + + Specifies the group ID for the website. + + String + + String + + + None + + + PingAddress + + {{ Fill PingAddress Description }} + + String + + String + + + None + + + PingCount + + {{ Fill PingCount Description }} + + Int32 + + Int32 + + + None + + + PingTimeout + + {{ Fill PingTimeout Description }} + + Int32 + + Int32 + + + None + + + PingPercentNotReceived + + {{ Fill PingPercentNotReceived Description }} + + Int32 + + Int32 + + + None + + + FailedCount + + {{ Fill FailedCount Description }} + + Int32 + + Int32 + + + None + + + OverallAlertLevel + + {{ Fill OverallAlertLevel Description }} + + String + + String + + + None + + + IndividualAlertLevel + + {{ Fill IndividualAlertLevel Description }} + + String + + String + + + None + + + Properties + + Specifies a hashtable of custom properties for the website. + + Hashtable + + Hashtable + + + None + + + PropertiesMethod + + Specifies how to handle properties. Valid values: "Add", "Replace", "Refresh". + + String + + String + + + Replace + + + PollingInterval + + Specifies the polling interval. Valid values: 1-10, 30, 60. + + Int32 + + Int32 + + + None + + + TestLocationAll + + Indicates whether to test from all locations. Cannot be used with TestLocationCollectorIds or TestLocationSmgIds. + + Boolean + + Boolean + + + None + + + TestLocationCollectorIds + + Array of collector IDs to use for testing. Cannot be used with TestLocationAll or TestLocationSmgIds. + + Int32[] + + Int32[] + + + None + + + TestLocationSmgIds + + Array of collector group IDs to use for testing. Can only be used when IsInternal is false. Cannot be used with TestLocationAll or TestLocationCollectorIds. + Available collector group IDs correspond to LogicMonitor regions: - 2 = US - Washington DC + - 3 = Europe - Dublin + - 4 = US - Oregon + - 5 = Asia - Singapore + - 6 = Australia - Sydney + + Int32[] + + Int32[] + + + None + + + WhatIf - Array of collector IDs to use for testing. Cannot be used with TestLocationAll or TestLocationSmgIds. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Int32[] - Int32[] + SwitchParameter - None + False - - TestLocationSmgIds + + Confirm - Array of collector group IDs to use for testing. Can only be used when IsInternal is false. Cannot be used with TestLocationAll or TestLocationCollectorIds. - Available collector group IDs correspond to LogicMonitor regions: - 2 = US - Washington DC - - 3 = Europe - Dublin - - 4 = US - Oregon - - 5 = Asia - Singapore - - 6 = Australia - Sydney + Prompts you for confirmation before running the cmdlet. - Int32[] - Int32[] + SwitchParameter - None + False ProgressAction @@ -71454,7 +91019,7 @@ Sets the user data for the user with Name "JohnDoe" for the dashboard with Id "6 None - + SSLAlertThresholds {{ Fill SSLAlertThresholds Description }} @@ -71639,6 +91204,30 @@ Sets the user data for the user with Name "JohnDoe" for the dashboard with Id "6 None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction @@ -71800,6 +91389,28 @@ Updates the website with new name, description, and enables alerting. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -71911,6 +91522,28 @@ Updates the website with new name, description, and enables alerting. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -72022,6 +91655,28 @@ Updates the website with new name, description, and enables alerting. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -72133,6 +91788,28 @@ Updates the website with new name, description, and enables alerting. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + ProgressAction @@ -72268,6 +91945,30 @@ Updates the website with new name, description, and enables alerting. None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + ProgressAction From af1caf59703133bd2e23e7719a6c2f3e91f0881a Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Thu, 30 Oct 2025 00:31:29 -0400 Subject: [PATCH 16/17] remove guide --- .../Utilities/Invoke-LMAPIRequest-Guide.md | 473 ------------------ Public/Remove-LMUptimeDevice.ps1 | 1 - Public/Set-LMUptimeDevice.ps1 | 1 - 3 files changed, 475 deletions(-) delete mode 100644 Documentation/Utilities/Invoke-LMAPIRequest-Guide.md diff --git a/Documentation/Utilities/Invoke-LMAPIRequest-Guide.md b/Documentation/Utilities/Invoke-LMAPIRequest-Guide.md deleted file mode 100644 index d0b4344..0000000 --- a/Documentation/Utilities/Invoke-LMAPIRequest-Guide.md +++ /dev/null @@ -1,473 +0,0 @@ -# Invoke-LMAPIRequest - Advanced User Guide - -## Overview - -`Invoke-LMAPIRequest` is a universal API request cmdlet designed for advanced users who need direct access to LogicMonitor API endpoints that don't yet have dedicated cmdlets in the module. It provides full control over API requests while leveraging the module's robust infrastructure. - -## Why Use This Cmdlet? - -### Problem Statement -With over 200+ cmdlets in the Logic.Monitor module, we still don't cover every API endpoint. Advanced users who discover new endpoints in the LogicMonitor API documentation often have to: -- Reinvent authentication handling -- Implement retry logic for transient failures -- Handle rate limiting manually -- Build debug utilities from scratch -- Deal with error handling inconsistencies - -### Solution -`Invoke-LMAPIRequest` provides a "bring your own endpoint" approach that: -- ✅ Uses existing module authentication (API keys, Bearer tokens, Session sync) -- ✅ Leverages built-in retry logic with exponential backoff -- ✅ Integrates with module debug utilities (`-Debug`, `Resolve-LMDebugInfo`) -- ✅ Handles rate limiting automatically -- ✅ Provides consistent error handling -- ✅ Supports all HTTP methods (GET, POST, PATCH, PUT, DELETE) -- ✅ Allows custom API version headers -- ✅ Includes ShouldProcess support for safety - -## Key Features - -### 1. Full CRUD Operation Support -```powershell -# CREATE - POST -$data = @{ name = "New Resource"; type = "custom" } -Invoke-LMAPIRequest -ResourcePath "/custom/endpoint" -Method POST -Data $data - -# READ - GET -Invoke-LMAPIRequest -ResourcePath "/custom/endpoint/123" -Method GET - -# UPDATE - PATCH -$updates = @{ description = "Updated" } -Invoke-LMAPIRequest -ResourcePath "/custom/endpoint/123" -Method PATCH -Data $updates - -# DELETE -Invoke-LMAPIRequest -ResourcePath "/custom/endpoint/123" -Method DELETE -``` - -**Important:** You must format data according to the API's requirements. For example, `customProperties` must be an array: -```powershell -# ❌ Wrong - simple hashtable -$data = @{ - name = "device1" - customProperties = @{ prop1 = "value1" } -} - -# ✅ Correct - array of name/value objects -$data = @{ - name = "device1" - customProperties = @( - @{ name = "prop1"; value = "value1" } - @{ name = "prop2"; value = "value2" } - ) -} -Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method POST -Data $data -``` - -### 2. Query Parameter Support -```powershell -$queryParams = @{ - size = 1000 - offset = 0 - filter = 'status:"active"' - fields = "id,name,status,created" - sort = "+name" -} -Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -QueryParams $queryParams -``` - -### 3. Custom API Versions -Some newer LogicMonitor API endpoints require different version numbers: -```powershell -# Use API version 4 for newer endpoints -Invoke-LMAPIRequest -ResourcePath "/new/endpoint" -Method GET -Version 4 -``` - -### 4. Raw Body Control -For special cases where you need exact control over JSON formatting: -```powershell -$rawJson = @" -{ - "name": "test", - "customField": null, - "preservedFormatting": true -} -"@ -Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method POST -RawBody $rawJson -``` - -### 5. File Downloads -```powershell -# Download reports or exports -Invoke-LMAPIRequest -ResourcePath "/report/reports/123/download" -Method GET -OutFile "C:\Reports\monthly.pdf" -``` - -### 6. Manual Pagination -```powershell -function Get-AllDevicesManually { - $offset = 0 - $size = 1000 - $allResults = @() - - do { - $response = Invoke-LMAPIRequest ` - -ResourcePath "/device/devices" ` - -Method GET ` - -QueryParams @{ size = $size; offset = $offset; sort = "+id" } - - $allResults += $response.items - $offset += $size - Write-Progress -Activity "Fetching devices" -Status "$($allResults.Count) of $($response.total)" - } while ($allResults.Count -lt $response.total) - - return $allResults -} -``` - -### 7. Type Information -Add custom type names for proper formatting: -```powershell -$result = Invoke-LMAPIRequest ` - -ResourcePath "/custom/endpoint" ` - -Method GET ` - -TypeName "LogicMonitor.CustomResource" -``` - -### 8. Hashtable Output -For easier property manipulation: -```powershell -$result = Invoke-LMAPIRequest ` - -ResourcePath "/device/devices/123" ` - -Method GET ` - -AsHashtable - -$result["customProperty"] = "newValue" -``` - -### 9. Formatting Output -Control how API responses are displayed: -```powershell -# Default: Returns raw objects (PowerShell chooses format automatically) -$devices = Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET - -# For table view, pipe to Format-Table with specific properties -Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET | - Format-Table id, name, displayName, status, collectorId - -# Or use Select-Object to choose properties, then let PowerShell format -Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET | - Select-Object id, name, displayName, status | - Format-Table -AutoSize - -# For detailed view of a single item -Invoke-LMAPIRequest -ResourcePath "/device/devices/123" -Method GET | Format-List - -# Use custom type name to leverage existing format definitions -Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET -TypeName "LogicMonitor.Device" -# This will use the LogicMonitor.Device format definition from Logic.Monitor.Format.ps1xml - -# Pipeline remains fully functional -Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET | - Where-Object { $_.status -eq 'normal' } | - Select-Object id, name, customProperties | - Export-Csv devices.csv # ✅ Works perfectly! -``` - -**Tip:** For frequently used endpoints, create a wrapper function with custom formatting: -```powershell -function Get-MyCustomResource { - Invoke-LMAPIRequest -ResourcePath "/custom/endpoint" -Method GET | - Format-Table id, name, status, created -AutoSize -} -``` - -## Design Patterns - -### Pattern 1: Testing New API Features -```powershell -# Test a beta endpoint before requesting a dedicated cmdlet -$betaData = @{ - feature = "new-capability" - enabled = $true -} -Invoke-LMAPIRequest -ResourcePath "/beta/features" -Method POST -Data $betaData -Version 4 -``` - -### Pattern 2: Bulk Operations -```powershell -# Bulk update multiple resources -$deviceIds = 1..100 -foreach ($id in $deviceIds) { - $updates = @{ description = "Bulk updated $(Get-Date)" } - Invoke-LMAPIRequest -ResourcePath "/device/devices/$id" -Method PATCH -Data $updates - Start-Sleep -Milliseconds 100 # Rate limiting -} -``` - -### Pattern 3: Custom Workflows -```powershell -# Complex workflow combining multiple API calls -function Deploy-CustomConfiguration { - param($ConfigName, $Targets) - - # Step 1: Create configuration - $config = @{ name = $ConfigName; type = "custom" } - $created = Invoke-LMAPIRequest -ResourcePath "/configs" -Method POST -Data $config - - # Step 2: Apply to targets - foreach ($target in $Targets) { - $assignment = @{ configId = $created.id; targetId = $target } - Invoke-LMAPIRequest -ResourcePath "/configs/assignments" -Method POST -Data $assignment - } - - # Step 3: Verify deployment - $status = Invoke-LMAPIRequest -ResourcePath "/configs/$($created.id)/status" -Method GET - return $status -} -``` - -### Pattern 4: Error Handling -```powershell -try { - $result = Invoke-LMAPIRequest ` - -ResourcePath "/risky/endpoint" ` - -Method POST ` - -Data $data ` - -ErrorAction Stop - - Write-Host "Success: $($result.id)" -} -catch { - Write-Error "API request failed: $($_.Exception.Message)" - # Fallback logic here -} -``` - -## Best Practices - -### 1. Use Dedicated Cmdlets When Available -```powershell -# ❌ Don't do this -Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method GET - -# ✅ Do this instead -Get-LMDevice -``` - -### 2. Validate Input Before Sending -```powershell -function New-CustomResource { - param($Name, $Type) - - # Validate locally first - if ([string]::IsNullOrWhiteSpace($Name)) { - throw "Name cannot be empty" - } - - $data = @{ name = $Name; type = $Type } - Invoke-LMAPIRequest -ResourcePath "/custom/resources" -Method POST -Data $data -} -``` - -### 3. Use -WhatIf for Testing -```powershell -# Test without making actual changes -Invoke-LMAPIRequest ` - -ResourcePath "/device/devices/123" ` - -Method DELETE ` - -WhatIf -``` - -### 4. Leverage Debug Output -```powershell -# Enable debug to see full request details -Invoke-LMAPIRequest ` - -ResourcePath "/endpoint" ` - -Method POST ` - -Data $data ` - -Debug -``` - -### 5. Handle Pagination Properly -```powershell -# For large datasets, use pagination -$size = 1000 # Max batch size -$offset = 0 -do { - $batch = Invoke-LMAPIRequest ` - -ResourcePath "/large/dataset" ` - -Method GET ` - -QueryParams @{ size = $size; offset = $offset } - - Process-Batch $batch.items - $offset += $size -} while ($batch.items.Count -eq $size) -``` - -## Integration with Module Features - -### Authentication -Automatically uses the current session from `Connect-LMAccount`: -```powershell -Connect-LMAccount -AccessId $id -AccessKey $key -AccountName "company" -Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -# No need to handle auth manually! -``` - -### Retry Logic -Built-in exponential backoff for transient failures: -```powershell -# Automatically retries on 429, 502, 503, 504 -Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -MaxRetries 5 - -# Disable retries for time-sensitive operations -Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -NoRetry -``` - -### Debug Information -Integrates with module debug utilities: -```powershell -# Shows full request details including headers, URL, payload -$DebugPreference = "Continue" -Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method POST -Data $data -``` - -## Common Use Cases - -### 1. Accessing New API Endpoints -```powershell -# LogicMonitor releases a new API endpoint -# Use Invoke-LMAPIRequest until a dedicated cmdlet is available -Invoke-LMAPIRequest -ResourcePath "/new/feature" -Method GET -``` - -### 2. Custom Integrations -```powershell -# Build custom integrations with external systems -$webhookData = @{ - url = "https://external-system.com/webhook" - events = @("alert.created", "alert.cleared") -} -Invoke-LMAPIRequest -ResourcePath "/integrations/webhooks" -Method POST -Data $webhookData -``` - -### 3. Prototyping -```powershell -# Prototype new functionality before requesting cmdlet additions -# Test different approaches quickly -$approaches = @( - @{ method = "approach1"; params = @{} }, - @{ method = "approach2"; params = @{} } -) - -foreach ($approach in $approaches) { - $result = Invoke-LMAPIRequest ` - -ResourcePath "/test/endpoint" ` - -Method POST ` - -Data $approach - - Measure-Performance $result -} -``` - -### 4. Advanced Filtering -```powershell -# Complex filters not yet supported by dedicated cmdlets -$complexFilter = 'name~"prod-*" && status:"active" && customProperties.environment:"production"' -Invoke-LMAPIRequest ` - -ResourcePath "/device/devices" ` - -Method GET ` - -QueryParams @{ filter = $complexFilter; size = 1000 } -``` - -## Troubleshooting - -### Issue: "Invalid json body" or "Cannot deserialize" Errors - -This usually means your data structure doesn't match the API's expected format. - -**Common Issue: customProperties Format** -```powershell -# ❌ Wrong - This will fail -$data = @{ - name = "device1" - customProperties = @{ environment = "prod" } # Simple hashtable -} - -# ✅ Correct - Array of name/value objects -$data = @{ - name = "device1" - customProperties = @( - @{ name = "environment"; value = "prod" } - ) -} -``` - -**Solution:** Check the LogicMonitor API documentation or look at how dedicated cmdlets format the data: -```powershell -# Compare with working cmdlet -New-LMDevice -Name "test" -DisplayName "test" -PreferredCollectorId 1 -Properties @{test="value"} -Debug - -# Look at the "Request Payload" in debug output to see the correct format -``` - -### Issue: Authentication Errors -```powershell -# Verify you're connected -if (-not $Script:LMAuth.Valid) { - Connect-LMAccount -AccessId $id -AccessKey $key -AccountName "company" -} -``` - -### Issue: Rate Limiting -```powershell -# Increase retry attempts or add delays -Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -MaxRetries 10 - -# Or add manual delays in loops -foreach ($item in $items) { - Invoke-LMAPIRequest -ResourcePath "/endpoint/$item" -Method GET - Start-Sleep -Milliseconds 500 -} -``` - -### Issue: Unexpected Response Format -```powershell -# Use -Debug to see raw response -$result = Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -Debug - -# Or capture as hashtable for inspection -$result = Invoke-LMAPIRequest -ResourcePath "/endpoint" -Method GET -AsHashtable -$result.Keys | ForEach-Object { Write-Host "$_: $($result[$_])" } -``` - -## Contributing - -If you find yourself frequently using `Invoke-LMAPIRequest` for a specific endpoint, consider: -1. Opening a GitHub issue requesting a dedicated cmdlet -2. Contributing a PR with the new cmdlet implementation -3. Sharing your use case to help prioritize development - -## Related Cmdlets - -- `Connect-LMAccount` - Establish authentication -- `Get-LMDevice`, `New-LMDevice`, etc. - Dedicated resource cmdlets -- `Build-LMFilter` - Interactive filter builder -- `Invoke-LMRestMethod` - Internal REST method wrapper (not for direct use) - -## Summary - -`Invoke-LMAPIRequest` bridges the gap between the module's current capabilities and the full LogicMonitor API surface area. It empowers advanced users to: -- Access any API endpoint immediately -- Prototype new functionality -- Build custom integrations -- Test beta features - -While maintaining the benefits of: -- Centralized authentication -- Robust error handling -- Automatic retries -- Consistent debugging -- Module best practices - -Use it when you need flexibility, but prefer dedicated cmdlets for routine operations. - diff --git a/Public/Remove-LMUptimeDevice.ps1 b/Public/Remove-LMUptimeDevice.ps1 index 51a64bc..6cc6cfc 100644 --- a/Public/Remove-LMUptimeDevice.ps1 +++ b/Public/Remove-LMUptimeDevice.ps1 @@ -29,7 +29,6 @@ Resolves the device ID by name and removes the corresponding Uptime device. .NOTES You must run Connect-LMAccount before invoking this cmdlet. Requests target -/device/devices/{id}?deleteHard={bool} with X-Version 3. .OUTPUTS System.Management.Automation.PSCustomObject diff --git a/Public/Set-LMUptimeDevice.ps1 b/Public/Set-LMUptimeDevice.ps1 index 9b480de..67cacd2 100644 --- a/Public/Set-LMUptimeDevice.ps1 +++ b/Public/Set-LMUptimeDevice.ps1 @@ -110,7 +110,6 @@ Resolves the ID from the device name and updates external web check locations an .NOTES You must run Connect-LMAccount before invoking this cmdlet. Requests are issued to -/device/devices/{id} with X-Version 3 and return LogicMonitor.LMUptimeDevice objects. .OUTPUTS LogicMonitor.LMUptimeDevice From 1d093f72b769e1b97d978489d04603e646fdb4b1 Mon Sep 17 00:00:00 2001 From: Steve Villardi <42367049+stevevillardi@users.noreply.github.com> Date: Thu, 30 Oct 2025 10:48:08 -0400 Subject: [PATCH 17/17] Add support for new json/xml import endpoints --- Documentation/Import-LMLogicModuleFromFile.md | 209 ++++++++++++++++++ Public/Import-LMLogicModule.ps1 | 11 +- Public/Import-LMLogicModuleFromFile.ps1 | 198 +++++++++++++++++ README.md | 12 + 4 files changed, 428 insertions(+), 2 deletions(-) create mode 100644 Documentation/Import-LMLogicModuleFromFile.md create mode 100644 Public/Import-LMLogicModuleFromFile.ps1 diff --git a/Documentation/Import-LMLogicModuleFromFile.md b/Documentation/Import-LMLogicModuleFromFile.md new file mode 100644 index 0000000..aab8edb --- /dev/null +++ b/Documentation/Import-LMLogicModuleFromFile.md @@ -0,0 +1,209 @@ +--- +external help file: Logic.Monitor-help.xml +Module Name: Logic.Monitor +online version: +schema: 2.0.0 +--- + +# Import-LMLogicModuleFromFile + +## SYNOPSIS +Imports a LogicModule into LogicMonitor using the V2 import endpoints. + +## SYNTAX + +### FilePath +``` +Import-LMLogicModuleFromFile -FilePath [-Type ] [-Format ] + [-FieldsToPreserve ] [-HandleConflict ] [-ProgressAction ] + [] +``` + +### File +``` +Import-LMLogicModuleFromFile -File [-Type ] [-Format ] [-FieldsToPreserve ] + [-HandleConflict ] [-ProgressAction ] [] +``` + +## DESCRIPTION +The Import-LMLogicModuleFromFile function imports a LogicModule from a file path or file data using the new XML and JSON import endpoints. +Supports various module types including datasources, configsources, eventsources, batchjobs, logsources, oids, topologysources, functions, and diagnosticsources. + +## EXAMPLES + +### EXAMPLE 1 +``` +#Import a datasource module from XML +Import-LMLogicModuleFromFile -FilePath "C:\LogicModules\datasource.xml" -Type "datasources" -Format "xml" +``` + +### EXAMPLE 2 +``` +#Import a logsource module from JSON with conflict handling +Import-LMLogicModuleFromFile -FilePath "C:\LogicModules\logsource.json" -Type "logsources" -Format "json" -HandleConflict "FORCE_OVERWRITE" +``` + +### EXAMPLE 3 +``` +#Import an eventsource from file data (read file content first with -Raw parameter) +$fileData = Get-Content -Path "C:\LogicModules\eventsource.xml" -Raw +Import-LMLogicModuleFromFile -File $fileData -Type "eventsources" -Format "xml" +``` + +### EXAMPLE 4 +``` +#Import with fields to preserve +Import-LMLogicModuleFromFile -FilePath "C:\LogicModules\datasource.json" -Type "datasources" -Format "json" -FieldsToPreserve "description,appliesTo" +``` + +## PARAMETERS + +### -FilePath +The path to the file containing the LogicModule to import. +The function will read the file content automatically. + +```yaml +Type: String +Parameter Sets: FilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +The raw file content of the LogicModule to import as a string. +Use Get-Content with -Raw parameter to read file content properly (e.g., Get-Content 'file.json' -Raw). + +```yaml +Type: Object +Parameter Sets: File +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of LogicModule. +Valid values are "datasources", "configsources", "eventsources", "batchjobs", "logsources", "oids", "topologysources", "functions", "diagnosticsources". +Defaults to "datasources". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Datasources +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +The format of the LogicModule file. +Valid values are "xml" or "json". +Defaults to "json". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Json +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FieldsToPreserve +Optional. +Comma-separated list of fields to preserve during import. +Only applies to JSON imports. +Defaults to preserving none of the fields. +Valid values are "NAME", "APPLIES_TO_SCRIPT", "COLLECTION_INTERVAL", "ACTIVE_DISCOVERY_INTERVAL", "ACTIVE_DISCOVERY_FILTERS", "MODULE_GROUP", "DISPLAY_NAME", "USE_WILD_VALUE_AS_UUID", "DATAPOINT_ALERT_THRESHOLDS", "TAGS". +"NAME" will preserve the name of the LogicModule. +"APPLIES_TO_SCRIPT" will preserve the appliesToScript of the LogicModule. +"COLLECTION_INTERVAL" will preserve the collectionInterval of the LogicModule. +"ACTIVE_DISCOVERY_INTERVAL" will preserve the activeDiscoveryInterval of the LogicModule. +"ACTIVE_DISCOVERY_FILTERS" will preserve the activeDiscoveryFilters of the LogicModule. +"MODULE_GROUP" will preserve the moduleGroup of the LogicModule. +"DISPLAY_NAME" will preserve the displayName of the LogicModule. +"USE_WILD_VALUE_AS_UUID" will preserve the useWildValueAsUuid of the LogicModule. +"DATAPOINT_ALERT_THRESHOLDS" will preserve the datapointAlertThresholds of the LogicModule. +"TAGS" will preserve the tags of the LogicModule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HandleConflict +Optional. +Specifies how to handle conflicts during import. +Only applies to JSON imports. +Defaults to "FORCE_OVERWRITE". +Valid values are "FORCE_OVERWRITE" or "ERROR". +"FORCE_OVERWRITE" will overwrite the existing LogicModule with the same name. +"ERROR" will throw an error if a conflict is found. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: FORCE_OVERWRITE +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None. You cannot pipe objects to this command. +## OUTPUTS + +### Returns a success message if the import is successful. +## NOTES +You must run Connect-LMAccount before running this command. +Requires PowerShell version 6.1 or higher. + +Note: Some module types only support specific formats: +- logsources, oids, functions, diagnosticsources: JSON only +- Other types: Both XML and JSON supported + +## RELATED LINKS diff --git a/Public/Import-LMLogicModule.ps1 b/Public/Import-LMLogicModule.ps1 index a122b71..d77d18c 100644 --- a/Public/Import-LMLogicModule.ps1 +++ b/Public/Import-LMLogicModule.ps1 @@ -1,8 +1,11 @@ <# .SYNOPSIS -Imports a LogicModule into LogicMonitor. +[DEPRECATED] Imports a LogicModule into LogicMonitor using legacy endpoints. .DESCRIPTION +DEPRECATED: This function uses legacy import endpoints and will be removed in a future version. +Please use Import-LMLogicModuleFromFile instead, which uses the newer XML/JSON import endpoints with better error handling and additional features. + The Import-LMLogicModule function imports a LogicModule from a file path or file data. Supports various module types including datasource, propertyrules, eventsource, topologysource, configsource, logsource, functions, and oids. .PARAMETER FilePath @@ -26,6 +29,8 @@ Import-LMLogicModule -FilePath "C:\LogicModules\datasource.xml" -Type "datasourc Import-LMLogicModule -File $fileData -Type "propertyrules" .NOTES +DEPRECATED: This cmdlet will be removed in a future version. Use Import-LMLogicModuleFromFile instead. + You must run Connect-LMAccount before running this command. Requires PowerShell version 6.1 or higher. .INPUTS @@ -50,7 +55,9 @@ function Import-LMLogicModule { ) #Check if we are logged in and have valid api creds - begin {} + begin { + Write-Warning "Import-LMLogicModule is deprecated and will be removed in a future version. Please use Import-LMLogicModuleFromFile instead." + } process { if ($Script:LMAuth.Valid) { diff --git a/Public/Import-LMLogicModuleFromFile.ps1 b/Public/Import-LMLogicModuleFromFile.ps1 new file mode 100644 index 0000000..97204d8 --- /dev/null +++ b/Public/Import-LMLogicModuleFromFile.ps1 @@ -0,0 +1,198 @@ +<# +.SYNOPSIS +Imports a LogicModule into LogicMonitor using the V2 import endpoints. + +.DESCRIPTION +The Import-LMLogicModuleFromFile function imports a LogicModule from a file path or file data using the new XML and JSON import endpoints. Supports various module types including datasources, configsources, eventsources, batchjobs, logsources, oids, topologysources, functions, and diagnosticsources. + +.PARAMETER FilePath +The path to the file containing the LogicModule to import. The function will read the file content automatically. + +.PARAMETER File +The raw file content of the LogicModule to import as a string. Use Get-Content with -Raw parameter to read file content properly (e.g., Get-Content 'file.json' -Raw). + +.PARAMETER Type +The type of LogicModule. Valid values are "datasources", "configsources", "eventsources", "batchjobs", "logsources", "oids", "topologysources", "functions", "diagnosticsources". Defaults to "datasources". + +.PARAMETER Format +The format of the LogicModule file. Valid values are "xml" or "json". Defaults to "json". + +.PARAMETER FieldsToPreserve +Optional. Comma-separated list of fields to preserve during import. Only applies to JSON imports. Defaults to preserving none of the fields. +Valid values are "NAME", "APPLIES_TO_SCRIPT", "COLLECTION_INTERVAL", "ACTIVE_DISCOVERY_INTERVAL", "ACTIVE_DISCOVERY_FILTERS", "MODULE_GROUP", "DISPLAY_NAME", "USE_WILD_VALUE_AS_UUID", "DATAPOINT_ALERT_THRESHOLDS", "TAGS". +"NAME" will preserve the name of the LogicModule. +"APPLIES_TO_SCRIPT" will preserve the appliesToScript of the LogicModule. +"COLLECTION_INTERVAL" will preserve the collectionInterval of the LogicModule. +"ACTIVE_DISCOVERY_INTERVAL" will preserve the activeDiscoveryInterval of the LogicModule. +"ACTIVE_DISCOVERY_FILTERS" will preserve the activeDiscoveryFilters of the LogicModule. +"MODULE_GROUP" will preserve the moduleGroup of the LogicModule. +"DISPLAY_NAME" will preserve the displayName of the LogicModule. +"USE_WILD_VALUE_AS_UUID" will preserve the useWildValueAsUuid of the LogicModule. +"DATAPOINT_ALERT_THRESHOLDS" will preserve the datapointAlertThresholds of the LogicModule. +"TAGS" will preserve the tags of the LogicModule. + +.PARAMETER HandleConflict +Optional. Specifies how to handle conflicts during import. Only applies to JSON imports. Defaults to "FORCE_OVERWRITE". +Valid values are "FORCE_OVERWRITE" or "ERROR". +"FORCE_OVERWRITE" will overwrite the existing LogicModule with the same name. +"ERROR" will throw an error if a conflict is found. + +.EXAMPLE +#Import a datasource module from XML +Import-LMLogicModuleFromFile -FilePath "C:\LogicModules\datasource.xml" -Type "datasources" -Format "xml" + +.EXAMPLE +#Import a logsource module from JSON with conflict handling +Import-LMLogicModuleFromFile -FilePath "C:\LogicModules\logsource.json" -Type "logsources" -Format "json" -HandleConflict "FORCE_OVERWRITE" + +.EXAMPLE +#Import an eventsource from file data (read file content first with -Raw parameter) +$fileData = Get-Content -Path "C:\LogicModules\eventsource.xml" -Raw +Import-LMLogicModuleFromFile -File $fileData -Type "eventsources" -Format "xml" + +.EXAMPLE +#Import with fields to preserve +Import-LMLogicModuleFromFile -FilePath "C:\LogicModules\datasource.json" -Type "datasources" -Format "json" -FieldsToPreserve "description,appliesTo" + +.NOTES +You must run Connect-LMAccount before running this command. Requires PowerShell version 6.1 or higher. + +Note: Some module types only support specific formats: +- logsources, oids, functions, diagnosticsources: JSON only +- Other types: Both XML and JSON supported + +.INPUTS +None. You cannot pipe objects to this command. + +.OUTPUTS +Returns a success message if the import is successful. +#> +function Import-LMLogicModuleFromFile { + [CmdletBinding()] + param ( + [Parameter(Mandatory, ParameterSetName = 'FilePath')] + [String]$FilePath, + + [Parameter(Mandatory, ParameterSetName = 'File')] + [Object]$File, + + [ValidateSet("datasources", "configsources", "eventsources", "batchjobs", "logsources", "oids", "topologysources", "functions", "diagnosticsources")] + [String]$Type = "datasources", + + [ValidateSet("xml", "json")] + [String]$Format = "json", + + [ValidateSet("NAME", "APPLIES_TO_SCRIPT", "COLLECTION_INTERVAL", "ACTIVE_DISCOVERY_INTERVAL", "ACTIVE_DISCOVERY_FILTERS", "MODULE_GROUP", "DISPLAY_NAME", "USE_WILD_VALUE_AS_UUID", "DATAPOINT_ALERT_THRESHOLDS", "TAGS")] + [String]$FieldsToPreserve, + + [ValidateSet("FORCE_OVERWRITE", "ERROR")] + [String]$HandleConflict = "FORCE_OVERWRITE" + ) + + #Check if we are logged in and have valid api creds + begin {} + process { + if ($Script:LMAuth.Valid) { + + #Check for PS version 6.1 + + if (($PSVersionTable.PSVersion.Major -le 5) -or ($PSVersionTable.PSVersion.Major -eq 6 -and $PSVersionTable.PSVersion.Minor -lt 1)) { + Write-Error "This command requires PS version 6.1 or higher to run." + return + } + + #Validate format for specific types that only support JSON + $JsonOnlyTypes = @("logsources", "oids", "functions", "diagnosticsources") + if ($JsonOnlyTypes -contains $Type -and $Format -ne "json") { + Write-Error "Module type '$Type' only supports JSON format. Please specify -Format 'json'." + return + } + + #Get file content from path if not given file data directly + if ($FilePath) { + if (!(Test-Path -Path $FilePath)) { + Write-Error "File not found at path: $FilePath" + return + } + + $FileExtension = [IO.Path]::GetExtension($FilePath).ToLower() + if ($FileExtension -notin @('.xml', '.json')) { + Write-Error "File is not a valid XML or JSON file. File extension must be .xml or .json" + return + } + + #Validate format matches file extension + $ExpectedExtension = ".$Format" + if ($FileExtension -ne $ExpectedExtension) { + Write-Warning "File extension '$FileExtension' does not match specified format '$Format'. Using format: $Format" + } + + $File = Get-Content $FilePath -Raw + } + + #Build resource path based on type and format + $ResourcePath = "/setting/$Type/import$Format" + + #Build query parameters if provided (only for JSON imports) + $QueryParams = "" + if ($Format -eq "json") { + $QueryParamsList = @() + + if ($FieldsToPreserve) { + $QueryParamsList += "fieldsToPreserve=$([System.Web.HttpUtility]::UrlEncode($FieldsToPreserve))" + } + + if ($HandleConflict) { + $QueryParamsList += "handleConflict=$([System.Web.HttpUtility]::UrlEncode($HandleConflict))" + } + + if ($QueryParamsList.Count -gt 0) { + $QueryParams = "?" + ($QueryParamsList -join "&") + } + } + + #Build header and uri + $Headers = New-LMHeader -Auth $Script:LMAuth -Method "POST" -ResourcePath $ResourcePath -Data $File + $Uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $ResourcePath + $QueryParams + + Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation -Payload $File + + #Issue request + try { + # Create a temporary file with the correct extension for the upload + $TempFile = [System.IO.Path]::GetTempFileName() + $TempFileWithExtension = [System.IO.Path]::ChangeExtension($TempFile, $Format) + + # Remove the temp file without extension and use the one with extension + if (Test-Path $TempFile) { + Remove-Item $TempFile -Force + } + + # Write the file content to temp file + Set-Content -Path $TempFileWithExtension -Value $File -NoNewline + + try { + # Use the file path for the form upload + $Response = Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $Uri -Method "POST" -Headers $Headers[0] -WebSession $Headers[1] -Form @{file = Get-Item $TempFileWithExtension } + + if ($Response) { + return "Successfully imported LogicModule of type: $Type (format: $Format)" + } + } + finally { + # Clean up temp file + if (Test-Path $TempFileWithExtension) { + Remove-Item $TempFileWithExtension -Force + } + } + } + catch { + Write-Error "Failed to import LogicModule: $_" + } + } + else { + Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." + } + } + end {} +} + diff --git a/README.md b/README.md index 34910c0..f31f21f 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,7 @@ Connect-LMAccount -UseCachedCredential - **Invoke-LMReportExecution**: Trigger on-demand execution of LogicMonitor reports with optional admin impersonation and custom email recipients. - **Get-LMReportExecutionTask**: Check the status and retrieve results of previously triggered report executions. - **Invoke-LMAPIRequest**: Universal API request cmdlet for advanced users to access any LogicMonitor API endpoint with custom payloads while leveraging module authentication, retry logic, and debug utilities. +- **Import-LMLogicModuleFromFile**: Import LogicModules using the new XML and JSON import endpoints with enhanced features including field preservation and conflict handling options. Supports datasources, configsources, eventsources, batchjobs, logsources, oids, topologysources, functions, and diagnosticsources. ### Updated Cmdlets - **Update-LogicMonitorModule**: Hardened for non-blocking version checks; failures are logged via `Write-Verbose` and never terminate connecting cmdlets. @@ -92,6 +93,7 @@ Connect-LMAccount -UseCachedCredential - **Set-LMWebsite**: Added `alertExpr` alias for `SSLAlertThresholds` parameter for improved API compatibility. Updated synopsis to reflect enhanced parameter validation. - **New-LMWebsite**: Added `alertExpr` alias for `SSLAlertThresholds` parameter for improved API compatibility. - **Format-LMFilter**: Enhanced filter string escaping to properly handle special characters like parentheses, dollar signs, ampersands, and brackets in filter expressions. +- **Import-LMLogicModule**: Marked as deprecated with warnings. Users should migrate to `Import-LMLogicModuleFromFile` for access to newer API endpoints and features. ### Bug Fixes - **Add-ObjectTypeInfo**: Fixed "Cannot bind argument to parameter 'InputObject' because it is null" error by adding `[AllowNull()]` attribute to handle successful but null API responses. @@ -139,6 +141,16 @@ $customData = @{ ) } Invoke-LMAPIRequest -ResourcePath "/device/devices" -Method POST -Data $customData -Version 3 + +# Import a LogicModule from file with the new endpoint +Import-LMLogicModuleFromFile -FilePath "C:\LogicModules\datasource.json" -Type datasources -Format json + +# Import with conflict handling and field preservation +Import-LMLogicModuleFromFile -FilePath "C:\LogicModules\datasource.json" -Type datasources -Format json -HandleConflict FORCE_OVERWRITE -FieldsToPreserve NAME + +# Import from file data variable +$fileContent = Get-Content -Path "C:\LogicModules\eventsource.xml" -Raw +Import-LMLogicModuleFromFile -File $fileContent -Type eventsources -Format xml ```