Nsx Component Administration APIs

Nsx Component Administration APIs
Operations
POST
Add Certificate Import
Add a New Certificate
POST
Add Cluster Node
Add a controller node to the cluster
POST
Add Crl Import
Add a New Certificate Revocation List
POST
Add Node User Ssh Key Add Ssh Key
Add SSH public key to authorized_keys file for node user
POST
Advance Cluster Restore Advance
Advance any suspended restore operation
POST
Cancel Appliance Management Task Cancel
Cancel specified task
POST
Cancel Cluster Restore Cancel
Cancel any running restore operation
GET
Check Rabbit MQ Management Port
Check if RabbitMQ management port is enabled or not
GET
Collect Alarms
Collect alarms from all NSX nodes
POST
Collect Audit Logs
Collect audit logs from registered manager nodes
POST
Collect Support Bundles Collect
Collect support bundles from registered cluster and fabric nodes
PUT
Configure Backup Config
Configure backup
PUT
Configure Restore Config
Configure Restore SFTP server credentials
POST
Copy From Remote File Copy From Remote File
Copy a remote file to the file store
POST
Copy To Remote File Copy To Remote File
Copy file in the file store to a remote file store
POST
Create Appliance Management Service Action Restart
Restart the node management service
POST
Create Cluster Boot Manager Service Action Restart
Restart, start or stop the cluster boot manager service
POST
Create Cluster Boot Manager Service Action Start
Restart, start or stop the cluster boot manager service
POST
Create Cluster Boot Manager Service Action Stop
Restart, start or stop the cluster boot manager service
POST
Create Cminventory Service Action Restart
Restart, start or stop the manager service
POST
Create Cminventory Service Action Start
Restart, start or stop the manager service
POST
Create Cminventory Service Action Stop
Restart, start or stop the manager service
POST
Create File
Upload a file to the file store
POST
Create Liagent Service Action Restart
Restart, start or stop the liagent service
POST
Create Liagent Service Action Start
Restart, start or stop the liagent service
POST
Create Liagent Service Action Stop
Restart, start or stop the liagent service
POST
Create Node Network Route
Create node network route
POST
Create NSX Message Bus Service Action Restart
Restart, start or stop the NSX Message Bus service
POST
Create NSX Message Bus Service Action Start
Restart, start or stop the NSX Message Bus service
POST
Create NSX Message Bus Service Action Stop
Restart, start or stop the NSX Message Bus service
POST
Create Nsx Ui Service Service Action Restart
Restart, Start and Stop the ui service
POST
Create Nsx Ui Service Service Action Start
Restart, Start and Stop the ui service
POST
Create Nsx Ui Service Service Action Stop
Restart, Start and Stop the ui service
POST
Create Nsx Upgrade Agent Service Action Restart
Restart, start or stop the NSX upgrade agent service
POST
Create Nsx Upgrade Agent Service Action Start
Restart, start or stop the NSX upgrade agent service
POST
Create Nsx Upgrade Agent Service Action Stop
Restart, start or stop the NSX upgrade agent service
POST
Create NTP Service Action Restart
Restart, start or stop the NTP service
POST
Create NTP Service Action Start
Restart, start or stop the NTP service
POST
Create NTP Service Action Stop
Restart, start or stop the NTP service
POST
Create Phonehome Coordinator Service Action Restart
Restart, start or stop Telemetry service
POST
Create Phonehome Coordinator Service Action Start
Restart, start or stop Telemetry service
POST
Create Phonehome Coordinator Service Action Stop
Restart, start or stop Telemetry service
POST
Create Proton Service Action Restart
Restart, start or stop the service
POST
Create Proton Service Action Start
Restart, start or stop the service
POST
Create Proton Service Action Stop
Restart, start or stop the service
POST
Create Proxy Service Action Restart
Restart the http service
POST
Create Proxy Service Action Start
Start the http service
POST
Create Proxy Service Action Stop
Stop the http service
POST
Create Proxy Service Apply Certificate Action Apply Certificate
Update http service certificate
POST
Create Rabbit MQ Service Action Restart
Restart, start or stop the Rabbit MQ service
POST
Create Rabbit MQ Service Action Start
Restart, start or stop the Rabbit MQ service
POST
Create Rabbit MQ Service Action Stop
Restart, start or stop the Rabbit MQ service
POST
Create Remote Directory Create Remote Directory
Create directory in remote file server
POST
Create Repository Service Action Restart
Restart, start or stop the NSX install-upgrade service
POST
Create Repository Service Action Start
Restart, start or stop the NSX install-upgrade service
POST
Create Repository Service Action Stop
Restart, start or stop the NSX install-upgrade service
POST
Create Search Service Action Restart
Restart, start or stop the NSX Search service
POST
Create Search Service Action Start
Restart, start or stop the NSX Search service
POST
Create Search Service Action Stop
Restart, start or stop the NSX Search service
POST
Create SNMP Service Action Restart
Restart, start or stop the SNMP service
POST
Create SNMP Service Action Start
Restart, start or stop the SNMP service
POST
Create SNMP Service Action Stop
Restart, start or stop the SNMP service
POST
Create SSH Service Action Restart
Restart, start or stop the ssh service
POST
Create SSH Service Action Start
Restart, start or stop the ssh service
POST
Create SSH Service Action Stop
Restart, start or stop the ssh service
POST
Create SSH Service Remove Host Fingerprint Action Remove Host Fingerprint
Remove a host's fingerprint from known hosts file
POST
Create Syslog Service Action Restart
Restart, start or stop the syslog service
POST
Create Syslog Service Action Start
Restart, start or stop the syslog service
POST
Create Syslog Service Action Stop
Restart, start or stop the syslog service
DELETE
Delete Appliance Management Task
Delete task
DELETE
Delete Certificate
Delete Certificate for the Given Certificate ID
DELETE
Delete Cluster Node Config
Remove a controller 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
POST
Delete Node User Ssh Key Remove Ssh Key
Remove SSH public key from authorized_keys file for node user
DELETE
Delete Principal Identity
Delete a principal identity
DELETE
DELETE Rabbit MQ Management Port
Delete RabbitMQ management port
POST
Generate Csr
Generate a New Certificate Signing Request
GET
Get Backup Config
Get backup configuration
GET
Get Backup History
Get backup history
GET
Get Backup Status
Get backup status
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 Node Mode
NodeMode
GET
Get Principal Identities
Return the list of principal identities
GET
Get Principal Identity
Get a Principal Identity
GET
Get Restore Config
Get Restore configuration
POST
Get Ssh Fingerprint Of Server Retrieve Ssh Fingerprint
Get ssh fingerprint of remote(backup) server
GET
Get Trust Objects
Return the Properties of a Trust Manager
POST
Import Certificate Import
Import a Certificate Associated with an Approved CSR
POST
Initiate Cluster Restore Start
Initiate a restore operation
DELETE
Invoke Delete Cluster Central API
Invoke DELETE request on target cluster node
DELETE
Invoke Delete Fabric Central API
Invoke DELETE request on target fabric node
GET
Invoke Get Cluster Central API
Invoke GET request on target cluster node
GET
Invoke Get Fabric Central API
Invoke GET request on target fabric node
POST
Invoke Post Cluster Central API
Invoke POST request on target cluster node
POST
Invoke Post Fabric Central API
Invoke POST request on target fabric node
PUT
Invoke Put Cluster Central API
Invoke PUT request on target cluster node
PUT
Invoke Put Fabric Central API
Invoke PUT request on target fabric node
GET
List Appliance Management Tasks
List appliance management tasks
GET
List Cluster Backup Timestamps
List timestamps of all available Cluster Backups.
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
GET
List Node User Ssh Keys
List SSH keys from authorized_keys file for node user
GET
List Restore Instruction Resources
List resources for a given instruction, to be shown to/executed by users.
POST
Post Node Syslog Exporter
Add node syslog exporter
GET
Query Cluster Restore Status
Query Restore Request Status
GET
Read Appliance Management Service
Read appliance management service properties
GET
Read Appliance Management Service Status
Read appliance management service status
GET
Read Appliance Management Task Properties
Read task properties
GET
Read Appliance Node Status
Read node status
GET
Read Asnyc Appliance Management Task Response
Read asynchronous task response
GET
Read Auth Provider Vidm
Read AAA provider vIDM properties
GET
Read Auth Provider Vidm Status
Read AAA provider vIDM status
GET
Read Cluster Boot Manager Service
Read cluster boot manager service properties
GET
Read Cluster Boot Manager Service Status
Read cluster boot manager service status
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 Cminventory Service
Read cm inventory service properties
GET
Read Cminventory Service Status
Read manager service status
GET
Read File
Read file contents
GET
Read File Properties
Read file properties
GET
Read File Thumbprint
Read file thumbprint
GET
Read Liagent Service
Read liagent service properties
GET
Read Liagent Service Status
Read liagent service status
GET
Read Management Config
Read NSX Management nodes global configuration.
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 Node Version
Read node version
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 Ui Service Service
Read ui service properties
GET
Read Nsx Ui Service Service Status
Read ui 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 Phonehome Coordinator Service
Read Telemetry service properties
GET
Read Phonehome Coordinator Service Status
Read Telemetry service status
GET
Read Proton Service
Read service properties
GET
Read Proton Service Status
Read 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 Search Service
Read NSX Search service properties
GET
Read Search Service Status
Read NSX Search 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
Register Principal Identity
Register a name-certificate combination.
POST
Request Onetime Backup Backup To Remote
Request one-time backup
POST
Request Onetime Inventory Summary Summarize Inventory To Remote
Request one-time inventory summary.
POST
Reset Proton Service Logging Level Action Reset Manager Logging Levels
Reset the logging levels to default values
POST
Restart Or Shutdown Node Restart
Restart or shutdown node
POST
Restart Or Shutdown Node Shutdown
Restart or shutdown node
POST
Retry Cluster Restore Retry
Retry any failed restore operation
POST
Self Sign Certificate Self Sign
Self-Sign the CSR
PUT
Set Node Mandatory Access Control
Enable or disable Mandatory Access Control
POST
Set Rabbit MQ Management Port
Set RabbitMQ management port
POST
Suspend Cluster Restore Suspend
Suspend any running restore operation
PUT
Update Auth Provider Vidm
Update AAA provider vIDM properties
PUT
Update Crl
Update CRL for the Given CRL ID
PUT
Update File
Replace file contents
PUT
Update Management Config
Update NSX Management nodes global configuration
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
POST
Update Principal Identity Certificate Update Certificate
Update a Principal Identity's certificate
PUT
Update Proton Service
Update 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