Skip to content

Latest commit

 

History

History
145 lines (113 loc) · 3.7 KB

Start-MpScan.md

File metadata and controls

145 lines (113 loc) · 3.7 KB
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
MSFT_MpScan.cdxml-help.xml
Defender
12/20/2016
2.0.0
Start-MpScan

Start-MpScan

SYNOPSIS

Starts a scan on a computer.

SYNTAX

Start-MpScan
 [-AsJob]
 [-CimSession <CimSession[]>]
 [-ScanPath <String>]
 [-ScanType <ScanType>]
 [-ThrottleLimit <Int32>]
 [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

Example 1: Start a scan

PS C:\> Start-MpScan

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

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ScanPath

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ScanType

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

  • FullScan
  • QuickScan
  • CustomScan
Type: ScanType
Parameter Sets: (All)
Aliases:
Accepted values: FullScan, QuickScan, CustomScan

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ThrottleLimit

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.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS