Project

PowerBGInfo

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

Stars 312
Forks 27
PowerShell Gallery downloads 612,914
Release v2.0.3
Language: C# Updated: 2026-09-02

API Reference

Command

New-BGInfoTopologyGroup

Namespace PowerBGInfo
Inputs
None
Outputs
ChartForgeX.Topology.TopologyGroup

Creates a BGInfo topology group definition.

Remarks

Creates a BGInfo topology group definition.

Examples

Authored help example

EXAMPLE 1


New-BGInfoTopologyGroup -Color '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

New-BGInfoTopologyGroup [-Color <String>] -Id <String> -Label <String> [-Status <Healthy|Warning|Critical|Unknown|Disabled>] [-Subtitle <String>] [-Symbol <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Color String optionalposition: namedpipeline: False
Optional group accent color as CSS hex.
Id String requiredposition: 0pipeline: False
Stable group identifier.
Label String requiredposition: 1pipeline: False
Group label rendered in the topology.
Status TopologyHealthStatus optionalposition: namedpipeline: Falsevalues: 5
Group health or state.
Possible values: Healthy, Warning, Critical, Unknown, Disabled
Subtitle String optionalposition: namedpipeline: False
Optional group subtitle.
Symbol String optionalposition: namedpipeline: False
Short symbol rendered near the group header.

Outputs

ChartForgeX.Topology.TopologyGroup