About this Resource

Modified: for 8.0.0

Defines Connectivity Check Managed Object.

REST API Methods for this Resource

Resource Schema

Parameters

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
CheckPortTypeYesYesEnum3Possible values:
  • 0 - cctUdpDns
  • 1 - cctUdpNtp
  • 2 - cctUdpStun
  • 3 - cctTcp
Specifies which protocol to test.
TargetNoNostringnone255 - Max Length FQDN of the target (Only used for DNS UDP testing)
HostServerNoNostringnone255 - Max Length FQDN/IP of the server to query.
HostIpAddrNoNostringnone15 - Max Length IP address of the server to query
HostPortYesYesintPossible values:
  • 0 - Minimum
  • 65535 - Maximum
Specifies the UDP/TCP port number to query.
CheckPortResultNoNoEnum0Possible values:
  • 0 - ccsUnknown
  • 1 - ccsOpen
  • 2 - ccsNameResolutionFailure
  • 3 - ccsClosed
Test result.