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-BGInfoTopologyEdge

Namespace PowerBGInfo
Inputs
None
Outputs
ChartForgeX.Topology.TopologyEdge

Creates a BGInfo topology edge definition.

Remarks

Creates a BGInfo topology edge definition.

Examples

Authored help example

EXAMPLE 1


New-BGInfoTopologyEdge -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-BGInfoTopologyEdge [-Color <String>] [-Direction <Forward|Backward|Bidirectional>] [-Id <String>] [-Kind <Generic>] [-Label <String>] [-Muted] [-Routing <Straight|Curved|Orthogonal|ObstacleAvoidingOrthogonal>] -SourceNodeId <String> [-Status <Healthy|Warning|Critical|Unknown|Disabled>] -TargetNodeId <String> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Color String optionalposition: namedpipeline: False
Optional edge color as CSS hex.
Direction VisualLinkDirection optionalposition: namedpipeline: Falsevalues: 3
Direction marker behavior.
Possible values: Forward, Backward, Bidirectional
Id String optionalposition: namedpipeline: False
Stable edge identifier. When omitted, one is derived from source and target ids.
Kind TopologyEdgeKind optionalposition: namedpipeline: Falsevalues: 12
Relationship kind.
Possible values: Generic, Link, Replication, Connectivity, Dependency, Trust, Mapping, AuthenticationPath, CertificateChain, DataFlow, Ownership, Membership
Label String optionalposition: 2pipeline: False
Primary edge label.
Muted SwitchParameter optionalposition: namedpipeline: False
Render the edge as a quiet structural relationship.
Routing TopologyEdgeRouting optionalposition: namedpipeline: Falsevalues: 4
Edge routing mode.
Possible values: Straight, Curved, Orthogonal, ObstacleAvoidingOrthogonal
SourceNodeId String requiredposition: 0pipeline: False
Source node identifier.
Status TopologyHealthStatus optionalposition: namedpipeline: Falsevalues: 5
Relationship health or state.
Possible values: Healthy, Warning, Critical, Unknown, Disabled
TargetNodeId String requiredposition: 1pipeline: False
Target node identifier.

Outputs

ChartForgeX.Topology.TopologyEdge