NSX-T Data Center REST API

Show the installed system health plugin list

Show all the installed system health plugins on given node

Request:

Method:

GET

URI Path(s):

/api/v1/systemhealth/plugins/status/<node-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/systemhealth/plugins/status/a257b981-1a1c-4b95-b16c-8646e85ce8f0

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PluginStatusList+

PluginStatusList (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Total plugin count	integer	Required
results	System Health plugin status list	array of PluginStatus
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count":1, "results": [ { "id": "72e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "name": "health-check-compute", "status": "enabled", "profile": "{ENABLED: true, CHECK_INTERVAL: 20}", "detail": "" } ] }

Required Permissions:

read

Feature:

tools_system_health_agent

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable