NSX-T Data Center REST API

Create a system health profile (Deprecated)

Create a system health profile.

Request:

Method:

POST

URI Path(s):

/api/v1/systemhealth/profiles

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

SystemHealthAgentProfile+

SystemHealthAgentProfile (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
applied_to_ua	Plugin Enablement Flag on UA cluster nodes The on-off switch of System Health Plugin on UA cluster nodes.	boolean
config	Profile Content The config content of System Health Agent	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Profile Enablement Flag The on-off switch of System Health Agent	boolean
id	Unique identifier of this resource	string	Sortable
plugin_id	Plugin id The id of System Health Agent plugin	string	Required
resource_type	Must be set to the value SystemHealthAgentProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Profile Type The type of System Health Agent. The System Health Agent plugin associated with given plugin id has already defined the profile type. So the backend can obtain the type by the plugin definition directly. Mark this field as optional. If need to check the type value by given plugin id, please call /systemhealth/plugins/.	SystemHealthAgentType

Example Request:

POST https://<nsx-mgr>/api/v1/systemhealth/profiles { "display_name": "compute-health", "enabled": true, "plugin_id":"22e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "config": "{\"CHECK_INTERVAL\": 60}" }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

SystemHealthAgentProfile+

SystemHealthAgentProfile (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
applied_to_ua	Plugin Enablement Flag on UA cluster nodes The on-off switch of System Health Plugin on UA cluster nodes.	boolean
config	Profile Content The config content of System Health Agent	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Profile Enablement Flag The on-off switch of System Health Agent	boolean
id	Unique identifier of this resource	string	Sortable
plugin_id	Plugin id The id of System Health Agent plugin	string	Required
resource_type	Must be set to the value SystemHealthAgentProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Profile Type The type of System Health Agent. The System Health Agent plugin associated with given plugin id has already defined the profile type. So the backend can obtain the type by the plugin definition directly. Mark this field as optional. If need to check the type value by given plugin id, please call /systemhealth/plugins/.	SystemHealthAgentType

Example Response:

{ "id": "72e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "type": "COMPUTE", "display_name": "compute-health", "enabled": true, "plugin_id":"22e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "config": "{\"CHECK_INTERVAL\": 60}", "resource_type": "SystemHealthAgentProfile", "_create_user": "admin", "_create_time": 1557909800701, "_last_modified_user": "admin", "_last_modified_time": 1557909945019, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 }

Required Permissions:

crud

Feature:

tools_system_health_agent

Additional Errors:

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