FleetDM-PowerShell Documentation

Welcome to the FleetDM-PowerShell module documentation. This lightweight module provides PowerShell cmdlets for managing and interacting with FleetDM Free Tier instances through the REST API, without requiring Premium licenses or external dependencies.

Quick Start

# Install the module from PowerShell Gallery
Install-Module -Name FleetDM-PowerShell

# Import the module
Import-Module FleetDM-PowerShell

# Connect to FleetDM
$token = Read-Host -AsSecureString "Enter API Token"
Connect-FleetDM -BaseUri "https://fleet.example.com" -ApiToken $token

# Get all online hosts
Get-FleetHost -Status online

Available Documentation

Cmdlet Reference

Authentication

Connect-FleetDM - Connect to a FleetDM instance
Disconnect-FleetDM - Disconnect from FleetDM

Host Management

Get-FleetHost - Retrieve host information
Remove-FleetHost - Remove a host from Fleet

Policies

Get-FleetPolicy - Get policy information
New-FleetPolicy - Create a new policy
Set-FleetPolicy - Update an existing policy

Queries

Get-FleetQuery - Get saved queries
Invoke-FleetQuery - Execute a live query
Invoke-FleetSavedQuery - Execute a saved query

Software

Get-FleetSoftware - Get software inventory

Core

Invoke-FleetDMMethod - Direct API access

Additional Resources

Installation

From PowerShell Gallery

Install-Module -Name FleetDM-PowerShell -Scope CurrentUser

From GitHub

git clone https://github.com/Jorgeasaurus/FleetDM-PowerShell.git
Import-Module ./FleetDM-PowerShell/FleetDM-PowerShell.psd1

Getting Help

For detailed help on any cmdlet, use PowerShell’s built-in help system:

Get-Help Connect-FleetDM -Full
Get-Help Get-FleetHost -Examples