TestimoX

API Reference

Class

RunConfig

Namespace TestimoX.Configuration.Run
Assembly TestimoX
Modifiers sealed

Minimal, host-agnostic configuration for running Testimo once (no scheduling). Designed for CLI, PowerShell, and C# examples.

Inheritance

  • Object
  • RunConfig

Constructors

public RunConfig() #

Properties

public List<String> RuleNames { get; set; } #

Names of rules to execute (string identifiers).

public List<String> PowerShellRuleNames { get; set; } #

Names of embedded PowerShell rules to execute.

public String PowerShellRulesDirectory { get; set; } #

Optional directory containing additional user PowerShell rules (.ps1) to load.

public Dictionary<String, Dictionary<String, Object>> RuleOverrides { get; set; } #

Inline per-rule override values keyed by rule name.

public String RuleConfigPath { get; set; } #

Optional JSON file path containing rule overrides (alternative to RuleOverrides).

public ExportShapeConfig Shape { get; set; } #

Optional shaping for exported streams when a host chooses to export run results.

public Nullable<Boolean> GenerateHtml { get; set; } #

When true, generate an HTML report after the run (host-dependent).

public Nullable<Boolean> GenerateWord { get; set; } #

When true, generate a Word (.docx) report after the run (host-dependent).

public Nullable<Boolean> OpenReport { get; set; } #

When true, open the generated HTML report (host-dependent).

public String HtmlReportPath { get; set; } #

Optional explicit path for the HTML report.

public String WordReportPath { get; set; } #

Optional explicit path for the Word (.docx) report.

public String JsonReportPath { get; set; } #

Optional explicit path for a JSON export of run results.

public EngineConfig Engine { get; set; } #

Optional engine-level settings for this one-off run.

public StorageConfig Storage { get; set; } #

Optional durable store settings for this run (results/snapshots reuse). When provided, the engine will consult and write to the store according to policy.

public PowerShellRuntimeConfig PowerShellRuntime { get; set; } #

Optional PowerShell catalog settings applied before discovery/execution.

public GpoConfig Gpo { get; set; } #

Convenience: GPO cache settings at the top level.

public List<Category> IncludeCategories { get; set; } #

Categories to include during rule selection.

public List<Category> ExcludeCategories { get; set; } #

Categories to exclude during rule selection.

public List<String> IncludeTags { get; set; } #

Tags to include (match any).

public List<String> ExcludeTags { get; set; } #

Tags to exclude (match any).

public Nullable<RuleCost> MaxCost { get; set; } #

Maximum rule cost to include (e.g., "Moderate").

public Nullable<Boolean> ExcludeHeavy { get; set; } #

Exclude rules marked as Heavy or Extreme regardless of MaxCost.

public Nullable<RuleSelectionProfile> Profile { get; set; } #

Optional curated rule-selection profile applied before explicit filters.