Skip to content

Commit fceda20

Browse files
authored
Merge pull request #8601 from Deland-Han/cmpy-branch-ci5171
AB#5171: Domain Join Log Collection Process Update
2 parents 46449bd + 4e803cb commit fceda20

1 file changed

Lines changed: 59 additions & 1 deletion

File tree

support/windows-server/active-directory/active-directory-domain-join-troubleshooting-guidance.md

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This guide provides the fundamental concepts used when troubleshooting Active Di
1616

1717
## Troubleshooting checklist
1818

19-
- Domain Name System (DNS): Anytime you have an issue joining a domain, one of the first things to check is DNS. DNS is the heart of Active Directory and makes things work correctly, including domain join. Make sure of the following items:
19+
- Domain Name System (DNS): Anytime you have an issue joining a domain, one of the first things to check is DNS. DNS is the heart of Active Directory (AD) and makes things work correctly, including domain join. Make sure of the following items:
2020

2121
- DNS server addresses are correct.
2222
- DNS suffix search order is correct if multiple DNS domains are in play.
@@ -344,3 +344,61 @@ For more information, see:
344344

345345
- Troubleshoot [Networking error messages and resolutions](troubleshoot-errors-join-computer-to-domain.md#networking-error-messages-and-resolutions)
346346
- Troubleshoot [Authentication error messages and resolutions](troubleshoot-errors-join-computer-to-domain.md#authentication-error-messages-and-resolutions)
347+
348+
## Data collections for domain join issues
349+
350+
To troubleshoot domain join issues, the following logs could help:
351+
352+
- Netsetup log
353+
This log file contains most information about domain join activities. The file is located on the client machine at `%windir%\debug\netsetup.log`.
354+
This log file is enabled by default. No need to explicitly enable it.
355+
356+
- Network trace
357+
The network trace contains the communication between the client computer and relative servers, such as DNS servers and domain controllers over the network. It should be collected at the client computer. Multiple tools can collect network traces, such as Wireshark, netsh.exe which is included in all Windows editions.
358+
359+
You can collect each log separately. Alternatively, you can use some tools provided by Microsoft to collect them all together. To do so, follow the steps in the following sections.
360+
361+
### Collect manually
362+
363+
1. Download and install Wireshark on the client computer that is to join the AD domain.
364+
2. Start the application with administrator privileges, and then start capturing.
365+
3. Try to join the AD domain to reproduce the error. Record the error message.
366+
4. Stop capturing in the app and save the network trace to a file.
367+
5. Collect the netsetup.log file that is located at *%windir%\debug\netsetup.log*.
368+
369+
### Use Auth Scripts
370+
371+
Auth Scripts is a lightweight PowerShell script developed by Microsoft to ease log collection for troubleshooting authentication-related issues. To use it, follow these steps:
372+
373+
1. Download [Auth Scripts](https://aka.ms/authscripts) on the client computer. Extract the files to a folder.
374+
2. Start a PowerShell window with administrator privileges. Switch to the folder containing those extracted files.
375+
3. Run *start-auth.ps1*, accept the EULA if prompted, and allow execution if warned about an untrusted publisher.
376+
377+
> [!NOTE]
378+
> If the scripts aren't allowed to run due to execution policies, see [about_Execution_Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies).
379+
380+
4. After the command completed successfully, try to join the AD domain to reproduce the error. Record the error message.
381+
5. Run *stop-auth.ps1*, and allow execution if warned about an untrusted publisher.
382+
6. Log files are saved in the *authlogs* subfolder, which includes the *Netsetup.log* log and the network trace file (Nettrace.etl).
383+
384+
### Use TSS Tool
385+
386+
TSS tool is another tool developed by Microsoft to ease log collection. To use it, follow these steps:
387+
388+
1. Download [TSS tool](https://aka.ms/gettss) on the client computer. Extract the files to a folder.
389+
2. Start a PowerShell window with administrator privileges. Switch to the folder containing those extracted files.
390+
3. Run the following command:
391+
392+
```console
393+
TSS.ps1 -scenario ADS_AUTH -noSDP -norecording -noxray -noupdate -accepteula -startnowait
394+
```
395+
396+
Accept the EULA if prompted, and allow execution if warned about an untrusted publisher.
397+
398+
> [!NOTE]
399+
> If the scripts aren't allowed to run due to execution policies, see [about_Execution_Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies).
400+
401+
4. The command takes a few minutes to complete. After the command completes successfully, try to join the AD domain to reproduce the error. Record the error message.
402+
5. Run `TSS.ps1 -stop`, and allow execution if warned about an untrusted publisher.
403+
6. Log files are saved in the *C:\MS_DATA* subfolder, and are zipped already. The ZIP filename follows the format of *TSS_\<hostname\>_\<date\>-\<time\>-ADS_AUTH.zip*.
404+
7. The zip file includes the *Netsetup.log*, and the network trace. The network trace file is named *\<hostname\>_\<date\>-\<time\>-Netsh_packetcapture.etl*.

0 commit comments

Comments
 (0)