3.1.5.22.1 Diagnostics ConnectivityCheck

The ConnectivityCheck resource initiates a diagnostics Action to check data path connectivity between two endpoints.

It is invoked through the following URI.

 https://<url>/networking/v1/diagnostics/ConnectivityCheck 

url: The address or name of the REST server of the Network Controller.

Note  The server MAY support additional versions, v1 or later, in the URI.

The following HTTP methods can be performed on this resource.

HTTP method	Section	Description
PUT	3.1.5.22.1.1.1	Initiates a diagnostics Action to check data path connectivity between two endpoints.

The following property elements are valid.

Element name	Type	Description
etag	Read-only	Specified in Common JSON Elements, section 2.2.2.
senderIpAddress	Required	IP Address of the Sender endpoint from which the diagnostics needs to be initiated.
receiverIpAddress	Required	IP Address of the Receiver endpoint to which the diagnostics needs to be initiated.
senderVirtualNetwork	Optional	Virtual Network reference of the Sender endpoint from which the diagnostics needs to be initiated.
receiverVirtualNetwork	Optional	Virtual Network reference of the Receiver endpoint to which the diagnostics needs to be initiated.
senderLogicalNetwork	Optional	Logical Network reference of the Sender endpoint from which the diagnostics needs to be initiated.
receiverLogicalNetwork	Optional	Logical Network reference of the Receiver endpoint to which the diagnostics needs to be initiated.
protocol	Required	Protocol to be used for diagnostics.
IcmpProtocolConfig	Optional	ICMP Protocol specific configuration.
IcmpProtocolConfig.Length	Optional	Length of the ICMP packet.
IcmpProtocolConfig.SequenceNumber	Optional	Sequence Number of the ICMP packet.
operationId	Read-only	Operation ID for this diagnostics operation.
ConnectivityCheckResult	Read-only	Resource Reference of the result resource.
submitTime	Read-only	Submit Time of this diagnostics operation.