NSX-T Data Center REST API
# ***************************************************************************
# Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential.
# ***************************************************************************
ManualHealthCheck (schema)
Manual Health Check
Describes a manual check to evaluate the VLAN MTU status of either a
transport zone or the hosts in a vCenter cluster.
| 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 |
| cluster_scope_filter | vCenter cluster scope filter The transport node scope is determined by the combination of specified vCenter cluster and specified host group (optional). The host switch scope is determined by the specified host switch. This property cannot be set together with the transport_zone_id property |
HealthCheckClusterScopeFilter | |
| 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 |
| id | Unique identifier of this resource | string | Sortable |
| operation_status | Operation Status The operation status for health check |
string | Readonly Enum: IN_PROGRESS, FINISHED, PARTIAL_FINISHED, FAILED |
| resource_type | Must be set to the value ManualHealthCheck | string | |
| result | HealthCheckResult | Readonly | |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| transport_zone_id | Transport Zone ID The entity ID works as a filter param. Entity ID and entity type should be both provided or not at a query. |
string | |
| vlans | Specificied VLANs VLANs specificied for manual health check |
HealthCheckSpecVlans | Required |