GitHub
Sign in
Start for free
View Categories

Devices

Quick guide #

XOAP Devices are endpoints where the XOAP Connector is installed and enrolled into your workspace. Once connected, devices become visible in the Inventory module and can be used to run queries and commands, collect inventory data, and (if enabled during installation) participate in Image Management workflows.

Add a Device (Install XOAP Connector) #

  1. Go to Inventory → Devices and click + Add Device.
  2. In the Download the XOAP connector section, select the target platform (Windows / macOS / Linux) and click Download.
  3. In Enroll and start the XOAP connector, select the API key that should be used for enrollment.
  4. Copy the generated installation command and run it on the target device:
    • Windows: Run Windows PowerShell as Administrator
    • Linux/macOS: Run the command with appropriate privileges (for example, using sudo where required)
  5. After installation completes, the Connector service is automatically started.
  6. Once the device connects, it will appear in Inventory → Devices with an online status.

Delete a Device #

  1. In Inventory → Devices, click the Action menu (⋮) next to the device.
  2. Select Delete.
  3. Confirm the deletion.

Additional useful information #

API key prerequisite #

To enroll a device, you must first create an API key in XOAP (under Connections). The installer uses this key to register the device to your workspace.

Service behavior #

The XOAP Connector runs as a service (Windows) /daemon (Linux/Mac).

Image Management flag #

If the device will be used for Image Management, install the connector using the –imagemanagement flag to enable the required functionality during enrollment.

Connectivity requirements #

The device must be able to reach the XOAP backend (HTTPS/443, directly or via proxy) to enroll and stay connected.

Devices vs. Nodes #

A single endpoint can appear both as a Device in Inventory (XOAP Connector installed) and as a Node in Configuration Management (registered via configuration). These are complementary views—one does not exclude the other.

Mass deployment option (PSADT + Application Management) #

The XOAP Connector installer can be packaged as a PSAppDeployToolkit (PSADT) package and deployed via Application Management to:

  • already managed Nodes, and
  • new endpoints as part of onboarding.

Technical documentation #

The Devices page in Inventory lists endpoints where the XOAP Connector is installed and enrolled into a workspace. Once connected, devices can execute Inventory features (for example Queries via osquery) and support operational actions such as running commands/scripts, transferring files, and installing applications.

A device can be managed in multiple XOAP areas at the same time:

  • The same endpoint can appear as a Node in Configuration Management and as a Device in Inventory. These are different feature areas and do not exclude each other.

Prerequisites #

  • API key must exist in XOAP Connections before installing/enrolling the XOAP Connector.
  • Local admin/root privileges are required to install the connector and set up the service.

Installing and enrolling the XOAP Connector #

In Inventory → Devices → Add Agent, select the platform and API key. XOAP generates an install command that enrolls the device into the correct workspace.

Windows (PowerShell as Administrator): #

.\XOAP.Connector.Installer.exe –install –apiKey APIKEY –workspace WORKSPACEID

Linux (run with sudo): #

./XOAP.Connector.Installer –install –apiKey APIKEY  –workspace WORKSPACEID

Image Management flag #

If the device should be used for Image Management, install the connector with the Image Management flag:

.\XOAP.Connector.Installer.exe –install –apiKey APIKEY –workspace WORKSPACEID –ImageManagement

If Image Management is not enabled during installation, the device will still work for Inventory features, but Image Management-specific capabilities may not be available.

Service startup #

After installation, the XOAP Connector service is started automatically. If needed, it can be started manually:

Start-Service XOAPConnector

What gets installed during XOAP Connector installation #

During installation, the XOAP Connector installation utility detects existing components first and installs only what is missing or required. If a component is already installed and meets the expected version, that step is skipped.

Components handled by the installer #

1) XOAP Connector binaries #
  • Downloads the latest XOAP Connector release package and extracts it to:
    • C:\Program Files\XOAP\Connector
  • Creates/updates the connector configuration as part of enrollment (API key + workspace).
2) XOAP Connector Windows Service #
  • Installs a Windows service named XOAPConnector
  • Starts the service after installation (and typically configures it for automatic startup).
3) Installer persistence files #
  • Persists installer/support files under:
    • C:\Program Files\XOAP\Installer
4) osquery (Inventory / Queries dependency) #
  • Detects osquery installation and version.
  • If missing (or older than required), downloads and installs osquery (MSI).
  • If already installed and the version is equal/newer than required, installation is skipped.
5) Supporting tooling (prepared installers / prerequisites) #

The installer can prepare prerequisites used by XOAP workflows (depending on scenario/feature usage):

  • Packer (commonly required for Image Management-related workflows)
  • Azure CLI (used when interacting with Azure workflows)
  • WinGet initialization may be executed to support prerequisite handling on Windows.

Temporary download locations #

Downloaded packages (for example connector ZIP and osquery MSI) are typically staged under:

  • C:\Users\<user>\AppData\Local\Temp\…

Updating and uninstalling (optional operational commands) #

Depending on your distribution/installer build, the connector utility may support lifecycle operations such as:

Update #

\XOAP.Connector-Installer.exe –update

Uninstall #

.\XOAP.Connector-Installer.exe –uninstall

Device actions in Inventory #

From the device action menu (â‹®) you can run operations on a connected device, such as:

  • View agent log: Opens connector runtime logs for troubleshooting.
  • Run Command: Executes a command from the Commands Library on the device.
  • Run Query: Executes an osquery-based Inventory query on the device.
  • Run Script: Runs a script on the device.
    • Scripts are selected from the XOAP Resources area (scripts must exist as resources first).
  • Install applications: Assigns and triggers application installs (depending on your Application Management setup).
  • Transfer file:
    • Download: Retrieve a file from the device to XOAP (optionally add it to Resources).
    • Upload: Upload a file to the device either from XOAP Resources or from your local machine.
  • Delete: Removes the device from the Inventory list (device-side uninstall is a separate action/process).

More information #

Devices vs Nodes #

A device can be managed as a Device (Inventory) and a Node (Configuration Management) at the same time.

Mass deployment #

The XOAP Connector can be packaged (for example as a PSAppDeployToolkit (PSADT) package) and deployed at scale through Application Management to existing managed Nodes — and used as a standardized installer for new devices as well.

Image Management enablement #

If a device is intended to participate in Image Management, install with –imagemanagement from the start to ensure the correct capabilities are enabled.

Powered by BetterDocs

Scroll to Top