public/Remove-TNScan.ps1
|
function Remove-TNScan { <# .SYNOPSIS Removes a list of scans .DESCRIPTION Removes a list of scans .PARAMETER SessionObject Optional parameter to force using specific SessionObjects. By default, each command will connect to all connected servers that have been connected to using Connect-TNServer .PARAMETER ScanId The ID of the target scan .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with 'sea of red' exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this 'nice by default' feature off and enables you to catch exceptions with your own try/catch. .EXAMPLE PS C:\> Remove-TNScan Removes a list of scans #> [CmdletBinding()] param ( [Parameter(ValueFromPipelineByPropertyName)] [object[]]$SessionObject = (Get-TNSession), [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias("Id")] [int32]$ScanId, [Parameter(ValueFromPipelineByPropertyName)] [switch]$EnableException ) process { foreach ($session in $SessionObject) { $PSDefaultParameterValues["*:SessionObject"] = $session Write-PSFMessage -Level Verbose -Message "Removing scan with Id $ScanId" Invoke-TNRequest -SessionObject $session -EnableException:$EnableException -Path "/scans/$ScanId" -Method Delete -Parameter $params | ConvertFrom-TNRestResponse Write-PSFMessage -Level Verbose -Message 'Scan Removed' } } } |