NSX-T Data Center REST API

IpSecVpnTunnelTrafficStatistics (type)

{
  "additionalProperties": false,
  "description": "Provides the following details for an IPSec VPN tunnel. The packet counters gives statistics since the time the tunnel is UP:  - Incoming packet count. - Outgoing packet count. - Dropped packet count. - Error/Failure reason of dropped packet. - Tunnel status, if it is UP/DOWN. - Tunnel down reason when the tunnel state is DOWN. - Tunnel local subnet. - Tunnel peer subnet. - Policy ID.",
  "id": "IpSecVpnTunnelTrafficStatistics",
  "module_id": "PolicyVpnStats",
  "properties": {
    "bytes_in": {
      "description": "The total number of incoming bytes on the inbound security association.",
      "readonly": true,
      "title": "Bytes in",
      "type": "integer"
    },
    "bytes_out": {
      "description": "The total number of outgoing bytes on the outbound security association.",
      "readonly": true,
      "title": "Bytes out",
      "type": "integer"
    },
    "decryption_failures": {
      "description": "The total number of packets dropped due to decryption failures.",
      "readonly": true,
      "title": "Decryption failures",
      "type": "integer"
    },
    "dropped_packets_in": {
      "description": "The total number of incoming packets dropped on the inbound security association.",
      "readonly": true,
      "title": "Dropped incoming packets",
      "type": "integer"
    },
    "dropped_packets_out": {
      "description": "The total number of outgoing packets dropped on the outbound security association.",
      "readonly": true,
      "title": "Dropped outgoing packets",
      "type": "integer"
    },
    "encryption_failures": {
      "description": "The total number of packets dropped due to failure in encryption.",
      "readonly": true,
      "title": "Encryption failures",
      "type": "integer"
    },
    "integrity_failures": {
      "description": "The total number of packets dropped due to integrity failures.",
      "readonly": true,
      "title": "Integrity failures",
      "type": "integer"
    },
    "local_subnet": {
      "description": "Tunnel local subnet in IPv4 CIDR Block format.",
      "readonly": true,
      "title": "Local subnet",
      "type": "string"
    },
    "nomatching_policy_errors": {
      "description": "The total number of packets dropped because of no matching policy was available.",
      "readonly": true,
      "title": "Nomatching Policy errors",
      "type": "integer"
    },
    "packets_in": {
      "description": "The total number of incoming packets on the inbound security association.",
      "readonly": true,
      "title": "Packets in",
      "type": "integer"
    },
    "packets_out": {
      "description": "The total number of outgoing packets on the outbound security association.",
      "readonly": true,
      "title": "Packets out",
      "type": "integer"
    },
    "packets_received_other_error": {
      "description": "The total number of incoming packets dropped on the inbound security association due to miscellaneous errors .",
      "readonly": true,
      "title": "Packets received other error",
      "type": "integer"
    },
    "packets_sent_other_error": {
      "description": "The total number of outgoing packets dropped due to miscellaneous errors.",
      "readonly": true,
      "title": "Packets sent other error",
      "type": "integer"
    },
    "peer_subnet": {
      "description": "Tunnel peer subnet in IPv4 CIDR Block format.",
      "readonly": true,
      "title": "Peer subnet",
      "type": "string"
    },
    "policy_id": {
      "description": "Policy UUID of IPSec Tunnel.",
      "readonly": true,
      "title": "Policy Identifier",
      "type": "string"
    },
    "replay_errors": {
      "description": "The total number of packets dropped due to replay check on that security association.",
      "readonly": true,
      "title": "Replay errors",
      "type": "integer"
    },
    "sa_mismatch_errors_in": {
      "description": "The total number of security association mismatch errors on incoming packets.",
      "readonly": true,
      "title": "Security association mismatch errors on incoming packets.",
      "type": "integer"
    },
    "sa_mismatch_errors_out": {
      "description": "The total number of security association mismatch errors on outgoing packets.",
      "readonly": true,
      "title": "Security association mismatch errors on outgoing packets",
      "type": "integer"
    },
    "seq_number_overflow_error": {
      "description": "The total number of packets dropped while sending due to overflow in sequence number.",
      "readonly": true,
      "title": "Sequence number overflow error",
      "type": "integer"
    },
    "tunnel_down_reason": {
      "description": "Gives the detailed reason about the tunnel when it is down. If tunnel is UP tunnel down reason will be empty.",
      "readonly": true,
      "title": "Tunnel down reason",
      "type": "string"
    },
    "tunnel_status": {
      "description": "Specifies the status of tunnel, if it is UP/DOWN.",
      "enum": [
        "UP",
        "DOWN"
      ],
      "readonly": true,
      "title": "Tunnel Status",
      "type": "string"
    }
  },
  "title": "IPSec VPN tunnel traffic statistics",
  "type": "object"
}