Public/Get-LMConfigSource.ps1
|
<# .SYNOPSIS Retrieves configuration sources from LogicMonitor. .DESCRIPTION The Get-LMConfigSource function retrieves configuration sources from LogicMonitor based on specified parameters. It can return a single configuration source by ID or name, or multiple sources using filters. .PARAMETER Id The ID of the configuration source to retrieve. This parameter is part of a mutually exclusive parameter set. .PARAMETER Name The name of the configuration source to retrieve. This parameter is part of a mutually exclusive parameter set. .PARAMETER Filter A filter object to apply when retrieving configuration sources. This parameter is part of a mutually exclusive parameter set. .PARAMETER BatchSize The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. .EXAMPLE #Retrieve a configuration source by ID Get-LMConfigSource -Id 123 .EXAMPLE #Retrieve a configuration source by name Get-LMConfigSource -Name "Cisco Config" .NOTES You must run Connect-LMAccount before running this command. .INPUTS None. You cannot pipe objects to this command. .OUTPUTS Returns LogicMonitor.Datasource objects. #> function Get-LMConfigSource { [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) { $ResourcePath = "/setting/configsources" $ParameterSetName = $PSCmdlet.ParameterSetName $CommandInvocation = $MyInvocation $SingleObjectWhenNotPaged = $ParameterSetName -eq "Id" $CallerPSCmdlet = $PSCmdlet $Results = Invoke-LMPaginatedGet -BatchSize $BatchSize -SingleObjectWhenNotPaged:$SingleObjectWhenNotPaged -InvokeRequest { param($Offset, $PageSize) $RequestResourcePath = $ResourcePath $QueryParams = "" switch ($ParameterSetName) { "All" { $QueryParams = "?size=$PageSize&offset=$Offset&sort=+id" } "Id" { $RequestResourcePath = "$ResourcePath/$Id" } "Name" { $QueryParams = "?filter=name:`"$Name`"&size=$PageSize&offset=$Offset&sort=+id" } "Filter" { $ValidFilter = Format-LMFilter -Filter $Filter -ResourcePath $ResourcePath $QueryParams = "?filter=$ValidFilter&size=$PageSize&offset=$Offset&sort=+id" } } $Headers = New-LMHeader -Auth $Script:LMAuth -Method "GET" -ResourcePath $RequestResourcePath $Uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $RequestResourcePath + $QueryParams Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $CommandInvocation $Response = Invoke-LMRestMethod -CallerPSCmdlet $CallerPSCmdlet -Uri $Uri -Method "GET" -Headers $Headers[0] -WebSession $Headers[1] if ($null -eq $Response) { return $null } return $Response } if ($null -eq $Results) { return } return (Add-ObjectTypeInfo -InputObject $Results -TypeName "LogicMonitor.Datasource") } else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } |