API Reference
Command
New-ImageTopologyGroup
Creates a topology group definition.
Remarks
Use this cmdlet inside New-ImageTopology to describe a logical region or cluster.
Examples
Create a site group
PS>
New-ImageTopologyGroup -Id site-a -Label 'Site A' -Status Healthy -Symbol region
Creates a ChartForgeX topology group that can contain topology nodes.
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-ImageTopologyGroup [-Color <String>] [-Height <Double>] [-Href <String>] [-IconId <String>] -Id <String> -Label <String> [-Latitude <Double>] [-LayoutPolicy <Auto>] [-Longitude <Double>] [-Status <Healthy|Warning|Critical|Unknown|Disabled>] [-Subtitle <String>] [-Symbol <String>] [-Tooltip <String>] [-Width <Double>] [-X <Double>] [-Y <Double>] [<CommonParameters>]#Parameter set:
All Parameter SetsParameters
- Color String
- Optional group accent color as a CSS hex color.
- Height Double
- Group height in pixels.
- Href String
- Optional drill-down link for SVG and HTML outputs.
- IconId String
- Reusable ChartForgeX icon identifier.
- Id String
- Stable group identifier.
- Label String
- Group label rendered in the diagram.
- Latitude Double
- Optional group latitude for geographic layouts.
- LayoutPolicy TopologyGroupLayoutPolicy
- Preferred node arrangement policy for dense grouped layouts.
- Possible values:
Auto,HubAndBranch,Grid,PairRows,MiniMesh,CollapsedDots - Longitude Double
- Optional group longitude for geographic layouts.
- Status TopologyHealthStatus
- Group health or state.
- Possible values:
Healthy,Warning,Critical,Unknown,Disabled - Subtitle String
- Optional group subtitle.
- Symbol String
- Short symbol rendered near the group header.
- Tooltip String
- Optional tooltip for SVG and HTML outputs.
- Width Double
- Group width in pixels.
- X Double
- Manual X coordinate. Automatic layouts can ignore this value.
- Y Double
- Manual Y coordinate. Automatic layouts can ignore this value.
Outputs
ChartForgeX.Topology.TopologyGroup