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

Export-BGInfoConfiguration

Namespace PowerBGInfo
Inputs
PowerBGInfo.BgInfoConfiguration
Outputs
System.String

Exports a BGInfo configuration to JSON.

Remarks

Writes a JSON file compatible with Invoke-BGInfo and the CLI.

Examples

Authored help example

EXAMPLE 1


Export-BGInfoConfiguration -InputObject 'Value'

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

Export-BGInfoConfiguration [-Force] -InputObject <BgInfoConfiguration> [-PassThru] -Path <String> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Force SwitchParameter optionalposition: namedpipeline: False
Overwrite the output file if it exists.
InputObject BgInfoConfiguration requiredposition: namedpipeline: True (ByValue)
Configuration object to export.
PassThru SwitchParameter optionalposition: namedpipeline: False
Return the output path.
Path String requiredposition: 0pipeline: False
Output path for the JSON configuration file.

Outputs

System.String