Start-CMDeployment
Applies To: System Center 2012 Configuration Manager SP1
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Start-CMDeployment
Starts deploying antimalware policies and client settings to Configuration Manager clients.
Syntax
Parameter Set: SearchByClientSettingName_CollectionName
Start-CMDeployment -ClientSettingName <String> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByAntimalwarePolicyId_CollectionId
Start-CMDeployment -AntimalwarePolicyId <String> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByAntimalwarePolicyId_CollectionName
Start-CMDeployment -AntimalwarePolicyId <String> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByAntimalwarePolicyId_CollectionValue
Start-CMDeployment -AntimalwarePolicyId <String> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByAntimalwarePolicyName_CollectionId
Start-CMDeployment -AntimalwarePolicyName <String> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByAntimalwarePolicyName_CollectionName
Start-CMDeployment -AntimalwarePolicyName <String> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByAntimalwarePolicyName_CollectionValue
Start-CMDeployment -AntimalwarePolicyName <String> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByAntimalwarePolicyValue_CollectionId
Start-CMDeployment -AntimalwarePolicy <IResultObject> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByAntimalwarePolicyValue_CollectionName
Start-CMDeployment -AntimalwarePolicy <IResultObject> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByAntimalwarePolicyValue_CollectionValue
Start-CMDeployment -AntimalwarePolicy <IResultObject> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByClientSettingId_CollectionId
Start-CMDeployment -ClientSettingId <String> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByClientSettingId_CollectionName
Start-CMDeployment -ClientSettingId <String> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByClientSettingId_CollectionValue
Start-CMDeployment -ClientSettingId <String> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByClientSettingName_CollectionId
Start-CMDeployment -ClientSettingName <String> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByClientSettingName_CollectionValue
Start-CMDeployment -ClientSettingName <String> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByClientSettingValue_CollectionId
Start-CMDeployment -ClientSetting <IResultObject> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByClientSettingValue_CollectionName
Start-CMDeployment -ClientSetting <IResultObject> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByClientSettingValue_CollectionValue
Start-CMDeployment -ClientSetting <IResultObject> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-CMDeployment cmdlet starts the deployment of antimalware policies and client settings to Microsoft System Center 2012 Configuration Manager clients. Antimalware policies are configuration settings that define how an antimalware agent operates on a client computer. System Center 2012 Configuration Manager manages specified settings for clients through the cm5short agent.
When you start a deployment, specify a collection of computers to receive the policies or settings by using a collection name or collection ID or using the
Parameters
-AntimalwarePolicy<IResultObject>
Specifies an antimalware policy object. 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 an ID for an antimalware policy.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AntimalwarePolicyName<String>
Specifies a name for an antimalware policy.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ClientSetting<IResultObject>
Specifies a client setting object. To obtain a client setting object, use the Get-CMClientSetting cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ClientSettingId<String>
Specifies an ID of a client setting object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ClientSettingName<String>
Specifies a name of a client setting object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Collection<IResultObject>
Specifies a collection object. Configuration Manager applies the deployment to this collection. To obtain a 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 an ID for a collection. Configuration Manager applies the deployment to this collection.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CollectionName<String>
Specifies a name of a collection. Configuration Manager applies the deployment to this collection.
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.
Examples
Example 1: Deploy antimalware policies to a named collection
This command starts the deployment of antimalware policies named AntimalwarePolicies to a collection of clients named General desktop computers.
PS C:\> Start-CMDeployment -AntimalwarePolicyName "AntimalwarePolicies" -CollectionName "General desktop computers"
Example 2: Deploy client settings to a named collection
This command starts the deployment of client settings with the ID CSD0001 to a collection of clients named General desktop computers.
PS C:\> Start-CMDeployment -ClientSettingId "CSD0001" -CollectionName "General desktop computers"