New-CMTSStepJoinDomainWorkgroup

Reference

Module:: ConfigurationManager

Create a Join Domain or Workgroup step, which you can add to a task sequence.

Syntax

New-CMTSStepJoinDomainWorkgroup
   [-DomainName <String>]
   [-OU <String>]
   [-UserName <String>]
   [-UserPassword <SecureString>]
   [-WorkgroupName <String>]
   [-Condition <IResultObject[]>]
   [-ContinueOnError]
   [-Description <String>]
   [-Disable]
   -Name <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

This cmdlet creates a new Join Domain or Workgroup step object. Then use the Add-CMTaskSequenceStep cmdlet to add the step to a task sequence. For more information on this step, see About task sequence steps: Join Domain or Workgroup.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1

This example first uses the ConvertTo-SecureString built-in cmdlet to create a secure string for the user password. This method is used here as a simple example, but not the most secure since the plain text password is in the script. For more information on this cmdlet and other options, see ConvertTo-SecureString.

The next line creates an object for the Join Domain or Workgroup step, using the secure string password variable.

It then gets a task sequence object, and adds this new step to the task sequence at index 11.

$Secure_String_Pwd = ConvertTo-SecureString "P@ssW0rD!" -AsPlainText -Force

$step = New-CMTSStepJoinDomainWorkgroup -Name "Join Domain or Workgroup" -DomainName "na.corp.contoso.com" -OU "LDAP://OU=Ops,OU=ITS,DC=na,DC=corp,DC=contoso,DC=com" -UserName "contoso\_cmosdjoin" -UserPassword $Secure_String_Pwd

$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast

$tsOsd | Add-CMTaskSequenceStep -Step $step -InsertStepStartIndex 11

Parameters

-Condition

Specify a condition object to use with this step. To get this object, use one of the task sequence condition cmdlets. For example, Get-CMTSStepConditionVariable.

Type:	IResultObject[]
Aliases:	Conditions
Position:	Named
Default value:	None
Required:	False
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:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContinueOnError

Add this parameter to enable the step option Continue on error. When you enable this option, if the step fails, the task sequence continues.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Specify an optional description for this task sequence step.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Disable

Add this parameter to disable this task sequence step.

Type:	SwitchParameter
Aliases:	DisableThisStep
Position:	Named
Default value:	None
Required:	False
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

-DomainName

To configure this step to have the computer join a ___domain, use this parameter to specify the name of a ___domain to join. Then use the following other parameters:

DomainOU: Optionally specify an organizational unit in which to create the new computer account.
UserName: Specify the user account with permissions to join a computer to the ___domain.
UserPassword: Specify the password for the user account.

Type:	String
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

-Name

Specify a name for this step to identify it in the task sequence.

Type:	String
Aliases:	StepName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-OU

When you use the DomainName parameter, you can also specify the path to an organizational unit (OU). When the computer joins the ___domain, if it creates a new computer account, that account will be in this OU.

For example, LDAP://OU=MyOu,DC=MyDom,DC=MyCompany,DC=com

Type:	String
Aliases:	OrganizationalUnit
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserName

When you use the DomainName parameter, use this parameter to specify the ___domain user account that's used to add the destination computer to the ___domain. Use the UserPassword parameter to specify the account password.

For more information, see the task sequence ___domain joining account.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserPassword

Specify the password as a secure string for the UserName parameter.

Type:	SecureString
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:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkgroupName

To configure this step to have the computer join a workgroup, use this parameter to specify the workgroup name.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

IResultObject

Notes

For more information on this return object and its properties, see SMS_TaskSequence_JoinDomainWorkgroupAction server WMI class.

Share via