VMware NSX API Guide
Table of Contents
Overview
All Methods
API Methods
API Usage
User Authentication
Federation
Federation Configuration
Full Synchronization
Global Managers
Inter-Sites
Observability
Security
East West Security
Distributed Firewall
Settings
Distributed Firewall Settings
Sites
Management Plane API
Associations
Grouping Objects
IP Sets
MAC Sets
NS Groups
NS Profiles
NS Service Groups
NS Services
Monitoring
NSX Component Administration
Appliance Management
Networking
Logical Bridging
Bridge Endpoint Profiles
Bridge Endpoints
Logical Routing And Services
BFD Peers
Logical Router Ports
Logical Routers
NAT
Routing BFD Configuration
Routing Configuration
Logical Switching
Logical Switch Ports
Logical Switches
Services
DHCP
DHCP Relay
DHCP Relay Profiles
DNS
Loadbalancer
Metadata Proxy
VPN
IPSEC
DPD Profiles
IKE Profiles
Peer Endpoints
Services
Sessions
Tunnel Profiles
L2VPN
Services
Sessions
Statistics
IKE Service
IKE Sessions Status
IPSEC Reset Sessions Statistics
IPSEC Sessions Statistics
IPSEC Sessions Summary
L2VPN Remote MACS
L2VPN Session Statistics
L2VPN Session Status
L2VPN Sessions Summary
Normalization
Security
Identity Firewall
Configuration
Monitoring
Realization Data
Intrusion Services
Dashboard
IDS Profiles
Malware Prevention
Service Configuration
Services
Firewall
Service Insertion
Troubleshooting And Monitoring
Healthcheck
IPFIX
Livetrace
Packet Capture
Port Connection
Port Mirroring
Traceflow
NSX Application Platform
Deployment
Bundle
Status
Platform
Config
Form Factors
Status
Storageclass
Versions
Registry
Tools
Bundle
Upload
Upgrade
Coordinator
Check
Status
Versions
Kubeconfig
Kubernetes
Tools
Platform
Host Agent
Tools
Bundle
Upload
Registration
Upgrade
Coordinator
Config
Status
Policy
Feature Flag
Aggregated Feature State
Aggregated Feature State Details
Infra
Certificates
CSR
Certificates
Certification Revocation List
Constraints
Deployment Zones
Domains
Domain
Domain Deployment Maps
Enforcement Points
Hierarchical API
Labels
Monitoring
Realized State
Inventory
Containers
Container Applications
Container Clusters
Container Projects
Groups
Group Members
Groups
Profiles
Context Profiles
L7 Access Profiles
Static MIME Content
Services
Tags
Virtual Interfaces
Virtual Machines
Virtual Switches
Vm
Monitoring
Capacity Dashboard
Compliance
Finetuning
Heatmap
IPFIX
Firewall IPFIX Collectors
Firewall IPFIX Profiles
Switch IPFIX Collectors
Switch IPFIX Profiles
LLDP
Latency
Livetrace
Online Diagnostic System
Port Mirroring
System Health Agent
Appliance
Monitor
Profile
Traceflow
Multi Tenancy
NSX VPC
Connectivity
Static Routes
Subnet
DHCP
Statistics
IP Management
Interfaces
Statistics
Port
Statistics
Statistics
IP Allocations
Network Services
NAT
Security
E-W Firewall
Groups
Group Members
N-S Firewall
Tags
VPC
Virtual Machines
Org
Org Root
Project
Quota
Shared Resource
Networking
Connectivity
Routing
Prefix List
Project Route Filters
Tier-0 Gateways
Segments
Bridge Endpoints
Statistics
Edge Bridge Profiles
MAC Table
Ports
MAC Table
State
Statistics
Status
Segment Connection Binding Map
Segment Profiles
Discovery Profile Binding
IP Discovery Profiles
MAC Discovery Profiles
Monitoring Profile Binding
QOS Profile Binding
QOS Profiles
Security Profile Binding
Segment Security Profile Binding
Segment Security Profiles
Spoofguard Profiles
Segments
Segments (Fixed)
Service Segments
State
Statistics
TEP Table
Tier-0 Gateways
ARP Proxies
EVPN Setting
EVPN Configuration
EVPN Tunnel Endpoints
Interface Groups
Interfaces
ARP Proxies
ARP Table
DAD State
Interfaces
Statistics
Multicast
Routing
BGP
Community Lists
Forwarding Table
Inter Vrf
Inter-Vrf-Routing
OSPF
Prefix List
Route Maps
Routing Table
State
Static Routes
Static Routes BFD Peers
Static Routes Troubleshoot Properties
Tier-0 Deployment Maps
Tier-0 Gateways
Tier-0 Locale Services
Tunnels
Tier-1 Gateways
ARP Proxies
Interface Groups
Interfaces
ARP Proxies
ARP Table
DAD State
Interfaces
Statistics
Multicast
Routing
Forwarding Table
State
Static Routes
Tier-1 Gateways
Tier-1 Locale Services
Transport Zones
IP Management
DHCP
DHCP Leases
DHCP Relay Configs
DHCP Server Configs
DHCP Static Bindings
Segments Bindings
Segments Bindings (Fixed)
DNS
DNS Forwarder
DNS Zones
Tier-0 Gateways
Tier-1 Gateways
IP Address Pools
IP Blocks
IP Pools
Manager IP Pools
Network Services
Forwarding Policies
Rules
Statistics
Statistics
Load Balancing
Load Balancer Pools
Load Balancer Profiles
Load Balancer Application Profiles
Load Balancer Monitor Profiles
Load Balancer Persistence Profiles
Load Balancer SSL Profiles
Load Balancer Client SSL Profiles
Load Balancer SSL Ciphers And Protocols
Load Balancer Server SSL Profiles
Load Balancer Services
Load Balancer Usage
Statistics
Status
Usage
Load Balancer Virtual Servers
Metadata Proxy
Status
NAT
Rules
Tier-0 Gateways
Tier-1 Gateways
Statistics
VPN
IPSEC
DPD Profiles
IKE Profiles
IPSEC Profiles
Local Endpoints
Services
Sessions
Summary
Statistics
Status
L2VPN
Remote-Mac
Services
Sessions
Statistics
Status
Networking Profiles
BFD Profiles
Constraint Global Configuration
EVPN Tenant Configuration
EVPN VNI Pools
Gateway QOS Profiles
Global Gateway Configuration
IPV6 DAD Profiles
IPV6 NDRA Profiles
Multicast Profiles
Transport Zone Profiles
Sandboxing
Security
East West Security
Distributed Firewall
Communication Maps
Container Cluster
IP Reputation
Rules
Settings
Distributed Firewall Settings
Drafts
Exclusion List
Firewall Identity Store
Event-Log-Server
Groups
LDAP Servers
Ldap-Server
Users
Firewall Scheduler
Identity Firewall Settings
Statistics
Task
Distributed IDS
Settings
Signatures
Endpoint Protection
Rules
Ids-Ips And Malware
Dashboard
Intrusion Services
Profiles
Rules
Statistics
Settings
Enablement
Signatures
Statistics
North South Security
Gateway Firewall
Rules
Settings
Firewall Configuration
Security Configuration
Statistics
Tier-0 Gateways
Tier-1 Gateways
Tls Inspection
Tls Profiles
Tls Rules
Tls State
Url Categorization
Security Profiles
Cpu Memory Thresholds Profiles
DNS Security Profile Bindings
DNS Security Profiles
Flood Protection Profile Binding
Flood Protection Profiles
Monitoring Profile Binding
Session Timer Profile Binding
Session Timer Profile Bindings
Session Timer Profiles
Service Insertion
Partner Services
Redirection Policies
Service Chains
Service Definitions
Service Instances
Tier-0 Gateways
Tier-1 Gateways
Service References
Settings
Configuration Status
Exclusion List
Statistics
Virtual Endpoints
Tier-0 Gateways
Tier-1 Gateways
Search
Search API
System Administration
Configuration
Directory Service
Domains
Event-Log-Server
Groups
LDAP Servers
Fabric
Associations
Cloud Native Service Instances
Compute Collections
Compute Managers
Edge Clusters
Edge Clusters
Failure Domains
Nodes
Certificates
Cluster Control Planes
DNS
Discovered Nodes
Fabric Nodes
File Store
Hardening
Mandatory Access Control
LLDP
Logs
NSX Edge
Dataplane
Diagnosis
Manager Configuration
Nestdb
Services
DHCP
DHCP Service
Docker
Ipsecvpn Service
Local-Controller
Maintenance Mode
NSX Ops Agent Service
Routing
Security-Hub
VPN
NSX Manager
Management Plane
Manager Configuration
Manager Network Interfaces
Services
Async Replicator Service
Cluster Manager Service
Cm Inventory Service
Controller Service
Corfu Server
Dispatcher Service
HTTP Service
Idps Reporting Service
Install Upgrade Service
Local-Controller Service
Manager Service
Messaging Manager Service
Metadata Proxy Service
Migration Coordinator Service
NSX Control Plane Agent Service
Node Stats Service
Policy Service
Search Service
Site Manager Service
Telemetry Service
User Interface Service
Network Interfaces
Routing
Physical Servers
Services
Log Insight
NSX Message Service
NSX Platform Client
NTP
Node Management
SNMP
SSH
Syslog
Tasks
Upgrade Agent
Settings
Support-Bundle
Transport Node Collections
Transport Node Interfaces
Transport Node Status
Transport Node Tunnels
Transport Nodes
User Management
Authentication Policy
Users
Pool Management
IP Blocks
IP Pools
MAC Pools
VNI Pools
VTEP Label Pools
Profiles
Cluster Profiles
Host Transport Node Profiles
Hostswitch Profiles
Transport Node Profiles
Transport Zone Profiles
Transport Zones
Global Configurations
Grub
NSX Advanced Load Balancer
Controller
Alb Auth Token
Alb Onboarding Workflow
Alb Portal Certificate
Alb System Config
Alb User Credential
Cluster
Cluster Config
Deployments
Form Factors
Password Check
NSX Intelligence
Form Factors
Repository
Bundles
NSX Managers
API Services
API Request Batching
Configuration
Task Management
Clusters
Cluster Certificate
Cluster Configuration
Cluster Interfaces
Cluster Node Deployments
Cluster Status
Cluster Virtual IP
Manager Configuration
Manager Mode
Nodes
Manager Configuration
Services
Async Replicator Service
Auth Service
NSX Partial Patch
Nodes
Manager Configuration
Site Management
System Properties
Dataplane
IPSEC Sessions
Mpa Configuration
Realization State Barrier
Lifecycle Management
Backup Restore Management
Backup
Restore
Migration
Mp2P Migration
Plan
NVDS
Overlay Adoption
Assessment
Inventory
Workflows
V2T Migration
Feedback
Group
Infra
Migration Units
Nodes
Plan
Setup
Stats
Status
User Inputs
Vmgroup
Mp Policy Migration
Configuration
Upgrade
Bundles
Eula
Group
History
Host
Nodes
Plan
Status
UI
Upgrade Coordinator
Upgrade Units
Monitoring
Alarms And Events
Dashboards
Capacity Dashboard
UI Views
Widget Configuration
Error Resolver
Health Checks
Health Performance Monitoring
Latency Profiles
Logs
Audit Logs
Core Dumps
NSX Manager Health
Notifications
System Health
Appliance
Process
Container
Antrea
Plugins
Profiles
Settings
Certificates
CRL
CSR
Certificate
Customer Experience Improvement
Telemetry
Licenses
Proxy Settings
Support Bundle
User Management
Access Token
LDAP Identity Sources
Principal Identity
Roles
Users
VIDM Configuration
API Types
API Type Schemas
API Errors
Deprecated Methods
Deprecated Types
Removed Methods
Removed Types
Single paged API guide