Check SDDC Network Connectivity
ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’].
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/networking/connectivity-tests
Parameters
Parameters
string
org
Required
Organization identifier
string
sddc
Required
Sddc identifier
Query Parameters
Query Parameters
string
action
Required
If = 'start', start connectivity tests.
Request Body
Request Body
ConnectivityValidationGroup (required){
"id": "string",
"name": "string",
"sub_groups": [
{
"help": "string",
"id": "string",
"inputs": [
{
"id": "string",
"label": "string",
"value": "string"
}
],
"label": "string",
"tests": [
{
"path": "string",
"ports": [
"string"
],
"source": "string",
"type": "string"
}
]
}
]
}
string
id
Optional
test group id, currently, only HLM.
Possible values are: HLM, DRAAS
string
name
Optional
Name of the test group.
Response
Response
Response BodyResponse Body
202 Accepted returns
Task
{
"correlation_id": "string",
"created": "string",
"end_resource_entity_version": 5,
"end_time": "string",
"error_message": "string",
"estimated_remaining_minutes": 4,
"id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"localized_error_message": "string",
"org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"org_type": "string",
"parent_task_id": "string",
"phase_in_progress": "string",
"progress_percent": 75,
"resource_id": "string",
"resource_type": "string",
"service_errors": [
{
"default_message": "string",
"localized_message": "string",
"original_service": "string",
"original_service_error_code": "string"
}
],
"start_resource_entity_version": 0,
"start_time": "string",
"status": "string",
"sub_status": "string",
"task_progress_phases": [
{
"id": "string",
"name": "string",
"progress_percent": 0
}
],
"task_type": "string",
"task_version": "string",
"updated": "string",
"updated_by_user_id": "string",
"updated_by_user_name": "string",
"user_id": "string",
"user_name": "string",
"version": 5
}
string
created
Required
Not available
string
id
Required
Unique ID for this entity
string
start_time
Required
Not available
string
status
Required
Not available
Possible values are: STARTED, CANCELING, FINISHED, FAILED, CANCELED
string
sub_status
Required
Not available
string
task_type
Required
Not available
string
updated
Required
Not available
string
updated_by_user_id
Required
User id that last updated this record
string
user_id
Required
User id that last updated this record
string
user_name
Required
User name that last updated this record
integer
version
Required
Version of this entity
string
correlation_id
Optional
(Optional) Client provided uniqifier to make task creation idempotent. Be aware not all tasks support this. For tasks that do - supplying the same correlation Id, for the same task type, within a predefined window will ensure the operation happens at most once.
integer
end_resource_entity_version
Optional
Entity version of the resource at the end of the task. This is only set for some task types.
string
end_time
Optional
Not available
string
error_message
Optional
Not available
integer
estimated_remaining_minutes
Optional
Estimated remaining time in minute of the task execution, < 0 means no estimation for the task.
string
localized_error_message
Optional
Not available
string
org_id
Optional
Not available
string
org_type
Optional
Not available
object
params
Optional
Not available
string
parent_task_id
Optional
If this task was created by another task - this provides the linkage. Mostly for debugging.
string
phase_in_progress
Optional
The current in progress phase ID in the task execution, if none in progress, empty string returned.
integer
progress_percent
Optional
Estimated progress percentage the task executed
string
resource_id
Optional
UUID of the resource the task is acting upon
string
resource_type
Optional
Type of resource being acted upon
integer
start_resource_entity_version
Optional
Entity version of the resource at the start of the task. This is only set for some task types.
array of
TaskProgressPhase
task_progress_phases
Optional
Task progress phases involved in current task execution
string
task_version
Optional
Not available
string
updated_by_user_name
Optional
User name that last updated this record
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"id":"string","name":"string","sub_groups":[{"help":"string","id":"string","inputs":[{"id":"string","label":"string","value":"string"}],"label":"string","tests":[{"path":"string","ports":["string"],"source":"string","type":"string"}]}]}' https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/networking/connectivity-tests?action=string
Errors
Not available
401
The request requires user authentication.
Not available
403
The server understood the request, but is refusing to fulfill it.
