Skip to content

Latest commit

 

History

History
280 lines (214 loc) · 8.58 KB

Start-CMAntimalwarePolicyDeployment.md

File metadata and controls

280 lines (214 loc) · 8.58 KB
description external help file Module Name ms.date schema title
Starts the deployment of an antimalware policy to the members of a Configuration Manager collection.
AdminUI.PS.dll-Help.xml
ConfigurationManager
05/07/2019
2.0.0
Start-CMAntimalwarePolicyDeployment

Start-CMAntimalwarePolicyDeployment

SYNOPSIS

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

SYNTAX

SearchByAntimalwarePolicyValue_CollectionValue (Default)

Start-CMAntimalwarePolicyDeployment -AntimalwarePolicy <IResultObject> -Collection <IResultObject>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByAntimalwarePolicyValue_CollectionId

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

SearchByAntimalwarePolicyValue_CollectionName

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

SearchByAntimalwarePolicyId_CollectionId

Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyId <String> -CollectionId <String>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByAntimalwarePolicyId_CollectionName

Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyId <String> -CollectionName <String>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByAntimalwarePolicyId_CollectionValue

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

SearchByAntimalwarePolicyName_CollectionId

Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyName <String> -CollectionId <String>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByAntimalwarePolicyName_CollectionName

Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyName <String> -CollectionName <String>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByAntimalwarePolicyName_CollectionValue

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
Parameter Sets: SearchByAntimalwarePolicyValue_CollectionValue, SearchByAntimalwarePolicyValue_CollectionId, SearchByAntimalwarePolicyValue_CollectionName
Aliases: Policy

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-AntimalwarePolicyId

Specifies the ID of an antimalware policy.

Type: String
Parameter Sets: SearchByAntimalwarePolicyId_CollectionId, SearchByAntimalwarePolicyId_CollectionName, SearchByAntimalwarePolicyId_CollectionValue
Aliases: PolicyId

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

-AntimalwarePolicyName

Specifies the name of an antimalware policy.

Type: String
Parameter Sets: SearchByAntimalwarePolicyName_CollectionId, SearchByAntimalwarePolicyName_CollectionName, SearchByAntimalwarePolicyName_CollectionValue
Aliases: PolicyName

Required: True
Position: Named
Default value: None
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
Parameter Sets: SearchByAntimalwarePolicyValue_CollectionValue, SearchByAntimalwarePolicyId_CollectionValue, SearchByAntimalwarePolicyName_CollectionValue
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-CollectionId

Specifies the ID of a device collection.

Type: String
Parameter Sets: SearchByAntimalwarePolicyValue_CollectionId, SearchByAntimalwarePolicyId_CollectionId, SearchByAntimalwarePolicyName_CollectionId
Aliases:

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

-CollectionName

Specifies the name of a device collection.

Type: String
Parameter Sets: SearchByAntimalwarePolicyValue_CollectionName, SearchByAntimalwarePolicyId_CollectionName, SearchByAntimalwarePolicyName_CollectionName
Aliases:

Required: True
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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 doesn't run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

OUTPUTS

System.Object

NOTES

RELATED LINKS

Export-CMAntimalwarePolicy

Get-CMAntiMalwarePolicy

Merge-CMAntimalwarePolicy

New-CMAntimalwarePolicy

Remove-CMAntiMalwarePolicy

Set-CMAntiMalwarePolicy

Get-CMDeviceCollection