PXE Everywhere Agent settings

Installer and configuration settings for the PXE Everywhere Agent client module of the 1E Client supported only on Windows computers.

1E Client is only available as a 64-bit version:

HKEY_LOCAL_MACHINE\SOFTWARE\1E\PXEEverywhere

Note

Registry settings:

Note

Installer properties:

Note

Configuration file settings:

Module.PXEEverywhere.Enabled

1E Client installers include a template configuration file that contains the more important settings with default values that match hard-coded default values. The configuration file is updated during installation and named 1E.Client.conf in the installation folder along with the 1E Client executable.

After installation, configuration file settings can be managed using 1E Client command-line parameters, Endpoint Troubleshooting configuration instructions, Endpoint Automation policies, Configuration Manager baselines or other means. Registry settings can also be managed by Windows Group Policy.

PXE Everywhere Agent installation settings

This table lists the configuration settings visible in the PXE Everywhere screen during an interactive installation of the 1E Client. Other installer properties are available when using a command-line installation or a transform.

Note

You must use UPPERCASE when specifying the name of any installer property in a mst transform file, and preferably when including them in a msiexec command-line.

Names of settings stored in the configuration file are not case-sensitive. Setting names stored in the registry may be case-sensitive and should be specified as shown.

Settings that have numeric values must be set using decimal integers, unless otherwise specified.

Installer property	Mandatory	Default value	Description
Module.PXEEverywhere.Enabled	No	false	Set this property to true to enable the PXE Everywhere Agent client module. The default value is false. Note If enabled, when the 1E Client starts it will attempt to automatically remove any previous installations of PXE Everywhere Agent. This setting does not have an associated registry entry and is stored in the 1E Client configuration file.
MODULE.PXEEVERYWHERE.CONFIGSERVERURL	Yes	http://SERVER/PXELite/PXELiteConfiguration.asmx	URL for the PXE Everywhere Central web service in the format: `http://SERVER/PXELite/PXELiteConfiguration.asmx` where `<SERVER>` is the name of the server (or FQDN) where the PXE Everywhere Central web service is installed. Note The http prefix to the URL is case-sensitive and must be entered in all lower case letters. The URL is not verified by the installer, so you will need to ensure that the correct URL is entered. This setting has an associated ConfigServerAddress registry value.
MODULE.PXEEVERYWHERE.USEFIPS	No	0	You must use the same FIPS encryption setting on all PXE Everywhere Agents. Use of FIPS compliant encryption for communications. 0 – use default encryption 1 – use FIPS encryption This setting has an associated EncryptionType registry value.
MODULE.PXEEVERYWHERE.DHCPPORT	No	67	This installer property is set to 2067 if Enable DHCP Snooping support is checked during an interactive installation of the 1E Client installer. This is the UDP port on which the PXE Everywhere Agent will listen for PXE requests. If DHCP Snooping is not being used, then this port must be 67 (default), and you do not need to install Responders. When manually installing the PXE Everywhere Agent, if the DHCP Snooping option is enabled in the installer UI, the default port is changed from 67 (43 hex) to 2067 (813 hex). If the MODULE.PXEEVERYWHERE.DHCPPORT installer property is used to specify a port other than 67, the installer UI assumes the DHCP Snooping option is enabled. If DHCP Snooping is being used, then DhcpPort on Agents must be the same value as AltPxeServerPort on Responders. The default value of AltPxeServerPort is 2067. If a value other than 2067 is specified as a custom port number on Agents, you will also need to manually create the AltPxeServerPort (and AltPxeClientPort) registry values on Responders. This setting has an associated DhcpPort registry value.

PXE Everywhere Agent registry settings

This table lists all registry setting and their associated installer properties.

Note

You must use UPPERCASE when specifying the name of any installer property in a mst transform file, and preferably when including them in a msiexec command-line.

Names of settings stored in the configuration file are not case-sensitive. Setting names stored in the registry may be case-sensitive and should be specified as shown.

Settings that have numeric values must be set using decimal integers, unless otherwise specified.

Registry name	Registry type	Installer property	Mandatory	Default value	Description
AlwaysBootImageId	REG_SZ	This value does not have an installer property.	No	Registry value is not created.	A string value containing a valid package id of a boot image. If specified, do not get boot image ID from PXE Everywhere Central but use this one instead.
AlwaysIsMandatory	REG_DWORD	This value does not have an installer property.	No	Registry value is not created.	Whether the boot image is mandatory (value 1) or not (0). Only relevant in combination with `AlwaysBootImageId`.
BindTo	REG_SZ	This value does not have an installer property.	No	Registry value is not created.	Comma-separated list of IP addresses which PXE Everywhere Agent listens for DHCP (PXE) and TFTP requests. If not present, PXE Everywhere Local listens on all IP addresses. Use this if there is more than one network interface.
CommsPort	REG_DWORD	MODULE.PXEEVERYWHERE.COMMSPORT	No	2012	Used for UDP election broadcast messages, this must be opened in the Windows firewall.
ConfigServerAddress	REG_SZ	MODULE.PXEEVERYWHERE.CONFIGSERVERURL	Yes	http://SERVER/PXELite/PXELiteConfiguration.asmx	URL for the PXE Everywhere Central web service in the format: `http://SERVER/PXELite/PXELiteConfiguration.asmx` where `<SERVER>` is the name of the server (or FQDN) where the PXE Everywhere Central web service is installed. Note The http prefix to the URL is case-sensitive and must be entered in all lower case letters. The URL is not verified by the installer, so you will need to ensure that the correct URL is entered.
Debug	REG_DWORD	MODULE.PXEEVERYWHERE.DEBUG	No	1	The debug level. Leave this at `1` unless 1E Support recommends a change. The range is: `0x1`: Basic logging `0x4`: Extra "application-specific" logging `0x8`: Extra registry logging `0x10`: Increased general logging The following two bits will perform centralized logging via SOAP calls to the PXE Central Server: `0x1000`: Logs election results `0x2000`: Logs TFTP file transfer start and stop (includes statistics).
DefaultBlockSize	REG_DWORD	This value does not have an installer property.	No	Registry value is not created.	Default TFTP block size. 512 if not specified.
DhcpPort	REG_DWORD	MODULE.PXEEVERYWHERE.DHCPPORT	No	67	This is the UDP port on which the PXE Everywhere Agent will listen for PXE requests. If DHCP Snooping is not being used, then this port must be 67 (default), and you do not need to install Responders. When manually installing the PXE Everywhere Agent, if the DHCP Snooping option is enabled in the installer UI, the default port is changed from 67 (43 hex) to 2067 (813 hex). If the MODULE.PXEEVERYWHERE.DHCPPORT installer property is used to specify a port other than 67, the installer UI assumes the DHCP Snooping option is enabled. If DHCP Snooping is being used, then DhcpPort on Agents must be the same value as AltPxeServerPort on Responders. The default value of AltPxeServerPort is 2067. If a value other than 2067 is specified as a custom port number on Agents, you will also need to manually create the AltPxeServerPort (and AltPxeClientPort) registry values on Responders.
ElectionWaitSecs	REG_DWORD	MODULE.PXEEVERYWHERE.ELECTIONWAITSECS	No	1	Time (in seconds) to wait for responses to the election request before broadcasting the result. Can be any positive integer value above 0.
ElectionWeight	REG_DWORD	MODULE.PXEEVERYWHERE.ELECTIONWEIGHT	No	50	When set, this manually created registry value determines the likelihood of the machine winning elections, all else being equal. The value must be between 0 and 99 inclusive. The higher the value the the higher the likelihood of winning. If no value is set, a default of 50 is used.
EncryptionType	REG_DWORD	MODULE.PXEEVERYWHERE.USEFIPS	No	0	You must use the same FIPS encryption setting on all PXE Everywhere Agents.Use of FIPS compliant encryption for communications. 0 – use default encryption 1 – use FIPS encryption
Flags	REG_DWORD	This value does not have an installer property.	No	Registry value is not created.	If set to `1` the DHCP listener adds an ASCII terminator character to the bootfile name in the DHCP acknowledgment message. Some HP machines require this. Any value other than 1 is treated as default 0.acknowledgment
IgnoreGatewayAddress	REG_DWORD	This value does not have an installer property.	No	Registry value is not created.	If set to any value other than `0` the DHCP listener ignores the gateway address. If not set then assumes default `0` .
IgnoreWireless	REG_DWORD	This value does not have an installer property.	No	0	If set to 1 then PXE Everywhere Agent does not bind on wireless adapters. Any value other than 1 is treated as default 0.
LogFileName	REG_SZ	MODULE.PXEEVERYWHERE.LOGPATH Note This property only specifies the location of the log file.	No	%ALLUSERSPROFILE%\1E\PXEEverywhere PXEEverywhere.log	The location of the PXE Everywhere log file. The path is created if it does not exist. The logfile name is `PXEEverywhere.log`
LogFormat	REG_DWORD	MODULE.PXEEVERYWHERE.LOGFORMAT	No	1	Formatting depends on which bits are set: bit `0 (0x01)` use Configuration Manager-compatible format (default) bit `3 (0x08)` do no formatting bit `7 (0x80)` include milliseconds in the timestamp
MaxBlockSize	REG_DWORD	Note This value does not have an installer property, but is configurable when deployed using 1E Client Deployment Assistant. Please refer to Installing PXE Everywhere Agents: Preparing a Configuration Manager Application for PXE Everywhere Agent using the 1E Client Deployment Assistant.	No	Registry value is not created.	Maximum value for the block size (in bytes). PXE Everywhere uses the system MTU to derive the size of TFTP packets. May require limiting when using VPN tunnels. In most cases, this value should not be altered. Default is 8192 (8 kbytes). Note The actual block size used for the TFTP protocol is the lesser value of the tftpBlockSize and the MaxBlockSize registry values. The tftpBlockSize value is specified in the CreateBCD.exe utility command-line, and does not have a registry entry or installer property.
MaxLogFilesize	REG_DWORD	MODULE.PXEEVERYWHERE.MAXLOGFILESIZE	No	10485760	Maximum size for the log file in bytes. Once the file reaches the specified size, a copy is made with a `.lo_` extension in the same directory. A new log file will then be created. Default is 10485760 (10 MBytes).
Mode	REG_DWORD	MODULE.PXEEVERYWHERE.MODE	No	2	Mode must be one of the following: 0 – no elections 1 – the election instigator becomes the master (only to be used for testing) 2 – with elections (default)
ReserveSecs	REG_DWORD	MODULE.PXEEVERYWHERE.RESERVESECS	No	60	Time (in seconds) an election result remains active. 60 if not specified or 0 is specified. Can be any positive integer value.
SessionTimeoutSecs	REG_DWORD	This value does not have an installer property.	No	Registry value is not created.	Timeout for the TFTP listener. 600 if not specified or 0 is specified. Can be any positive integer value.
TftpRoot	REG_SZ	MODULE.PXEEVERYWHERE.TFTPROOT	No	`%ALLUSERSPROFILE%\1E\PXEEverywhere\TftpRoot`	Location for the PXE Everywhere Agent `TFTPROOT` directory. If you change the location of `TFTPROOT,` you need to change the location that you copy the additional PXE boot files to.