Join Domain

Joins the computer to an Active Directory domain.

Parameters

Domain User Name

Required

Domain account with permission to join the computer to domain. Ex. CONTOSO\Administrator

Password

Required

Password for the domain account.

Domain Name

Required

Fully qualified domain name to join. Ex. contoso.local

Preferred Domain Controller

Required

Preferred domain controller FQDN used for the domain join. Ex. dc01.contoso.local

OU Path

Optional

Optional LDAP OU path for the computer object. Ex. OU=Computers,DC=contoso,DC=local

Allow Reboot

Optional — Default: True

Enable to reboot the workstation after successful domain join. Disable to continue without rebooting.

Allow Rejoin Domain

Optional — Default: False

Enable to unjoin the computer from the current domain before joining the target domain. Disable to skip the unjoin step. Remember to delete any computer object with the same name in the domain before rejoining.

Ping DC Retry Later

Optional — Default: False

Enable to ping the preferred domain controller before join and return retry later when unreachable. Disable to skip the connectivity pre-check.

Details

• Category: Provisioning
• Brick ID: AD-JoinDomain

Raw JSON definition

• JSON

{
  "category": "provisioning",
  "description": "Joins the computer to an Active Directory domain.",
  "developerVendor": "CapaSystems A/S",
  "displayName": null,
  "id": "AD-JoinDomain",
  "name": "Join Domain",
  "parameters": [
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Domain account with permission to join the computer to domain. Ex. CONTOSO\\Administrator",
      "id": "UserName",
      "name": "Domain User Name",
      "regExValidation": "",
      "required": true,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Password for the domain account.",
      "id": "Base64Password",
      "name": "Password",
      "regExValidation": "",
      "required": true,
      "type": "TextBoxWithPassword",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Fully qualified domain name to join. Ex. contoso.local",
      "id": "DomainName",
      "name": "Domain Name",
      "regExValidation": "",
      "required": true,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Preferred domain controller FQDN used for the domain join. Ex. dc01.contoso.local",
      "id": "PerferredDC",
      "name": "Preferred Domain Controller",
      "regExValidation": "",
      "required": true,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Optional LDAP OU path for the computer object. Ex. OU=Computers,DC=contoso,DC=local",
      "id": "OUPath",
      "name": "OU Path",
      "regExValidation": "",
      "required": false,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "True",
      "defaultValueObject": null,
      "description": "Enable to reboot the workstation after successful domain join. Disable to continue without rebooting.",
      "id": "AllowReboot",
      "name": "Allow Reboot",
      "regExValidation": "",
      "required": false,
      "type": "Boolean",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "False",
      "defaultValueObject": null,
      "description": "Enable to unjoin the computer from the current domain before joining the target domain. Disable to skip the unjoin step. Remember to delete any computer object with the same name in the domain before rejoining.",
      "id": "AllowRejoinDomain",
      "name": "Allow Rejoin Domain",
      "regExValidation": "",
      "required": false,
      "type": "Boolean",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "False",
      "defaultValueObject": null,
      "description": "Enable to ping the preferred domain controller before join and return retry later when unreachable. Disable to skip the connectivity pre-check.",
      "id": "PingDCRetryLater",
      "name": "Ping DC Retry Later",
      "regExValidation": "",
      "required": false,
      "type": "Boolean",
      "value": null,
      "values": [],
      "valuesObject": null
    }
  ],
  "powershell": {
    "base64Encoded": true,
    "function": "ZnVuY3Rpb2..."
  },
  "type": "powerbrick",
  "version": "2026.7.2.1"
}