tentools

0.0.1

public/Stop-TNScan.ps1

                                function Stop-TNScan {

<#

    .SYNOPSIS

        Stops a list of scans

    .DESCRIPTION

        Stops 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:\> Stop-TNScan

        Stops a list of scans

#>

    [CmdletBinding()]

    param

    (

        [Parameter(ValueFromPipelineByPropertyName)]

        [object[]]$SessionObject = (Get-TNSession),

        [Parameter(Mandatory, ValueFromPipelineByPropertyName)]

        [int32]$ScanId,

        [switch]$EnableException

    )

    begin {

    }

    process {

        foreach ($session in $SessionObject) {

            $Scans = Invoke-TNRequest -SessionObject $session -EnableException:$EnableException -Path "/scans/$ScanId/stop" -Method 'Post'

            if ($Scans -is [psobject]) {

                $scan = $Scans.scan

                $ScanProps = [ordered]@{ }

                $ScanProps.add('Name', $scan.name)

                $ScanProps.add('ScanId', $ScanId)

                $ScanProps.add('HistoryId', $scan.id)

                $ScanProps.add('Status', $scan.status)

                $ScanProps.add('Enabled', $scan.enabled)

                $ScanProps.add('Owner', $scan.owner)

                $ScanProps.add('AlternateTarget', $scan.ownalt_targetser)

                $ScanProps.add('IsPCI', $scan.is_pci)

                $ScanProps.add('UserPermission', $permidenum[$scan.user_permissions])

                $ScanProps.add('CreationDate', $origin.AddSeconds($scan.creation_date).ToLocalTime())

                $ScanProps.add('LastModified', $origin.AddSeconds($scan.last_modification_date).ToLocalTime())

                $ScanProps.add('StartTime', $origin.AddSeconds($scan.starttime).ToLocalTime())

                $ScanProps.Add('SessionId', $session.SessionId)

                $ScanObj = New-Object -TypeName psobject -Property $ScanProps

                $ScanObj.pstypenames[0] = 'Nessus.RunningScan'

                $ScanObj

            }

        }

    }

}