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

New-BGInfoTopologyNode

Namespace PowerBGInfo
Inputs
None
Outputs
ChartForgeX.Topology.TopologyNode

Creates a BGInfo topology node definition.

Remarks

Creates a BGInfo topology node definition.

Examples

Authored help example

EXAMPLE 1


New-BGInfoTopologyNode -Badge '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-BGInfoTopologyNode [-Badge <String>] [-Color <String>] [-DisplayMode <Card>] [-GroupId <String>] -Id <String> [-Kind <Generic>] -Label <String> [-Status <Healthy|Warning|Critical|Unknown|Disabled>] [-Subtitle <String>] [-Symbol <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Badge String optionalposition: namedpipeline: False
Optional badge text.
Color String optionalposition: namedpipeline: False
Optional node accent color as CSS hex.
DisplayMode TopologyNodeDisplayMode optionalposition: namedpipeline: Falsevalues: 8
Optional node display mode override.
Possible values: Card, CompactCard, Tile, Pill, Icon, Artwork, Dot, Hidden
GroupId String optionalposition: namedpipeline: False
Optional parent group identifier.
Id String requiredposition: 0pipeline: False
Stable node identifier used by topology edges.
Kind TopologyNodeKind optionalposition: namedpipeline: Falsevalues: 21
Node kind used for icon and legend selection.
Possible values: Generic, Group, Location, Hub, Branch, Server, Service, Endpoint, Gateway, Cloud, Database, Storage, Network, NetworkSegment, Namespace, Application, Process, Queue, Person, Team, Certificate
Label String requiredposition: 1pipeline: False
Node label rendered in the topology.
Status TopologyHealthStatus optionalposition: namedpipeline: Falsevalues: 5
Node health or state.
Possible values: Healthy, Warning, Critical, Unknown, Disabled
Subtitle String optionalposition: namedpipeline: False
Optional node subtitle.
Symbol String optionalposition: namedpipeline: False
Short symbol rendered inside or near the node icon.

Outputs

ChartForgeX.Topology.TopologyNode