NSX-T Data Center REST API

QueryTunnelParameters (type)

{
  "extends": {
    "$ref": "ListWithDataSourceParameters
  }, 
  "id": "QueryTunnelParameters", 
  "module_id": "Tunnel", 
  "properties": {
    "bfd_diagnostic_code": {
      "enum": [
        "0", 
        "NO_DIAGNOSTIC", 
        "1", 
        "CONTROL_DETECTION_TIME_EXPIRED", 
        "2", 
        "ECHO_FUNCTION_FAILED", 
        "3", 
        "NEIGHBOR_SIGNALED_SESSION_DOWN", 
        "4", 
        "FORWARDING_PLANE_RESET", 
        "5", 
        "PATH_DOWN", 
        "6", 
        "CONCATENATED_PATH_DOWN", 
        "7", 
        "ADMINISTRATIVELY_DOWN", 
        "8", 
        "REVERSE_CONCATENATED_PATH_DOWN"
      ], 
      "title": "BFD diagnostic code of Tunnel as defined in RFC 5880", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "encap": {
      "description": "The encapsulation type of tunnel. VXLAN         - tunnel with VXLAN encapsulation GENEVE        - tunnel with GENEVE encapsulation UNKNOWN_ENCAP - tunnel with unknown encapsulation", 
      "enum": [
        "UNKNOWN_ENCAP", 
        "GENEVE", 
        "VXLAN"
      ], 
      "title": "Tunnel encapsulation type", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "remote_node_id": {
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "title": "Tunnel status", 
      "type": "string"
    }
  }, 
  "type": "object"
}