Set-ADXReportOptions

Namespace ADPlayground.PowerShell

Sets global defaults for ADPlayground HTML reports.

Examples

Authored help example

Example 1: Set branded defaults for reports generated on an admin workstation


Set-ADXReportOptions -OutputDirectory 'C:\Reports' -LogoPath 'C:\Branding\contoso-logo.png' -LogoAltText 'Contoso' -HeaderText 'Contoso Identity Operations' -FooterText 'Generated by ADPlayground' -Author 'Identity Engineering' -OpenInBrowser

Example 2: Reset report defaults to the built-in module values


Set-ADXReportOptions -Reset

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

Set-ADXReportOptions [-Author <string>] [-Description <string>] [-FooterText <string>] [-HeaderText <string>] [-LogoAltText <string>] [-LogoPath <string>] [-OpenInBrowser] [-OutputDirectory <string>] [-Reset] [-Subtitle <string>] [-Title <string>] [<CommonParameters>]

Parameters

Author string optionalposition: namedpipeline: false: Override the report author.
Description string optionalposition: namedpipeline: false: Override the report description.
FooterText string optionalposition: namedpipeline: false: Footer text (optional).
HeaderText string optionalposition: namedpipeline: false: Header text (optional).
LogoAltText string optionalposition: namedpipeline: false: Logo alt text (optional).
LogoPath string optionalposition: namedpipeline: false: Logo path for header branding (optional).
OpenInBrowser SwitchParameter optionalposition: namedpipeline: false: Open reports after generation (HTML in browser).
OutputDirectory string optionalposition: namedpipeline: false: Default output directory for exported reports.
Reset SwitchParameter optionalposition: namedpipeline: false: Reset defaults to built-in values.
Subtitle string optionalposition: namedpipeline: false: Override the report subtitle.
Title string optionalposition: namedpipeline: false: Override the report title.