> For the complete documentation index, see [llms.txt](https://documentation.2pintsoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.2pintsoftware.com/ipxe-ws/4.0/configuration/integrating-with-2pxe-server.md).

# Integrating with 2PXE Server

{% hint style="danger" %}
**Configuration Manager compatibility**

The integration between 2PXE Server 4.0 and iPXE Anywhere Web Service described on this page is supported. However, native Microsoft Configuration Manager (ConfigMgr/SCCM) PXE integration is not currently supported by 2PXE Server 4.0. The Configuration Manager collection example below is a custom PowerShell workflow, not native ConfigMgr PXE integration.
{% endhint %}

2PXE Server sends requests to the iPXE Anywhere Web Service while devices boot. The integration is turned on and configured on the 2PXE Server, in the **iPXE Anywhere Web Service settings** section of the **Configure 2PXE** configuration editor. Full details of these settings are in the 2PXE Server 4.0 documentation.

| 2PXE setting                                                                             | Description                                                                                                                                                                                                                                                                |
| ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Integrate with iPXE Anywhere Web Service** (`IntegrateWithiPXEAnywhereWebService`)     | Turns on integration with the iPXE Anywhere Web Service. The other settings are only shown when this is turned on.                                                                                                                                                         |
| **iPXE Anywhere Web Service URI** (`iPXEAnywhereWebServiceURI`)                          | The address and port of the web service, for example `https://server.contoso.com:8051`. Use the server's FQDN, and the port set in the web service's **Run on HTTP port** setting (`8051` by default). With HTTPS, the host name must match the web service's certificate. |
| **iPXE Anywhere Web Service IP address** (`IPXEAnywhereWebServiceIP`)                    | The IP address of the web service. If empty, 2PXE resolves the host name in the URI.                                                                                                                                                                                       |
| **Enabled iPXE Anywhere Web Service features** (`EnablediPXEAnywhereWebServiceFeatures`) | The requests that 2PXE sends to the web service. See the table below.                                                                                                                                                                                                      |

Each feature that 2PXE sends is handled by the web service, in most cases by running one of the scripts configured in **Configure iPXE WS**:

| Feature                                                                                                 | What the web service does                                                                                                      |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| **BootRequest**                                                                                         | Handles the main boot request, and returns the iPXE script from the **iPXE start script**. Required when using authentication. |
| **ReportBootConfiguration**, **ReportDLStart**, **ReportDLComplete**, **ReportDLBoot**, **ReportPEEnd** | Records the progress of each boot in the database, for reporting.                                                              |
| **Config**                                                                                              | Returns configuration for the device from the **iPXE config script**.                                                          |
| **ExtraFile**                                                                                           | Returns extra files to inject into the boot image from the **iPXE config inject file script**.                                 |
| **WinPEShl**                                                                                            | Returns WinPEShl.ini content from the **WinPeShl script**.                                                                     |
| **RunCmdLineWinPE**                                                                                     | Returns commands to run when WinPE starts from the **WinPeStart script**.                                                      |
| **RunCmdLineWinPEEnd**                                                                                  | Returns commands to run at the end of WinPE from the **WinPeEnd script**.                                                      |

The 2PXE default is `BootRequest`, `ReportBootConfiguration`, `ReportDLStart`, `ReportDLComplete`, `ReportDLBoot`, `Config` and `ReportPEEnd`.

{% hint style="info" %}
After changing these settings, save the configuration in **Configure 2PXE** and restart the 2PXE service when prompted.
{% endhint %}

## Integration modes

The features that you enable in 2PXE determine how the web service is used. There are two main modes.

### Reporting only mode

To only collect status during the boot process, enable the reporting features (**ReportBootConfiguration**, **ReportDLStart**, **ReportDLComplete**, **ReportDLBoot** and **ReportPEEnd**) without **BootRequest**. There is nothing else to configure. Events such as download start, download end, errors and success are forwarded to the iPXE Anywhere Web Service database, and are then visible in the iPXE Anywhere reports.

*Note: It is also possible to create your own custom status events. See the iPXE Anywhere Scripting Guide for more information.*

#### The iPXE Anywhere reports

There are three basic reports for the iPXE Anywhere Web Service, which can be downloaded from GitHub (see Install iPXE Anywhere Reports). The iPXE Anywhere database also includes SQL views, which are designed to make it easy for users to create their own reports.

Once installed, the reports can be accessed from the SSRS web page. Navigate to **2Pint Software\iPXE Anywhere** to see the three reports, which are described below.

![](https://content.gitbook.com/content/oPMTFuBb6yV8Wq1KUzxo/blobs/J9fgVOGProSj2Xmazad3/10.png)

**IPA\_One\_Hour\_Summary**

This report updates every 60 seconds, and gives you an almost live display of the current state of boot requests.

![](https://content.gitbook.com/content/oPMTFuBb6yV8Wq1KUzxo/blobs/XFnXpO3muwAKD16rgVQV/11.png)

The **Current Health** indicator changes color as the success rate of boot requests increases or decreases. This is a top-level indicator to allow deeper investigation should the boot request statistics deteriorate for some reason.

Below the indicator is the main chart, which details the statistics for boot requests for the previous 60 minutes. There are seven status levels for a boot request, and as systems progress through the boot process, these statistics update.

Below the main chart is a table detailing any issues reported for the last 60 minutes.

**IPA\_Main\_Dashboard**

This report provides more of a management overview of performance over the previous six months. You can see trends, success rates and timings for all boot requests here.

![](https://content.gitbook.com/content/oPMTFuBb6yV8Wq1KUzxo/blobs/pzp2HNXl62yu7w7ZSF84/12.png)

**IPA\_Hardware**

This report provides a high-level view of hardware and BIOS versions for systems that have used iPXE Anywhere. This can be useful for tracking such things as legacy BIOS systems during a migration to UEFI.

![](https://content.gitbook.com/content/oPMTFuBb6yV8Wq1KUzxo/blobs/7cZE5KXia35hGKxpryYE/13.png)

### Reporting and request handler mode

To use the web service for both reporting and request handling, also enable **BootRequest** (the 2PXE default). Status reporting works as described above, and in addition all boot requests are routed from 2PXE to the iPXE Anywhere Web Service. When it receives a boot request, the iPXE Anywhere Web Service runs the **iPXE start script** PowerShell script (by default `Scripts\Boot\iPXEboot.ps1`; see [Configuring the iPXE Web Service](/ipxe-ws/4.0/configuration/configuring-the-ipxe-web-service.md)). This script can be used to perform many custom actions during the boot process. During the workflow, control can be passed from the iPXE Anywhere Web Service to 2PXE and back again several times if required, making it a very powerful solution.

#### Examples

See the iPXE Anywhere Scripting Guide, which contains examples and a full reference for scripting with both PowerShell and iPXE scripting.

#### Things to try

* Add the system to (or remove it from) Microsoft Configuration Manager collections
* Provide the logic required to update the BIOS if it is out of date
* Switch from BIOS to UEFI
* Automatically create a ticket in your service desk of choice
* Talk to any other management system


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.2pintsoftware.com/ipxe-ws/4.0/configuration/integrating-with-2pxe-server.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
