Export (0) Print
Expand All
Expand Minimize

Install-CMClient

Updated: February 7, 2014

Applies To: System Center 2012 R2 Configuration Manager

Install-CMClient

Installs a Configuration Manager client.

Syntax

Parameter Set: SearchByNameMandatory
Install-CMClient -AlwaysInstallClient <Boolean> -ForceReinstall <Boolean> -IncludeDomainController <Boolean> -Name <String> -SiteCode <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByDeviceIdMandatory
Install-CMClient -AlwaysInstallClient <Boolean> -DeviceId <String> -ForceReinstall <Boolean> -IncludeDomainController <Boolean> -SiteCode <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByDeviceNameMandatory
Install-CMClient -AlwaysInstallClient <Boolean> -DeviceName <String> -ForceReinstall <Boolean> -IncludeDomainController <Boolean> -SiteCode <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByDeviceValueMandatory
Install-CMClient -AlwaysInstallClient <Boolean> -Device <IResultObject> -ForceReinstall <Boolean> -IncludeDomainController <Boolean> -SiteCode <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByIdMandatory
Install-CMClient -AlwaysInstallClient <Boolean> -CollectionId <String> -ForceReinstall <Boolean> -IncludeDomainController <Boolean> -SiteCode <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByValueMandatory
Install-CMClient -AlwaysInstallClient <Boolean> -ForceReinstall <Boolean> -IncludeDomainController <Boolean> -InputObject <IResultObject> -SiteCode <String> [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Install-CMClient cmdlet installs a client for Microsoft System Center 2012 Configuration Manager.

Parameters

-AlwaysInstallClient<Boolean>

Indicates whether Configuration Manager always installs the client.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-CollectionId<String>

Specifies the ID of the collection to which the client belongs.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Device<IResultObject>

Specifies a Configuration Manager device object. You can get a Configuration Manager device object by using the Get-CMDevice cmdlet.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeviceId<String>

Specifies the ID for the device to which Configuration Manager installs the client.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeviceName<String>

Specifies the name of the device to which Configuration Manager installs the client.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ForceReinstall<Boolean>

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-IncludeDomainController<Boolean>

Indicates whether Configuration Manager authenticates and authorizes the client by using the clients domain controller.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<IResultObject>

Specifies a Configuration Manager client object. You can get a Configuration Manager client object by using the Get-Client cmdlet.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a Configuration Manager client.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SiteCode<String>

Specifies the site code for the Configuration Manager site that hosts this site system role.


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: Install a client

This command installs the client named RemoteClient05 on the Configuration Manager site that has the site code CM1.


PS C:\> Install-CMClient -Name "RemoteClient05" -SiteCode "CM1" -AlwaysInstallClient $True -IncludeDomainController $True

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft