Get-TestimoXConfig

Namespace TestimoX.PowerShell

Outputs

TestimoX.Configuration.GeneratedFileResult TestimoX.Configuration.Rules.RuleExportResult TestimoX.Configuration.Run.RunConfig TestimoX.Execution.RuleListEntry TestimoX.Execution.RuleSelectionProfileInfo

Create run.json (one-off runs), list rules, and export rule overrides JSON.

Remarks

Service configuration generation lives in Get-TestimoXService.

Examples

Authored help example

Example 1: Create a run.json (one-off run)

PS>


Get-TestimoXConfig -Path C:\Configs\run.json -RuleNames ForestRecycleBinAndLifetimes

Example 2: List rules (names only)

PS>


Get-TestimoXConfig -ListRules

Example 3: Export rule override template for selected rules

PS>


Get-TestimoXConfig -RuleConfigPath C:\Configs\rules.json -Name Forest*

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 optionalposition: namedpipeline: false: When set, include HTML report generation in run.json.
HtmlReportPath string optionalposition: namedpipeline: false: Output path for HTML report (optional override).
IncludeDisabled SwitchParameter optionalposition: namedpipeline: false: Include rules disabled by default when listing/exporting.
JsonReportPath string optionalposition: namedpipeline: false: Output path for JSON report (optional override).
ListProfiles SwitchParameter optionalposition: namedpipeline: false: List curated execution profiles instead of generating run config.
ListRules SwitchParameter optionalposition: namedpipeline: false: List rules instead of generating run config.
Name string[] optionalposition: namedpipeline: false: Wildcard name filter when listing/exporting rules.
OpenReport SwitchParameter optionalposition: namedpipeline: false: When set, open the HTML report after the run completes.
Path string optionalposition: namedpipeline: false: Optional file path to save the generated run.json. If omitted, the typed object is written to the pipeline.
PowerShellRuleNames string[] optionalposition: namedpipeline: false: PowerShell rule names to include in the generated run.json.
PowerShellRulesDirectory string optionalposition: namedpipeline: false: Optional path to a directory containing additional user PowerShell rules (.ps1). Overrides TESTIMOX_PS_RULES_DIR for discovery in this cmdlet.
Profile RuleSelectionProfile optionalposition: namedpipeline: falsevalues: 1: Optional curated rule-selection profile to persist in run.json. Possible values: None, AdSecurityAssessment; Possible values: AdSecurityAssessment
RuleConfigPath string optionalposition: namedpipeline: false: When set, export a rule overrides template to this path.
RuleNames string[] optionalposition: namedpipeline: false: 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