Edit

Start-CMAntimalwarePolicyDeployment

  • Reference
Module:
ConfigurationManager

(Deprecated) Starts the deployment of an antimalware policy to the members of a Configuration Manager collection.

Syntax

Start-CMAntimalwarePolicyDeployment
     -AntimalwarePolicy <IResultObject>
     -Collection <IResultObject>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMAntimalwarePolicyDeployment
     -AntimalwarePolicy <IResultObject>
     -CollectionId <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMAntimalwarePolicyDeployment
     -AntimalwarePolicy <IResultObject>
     -CollectionName <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMAntimalwarePolicyDeployment
     -AntimalwarePolicyId <String>
     -CollectionId <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMAntimalwarePolicyDeployment
     -AntimalwarePolicyId <String>
     -CollectionName <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMAntimalwarePolicyDeployment
     -AntimalwarePolicyId <String>
     -Collection <IResultObject>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMAntimalwarePolicyDeployment
     -AntimalwarePolicyName <String>
     -CollectionId <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMAntimalwarePolicyDeployment
     -AntimalwarePolicyName <String>
     -CollectionName <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMAntimalwarePolicyDeployment
     -AntimalwarePolicyName <String>
     -Collection <IResultObject>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-CMAntimalwarePolicyDeployment cmdlet starts the deployment of a Microsoft System Center 2016 Endpoint Protection antimalware policy to the members of a Configuration Manager collection.

To start a policy deployment, specify the antimalware policy to be deployed and the device collection that is the destination for the deployment. Specify a policy by name or by ID, or use the Get-CMAntiMalwarePolicy cmdlet to get a policy object. Specify a collection by name or by ID, or use the Get-CMDeviceCollection cmdlet to get a collection object. You can also specify a deployment name to deploy a policy.

Important

Starting in version 2107, this cmdlet is deprecated and may be removed in a future release. Instead use the New-CMAntimalwarePolicyDeployment cmdlet.

Examples

Example 1: Deploy an antimalware policy to a collection by using an ID

PS XYZ:\> Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyName "ExclusionsPolicy" -CollectionId "SMS00023"

This command starts the deployment for a policy named ExclusionsPolicy to a device collection that has the ID SMS00023.

Example 2: Deploy an antimalware policy to a named collection

PS XYZ:\> Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyName "ExclusionsPolicy" -CollectionName "SouthOffice"

This command starts the deployment for a policy named ExclusionsPolicy to a device collection named SouthOffice.

Parameters

-AntimalwarePolicy

Specifies an antimalware policy object in Configuration Manager. To obtain an antimalware policy object, use the Get-CMAntiMalwarePolicy cmdlet.

Type:IResultObject
Aliases:Policy
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-AntimalwarePolicyId

Specifies the ID of an antimalware policy.

Type:String
Aliases:PolicyId
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-AntimalwarePolicyName

Specifies the name of an antimalware policy.

Type:String
Aliases:PolicyName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Collection

Specifies a Configuration Manager device collection object. To obtain a device collection object, use Get-CMDeviceCollection.

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

-CollectionId

Specifies the ID of a device collection.

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

-CollectionName

Specifies the name of a device collection.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object