---

layout: default title: README

FleetDM-PowerShell

A PowerShell module for the FleetDM REST API, including Fleet Free and optional Fleet Premium cmdlets.

Overview

FleetDM-PowerShell provides a native PowerShell interface to Fleet. Free-tier cmdlets manage hosts, reports, policies, and software inventory. Premium cmdlets cover fleets, software installers, self-service categories, scripts, MDM lock and disk encryption, OS update enforcement, policy automations, calendar maintenance windows, and SSO just-in-time provisioning. Premium cmdlets call the same API and surface HTTP 402 from a Fleet Free server as a license error.

📚 View Full Documentation — install, connect, common tasks, and the cmdlet reference.

Features

• Free Tier: Hosts, reports, policies, and software inventory without a Premium license
• Fleet Premium: Fleets, software install and uninstall, self-service categories, scripts, host lock and unlock, disk encryption, OS update enforcement, policy automations, calendar events, and SSO JIT provisioning
• Host Management: Query, filter, and manage FleetDM hosts
• Query Execution: Run live queries and saved reports against hosts
• Policy Management: Create, update, and monitor compliance policies, including fleet policies
• Software Inventory: Track installed software and vulnerabilities
• Cross-Platform: Works on Windows PowerShell 5.1+ and PowerShell Core 7+
• Pipeline Support: Full support for PowerShell pipeline operations
• Simple Authentication: Support for API tokens and credentials without external dependencies
• Lightweight: No SecretManagement or other complex dependencies
• Comprehensive Help: Detailed help for all cmdlets with examples

Requirements

• PowerShell 5.1 or PowerShell Core 7.0+
• FleetDM server (4.0+). Fleet Premium cmdlets require a Premium license on that server
• FleetDM API token or credentials
• No external module dependencies

Installation

From PowerShell Gallery

Install-Module -Name FleetDM-PowerShell -Force

From Source

# Clone the repository
git clone https://github.com/Jorgeasaurus/FleetDM-PowerShell.git
cd FleetDM-PowerShell

# Import directly without building
Import-Module ./FleetDM-PowerShell.psd1 -Force

Quick Start

Connect to FleetDM

# Using API token (recommended - most secure)
$token = ConvertTo-SecureString "your-api-token-here" -AsPlainText -Force
Connect-FleetDM -BaseUri "https://fleet.example.com" -ApiToken $token

# Using username/password
$cred = Get-Credential
Connect-FleetDM -BaseUri "https://fleet.example.com" -Credential $cred

Basic Operations

# Get all hosts
Get-FleetHost

# Get specific host
Get-FleetHost -Id 123

# Filter hosts by status
Get-FleetHost -Status online

# Run a live query and get results directly
$results = Invoke-FleetQuery -Query "SELECT * FROM system_info;" -HostId 1,2,3
$results.Results | Format-Table

# Or use a saved query
$results = Invoke-FleetSavedQuery -QueryId 123 -HostId 1,2,3

# Get policies
Get-FleetPolicy

# Get software inventory
Get-FleetSoftware -VulnerableOnly

Available Cmdlets

For detailed help and examples, visit the Online Documentation or use Get-Help <cmdlet-name> -Full.

Connection Management

• Connect-FleetDM - Establish connection to FleetDM server
• Disconnect-FleetDM - Disconnect from FleetDM server

Host Management

• Get-FleetHost - Retrieve host information
• Remove-FleetHost - Remove hosts from FleetDM

Query Management

• Get-FleetQuery - List saved queries
• Invoke-FleetQuery - Execute live queries
• Invoke-FleetSavedQuery - Execute saved queries with direct results

Policy Management

• Get-FleetPolicy - Retrieve policies
• New-FleetPolicy - Create new policies
• Set-FleetPolicy - Update existing policies

Software Management

• Get-FleetSoftware - Retrieve software inventory
• Install-FleetSoftware - Install a software title on a host (Premium)
• Uninstall-FleetSoftware - Uninstall a software title from a host (Premium)
• Get-FleetSoftwareInstall - Read a package install result (Premium)
• Remove-FleetSoftwarePackage - Remove an installer from a fleet (Premium)
• Get-FleetSelfServiceCategory - List self-service categories (Premium)
• New-FleetSelfServiceCategory - Create a self-service category (Premium)
• Set-FleetSelfServiceCategory - Rename a self-service category (Premium)
• Remove-FleetSelfServiceCategory - Delete a self-service category (Premium)

Fleets (Premium)

• Get-FleetTeam - List or get fleets (the REST resource is /fleets)
• New-FleetTeam - Create a fleet
• Set-FleetTeam - Rename a fleet or assign hosts
• Remove-FleetTeam - Delete a fleet

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗