How to use the PXE troubleshooting tool?

In OS Deployer, PXE booting is essential for image deployment to multiple computers and offline image creation. The PXE troubleshooting tool helps users to resolve issues that hinder the seamless functioning of the PXE booting process.

The tool inspects,

  • If any service/application is interfering with the PXE service
  • If the PXE media is published, and
  • The DHCP configurations required for PXE boot

In this document, we will discuss:

  1. How to configure/troubleshoot the Windows DHCP Server?
  2. How to perform PXE troubleshooting?

How to configure/troubleshoot the Windows DHCP Server?

Note: This tool should be run on machines with the following Windows operating systems: Windows 8 and above and Windows Server 2012 and above.

Pre-requisites

  • Ensure that the PXE media is already published.
  • RPC (Remote Procedure Call) must be enabled on the machine where the DHCP Server is running, if the tool is running on a remote machine.

Steps

  1. Download and extract the PXETroubleshootingTool.zip.
    Note :The SHA256 checksum value is 9f50ad43415652c0034eee0152b0fcf9a830a2a12a1f4db8b36b9045ec18c599
  2. Run PXETroubleshootingtool.exe on any machine on the network.
  3. You can either select the DHCP server's IP address from the tool or you can enter the DHCP Server's IP address manually. Then enter the username and password of the DHCP administrator.
  4. The username must be given in the format Domain\username. For example zylker\john12
  5. Click the troubleshoot/configure button. All the available scopes under that DHCP Server will be listed. Ensure that both the PXE Server IP Address and Boot Configuration for the scopes listed are correct.
    • The Scopes retrieved from the DHCP Server are classified into 3 types.
    • Fully Configured - All configurations of that scope matched with the PXE Server configuration.
    • Partially Configured - Some configurations of that scope matches with the PXE Server configuration.
    • Not Configured - No configuration of that scope matches with the PXE Server Configuration.
  6. If it fails, make sure the credentials are correct and DHCP Server is reachable from the Remote Machine (the machine where the tool is running). Click this link to resolve RPC Related issues on the DHCP Server machine.
  7. Click Configure for any scope to update the boot configuration and PXE Server IP address of that particular scope if necessary.

How to perform PXE troubleshooting?

  1. Download and extract the PXETroubleshootingTool.zip.
    Note :The SHA256 checksum value is 9f50ad43415652c0034eee0152b0fcf9a830a2a12a1f4db8b36b9045ec18c599
  2. Run PXETroubleshootingtool.exe on the machine where the Central Server/Distribution server is installed.
  3. If the Central Server/Distribution server is detected, the Troubleshoot button will be shown. Click the Troubleshoot button.
  4. You will be shown the summary of PXE-related services and their status.

Summary and Resolution

PXE Server Status

  1. If it's failed, ensure that the PXE service is running on the machine.
  2. Navigate to Start → Run → services.msc and double-click the service ManageEngine OS Deployer PXE Server. If the service is not running, click Start.

If the PXE service is not running, you can try manually restarting the service or check if it is overridden by any other service. To restart the PXE service, follow the steps given below:

  1. Open command prompt in the path C:\Program Files (x86)\ZohoCorp\OSDPXEComponent\PXEService\bin for remote offices. For local offices use the path \bin
  2. Run osd-tftp.bat -p to stop the PXE service
  3. Run osd-tftp.bat -r to remove the PXE service
  4. Run osd-tftp.bat -i to install PXE service
  5. Run osd-tftp.bat -t to start the PXE service

If the service is still not running, verify if any other PXE service is running in port 69.

Note: PXE service by default runs on port 69, which might result in a conflict of services.

  1. To verify, run the following command in Command Prompt,

    netstat -naop UDP | findStr "69" 

  2. You will receive a response with the PID in the far right. 

    UDP     0.0.0.0:<portnumber>     *:*     <PID>

    Example:UDP     0.0.0.0:69     *:*     11235

  3. Go to Task Manager -->Services tab and search for the PID under PID tab.
  4. If any other PXE service (eg., WDS PXE) is running in that port, stop/uninstall the service. And start ManageEngine OS Deployer PXE service.

Antivirus Status

  1. If any antivirus is detected, ensure that the antivirus is not blocking the Manage Engine OS Deployer - PXE Server Service and Central Server/Distribution Server.
  2. Also, check if the antivirus doesn't block UDP ports 69 and 4011.

Firewall Status

  1. If it's failed with the remark "No firewall rule is added to allow the PXE Service", follow the steps given below
    • Navigate to Start -> Control panel -> Windows defender firewall.
    • Add inbound & outbound rules in the firewall to allow traffic to ports 69 and 4011.
    • To allow traffic, navigate to Advanced Settings ->Inbound/ Outbound rules -> New Rule.
    • Under Rule type, select the Port option.
    • Select UDP Protocol, feed in port numbers 69 and 4011 under Specific local/remote ports option.
    • Select Allow the connection.
    • Specify a name for the inbound/outbound rule and click Finish.
  2. If it's failed with the remark "PXE Service Blocked by Firewall", double-click the remark to view the rules that block the PXE Service. Exclude the blocked ports (69, 4011) on that rule for PXE Service to transfer data.

PXE Media Status

If failed, ensure that the PXE Media is created and published successfully for that remote office in the web console. To publish the created WinPE media in the PXE server, Click on Action against the media to be published and select Publish PXE media. This will lead you to the list of remote office(s). Now, if you want to publish and use this media in your remote offices, select the remote office(s) and click on the Publish Media button.