iPXE Web Service Configuration File
The iPXE Anywhere Web Service configuration file is used to configure global settings for the iPXE Anywhere Web server. The config file (iPXEAnywhere.Service.exe.config) is located within in the program files directory in which the service was installed. The settings below are located within the <appSettings> section of the file:
Note: Not all values in the iPXEAnywhere.Service.exe.config file are documented here. Please contact 2Pint Support prior to making changes to undocumented settings.
You must restart the "2Pint Software iPXE Anywhere Web Service" service for the changes in the configuration file to take effect. In general, numerical value 0 = False and 1 = True. Individual values are to be considered default.
General Settings
Setting Key Value Name | Values and Descriptions |
---|---|
ApprovedDevicesRequestLimit | Value: 604800 Description: The amount of seconds from the approved date in which a record in the database is valid. This setting can also be overruled in DeviceAuthentication.ps1 script. |
AutoApproveDevices | Value: 0 (default) or 1 Description: |
CertificatesPath | Value: %PROGRAMDATA%\2Pint Software\2PXE\Certificates Description: |
DebugLogPath | Value: %PROGRAMDATA%\2Pint Software\iPXEWS\iPXEWS.log Description: The path of the debug log file when debug logging is enabled. Ensure that the service account has access to the path if no log is appearing. |
EnableDebugLog | Value: 0 (default) or 1 Description: Enables debugging. This log will be fairly verbose, so remember to set it to "0" to switch it off afterwards. Errors and warnings will always be logged to the event log. See the DebugLogPath setting for the location of the debug log file. |
EnableSyslogServer | Value: 0 or 1 (default) Description: |
EncryptionKey | Value: <A32ByteString> Description: Used to encrypt the requests in case of server restarts or clustered/load balanced multi server installs. This has to translate to 32-bytes from a UTF8 conversion. |
HostCertificateThumbprint | Value: <thumbprint> Description: The thumbprint of the self-signed certificate issued by 2PintSoftware.com |
LicenseKey | Value: <iPXEWSLicenseKey> Description: The iPXE AnyWhere Web Service license key. |
RunAdminOnHttpPort | Value: 8052 Description: |
RunonHttpPort | Value: 8051 Description: |
RunonHttps | Value: 0 or 1 Description: |
StifleRURL | Value: <URL to StifleR web service> Description: |
Scripts Called from Authentication Requests
Setting Key Value Name | Values and Descriptions |
---|---|
DeviceAuthenticationScript | Value: Scripts\Authentication\DeviceAuthentication.ps1 Description: |
UserAuthenticationScript | Value: Scripts\Authentication\UserAuthentication.ps1 Description: |
Scripts Called from a Boot Request
Setting Key Value Name | Values and Descriptions |
---|---|
iPXEStartScript | Value: Scripts\Boot\iPXEboot.ps1 Description: |
Scripts Called from an Ongoing Boot
Setting Key Value Name | Values and Descriptions |
---|---|
iPXEConfigScript | Value: Scripts\config\iPXEconfig.ps1 Description: |
iPXEConfigInjectFileScript | Value: Scripts\config\iPXEinjectfile.ps1 Description: |
WinPEShlScript | Value: Scripts\config\WinPEShl.ps1 Description: |
Scripts Called from WinPE
Setting Key Value Name | Values and Descriptions |
---|---|
WinPEStartScript | Value: Scripts\config\WinPEStart.ps1 Description: |
WinPEEndScript | Value: Scripts\config\WinPEEnd.ps1 Description: |
Scripts Called from WinPE When a Deployment Fails / Completes
Setting Key Value Name | Values and Descriptions |
---|---|
FailureLogsScript | Value: Scripts\Logs\FailureLogsScript.ps1 Description: |
SuccessLogsScript | Value: Scripts\Logs\SuccessLogsScript.ps1 Description: |
Last updated