.png)
Start-CMAntimalwarePolicyDeployment
Updated: March 1, 2013
Applies To: System Center 2012 Configuration Manager SP1
Start-CMAntimalwarePolicyDeployment
Syntax
Parameter Set: SearchByAntimalwarePolicyId_CollectionId Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyId <String> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SearchByAntimalwarePolicyId_CollectionName Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyId <String> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SearchByAntimalwarePolicyId_CollectionValue Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyId <String> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SearchByAntimalwarePolicyName_CollectionId Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyName <String> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SearchByAntimalwarePolicyName_CollectionName Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyName <String> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SearchByAntimalwarePolicyName_CollectionValue Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyName <String> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SearchByAntimalwarePolicyValue_CollectionId Start-CMAntimalwarePolicyDeployment -AntimalwarePolicy <IResultObject> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SearchByAntimalwarePolicyValue_CollectionName Start-CMAntimalwarePolicyDeployment -AntimalwarePolicy <IResultObject> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SearchByAntimalwarePolicyValue_CollectionValue Start-CMAntimalwarePolicyDeployment -AntimalwarePolicy <IResultObject> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: StartDeploymentByName Start-CMAntimalwarePolicyDeployment -Name <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-CMAntimalwarePolicyDeployment cmdlet starts the deployment of a Microsoft System Center 2012 Endpoint Protection antimalware policy to the members of a Microsoft System Center 2012 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.
Parameters
-AntimalwarePolicy<IResultObject>
Specifies an antimalware policy object in Configuration Manager. To obtain an antimalware policy object, use the Get-CMAntiMalwarePolicy cmdlet.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-AntimalwarePolicyId<String>
Specifies the ID of an antimalware policy.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-AntimalwarePolicyName<String>
Specifies the name of an antimalware policy.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Collection<IResultObject>
Specifies a Configuration Manager device collection object. To obtain a device collection object, use the Get-CMDeviceCollection cmdlet.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-CollectionId<String>
Specifies the ID of a device collection.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-CollectionName<String>
Specifies the name of a device collection.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Name<String>
Specifies the name of an antimalware policy deployment.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Confirm
Prompts you for confirmation before executing the command.
Required? | false |
Position? | named |
Default Value | false |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
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.
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: Deploy an antimalware policy to a collection by using an ID
This command starts the deployment for a policy named ExclusionsPolicy to a device collection that has the ID SMS00023.
PS C:\> Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyName "ExclusionsPolicy" -CollectionId "SMS00023"
Example 2: Deploy an antimalware policy to a named collection
This command starts the deployment for a policy named ExclusionsPolicy to a device collection named SouthOffice.
PS C:\> Start-CMAntimalwarePolicyDeployment -AntimalwarePolicyName "ExclusionsPolicy" -CollectionName "SouthOffice"
