Install the Orb Sensor on Windows

Installation

Setting up a Windows device as an Orb sensor allows you to run continuous network monitoring as a background service.

Download

Download the Orb CLI for Windows from our Early Access page:

Download Orb CLI for Windows

After downloading, extract orb.exe to a permanent location on your system (e.g., C:\Program Files\Orb\orb.exe).

Setting Up as a Windows Service

You can install Orb as a Windows service using either PowerShell or the sc.exe command.

Option 1: Using PowerShell (Recommended)

Open PowerShell as Administrator and run:

New-Service -Name "Orb" -BinaryPathName "C:\Program Files\Orb\orb.exe windowsservice" -DisplayName "Orb Sensor Service" -StartupType Automatic

Replace C:\Program Files\Orb\orb.exe with the actual path where you placed the Orb executable.

Option 2: Using sc.exe

Open Command Prompt as Administrator and run:

sc.exe create Orb binPath= "C:\Program Files\Orb\orb.exe windowsservice" DisplayName= "Orb Sensor Service" start= auto

Starting the Service

After creating the service, start it using:

PowerShell:

Start-Service -Name "Orb"

Command Prompt:

sc.exe start Orb

The service will now start automatically on system boot.

Data Storage

When running as LocalSystem (the default), Orb saves data in:

C:\ProgramData\Orb

Using Deployment Tokens

You can automatically link your Orb sensor to your Orb Cloud Space using a deployment token. This is especially useful for deploying multiple sensors or automating setup.

To use a deployment token, create a file named deployment_token.txt in the Orb configuration directory containing your token:

echo orb-dt1-yourdeploymenttoken678 > C:\ProgramData\Orb\deployment_token.txt

Replace orb-dt1-yourdeploymenttoken678 with your actual deployment token from the Orchestration section of Orb Cloud.

When the Orb service starts, it will automatically read this file and link to your Space.

For more details on deployment tokens and other linking methods, see the Deployment Tokens guide.

Orb CLI Commands

The Orb CLI provides a set of commands to manage your Orb sensors and interact with your Orb account. To use these commands, run orb.exe directly (not as a service):

orb.exe [command]

Available Commands:

  sensor      Run the Orb sensor
  listen      Connect to a running Orb service
  link        Link this Orb to an account
  version     Current version of Orb
  summary     Show the latest summary for this Orb
  help        This screen

Flags:
  -h, --help     help for example
  -r  --remote   connect to remote host

Managing the Service

Stop the Service

PowerShell:

Stop-Service -Name "Orb"

Command Prompt:

sc.exe stop Orb

Check Service Status

PowerShell:

Get-Service -Name "Orb"

Command Prompt:

sc.exe query Orb

Uninstall the Service

First, stop the service, then remove it:

PowerShell:

Stop-Service -Name "Orb"
Remove-Service -Name "Orb"

Command Prompt:

sc.exe stop Orb
sc.exe delete Orb

Troubleshooting

If the service fails to start:

1. Verify the path to orb.exe is correct in the service configuration
2. Check that orb.exe has the necessary permissions
3. Review Windows Event Viewer for error messages (Windows Logs → Application)
4. Ensure no other application is using the required network ports

For instructions on linking your Orb sensor to your account, refer to the Linking an Orb to Your Account guide.