Studio Project workflows for VMware NSX segments, gateways, and distributed firewalling
VMware NSX is Broadcom's network virtualization and security platform, providing software-defined networking (segments, gateways, routing), distributed and gateway firewalling, load balancing, VPN, and DHCP/DNS services across on-premises and cloud environments. The NSX Policy API is the current, declarative REST API surface for managing all of this centrally through NSX Manager.
| Asset | Description |
|---|---|
| OpenAPIs/ | VMware NSX Policy API Integration Model |
| Studio Projects/VMware NSX Policy | 24 workflows covering common CRUD automation |
| Requirement | Version |
|---|---|
| Itential Platform | 6.x |
| VMware NSX | 9.1.x |
Import vmware_nsx_policy-latest.json as an Integration Model in Admin > Integrations, then create an integration instance pointing at your NSX Manager.
Authentication is HTTP Basic:
Authorization: Basic <base64(username:password)> The instance's authentication/server properties should look like this once configured:
{
"authentication": {
"basicAuth": {
"username": "<your-nsx-username>",
"password": "<your-nsx-password>"
}
},
"server": {
"protocol": "https",
"host": "<nsx-manager-host>",
"base_path": "/policy/api/v1"
}
} | Spec | Version | Operations | Description |
|---|---|---|---|
vmware_nsx_policy-latest.json | latest (curated) | 976 | Trimmed to 976 of 3740 upstream operations covering common network virtualization automation |
vmware_nsx_policy-9.1.1.0.json | 9.1.1.0 | 3740 | Full NSX Policy API, officially published by Broadcom |
vmware_nsx_policy-latest.jsonActively-maintained spec (x-vendor-api-version: 9.1.1.0), converted to OpenAPI 3.0 from the vendor's native Swagger 2.0 spec. Trimmed to 976 of 3740 upstream operations. The full upstream spec also covers federation/multi-site management, Kubernetes/container networking, malware prevention and IDS/IPS, endpoint protection, licensing, user/role administration, system health and diagnostics, upgrade orchestration, and a long tail of per-protocol statistics/status/table read endpoints (ARP tables, forwarding tables, tunnel status, etc.) — none of those are included here.
Resources included, by category:
vmware_nsx_policy-9.1.1.0.jsonFull spec (3740 operations), sourced directly from Broadcom's official vmware/vcf-api-specs GitHub repository (specifications/nsx/openapi-2.0/nsx_policy_api.yaml). Preserved as published in its native Swagger 2.0 format, per this repo's convention of keeping the dated full spec exactly as the vendor published it. See vmware_nsx_policy-latest.json above for the curated OpenAPI 3.0 subset if you just need common network virtualization automation.
Backed by the VMware NSX Policy:latest Integration Model (see vmware_nsx_policy-latest.json above). The project contains 24 workflows organized into 6 folders, one atomic workflow per API operation, covering the common-CRUD subset of the curated spec (single-site /infra paths, not the multi-site /global-infra federation surface).
| Folder | Workflows | Scope |
|---|---|---|
| Segments | List, Get, Create, Delete Segment | Segment lifecycle |
| Tier-0 Gateways | List, Get, Create, Delete Tier-0 Gateway | Tier-0 gateway lifecycle |
| Tier-1 Gateways | List, Get, Create, Delete Tier-1 Gateway | Tier-1 gateway lifecycle |
| Groups | List, Get, Create, Delete Group | Group CRUD |
| Gateway Firewall Rules | List, Get, Create, Delete Gateway Firewall Rule | Gateway firewall rule CRUD |
| NAT Rules | List, Get, Create, Delete NAT Rule | Tier-1 NAT rule CRUD |
| Dependency | Notes |
|---|---|
VMware NSX Policy:latest Integration Model | Import from vmware_nsx_policy-latest.json before importing the project |
VMware NSX Policy integration instance | Create in Admin > Integrations with the connection properties above. Workflows are wired to an integration instance named VMware NSX Policy — update the adapter_id value in each workflow task if yours is named differently |