Install-CMClient
Installs a Configuration Manager client.
Syntax
Install-CMClient
[-AlwaysInstallClient <Boolean>]
[-ForceReinstall <Boolean>]
[-IncludeDomainController <Boolean>]
-InputObject <IResultObject>
[-SiteCode <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Install-CMClient
[-AlwaysInstallClient <Boolean>]
-DeviceId <String>
[-ForceReinstall <Boolean>]
[-IncludeDomainController <Boolean>]
[-SiteCode <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Install-CMClient
[-AlwaysInstallClient <Boolean>]
-DeviceName <String>
[-ForceReinstall <Boolean>]
[-IncludeDomainController <Boolean>]
[-SiteCode <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Install-CMClient
[-AlwaysInstallClient <Boolean>]
-CollectionId <String>
[-ForceReinstall <Boolean>]
[-IncludeDomainController <Boolean>]
[-SiteCode <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Install-CMClient
[-AlwaysInstallClient <Boolean>]
[-ForceReinstall <Boolean>]
[-IncludeDomainController <Boolean>]
-Name <String>
[-SiteCode <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Install-CMClient cmdlet installs a client for 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: Install a client
PS XYZ:\>Install-CMClient -Name "RemoteClient05" -SiteCode "CM1" -AlwaysInstallClient $True -IncludeDomainController $True
This command installs the client named RemoteClient05 on the Configuration Manager site that has the site code CM1.
Parameters
-AlwaysInstallClient
Indicates whether Configuration Manager always installs the client.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CollectionId
Specifies the ID of the collection to which the client belongs.
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 |
-DeviceId
Specifies the ID for the device to which Configuration Manager installs the client.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceName
Specifies the name of the device to which Configuration Manager installs the client.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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 |
-ForceReinstall
Indicates whether the cmdlet reinstalls the client.
Type: | Boolean |
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 |
-IncludeDomainController
Indicates whether Configuration Manager authenticates and authorizes the client by using the clients domain controller.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies a Configuration Manager client object. You can get a Configuration Manager client object by using the Get-CMBaseline cmdlet.
Type: | IResultObject |
Aliases: | Collection, Device |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of a Configuration Manager client.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SiteCode
Specifies the site code for the Configuration Manager site that hosts this site system role.
Type: | String |
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