NSX-T Data Center REST API
SystemHealthPluginProfile (schema)
System Health Plugin Profile
Describes a profile to define a kind of system health plugin.
| 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 |
| config | The pre defind plugin profile Display the default config of pre defined plugin. The config can be changed by API /systemhealth/profiles. To see the effective status on given node, use the status API per node /systemhealth/plugins/status/ |
SHAPredefinedPluginProfileData | Readonly |
| 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 | Plugin Enablement Flag Display the default on-off switch of pre defined plugin. The config can be changed by API /systemhealth/profiles. To see the effective status on given node, use the status API per node /systemhealth/plugins/status/ |
boolean | Readonly |
| id | Unique identifier of this resource | string | Sortable |
| node_types | The supported node types Display the running node types of pre-defined plugin. The config can be changed by API /systemhealth/profiles. To see the effective status on given node, use the status API per node /systemhealth/plugins/status/ |
array of NsxNodeType | Readonly |
| publisher | Plugin publisher The publisher of System Health Agent plugin |
string | |
| resource_type | Must be set to the value SystemHealthPluginProfile | string | |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| type | Plugin Type The type of System Health Agent plugin |
SystemHealthAgentType | Default: "NETWORK" |