Appearance
Enrollment
Enrollment is how agent endpoints are added to Ordyn.
What you need
For an endpoint enrollment you need:
- an edge node
- an endpoint enrollment token created in Ordyn
Flow
- Obtain an endpoint enrollment token and the edge host.
- Install the Agent and provide the enrollment details.
- Wait for the enrollment result.
- If approval is required, approve the endpoint in Ordyn before it can connect.
On Windows, use the Enrollment page in Agent Configuration to enroll an installed Agent, reset enrollment for a new endpoint, or repair an existing approved endpoint with a recovery token.
Enrollment tokens
Create an Enrollment Token for the intended tenant and rollout. Choose manual approval when an operator should review new devices, or automatic approval for a controlled deployment.
Bound enrollment tokens
Use a bound token to claim a prepared endpoint record and preserve its planned assignments.
Service-client enrollment tokens
Services use tokens for their configured service entry. Follow the individual service installation guide for commands.
Service-client certificate lifetime and renewal
Plan service renewal before its displayed expiry. Follow Service-Client Renewal for the shared procedure.
Supported agent operating systems
Endpoint agent enrollment is supported on these operating systems:
| Operating system | Architecture |
|---|---|
| Windows Server 2016 | x64 |
| Windows Server 2019 | x64 |
| Windows Server 2022 | x64 |
| Windows Server 2025 | x64 |
| Windows 11 24H2 | x64 |
| Windows 11 25H2 | x64 |
| Debian 12 | amd64, arm64 |
| Debian 13 | amd64, arm64 |
| Ubuntu 24.04 LTS | amd64, arm64 |
| Ubuntu 26.04 LTS | amd64, arm64 |
Enrollment on DEB-based distributions
Choose the .deb package for your device's architecture (amd64 or arm64). Agent and Runner require systemd and glibc. Install with APT to check and resolve the package dependencies.
Install the package:
bash
apt-get install ./dist/ordyn-agent_<version>_<arch>.debFor noninteractive enrollment during install, provide both environment variables:
bash
ORDYN_EDGE_HOST=ordyn-edge.example.com \
ORDYN_ENROLLMENT_TOKEN=<token> \
apt-get install ./dist/ordyn-agent_<version>_<arch>.debProviding both values enrolls a fresh installation automatically.
Windows enrollment
Windows agents can be enrolled through the MSI installer or the Enrollment page in Ordyn Agent Configuration. Both accept an enrollment token and edge host. Open the configuration application from the tray Settings… action and approve the administrator prompt.
Preserve an existing Agent installation
For an upgrade or reinstall of an enrolled Agent, open Command Prompt as administrator and start the MSI from that prompt:
cmd
msiexec.exe /i "C:\path\ordyn-agent_VERSION_x64.msi"When the MSI is started by double-clicking, setup may not detect the protected state of an existing installation and may show the enrollment page. If this happens on an already-enrolled Agent, cancel setup and run the command above. Do not enter new enrollment details.
The MSI also supports noninteractive installation through public MSI properties:
cmd
msiexec.exe /i "C:\path\ordyn-agent_VERSION_x64.msi" ORDYN_EDGE_HOST="ordyn-edge.example.com" ORDYN_ENROLLMENT_TOKEN="paste-token-here"If both properties are provided and no existing state file is present, setup skips the enrollment dialog and enrolls automatically during installation.
PowerShell security controls
Several built-in Windows operations and the endpoint script feature launch PowerShell. Endpoint security controls must permit the PowerShell processes and scripts started by Ordyn. This includes applicable PowerShell execution policies, AppLocker rules, App Control for Business policies, attack-surface reduction rules, and EDR application controls.
These products use different matching and exclusion mechanisms. Configure the narrowest allowance supported by the product for the Ordyn agent, the required PowerShell activity, and the execution identities selected for endpoint scripts. Do not disable PowerShell security controls globally.
If the required allowance is missing, PowerShell-backed jobs and configuration profiles can fail even though the Ordyn agent itself is permitted to run. Using the endpoint script feature requires policies that allow the submitted script content and its selected execution context.
Approval after enrollment
Successful enrollment does not automatically allow the endpoint to connect to Ordyn.
If the enrollment token is configured to automatically approve the endpoint, this step is approved automatically; otherwise, an operator has to approve the endpoint manually.
See Pending Endpoints for the approval and rejection workflow.
Prepared and PXE-related enrollment
Prepared endpoint + bound token
If you pre-create an endpoint, a bound enrollment token can claim exactly that record.
PXE and OS-install flow
For PXE-based provisioning, claim can also happen through the install workflow driven by ordyn-net. This allows devices that are created manually with their MAC address to be enrolled automatically after PXE installation completes.