Start-MpScan

Start-MpScan

Starts a scan on a computer.

Syntax

Parameter Set: Start0
Start-MpScan [-AsJob] [-CimSession <CimSession[]> ] [-ScanPath <String> ] [-ScanType <ScanType> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Start-MpScan cmdlet starts a scan on a computer. The cmdlet performs scans for the path you specify.

Parameters

-AsJob

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

-ScanPath<String>

Specifies a file or a folder path to scan. Specify a file name, a folder name, such as C:\, or a UNC path.

-ScanType<ScanType>

Specifies the type of scan. The acceptable values for this parameter are:

   -- FullScan
   -- QuickScan
   -- CustomScan

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Start a scan

This command starts a scan on the computer on which you run the cmdlet.

PS C:\> Start-MpScan