NSX-T Data Center REST API

TraceflowObservationForwarded (type)

{
  "extends": {
    "$ref": "TraceflowObservation"
  },
  "id": "TraceflowObservationForwarded",
  "module_id": "Traceflow",
  "polymorphic-type-descriptor": {
    "type-identifier": "TraceflowObservationForwarded"
  },
  "properties": {
    "component_name": {
      "readonly": true,
      "required": false,
      "title": "The name of the component that issued the observation.",
      "type": "string"
    },
    "component_sub_type": {
      "$ref": "TraceflowComponentSubType",
      "readonly": true,
      "required": false,
      "title": "The sub type of the component that issued the observation."
    },
    "component_type": {
      "$ref": "TraceflowComponentType",
      "readonly": true,
      "required": false,
      "title": "The type of the component that issued the observation."
    },
    "context": {
      "required": false,
      "title": "The 64bit tunnel context carried on the wire",
      "type": "integer"
    },
    "dst_transport_node_id": {
      "description": "This field will not be always available. Use remote_ip_address when this field is not set.",
      "readonly": true,
      "required": false,
      "title": "The id of the transport node to which the traceflow packet is forwarded",
      "type": "string"
    },
    "dst_transport_node_name": {
      "readonly": true,
      "required": false,
      "title": "The name of the transport node to which the traceflow packet is forwarded",
      "type": "string"
    },
    "is_ens": {
      "description": "This flag is to indicate whether the observation is reported from ENS fastpath or slowpath. This field is only applicable for livetrace observations.",
      "readonly": true,
      "required": false,
      "title": "Flag to indicate whether the observation is reported from ENS fastpath.",
      "type": "boolean"
    },
    "local_ip_address": {
      "$ref": "IPAddress",
      "required": false,
      "title": "IP address of the source end of the tunnel"
    },
    "remote_ip_address": {
      "$ref": "IPAddress",
      "required": false,
      "title": "IP address of the destination end of the tunnel"
    },
    "resource_type": {
      "$ref": "TraceflowObservationType",
      "default": "TraceflowObservationReceived",
      "required": true
    },
    "sequence_no": {
      "description": "the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation.",
      "readonly": true,
      "required": true,
      "title": "the sequence number is the traceflow observation hop count",
      "type": "integer"
    },
    "site_path": {
      "description": "This field contains the site path where this observation was generated.",
      "readonly": true,
      "title": "Policy path of the federated site",
      "type": "string"
    },
    "timestamp": {
      "$ref": "EpochMsTimestamp",
      "description": "Timestamp when the observation was created by the transport node (milliseconds epoch)",
      "readonly": true,
      "required": false,
      "title": "Timestamp when the observation was created by the transport node"
    },
    "timestamp_micro": {
      "description": "Timestamp when the observation was created by the transport node (microseconds epoch)",
      "readonly": true,
      "required": false,
      "title": "Timestamp when the observation was created by the transport node",
      "type": "integer"
    },
    "transport_node_id": {
      "readonly": true,
      "required": false,
      "title": "id of the transport node that observed a traceflow packet",
      "type": "string"
    },
    "transport_node_name": {
      "readonly": true,
      "required": false,
      "title": "name of the transport node that observed a traceflow packet",
      "type": "string"
    },
    "transport_node_type": {
      "$ref": "TransportNodeType",
      "readonly": true,
      "required": false,
      "title": "type of the transport node that observed a traceflow packet"
    },
    "uplink_name": {
      "required": false,
      "title": "The name of the uplink the traceflow packet is forwarded on",
      "type": "string"
    },
    "vtep_label": {
      "required": false,
      "title": "The virtual tunnel endpoint label",
      "type": "integer"
    }
  },
  "type": "object"
}