Get-TestimoXRuleOverview

Namespace TestimoX.PowerShell

Outputs

System.String TestimoX.Execution.RuleInventoryEntry TestimoX.Execution.RuleOverview

Lists discovered TestimoX rules as metadata rows or emits copy/paste-ready enum names.

Examples

Authored help example

Example 1: List the full rule overview and review it in a table

PS>


Get-TestimoXRuleOverview | Format-Table Name, Type, Enabled, Categories, DisplayName -AutoSize

This is a good first pass when you want to see what the current build exposes across both rule catalogs.

Example 2: Inspect only enabled PowerShell-backed rules that mention recycle bin

PS>


Get-TestimoXRuleOverview -Type PowerShell -EnabledOnly -Filter RecycleBin

Use this to verify that a targeted subset is still enabled after rule-generation changes.

Example 3: Generate snippet-ready C# enum entries for a hand-curated rule list

PS>


Get-TestimoXRuleOverview -Type CSharp -NameOnly -AsSnippet -Indent 8

The output includes indentation and trailing commas so it can be pasted directly into a source file.

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-TestimoXRuleOverview [-AsSnippet] [-EnabledOnly] [-Filter <string>] [-Indent <int>] [-Inventory] [-NameOnly] [-PowerShellRulesDirectory <string>] [-Profile <AdSecurityAssessment>] [-Type <string>] [<CommonParameters>]

Parameters

AsSnippet SwitchParameter optionalposition: namedpipeline: false: When used with NameOnly, outputs lines with indentation and commas.
EnabledOnly SwitchParameter optionalposition: namedpipeline: false: Returns only rules that are enabled by default.
Filter string optionalposition: namedpipeline: false: Optional case-insensitive substring filter applied to both Name and DisplayName.
Indent int optionalposition: namedpipeline: false: Number of leading spaces used when AsSnippet is requested.
Inventory SwitchParameter optionalposition: namedpipeline: false: Emits the richer migration inventory instead of the compact overview.
NameOnly SwitchParameter optionalposition: namedpipeline: false: Emits only qualified enum names instead of overview or inventory rows.
PowerShellRulesDirectory string optionalposition: namedpipeline: false: Optional path to a directory containing user PowerShell rules (.ps1). Overrides TESTIMOX_PS_RULES_DIR.
Profile RuleSelectionProfile optionalposition: namedpipeline: falsevalues: 5: Optional curated profile used to classify inventory rows into assessment areas. Possible values: None, AdSecurityAssessment, DnsSecurityAudit, NistDnsAudit, GeneralDnsConfigurationAudit, AdDnsCleanupAudit; Possible values: AdSecurityAssessment, DnsSecurityAudit, NistDnsAudit, GeneralDnsConfigurationAudit, AdDnsCleanupAudit
Type string optionalposition: namedpipeline: false: Limits results to a specific source catalog: Both, CSharp, or PowerShell.

Outputs

System.String, TestimoX.Execution.RuleInventoryEntry, TestimoX.Execution.RuleOverview