PXE Everywhere tools
Reference for command-line options used by 1E tools. These tools are used for Preparing and deploying 1E PXE Everywhere boot images.
1E tool | Where to find it | What it does |
|---|---|---|
Included in the PXE Everywhere Admin Tools. The PXE Everywhere Admin tools can be installed using the PXE Everywhere Central installer, on any computer that has the Configuration Manager Admin Console. Please refer to Installing PXE Everywhere Central. The PXE Everywhere Central installer is provided in the PXE Everywhere download zip available from the Nomad download area of the 1E Support Portal. | This tool is used to update Windows PE boot images for use with PXE Everywhere. It uses the native Configuration Manager API to add a certificate, and update the variables.dat file included in the image. When the PXE client loads the boot image, the Configuration Manager executables load the encrypted variables file and attempt to connect to the specified Management Point. The tool takes advantage of a boot image reload feature introduced in Configuration Manager 1706 CB, which enables you reload the latest version of Windows PE (from the Windows ADK installation directory) into the boot image when you run the Update Distribution Points wizard. NoteWhenever you reload the boot image while running the Update Distribution Points wizard, for example to replace a certificate that is about to expire, you must then re-run UpdateBootImage.exe to ensure the 1E components and settings are installed in the reloaded boot image. NoteTo include a client certificate, it must be provided as a PFX file in a Public Key Certificate Standard (PKCS #12) format, with private key exportable, and a known password. For details of CM certificates please refer to Boot images for deploying operating systems in PKI certificate requirements for System Center Configuration Manager ( https://docs.microsoft.com/en-us/mem/configmgr/core/plan-design/network/pki-certificate-requirements. | |
UpdateBootImageGUI | Included in the PXE Everywhere download zip with the installers for PXE Everywhere Central and Responder. NoteUse v1.0.0.6 with PXE Everywhere 4.0 | This tool provides a GUI where a user defines the parameters required by the UpdateBootImage tool. When executed it copies a command-line to the clipboard, which you then copy into an elevated command prompt and execute it. The tool is provided to reduce the chance of errors when typing in the long command-line required by the UpdateBootImage tool. The executable name is 1E.PS.UpdateBootImageGUI.exe and requires .NET Framework 4.5 or later. |
Included in the installation of 1E Client with PXE Everywhere enabled. | This tool is run by a Stage boot image Task Sequence on PXE Everywhere Agents to copy the 1E PXE Everywhere boot image referenced by the Task Sequence to the Images folder in the Agent's TFTPTOOT, configure a suitable TFTP Block Size, and create a boot configuration database on the Agent. CreateBCD only works within the context of a Configuration Manager task sequence. It will run outside a Task Sequence but have no effect. WarningCreateBCD does not validate the boot image - it will not detect a corrupt .wim file. |
UpdateBootImage
This tool is used to update Windows PE boot images for use with PXE Everywhere. It uses the native Configuration Manager API to add a certificate, and update the variables.dat file included in the image. When the PXE client loads the boot image, the Configuration Manager executables load the encrypted variables file and attempt to connect to the specified Management Point.
The format of the command-line is as follows:
UpdateBootImage.exe [-parameter=value]
The following table shows command-line parameters and their description.
Parameter | Required / Optional | Description |
|---|---|---|
BootImageID | Required | The package ID of the PXE Everywhere boot image, as created above. |
CertExpiry | Optional | Used to define the Certificate expiration in days, Default = 365 ( 1 Year ), minimum of 1 day is enforced. NoteCertExpiry is only needed for self-signed certificates. It is not needed for PKI certificates. |
CertPassword | Required (HTTPS only) | The password used when the .PFX file was exported earlier from the MP, so that it can be imported into the boot image. Only required if using the HTTPS protocol. |
CertPath | Required (HTTPS only) | The full path of the .PFX file exported earlier, so that it can be imported into the boot image. Only required if using the HTTPS protocol. |
DistributionPoints | Required | A distribution point where the newly created PXE boot image has been distributed. The FQDN of the distribution point can be used and this must match the Server Name used to create the Site System Server. |
ManagementPoints | Required | This parameter is used to create boot media that span multiple sites/management points. This should be set to a list of FQDN for all possible management points separated by the * character. This parameter is required for creating PXE Everywhere boot media in Configuration Manager. For single Primary Site environments, use the static based media option, SMSTSMP, for example: -ManagementPoints=SMSTSMP=http://mp.contoso.com For multi-site hierarchies, use the dynamic media option, SMSTSLocationMPs and specify at least one MP from each site, for example: -ManagementPoints=SMSTSLocationMPs=
http://site1MP.consoto.com*
http://site2MP.contoso.com |
MediaPassword | Optional | The password applied to protect the media – recommended if deploying to Unknown Computers. |
ProviderName | Required | Usually the name of the Configuration Manager server that hosts the "SMS Provider" role. |
SiteCode | Required | Configuration Manager site code. |
WIMFileName | Required | The filename of the boot WIM that you created above. |
CreateBCD
This tool is run by a Stage boot image Task Sequence on PXE Everywhere Agents to copy the 1E PXE Everywhere boot image referenced by the Task Sequence to the Images folder in the Agent's TFTPTOOT, configure a suitable TFTP Block Size, and create a boot configuration database on the Agent.
CreateBCD only works within the context of a Configuration Manager task sequence. It will run outside a Task Sequence but have no effect.
The format of the the command-line is as follows:
CreateBCD.exe [-parameter=value]
The following table shows command-line parameters and their description.
Option | Required / Optional | Description |
|---|---|---|
-tftpBlocksize=blocksize | Optional | Sets the RAMDisk tftp blocksize in bytes. |
TFTP Block Size
Some hardware may not support block size values higher than 16384 bytes and hence may fail to PXE boot. We recommend you use a TFTP block size of 8192 bytes for best results.
An known issue has been observed on some Cisco switches when DHCP Snooping is enabled and a block size greater than 1471 is used. The issue is referenced in the following two Cisco bug reports. If you are affected by this Cisco issue, change the tftpBlockSize to 1471 or lower.
https://quickview.cloudapps.cisco.com/quickview/bug/CSCvk53444.
https://quickview.cloudapps.cisco.com/quickview/bug/CSCtw63707
The issue may also be present in TP-Link switches.
The actual block size used for the tftp protocol is the lesser value of the tftpBlockSize and the MaxBlockSize registry values. Effectively, MaxBlockSize limits the tftpBlockSize specified in the CreateBCD.exe utility.
There is only one command-line switch for CreateBCD.exe which is used to set the tftpBlockSize for the RAMDisk (boot image). The notation for this is CreateBCD.exe -tftpBlocksize=blocksize where blocksize is measured in bytes.