NSX-T Data Center REST API

PolicyTraceflowObservationReceivedLogical (type)

{
  "additionalProperties": false,
  "extends": {
    "$ref": "TraceflowObservationReceivedLogical"
  },
  "id": "PolicyTraceflowObservationReceivedLogical",
  "module_id": "PolicyConnectivity",
  "polymorphic-type-descriptor": {
    "type-identifier": "PolicyTraceflowObservationReceivedLogical"
  },
  "properties": {
    "component_id": {
      "readonly": true,
      "required": false,
      "title": "The id of the component that received the traceflow packet.",
      "type": "string"
    },
    "component_name": {
      "readonly": true,
      "required": false,
      "title": "The name of the component that issued the observation.",
      "type": "string"
    },
    "component_path": {
      "readonly": true,
      "required": false,
      "title": "The path of the component that received the traceflow packet",
      "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."
    },
    "interface_path": {
      "Description": "The path of the interface at which the traceflow packet was received (e.g.,\nTier0 Interface, Tier1 Interface, Service Interface, and Virtual Tunnel Interface).\n",
      "readonly": true,
      "required": false,
      "title": "Path of interface",
      "type": "string"
    },
    "ipsec_vpn": {
      "$ref": "TraceflowObservationIpsecVpn",
      "description": "This field is specified when the traceflow packet was received on IPSec VPN.",
      "readonly": true,
      "required": false,
      "title": "IPSec VPN on which the traceflow packet was received."
    },
    "ipsec_vpn_path": {
      "$ref": "PolicyTraceflowObservationIpsecVpn",
      "readonly": true,
      "required": false,
      "title": "The related path of IPsec VPN on which the traceflow packet was received"
    },
    "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"
    },
    "lport_id": {
      "readonly": true,
      "required": false,
      "title": "The id of the logical port at which the traceflow packet was received",
      "type": "string"
    },
    "lport_name": {
      "readonly": true,
      "required": false,
      "title": "The name of the logical port at which the traceflow packet was received",
      "type": "string"
    },
    "resource_type": {
      "$ref": "TraceflowObservationType",
      "default": "TraceflowObservationReceived",
      "required": true
    },
    "segment_port_path": {
      "Description": "The path of the segment port at which the\ntraceflow packet was received.\n",
      "readonly": true,
      "required": false,
      "title": "Path of segment port",
      "type": "string"
    },
    "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"
    },
    "src_component_id": {
      "readonly": true,
      "required": false,
      "title": "The id of the source component from which the traceflow packet was received.",
      "type": "string"
    },
    "src_component_name": {
      "readonly": true,
      "required": false,
      "title": "The name of source component from which the traceflow packet was received.",
      "type": "string"
    },
    "src_component_path": {
      "readonly": true,
      "required": false,
      "title": "The path of the source component from which the traceflow packet was received",
      "type": "string"
    },
    "src_component_type": {
      "$ref": "TraceflowComponentType",
      "readonly": true,
      "required": false,
      "title": "The type of the source component from which the traceflow packet was received."
    },
    "subnet_port_path": {
      "Description": "The path of the subnet port at which the traceflow packet was received.\n",
      "readonly": true,
      "required": false,
      "title": "Path of subnet port",
      "type": "string"
    },
    "svc_mac": {
      "description": "MAC address of SAN volume controller for service insertion(SI) in service VM(SVM) where the traceflow packet was received.",
      "readonly": true,
      "required": false,
      "title": "MAC address of SAN volume controller",
      "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"
    },
    "vlan": {
      "$ref": "VlanID",
      "description": "This field is specified when the traceflow packet was received by a VLAN logical network.",
      "readonly": true,
      "required": false,
      "title": "VLAN for the logical network on which the traceflow packet was received."
    },
    "vni": {
      "description": "This field is specified when the traceflow packet was received by an overlay logical network.",
      "readonly": true,
      "required": false,
      "title": "VNI for the logical network on which the traceflow packet was received.",
      "type": "int"
    }
  },
  "type": "object"
}