TestimoX

API Reference

Command

Get-TestimoXService

Namespace TestimoX.PowerShell
Outputs
System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]] System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]] TestimoX.Configuration.GeneratedFileResult TestimoX.Configuration.Service.ServiceConfig TestimoX.Services.ServiceHealthStatus TestimoX.Services.ServiceMetricsSnapshot TestimoX.Services.ServiceRuntimeStatus TestimoX.Services.ServiceStatusInfo

Get TestimoX service status or read/generate the service configuration.

Remarks

If connected via Connect-TestimoXService, this cmdlet calls the Management API (status/config/preview). Otherwise it reads the deployed configuration locally and computes a preview from the schedule. Default output is the currently deployed typed configuration. Use -Status to return only service status, -WhatIfNext to preview upcoming run times, or provide -Path with schedule options to generate a new service.json scaffold.

Examples

Authored help example

Example 1: Get status

PS>


Get-TestimoXService -Name TestimoX -Status

Example 2: Read deployed service configuration

PS>


Get-TestimoXService -Name TestimoX

Example 3: Generate a service.json scaffold

PS>


Get-TestimoXService -Path C:\Configs\service.json -Mode Daily -DailyTimes 01:00 -EnableAdSnapshot

Example 4: List API key names and LastSetUtc

PS>


Get-TestimoXService -ApiKeys

Example 5: Tail service logs (last 200 lines by default)

PS>


Get-TestimoXService -Logs -Lines 500 -Date 20250930

Example 6: Check service health

PS>


Get-TestimoXService -Health

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-TestimoXService [-Config] [-Name <string>] [<CommonParameters>]
#
Parameter set: By Config

Parameters

Config SwitchParameter optionalposition: namedpipeline: false
When set in the Read set, return the deployed typed configuration instead of status.
Name string optionalposition: namedpipeline: false
Windows service name.

Outputs

System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Service.ServiceConfig, TestimoX.Services.ServiceHealthStatus, TestimoX.Services.ServiceMetricsSnapshot, TestimoX.Services.ServiceRuntimeStatus, TestimoX.Services.ServiceStatusInfo

Get-TestimoXService [-Name <string>] [-Status] [<CommonParameters>]
#
Parameter set: By Status

Parameters

Name string optionalposition: namedpipeline: false
Windows service name.
Status SwitchParameter optionalposition: namedpipeline: false
Return only service status (Name, Status, CanStop, paths), not configuration.

Outputs

System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Service.ServiceConfig, TestimoX.Services.ServiceHealthStatus, TestimoX.Services.ServiceMetricsSnapshot, TestimoX.Services.ServiceRuntimeStatus, TestimoX.Services.ServiceStatusInfo

Get-TestimoXService [-ApiKeys] [-Name <string>] [<CommonParameters>]
#
Parameter set: By ApiKeys

Parameters

ApiKeys SwitchParameter optionalposition: namedpipeline: false
List configured API keys (name and LastSetUtc) via the Management API.
Name string optionalposition: namedpipeline: false
Windows service name.

Outputs

System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Service.ServiceConfig, TestimoX.Services.ServiceHealthStatus, TestimoX.Services.ServiceMetricsSnapshot, TestimoX.Services.ServiceRuntimeStatus, TestimoX.Services.ServiceStatusInfo

Get-TestimoXService [-Contains <string>] [-Date <string>] [-Level <string>] [-Lines <int>] [-Logs] [-Name <string>] [<CommonParameters>]
#
Parameter set: By Contains + Date

Parameters

Contains string optionalposition: namedpipeline: false
Optional substring filter: include only lines that contain this text.
Date string optionalposition: namedpipeline: false
Optional date for -Logs (yyyyMMdd). Defaults to today.
Level string optionalposition: namedpipeline: false
Optional log level filter (e.g., Info, Warn, Error).
Lines int optionalposition: namedpipeline: false
Number of lines to read for -Logs/-History (default 200; max 5000).
Logs SwitchParameter optionalposition: namedpipeline: false
Tail service logs from the Management API or local files.
Name string optionalposition: namedpipeline: false
Windows service name.

Outputs

System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Service.ServiceConfig, TestimoX.Services.ServiceHealthStatus, TestimoX.Services.ServiceMetricsSnapshot, TestimoX.Services.ServiceRuntimeStatus, TestimoX.Services.ServiceStatusInfo

Get-TestimoXService [-History] [-Lines <int>] [-Name <string>] [<CommonParameters>]
#
Parameter set: By History

Parameters

History SwitchParameter optionalposition: namedpipeline: false
Show recent run history (timestamps and outcomes).
Lines int optionalposition: namedpipeline: false
Number of lines to read for -Logs/-History (default 200; max 5000).
Name string optionalposition: namedpipeline: false
Windows service name.

Outputs

System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Service.ServiceConfig, TestimoX.Services.ServiceHealthStatus, TestimoX.Services.ServiceMetricsSnapshot, TestimoX.Services.ServiceRuntimeStatus, TestimoX.Services.ServiceStatusInfo

Get-TestimoXService [-Baselines] [-Name <string>] [<CommonParameters>]
#
Parameter set: By Baselines

Parameters

Baselines SwitchParameter optionalposition: namedpipeline: false
List baseline files produced by previous runs.
Name string optionalposition: namedpipeline: false
Windows service name.

Outputs

System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Service.ServiceConfig, TestimoX.Services.ServiceHealthStatus, TestimoX.Services.ServiceMetricsSnapshot, TestimoX.Services.ServiceRuntimeStatus, TestimoX.Services.ServiceStatusInfo

Get-TestimoXService [-Health] [-Name <string>] [<CommonParameters>]
#
Parameter set: By Health

Parameters

Health SwitchParameter optionalposition: namedpipeline: false
Return a health snapshot from the Management API (if connected).
Name string optionalposition: namedpipeline: false
Windows service name.

Outputs

System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Service.ServiceConfig, TestimoX.Services.ServiceHealthStatus, TestimoX.Services.ServiceMetricsSnapshot, TestimoX.Services.ServiceRuntimeStatus, TestimoX.Services.ServiceStatusInfo

Get-TestimoXService [-WhatIfNext <int>] [<CommonParameters>]
#
Parameter set: By WhatIfNext

Parameters

WhatIfNext int optionalposition: namedpipeline: false
Preview next N scheduled run times (default 5) when using the Preview set.

Outputs

System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Service.ServiceConfig, TestimoX.Services.ServiceHealthStatus, TestimoX.Services.ServiceMetricsSnapshot, TestimoX.Services.ServiceRuntimeStatus, TestimoX.Services.ServiceStatusInfo

Get-TestimoXService [-Metrics] [<CommonParameters>]
#
Parameter set: By Metrics

Parameters

Metrics SwitchParameter optionalposition: namedpipeline: false
Return a metrics snapshot (counters/timers) from the Management API.

Outputs

System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Service.ServiceConfig, TestimoX.Services.ServiceHealthStatus, TestimoX.Services.ServiceMetricsSnapshot, TestimoX.Services.ServiceRuntimeStatus, TestimoX.Services.ServiceStatusInfo

Get-TestimoXService [-DailyTimes <string[]>] [-EnableAdSnapshot] [-IntervalSeconds <int>] [-JitterSeconds <int>] [-Mode <Disabled|Interval|Daily|Weekly>] [-OutputDirectory <string>] [-Path <string>] [-Profile <AdSecurityAssessment>] [-RunAtStartup] [-Shape <All|SummaryOnly|PassFailOnly|ResultsOnly>] [-WeeklyDays <string[]>] [-WeeklyTime <string>] [<CommonParameters>]
#
Parameter set: By DailyTimes + EnableAdSnapshot

Parameters

DailyTimes string[] optionalposition: namedpipeline: false
Times for Daily mode in HH:mm, multiple allowed (e.g., 01:00,13:00).
EnableAdSnapshot SwitchParameter optionalposition: namedpipeline: false
Enable the Active Directory snapshot stage.
IntervalSeconds int optionalposition: namedpipeline: false
Interval seconds for Interval mode (ignored by other modes).
JitterSeconds int optionalposition: namedpipeline: false
Randomize next-run times by up to this many seconds.
Mode ScheduleMode optionalposition: namedpipeline: falsevalues: 4
Schedule mode when generating a new service.json: Disabled, Interval, Daily, or Weekly. Possible values: Disabled, Interval, Daily, Weekly
Possible values: Disabled, Interval, Daily, Weekly
OutputDirectory string optionalposition: namedpipeline: false
Directory for generated outputs (reports/baselines) when the service runs.
Path string optionalposition: namedpipeline: false
Optional output path; when set, writes the generated service.json to this file. Otherwise outputs the typed object.
Profile RuleSelectionProfile optionalposition: namedpipeline: falsevalues: 1
Optional curated rule-selection profile to place in the generated TestRun section. Possible values: None, AdSecurityAssessment
Possible values: AdSecurityAssessment
RunAtStartup SwitchParameter optionalposition: namedpipeline: false
Run immediately at service start (in addition to the schedule).
Shape ExportSelectionMode optionalposition: namedpipeline: falsevalues: 4
Report shape to produce (SummaryOnly or IncludeDetails). Possible values: All, SummaryOnly, PassFailOnly, ResultsOnly
Possible values: All, SummaryOnly, PassFailOnly, ResultsOnly
WeeklyDays string[] optionalposition: namedpipeline: false
Days of week for Weekly mode (e.g., Monday,Wednesday).
WeeklyTime string optionalposition: namedpipeline: false
Time for Weekly mode in HH:mm.

Outputs

System.Collections.Generic.List`1[[System.DateTimeOffset, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceApiKeyInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.List`1[[TestimoX.Services.ServiceBaselineInfo, TestimoX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]], TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Service.ServiceConfig, TestimoX.Services.ServiceHealthStatus, TestimoX.Services.ServiceMetricsSnapshot, TestimoX.Services.ServiceRuntimeStatus, TestimoX.Services.ServiceStatusInfo