Project

PowerBGInfo

Generate support-ready Windows desktop and logon backgrounds from PowerShell data, charts, and topology.

View on GitHub Releases Get package
Stars 312
Forks 27
PowerShell Gallery downloads 612,914
Release v2.0.3
Language: C# Updated: 2026-09-02

API Reference

Command

Invoke-BGInfo

Namespace PowerBGInfo
Inputs
None
Outputs
System.String

Runs BGInfo from a JSON configuration file.

Remarks

Runs BGInfo from a JSON configuration file.

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

  • Deploy PowerBGInfo safely Workflow

    Choose the output target, test at the real monitor resolution, and deploy reviewed JSON through logon, scheduled, or RMM automation.

  • Curated PowerBGInfo examples Example

    Build reusable configurations, operational charts, topology overlays, and visual canvases.

Examples

Authored help example

EXAMPLE 1


Invoke-BGInfo -Path 'C:\Path'

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

Invoke-BGInfo [-ConfigurationDirectory <String>] [-MonitorIndex <Int32>] [-NoApply] [-OutputFileName <String>] -Path <String> [-Target <Wallpaper|LogonScreen|Both|File>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

ConfigurationDirectory String optionalposition: namedpipeline: False
Override configuration output directory.
MonitorIndex Int32 optionalposition: namedpipeline: False
Override monitor index.
NoApply SwitchParameter optionalposition: namedpipeline: False
Generate the image without applying it to the wallpaper.
OutputFileName String optionalposition: namedpipeline: False
Override output file name.
Path String requiredposition: 0pipeline: False
Path to the JSON configuration file.
Target BgInfoTarget optionalposition: namedpipeline: Falsevalues: 4
Override output target.
Possible values: Wallpaper, LogonScreen, Both, File

Outputs

System.String