Merge pull request #12 from logicmonitor/pre-release

stevevillardi · web-flow · commit 5bd69c7415b6 · 2024-08-19T22:03:19.000-04:00
6.3 pre release
diff --git a/Logic.Monitor.Format.ps1xml b/Logic.Monitor.Format.ps1xml
@@ -1467,6 +1467,53 @@
             </TableRowEntries>
          </TableControl>
       </View>
+      <!-- New View LogicMonitor.Logsource-->
+      <View>
+         <Name>LogicMonitorLogsource</Name>
+         <ViewSelectedBy>
+            <TypeName>LogicMonitor.Logsource</TypeName>
+         </ViewSelectedBy>
+         <TableControl>
+            <TableHeaders>
+               <TableColumnHeader>
+                  <Label>id</Label>
+               </TableColumnHeader>
+               <TableColumnHeader>
+                  <Label>name</Label>
+               </TableColumnHeader>
+               <TableColumnHeader>
+                  <Label>logFields</Label>
+               </TableColumnHeader>
+               <TableColumnHeader>
+                  <Label>resourceMapping</Label>
+               </TableColumnHeader>
+               <TableColumnHeader>
+                  <Label>description</Label>
+               </TableColumnHeader>
+            </TableHeaders>
+            <TableRowEntries>
+               <TableRowEntry>
+                  <TableColumnItems>
+                     <TableColumnItem>
+                        <PropertyName>id</PropertyName>
+                     </TableColumnItem>
+                     <TableColumnItem>
+                        <PropertyName>name</PropertyName>
+                     </TableColumnItem>
+                     <TableColumnItem>
+                        <PropertyName>logFields</PropertyName>
+                     </TableColumnItem>
+                     <TableColumnItem>
+                        <PropertyName>resourceMapping</PropertyName>
+                     </TableColumnItem>
+                     <TableColumnItem>
+                        <PropertyName>description</PropertyName>
+                     </TableColumnItem>
+                  </TableColumnItems>
+               </TableRowEntry>
+            </TableRowEntries>
+         </TableControl>
+      </View>
       <!-- New View LogicMonitor.Propertysource-->
       <View>
          <Name>LogicMonitorPropertysource</Name>
diff --git a/Public/Export-LMLogicModule.ps1 b/Public/Export-LMLogicModule.ps1
@@ -47,7 +47,7 @@ Function Export-LMLogicModule {
         [String]$LogicModuleName,
 
         [Parameter(Mandatory)]
-        [ValidateSet("datasources", "propertyrules", "eventsources", "topologysources", "configsources")]
+        [ValidateSet("datasources", "propertyrules", "eventsources", "topologysources", "configsources","logsources")]
         [String]$Type,
 
         [String]$DownloadPath = (Get-Location).Path
@@ -91,6 +91,11 @@ Function Export-LMLogicModule {
                         $ExportPath = $DownloadPath + "\$($LogicModuleInfo.name).xml"
                         $QueryParams = "?format=xml&v=3"
                     }
+                    "logsources" {
+                        $LogicModuleInfo = Get-LMLogSource -Name $LogicModuleName
+                        $ExportPath = $DownloadPath + "\$($LogicModuleInfo.name).xml"
+                        $QueryParams = "?format=xml&v=3"
+                    }
                 }
                 #Verify our query only returned one result
                 If (Test-LookupResult -Result $LogicModuleInfo.Id -LookupString $LogicModuleName) {
@@ -126,6 +131,11 @@ Function Export-LMLogicModule {
                         $ExportPath = $DownloadPath + "\$($LogicModuleInfo.name).xml"
                         $QueryParams = "?format=xml&v=3"
                     }
+                    "logsources" {
+                        $LogicModuleInfo = Get-LMLogSource -Id $LogicModuleId
+                        $ExportPath = $DownloadPath + "\$($LogicModuleInfo.name).xml"
+                        $QueryParams = "?format=xml&v=3"
+                    }
                 }
             }
 
diff --git a/Public/Get-LMAlert.ps1 b/Public/Get-LMAlert.ps1
@@ -62,7 +62,7 @@ Function Get-LMAlert {
         [ValidateSet("*", "Warning", "Error", "Critical")]
         [String]$Severity = "*",
 
-        [ValidateSet("*", "websiteAlert", "dataSourceAlert", "eventSourceAlert", "logAlert")]
+        [ValidateSet("*", "websiteAlert", "dataSourceAlert", "eventAlert", "logAlert")]
         [String]$Type = "*",
 
         [Boolean]$ClearedAlerts = $false,
diff --git a/Public/Get-LMLogSource.ps1 b/Public/Get-LMLogSource.ps1
@@ -0,0 +1,81 @@
+Function Get-LMLogSource {
+
+    [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/logsources"
+
+        #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"
+                }
+            }
+            Try {
+                $Headers = New-LMHeader -Auth $Script:LMAuth -Method "GET" -ResourcePath $ResourcePath
+                $Uri = "https://$($Script:LMAuth.Portal).logicmonitor.com/santaba/rest" + $ResourcePath + $QueryParams
+                    
+                
+                
+                Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation
+
+                #Issue request
+                $Response = Invoke-RestMethod -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.Logsource")
+                }
+                #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
+                    }
+                }
+            }
+            Catch [Exception] {
+                $Proceed = Resolve-LMException -LMException $PSItem
+                If (!$Proceed) {
+                    Return
+                }
+            }
+        }
+        Return (Add-ObjectTypeInfo -InputObject $Results -TypeName "LogicMonitor.Logsource")
+    }
+    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/Import-LMLogicModule.ps1 b/Public/Import-LMLogicModule.ps1
@@ -37,7 +37,7 @@ Function Import-LMLogicModule {
         [Parameter(Mandatory, ParameterSetName = 'File')]
         [Object]$File,
         
-        [ValidateSet("datasource", "propertyrules", "eventsource", "topologysource", "configsource")]
+        [ValidateSet("datasource", "propertyrules", "eventsource", "topologysource", "configsource","logsource")]
         [String]$Type = "datasource",
 
         [Boolean]$ForceOverwrite = $false
diff --git a/Public/New-LMOpsNote.ps1 b/Public/New-LMOpsNote.ps1
@@ -60,7 +60,7 @@ Function New-LMOpsNote {
         }
 
         $Scope = @()
-        If ($ResourceIds -or $WebsiteIds -or $DeviceGroupIds) {
+        If ($DeviceIds -or $WebsiteIds -or $DeviceGroupIds) {
             Foreach ($id in $DeviceIds) {
                 $Scope += [PSCustomObject]@{
                     type     = "device"
@@ -101,7 +101,7 @@ Function New-LMOpsNote {
             }
 
             #Remove empty keys so we dont overwrite them
-            @($Data.keys) | ForEach-Object { If ([string]::IsNullOrEmpty($Data[$_])) { $Data.Remove($_) } }
+            @($Data.keys) | ForEach-Object { If ([string]::IsNullOrEmpty($Data[$_]) -and $_ -ne "scopes" -and $_ -ne "tags") { $Data.Remove($_) } }
 
             $Data = ($Data | ConvertTo-Json)
 
diff --git a/Public/Remove-LMLogsource.ps1 b/Public/Remove-LMLogsource.ps1
@@ -0,0 +1,71 @@
+Function Remove-LMLogsource {
+
+    [CmdletBinding(DefaultParameterSetName = 'Id', SupportsShouldProcess, ConfirmImpact = 'High')]
+    Param (
+        [Parameter(Mandatory, ParameterSetName = 'Id', ValueFromPipelineByPropertyName)]
+        [Int]$Id,
+
+        [Parameter(Mandatory, ParameterSetName = 'Name')]
+        [String]$Name
+
+    )
+
+    Begin {}
+    Process {
+        #Check if we are logged in and have valid api creds
+        If ($Script:LMAuth.Valid) {
+
+            #Lookup Id if supplying username
+            If ($Name) {
+                $LookupResult = (Get-LMLogSource -Name $Name).Id
+                If (Test-LookupResult -Result $LookupResult -LookupString $Name) {
+                    return
+                }
+                $Id = $LookupResult
+            }
+
+            
+            #Build header and uri
+            $ResourcePath = "/setting/logsources/$Id"
+
+            If ($PSItem) {
+                $Message = "Id: $Id | Name: $($PSItem.name)"
+            }
+            Elseif ($Name) {
+                $Message = "Id: $Id | Name: $Name"
+            }
+            Else {
+                $Message = "Id: $Id"
+            }
+
+            Try {
+                If ($PSCmdlet.ShouldProcess($Message, "Remove Logsource")) {                    
+                    $Headers = New-LMHeader -Auth $Script:LMAuth -Method "DELETE" -ResourcePath $ResourcePath
+                    $Uri = "https://$($Script:LMAuth.Portal).logicmonitor.com/santaba/rest" + $ResourcePath
+    
+                    Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation
+
+                    #Issue request
+                    $Response = Invoke-RestMethod -Uri $Uri -Method "DELETE" -Headers $Headers[0] -WebSession $Headers[1]
+                    
+                    $Result = [PSCustomObject]@{
+                        Id      = $Id
+                        Message = "Successfully removed ($Message)"
+                    }
+                    
+                    Return $Result
+                }
+            }
+            Catch [Exception] {
+                $Proceed = Resolve-LMException -LMException $PSItem
+                If (!$Proceed) {
+                    Return
+                }
+            }
+        }
+        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/Set-LMDeviceDatasourceInstanceAlertSetting.ps1 b/Public/Set-LMDeviceDatasourceInstanceAlertSetting.ps1
@@ -72,34 +72,32 @@ Function Set-LMDeviceDatasourceInstanceAlertSetting {
 
             #Replace brakets in instance name
             $InstanceName = $InstanceName -replace "[\[\]]", "?"
-
             #Lookup HdsiId
             If ($DatasourceName) {
                 $LookupResult = (Get-LMDeviceDatasourceInstance -DatasourceName $DatasourceName -DeviceId $Id | Where-Object { $_.name -like "*$InstanceName" }).Id
-                If (Test-LookupResult -Result $LookupResult -LookupString $InstanceName) {
+                If (Test-LookupResult -Result $LookupResult -LookupString $DatasourceName) {
                     return
                 }
                 $HdsiId = $LookupResult
             }
             Else {
                 $LookupResult = (Get-LMDeviceDatasourceInstance -DatasourceId $DatasourceId -DeviceId $Id | Where-Object { $_.name -like "*$InstanceName" }).Id
-                If (Test-LookupResult -Result $LookupResult -LookupString $InstanceName) {
+                If (Test-LookupResult -Result $LookupResult -LookupString $DatasourceId) {
                     return
                 }
                 $HdsiId = $LookupResult
             }
-
-            #Lookup HdsiId
-            If ($DatapointName) {
+            #Lookup DatapointId
+            If ($DatasourceName) {
                 $LookupResult = (Get-LMDeviceDatasourceInstanceAlertSetting -DatasourceName $DatasourceName -Id $Id -InstanceName $InstanceName | Where-Object { $_.dataPointName -eq $DatapointName }).Id
-                If (Test-LookupResult -Result $LookupResult -LookupString $InstanceName) {
+                If (Test-LookupResult -Result $LookupResult -LookupString $DatapointName) {
                     return
                 }
                 $DatapointId = $LookupResult
             }
             Else {
-                $LookupResult = (Get-LMDeviceDatasourceInstance -DatasourceId $DatasourceId -Id $Id -InstanceName $InstanceName | Where-Object { $_.dataPointName -eq $DatapointName }).Id
-                If (Test-LookupResult -Result $LookupResult -LookupString $InstanceName) {
+                $LookupResult = (Get-LMDeviceDatasourceInstanceAlertSetting -DatasourceId $DatasourceId -Id $Id -InstanceName $InstanceName | Where-Object { $_.dataPointName -eq $DatapointName }).Id
+                If (Test-LookupResult -Result $LookupResult -LookupString $DatasourceId) {
                     return
                 }
                 $DatapointId = $LookupResult
@@ -108,7 +106,7 @@ Function Set-LMDeviceDatasourceInstanceAlertSetting {
             #Build header and uri
             $ResourcePath = "/device/devices/$Id/devicedatasources/$HdsId/instances/$HdsiId/alertsettings/$DatapointId"
 
-            $Message = "Id: $Id | hostDatasourceId: $HdsId | datapointId: $DatapointId"
+            $Message = "Id: $Id | hostDatasourceId: $HdsId | instanceId: $HdsiId | datapointId: $DatapointId"
 
             Try {
                 $Data = @{
diff --git a/Public/Test-LMAppliesToQuery.ps1 b/Public/Test-LMAppliesToQuery.ps1
@@ -0,0 +1,61 @@
+<#
+.SYNOPSIS
+Tests the applies to query against the LogicMonitor API.
+
+.DESCRIPTION
+The Test-LMAppliesToQuery function is used to test the applies to query against the LogicMonitor API.
+
+.PARAMETER Query
+The applies to query to be tested.
+
+.EXAMPLE
+Test-LMAppliesToQuery -Query "system.hostname == 'server01'"
+
+This example tests the applies to query "system.hostname == 'server01'" against the LogicMonitor API and returns a list of matching devices.
+#>
+Function Test-LMAppliesToQuery {
+
+    [CmdletBinding()]
+    Param (
+        [Parameter(Mandatory)]
+        [String]$Query
+
+    )
+    #Check if we are logged in and have valid api creds
+    If ($Script:LMAuth.Valid) {
+
+        
+        #Build header and uri
+        $ResourcePath = "/functions"
+
+        Try {
+            $Data = @{
+                currentAppliesTo    = $Query
+                originalAppliesTo   = $Query
+                needInheritProps    = $true
+                type                = "testAppliesTo"
+            }
+
+            $Data = ($Data | ConvertTo-Json)
+
+            $Headers = New-LMHeader -Auth $Script:LMAuth -Method "POST" -ResourcePath $ResourcePath -Data $Data 
+            $Uri = "https://$($Script:LMAuth.Portal).logicmonitor.com/santaba/rest" + $ResourcePath
+
+            Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation -Payload $Data
+
+            #Issue request
+            $Response = (Invoke-RestMethod -Uri $Uri -Method "POST" -Headers $Headers[0] -WebSession $Headers[1] -Body $Data).currentMatches
+
+            Return $Response
+        }
+        Catch [Exception] {
+            $Proceed = Resolve-LMException -LMException $PSItem
+            If (!$Proceed) {
+                Return
+            }
+        }
+    }
+    Else {
+        Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again."
+    }
+}
diff --git a/README.md b/README.md
diff --git a/RELEASENOTES.md b/RELEASENOTES.md

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ Function Export-LMLogicModule {`
`47`	`47`	`[String]$LogicModuleName,`
`48`	`48`
`49`	`49`	`[Parameter(Mandatory)]`
`50`		`- [ValidateSet("datasources", "propertyrules", "eventsources", "topologysources", "configsources")]`
	`50`	`+ [ValidateSet("datasources", "propertyrules", "eventsources", "topologysources", "configsources","logsources")]`
`51`	`51`	`[String]$Type,`
`52`	`52`
`53`	`53`	`[String]$DownloadPath = (Get-Location).Path`
`@@ -91,6 +91,11 @@ Function Export-LMLogicModule {`
`91`	`91`	`$ExportPath = $DownloadPath + "\$($LogicModuleInfo.name).xml"`
`92`	`92`	`$QueryParams = "?format=xml&v=3"`
`93`	`93`	`}`
	`94`	`+ "logsources" {`
	`95`	`+ $LogicModuleInfo = Get-LMLogSource -Name $LogicModuleName`
	`96`	`+ $ExportPath = $DownloadPath + "\$($LogicModuleInfo.name).xml"`
	`97`	`+ $QueryParams = "?format=xml&v=3"`
	`98`	`+ }`
`94`	`99`	`}`
`95`	`100`	`#Verify our query only returned one result`
`96`	`101`	`If (Test-LookupResult -Result $LogicModuleInfo.Id -LookupString $LogicModuleName) {`
`@@ -126,6 +131,11 @@ Function Export-LMLogicModule {`
`126`	`131`	`$ExportPath = $DownloadPath + "\$($LogicModuleInfo.name).xml"`
`127`	`132`	`$QueryParams = "?format=xml&v=3"`
`128`	`133`	`}`
	`134`	`+ "logsources" {`
	`135`	`+ $LogicModuleInfo = Get-LMLogSource -Id $LogicModuleId`
	`136`	`+ $ExportPath = $DownloadPath + "\$($LogicModuleInfo.name).xml"`
	`137`	`+ $QueryParams = "?format=xml&v=3"`
	`138`	`+ }`
`129`	`139`	`}`
`130`	`140`	`}`
`131`	`141`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ Function New-LMOpsNote {`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`$Scope = @()`
`63`		`- If ($ResourceIds -or $WebsiteIds -or $DeviceGroupIds) {`
	`63`	`+ If ($DeviceIds -or $WebsiteIds -or $DeviceGroupIds) {`
`64`	`64`	`Foreach ($id in $DeviceIds) {`
`65`	`65`	`$Scope += [PSCustomObject]@{`
`66`	`66`	`type = "device"`
`@@ -101,7 +101,7 @@ Function New-LMOpsNote {`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`#Remove empty keys so we dont overwrite them`
`104`		`- @($Data.keys) \| ForEach-Object { If ([string]::IsNullOrEmpty($Data[$_])) { $Data.Remove($_) } }`
	`104`	`+ @($Data.keys) \| ForEach-Object { If ([string]::IsNullOrEmpty($Data[$_]) -and $_ -ne "scopes" -and $_ -ne "tags") { $Data.Remove($_) } }`
`105`	`105`
`106`	`106`	`$Data = ($Data \| ConvertTo-Json)`
`107`	`107`