Create a new manual health check request

Create a new manual health check request with essential properties. It's
disallowed to create new one until the count of in-progress manual health
check is less than 50. A manual health check will be deleted automatically
after finished for 24 hours.

Request:

Method:

POST

URI Path(s):

/api/v1/manual-health-checks

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ManualHealthCheck+

ManualHealthCheck (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
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
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	Required
vlans	Specificied VLANs VLANs specificied for manual health check	HealthCheckSpecVlans	Required

Example Request:

POST https://<nsx-mgr>/api/v1/manual-health-checks { "resource_type": "ManualHealthCheck", "display_name": "Manual HealthCheck 002", "transport_zone_id": "7f5e6a44-696d-401d-936a-d7138476acd3", "vlans":{ "vlan_ranges":[{ "start": 1, "end": 5 },{ "start": 11, "end": 11 }] }, }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

ManualHealthCheck+

ManualHealthCheck (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
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
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	Required
vlans	Specificied VLANs VLANs specificied for manual health check	HealthCheckSpecVlans	Required

Example Response:

{ "id": "2d5d3a9a-5bc7-4ad1-2f0a-a9836575d204", "resource_type": "ManualHealthCheck", "display_name": "Manual HealthCheck 002", "operation_status": "IN PROGRESS", "transport_zone_id": "7f5e6a44-696d-401d-936a-d7138476acd3", "vlans":{ "vlan_ranges":[{ "start": 1, "end": 5 },{ "start": 11, "end": 11 }] }, "_protection" : "NOT_PROTECTED", "_create_user" : "admin", "_create_time" : 1507687895605, "_last_modified_user" : "admin", "_last_modified_time" : 1507705866588, "_system_owned" : false, "_revision" : 0 }

Create a new manual health check request

Request:

ManualHealthCheck (schema)

Example Request:

Successful Response:

ManualHealthCheck (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: