NSX-T Data Center REST API

Show all the system health plugin (Deprecated)

Show all the system health plugins.

Request:

Method:

GET

URI Path(s):

/api/v1/systemhealth/plugins

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

ListRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/systemhealth/plugins

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

SystemHealthPluginProfileList+

SystemHealthPluginProfileList (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 list	array of SystemHealthPluginProfile
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":2, "results": [ { "id": "72e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "type": "COMPUTE", "display_name": "health-check-compute", "publisher": "vmware", "resource_type": "SystemHealthPlugin", "_create_user": "admin", "_create_time": 1557909800701, "_last_modified_user": "admin", "_last_modified_time": 1557909945019, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 } ] }

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