zw008/VMware-NSX

> **Author**: Wei Zhou, VMware by Broadcom — wei-wz.zhou@broadcom.com
> This is a community-driven project by a VMware engineer, not an official VMware product.
> For official VMware developer tools see developer.broadcom.com.
English | 中文
VMware NSX networking management: segments, gateways, NAT, routing, IPAM — 33 MCP tools, domain-focused.
> NSX Policy API skill for NSX-T 3.0+ and NSX 4.x.
Companion Skills
| Skill | Scope | Tools | Install |
|-------|-------|:-----:|---------|
| **vmware-aiops** ⭐ entry point | VM lifecycle, deployment, guest ops, clusters | 49 | uv tool install vmware-aiops |
| **vmware-monitor** | Read-only monitoring, alarms, events, VM info | 27 | uv tool install vmware-monitor |
| **vmware-storage** | Datastores, iSCSI, vSAN | 11 | uv tool install vmware-storage |
| **vmware-vks** | Tanzu Namespaces, TKC cluster lifecycle | 20 | uv tool install vmware-vks |
| **vmware-nsx-security** | DFW microsegmentation, security groups, Traceflow | 21 | uv tool install vmware-nsx-security |
| **vmware-aria** | Aria Ops metrics, alerts, capacity planning | 28 | uv tool install vmware-aria |
| **vmware-avi** | AVI/NSX ALB load balancing, AKO | 28 | uv tool install vmware-avi |
| **vmware-harden** | Compliance baselines, drift detection | 6 | uv tool install vmware-harden |
Quick Install
Offline / Air-Gapped Install (from source)
This project uses the modern PEP 517 build system (hatchling), so there is **no
setup.py** by design — that is expected, not a missing file. If you cloned the
source and hit ERROR: File "setup.py" or "setup.cfg" not found ... editable mode
currently requires a setuptools-based build, your pip is older than 21.3 and
cannot do an *editable* (-e) install with a non-setuptools backend. Editable
mode is a developer convenience, not needed to run the tool — do one of:
For a **truly air-gapped host**, build the wheels on a connected machine and copy
them over — the target then needs no network:
Configuration
What This Skill Does
| Category | Tools | Count | Read / Write |
|----------|-------|:-----:|:------------:|
| **Segments** | list, get, create, update, delete | 5 | 2R / 3W |
| **Tier-0 Gateways** | list, get, BGP neighbors, configure BGP | 4 | 3R / 1W |
| **Tier-1 Gateways** | list, get, create, update, delete | 5 | 2R / 3W |
| **NAT** | list, create, delete | 3 | 1R / 2W |
| **Static Routes** | list, create, delete | 3 | 1R / 2W |
| **IP Pools** | list, usage, create, delete | 4 | 2R / 2W |
| **Fabric Inventory** | transport zones, transport nodes, edge clusters | 3 | 3R / 0W |
| **Health & Troubleshooting** | alarms, transport node status, edge cluster status, manager status, port status, VM-to-segment | 6 | 6R / 0W |
**Total**: 33 tools (20 read-only + 13 write)
Common Workflows
Create an App Network (Segment + T1 Gateway + NAT)
1. Create gateway: vmware-nsx gateway create-t1 app-t1 --edge-cluster edge-cluster-01 --tier0 tier0-gw
2. Create segment: vmware-nsx segment create app-web-seg --name app-web-seg --tz --subnet 10.10.1.1/24
3. Add SNAT: vmware-nsx nat create app-t1 --action SNAT --source 10.10.1.0/24 --translated 172.16.0.10
4. Verify: vmware-nsx segment list and vmware-nsx nat list app-t1
Use --dry-run to preview any write command first.
Check Network Health
1. Manager status: vmware-nsx health manager-status
2. Transport nodes: vmware-nsx health transport-nodes
3. Edge clusters: vmware-nsx health edge-clusters
4. Alarms: vmware-nsx health alarms --severity HIGH (exact-match filter; query each severity separately)
Troubleshoot VM Connectivity
1. Find VM's segment: vmware-nsx troubleshoot vm-segment
2. Check port realized state: vmware-nsx troubleshoot port-status (all ports on the segment: attachment, realized bindings, transport nodes)
3. Check routes: vmware-nsx gateway routes-t1 app-t1