< Back

Start-MpScan

Tue Jan 29, 2019 10:14 pm

NAME Start-MpScan



SYNOPSIS

Starts a scan on a computer.





SYNTAX

Start-MpScan [-CimSession <CimSession[]>] [-ScanPath <String>] [-ScanType {QuickScan | FullScan | CustomScan}] [-ThrottleLimit <Int32>]

[<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ScanType [<ScanType>]

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



-- FullScan

-- QuickScan

-- CustomScan



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS









Example 1: Start a scan



PS C:\\> Start-MpScan



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







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=317472