TestimoX PowerShell Module

The TestimoX module provides consolidated cmdlets for running assessments, exploring the rule catalog, generating configuration files, comparing historical runs, and managing the monitoring service.

Assessment Cmdlets

Invoke-TestimoX

Runs the TestimoX assessment engine and produces reports.

# Run the curated AD security profile
Invoke-TestimoX -Profile AdSecurityAssessment

# Run specific rules with a custom report path
Invoke-TestimoX -IncludeRules 'ForestRecycleBinAndLifetimes','DomainPasswordPolicy' `
                -HtmlReportPath "C:\Reports\Assessment.html"

# Run typed C# rules with IntelliSense
$cs = [TestimoX.Definitions.CSharpRule]
Invoke-TestimoX -IncludeCSharpRules $cs::ForestPkiConfiguration

# Baseline mode skips DomainController-scoped rules
Invoke-TestimoX -Baseline -Verbosity Detailed

# Resume a partial run from the durable store
Invoke-TestimoX -StoreDir "C:\Data\TestimoX" -RunId "2025-10-24T1300" -ResumeFromRun "2025-10-24T1300"

# Publish HTML from stored results only
Invoke-TestimoX -PublishFromStore -StoreDir "C:\Data\TestimoX" -HtmlReportPath "C:\Reports\TestimoX-FromStore.html"

Get-TestimoX

Runs the fast data-only path for selected rules and returns typed objects without the full reporting flow.

# Execute one rule and return its summary shape
Get-TestimoX -Rule 'ForestRecycleBinAndLifetimes' -AsSummary

# Execute typed rules and return raw objects
$cs = [TestimoX.Definitions.CSharpRule]
$ps = [TestimoX.RulesPowerShell.PowerShellRule]
Get-TestimoX -IncludeRules $cs::DomainPasswordPolicy -IncludePowerShellRules $ps::ForestRecycleBinAndLifetimes -Raw

Get-TestimoXRuleOverview

Discovers rules and returns catalog or migration-inventory views.

# List visible rules
Get-TestimoXRuleOverview

# Show the migration inventory
Get-TestimoXRuleOverview -Inventory | Format-Table Name, Type, State, SuppressedByDefault

Get-TestimoXConfig

Creates run.json , lists available rules, and exports rule override templates.

# Generate run.json
Get-TestimoXConfig -Path "C:\Configs\run.json" -Profile AdSecurityAssessment

# List rules
Get-TestimoXConfig -ListRules | Format-Table Name, SourceType, EnabledByDefault

# Export rule override template
Get-TestimoXConfig -RuleConfigPath "C:\Configs\rules.json" -Name Forest*

Compare-TestimoX

Compares two stored runs or builds a timeline across the durable store.

Compare-TestimoX -StoreDir "C:\Data\TestimoX" -Baseline "2025-10-16T10-00" -Current "2025-10-23T10-00"
Compare-TestimoX -StoreDir "C:\Data\TestimoX"

Get-TestimoXBaseline

Retrieves baseline definitions for rule comparison and reporting.

Get-TestimoXBaseline

Service Management Cmdlets

These cmdlets manage the TestimoX monitoring service.

Initialize-TestimoXService

Installs, applies, restarts, uninstalls, or runs the monitoring service workload on demand.

Initialize-TestimoXService -Install -ServicePath "C:\Apps\TestimoX.Service.exe"
Initialize-TestimoXService -Apply -Name TestimoX -ConfigPath "C:\Configs\service.json" -Restart

Connect-TestimoXService

Connects to the management API used by the monitoring service.

Connect-TestimoXService -Url "http://127.0.0.1:7809/" -ApiKey (Get-Content C:\secret.txt -Raw)

Disconnect-TestimoXService

Clears the active management API session.

Disconnect-TestimoXService

Get-TestimoXService

Reads the deployed service configuration, previews schedules, or returns service status and health.

Get-TestimoXService -Status
Get-TestimoXService -WhatIfNext 5
Get-TestimoXService -Health
Get-TestimoXService -Path "C:\Configs\service.json" -Mode Daily -DailyTimes 01:00 -EnableAdSnapshot

Set-TestimoXService

Validates and applies service.json , locally or through the management API.

Set-TestimoXService -Name TestimoX -ConfigPath "C:\Configs\service.json" -Restart

Invoke-TestimoXService

Triggers the configured monitoring workload or a one-time test/snapshot run.

Invoke-TestimoXService
Invoke-TestimoXService -RunSnapshot -Streams Users,Groups
Invoke-TestimoXService -RunTest -IncludeRules ForestRecycleBinAndLifetimes

Common Parameters

Assessment cmdlets commonly use:

Generated Reference

• TestimoX PowerShell API -- exhaustive cmdlet signatures, parameters, and generated examples
• TestimoX .NET API -- underlying assessment library types and member-level reference