Set-CMClientPushInstallation
Configure settings for client push installation.
Syntax
SearchByValueMandatory (Default)
Set-CMClientPushInstallation
-InputObject <IResultObject>
[-AddAccount <String[]>]
[-AllownNTLMFallback <Boolean>]
[-ChosenAccount <String[]>]
[-ClearAccount]
[-EnableAutomaticClientPushInstallation <Boolean>]
[-EnableSystemTypeConfigurationManager <Boolean>]
[-EnableSystemTypeServer <Boolean>]
[-EnableSystemTypeWorkstation <Boolean>]
[-InstallationProperty <String>]
[-InstallClientToDomainController <Boolean>]
[-RemoveAccount <String[]>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByComponentValueMandatory
Set-CMClientPushInstallation
-InputObject <IResultObject>
[-AddAccount <String[]>]
[-AllownNTLMFallback <Boolean>]
[-ChosenAccount <String[]>]
[-ClearAccount]
[-EnableAutomaticClientPushInstallation <Boolean>]
[-EnableSystemTypeConfigurationManager <Boolean>]
[-EnableSystemTypeServer <Boolean>]
[-EnableSystemTypeWorkstation <Boolean>]
[-InstallationProperty <String>]
[-InstallClientToDomainController <Boolean>]
[-RemoveAccount <String[]>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByNameMandatory
Set-CMClientPushInstallation
-Name <String>
[-AddAccount <String[]>]
[-AllownNTLMFallback <Boolean>]
[-ChosenAccount <String[]>]
[-ClearAccount]
[-EnableAutomaticClientPushInstallation <Boolean>]
[-EnableSystemTypeConfigurationManager <Boolean>]
[-EnableSystemTypeServer <Boolean>]
[-EnableSystemTypeWorkstation <Boolean>]
[-InstallationProperty <String>]
[-InstallClientToDomainController <Boolean>]
[-RemoveAccount <String[]>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchBySiteCodeMandatory
Set-CMClientPushInstallation
[-AddAccount <String[]>]
[-AllownNTLMFallback <Boolean>]
[-ChosenAccount <String[]>]
[-ClearAccount]
[-EnableAutomaticClientPushInstallation <Boolean>]
[-EnableSystemTypeConfigurationManager <Boolean>]
[-EnableSystemTypeServer <Boolean>]
[-EnableSystemTypeWorkstation <Boolean>]
[-InstallationProperty <String>]
[-InstallClientToDomainController <Boolean>]
[-RemoveAccount <String[]>]
[-SiteCode <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Use this cmdlet to change the site configuration for client push installation. The client push installation method installs the Configuration Manager client on computers that the site discovers.
You can also start a client push installation by running the Client Push Installation Wizard for a specific collection or resource within a collection.
For more information, see How to install clients on Windows-based computers in Configuration Manager.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Change the settings of a client push installation
This command makes the following configurations:
- Automatically use client push for discovered computers.
- Push the client to site system servers
- The site uses the account named contoso\svc_smspush to connect to the computer to install the client software.
The InstallationProperty parameter sets the value of the SMSSITECODE property for the Windows Installer package to CM1. This setting assigns the client to the site that has the site code CM1.
Set-CMClientPushInstallation -SiteCode "CM1" -EnableAutomaticClientPushInstallation $True -EnableSystemTypeConfiguationManager $True -ChosenAccount "contoso\svc_smspush" -InstallationProperty "SMSSITECODE=CM1"
Parameters
-AddAccount
Specify a string array for one or more accounts that can install the client. The accounts need to be a local Administrator on the destination computer. For each account, use the format domain\username.
For more information, see Client push installation account.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AddAccounts |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AllownNTLMFallback
When this parameter is $true, if the site can't authenticate the client by using Kerberos, it retries the connection by using NTLM. The recommended configuration for improved security is to set this parameter to $false, which requires Kerberos without NTLM fallback.
Note
When it uses client push to install the Configuration Manager client, the site server creates a remote connection to the client. The site can require Kerberos mutual authentication by not allowing fallback to NTLM before establishing the connection. This behavior helps to secure the communication between the server and the client.
Depending on your security policies, your environment might already prefer or require Kerberos over the older NTLM authentication. For more information on the security considerations of these authentication protocols, read about the Windows security policy setting to restrict NTLM.
To use this feature, clients must be in a trusted Active Directory forest. Kerberos in Windows relies on Active Directory for mutual authentication.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ChosenAccount
Specify a string array for one or more accounts already added to Configuration Manager.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ChosenAccounts |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ClearAccount
Add this parameter to remove all accounts that are currently specified for client push at the site. To remove a single account, use the RemoveAccount parameter.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ClearAccounts |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableAutomaticClientPushInstallation
Set this parameter to $true to install the Configuration Manager client on newly discovered computer resources. It also enables installation on existing computer resources that don't have the client installed.
If you set this parameter to $false, you can still use the Install client action on a collection or device.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableSystemTypeConfigurationManager
Set this parameter to $true to install the Configuration Manager client on site system servers.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableSystemTypeServer
Set this parameter to $true to install the Configuration Manager client on servers.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableSystemTypeWorkstation
Set this parameter to $true to install the Configuration Manager client on workstations.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specify a client push installation object. To get this object, use the Get-CMClientPushInstallation cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ClientPushComponent |
Parameter sets
SearchByValueMandatory
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
SearchByComponentValueMandatory
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InstallationProperty
Specify any installation properties to use when installing the Configuration Manager client.
For example:
/mp:mp01.contoso.com CCMDEBUGLOGGING="1" CCMLOGGINGENABLED="TRUE" CCMLOGLEVEL="0" CCMLOGMAXHISTORY="5" CCMLOGMAXSIZE="10000000" SMSCACHESIZE="15000" SMSSITECODE="XYZ" SMSMP=mp01.contoso.com
For more information, see About client installation parameters and properties in Configuration Manager.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InstallClientToDomainController
Set this parameter to specify whether to install the Configuration Manager client on domain controllers:
- $true: Always install the client on domain controllers.
- $false: Never install the client on domain controllers, unless specified in the Client Push Installation Wizard.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies a name for the client push installation.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SiteName |
Parameter sets
SearchByNameMandatory
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RemoveAccount
Specify a string array of client push installation accounts to remove. To remove all accounts, use the ClearAccount parameter.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RemoveAccounts |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SiteCode
Specify the three character site code. For example, XYZ.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SearchBySiteCodeMandatory
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.