Invoke-CMEndpointProtectionScan
Invoke-CMEndpointProtectionScan
Invokes a scan to detect malware on one or more devices in the Configuration Manager hierarchy.
Syntax
Parameter Set: SearchByDeviceIdMandatory
Invoke-CMEndpointProtectionScan -DeviceId <String> [-ScanType <ScanType> {Full | Quick} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByDeviceNameMandatory
Invoke-CMEndpointProtectionScan -DeviceName <String> [-ScanType <ScanType> {Full | Quick} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByDeviceValueMandatory
Invoke-CMEndpointProtectionScan -Device <IResultObject> [-ScanType <ScanType> {Full | Quick} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByIdMandatory
Invoke-CMEndpointProtectionScan -DeviceCollectionId <String> [-ScanType <ScanType> {Full | Quick} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByNameMandatory
Invoke-CMEndpointProtectionScan -DeviceCollectionName <String> [-ScanType <ScanType> {Full | Quick} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Invoke-CMEndpointProtectionScan -DeviceCollection <IResultObject> [-ScanType <ScanType> {Full | Quick} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Invoke-CMEndpointProtectionScan cmdlet invokes an Endpoint Protection scan that is outside of any scheduled scans. You can specify the device or collection by using its name, Id, or by specifying an object that represents the device or collection.
For more information about how Configuration Manager supports Endpoint Protection, see Endpoint Protection in Configuration Manager.
Parameters
-Device<IResultObject>
Specifies the device that is scanned for malware.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceCollection<IResultObject>
Specifies an object that represents a device collection whose members are scanned for malware.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceCollectionId<String>
Specifies the Id of a device collection whose members are scanned for malware.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceCollectionName<String>
Specifies the name of a device collection whose members are scanned for malware.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceId<String>
Specifies the Id of a device that is scanned for malware.
Aliases |
ResourceID |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceName<String>
Specifies the name of a device that is scanned for malware.
Aliases |
Name |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ScanType<ScanType>
Specifies a full or a quick scan. A full scan looks at every location on the device. A quick scan looks at only those locations where malware is most likely to appear.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<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: Invoke a full Endpoint Protection scan
This command invokes a full Endpoint Protection scan of the device named CMCEN-DIST02.
PS C:\> Invoke-CMEndpointProtectionScan -DeviceName "CMCEN-DIST02" -ScanType Full