Sysprep_JoinDomain

VB Scripting Library > OSD Scripting Library > Sysprep functions (OSD)

Sysprep_JoinDomain(sDomainName,sDomainAdmin,sPassword,sMachineObjectOU)

Adds information to unattend file about which domain the computer should join.

Arguments

ARGUMENT	DESCRIPTION	TYPE
sDomainName	Name of the domain to join	String
sDomainAdmin	Account name in the target domain, that has the privileges to add a computer to the domain	String
sPassword	Password for the user	String
sMachineObjectOU	Optional string for specifying the target Active Directory Organizational Unit (OU) where the computer object is to be created. If no OU, a blank string must be specified	String

Return Type

Boolean, TRUE if function completed successfully.

Affected unattend sections

UNATTEND FILE	COMPONENT PATH / SECTION	SETTINGS PASS
Unattend.xml	Microsoft-Windows-UnattendedJoin	Specialize
Sysprep.inf	Identification	N/A

Remarks

Typically used in the PreBootScript.wsf

The function registers the password with Log_RegisterExcludeValue, so it’s removed from the files that Log_SubmitLogs uploads.
Any workgroup setting in the unattend file is removed.
In unattend.xml, the Microsoft-Windows-UnattendedJoin component must exist in the specialize pass.

Example

The following example will join the computer to the domain “mydomain.local” using the “CapaJoin” account. The Computer object will be created in the “Test Computers OU”.

VBScript

Private Function IncludeScript(sScriptFile)
 '...
End Function

'Begin
  bStatus=True
  If bStatus Then bStatus=IncludeScript("customlib.cis")
  If bStatus Then bStatus=IncludeLibrary("Capalib.cin")
  If bStatus Then bStatus=IncludeLibrary("Osdlib.cin")
  If bStatus Then bStatus=Job_Start("WS","Script Name","1.0","ScriptName.log","INSTALL")
  If bStatus Then bStatus=OSD_Initialize()

  If bStatus Then bStatus=Sysprep_JoinDomain("mydomain.local","capajoin","MySecretPassword","OU=Test Computers OU,DC=mydomain,DC=local")

  Job_End(bStatus)
'End main