XOAP Connector

XOAP Connector is an agent designed for secure system automation within the XOAP platform. The Connector enables centralized management of distributed systems and simplifies the operation of hybrid IT infrastructures.

It runs on Windows, macOS and Linux, and connects directly to your XOAP backend. Currently, supported on-premises environments include vSphere and Nutanix.

Getting Started

Prerequisites

Before installing the XOAP Connector, you need:

1. API Key: Create an API key in your XOAP workspace
2. Workspace ID: Found in your XOAP Workspace URL
3. Connection: Define credentials to link your on-premises environment with XOAP

Add API Key

To create a new API key:

1. In your XOAP workspace, go to Connections and click New Connection
2. Select API Key as the connection type
3. Provide a Connection Name and select the API Token Type called "XOAP Connector"
4. Click Confirm to create a new API key
5. Copy the key to the clipboard for use during installation

Installation

The Connector can be installed using command line parameters. See the Command Line Parameters section below for details.

Windows Installation

Run in PowerShell as Administrator:

.\xoap-connector.exe -i -a <YOUR_API_KEY> -w <YOUR_WORKSPACE_ID>

Linux/Mac Installation

./xoap-connector -i -a <YOUR_API_KEY> -w <YOUR_WORKSPACE_ID>

Connect Your Device

To connect your device to XOAP:

1. In Application Management, go to Application Groups
2. Find the group XOAP Connector – Base Group and open Details
3. On the Details page, under Assigned applications, click the Connector application eye icon to view details
4. Set the apiKey and workspace values and click Update to save the new values
5. Go to Configuration Management → Configuration Groups
6. Find the XOAP Connector group, click the action menu and select Copy registration command
7. Run this command on your device in an administrator session

Once complete, your device will appear under Inventory → Devices in your XOAP Workspace.

Command Line Parameters

Mandatory Parameters

• -i or --install: Installs the Connector
• -a or --apiKey: Specifies the API Key to connect to the XOAP Workspace
• -w or --workspace: Specifies the XOAP Workspace ID the Connector should connect to

Optional Parameters

• -m or --imageManagement: Additionally installs Packer on Windows and supported Linux distributions
• -u or --update: Fetches the latest available Connector binaries from GitHub
• -p or --path: Installation path
  • Default: C:\Program Files\XOAP\Connector (Windows)
  • Default: /opt/XOAP/Connector (Linux and Mac)
• -?: Shows available parameters

Example Usage

Basic installation:

./xoap-connector -i -a your-api-key-here -w your-workspace-id

Installation with image management:

./xoap-connector -i -a your-api-key-here -w your-workspace-id -m

Installation with custom path:

./xoap-connector -i -a your-api-key-here -w your-workspace-id -p /custom/path

Update existing installation:

./xoap-connector -u

Supported Operating Systems

Windows

• Windows Server 2016 and later
• Windows 10 and later

Linux (Preview)

The following distributions have been tested:

• Ubuntu 24.04, 22.04
• Rocky 10 Linux
• Alma Linux
• Fedora 43 Linux

Next Steps

Once your environment, API key, device and operating system are configured, you can create your first machine image. For detailed instructions, see the Creating an image documentation.

Resources

• Official Documentation
• Getting Started Guide
• XOAP Packer Templates
• Customer Support
• Changelog
• Roadmap

Support

For support and questions, please visit:

• Customer Support
• Documentation
• FAQ

License

This software is proprietary and licensed by RIS AG all rights are reserved.