Public/Remove-LMNetscan.ps1
|
<# .SYNOPSIS Removes a LogicMonitor Netscan. .DESCRIPTION The Remove-LMNetscan function is used to remove a LogicMonitor Netscan. It supports removing a Netscan by either its Id or Name. .PARAMETER Id Specifies the Id of the Netscan to remove. This parameter is mandatory when using the 'Id' parameter set. .PARAMETER Name Specifies the Name of the Netscan to remove. This parameter is mandatory when using the 'Name' parameter set. .EXAMPLE Remove-LMNetscan -Id 123 Removes the Netscan with Id 123. .EXAMPLE Remove-LMNetscan -Name "MyNetscan" Removes the Netscan with the name "MyNetscan". .INPUTS You can pipe input to this function. .OUTPUTS Returns a PSCustomObject containing the ID of the removed Netscan and a message indicating the success of the removal operation. #> function Remove-LMNetscan { [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-LMNetscan -Name $Name).Id if (Test-LookupResult -Result $LookupResult -LookupString $Name) { return } $Id = $LookupResult } #Build header and uri $ResourcePath = "/setting/netscans/$Id" if ($PSItem) { $Message = "Id: $Id | Name: $($PSItem.name)" } elseif ($Name) { $Message = "Id: $Id | Name: $Name" } else { $Message = "Id: $Id" } #Loop through requests if ($PSCmdlet.ShouldProcess($Message, "Remove NetScan")) { $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 {} } |