NSX API Operations Index
All available NSX API Operations
Aaa
GET
Get Current User Info
Get information about logged-in user
Aggregation Service
GET
Get Aggregation Service Global Config
Read global health performance monitoring configuration
GET
Get Feature Stack Configuration
Read health performance monitoring configuration for feature stack
GET
List Feature Stack Configurations
List all health performance monitoring feature stacks
POST
Reset Aggregation Service Feature Stack Configuration
Reset the data collection frequency configuration setting to the default values
PUT
Update Aggregation Service Global Config
Set the global configuration for aggregation service related data collection
PUT
Update Feature Stack Configuration
Update health performance monitoring configuration for feature stack
Api Services
GET
List Tasks
Get information about all tasks
GET
Read Authentication Policy Properties
Read node authentication policy configuration
GET
Read Task Properties
Get information about the specified task
GET
Read Task Result
Get the response of a task
POST
Register Batch Request
Register a Collection of API Calls at a Single End Point
PUT
Update Authentication Policy Properties
Update node authentication policy configuration
Associations
GET
Get Associations
Get ResourceReference objects to which the given resource belongs to
Error Resolver
GET
Get Error Resolver Info
Fetches metadata about the given error_id
GET
List Error Resolver Info
Fetches a list of metadata for all the registered error resolvers
POST
Resolve Error
Resolves the error
Fabric
POST
Add Node
Register and Install NSX Components on a Node
DELETE
Delete Node
Delete a Node
GET
Get Fabric Node Modules
Get the module details of a Fabric Node
GET
Get Fabric Node State
Get the Realized State of a Fabric Node
GET
List Fabric Node Interfaces
List the specified node's Network Interfaces
GET
List Node Capabilities
Return the List of Capabilities of a Single Node
GET
List Nodes
Return the List of Nodes
GET
List Vifs
Return the List of Virtual Network Interfaces (VIFs)
GET
List Virtual Machines
Return the List of Virtual Machines
POST
Perform Host Node Upgrade Action
Perform a service deployment upgrade on a host node
POST
Perform Node Action
Perform an Action on Fabric Node
GET
Read Fabric Node Interface
Read the node's Network Interface
GET
Read Fabric Node Interface Statistics
Read the NSX Manager's Network Interface Statistics
GET
Read Node
Return Node Information
GET
Read Nodes Status
Return Runtime Status Information for given Nodes
GET
Read Node Status
Return Runtime Status Information for a Node
POST
Restart Inventory Sync
Restart the inventory sync for the node if it's paused currently.
PUT
Update Node
Update a Node
POST
Update Virtual Machine Tags
Update tags applied to a virtual machine
Grouping Objects
POST
Add MAC Address
Add a MAC address to a MACSet
POST
Add Or Remove NS Group Expression
Add NSGroup expression
POST
Create IP Set
Create IPSet
POST
Create MAC Set
Create MACSet
POST
Create NS Group
Create NSGroup
POST
Create NS Service
Create NSService
POST
Create NS Service Group
Create NSServiceGroup
DELETE
Delete IP Set
Delete IPSet
DELETE
Delete MAC Set
Delete MACSet
DELETE
Delete NS Group
Delete NSGroup
DELETE
Delete NS Service
Delete NSService
DELETE
Delete NS Service Group
Delete NSServiceGroup
GET
Get Effective IP Address Members
Get Effective IPAddress translated from the NSGroup
GET
Get Effective Logical Port Members
Get Effective Logical Ports translated from the NSgroup
GET
Get Effective Logical Switch Members
Get Effective switch members translated from the NSGroup
GET
Get MAC Addresses
Get all MACAddresses in a MACSet
GET
List IP Sets
List IPSets
GET
List MAC Sets
List MACSets
GET
List NS Groups
List NSGroups
GET
List NS Service Groups
List all NSServiceGroups
GET
List NS Services
List all NSServices
GET
Read IP Set
Read IPSet
GET
Read MAC Set
Read MACSet
GET
Read NS Group
Read NSGroup
GET
Read NS Service
Read NSService
GET
Read NS Service Group
Read NSServiceGroup
DELETE
Remove MAC Address
Remove a MAC address from given MACSet
PUT
Update IP Set
Update IPSet
PUT
Update MAC Set
Update MACSet
PUT
Update NS Group
Update NSGroup
PUT
Update NS Service
Update NSService
PUT
Update NS Service Group
Update NSServiceGroup
Licensing
POST
Create License
Add a new license key
DELETE
Delete License
Remove a license identified by the license-key
GET
Get License
Deprecated. Return the Enterprise License
GET
Get License By Key
Get license properties for license identified by the license-key
GET
Get Licenses
Get all licenses
PUT
Update License
Deprecated. Assign an Updated Enterprise License Key
Logical Routing And Services
POST
Add Bgp Neighbor
Add a new BGP Neighbor on a Logical Router
POST
Add IP Prefix List
Add IPPrefixList on a Logical Router
POST
Add Nat Rule
Add a NAT rule in a specific logical router
POST
Add Route Map
Add RouteMap on a Logical Router
POST
Add Static Route
Add Static Routes on a Logical Router
POST
Create Dhcp Relay
Create a DHCP Relay Service
POST
Create Dhcp Relay Profile
Create a DHCP Relay Profile
POST
Create Logical Router
Create a Logical Router
POST
Create Logical Router Port
Create a Logical Router Port
POST
Create Service
Create a Logical Router Service
POST
Create Service Profile
Create a Service Profile
POST
Create Static Hop Bfd Peer
Create a static hop BFD peer
DELETE
Delete Bgp Neighbor
Delete a specific BGP Neighbor on a Logical Router
DELETE
Delete Dhcp Relay
Delete a DHCP Relay Service
DELETE
Delete Dhcp Relay Profile
Delete a DHCP Relay Profile
DELETE
Delete IP Prefix List
Delete a specific IPPrefixList on a Logical Router
DELETE
Delete Logical Router
Delete a Logical Router
DELETE
Delete Logical Router Port
Delete a Logical Router Port
DELETE
Delete Nat Rule
Delete a specific NAT rule from a logical router
DELETE
Delete Route Map
Delete a specific RouteMap on a Logical Router
DELETE
Delete Service
Delete a Logical Router Service
DELETE
Delete Service Profile
Delete a Service Profile
DELETE
Delete Static Hop Bfd Peer
Delete a specified static route BFD peer cofigured on a specified logical router
DELETE
Delete Static Route
Delete a specific Static Route on a Logical Router
GET
Get Bgp Neighbors Status
Get the status of all the BGP neighbors for the Logical Router of the given id
GET
Get Logical Router Forwarding Table
Get FIB table on a specified node for a logical router
GET
Get Logical Router Forwarding Table In Csv Format
Get FIB table on a specified node for a logical router
GET
Get Logical Router Port Arp Table
Get the ARP table for the Logical Router Port of the given id
GET
Get Logical Router Port Arp Table In Csv Format
Get the ARP table for the Logical Router Port of the given id
GET
Get Logical Router Port Statistics
Get the statistics of a specified logical router port on all or a specified node
GET
Get Logical Router Port Statistics Summary
Get the statistics summary of a specified logical router port
GET
Get Logical Router Route Table
Get route table on a given node for a logical router
GET
Get Logical Router Route Table In Csv Format
Get route table on a node for a logical router
GET
Get Logical Router Routing Table
Get RIB table on a specified node for a logical router
GET
Get Logical Router Routing Table In Csv Format
Get RIB table on a specified node for a logical router
GET
Get Logical Router Status
Get the status for the Logical Router of the given id
GET
Get Nat Rule
Get a specific NAT rule from a given logical router
GET
Get Nat Statistics Per Logical Router
Get the statistics of all rules of the logical router
GET
Get Nat Statistics Per Rule
Get the statistics of a specified logical router NAT Rule
GET
Get Nat Statistics Per Transport Node
Get statistics for all logical router NAT rules on a transport node
GET
List Bgp Neighbors
Paginated list of BGP Neighbors on a Logical Router
GET
List Dhcp Relay Profiles
List All DHCP Relay Profiles
GET
List Dhcp Relays
List all DHCP Relay Services
GET
List IP Prefix Lists
Paginated List of IPPrefixLists
GET
List Logical Router Ports
List Logical Router Ports
GET
List Logical Routers
List Logical Routers
GET
List Nat Rules
List NAT rules of the logical router
GET
List Route Maps
Paginated List of RouteMaps
GET
List Service Profiles
List All Service Profiles
GET
List Services
List all Logical Router Services
GET
List Static Hop Bfd Peers
List static routes BFD Peers
GET
List Static Routes
Paginated List of Static Routes
GET
Read Advertisement Config
Read the Advertisement Configuration on a Logical Router
GET
Read Advertise Rule List
Read the Advertisement Rules on a Logical Router
GET
Read Bgp Config
Read the BGP Configuration on a Logical Router
GET
Read Bgp Neighbor
Read a specific BGP Neighbor on a Logical Router
GET
Read Debug Info
Read the debug information for the logical router
GET
Read Dhcp Relay
Read a DHCP Relay Service
GET
Read Dhcp Relay Profile
Read a DHCP Relay Profile
GET
Read IP Prefix List
Get a specific IPPrefixList on a Logical Router
GET
Read Logical Router
Read Logical Router
GET
Read Logical Router Port
Read Logical Router Port
GET
Read Redistribution Config
Read the Redistribution Configuration on a Logical Router
GET
Read Redistribution Rule List
Read All the Redistribution Rules on a Logical Router
GET
Read Route Map
Get a specific RouteMap on a Logical Router
GET
Read Routing Bfd Config
Read the Routing BFD Configuration
GET
Read Routing Config
Read the Routing Configuration
GET
Read Service
Read a Logical Router Service
GET
Read Service Profile
Read a Service Profile
GET
Read Static Hop Bfd Peer
Read a static route BFD peer
GET
Read Static Route
Get a specific Static Route on a Logical Router
POST
Re Process Logical Router
Reprocesses a logical router configuration and publish updates to controller
POST
Un Set Password On Bgp Neighbor
Unset/Delete password property on specific BGP Neighbor on Logical Router
PUT
Update Advertisement Config
Update the Advertisement Configuration on a Logical Router
PUT
Update Advertise Rule List
Update the Advertisement Rules on a Logical Router
PUT
Update Bgp Config
Update the BGP Configuration on a Logical Router
PUT
Update Bgp Neighbor
Update a specific BGP Neighbor on a Logical Router
PUT
Update Dhcp Relay
Update a DHCP Relay Service
PUT
Update Dhcp Relay Profile
Update a DHCP Relay Profile
PUT
Update IP Prefix List
Update a specific IPPrefixList on a Logical Router
PUT
Update Logical Router
Update a Logical Router
PUT
Update Logical Router Port
Update a Logical Router Port
PUT
Update Nat Rule
Update a specific NAT rule from a given logical router
PUT
Update Redistribution Config
Update the Redistribution Configuration on a Logical Router
PUT
Update Redistribution Rule List
Update All the Redistribution Rules on a Logical Router
PUT
Update Route Map
Update a specific RouteMap on a Logical Router
PUT
Update Routing Bfd Config
Update the BFD Configuration for BFD peers for routing
PUT
Update Routing Config
Update the Routing Configuration
PUT
Update Service
Update a Logical Router Service
PUT
Update Service Profile
Update a Service Profile
PUT
Update Static Hop Bfd Peer
Update a static route BFD peer
PUT
Update Static Route
Update a specific Static Route Rule on a Logical Router
Logical Switching
POST
Create Logical Port
Create a Logical Port
POST
Create Logical Switch
Create a Logical Switch
POST
Create Switching Profile
Create a Switching Profile
DELETE
Delete Logical Port
Delete a Logical Port
DELETE
Delete Logical Switch
Delete a Logical Switch
DELETE
Delete Switching Profile
Delete a Switching Profile
GET
Get Logical Port
Get Information About a Logical Port
GET
Get Logical Port Operational Status
Get Operational Status for Logical Port of a Given Port ID (lport-id)
GET
Get Logical Port State
Get location of a logical port
GET
Get Logical Port Statistics
Get Statistics for Logical Port of a Given Port ID (lport-id)
GET
Get Logical Port Status Summary
Get Operational Status Summary of All Logical Ports in the System
GET
Get Logical Switch
Get Logical Switch associated with the provided id (lswitch-id)
GET
Get Logical Switch Mac Table
Get MAC Table for Logical Switch of the Given ID (lswitch-id)
GET
Get Logical Switch Mac Table In Csv Format
Get MAC Table for Logical Switch of the Given ID (lswitch-id)
GET
Get Logical Switch State
Get the realized state associated with provided logical switch id
GET
Get Logical Switch Statistics
Get Statistics for Logical Switch of the Given ID (lswitch-id)
GET
Get Logical Switch Status
Get Logical Switch runtime status info for a given logical switch
GET
Get Logical Switch Status Summary
Get Status Summary of All Logical Switches in the System
GET
Get Logical Switch Vtep Table
Get VTEP Table for Logical Switch of the Given ID (lswitch-id)
GET
Get Logical Switch Vtep Table In Csv Format
Get VTEP Table for Logical Switch of the Given ID (lswitch-id)
GET
Get Switching Profile
Get Switching Profile by ID
GET
Get Switching Profile Status
Get Counts of Ports and Switches Using This Switching Profile
GET
List Logical Ports
List All Logical Ports
GET
List Logical Switches
List all Logical Switches
GET
List Logical Switches By State
List logical switches by realized state
GET
List Switching Profiles
List Switching Profiles
PUT
Update Logical Port
Update a Logical Port
PUT
Update Logical Switch
Update a Logical Switch
PUT
Update Switching Profile
Update a Switching Profile
Network Transport
POST
Create Bridge Cluster
Create a Bridge Cluster
POST
Create Bridge Endpoint
Create a Bridge Endpoint
POST
Create Cluster Profile
Create a Cluster Profile
POST
Create Edge Cluster
Create Edge Cluster
POST
Create Host Switch Profile
Create a Hostswitch Profile
POST
Create Transport Node
Create a Transport Node
POST
Create Transport Zone
Create a Transport Zone
POST
Create Transport Zone Profile
Create a transport zone Profile
DELETE
Delete Bridge Cluster
Delete a Bridge Cluster
DELETE
Delete Bridge Endpoint
Delete a Bridge Endpoint
DELETE
Delete Cluster Profile
Delete a cluster profile
DELETE
Delete Edge Cluster
Delete Edge Cluster
DELETE
Delete Host Switch Profile
Delete a Hostswitch Profile
DELETE
Delete Transport Node
Delete a Transport Node
DELETE
Delete Transport Zone
Delete a Transport Zone
DELETE
Delete Transport Zone Profile
Delete a transport zone Profile
GET
Get Bridge Cluster
Get Information about a bridge cluster
GET
Get Bridge Cluster Status
Returns status of a specified Bridge Cluster
GET
Get Bridge Endpoint
Get Information about a bridge endpoint
GET
Get Bridge Endpoint Statistics
Returns statistics of a specified Bridge Endpoint
GET
Get Bridge Endpoint Status
Returns status of a specified Bridge Endpoint
GET
Get Cluster Profile
Get cluster profile by Id
GET
Get Host Switch Profile
Get a Hostswitch Profile by ID
GET
Get Transport Node
Get a Transport Node
GET
Get Transport Node State
Get a Transport Node's State
GET
Get Transport Zone
Get a Transport Zone
GET
Get Transport Zone Profile
Get transport zone profile by identifier
GET
Get Transport Zone Status
Get a Transport Zone's Current Runtime Status Information
GET
List Bridge Clusters
List All Bridge Clusters
GET
List Bridge Endpoints
List All Bridge Endpoints
GET
List Cluster Profiles
List Cluster Profiles
GET
List Edge Clusters
List Edge Clusters
GET
List Host Switch Profiles
List Hostswitch Profiles
GET
List Neighbor Properties
List LLDP Neighbor Properties
GET
List Transport Nodes
List Transport Nodes
GET
List Transport Nodes By State
List transport nodes by realized state
GET
List Transport Zone Profiles
List transport zone profiles
GET
List Transport Zones
List Transport Zones
GET
Read Edge Cluster
Read Edge Cluster
GET
Read Neighbor Properties
Read LLDP Neighbor Properties
POST
Replace Edge Cluster Member Transport Node
Replace the transport node in the specified member of the edge-cluster
POST
Resync Transport Node
Resync a Transport Node
PUT
Update Bridge Cluster
Update a Bridge Cluster
PUT
Update Bridge Endpoint
Update a Bridge Endpoint
PUT
Update Cluster Profile
Update a cluster profile
PUT
Update Edge Cluster
Update Edge Cluster
PUT
Update Host Switch Profile
Update a Hostswitch Profile
PUT
Update Transport Node
Update a Transport Node
PUT
Update Transport Zone
Update a Transport Zone
PUT
Update Transport Zone Profile
Update a transport zone profile
Normalization
GET
Get Normalizations
Get normalizations based on the query parameters
Nsx Admin
PUT
Configure Backup Config
Configure backup
POST
Create Cluster Backup
Create cluster backup
POST
Create Cluster Restore
Restore cluster backup
POST
Create Node Backup
Create node backup
POST
Create Node Restore
Restore node backup
GET
Get Backup Config
Get backup configuration
GET
Get Backup History
Get backup history
GET
Get Backup Status
Get backup status
POST
Request Onetime Backup
Request one-time backup
POST
Request Onetime Inventory Summary
Request one-time inventory summary.
Nsx Component Administration
POST
Add Certificate
Add a New Certificate
POST
Add Cluster Node
Add a Node to the Cluster
POST
Add Crl
Add a New Certificate Revocation List
POST
Cancel Task
Cancel specified task
POST
Collect Support Bundles
Collect support bundles from registered cluster and fabric nodes
POST
Copy From Remote File
Copy a remote file to the file store
POST
Copy To Remote File
Copy file in the file store to a remote file store
POST
Create Appliance Management Service Action
Restart the node management service
POST
Create File
Upload a file to the file store
POST
Create Node Network Route
Create node network route
POST
Create NSX Message Bus Service Action
Restart, start or stop the NSX Message Bus service
POST
Create NSX Message Bus Service Action
Restart, start or stop the NSX Message Bus service
POST
Create NSX Message Bus Service Action
Restart, start or stop the NSX Message Bus service
POST
Create Nsx Upgrade Agent Service Action
Restart, start or stop the NSX upgrade agent service
POST
Create Nsx Upgrade Agent Service Action
Restart, start or stop the NSX upgrade agent service
POST
Create Nsx Upgrade Agent Service Action
Restart, start or stop the NSX upgrade agent service
POST
Create NTP Service Action
Restart, start or stop the NTP service
POST
Create NTP Service Action
Restart, start or stop the NTP service
POST
Create NTP Service Action
Restart, start or stop the NTP service
POST
Create Proton Service Action
Restart, start or stop the manager service
POST
Create Proton Service Action
Restart, start or stop the manager service
POST
Create Proton Service Action
Restart, start or stop the manager service
POST
Create Proxy Service Action
Restart, start or stop the http service
POST
Create Proxy Service Action
Restart, start or stop the http service
POST
Create Proxy Service Action
Restart, start or stop the http service
POST
Create Proxy Service Apply Certificate Action
Update http service certificate
POST
Create Rabbit MQ Service Action
Restart, start or stop the Rabbit MQ service
POST
Create Rabbit MQ Service Action
Restart, start or stop the Rabbit MQ service
POST
Create Rabbit MQ Service Action
Restart, start or stop the Rabbit MQ service
POST
Create Remote Directory
Create directory in remote file server
POST
Create Repository Service Action
Restart, start or stop the NSX install-upgrade service
POST
Create Repository Service Action
Restart, start or stop the NSX install-upgrade service
POST
Create Repository Service Action
Restart, start or stop the NSX install-upgrade service
POST
Create SNMP Service Action
Restart, start or stop the SNMP service
POST
Create SNMP Service Action
Restart, start or stop the SNMP service
POST
Create SNMP Service Action
Restart, start or stop the SNMP service
POST
Create SSH Service Action
Restart, start or stop the ssh service
POST
Create SSH Service Action
Restart, start or stop the ssh service
POST
Create SSH Service Action
Restart, start or stop the ssh service
POST
Create SSH Service Remove Host Fingerprint Action
Remove a host's fingerprint from known hosts file
POST
Create Syslog Service Action
Restart, start or stop the syslog service
POST
Create Syslog Service Action
Restart, start or stop the syslog service
POST
Create Syslog Service Action
Restart, start or stop the syslog service
DELETE
Delete Certificate
Delete Certificate for the Given Certificate ID
DELETE
Delete Cluster Node Config
Remove a Node from the Cluster
DELETE
Delete Crl
Delete a CRL
DELETE
Delete Csr
Delete a CSR
DELETE
Delete File
Delete file
DELETE
Delete Node Network Route
Delete node network route
DELETE
Delete Node Syslog Exporter
Delete node syslog exporter
DELETE
Delete Task
Delete task
POST
Generate Csr
Generate a New Certificate Signing Request
GET
Get Certificate
Show Certificate Data for the Given Certificate ID
GET
Get Certificates
Return All the User-Facing Components' Certificates
GET
Get Crl
Show CRL Data for the Given CRL ID
GET
Get Crls
Return All Added CRLs
GET
Get Csr
Show CSR Data for the Given CSR ID
GET
Get Csr Pem
Get CSR PEM File for the Given CSR ID
GET
Get Csrs
Return All the Generated CSRs
GET
Get Node Mandatory Access Control
Gets the enable status for Mandatory Access Control
GET
Get Node Mandatory Access Control Report
Get the report for Mandatory Access Control
GET
Get Trust Objects
Return the Properties of a Trust Manager
POST
Import Certificate
Import a Certificate Associated with an Approved CSR
GET
List Cluster Node Configs
List Cluster Node Configurations
GET
List Cluster Node Interfaces
List the specified node's Network Interfaces
GET
List Files
List node files
GET
List Node Interfaces
List the NSX Manager's Network Interfaces
GET
List Node Network Routes
List node network routes
GET
List Node Processes
List node processes
GET
List Node Services
List node services
GET
List Node Syslog Exporters
List node syslog exporters
GET
List Node Users
List node users
POST
Post Node Syslog Exporter
Add node syslog exporter
GET
Read Appliance Management Service
Read appliance management service properties
GET
Read Appliance Management Service Status
Read appliance management service status
GET
Read Asnyc Task Response
Read asynchronous task response
GET
Read Cluster Config
Read Cluster Configuration
GET
Read Cluster Node Config
Read Cluster Node Configuration
GET
Read Cluster Node Interface
Read the node's Network Interface
GET
Read Cluster Node Interface Statistics
Read the NSX Manager/Controller's Network Interface Statistics
GET
Read Cluster Nodes Aggregate Status
Read Cluster Status
GET
Read Cluster Node Status
Read Cluster Node Status
GET
Read Cluster Status
Read Cluster Status
GET
Read File
Read file contents
GET
Read File Properties
Read file properties
GET
Read File Thumbprint
Read file thumbprint
GET
Read Network Interface Statistics
Read the NSX Manager's Network Interface Statistics
GET
Read Network Properties
Read network configuration properties
GET
Read Node Interface
Read the NSX Manager's Network Interface
GET
Read Node Name Servers
Read the NSX Manager's Name Servers
GET
Read Node Network Route
Read node network route
GET
Read Node Process
Read node process
GET
Read Node Properties
Read node properties
GET
Read Node Search Domains
Read the NSX Manager's Search Domains
GET
Read Node Support Bundle
Read node support bundle
GET
Read Node Syslog Exporter
Read node syslog exporter
GET
Read Node User
Read node user
GET
Read NSX Message Bus Service
Read NSX Message Bus service properties
GET
Read NSX Message Bus Service Status
Read NSX Message Bus service status
GET
Read Nsx Upgrade Agent Service
Read NSX upgrade Agent service properties
GET
Read Nsx Upgrade Agent Service Status
Read Nsx upgrade agent service status
GET
Read NTP Service
Read NTP service properties
GET
Read NTP Service Status
Read NTP service status
GET
Read Proton Service
Read manager service properties
GET
Read Proton Service Status
Read manager service status
GET
Read Proxy Service
Read http service properties
GET
Read Proxy Service Status
Read http service status
GET
Read Rabbit MQ Service
Read Rabbit MQ service properties
GET
Read Rabbit MQ Service Status
Read Rabbit MQ service status
GET
Read Repository Service
Read NSX install-upgrade service properties
GET
Read Repository Service Status
Read NSX install-upgrade service status
GET
Read SNMP Service
Read SNMP service properties
GET
Read SNMP Service Status
Read SNMP service status
GET
Read SSH Service
Read ssh service properties
GET
Read SSH Service Status
Read ssh service status
GET
Read Syslog Service
Read syslog service properties
GET
Read Syslog Service Status
Read syslog service status
POST
Reset Proton Service Logging Level Action
Reset the manager logging levels to default values
POST
Restart Or Shutdown Node
Restart or shutdown node
POST
Restart Or Shutdown Node
Restart or shutdown node
POST
Revoke Missing Cluster Node Config
Revoke Missing Nodes from the Cluster
POST
Self Sign Certificate
Self-Sign the CSR
PUT
Set Node Mandatory Access Control
Enable or disable Mandatory Access Control
PUT
Update Crl
Update CRL for the Given CRL ID
PUT
Update File
Replace file contents
PUT
Update Node Interface
Update the NSX Manager's Network Interface
PUT
Update Node Name Servers
Update the NSX Manager's Name Servers
PUT
Update Node Properties
Update node properties
PUT
Update Node Search Domains
Update the NSX Manager's Search Domains
PUT
Update Node User
Update node user
PUT
Update NTP Service
Update NTP service properties
PUT
Update Proton Service
Update Proton service properties
PUT
Update Proxy Service
Update http service properties
PUT
Update Repository Service
Update NSX install-upgrade service properties
PUT
Update SNMP Service
Update SNMP service properties
PUT
Update SSH Service
Update ssh service properties
POST
Upload CA Signed Cert
Upload the Certificate PEM File Signed by the CA Associated with a CSR
Operations
POST
Create Ipfix Config
Create a new IPFIX configuration
DELETE
Delete Ipfix Config
Delete an existing IPFIX configuration
GET
Get Ipfix Config
Get an existing IPFIX configuration
GET
List Ipfix Config
List IPFIX configuration
PUT
Update Ipfix Config
Update an existing IPFIX configuration
Pool Management
POST
Allocate Or Release From Ip Pool
Allocate or Release an IP Address from a Pool
POST
Create Ip Pool
Create an IP Pool
DELETE
Delete Ip Pool
Delete an IP Pool
GET
List Ip Pool Allocations
List IP Pool Allocations
GET
List Ip Pools
List IP Pools
GET
List VNI Pools
List VNI Pools
GET
Read Ip Pool
Read IP Pool
GET
Read VNI Pool
Read VNI Pool
PUT
Update Ip Pool
Update an IP Pool
PUT
Update VNI Pool
Update a VNI Pool
Realization
GET
Get Current Barrier
Gets the current barrier number
GET
Get Realization State Barrier Config
Gets the realization state barrier configuration
POST
Increment Realization State Barrier
Increments the barrier count by 1
PUT
Update Realization State Barrier Config
Updates the barrier configuration
Services
POST
Add Dne Key Manager
Add a key manager configuration
POST
Add Dne Key Policy
Create a DNE Key Policy
POST
Add Dne Rule In Section
Add a single rule in a section
POST
Add Dne Rules In Section
Add multiple rules in a section
POST
Add Dne Section
Create a new empty section
POST
Add Dne Section With Rules
Create a section with rules
POST
Add Member
Add a new object in the exclude list
POST
Add Rule In Section
Add a Single Rule in a Section
POST
Add Rules In Section
Add Multiple Rules in a Section
POST
Add Section
Create a New Empty Section
POST
Add Section With Rules
Create a Section with Rules
POST
Check Member If Exists
Check if the object a member of the exclude list
POST
Create Dhcp Ip Pool
Create an IP pool for a DHCP server
POST
Create Dhcp Profile
Create a DHCP server profile
POST
Create Dhcp Server
Create a DHCP server
POST
Create Dhcp Static Binding
Create a static binding for a DHCP server
POST
Create Metadata Proxy
Create a metadata proxy
DELETE
Delete Dhcp Ip Pool
Delete a DHCP server's IP pool
DELETE
Delete Dhcp Profile
Delete a DHCP server profile
DELETE
Delete Dhcp Server
Delete a DHCP server
DELETE
Delete Dhcp Static Binding
Delete a static binding
DELETE
Delete Dne Key Manager
Delete an attached DNE key manager
DELETE
Delete Dne Key Policy
Delete an existing DNE key policy
DELETE
Delete Dne Rule
Delete an existing rule
DELETE
Delete Dne Section
Delete an existing section and its associated rules
DELETE
Delete Metadata Proxy
Delete a metadata proxy
DELETE
Delete Rule
Delete an Existing Rule
DELETE
Delete Section
Delete an Existing Section and Its Associated Rules
GET
Get Dne Key Manager
Get an existing key manager configuration
GET
Get Dne Key Policy
Read an existing key policy
GET
Get Dne Key Policy Stats
Get the stats results for a given DNE key policy
GET
Get Dne Rule
Read an existing rule
GET
Get Dne Rules
Get the rules of a section
GET
Get Dne Rules By Key Policy
Get all rules that refer to a given key policy
GET
Get Dne Rule State
Get the Realized State of a Dne Rule
GET
Get Dne Rule Stats
Get the stats results for a given DNE rule
GET
Get Dne Section
Get an existing section
GET
Get Dne Section State
Get the Realized State of a Dne Section
POST
Get Dne Section With Rules
Get an existing Section, including rules
GET
Get Exclude List
Get list of entities in exclude list
GET
Get Firewall Stats
Get the aggregated flow for a given firewall rule
GET
Get Rule
Read an Existing Rule
GET
Get Rules
Get All the Rules for a Section
GET
Get Rule State
Get the Realized State of a Firewall Rule
GET
Get Section
Get an Existing Section
GET
Get Section State
Get the Realized State of a Firewall Section
POST
Get Section With Rules
Get an Existing Section, Including Rules
GET
List Dhcp Ip Pools
Get a paginated list of a DHCP server's IP pools
GET
List Dhcp Profiles
Get a paginated list of DHCP server profiles
GET
List Dhcp Servers
Get a paginated list of DHCP servers
GET
List Dhcp Static Bindings
Get a paginated list of a DHCP server's static bindings
GET
List Dne Key Managers
List DNE Key manager configration instances
GET
List Dne Key Policies
List out DNE Key Policies
GET
List Dne Sections
List DNE sections
GET
List Metadata Proxy
Get a paginated list of metadata proxies
GET
List Sections
List All Firewall Sections
GET
Read Dhcp Ip Pool
Get a DHCP server's IP pool with the specified pool ID
GET
Read Dhcp Profile
Get a DHCP server profile
GET
Read Dhcp Server
Get a DHCP server
GET
Read Dhcp Static Binding
Get a DHCP server's static binding with the specified binding ID
GET
Read Metadata Proxy
Get a metadata proxy
POST
Remove Member
Remove an existing object from the exclude list
PUT
Reset Default Dne Key Policy To System Default
Reset default key policy to system default
POST
Revise Dne Rule
Update an existing rule and reorder the rule
POST
Revise Dne Section
Update an existing section, including its position
POST
Revise Dne Section With Rules
Update an existing section with rules
POST
Revise Rule
Update an Existing Rule and Reorder the Rule
POST
Revise Section
Update an Existing Section, Including Its Position
POST
Revise Section With Rules
Update an Existing Section with Rules
POST
Revoke Dne Key Policy
Manually revoke a key policy for ungraceful re-key
POST
Rotate Dne Key Policy
Manually rotate a key policy for graceful re-key
PUT
Update Dhcp Ip Pool
Update a DHCP server's IP pool
PUT
Update Dhcp Profile
Update a DHCP server profile
PUT
Update Dhcp Server
Update a DHCP server
PUT
Update Dhcp Static Binding
Update a DHCP server's static binding
PUT
Update Dne Key Manager
Update key manager configuration
PUT
Update Dne Key Policy
Update key policy properties
PUT
Update Dne Rule
Update an existing rule
PUT
Update Dne Section
Update an existing section
POST
Update Dne Section With Rules
Update an existing section, including its rules
PUT
Update Exclude List
Modify exclude list
PUT
Update Metadata Proxy
Update a metadata proxy
PUT
Update Rule
Update an Existing Rule
PUT
Update Section
Update an Existing Section
POST
Update Section With Rules
Update an Existing Section, Including Its Rules
Transport Entities
GET
Get Tunnel
Tunnel properties
GET
Query Tunnels
List of tunnels
Troubleshooting And Monitoring
POST
Create Port Mirroring Sessions
Create a mirror session
POST
Create Traceflow
Initiate a Traceflow Operation on the Specified Port
DELETE
Delete Port Mirroring Session
Delete the mirror session
DELETE
Delete Traceflow
Delete the Traceflow round
GET
Get Forwarding Path
Get networking entities between two logical ports with VIF attachment
GET
Get Heatmap Transport Zone Status
Get high-level summary of a transport zone
GET
Get Ipfix Obs Points
Get the list of IPFIX observation points
GET
Get Port Mirroring Session
Get the mirror session
GET
Get Switch Ipfix Config
Read global switch IPFIX export configuration
GET
Get Traceflow
Get the Traceflow round status and result summary
GET
Get Traceflow Observations
Get observations for the Traceflow round
GET
Get Transport Node Report
Creates a status report of transport nodes of all the transport zones
GET
Get Transport Node Report For A Transport Zone
Creates a status report of transport nodes in a transport zone
GET
Get Transport Node Status
Read status of a transport node
GET
List Node Logs
List available node logs
GET
List Port Mirroring Session
List all mirror sessions
GET
List Remote Transport Node Status
Read status of all transport nodes with tunnel connections to transport node
GET
List Traceflows
List all Traceflow rounds
GET
List Transport Node Status
Read status of all the transport nodes
GET
List Transport Node Status For Transport Zone
Read status of transport nodes in a transport zone
GET
Read Node Log
Read node log properties
GET
Read Node Log Data
Read node log contents
PUT
Update Port Mirroring Session
Update the mirror session
PUT
Update Switch Ipfix Config
Update global switch IPFIX export configuration
POST
Verify Port Mirroring Session
Verify whether the mirror session is still valid
Uirpc
POST
Add User
Create a User for UI RPC Test
DELETE
Remove User
Create User for UI RPC Test
PUT
Update User
Update User Properties for UI RPC Test
Upgrade
POST
Add Upgrade Units To Group
Add upgrade units to specified upgrade unit group
POST
Continue Upgrade
Continue upgrade
POST
Create Upgrade Unit Group
Create a group
DELETE
Delete Upgrade Unit Group
Delete the upgrade unit group
GET
Get Nodes
Get list of nodes across all types
GET
Get Nodes Summary
Get summary of nodes
GET
Get Upgrade History
Get upgrade history
GET
Get Upgrade Plan Settings
Get upgrade plan settings for the component
GET
Get Upgrade Status Summary
Get upgrade status summary
GET
Get Upgrade Summary
Get upgrade summary
GET
Get Upgrade Unit
Get a specific upgrade unit
GET
Get Upgrade Unit Aggregate Info
Get upgrade units aggregate-info
GET
Get Upgrade Unit Group
Return upgrade unit group information
GET
Get Upgrade Unit Group Aggregate Info
Return aggregate information of all upgrade unit groups
GET
Get Upgrade Unit Groups
Return information of all upgrade unit groups
GET
Get Upgrade Unit Groups Status
Get upgrade status for upgrade unit groups
GET
Get Upgrade Unit Group Status
Get upgrade status for group
GET
Get Upgrade Units
Get upgrade units
GET
Get Upgrade Units Stats
Get upgrade units stats
GET
Get Version Whitelist
Get the version whitelist
GET
Get Version Whitelist By Component
Get the version whitelist for the specified component
POST
Pause Upgrade
Pause upgrade
POST
Reorder Upgrade Unit
Reorder an upgrade unit within the upgrade unit group
POST
Reorder Upgrade Unit Group
Reorder upgrade unit group
POST
Reset Upgrade Plan
Reset upgrade plan to default plan
POST
Start Upgrade
Start upgrade
POST
Trigger Uc Upgrade
Upgrade the upgrade coordinator.
PUT
Update Upgrade Plan Settings
Update upgrade plan settings for the component
PUT
Update Upgrade Unit Group
Update the upgrade unit group
PUT
Update Version Whitelist
Update the version whitelist for the specified component type
POST
Upload Upgrade Bundle
Upload upgrade bundle