[{"label":"Latest (v1.1)","version":"latest"}]
vmc
Post Network Connectivity Checker
DescriptionConnectivityValidationGroupResultWrapper will be available at task.params[’test_result’].
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/networking/connectivity-tests
Path Parameters
Path 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
{
"id": "HLM",
"name": "string",
"sub_groups": [
{
"help": "string",
"id": "PRIMARY_DNS",
"inputs": [
{
"id": "HOSTNAME",
"label": "string",
"value": "string"
}
],
"label": "string",
"tests": [
{
"path": "string",
"pktsize": "string",
"ports": [
"string"
],
"source": "VCENTER",
"type": "PING"
}
]
}
]
}
string
id
Optional
test group id, currently, only HLM.
Possible values are: HLM , DRAAS
string
name
Optional
Name of the test group.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted
Returns
Task
of type(s) application/json
This response body class contains all of the following:
AbstractEntity, InlineTask1
Errors
ErrorResponse
400
Bad Request
401
Unauthorized
403
Forbidden
Code Samples
PowerCLI Client SDK Example
$ConnectivityValidationInput = Initialize-ConnectivityValidationInput -Id "HOSTNAME" -Value "MyValue" -Label "MyLabel"
$ConnectivityAgentValidation = Initialize-ConnectivityAgentValidation -Source "VCENTER" -Path "MyPath" -Type "PING" -Ports "MyPorts" -Pktsize "MyPktsize"
$ConnectivityValidationSubGroup = Initialize-ConnectivityValidationSubGroup -Inputs $ConnectivityValidationInput -Tests $ConnectivityAgentValidation -Label "MyLabel" -Help "MyHelp" -Id "PRIMARY_DNS"
$ConnectivityValidationGroup = Initialize-ConnectivityValidationGroup -Id "HLM" -Name "MyName" -SubGroups $ConnectivityValidationSubGroup
Invoke-OrgsOrgSddcsSddcNetworkingConnectivityTestsPost -Org "MyOrg" -Sddc "MySddc" -Action "MyAction" -RequestInfo $RequestInfo
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"id":"HLM","name":"string","sub_groups":[{"help":"string","id":"PRIMARY_DNS","inputs":[{"id":"HOSTNAME","label":"string","value":"string"}],"label":"string","tests":[{"path":"string","pktsize":"string","ports":["string"],"source":"VCENTER","type":"PING"}]}]}' https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/networking/connectivity-tests?action=string
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: network-connectivity-checker
x-vmw-vapi-methodname: post
[{"label":"Latest (v1.1)","version":"latest"}]
vmc
