NSX-T Data Center REST API

PolicyBgpNeighborStatus (type)

{
  "id": "PolicyBgpNeighborStatus",
  "module_id": "PolicyConnectivityStatistics",
  "properties": {
    "address_families": {
      "description": "Address families of BGP neighbor",
      "items": {
        "$ref": "BgpAddressFamily"
      },
      "readonly": true,
      "required": false,
      "title": "Address families of BGP neighbor",
      "type": "array"
    },
    "announced_capabilities": {
      "items": {
        "type": "string"
      },
      "readonly": true,
      "required": false,
      "title": "BGP capabilities sent to BGP neighbor.",
      "type": "array"
    },
    "connection_drop_count": {
      "readonly": true,
      "required": false,
      "title": "Count of connection drop",
      "type": "integer"
    },
    "connection_state": {
      "enum": [
        "INVALID",
        "IDLE",
        "CONNECT",
        "ACTIVE",
        "OPEN_SENT",
        "OPEN_CONFIRM",
        "ESTABLISHED",
        "UNKNOWN"
      ],
      "readonly": true,
      "required": false,
      "title": "Current state of the BGP session.",
      "type": "string"
    },
    "edge_path": {
      "required": false,
      "title": "Transport node policy path",
      "type": "string"
    },
    "established_connection_count": {
      "readonly": true,
      "required": false,
      "title": "Count of connections established",
      "type": "integer"
    },
    "graceful_restart_mode": {
      "description": "Current state of graceful restart of BGP neighbor. Possible values are - 1. GR_AND_HELPER - Graceful restart with Helper 2. HELPER_ONLY - Helper only 3. DISABLE - Disabled",
      "readonly": true,
      "required": false,
      "title": "Graceful restart mode",
      "type": "string"
    },
    "hold_time": {
      "description": "If a HELLO packet is not seen from BGP Peer withing hold_time then BGP neighbor will be marked as down.",
      "readonly": true,
      "required": false,
      "title": "Time in ms to wait for HELLO from BGP peer.",
      "type": "integer"
    },
    "keep_alive_interval": {
      "readonly": true,
      "required": false,
      "title": "Time in ms to wait for HELLO packet from BGP peer",
      "type": "integer"
    },
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp",
      "description": "Timestamp when the data was last updated, unset if data source has never updated the data.",
      "readonly": true,
      "title": "Timestamp indicating last update time of data"
    },
    "local_port": {
      "maximum": 65535,
      "minimum": 1,
      "readonly": true,
      "required": false,
      "title": "TCP port number of Local BGP connection",
      "type": "integer"
    },
    "messages_received": {
      "readonly": true,
      "required": false,
      "title": "Count of messages received from the neighbor",
      "type": "integer"
    },
    "messages_sent": {
      "readonly": true,
      "required": false,
      "title": "Count of messages sent to the neighbor",
      "type": "integer"
    },
    "negotiated_capability": {
      "items": {
        "type": "string"
      },
      "readonly": true,
      "required": false,
      "title": "BGP capabilities negotiated with BGP neighbor.",
      "type": "array"
    },
    "neighbor_address": {
      "$ref": "IPAddress",
      "readonly": true,
      "required": false,
      "title": "The IP of the BGP neighbor"
    },
    "neighbor_edge_node": {
      "readonly": true,
      "required": false,
      "title": "Inter-Sr neighbor edge node policy path",
      "type": "string"
    },
    "neighbor_router_id": {
      "readonly": true,
      "required": false,
      "title": "Router ID of the BGP neighbor.",
      "type": "string"
    },
    "remote_as_number": {
      "readonly": true,
      "required": false,
      "title": "AS number of the BGP neighbor",
      "type": "string"
    },
    "remote_port": {
      "maximum": 65535,
      "minimum": 1,
      "readonly": true,
      "required": false,
      "title": "TCP port number of remote BGP Connection",
      "type": "integer"
    },
    "remote_site": {
      "$ref": "ResourceReference",
      "description": "Remote site details.",
      "readonly": true,
      "title": "Remote site"
    },
    "source_address": {
      "$ref": "IPAddress",
      "readonly": true,
      "required": false,
      "title": "The Ip address of logical port"
    },
    "tier0_path": {
      "readonly": true,
      "required": true,
      "title": "Policy path to Tier0",
      "type": "string"
    },
    "time_since_established": {
      "readonly": true,
      "required": false,
      "title": "Time(in seconds) since connection was established.",
      "type": "integer"
    },
    "total_in_prefix_count": {
      "description": "Sum of in prefixes counts across all address families.",
      "readonly": true,
      "required": false,
      "title": "Count of in prefixes",
      "type": "integer"
    },
    "total_out_prefix_count": {
      "description": "Sum of out prefixes counts across all address families.",
      "readonly": true,
      "required": false,
      "title": "Count of out prefixes",
      "type": "integer"
    },
    "type": {
      "description": "BGP neighbor type",
      "enum": [
        "INTER_SR",
        "USER"
      ],
      "readonly": true,
      "title": "BGP neighbor type",
      "type": "string"
    }
  },
  "type": "object"
}