# c-wilkinson/vcd-nsxforge architecture

> Architecture diagram of the GitHub repository c-wilkinson/vcd-nsxforge, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/c-wilkinson/vcd-nsxforge
- Repository: https://github.com/c-wilkinson/vcd-nsxforge

## Overview

VCD-NSXForge is an experimental PowerShell 5.1 WinForms tool for network and security engineers managing NSX firewall rules, IP sets, and manual IP reservations in VMware Cloud Director. Its documented workflow is a native UI over application use cases, with live read operations against VCD and safer change planning; the built-in simulator supports offline work. The README describes the main layers but provides no source excerpts, so component-to-component links below are conservative and marked unverified where the exact runtime calls cannot be established.

Main entry points: [`src/Application/VcdRead/VcdReadOperation.psm1`](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/VcdRead/VcdReadOperation.psm1) (VCD read workflow), [`src/Presentation/WinForms/MainForm.psm1`](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Presentation/WinForms/MainForm.psm1) (WinForms UI), [`src/Application/Editing/NetworkWorkspace.psm1`](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/Editing/NetworkWorkspace.psm1) (Draft workspace), [`src/Application/Planning/OfflinePlan.psm1`](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/Planning/OfflinePlan.psm1) (Offline planning)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_presentation["User interface"]
  node_winforms["WinForms UI<br/>[MainForm.psm1]"]
  node_editor["Network editor"]
  node_ui_state["UI state<br/>[UiState.psm1]"]
end

subgraph group_application["Application workflows"]
  node_editing["Network editing"]
  node_workspace["Draft workspace"]
  node_planning["Offline planning<br/>[OfflinePlan.psm1]"]
  node_vcd_read["VCD read workflow"]
  node_discovery["VCD discovery<br/>[VcdDiscovery.psm1]"]
  node_snapshot["Read snapshots<br/>[VcdSnapshot.psm1]"]
end

subgraph group_domain["Domain logic"]
  node_state_model["Network state model<br/>[StateModel.psm1]"]
  node_policy_model["VCD policy model"]
  node_plan_logic["Plan logic<br/>[Planning.psm1]"]
  node_capabilities["Capability evaluation"]
  node_topology["Topology policy"]
  node_traffic["Traffic analysis<br/>[Traffic.psm1]"]
end

subgraph group_infrastructure["Infrastructure"]
  node_state_repo[("State persistence")]
  node_vcd_api["VCD API client<br/>[VcdApi.psm1]"]
  node_simulator["Offline simulator"]
end

subgraph group_runtime["Runtime"]
  node_dispatcher["Worker dispatcher<br/>[Dispatcher.psm1]"]
  node_launcher["Application launcher"]
end

node_engineer(("Network engineer"))
node_vcd["VMware Cloud Director"]

node_engineer -.->|"uses"| node_winforms
node_winforms -.->|"starts workflows"| node_editing
node_winforms -.->|"starts reads"| node_vcd_read
node_editor -.->|"edits drafts"| node_workspace
node_editing -.->|"uses model"| node_state_model
node_workspace -.->|"persists state"| node_state_repo
node_planning -.->|"plans changes"| node_plan_logic
node_vcd_read -.->|"discovers resources"| node_discovery
node_vcd_read -.->|"produces snapshots"| node_snapshot
node_vcd_read -.->|"reads from"| node_vcd_api
node_vcd_api -.->|"calls API"| node_vcd
node_planning -.->|"plans drafts"| node_workspace
node_launcher -.->|"launches UI"| node_winforms
node_dispatcher -.->|"dispatches work"| node_vcd_read
node_simulator -.->|"uses state"| node_state_repo

click node_winforms "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Presentation/WinForms/MainForm.psm1"
click node_editor "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Presentation/WinForms/NetworkEditorForm.psm1"
click node_ui_state "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Presentation/Controllers/UiState.psm1"
click node_editing "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/Editing/NetworkEditing.psm1"
click node_workspace "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/Editing/NetworkWorkspace.psm1"
click node_planning "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/Planning/OfflinePlan.psm1"
click node_vcd_read "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/VcdRead/VcdReadOperation.psm1"
click node_discovery "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/VcdRead/VcdDiscovery.psm1"
click node_snapshot "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/VcdRead/VcdSnapshot.psm1"
click node_state_model "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/State/StateModel.psm1"
click node_policy_model "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/State/VcdPolicyModel.psm1"
click node_plan_logic "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/Planning/Planning.psm1"
click node_capabilities "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/Capabilities/VcdCapabilityEvaluation.psm1"
click node_topology "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/Topology/TopologyPolicy.psm1"
click node_traffic "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/Traffic/Traffic.psm1"
click node_state_repo "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Infrastructure/State/StateRepository.psm1"
click node_vcd_api "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Infrastructure/VcdApi/VcdApi.psm1"
click node_simulator "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Infrastructure/Simulator/SimulatorServer.psm1"
click node_dispatcher "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Runtime/Dispatcher.psm1"
click node_launcher "https://github.com/c-wilkinson/vcd-nsxforge/blob/main/Start-VcdNetworkManager.ps1"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_winforms,node_editor,node_ui_state toneBlue
class node_editing,node_workspace,node_planning,node_vcd_read,node_discovery,node_snapshot toneAmber
class node_state_model,node_policy_model,node_plan_logic,node_capabilities,node_topology,node_traffic toneMint
class node_state_repo,node_vcd_api,node_simulator toneRose
class node_dispatcher,node_launcher,node_engineer,node_vcd toneIndigo
```

## Components

### User interface

- [WinForms UI](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Presentation/WinForms/MainForm.psm1): `src/Presentation/WinForms/MainForm.psm1`
- [Network editor](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Presentation/WinForms/NetworkEditorForm.psm1): `src/Presentation/WinForms/NetworkEditorForm.psm1`
- [UI state](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Presentation/Controllers/UiState.psm1): `src/Presentation/Controllers/UiState.psm1`

### Application workflows

- [Network editing](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/Editing/NetworkEditing.psm1): `src/Application/Editing/NetworkEditing.psm1`
- [Draft workspace](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/Editing/NetworkWorkspace.psm1): `src/Application/Editing/NetworkWorkspace.psm1`
- [Offline planning](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/Planning/OfflinePlan.psm1): `src/Application/Planning/OfflinePlan.psm1`
- [VCD read workflow](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/VcdRead/VcdReadOperation.psm1): `src/Application/VcdRead/VcdReadOperation.psm1`
- [VCD discovery](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/VcdRead/VcdDiscovery.psm1): `src/Application/VcdRead/VcdDiscovery.psm1`
- [Read snapshots](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Application/VcdRead/VcdSnapshot.psm1): `src/Application/VcdRead/VcdSnapshot.psm1`

### Domain logic

- [Network state model](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/State/StateModel.psm1): `src/Domain/State/StateModel.psm1`
- [VCD policy model](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/State/VcdPolicyModel.psm1): `src/Domain/State/VcdPolicyModel.psm1`
- [Plan logic](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/Planning/Planning.psm1): `src/Domain/Planning/Planning.psm1`
- [Capability evaluation](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/Capabilities/VcdCapabilityEvaluation.psm1): `src/Domain/Capabilities/VcdCapabilityEvaluation.psm1`
- [Topology policy](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/Topology/TopologyPolicy.psm1): `src/Domain/Topology/TopologyPolicy.psm1`
- [Traffic analysis](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Domain/Traffic/Traffic.psm1): `src/Domain/Traffic/Traffic.psm1`

### Infrastructure

- [State persistence](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Infrastructure/State/StateRepository.psm1): `src/Infrastructure/State/StateRepository.psm1`
- [VCD API client](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Infrastructure/VcdApi/VcdApi.psm1): `src/Infrastructure/VcdApi/VcdApi.psm1`
- [Offline simulator](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Infrastructure/Simulator/SimulatorServer.psm1): `src/Infrastructure/Simulator/SimulatorServer.psm1`

### Runtime

- [Worker dispatcher](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/src/Runtime/Dispatcher.psm1): `src/Runtime/Dispatcher.psm1`
- [Application launcher](https://github.com/c-wilkinson/vcd-nsxforge/blob/main/Start-VcdNetworkManager.ps1): `Start-VcdNetworkManager.ps1`

### Other components

- **Network engineer**
- **VMware Cloud Director**

## Connections

- Network engineer → WinForms UI: uses (evidence: `README.md`)
- WinForms UI → Network editing: starts workflows (evidence: `README.md`)
- WinForms UI → VCD read workflow: starts reads (evidence: `README.md`)
- Network editor → Draft workspace: edits drafts (evidence: `README.md`)
- Network editing → Network state model: uses model (evidence: `README.md`)
- Draft workspace → State persistence: persists state (evidence: `README.md`)
- Offline planning → Plan logic: plans changes (evidence: `README.md`)
- VCD read workflow → VCD discovery: discovers resources (evidence: `README.md`)
- VCD read workflow → Read snapshots: produces snapshots (evidence: `README.md`)
- VCD read workflow → VCD API client: reads from (evidence: `README.md`)
- VCD API client → VMware Cloud Director: calls API (evidence: `README.md`)
- Offline planning → Draft workspace: plans drafts (evidence: `README.md`)
- Application launcher → WinForms UI: launches UI (evidence: `README.md`)
- Worker dispatcher → VCD read workflow: dispatches work (evidence: `README.md`)
- Offline simulator → State persistence: uses state (evidence: `README.md`)
