Configuration APIs

Configuration APIs
Operations
POST
Register Batch Request Deprecated
Register a Collection of API Calls at a Single End Point
GET
Read Cluster Config
Read Cluster Configuration
GET
List Cluster Profiles
List Cluster Profiles
POST
Create Cluster Profile
Create a Cluster Profile
DELETE
Delete Cluster Profile
Delete a cluster profile
GET
Get Cluster Profile
Get cluster profile by Id
PUT
Update Cluster Profile
Update a cluster profile
GET
Get Cluster Certificate Id
Read cluster certificate ID
POST
Clear Cluster Certificate Clear Cluster Certificate Deprecated
Clear the cluster certificate
POST
Set Cluster Certificate Set Cluster Certificate Deprecated
Set the cluster certificate
GET
Get Api Service Config
Read API service properties
PUT
Update Api Service Config
Update API service properties
GET
Get Cluster Virtual Ip
Read cluster virtual IP addresses
POST
Clear Cluster Virtual Ip Clear Virtual Ip
Clear cluster virtual IP address
POST
Clear Cluster Virtual Ip Clear Virtual Ip6
Clear cluster virtual IP address
POST
Set Cluster Virtual Ip Set Virtual Ip
Set cluster virtual IP addresses
GET
Get Backup Ui Frames Info
Get backup frames for UI
POST
Perform Repo Sync
Synchronizes the repository data between nsx managers.
GET
List Cluster Node Configs
List Cluster Node Configurations
POST
Add Cluster Node Deprecated
Add a controller to the cluster
GET
List Cluster Node VM Deployment Requests
Returns info for all cluster node VM auto-deployment attempts
POST
Add Cluster Node VM
Deploy and register a cluster node VM
GET
Read Cluster Node VM Deployment Request
Returns info for a cluster-node VM auto-deployment attempt
GET
Read Cluster Node VM Deployment Status
Returns the status of the VM creation/deletion
POST
Delete Auto Deployed Cluster Node VM
Attempt to delete an auto-deployed cluster node VM
GET
Read Cluster Nodes Aggregate Status Deprecated
Read cluster runtime status
DELETE
Delete Cluster Node Config Deprecated
Remove a controller from the cluster
GET
Read Cluster Node Config Deprecated
Read Cluster Node Configuration
GET
List Cluster Node Interfaces
List the specified node's Network Interfaces
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
Get Repo Sync Status
Synchronizes the repository data between nsx managers.
GET
Read Cluster Node Status
Read cluster node runtime status
GET
Read Cluster Status
Read Cluster Status
GET
Cluster Cluster Node Id Node Read Node Properties
Read node properties
PUT
Cluster Cluster Node Id Node Update Node Properties
Update node properties
GET
Cluster Cluster Node Id Node Read Authentication Policy Properties
Read node authentication policy and password complexity configuration
PUT
Cluster Cluster Node Id Node Update Authentication Policy Properties
Update node authentication policy and password complexity configuration
POST
Cluster Cluster Node Id Node Reset Authentication Policy Properties Reset All
Resets node authentication policy and password complexity configuration
POST
Cluster Cluster Node Id Node Reset Authentication Policy Properties Reset Auth Policies
Resets node authentication policy and password complexity configuration
POST
Cluster Cluster Node Id Node Reset Authentication Policy Properties Reset Pwd Complexity
Resets node authentication policy and password complexity configuration
GET
Cluster Cluster Node Id Node Read Central Config Properties
Read Central Config properties
PUT
Cluster Cluster Node Id Node Update Central Config Properties
Update Central Config properties
GET
Cluster Cluster Node Id Node List Files
List node files
DELETE
Cluster Cluster Node Id Node Delete File
Delete file
GET
Cluster Cluster Node Id Node Read File Properties
Read file properties
POST
Cluster Cluster Node Id Node Create File
Upload a file to the file store
GET
Cluster Cluster Node Id Node Read File Thumbprint
Read file thumbprint
POST
Cluster Cluster Node Id Node Copy From Remote File Copy From Remote File
Copy a remote file to the file store
POST
Cluster Cluster Node Id Node Copy To Remote File Copy To Remote File
Copy file in the file store to a remote file store
POST
Cluster Cluster Node Id Node Create Remote Directory Create Remote Directory
Create directory in remote file server
DELETE
Cluster Cluster Node Id Node Delete Remote Directory Delete Remote Directory
Delete directory in remote file server
POST
Cluster Cluster Node Id Node Retrieve Ssh Fingerprint Retrieve Ssh Fingerprint
Retrieve ssh fingerprint for given remote server
GET
Cluster Cluster Node Id Node List Node Grub Properties
Return node GRUB properties
PUT
Cluster Cluster Node Id Node Update Node Grub Properties
Update node GRUB properties
PUT
Cluster Cluster Node Id Node Update Node Grub User
Update node GRUB user properties
GET
Cluster Cluster Node Id Node Get Node Mandatory Access Control
Gets the enable status for Mandatory Access Control
PUT
Cluster Cluster Node Id Node Set Node Mandatory Access Control
Enable or disable Mandatory Access Control
GET
Cluster Cluster Node Id Node Get Node Mandatory Access Control Report
Get the report for Mandatory Access Control
GET
Cluster Cluster Node Id Node List Intelligence Form Factors Deprecated
List available Napp appliance form factors
GET
Cluster Cluster Node Id Node List Node Logs
List available node logs
GET
Cluster Cluster Node Id Node Read Node Log
Read node log properties
GET
Cluster Cluster Node Id Node Read Node Log Data
Read node log contents
DELETE
Cluster Cluster Node Id Node Delete Management Plane Configuration
Delete management plane configuration for this node
GET
Cluster Cluster Node Id Node Read Management Plane Configuration
Get management plane configuration for this node
PUT
Cluster Cluster Node Id Node Update Management Plane Configuration
Update management plane configuration for this node
GET
Cluster Cluster Node Id Node Get Node Mode
NodeMode
GET
Cluster Cluster Node Id Node Read Node Motd
Read node message of the day
DELETE
Cluster Cluster Node Id Node Delete MPA Configuration
Delete MPA configuration for this node
GET
Cluster Cluster Node Id Node Read MPA Configuration
Get MPA configuration for this node
PUT
Cluster Cluster Node Id Node Update MPA Configuration
Update MPA configuration for this node
GET
Cluster Cluster Node Id Node Read Network Properties
Read network configuration properties
GET
Cluster Cluster Node Id Node List Node Interfaces
List the Node's Network Interfaces
GET
Cluster Cluster Node Id Node Read Node Interface
Read the Node's Network Interface
PUT
Cluster Cluster Node Id Node Update Node Interface
Update the Node's Network Interface
GET
Cluster Cluster Node Id Node Read Network Interface Statistics
Read the Node's Network Interface Statistics
GET
Cluster Cluster Node Id Node Read Node Name Servers
Read the Node's Name Servers
PUT
Cluster Cluster Node Id Node Update Node Name Servers
Update the Node's Name Servers
GET
Cluster Cluster Node Id Node List Node Network Routes
List node network routes
POST
Cluster Cluster Node Id Node Create Node Network Route
Create node network route
DELETE
Cluster Cluster Node Id Node Delete Node Network Route
Delete node network route
GET
Cluster Cluster Node Id Node Read Node Network Route
Read node network route
GET
Cluster Cluster Node Id Node Read Node Search Domains
Read the Node's Search Domains
PUT
Cluster Cluster Node Id Node Update Node Search Domains
Update the Node's Search Domains
GET
Cluster Cluster Node Id Node List Node Processes
List node processes
GET
Cluster Cluster Node Id Node Read Node Process
Read node process
GET
Cluster Cluster Node Id Node List Node Services
List node services
GET
Cluster Cluster Node Id Node Read Async Replicator Service
Read the Async Replicator service properties
PUT
Cluster Cluster Node Id Node Update Async Replicator Service
Update the async_replicator service properties
GET
Cluster Cluster Node Id Node Read Async Replicator Service Status
Read the Async Replicator service status
POST
Cluster Cluster Node Id Node Create Async Replicator Service Action Restart
Restart, start or stop the Async Replicator service
POST
Cluster Cluster Node Id Node Create Async Replicator Service Action Start
Restart, start or stop the Async Replicator service
POST
Cluster Cluster Node Id Node Create Async Replicator Service Action Stop
Restart, start or stop the Async Replicator service
GET
Cluster Cluster Node Id Node Read Auth Service
Read auth service properties
PUT
Cluster Cluster Node Id Node Update Auth Service
Update auth service properties
GET
Cluster Cluster Node Id Node Read Auth Service Status
Read auth service status
POST
Cluster Cluster Node Id Node Create Auth Service Action Restart Restart
Restart the auth service
POST
Cluster Cluster Node Id Node Create Auth Service Action Start Start
Start the auth service
POST
Cluster Cluster Node Id Node Create Auth Service Action Stop Stop
Stop the auth service
GET
Cluster Cluster Node Id Node Read Cluster Boot Manager Service
Read cluster boot manager service properties
GET
Cluster Cluster Node Id Node Read Cluster Boot Manager Service Status
Read cluster boot manager service status
POST
Cluster Cluster Node Id Node Create Cluster Boot Manager Service Action Restart
Restart, start or stop the cluster boot manager service
POST
Cluster Cluster Node Id Node Create Cluster Boot Manager Service Action Start
Restart, start or stop the cluster boot manager service
POST
Cluster Cluster Node Id Node Create Cluster Boot Manager Service Action Stop
Restart, start or stop the cluster boot manager service
GET
Cluster Cluster Node Id Node Read Cminventory Service
Read cm inventory service properties
GET
Cluster Cluster Node Id Node Read Cminventory Service Status
Read manager service status
POST
Cluster Cluster Node Id Node Create Cminventory Service Action Restart
Restart, start or stop the manager service
POST
Cluster Cluster Node Id Node Create Cminventory Service Action Start
Restart, start or stop the manager service
POST
Cluster Cluster Node Id Node Create Cminventory Service Action Stop
Restart, start or stop the manager service
GET
Cluster Cluster Node Id Node Read Controller Server Service
Read controller service properties
GET
Cluster Cluster Node Id Node Read Controller Server Certificate
Read controller server certificate properties
GET
Cluster Cluster Node Id Node Get Controller Profiler Status
Get the status (Enabled/Disabled) of controller profiler
PUT
Cluster Cluster Node Id Node Set Controller Profiler
Enable or disable controller profiler
GET
Cluster Cluster Node Id Node Read Controller Server Service Status
Read controller service status
POST
Cluster Cluster Node Id Node Create Controller Server Service Action Restart
Restart, start or stop the controller service
POST
Cluster Cluster Node Id Node Create Controller Server Service Action Start
Restart, start or stop the controller service
POST
Cluster Cluster Node Id Node Create Controller Server Service Action Stop
Restart, start or stop the controller service
GET
Cluster Cluster Node Id Node Read Corfu Server Service
Read the Corfu Server service properties
GET
Cluster Cluster Node Id Node Get Corfu Certificate Expiry Check Status
Get the status of Corfu Certificate Expiry Check. Enabled or disabled
POST
Cluster Cluster Node Id Node Corfu Certificate Expiry Check Disable
Enable or Disable Corfu Certificate Expiry Check. Default is enabled
POST
Cluster Cluster Node Id Node Corfu Certificate Expiry Check Enable
Enable or Disable Corfu Certificate Expiry Check. Default is enabled
GET
Cluster Cluster Node Id Node Read Corfu Server Service Status
Read the Corfu Server service status
POST
Cluster Cluster Node Id Node Create Corfu Server Service Action Restart
Restart, start or stop the Corfu Server service
POST
Cluster Cluster Node Id Node Create Corfu Server Service Action Start
Restart, start or stop the Corfu Server service
POST
Cluster Cluster Node Id Node Create Corfu Server Service Action Stop
Restart, start or stop the Corfu Server service
GET
Cluster Cluster Node Id Node Read Corfu Log Replication Server Service
Read the Corfu Log Replication Server service properties
GET
Cluster Cluster Node Id Node Read Corfu Log Replication Server Service Status
Read the Corfu Log Replication Server service status
POST
Cluster Cluster Node Id Node Create Corfu Log Replication Server Service Action Restart
Restart, start or stop the Corfu Log Replication Server service
POST
Cluster Cluster Node Id Node Create Corfu Log Replication Server Service Action Start
Restart, start or stop the Corfu Log Replication Server service
POST
Cluster Cluster Node Id Node Create Corfu Log Replication Server Service Action Stop
Restart, start or stop the Corfu Log Replication Server service
GET
Cluster Cluster Node Id Node Read Corfu Nonconfig Server Service
Read the Corfu Nonconfig Server service properties
GET
Cluster Cluster Node Id Node Read Corfu Nonconfig Server Service Status
Read the Corfu Nonconfig Server service status
POST
Cluster Cluster Node Id Node Create Corfu Nonconfig Server Service Action Restart
Restart, start or stop the Corfu Nonconfig Server service
POST
Cluster Cluster Node Id Node Create Corfu Nonconfig Server Service Action Start
Restart, start or stop the Corfu Nonconfig Server service
POST
Cluster Cluster Node Id Node Create Corfu Nonconfig Server Service Action Stop
Restart, start or stop the Corfu Nonconfig Server service
GET
Cluster Cluster Node Id Node Read Proxy Service
Read http service properties
PUT
Cluster Cluster Node Id Node Update Proxy Service
Update http service properties
GET
Cluster Cluster Node Id Node Read Proxy Service Status
Read http service status
POST
Cluster Cluster Node Id Node Create Proxy Service Apply Certificate Action Apply Certificate Deprecated
Update http service certificate
POST
Cluster Cluster Node Id Node Create Proxy Service Action Restart Restart
Restart the http service
POST
Cluster Cluster Node Id Node Create Proxy Service Action Start Start
Start the http service
POST
Cluster Cluster Node Id Node Create Proxy Service Action Stop Stop
Stop the http service
GET
Cluster Cluster Node Id Node Read Idps Reporting Service
Read the idps-reporting service properties
GET
Cluster Cluster Node Id Node Read Idps Reporting Service Status
Read the idps-reporting service status
POST
Cluster Cluster Node Id Node Create Idps Reporting Service Action Restart
Restart, start or stop the idps-reporting service
POST
Cluster Cluster Node Id Node Create Idps Reporting Service Action Start
Restart, start or stop the idps-reporting service
POST
Cluster Cluster Node Id Node Create Idps Reporting Service Action Stop
Restart, start or stop the idps-reporting service
GET
Cluster Cluster Node Id Node Read Repository Service
Read NSX install-upgrade service properties
PUT
Cluster Cluster Node Id Node Update Repository Service
Update NSX install-upgrade service properties
GET
Cluster Cluster Node Id Node Read Repository Service Status
Read NSX install-upgrade service status
PUT
Cluster Cluster Node Id Node Update Uc State
Update UC state properties
POST
Cluster Cluster Node Id Node Create Repository Service Action Restart
Restart, start or stop the NSX install-upgrade service
POST
Cluster Cluster Node Id Node Create Repository Service Action Start
Restart, start or stop the NSX install-upgrade service
POST
Cluster Cluster Node Id Node Create Repository Service Action Stop
Restart, start or stop the NSX install-upgrade service
GET
Cluster Cluster Node Id Node Read Liagent Service
Read liagent service properties
GET
Cluster Cluster Node Id Node Read Liagent Service Status
Read liagent service status
POST
Cluster Cluster Node Id Node Create Liagent Service Action Restart
Restart, start or stop the liagent service
POST
Cluster Cluster Node Id Node Create Liagent Service Action Start
Restart, start or stop the liagent service
POST
Cluster Cluster Node Id Node Create Liagent Service Action Stop
Restart, start or stop the liagent service
GET
Cluster Cluster Node Id Node Read Proton Service
Read service properties
PUT
Cluster Cluster Node Id Node Update Proton Service
Update service properties
GET
Cluster Cluster Node Id Node Read Proton Service Status
Read service status
POST
Cluster Cluster Node Id Node Reset Proton Service Logging Level Action Reset Manager Logging Levels
Reset the logging levels to default values
POST
Cluster Cluster Node Id Node Create Proton Service Action Restart
Restart, start or stop the service
POST
Cluster Cluster Node Id Node Create Proton Service Action Start
Restart, start or stop the service
POST
Cluster Cluster Node Id Node Create Proton Service Action Stop
Restart, start or stop the service
GET
Cluster Cluster Node Id Node Read NSX Messaging Manager Service
Read NSX Messaging Manager service properties
GET
Cluster Cluster Node Id Node Read NSX Messaging Manager Service Status
Read NSX Messaging Manager service status
POST
Cluster Cluster Node Id Node Create NSX Messaging Manager Service Action Restart
Restart, start or stop the NSX Messaging Manager service
POST
Cluster Cluster Node Id Node Create NSX Messaging Manager Service Action Start
Restart, start or stop the NSX Messaging Manager service
POST
Cluster Cluster Node Id Node Create NSX Messaging Manager Service Action Stop
Restart, start or stop the NSX Messaging Manager service
GET
Cluster Cluster Node Id Node Read Migration Coordinator Service
Read migration coordinator service properties
GET
Cluster Cluster Node Id Node Read Migration Coordinator Service Status
Read migration coordinator service status
POST
Cluster Cluster Node Id Node Create Migration Coordinator Service Action Restart
Restart, start or stop the migration coordinator service
POST
Cluster Cluster Node Id Node Create Migration Coordinator Service Action Start
Restart, start or stop the migration coordinator service
POST
Cluster Cluster Node Id Node Create Migration Coordinator Service Action Stop
Restart, start or stop the migration coordinator service
GET
Cluster Cluster Node Id Node Read Appliance Management Service
Read appliance management service properties
GET
Cluster Cluster Node Id Node Get Node Management Log Level
Retrieve Node Management loglevel
PUT
Cluster Cluster Node Id Node Set Node Management Log Level
Set Node Management loglevel
GET
Cluster Cluster Node Id Node Read Appliance Management Service Status
Read appliance management service status
POST
Cluster Cluster Node Id Node Create Appliance Management Service Action Restart
Restart the node management service
GET
Cluster Cluster Node Id Node Read Node Stats Service
Read NSX node-stats service properties
GET
Cluster Cluster Node Id Node Read Node Stats Service Status
Read NSX node-stats service status
POST
Cluster Cluster Node Id Node Create Node Stats Service Action Restart
Restart, start or stop the NSX node-stats service
POST
Cluster Cluster Node Id Node Create Node Stats Service Action Start
Restart, start or stop the NSX node-stats service
POST
Cluster Cluster Node Id Node Create Node Stats Service Action Stop
Restart, start or stop the NSX node-stats service
GET
Cluster Cluster Node Id Node Read NSX Message Bus Service
Read NSX Message Bus service properties
GET
Cluster Cluster Node Id Node Read NSX Message Bus Service Status
Read NSX Message Bus service status
POST
Cluster Cluster Node Id Node Create NSX Message Bus Service Action Restart
Restart, start or stop the NSX Message Bus service
POST
Cluster Cluster Node Id Node Create NSX Message Bus Service Action Start
Restart, start or stop the NSX Message Bus service
POST
Cluster Cluster Node Id Node Create NSX Message Bus Service Action Stop
Restart, start or stop the NSX Message Bus service
GET
Cluster Cluster Node Id Node Read Platform Client Service
Read NSX Platform Client service properties
GET
Cluster Cluster Node Id Node Read Platform Client Service Status
Read NSX Platform Client service status
POST
Cluster Cluster Node Id Node Create Platform Client Service Action Restart
Restart, start or stop the NSX Platform Client service
POST
Cluster Cluster Node Id Node Create Platform Client Service Action Start
Restart, start or stop the NSX Platform Client service
POST
Cluster Cluster Node Id Node Create Platform Client Service Action Stop
Restart, start or stop the NSX Platform Client service
GET
Cluster Cluster Node Id Node Read Nsx Upgrade Agent Service
Read NSX upgrade Agent service properties
GET
Cluster Cluster Node Id Node Read Nsx Upgrade Agent Service Status
Read Nsx upgrade agent service status
POST
Cluster Cluster Node Id Node Create Nsx Upgrade Agent Service Action Restart
Restart, start or stop the NSX upgrade agent service
POST
Cluster Cluster Node Id Node Create Nsx Upgrade Agent Service Action Start
Restart, start or stop the NSX upgrade agent service
POST
Cluster Cluster Node Id Node Create Nsx Upgrade Agent Service Action Stop
Restart, start or stop the NSX upgrade agent service
GET
Cluster Cluster Node Id Node Read NTP Service
Read NTP service properties
PUT
Cluster Cluster Node Id Node Update NTP Service
Update NTP service properties
GET
Cluster Cluster Node Id Node Read NTP Service Status
Read NTP service status
POST
Cluster Cluster Node Id Node Create NTP Service Action Restart
Restart, start or stop the NTP service
POST
Cluster Cluster Node Id Node Create NTP Service Action Start
Restart, start or stop the NTP service
POST
Cluster Cluster Node Id Node Create NTP Service Action Stop
Restart, start or stop the NTP service
GET
Cluster Cluster Node Id Node Read Policy Service Deprecated
Read service properties
PUT
Cluster Cluster Node Id Node Update Policy Service Deprecated
Update service properties
GET
Cluster Cluster Node Id Node Read Policy Service Status Deprecated
Read service status
POST
Cluster Cluster Node Id Node Reset Policy Service Logging Level Action Reset Manager Logging Levels Deprecated
Reset the logging levels to default values
POST
Cluster Cluster Node Id Node Create Policy Service Action Restart Deprecated
Restart, start or stop the service
POST
Cluster Cluster Node Id Node Create Policy Service Action Start Deprecated
Restart, start or stop the service
POST
Cluster Cluster Node Id Node Create Policy Service Action Stop Deprecated
Restart, start or stop the service
GET
Cluster Cluster Node Id Node Read Search Service
Read NSX Search service properties
GET
Cluster Cluster Node Id Node Read Search Service Status
Read NSX Search service status
POST
Cluster Cluster Node Id Node Create Search Service Action Restart
Restart, start or stop the NSX Search service
POST
Cluster Cluster Node Id Node Create Search Service Action Start
Restart, start or stop the NSX Search service
POST
Cluster Cluster Node Id Node Create Search Service Action Stop
Restart, start or stop the NSX Search service
GET
Cluster Cluster Node Id Node Read Site Manager Service
Read the Site Manager service properties
GET
Cluster Cluster Node Id Node Read Site Manager Service Status
Read the Site Manager service status
POST
Cluster Cluster Node Id Node Create Site Manager Service Action Restart
Restart, start or stop the Site Manager service
POST
Cluster Cluster Node Id Node Create Site Manager Service Action Start
Restart, start or stop the Site Manager service
POST
Cluster Cluster Node Id Node Create Site Manager Service Action Stop
Restart, start or stop the Site Manager service
GET
Cluster Cluster Node Id Node Read SNMP Service
Read SNMP service properties
PUT
Cluster Cluster Node Id Node Update SNMP Service
Update SNMP service properties
GET
Cluster Cluster Node Id Node Read SNMP Service Status
Read SNMP service status
GET
Cluster Cluster Node Id Node Read SNMPV3 Engine ID
Read SNMP V3 Engine ID
PUT
Cluster Cluster Node Id Node Update SNMPV3 Engine ID
Update SNMP V3 Engine ID
POST
Cluster Cluster Node Id Node Create SNMP Service Action Restart
Restart, start or stop the SNMP service
POST
Cluster Cluster Node Id Node Create SNMP Service Action Start
Restart, start or stop the SNMP service
POST
Cluster Cluster Node Id Node Create SNMP Service Action Stop
Restart, start or stop the SNMP service
GET
Cluster Cluster Node Id Node Read SSH Service
Read ssh service properties
PUT
Cluster Cluster Node Id Node Update SSH Service
Update ssh service properties
POST
Cluster Cluster Node Id Node Create SSH Service Action Notify Mpa Restart
Restart, start or stop the ssh service
POST
Cluster Cluster Node Id Node Create SSH Service Action Notify Mpa Start
Restart, start or stop the ssh service
POST
Cluster Cluster Node Id Node Create SSH Service Action Notify Mpa Stop
Restart, start or stop the ssh service
GET
Cluster Cluster Node Id Node Read SSH Service Status
Read ssh service status
POST
Cluster Cluster Node Id Node Create SSH Service Remove Host Fingerprint Action Remove Host Fingerprint
Remove a host's fingerprint from known hosts file
POST
Cluster Cluster Node Id Node Create SSH Service Action Restart
Restart, start or stop the ssh service
POST
Cluster Cluster Node Id Node Create SSH Service Action Start
Restart, start or stop the ssh service
POST
Cluster Cluster Node Id Node Create SSH Service Action Stop
Restart, start or stop the ssh service
GET
Cluster Cluster Node Id Node Read Syslog Service
Read syslog service properties
DELETE
Cluster Cluster Node Id Node Delete Node Syslog Exporter All
Delete all node syslog exporters
GET
Cluster Cluster Node Id Node List Node Syslog Exporters
List node syslog exporters
POST
Cluster Cluster Node Id Node Post Node Syslog Exporter
Add node syslog exporter
DELETE
Cluster Cluster Node Id Node Delete Node Syslog Exporter
Delete node syslog exporter
GET
Cluster Cluster Node Id Node Read Node Syslog Exporter
Read node syslog exporter
POST
Cluster Cluster Node Id Node Verify Node Syslog Exporter Verify
Verify node syslog exporter
GET
Cluster Cluster Node Id Node Read Syslog Service Status
Read syslog service status
POST
Cluster Cluster Node Id Node Create Syslog Service Action Restart
Restart, start or stop the syslog service
POST
Cluster Cluster Node Id Node Create Syslog Service Action Start
Restart, start or stop the syslog service
POST
Cluster Cluster Node Id Node Create Syslog Service Action Stop
Restart, start or stop the syslog service
GET
Cluster Cluster Node Id Node Read Phonehome Coordinator Service
Read Telemetry service properties
PUT
Cluster Cluster Node Id Node Update Phonehome Coordinator Service
Update Telemetry service properties
GET
Cluster Cluster Node Id Node Read Phonehome Coordinator Service Status
Read Telemetry service status
POST
Cluster Cluster Node Id Node Reset Phonehome Coordinator Service Logging Level Action Reset Telemetry Logging Levels
Reset the logging levels to default values
POST
Cluster Cluster Node Id Node Create Phonehome Coordinator Service Action Restart
Restart, start or stop Telemetry service
POST
Cluster Cluster Node Id Node Create Phonehome Coordinator Service Action Start
Restart, start or stop Telemetry service
POST
Cluster Cluster Node Id Node Create Phonehome Coordinator Service Action Stop
Restart, start or stop Telemetry service
GET
Cluster Cluster Node Id Node Read Nsx Ui Service Service
Read ui service properties
GET
Cluster Cluster Node Id Node Read Nsx Ui Service Service Status
Read ui service status
POST
Cluster Cluster Node Id Node Create Nsx Ui Service Service Action Restart
Restart, Start and Stop the ui service
POST
Cluster Cluster Node Id Node Create Nsx Ui Service Service Action Start
Restart, Start and Stop the ui service
POST
Cluster Cluster Node Id Node Create Nsx Ui Service Service Action Stop
Restart, Start and Stop the ui service
GET
Cluster Cluster Node Id Node Read Appliance Node Status
Read node status
POST
Cluster Cluster Node Id Node Update Appliance Node Status Clear Bootup Error
Update node status
GET
Cluster Cluster Node Id Node List Appliance Management Tasks
List appliance management tasks
DELETE
Cluster Cluster Node Id Node Delete Appliance Management Task
Delete task
GET
Cluster Cluster Node Id Node Read Appliance Management Task Properties
Read task properties
GET
Cluster Cluster Node Id Node Read Async Appliance Management Task Response
Read asynchronous task response
POST
Cluster Cluster Node Id Node Cancel Appliance Management Task Cancel
Cancel specified task
GET
Cluster Cluster Node Id Node List Node Users True
List node users
DELETE
Cluster Cluster Node Id Node Delete Node User
Delete node user
GET
Cluster Cluster Node Id Node Read Node User
Read node user
PUT
Cluster Cluster Node Id Node Update Node User
Update node user
GET
Cluster Cluster Node Id Node List Node User Ssh Keys
List SSH keys from authorized_keys file for node user
POST
Cluster Cluster Node Id Node Add Node User Ssh Key Add Ssh Key
Add SSH public key to authorized_keys file for node user
POST
Cluster Cluster Node Id Node Delete Node User Ssh Key Remove Ssh Key
Remove SSH public key from authorized_keys file for node user
POST
Cluster Cluster Node Id Node Activate Node User Activate
Activate a user account with a password
POST
Cluster Cluster Node Id Node Deactivate Node User Deactivate
Deactivate a user account
POST
Cluster Cluster Node Id Node Reset Node User Password Reset Password
Reset a user's password without requiring their current password
POST
Cluster Cluster Node Id Node Create Node User Create Audit User
Create node users
POST
Cluster Cluster Node Id Node Create Node User Create User
Create node users
POST
Cluster Cluster Node Id Node Reset Node User Own Password Reset Own Password
Reset a user's own password. Requires current password
GET
Cluster Cluster Node Id Node List Node Users True
List node users
GET
Cluster Cluster Node Id Node Read Node Version
Read node version
POST
Cluster Cluster Node Id Node Restart Or Shutdown Node Restart
Restart or shutdown node
POST
Cluster Cluster Node Id Node Set Node Time Set System Time
Set the node system time
POST
Cluster Cluster Node Id Node Restart Or Shutdown Node Shutdown
Restart or shutdown node
GET
Get Cluster Node Config
Read cluster node configuration
POST
Detach Cluster Node
Detach a node from the Cluster
DELETE
Invoke Delete Cluster Central API
Invoke DELETE request on target cluster node
GET
Invoke Get Cluster Central API
Invoke GET request on target cluster node
POST
Invoke Post Cluster Central API
Invoke POST request on target cluster node
PUT
Invoke Put Cluster Central API
Invoke PUT request on target cluster node
POST
Join Cluster
Join this node to a NSX Cluster
GET
List All Nodes Logging Server Configuration Status
List all nodes logging-server configuration status
GET
List Central Node Config Profiles
List all Central Node Config profiles
PUT
Update Central Node Config Profile
Configure Node Config profile
GET
Read Central Node Config Profile
Read Central Node Config profile
GET
Get Inventory Config
Return inventory configuration
GET
Read Management Config
Read NSX Management nodes global configuration.
PUT
Update Management Config
Update NSX Management nodes global configuration
POST
Change Node Mode
NodeMode
POST
Scan Directory Domain Size Deprecated
Scan the size of a directory domain
GET
List Directory Domains Deprecated
List all configured domains
POST
Create Directory Domain Deprecated
Create a directory domain
DELETE
Delete Directory Domain Deprecated
Delete a specific domain with given identifier
GET
Get Directory Domain Deprecated
Get a specific domain with given identifier
POST
Request Directory Domain Sync Deprecated
Invoke full sync or delta sync for a specific domain, with additional delay in seconds if needed. Stop sync will try to stop any pending sync if any to return to idle state.
PUT
Update Directory Domain Deprecated
Update a directory domain
GET
Search Directory Groups Deprecated
Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)
GET
List Directory Group Member Groups Deprecated
List members of a directory group
GET
List Directory Ldap Servers Deprecated
List all configured domain LDAP servers
POST
Create Directory Ldap Server Deprecated
Create a LDAP server for directory domain
DELETE
Delete Directory Ldap Server Deprecated
Delete a LDAP server for directory domain
GET
Get Directory Ldap Server Deprecated
Get a specific LDAP server for a given directory domain
POST
Test Directory Ldap Server Deprecated
Test a LDAP server connection for directory domain
PUT
Update Directory Ldap Server Deprecated
Update a LDAP server for directory domain
POST
Fetch Directory Org Units For Directory Domain Deprecated
Fetch all organization units for a Directory domain.
GET
Get Directory Domain Sync Stats Deprecated
Get domain sync statistics for the given identifier
POST
Verify Directory Ldap Server Deprecated
Test a directory domain LDAP server connectivity
POST
Fetch Directory Org Units Deprecated
Fetch all organization units for a LDAP server.
GET
List Edge Clusters
List Edge Clusters
POST
Create Edge Cluster
Create Edge Cluster
DELETE
Delete Edge Cluster
Delete Edge Cluster
GET
Read Edge Cluster
Read Edge Cluster
PUT
Update Edge Cluster
Update Edge Cluster
GET
Get Edge Cluster Allocation Status
Get the Allocation details of an edge cluster
GET
Get Edge Cluster State
Get the Realized State of a Edge Cluster
GET
Get Edge Cluster Status
Get the status for the Edge cluster of the given id
POST
Relocate And Remove Edge Cluster Member
Relocate service contexts from edge and remove edge node from the edge-cluster
POST
Replace Edge Cluster Member Transport Node
Replace the transport node in the specified member of the edge-cluster
GET
List All Cloud Native Service Instances
Returns the List of cloud native service instances
GET
Get Cloud Native Service Instance
Returns information about a particular cloud native service instance by external-id.
GET
List Compute Collections
Return the List of Compute Collections
GET
Read Compute Collection
Return Compute Collection Information
POST
Perform Action On Compute Collection
Perform action specific to NSX on the compute-collection. cc-ext-id should be of type VC_Cluster.
GET
Get Host Node Status On Compute Collection
Get status of member host nodes of the compute-collection. Only nsx prepared host nodes in the specified compute-collection are included in the response. cc-ext-id should be of type VC_Cluster.
GET
List Compute Collection Physical Network Interfaces
List the Physical Network Interface for all discovered nodes
GET
List Compute Managers
Return the List of Compute managers
POST
Add Compute Manager
Register compute manager with NSX
GET
Get Cm Thumbprint Hashing Config
Return thumbprint hashing algorithm config used for compute manager extension
PUT
Update Cm Thumbprint Hashing Config
Update thumbprint hashing algorithm used for compute manager extension
DELETE
Delete Compute Manager
Unregister a compute manager
GET
Read Compute Manager
Return compute manager Information
PUT
Update Compute Manager
Update compute manager
GET
Get Compute Manager State
Get the realized state of a compute manager
GET
Read Compute Manager Status
Return runtime status information for a compute manager
GET
List Discovered Nodes
Return the List of Discovered Nodes
GET
Read Discovered Node
Return Discovered Node Information
POST
Create Transport Node For Discovered Node
Created Transport Node for Discovered Node
POST
Reapply TN Profile On Discovered Node
Apply cluster level config on Discovered Node
GET
Get Supported Host OS Types
Return list of supported host OS types
GET
List Physical Servers
Return the list of physical servers
GET
Get Physical Server
Return a specific physical server
GET
Get Discovered Resource Scope Associations
Retrieve scope associations for discovered resources
POST
Add Discovered Resource Scope Associations
Add scope associations for discovered resources
POST
Delete Discovered Resource Scope Associations
Delete scope associations for discovered resources
GET
List Failure Domains
List Failure Domains
POST
Create Failure Domain
Create Failure Domain
DELETE
Delete Failure Domain
Delete Failure Domain
GET
Get Failure Domain
Get a Failure Domain
PUT
Update Failure Domain
Update Failure Domain
GET
List Global Configs
List global configurations of a NSX domain
GET
Get Global Configs
Get global configs for a config type
PUT
Update Global Configs
Update global configurations of a config type
PUT
Resync Global Configs
Resyncs global configurations of a config-type
GET
List Host Switch Profiles Deprecated
List Hostswitch Profiles
POST
Create Host Switch Profile Deprecated
Create a Hostswitch Profile
DELETE
Delete Host Switch Profile Deprecated
Delete a Hostswitch Profile
GET
Get Host Switch Profile Deprecated
Get a Hostswitch Profile by ID
PUT
Update Host Switch Profile Deprecated
Update a Hostswitch Profile
GET
List Fabric Node Neighbor Properties
List LLDP Neighbor Properties of Fabric Node
GET
Read Fabric Node Neighbor Properties
Read LLDP Neighbor Properties of Fabric Node by Interface Name
GET
List Neighbor Properties
List LLDP Neighbor Properties of Transport Node
GET
Read Neighbor Properties
Read LLDP Neighbor Properties of Transport Node by Interface Name
GET
Node Read Node Properties
Read node properties
PUT
Node Update Node Properties
Update node properties
GET
Node Read Authentication Policy Properties
Read node authentication policy and password complexity configuration
PUT
Node Update Authentication Policy Properties
Update node authentication policy and password complexity configuration
POST
Node Reset Authentication Policy Properties Reset All
Resets node authentication policy and password complexity configuration
POST
Node Reset Authentication Policy Properties Reset Auth Policies
Resets node authentication policy and password complexity configuration
POST
Node Reset Authentication Policy Properties Reset Pwd Complexity
Resets node authentication policy and password complexity configuration
GET
Node Read Central Config Properties
Read Central Config properties
PUT
Node Update Central Config Properties
Update Central Config properties
GET
Node List Files
List node files
DELETE
Node Delete File
Delete file
GET
Node Read File Properties
Read file properties
POST
Node Create File
Upload a file to the file store
GET
Read File
Read file contents
PUT
Update File
Replace file contents
GET
Node Read File Thumbprint
Read file thumbprint
POST
Node Copy From Remote File Copy From Remote File
Copy a remote file to the file store
POST
Node Copy To Remote File Copy To Remote File
Copy file in the file store to a remote file store
POST
Node Create Remote Directory Create Remote Directory
Create directory in remote file server
DELETE
Node Delete Remote Directory Delete Remote Directory
Delete directory in remote file server
POST
Node Retrieve Ssh Fingerprint Retrieve Ssh Fingerprint
Retrieve ssh fingerprint for given remote server
GET
Node List Node Grub Properties
Return node GRUB properties
PUT
Node Update Node Grub Properties
Update node GRUB properties
PUT
Node Update Node Grub User
Update node GRUB user properties
GET
Node Get Node Mandatory Access Control
Gets the enable status for Mandatory Access Control
PUT
Node Set Node Mandatory Access Control
Enable or disable Mandatory Access Control
GET
Node Get Node Mandatory Access Control Report
Get the report for Mandatory Access Control
GET
Node List Intelligence Form Factors Deprecated
List available Napp appliance form factors
GET
Node List Node Logs
List available node logs
GET
Node Read Node Log
Read node log properties
GET
Node Read Node Log Data
Read node log contents
DELETE
Node Delete Management Plane Configuration
Delete management plane configuration for this node
GET
Node Read Management Plane Configuration
Get management plane configuration for this node
PUT
Node Update Management Plane Configuration
Update management plane configuration for this node
GET
Node Get Node Mode
NodeMode
GET
Node Read Node Motd
Read node message of the day
DELETE
Node Delete MPA Configuration
Delete MPA configuration for this node
GET
Node Read MPA Configuration
Get MPA configuration for this node
PUT
Node Update MPA Configuration
Update MPA configuration for this node
GET
Node Read Network Properties
Read network configuration properties
GET
Node List Node Interfaces
List the Node's Network Interfaces
GET
Node Read Node Interface
Read the Node's Network Interface
PUT
Node Update Node Interface
Update the Node's Network Interface
GET
Node Read Network Interface Statistics
Read the Node's Network Interface Statistics
GET
Node Read Node Name Servers
Read the Node's Name Servers
PUT
Node Update Node Name Servers
Update the Node's Name Servers
GET
Node List Node Network Routes
List node network routes
POST
Node Create Node Network Route
Create node network route
DELETE
Node Delete Node Network Route
Delete node network route
GET
Node Read Node Network Route
Read node network route
GET
Node Read Node Search Domains
Read the Node's Search Domains
PUT
Node Update Node Search Domains
Update the Node's Search Domains
GET
Node List Node Processes
List node processes
GET
Node Read Node Process
Read node process
GET
Node List Node Services
List node services
GET
Node Read Async Replicator Service
Read the Async Replicator service properties
PUT
Node Update Async Replicator Service
Update the async_replicator service properties
GET
Node Read Async Replicator Service Status
Read the Async Replicator service status
POST
Node Create Async Replicator Service Action Restart
Restart, start or stop the Async Replicator service
POST
Node Create Async Replicator Service Action Start
Restart, start or stop the Async Replicator service
POST
Node Create Async Replicator Service Action Stop
Restart, start or stop the Async Replicator service
GET
Node Read Auth Service
Read auth service properties
PUT
Node Update Auth Service
Update auth service properties
GET
Node Read Auth Service Status
Read auth service status
POST
Node Create Auth Service Action Restart Restart
Restart the auth service
POST
Node Create Auth Service Action Start Start
Start the auth service
POST
Node Create Auth Service Action Stop Stop
Stop the auth service
GET
Node Read Cluster Boot Manager Service
Read cluster boot manager service properties
GET
Node Read Cluster Boot Manager Service Status
Read cluster boot manager service status
POST
Node Create Cluster Boot Manager Service Action Restart
Restart, start or stop the cluster boot manager service
POST
Node Create Cluster Boot Manager Service Action Start
Restart, start or stop the cluster boot manager service
POST
Node Create Cluster Boot Manager Service Action Stop
Restart, start or stop the cluster boot manager service
GET
Node Read Cminventory Service
Read cm inventory service properties
GET
Node Read Cminventory Service Status
Read manager service status
POST
Node Create Cminventory Service Action Restart
Restart, start or stop the manager service
POST
Node Create Cminventory Service Action Start
Restart, start or stop the manager service
POST
Node Create Cminventory Service Action Stop
Restart, start or stop the manager service
GET
Node Read Controller Server Service
Read controller service properties
GET
Node Read Controller Server Certificate
Read controller server certificate properties
GET
Node Get Controller Profiler Status
Get the status (Enabled/Disabled) of controller profiler
PUT
Node Set Controller Profiler
Enable or disable controller profiler
GET
Node Read Controller Server Service Status
Read controller service status
POST
Node Create Controller Server Service Action Restart
Restart, start or stop the controller service
POST
Node Create Controller Server Service Action Start
Restart, start or stop the controller service
POST
Node Create Controller Server Service Action Stop
Restart, start or stop the controller service
GET
Node Read Corfu Server Service
Read the Corfu Server service properties
GET
Node Get Corfu Certificate Expiry Check Status
Get the status of Corfu Certificate Expiry Check. Enabled or disabled
POST
Node Corfu Certificate Expiry Check Disable
Enable or Disable Corfu Certificate Expiry Check. Default is enabled
POST
Node Corfu Certificate Expiry Check Enable
Enable or Disable Corfu Certificate Expiry Check. Default is enabled
GET
Node Read Corfu Server Service Status
Read the Corfu Server service status
POST
Node Create Corfu Server Service Action Restart
Restart, start or stop the Corfu Server service
POST
Node Create Corfu Server Service Action Start
Restart, start or stop the Corfu Server service
POST
Node Create Corfu Server Service Action Stop
Restart, start or stop the Corfu Server service
GET
Node Read Corfu Log Replication Server Service
Read the Corfu Log Replication Server service properties
GET
Node Read Corfu Log Replication Server Service Status
Read the Corfu Log Replication Server service status
POST
Node Create Corfu Log Replication Server Service Action Restart
Restart, start or stop the Corfu Log Replication Server service
POST
Node Create Corfu Log Replication Server Service Action Start
Restart, start or stop the Corfu Log Replication Server service
POST
Node Create Corfu Log Replication Server Service Action Stop
Restart, start or stop the Corfu Log Replication Server service
GET
Node Read Corfu Nonconfig Server Service
Read the Corfu Nonconfig Server service properties
GET
Node Read Corfu Nonconfig Server Service Status
Read the Corfu Nonconfig Server service status
POST
Node Create Corfu Nonconfig Server Service Action Restart
Restart, start or stop the Corfu Nonconfig Server service
POST
Node Create Corfu Nonconfig Server Service Action Start
Restart, start or stop the Corfu Nonconfig Server service
POST
Node Create Corfu Nonconfig Server Service Action Stop
Restart, start or stop the Corfu Nonconfig Server service
GET
Node Read Proxy Service
Read http service properties
PUT
Node Update Proxy Service
Update http service properties
GET
Node Read Proxy Service Status
Read http service status
POST
Node Create Proxy Service Apply Certificate Action Apply Certificate Deprecated
Update http service certificate
POST
Node Create Proxy Service Action Restart Restart
Restart the http service
POST
Node Create Proxy Service Action Start Start
Start the http service
POST
Node Create Proxy Service Action Stop Stop
Stop the http service
GET
Node Read Idps Reporting Service
Read the idps-reporting service properties
GET
Node Read Idps Reporting Service Status
Read the idps-reporting service status
POST
Node Create Idps Reporting Service Action Restart
Restart, start or stop the idps-reporting service
POST
Node Create Idps Reporting Service Action Start
Restart, start or stop the idps-reporting service
POST
Node Create Idps Reporting Service Action Stop
Restart, start or stop the idps-reporting service
GET
Node Read Repository Service
Read NSX install-upgrade service properties
PUT
Node Update Repository Service
Update NSX install-upgrade service properties
GET
Node Read Repository Service Status
Read NSX install-upgrade service status
PUT
Node Update Uc State
Update UC state properties
POST
Node Create Repository Service Action Restart
Restart, start or stop the NSX install-upgrade service
POST
Node Create Repository Service Action Start
Restart, start or stop the NSX install-upgrade service
POST
Node Create Repository Service Action Stop
Restart, start or stop the NSX install-upgrade service
GET
Node Read Liagent Service
Read liagent service properties
GET
Node Read Liagent Service Status
Read liagent service status
POST
Node Create Liagent Service Action Restart
Restart, start or stop the liagent service
POST
Node Create Liagent Service Action Start
Restart, start or stop the liagent service
POST
Node Create Liagent Service Action Stop
Restart, start or stop the liagent service
GET
Node Read Proton Service
Read service properties
PUT
Node Update Proton Service
Update service properties
GET
Node Read Proton Service Status
Read service status
POST
Node Reset Proton Service Logging Level Action Reset Manager Logging Levels
Reset the logging levels to default values
POST
Node Create Proton Service Action Restart
Restart, start or stop the service
POST
Node Create Proton Service Action Start
Restart, start or stop the service
POST
Node Create Proton Service Action Stop
Restart, start or stop the service
GET
Node Read NSX Messaging Manager Service
Read NSX Messaging Manager service properties
GET
Node Read NSX Messaging Manager Service Status
Read NSX Messaging Manager service status
POST
Node Create NSX Messaging Manager Service Action Restart
Restart, start or stop the NSX Messaging Manager service
POST
Node Create NSX Messaging Manager Service Action Start
Restart, start or stop the NSX Messaging Manager service
POST
Node Create NSX Messaging Manager Service Action Stop
Restart, start or stop the NSX Messaging Manager service
GET
Node Read Migration Coordinator Service
Read migration coordinator service properties
GET
Node Read Migration Coordinator Service Status
Read migration coordinator service status
POST
Node Create Migration Coordinator Service Action Restart
Restart, start or stop the migration coordinator service
POST
Node Create Migration Coordinator Service Action Start
Restart, start or stop the migration coordinator service
POST
Node Create Migration Coordinator Service Action Stop
Restart, start or stop the migration coordinator service
GET
Node Read Appliance Management Service
Read appliance management service properties
GET
Node Get Node Management Log Level
Retrieve Node Management loglevel
PUT
Node Set Node Management Log Level
Set Node Management loglevel
GET
Node Read Appliance Management Service Status
Read appliance management service status
POST
Node Create Appliance Management Service Action Restart
Restart the node management service
GET
Node Read Node Stats Service
Read NSX node-stats service properties
GET
Node Read Node Stats Service Status
Read NSX node-stats service status
POST
Node Create Node Stats Service Action Restart
Restart, start or stop the NSX node-stats service
POST
Node Create Node Stats Service Action Start
Restart, start or stop the NSX node-stats service
POST
Node Create Node Stats Service Action Stop
Restart, start or stop the NSX node-stats service
GET
Node Read NSX Message Bus Service
Read NSX Message Bus service properties
GET
Node Read NSX Message Bus Service Status
Read NSX Message Bus service status
POST
Node Create NSX Message Bus Service Action Restart
Restart, start or stop the NSX Message Bus service
POST
Node Create NSX Message Bus Service Action Start
Restart, start or stop the NSX Message Bus service
POST
Node Create NSX Message Bus Service Action Stop
Restart, start or stop the NSX Message Bus service
GET
Node Read Platform Client Service
Read NSX Platform Client service properties
GET
Node Read Platform Client Service Status
Read NSX Platform Client service status
POST
Node Create Platform Client Service Action Restart
Restart, start or stop the NSX Platform Client service
POST
Node Create Platform Client Service Action Start
Restart, start or stop the NSX Platform Client service
POST
Node Create Platform Client Service Action Stop
Restart, start or stop the NSX Platform Client service
GET
Node Read Nsx Upgrade Agent Service
Read NSX upgrade Agent service properties
GET
Node Read Nsx Upgrade Agent Service Status
Read Nsx upgrade agent service status
POST
Node Create Nsx Upgrade Agent Service Action Restart
Restart, start or stop the NSX upgrade agent service
POST
Node Create Nsx Upgrade Agent Service Action Start
Restart, start or stop the NSX upgrade agent service
POST
Node Create Nsx Upgrade Agent Service Action Stop
Restart, start or stop the NSX upgrade agent service
GET
Node Read NTP Service
Read NTP service properties
PUT
Node Update NTP Service
Update NTP service properties
GET
Node Read NTP Service Status
Read NTP service status
POST
Node Create NTP Service Action Restart
Restart, start or stop the NTP service
POST
Node Create NTP Service Action Start
Restart, start or stop the NTP service
POST
Node Create NTP Service Action Stop
Restart, start or stop the NTP service
GET
Node Read Policy Service Deprecated
Read service properties
PUT
Node Update Policy Service Deprecated
Update service properties
GET
Node Read Policy Service Status Deprecated
Read service status
POST
Node Reset Policy Service Logging Level Action Reset Manager Logging Levels Deprecated
Reset the logging levels to default values
POST
Node Create Policy Service Action Restart Deprecated
Restart, start or stop the service
POST
Node Create Policy Service Action Start Deprecated
Restart, start or stop the service
POST
Node Create Policy Service Action Stop Deprecated
Restart, start or stop the service
GET
Node Read Search Service
Read NSX Search service properties
GET
Node Read Search Service Status
Read NSX Search service status
POST
Node Create Search Service Action Restart
Restart, start or stop the NSX Search service
POST
Node Create Search Service Action Start
Restart, start or stop the NSX Search service
POST
Node Create Search Service Action Stop
Restart, start or stop the NSX Search service
GET
Node Read Site Manager Service
Read the Site Manager service properties
GET
Node Read Site Manager Service Status
Read the Site Manager service status
POST
Node Create Site Manager Service Action Restart
Restart, start or stop the Site Manager service
POST
Node Create Site Manager Service Action Start
Restart, start or stop the Site Manager service
POST
Node Create Site Manager Service Action Stop
Restart, start or stop the Site Manager service
GET
Node Read SNMP Service
Read SNMP service properties
PUT
Node Update SNMP Service
Update SNMP service properties
GET
Node Read SNMP Service Status
Read SNMP service status
GET
Node Read SNMPV3 Engine ID
Read SNMP V3 Engine ID
PUT
Node Update SNMPV3 Engine ID
Update SNMP V3 Engine ID
POST
Node Create SNMP Service Action Restart
Restart, start or stop the SNMP service
POST
Node Create SNMP Service Action Start
Restart, start or stop the SNMP service
POST
Node Create SNMP Service Action Stop
Restart, start or stop the SNMP service
GET
Node Read SSH Service
Read ssh service properties
PUT
Node Update SSH Service
Update ssh service properties
POST
Node Create SSH Service Action Notify Mpa Restart
Restart, start or stop the ssh service
POST
Node Create SSH Service Action Notify Mpa Start
Restart, start or stop the ssh service
POST
Node Create SSH Service Action Notify Mpa Stop
Restart, start or stop the ssh service
GET
Node Read SSH Service Status
Read ssh service status
POST
Node Create SSH Service Remove Host Fingerprint Action Remove Host Fingerprint
Remove a host's fingerprint from known hosts file
POST
Node Create SSH Service Action Restart
Restart, start or stop the ssh service
POST
Node Create SSH Service Action Start
Restart, start or stop the ssh service
POST
Node Create SSH Service Action Stop
Restart, start or stop the ssh service
GET
Node Read Syslog Service
Read syslog service properties
DELETE
Node Delete Node Syslog Exporter All
Delete all node syslog exporters
GET
Node List Node Syslog Exporters
List node syslog exporters
POST
Node Post Node Syslog Exporter
Add node syslog exporter
DELETE
Node Delete Node Syslog Exporter
Delete node syslog exporter
GET
Node Read Node Syslog Exporter
Read node syslog exporter
POST
Node Verify Node Syslog Exporter Verify
Verify node syslog exporter
GET
Node Read Syslog Service Status
Read syslog service status
POST
Node Create Syslog Service Action Restart
Restart, start or stop the syslog service
POST
Node Create Syslog Service Action Start
Restart, start or stop the syslog service
POST
Node Create Syslog Service Action Stop
Restart, start or stop the syslog service
GET
Node Read Phonehome Coordinator Service
Read Telemetry service properties
PUT
Node Update Phonehome Coordinator Service
Update Telemetry service properties
GET
Node Read Phonehome Coordinator Service Status
Read Telemetry service status
POST
Node Reset Phonehome Coordinator Service Logging Level Action Reset Telemetry Logging Levels
Reset the logging levels to default values
POST
Node Create Phonehome Coordinator Service Action Restart
Restart, start or stop Telemetry service
POST
Node Create Phonehome Coordinator Service Action Start
Restart, start or stop Telemetry service
POST
Node Create Phonehome Coordinator Service Action Stop
Restart, start or stop Telemetry service
GET
Node Read Nsx Ui Service Service
Read ui service properties
GET
Node Read Nsx Ui Service Service Status
Read ui service status
POST
Node Create Nsx Ui Service Service Action Restart
Restart, Start and Stop the ui service
POST
Node Create Nsx Ui Service Service Action Start
Restart, Start and Stop the ui service
POST
Node Create Nsx Ui Service Service Action Stop
Restart, Start and Stop the ui service
GET
Node Read Appliance Node Status
Read node status
POST
Node Update Appliance Node Status Clear Bootup Error
Update node status
GET
Read Node Support Bundle
Read node support bundle
GET
Node List Appliance Management Tasks
List appliance management tasks
DELETE
Node Delete Appliance Management Task
Delete task
GET
Node Read Appliance Management Task Properties
Read task properties
GET
Node Read Async Appliance Management Task Response
Read asynchronous task response
POST
Node Cancel Appliance Management Task Cancel
Cancel specified task
GET
Node List Node Users True
List node users
DELETE
Node Delete Node User
Delete node user
GET
Node Read Node User
Read node user
PUT
Node Update Node User
Update node user
GET
Node List Node User Ssh Keys
List SSH keys from authorized_keys file for node user
POST
Node Add Node User Ssh Key Add Ssh Key
Add SSH public key to authorized_keys file for node user
POST
Node Delete Node User Ssh Key Remove Ssh Key
Remove SSH public key from authorized_keys file for node user
POST
Node Activate Node User Activate
Activate a user account with a password
POST
Node Deactivate Node User Deactivate
Deactivate a user account
POST
Node Reset Node User Password Reset Password
Reset a user's password without requiring their current password
POST
Node Create Node User Create Audit User
Create node users
POST
Node Create Node User Create User
Create node users
POST
Node Reset Node User Own Password Reset Own Password
Reset a user's own password. Requires current password
GET
Node List Node Users True
List node users
GET
Node Read Node Version
Read node version
POST
Node Restart Or Shutdown Node Restart
Restart or shutdown node
POST
Node Set Node Time Set System Time
Set the node system time
POST
Node Restart Or Shutdown Node Shutdown
Restart or shutdown node
GET
Get Nvds Upgrade Precheck Id Deprecated
Retrieve latest precheck ID of the N-VDS to VDS migration
POST
Create Nvds Upgrade Precheck Deprecated
Start precheck for N-VDS to VDS migration
GET
Get Nvds Upgrade Precheck Id By Cluster Deprecated
Retrieve latest precheck ID of the N-VDS to VDS migration for the cluster
POST
Create Nvds Upgrade Precheck By Cluster Deprecated
Start precheck for N-VDS to VDS migration by cluster
POST
Create Nvds Upgrade Precheck By Clusters Deprecated
Start precheck for N-VDS to VDS migration by clusters
GET
Get Nvds Upgrade Readiness Check Summary By Cluster Deprecated
Get summary of N-VDS to VDS migration
GET
Get Nvds Upgrade Readiness Check Summary Deprecated
Get summary of N-VDS to VDS migration
GET
Get Recommended Vds Topology By Cluster Deprecated
Recommmended topology
POST
Set Target Vds Topology By Cluster Deprecated
Set VDS configuration and create it in vCenter
GET
Get Recommended Vds Topology Deprecated
Recommmended topology
POST
Set Target Vds Topology Deprecated
Set VDS configuration and create it in vCenter
POST
Unset Target Vds Topology Deprecated
Unset VDS configuration and remove it from vCenter
POST
Nvds Upgrade Cleanup Deprecated
Clean up all nvds upgrade related configurations
POST
Ignore Migrate Status Deprecated
Set the migrate status key of ExtraConfigProfile of all Transport Nodes to IGNORE
GET
List Ip Blocks Deprecated
Returns list of configured IP address blocks.
POST
Create Ip Block Deprecated
Create a new IP address block.
DELETE
Delete Ip Block Deprecated
Delete an IP Address Block
GET
Read Ip Block Deprecated
Get IP address block information.
PUT
Update Ip Block Deprecated
Update an IP Address Block
GET
List Ip Pools Deprecated
List IP Pools
POST
Create Ip Pool Deprecated
Create an IP Pool
DELETE
Delete Ip Pool Deprecated
Delete an IP Pool
GET
Read Ip Pool Deprecated
Read IP Pool
POST
Allocate Or Release From Ip Pool Deprecated
Allocate or Release an IP Address from a Pool
PUT
Update Ip Pool Deprecated
Update an IP Pool
GET
List Ip Pool Allocations Deprecated
List IP Pool Allocations
GET
List Ip Block Subnets Deprecated
List subnets within an IP block
POST
Create Ip Block Subnet Deprecated
Create subnet of specified size within an IP block
DELETE
Delete Ip Block Subnet Deprecated
Delete subnet within an IP block
GET
Read Ip Block Subnet Deprecated
Get the subnet within an IP block
POST
Allocate Or Release From Ip Block Subnet Deprecated
Allocate or Release an IP Address from a Ip Subnet
GET
List Mac Pools
List MAC Pools
GET
Read Mac Pool
Read MAC Pool
GET
List VNI Pools
List VNI Pools
POST
Create VNI Pool
Create a new VNI Pool.
DELETE
Delete VNI Pool
Delete a VNI Pool
GET
Read VNI Pool
Read VNI Pool
PUT
Update VNI Pool
Update a VNI Pool
GET
List Vtep Label Pools
List virtual tunnel endpoint Label Pools
GET
Read Vtep Label Pool
Read a virtual tunnel endpoint label pool
GET
Get Realization State Barrier Config
Gets the realization state barrier configuration
PUT
Update Realization State Barrier Config
Updates the barrier configuration
GET
Get Current Barrier Deprecated
Gets the current barrier number
POST
Increment Realization State Barrier Deprecated
Increments the barrier count by 1
GET
Get Bundle Ids
Get list of bundle-ids which are available in repository or in-progress
POST
Upload Bundle Via Remote File
Upload bundle using remote file
GET
Get Ovf Deploy Info
Get information of the OVF which will be getting deployed.
GET
Get Bundle Upload Permissions
Checks bundle upload permissions
GET
Get Bundle Upload Status
Get bundle upload status
POST
Cancel Bundle Upload
Cancel bundle upload
POST
Upload Bundle Via Local File
Upload bundle
GET
Get Site Configuration
Get the site configuration
GET
Compatible List
Get the compatibility list of the site
GET
Compatible List Remote
Check whether the remote site version is compatible to this site
GET
Get Site Self
Get the local site configuration
GET
Get Federation Status
Get overall status of the federation, including stub status
GET
Make Active Status
Get the switchover status
GET
Get Site Configuration Versioned302
Get the site configuration, some attributes won't be shown based on version
GET
Get Site Configuration Versioned310
Get the site configuration, some attributes won't be shown based on version
GET
Get Site Configuration Versioned Latest
Get the site configuration, some attributes won't be shown based on version
GET
List Tasks
Get information about all tasks
GET
Read Task Properties
Get information about the specified task
GET
Read Task Result
Get the response of a task
GET
List Transport Node Collections
List Transport Node collections
POST
Create Transport Node Collection
Create transport node collection by attaching Transport Node Profile to cluster.
DELETE
Delete Transport Node Collection
Detach transport node profile from compute collection.
GET
Get Transport Node Collection
Get Transport Node collection by id
PUT
Update Transport Node Collection
Update Transport Node collection
GET
Get Transport Node Collection State
Get Transport Node collection application state
POST
Retry Transport Node Collection Realization
Retry the process on applying transport node profile
GET
List Transport Node Profiles Deprecated
List Transport Nodes
POST
Create Transport Node Profile Deprecated
Create a Transport Node Profile
DELETE
Delete Transport Node Profile Deprecated
Delete a Transport Node Profile
GET
Get Transport Node Profile Deprecated
Get a Transport Node
PUT
Update Transport Node Profile Deprecated
Update a Transport Node Profile
GET
List Transport Nodes With Deployment Info
List Transport Nodes
POST
Create Transport Node With Deployment Info
Create a Transport Node
GET
List Transport Nodes By State With Deployment Info
List transport nodes by realized state
GET
Get All Transport Nodes Status
Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.
POST
Cleanup Edge Transport Node Stale Entry
Clear edge transport node stale entry
GET
Get Fabric Node Modules Of Transport Node Deprecated
Get the module details of a transport node
GET
Get Pnic Statuses For Transport Node
Get high-level summary of a transport node
GET
List Remote Transport Node Status
Read status of all transport nodes with tunnel connections to transport node
GET
Get Transport Node Status
Read status of a transport node
GET
Query Tunnels
List of tunnels
GET
Get Tunnel
Tunnel properties
POST
Add Or Update Edge Placement References
Add or update deployment references of edge VM.
POST
Redeploy Edge Transport Node
Redeploys a new node that replaces the specified edge node.
DELETE
Invoke Delete Transport Node Central API
Invoke DELETE request on target transport node
GET
Invoke Get Transport Node Central API
Invoke GET request on target transport node
POST
Invoke Post Transport Node Central API
Invoke POST request on target transport node
PUT
Invoke Put Transport Node Central API
Invoke PUT request on target transport node
DELETE
Delete Transport Node With Deployment Info
Delete a Transport Node
GET
Get Transport Node With Deployment Info
Get a Transport Node
PUT
Update Transport Node With Deployment Info
Update a Transport Node
GET
List Transport Node Capabilities
Return the list of capabilities of transport node
GET
List Transport Node Interfaces
List the specified transport node's network interfaces
GET
Read Transport Node Interface
Read the transport node's network interface
GET
Read Transport Node Interface Statistics
Read counters for transport node interfaces.
GET
Transport Nodes Transport Node Id Node Read Node Properties
Read node properties
PUT
Transport Nodes Transport Node Id Node Update Node Properties
Update node properties
GET
Transport Nodes Transport Node Id Node Read Authentication Policy Properties
Read node authentication policy and password complexity configuration
PUT
Transport Nodes Transport Node Id Node Update Authentication Policy Properties
Update node authentication policy and password complexity configuration
POST
Transport Nodes Transport Node Id Node Reset Authentication Policy Properties Reset All
Resets node authentication policy and password complexity configuration
POST
Transport Nodes Transport Node Id Node Reset Authentication Policy Properties Reset Auth Policies
Resets node authentication policy and password complexity configuration
POST
Transport Nodes Transport Node Id Node Reset Authentication Policy Properties Reset Pwd Complexity
Resets node authentication policy and password complexity configuration
GET
Transport Nodes Transport Node Id Node Read Node Certificate
Read node certificate properties
GET
Transport Nodes Transport Node Id Node Read Node Configuration
Current configuration for this node
GET
Transport Nodes Transport Node Id Node Read Edge Diagnosis
Read edge config diagnosis
GET
Transport Nodes Transport Node Id Node Read Edge Diagnosis Inconsistency
Read edge diagnosis inconsistency
GET
Transport Nodes Transport Node Id Node List Files
List node files
DELETE
Transport Nodes Transport Node Id Node Delete File
Delete file
GET
Transport Nodes Transport Node Id Node Read File Properties
Read file properties
POST
Transport Nodes Transport Node Id Node Create File
Upload a file to the file store
GET
Transport Nodes Transport Node Id Node Read File Thumbprint
Read file thumbprint
POST
Transport Nodes Transport Node Id Node Copy From Remote File Copy From Remote File
Copy a remote file to the file store
POST
Transport Nodes Transport Node Id Node Copy To Remote File Copy To Remote File
Copy file in the file store to a remote file store
POST
Transport Nodes Transport Node Id Node Create Remote Directory Create Remote Directory
Create directory in remote file server
DELETE
Transport Nodes Transport Node Id Node Delete Remote Directory Delete Remote Directory
Delete directory in remote file server
POST
Transport Nodes Transport Node Id Node Retrieve Ssh Fingerprint Retrieve Ssh Fingerprint
Retrieve ssh fingerprint for given remote server
GET
Transport Nodes Transport Node Id Node Read Flows
Get NSX Edge stateful flows
GET
Transport Nodes Transport Node Id Node Read Iface Flows
Get NSX Edge stateful flows by interface
GET
Transport Nodes Transport Node Id Node Read Router Flows
Get NSX Edge stateful flows by router
GET
Transport Nodes Transport Node Id Node List Node Grub Properties
Return node GRUB properties
PUT
Transport Nodes Transport Node Id Node Update Node Grub Properties
Update node GRUB properties
PUT
Transport Nodes Transport Node Id Node Update Node Grub User
Update node GRUB user properties
GET
Transport Nodes Transport Node Id Node Get Node Mandatory Access Control
Gets the enable status for Mandatory Access Control
PUT
Transport Nodes Transport Node Id Node Set Node Mandatory Access Control
Enable or disable Mandatory Access Control
GET
Transport Nodes Transport Node Id Node Get Node Mandatory Access Control Report
Get the report for Mandatory Access Control
GET
Transport Nodes Transport Node Id Node List Logical Routers Diagnosis
Logical-routers diagnosis
GET
Transport Nodes Transport Node Id Node List Logical Router Diagnosis
Logical-router diagnosis
GET
Transport Nodes Transport Node Id Node List Node Logs
List available node logs
GET
Transport Nodes Transport Node Id Node Read Node Log
Read node log properties
GET
Transport Nodes Transport Node Id Node Read Node Log Data
Read node log contents
GET
Transport Nodes Transport Node Id Node Read Maintenance Mode
Get Edge maintenance mode
PUT
Transport Nodes Transport Node Id Node Update Maintenance Mode
Set Edge maintenance mode
GET
Transport Nodes Transport Node Id Node Read Node Motd
Read node message of the day
GET
Transport Nodes Transport Node Id Node Read Network Properties
Read network configuration properties
GET
Transport Nodes Transport Node Id Node List Node Interfaces
List the Node's Network Interfaces
GET
Transport Nodes Transport Node Id Node Read Node Interface
Read the Node's Network Interface
PUT
Transport Nodes Transport Node Id Node Update Node Interface
Update the Node's Network Interface
GET
Transport Nodes Transport Node Id Node Read Network Interface Statistics
Read the Node's Network Interface Statistics
GET
Transport Nodes Transport Node Id Node Read Node Name Servers
Read the Node's Name Servers
PUT
Transport Nodes Transport Node Id Node Update Node Name Servers
Update the Node's Name Servers
GET
Transport Nodes Transport Node Id Node List Node Network Routes
List node network routes
POST
Transport Nodes Transport Node Id Node Create Node Network Route
Create node network route
DELETE
Transport Nodes Transport Node Id Node Delete Node Network Route
Delete node network route
GET
Transport Nodes Transport Node Id Node Read Node Network Route
Read node network route
GET
Transport Nodes Transport Node Id Node Read Node Search Domains
Read the Node's Search Domains
PUT
Transport Nodes Transport Node Id Node Update Node Search Domains
Update the Node's Search Domains
GET
Transport Nodes Transport Node Id Node List Node Processes
List node processes
GET
Transport Nodes Transport Node Id Node Read Node Process
Read node process
GET
Transport Nodes Transport Node Id Node List Node Services
List node services
GET
Transport Nodes Transport Node Id Node Read Edge Datapath Service
Read NSX EdgeDatapath service properties
PUT
Transport Nodes Transport Node Id Node Update Edge Datapath Service
Update NSX Edge Datapath service properties
GET
Transport Nodes Transport Node Id Node Read Cpu Stats
Get NSX Edge dataplane cpu stats
PUT
Transport Nodes Transport Node Id Node Update Ctrl Prio Setting
Update NSX Edge dataplane control packets prioritization setting
GET
Transport Nodes Transport Node Id Node Read Flow Cache Setting
Get NSX Edge dataplane flow cache setting
PUT
Transport Nodes Transport Node Id Node Update Flow Cache Setting
Update NSX Edge dataplane flow cache setting
GET
Transport Nodes Transport Node Id Node Get Flow Monitor Top K
Return top 10 flows information
PUT
Transport Nodes Transport Node Id Node Start Flow Monitor With Arg
Start NSX Edge dataplane flow monitor
GET
Transport Nodes Transport Node Id Node Read Fw Conns
Get NSX Edge dataplane firewall connections
GET
Transport Nodes Transport Node Id Node Read Fw Stats
Get NSX Edge dataplane firewall stats
GET
Transport Nodes Transport Node Id Node Read Geneve Cbit Setting
Get NSX Edge dataplane geneve cbit setting
PUT
Transport Nodes Transport Node Id Node Update Geneve Cbit Setting
Update NSX Edge dataplane geneve cbit setting
PUT
Transport Nodes Transport Node Id Node Update Intr Mode
Update NSX Edge dataplane interrupt mode setting
GET
Transport Nodes Transport Node Id Node Read L 2vpn Pmtu Setting
Get NSX Edge dataplane l2vpn pmtu message generation setting
PUT
Transport Nodes Transport Node Id Node Update L 2vpn Pmtu Setting
Update NSX Edge dataplane l2vpn pmtu message generation setting
GET
Transport Nodes Transport Node Id Node Read Pmtu Learning Setting Depreciated Deprecated
Depreciated. Please use /node/services/dataplane/pmtu-learning
PUT
Transport Nodes Transport Node Id Node Update Pmtu Learning Setting Depreciated Deprecated
Depreciated. Please use /node/services/dataplane/pmtu-learning
GET
Transport Nodes Transport Node Id Node Get Physical Port Stats
Get the physical port statistics
GET
Transport Nodes Transport Node Id Node Get Physical Port X Stats
Get the physical port extended statistics
GET
Transport Nodes Transport Node Id Node Read Pmtu Learning Setting
Get NSX Edge dataplane pmtu learning setting
PUT
Transport Nodes Transport Node Id Node Update Pmtu Learning Setting
Update NSX Edge dataplane pmtu learning setting
PUT
Transport Nodes Transport Node Id Node Update Qat Admin Status
Update NSX Edge dataplane QAT feature enabled status
GET
Transport Nodes Transport Node Id Node Read Qat Status
Get NSX Edge dataplane QAT setting
GET
Transport Nodes Transport Node Id Node Read Queue Num Per Port Per Core
Get NSX Edge rx and tx queue number per port per core
PUT
Transport Nodes Transport Node Id Node Update Queue Num Per Port Per Core
Set NSX Edge rx and tx queue number per port per core
GET
Transport Nodes Transport Node Id Node Get Ring Size
Return rx/tx ring size information
PUT
Transport Nodes Transport Node Id Node Update Rx Ring Size
Set NSX Edge rx ring size for physical ports
GET
Transport Nodes Transport Node Id Node Read Edge Datapath Service Status
Read NSX EdgeDatapath service status
PUT
Transport Nodes Transport Node Id Node Update Tx Ring Size
Set NSX Edge tx ring size for physical ports
GET
Transport Nodes Transport Node Id Node Get Upt Mode
Check UPT mode enabled status of NSX Edge dataplane
POST
Transport Nodes Transport Node Id Node Create Edge Datapath Service Action Restart
Restart, start or stop the NSX EdgeDatapath service
POST
Transport Nodes Transport Node Id Node Create Edge Datapath Service Action Start
Restart, start or stop the NSX EdgeDatapath service
POST
Transport Nodes Transport Node Id Node Create Edge Datapath Service Action Stop
Restart, start or stop the NSX EdgeDatapath service
GET
Transport Nodes Transport Node Id Node Read Edge DHCP Service
Read NSX Edge DHCP service properties
PUT
Transport Nodes Transport Node Id Node Update Edge DHCP Service
Update NSX Edge DHCP service properties
GET
Transport Nodes Transport Node Id Node Read Edge DHCP Service Status
Read NSX Edge DHCP service status
GET
Transport Nodes Transport Node Id Node Read Edge Dispatcher Service
Read NSX Edge Dispatcher service properties
GET
Transport Nodes Transport Node Id Node Read Edge Dispatcher Service Status
Read NSX Edge Dispatcher service status
POST
Transport Nodes Transport Node Id Node Create Edge Dispatcher Service Action Restart
Restart, start or stop the NSX Edge Dispatcher service
POST
Transport Nodes Transport Node Id Node Create Edge Dispatcher Service Action Start
Restart, start or stop the NSX Edge Dispatcher service
POST
Transport Nodes Transport Node Id Node Create Edge Dispatcher Service Action Stop
Restart, start or stop the NSX Edge Dispatcher service
GET
Transport Nodes Transport Node Id Node Read Edge Docker Service
Read NSX Edge Docker service properties
GET
Transport Nodes Transport Node Id Node Read Edge Docker Service Status
Read NSX Edge Docker service status
GET
Transport Nodes Transport Node Id Node Read Edge Ipsec VPN Service
Read NSX Edge Ipsec VPN service properties
PUT
Transport Nodes Transport Node Id Node Update Edge Ipsec VPN Service
Update NSX Edge Ipsec VPN service properties
GET
Transport Nodes Transport Node Id Node Read Edge Ipsec VPN Service Status
Read NSX Edge Ipsec VPN service status
GET
Transport Nodes Transport Node Id Node Read Liagent Service
Read liagent service properties
GET
Transport Nodes Transport Node Id Node Read Liagent Service Status
Read liagent service status
POST
Transport Nodes Transport Node Id Node Create Liagent Service Action Restart
Restart, start or stop the liagent service
POST
Transport Nodes Transport Node Id Node Create Liagent Service Action Start
Restart, start or stop the liagent service
POST
Transport Nodes Transport Node Id Node Create Liagent Service Action Stop
Restart, start or stop the liagent service
GET
Transport Nodes Transport Node Id Node Read Edge NSXA Service
Read NSX Edge NSXA service properties
PUT
Transport Nodes Transport Node Id Node Update Edge NSXA Service
Update NSX Edge NSXA service properties
GET
Transport Nodes Transport Node Id Node Read Edge NSXA Service Status
Read NSX EdgeNSXA service status
POST
Transport Nodes Transport Node Id Node Create Edge NSXA Service Action Restart
Restart, start or stop the NSX EdgeNSXA service
POST
Transport Nodes Transport Node Id Node Create Edge NSXA Service Action Start
Restart, start or stop the NSX EdgeNSXA service
POST
Transport Nodes Transport Node Id Node Create Edge NSXA Service Action Stop
Restart, start or stop the NSX EdgeNSXA service
GET
Transport Nodes Transport Node Id Node Read Nsx NGINX Service
Read Metadata-proxy service properties
GET
Transport Nodes Transport Node Id Node Read Nsx NGINX Service Status
Read Metadata-proxy service status
GET
Transport Nodes Transport Node Id Node Read Nsx Nestdb Service
Read NSX Nestdb service properties
GET
Transport Nodes Transport Node Id Node Read Nsx Nestdb Service Status
Read NSX Nestdb service status
POST
Transport Nodes Transport Node Id Node Create Nsx Nestdb Service Action Restart
Restart, start or stop the NSX Nestdb service
POST
Transport Nodes Transport Node Id Node Create Nsx Nestdb Service Action Start
Restart, start or stop the NSX Nestdb service
POST
Transport Nodes Transport Node Id Node Create Nsx Nestdb Service Action Stop
Restart, start or stop the NSX Nestdb service
GET
Transport Nodes Transport Node Id Node Read Appliance Management Service
Read appliance management service properties
GET
Transport Nodes Transport Node Id Node Get Node Management Log Level
Retrieve Node Management loglevel
PUT
Transport Nodes Transport Node Id Node Set Node Management Log Level
Set Node Management loglevel
GET
Transport Nodes Transport Node Id Node Read Appliance Management Service Status
Read appliance management service status
POST
Transport Nodes Transport Node Id Node Create Appliance Management Service Action Restart
Restart the node management service
GET
Transport Nodes Transport Node Id Node Read Nsx Control Plane Agent Service
Read NSX Control Plane Agent service properties
GET
Transport Nodes Transport Node Id Node Read Nsx Control Plane Agent Service Status
Read NSX Control Plane Agent service status
POST
Transport Nodes Transport Node Id Node Create Nsx Control Plane Agent Service Action Restart
Restart, start or stop the NSX Control Plane Agent service
POST
Transport Nodes Transport Node Id Node Create Nsx Control Plane Agent Service Action Start
Restart, start or stop the NSX Control Plane Agent service
POST
Transport Nodes Transport Node Id Node Create Nsx Control Plane Agent Service Action Stop
Restart, start or stop the NSX Control Plane Agent service
GET
Transport Nodes Transport Node Id Node Read Ops Agent Service
Read NSX OpsAgent service properties
GET
Transport Nodes Transport Node Id Node Read Ops Agent Service Status
Read NSX OpsAgent service status
POST
Transport Nodes Transport Node Id Node Create Ops Agent Service Action Restart
Restart, start or stop the NSX OpsAgent service
POST
Transport Nodes Transport Node Id Node Create Ops Agent Service Action Start
Restart, start or stop the NSX OpsAgent service
POST
Transport Nodes Transport Node Id Node Create Ops Agent Service Action Stop
Restart, start or stop the NSX OpsAgent service
GET
Transport Nodes Transport Node Id Node Read Platform Client Service
Read NSX Platform Client service properties
GET
Transport Nodes Transport Node Id Node Read Platform Client Service Status
Read NSX Platform Client service status
POST
Transport Nodes Transport Node Id Node Create Platform Client Service Action Restart
Restart, start or stop the NSX Platform Client service
POST
Transport Nodes Transport Node Id Node Create Platform Client Service Action Start
Restart, start or stop the NSX Platform Client service
POST
Transport Nodes Transport Node Id Node Create Platform Client Service Action Stop
Restart, start or stop the NSX Platform Client service
GET
Transport Nodes Transport Node Id Node Read Nsx Upgrade Agent Service
Read NSX upgrade Agent service properties
GET
Transport Nodes Transport Node Id Node Read Nsx Upgrade Agent Service Status
Read Nsx upgrade agent service status
POST
Transport Nodes Transport Node Id Node Create Nsx Upgrade Agent Service Action Restart
Restart, start or stop the NSX upgrade agent service
POST
Transport Nodes Transport Node Id Node Create Nsx Upgrade Agent Service Action Start
Restart, start or stop the NSX upgrade agent service
POST
Transport Nodes Transport Node Id Node Create Nsx Upgrade Agent Service Action Stop
Restart, start or stop the NSX upgrade agent service
GET
Transport Nodes Transport Node Id Node Read NTP Service
Read NTP service properties
PUT
Transport Nodes Transport Node Id Node Update NTP Service
Update NTP service properties
GET
Transport Nodes Transport Node Id Node Read NTP Service Status
Read NTP service status
POST
Transport Nodes Transport Node Id Node Create NTP Service Action Restart
Restart, start or stop the NTP service
POST
Transport Nodes Transport Node Id Node Create NTP Service Action Start
Restart, start or stop the NTP service
POST
Transport Nodes Transport Node Id Node Create NTP Service Action Stop
Restart, start or stop the NTP service
GET
Transport Nodes Transport Node Id Node Read Edge MSR Service
Read NSX EdgeMSR service properties
GET
Transport Nodes Transport Node Id Node Read Edge MSR Config Service
Read NSX EdgeMSRConfig service properties
GET
Transport Nodes Transport Node Id Node Read Edge MSR Config Service Status
Read NSX EdgeMSRConfig service status
GET
Transport Nodes Transport Node Id Node Read Edge MSR Service Status
Read NSX EdgeMSR service status
GET
Transport Nodes Transport Node Id Node Read Edge Securty Hub Service
Read NSX security-hub service properties
GET
Transport Nodes Transport Node Id Node Read Edge Security Hub Service Status
Read NSX Edge security-hub service status
GET
Transport Nodes Transport Node Id Node Read SNMP Service
Read SNMP service properties
PUT
Transport Nodes Transport Node Id Node Update SNMP Service
Update SNMP service properties
GET
Transport Nodes Transport Node Id Node Read SNMP Service Status
Read SNMP service status
GET
Transport Nodes Transport Node Id Node Read SNMPV3 Engine ID
Read SNMP V3 Engine ID
PUT
Transport Nodes Transport Node Id Node Update SNMPV3 Engine ID
Update SNMP V3 Engine ID
POST
Transport Nodes Transport Node Id Node Create SNMP Service Action Restart
Restart, start or stop the SNMP service
POST
Transport Nodes Transport Node Id Node Create SNMP Service Action Start
Restart, start or stop the SNMP service
POST
Transport Nodes Transport Node Id Node Create SNMP Service Action Stop
Restart, start or stop the SNMP service
GET
Transport Nodes Transport Node Id Node Read SSH Service
Read ssh service properties
PUT
Transport Nodes Transport Node Id Node Update SSH Service
Update ssh service properties
POST
Transport Nodes Transport Node Id Node Create SSH Service Action Notify Mpa Restart
Restart, start or stop the ssh service
POST
Transport Nodes Transport Node Id Node Create SSH Service Action Notify Mpa Start
Restart, start or stop the ssh service
POST
Transport Nodes Transport Node Id Node Create SSH Service Action Notify Mpa Stop
Restart, start or stop the ssh service
GET
Transport Nodes Transport Node Id Node Read SSH Service Status
Read ssh service status
POST
Transport Nodes Transport Node Id Node Create SSH Service Remove Host Fingerprint Action Remove Host Fingerprint
Remove a host's fingerprint from known hosts file
POST
Transport Nodes Transport Node Id Node Create SSH Service Action Restart
Restart, start or stop the ssh service
POST
Transport Nodes Transport Node Id Node Create SSH Service Action Start
Restart, start or stop the ssh service
POST
Transport Nodes Transport Node Id Node Create SSH Service Action Stop
Restart, start or stop the ssh service
GET
Transport Nodes Transport Node Id Node Read Syslog Service
Read syslog service properties
DELETE
Transport Nodes Transport Node Id Node Delete Node Syslog Exporter All
Delete all node syslog exporters
GET
Transport Nodes Transport Node Id Node List Node Syslog Exporters
List node syslog exporters
POST
Transport Nodes Transport Node Id Node Post Node Syslog Exporter
Add node syslog exporter
DELETE
Transport Nodes Transport Node Id Node Delete Node Syslog Exporter
Delete node syslog exporter
GET
Transport Nodes Transport Node Id Node Read Node Syslog Exporter
Read node syslog exporter
POST
Transport Nodes Transport Node Id Node Verify Node Syslog Exporter Verify
Verify node syslog exporter
GET
Transport Nodes Transport Node Id Node Read Syslog Service Status
Read syslog service status
POST
Transport Nodes Transport Node Id Node Create Syslog Service Action Restart
Restart, start or stop the syslog service
POST
Transport Nodes Transport Node Id Node Create Syslog Service Action Start
Restart, start or stop the syslog service
POST
Transport Nodes Transport Node Id Node Create Syslog Service Action Stop
Restart, start or stop the syslog service
GET
Transport Nodes Transport Node Id Node Read IP Sec Determ RSS Setting
Get NSX Edge IPSec Determ RSS setting
PUT
Transport Nodes Transport Node Id Node Update IP Sec Determ RSS Setting
Update NSX Edge IPSec Determ RSS setting
GET
Transport Nodes Transport Node Id Node Read IP Sec Determ RSS Status
Get NSX Edge IPSec Determ RSS setting
GET
Transport Nodes Transport Node Id Node Read Appliance Node Status
Read node status
POST
Transport Nodes Transport Node Id Node Update Appliance Node Status Clear Bootup Error
Update node status
GET
Transport Nodes Transport Node Id Node List Appliance Management Tasks
List appliance management tasks
DELETE
Transport Nodes Transport Node Id Node Delete Appliance Management Task
Delete task
GET
Transport Nodes Transport Node Id Node Read Appliance Management Task Properties
Read task properties
GET
Transport Nodes Transport Node Id Node Read Async Appliance Management Task Response
Read asynchronous task response
POST
Transport Nodes Transport Node Id Node Cancel Appliance Management Task Cancel
Cancel specified task
GET
Transport Nodes Transport Node Id Node List Node Users True
List node users
DELETE
Transport Nodes Transport Node Id Node Delete Node User
Delete node user
GET
Transport Nodes Transport Node Id Node Read Node User
Read node user
PUT
Transport Nodes Transport Node Id Node Update Node User
Update node user
GET
Transport Nodes Transport Node Id Node List Node User Ssh Keys
List SSH keys from authorized_keys file for node user
POST
Transport Nodes Transport Node Id Node Add Node User Ssh Key Add Ssh Key
Add SSH public key to authorized_keys file for node user
POST
Transport Nodes Transport Node Id Node Delete Node User Ssh Key Remove Ssh Key
Remove SSH public key from authorized_keys file for node user
GET
Transport Nodes Transport Node Id Node List Node Users True
List node users
GET
Transport Nodes Transport Node Id Node Read Node Version
Read node version
POST
Transport Nodes Transport Node Id Node Restart Or Shutdown Node Restart
Restart or shutdown node
POST
Transport Nodes Transport Node Id Node Set Node Time Set System Time
Set the node system time
POST
Transport Nodes Transport Node Id Node Restart Or Shutdown Node Shutdown
Restart or shutdown node
GET
Get Transport Node State With Deployment Info
Get a Transport Node's State
POST
Disable Flow Cache
Disable flow cache for an edge transport node
POST
Enable Flow Cache
Enable flow cache for an edge transport node
POST
Refresh Transport Node
Refresh the node configuration for the Edge node.
POST
Restart Transport Node Inventory Sync
Restart the inventory sync for the node if it is paused currently.
POST
Restore Parent Cluster Configuration Deprecated
Apply cluster level Transport Node Profile on overridden host
POST
Update Transport Node Maintenance Mode
Update transport node maintenance mode
POST
Resync Transport Node
Resync a Transport Node
POST
Cleanup Edge Transport Node Stale Entries
Clear edge transport node stale entries
GET
List Transport Zones Deprecated
List Transport Zones
POST
Create Transport Zone Deprecated
Create a Transport Zone
GET
Get All Transport Zone Status
Get high-level summary of a transport zone. The service layer does not support source = realtime or cached.
GET
List Transport Node Status
Read status of all the transport nodes
GET
Get Transport Node Report
Creates a status report of transport nodes of all the transport zones
GET
Get Transport Node Json Report
Creates a status json report of transport nodes of all the transport zones
DELETE
Delete Transport Zone Deprecated
Delete a Transport Zone
GET
Get Transport Zone Deprecated
Get a Transport Zone
PUT
Update Transport Zone Deprecated
Update a Transport Zone
GET
Get Heatmap Transport Zone Status
Get high-level summary of a transport zone
GET
Get Transport Zone Status Deprecated
Get a Transport Zone's Current Runtime Status Information
GET
List Transport Node Status For Transport Zone
Read status of transport nodes in a transport zone
GET
Get Transport Node Report For A Transport Zone
Creates a status report of transport nodes in a transport zone
GET
Get Transport Node Json Report For A Transport Zone
Creates a status json report of transport nodes in a transport zone
GET
List Transport Zone Profiles Deprecated
List transport zone profiles
POST
Create Transport Zone Profile Deprecated
Create a transport zone Profile
DELETE
Delete Transport Zone Profile Deprecated
Delete a transport zone Profile
GET
Get Transport Zone Profile Deprecated
Get transport zone profile by identifier
PUT
Update Transport Zone Profile Deprecated
Update a transport zone profile
POST
Reset IP Sec VPN Session Stats Reset
Reset IPSec VPN session statistics
DELETE
Delete Deployment Info
Delete deployment information.
GET
Get Deployment Info
Get deployment information.
POST
Create Deployment Info
Create or update deployment information.
PUT
Create Or Update Deployment Info
Create or update deployment information.