API Reference
Get-TestimoXConfig
Generates run.json, lists discoverable rules, and exports rule-override templates.
Examples
Example 1: Generate a one-off run.json for the AD security assessment profile
PS>
Get-TestimoXConfig -Path 'C:\Ops\TestimoX\Configs\run.json' -Profile AdSecurityAssessment -GenerateHtml -OpenReport -HtmlReportPath 'C:\Ops\TestimoX\Reports\AdSecurity.html'
The generated JSON can be checked into an operations repo and later executed with Invoke-TestimoX -ConfigPath.
Example 2: List rules from both built-in catalogs and a custom PowerShell rule folder
PS>
Get-TestimoXConfig -ListRules -PowerShellRulesDirectory 'C:\Ops\TestimoX\Rules' -Name 'Domain*'
This helps validate that custom .ps1 rules are being discovered before a production run.
Example 3: Export a rule-override template for password and Kerberos-related rules
PS>
Get-TestimoXConfig -RuleConfigPath 'C:\Ops\TestimoX\Configs\rules-overrides.json' -Name 'DomainPassword*','DomainKerberos*'
The resulting file contains only the selected rules, making it easier to review with change control.
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-TestimoXConfig [-GenerateHtml] [-HtmlReportPath <string>] [-IncludeDisabled] [-JsonReportPath <string>] [-ListProfiles] [-ListRules] [-Name <string[]>] [-OpenReport] [-Path <string>] [-PowerShellRuleNames <string[]>] [-PowerShellRulesDirectory <string>] [-Profile <AdSecurityAssessment>] [-RuleConfigPath <string>] [-RuleNames <string[]>] [<CommonParameters>]Parameters
- GenerateHtml SwitchParameter
- When set, the generated run configuration enables HTML report generation.
- HtmlReportPath string
- Optional explicit output path for the HTML report generated by the resulting run configuration.
- IncludeDisabled SwitchParameter
- Includes rules that are disabled by default when listing or exporting rule metadata.
- JsonReportPath string
- Optional explicit output path for the JSON report generated by the resulting run configuration.
- ListProfiles SwitchParameter
- Lists curated execution profiles instead of generating a run configuration.
- ListRules SwitchParameter
- Lists discovered rules instead of generating a run configuration.
- Name string[]
- Wildcard name filter used when listing or exporting rules.
- OpenReport SwitchParameter
- When set, the generated run configuration opens the HTML report after execution completes.
- Path string
- Optional file path for the generated run.json. When omitted, the typed RunConfig object is written to the pipeline.
- PowerShellRuleNames string[]
- Embedded or custom PowerShell rule names to include in the generated run.json.
- PowerShellRulesDirectory string
- Optional path to a directory containing additional user PowerShell rules (.ps1). Overrides TESTIMOX_PS_RULES_DIR for discovery in this cmdlet.
- Profile RuleSelectionProfile
- Optional curated rule-selection profile to stamp into the generated run configuration. Possible values: None, AdSecurityAssessment, DnsSecurityAudit, NistDnsAudit, GeneralDnsConfigurationAudit, AdDnsCleanupAudit
- Possible values:
AdSecurityAssessment,DnsSecurityAudit,NistDnsAudit,GeneralDnsConfigurationAudit,AdDnsCleanupAudit - RuleConfigPath string
- When provided, exports a rule-overrides JSON template to this path.
- RuleNames string[]
- C# or engine rule names to include in the generated run.json.
Outputs
TestimoX.Configuration.GeneratedFileResult, TestimoX.Configuration.Rules.RuleExportResult, TestimoX.Configuration.Run.RunConfig, TestimoX.Execution.RuleListEntry, TestimoX.Execution.RuleSelectionProfileInfo