Post Network Connectivity Checker

Post Network Connectivity Checker

ConnectivityValidationGroupResultWrapper will be available at task.params['test_result'].

Request
URI
POST
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/networking/connectivity-tests
COPY
Path Parameters
string
org
Required

Organization identifier

string
sddc
Required

Sddc identifier

Query Parameters
string
action
Required

If = 'start', start connectivity tests.

Request Body

request information

ConnectivityValidationGroup of type(s) application/json
Required 
{
    "id": "string",
    "name": "string",
    "sub_groups": [
        {
            "inputs": [
                {
                    "id": "string",
                    "value": "string",
                    "label": "string"
                }
            ],
            "tests": [
                {
                    "source": "string",
                    "path": "string",
                    "type": "string",
                    "ports": [
                        "string"
                    ],
                    "pktsize": "string"
                }
            ],
            "label": "string",
            "help": "string",
            "id": "string"
        }
    ]
}
string
id
Optional

test group id, currently, only HLM.

Possible values are : HLM, DRAAS,
string
name
Optional

Name of the test group.

array of ConnectivityValidationSubGroup
sub_groups
Optional

List of sub groups.

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns Task of type(s) application/json
This response body class contains all of the following: AbstractEntity 
{
    "updated": "string",
    "user_id": "string",
    "updated_by_user_id": "string",
    "created": "string",
    "version": 5,
    "updated_by_user_name": "string",
    "user_name": "string",
    "id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "status": "string",
    "localized_error_message": "string",
    "resource_id": "string",
    "parent_task_id": "string",
    "task_version": "string",
    "correlation_id": "string",
    "start_resource_entity_version": 0,
    "customer_error_message": "string",
    "sub_status": "string",
    "task_type": "string",
    "start_time": "string",
    "task_progress_phases": [
        {
            "id": "string",
            "name": "string",
            "progress_percent": 0
        }
    ],
    "error_message": "string",
    "org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "end_resource_entity_version": 5,
    "service_errors": [
        {
            "default_message": "string",
            "original_service": "string",
            "localized_message": "string",
            "original_service_error_code": "string"
        }
    ],
    "org_type": "string",
    "estimated_remaining_minutes": 4,
    "progress_percent": 75,
    "phase_in_progress": "string",
    "resource_type": "string",
    "end_time": "string"
}

400

Bad Request

Returns ErrorResponse of type(s) application/json 
{
    "status": 0,
    "path": "string",
    "retryable": false,
    "error_code": "string",
    "error_messages": [
        "string"
    ]
}
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

On This Page
Troubleshooting Operations
GET
Get Network Connectivity Checker
POST
Post Network Connectivity Checker