Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    VPN Traffic Data Details

    Returns traffic details for the specified router VPN, with the information retrieved from the daily database VPN tables.

    • Root URL: Same consideration as Performance Management and Hardware Inventory
      • Traffic collection specific: /tenant/1/trafficData /1/

    VPN Traffic Data

    Parameter

    Description

    IPMPLSView/API/v1/tenant/1/trafficData/1/vpnInterfacesByVPN

    vpnname

    Returns list of device/interfaces on the specified vpnName.

    IPMPLSView/API/v1/tenant/1/trafficData/1/vpnfile

     

    Returns a formatted version of an attached vpn.x file.

    IPMPLSView/API/v1/tenant/1/trafficData/1/vpnfile

    vpntype

    Returns a list of Layer 2 Kompella VPN instance allowed values:

    • vpntype include 3 (L3 VPN)
    • 2M (L2 Martini)
    • 2K (L2 Kompella)
    • 2V (VPLS LDP based)
    • 2C (L2 CCC)
    • VPLS (VPLS BGP based)
    • VR (VRF Lite) Interface traffic per VPN

    IPMPLSView/API/v1/tenant/1/trafficData/1/vpnInterfaceTraffic

    vpnname

    Returns all device/interface traffic stats (from the DB) for the specified vpnName.

    Traffic Collection Schema

    Example A:

    IPMPLSView/API/v1/tenant/1/trafficData/1/devices

    (partial sample output)

    [ { routerID: 1, 
    groupID: 1, 
    routerIP: '172.16.0.105', 
    routerName: '5_PARIS', 
    routerType: 'JUNIPER_J', 
    secondaryIP: '', 
    snmpPort: 161, 
    snmpRetry: 3, 
    snmpTimeout: 3, 
    snmpVersion: '2C', 
    snmpUser: '', 
    snmpContextEngine: null, 
    snmpAuth: 'NONE', 
    snmpPrivacy: 'NONE', 
    collectIFXinfo: 1, 
    collectionMethod: 'SNMP', 
    cliLogin: 'newlab', 
    cliAccessMethod: 'telnet', 
    cliTelnetTimeout: 300, 
    cliTelnetRetries: 3, 
    cliTelnetPort: 23, 
    cliSSHCommand: 'ssh', 
    cliAgents: '', 
    snmpGetBulkSize: 0, 
    maxCollectTime: 240, 
    collectTables: 'IF,IFX,TUNNEL,COS,MCAST', 
    cliSpecific: null, 
    ipv6Address: '' }, 
    { routerID: 2, 
    groupID: 1, 
    routerIP: '172.16.0.104', 
    routerName: '4_BERLIN', 
    routerType: 'JUNIPER_J', 
    secondaryIP: '', 
    snmpPort: 161, 
    snmpRetry: 3, 
    snmpTimeout: 3, 
    snmpVersion: '2C', 
    snmpUser: '', 
    snmpContextEngine: null, 
    snmpAuth: 'NONE', 
    snmpPrivacy: 'NONE', 
    collectIFXinfo: 1, 
    collectionMethod: 'SNMP', 
    cliLogin: 'newlab', 
    cliAccessMethod: 'telnet', 
    cliTelnetTimeout: 300, 
    cliTelnetRetries: 3, 
    cliTelnetPort: 23, 
    cliSSHCommand: 'ssh', 
    cliAgents: '', 
    snmpGetBulkSize: 0, 
    maxCollectTime: 240, 
    collectTables: 'IF,IFX,TUNNEL,COS,MCAST', 
    cliSpecific: null, 
    ipv6Address: '' }, 
    { routerID: 3, 
    groupID: 1, 
    routerIP: '172.16.0.107', 
    routerName: '7_MADRID', 
    routerType: 'JUNIPER_J', 
    secondaryIP: '', 
    snmpPort: 161, 
    snmpRetry: 3, 
    snmpTimeout: 3, 
    snmpVersion: '2C', 
    snmpUser: '', 
    snmpContextEngine: null, 
    snmpAuth: 'NONE', 
    snmpPrivacy: 'NONE', 
    collectIFXinfo: 1, 
    collectionMethod: 'SNMP', 
    cliLogin: 'newlab', 
    cliAccessMethod: 'telnet', 
    cliTelnetTimeout: 300, 
    cliTelnetRetries: 3, 
    cliTelnetPort: 23, 
    cliSSHCommand: 'ssh', 
    cliAgents: '', 
    snmpGetBulkSize: 0, 
    maxCollectTime: 240, 
    collectTables: 'IF,IFX,TUNNEL,COS,MCAST', 
    cliSpecific: null, 
    ipv6Address: '' }, 
    { routerID: 4, 
    groupID: 1, 
    routerIP: '172.16.0.106', 
    routerName: '6_FRANKFURT', 
    routerType: 'JUNIPER_J', 
    secondaryIP: '', 
    snmpPort: 161, 
    snmpRetry: 3, 
    snmpTimeout: 3, 
    snmpVersion: '2C', 
    snmpUser: '', 
    snmpContextEngine: null, 
    snmpAuth: 'NONE', 
    snmpPrivacy: 'NONE', 
    collectIFXinfo: 1, 
    collectionMethod: 'SNMP', 
    cliLogin: 'newlab', 
    cliAccessMethod: 'telnet', 
    cliTelnetTimeout: 300, 
    cliTelnetRetries: 3, 
    cliTelnetPort: 23, 
    cliSSHCommand: 'ssh', 
    cliAgents: '', 
    snmpGetBulkSize: 0, 
    maxCollectTime: 240, 
    collectTables: 'IF,IFX,TUNNEL,COS,MCAST', 
    cliSpecific: null, 
    ipv6Address: '' 
    }, 
    . . .
    . . .
    ]
    

    Example B:

    IPMPLSView/API/v1/tenant/1/trafficData/1/routerDetails?routerName=5_PARIS

    (partial sample output)

    {"routerID":2,
    "groupID":1,
    "routerName":"4_BERLIN",
    "routerIP":"172.16.0.104",
    "routerType":"JUNIPER_J",
    "collectTables":"IF,IFX",
    "timeSig":20151114224,
    "status":1,
    "ingress":198153,
    "egress":168965,
    "tIngress":0,
    "tEgress":0
    },
    {"routerID":3,
    "groupID":1,
    "routerName":"7_MADRID",
    "routerIP":"172.16.0.107",
    "routerType":"JUNIPER_J",
    "collectTables":"IF,IFX",
    "timeSig":20151114224,
    "status":1,
    "ingress":66626,
    "egress":69420,
    "tIngress":0,
    "tEgress":0
    },
    {"routerID":4,
    "groupID":1,
    "routerName":"6_FRANKFURT",
    "routerIP":"172.16.0.106",
    "routerType":"JUNIPER_J",
    "collectTables":"IF,IFX",
    "timeSig":20151114224,
    "status":1,
    "ingress":458955,
    "egress":428662,
    "tIngress":0,
    "tEgress":0},
    . . .
    . . .
    

    Example C:

    /IPMPLSView/API/v1/tenant/1/trafficData/1/interfaceDetails?routerName=5_PARIS

    (partial sample output)

    [ 
    { interfaceDesc: 'lo0.0',
        interfaceBW: 0,
        comment: '',
        interfaceID: 350,
        timeSig: 20141110121,
        collectedTS: 1418224231,
        status: 1, 
        ingress: 0,
        egress: 0,
        ingressError: 0,
        egressError: 0,
        ingressDiscard: 0,
        egressDiscard: 0,
        ingressMax: 0,
        egressMax: 0 },
      {   
    

    /IPMPLSView/API/v1/tenant/1/trafficData/1/network/intfTraffic

    (partial sample output)

    [ { StimeMMDDYY: '12/10/14',
        StimeHH: '9',
        StimeMM: '25',
        StimeAMPPM: 'AM',
        Interval: '5' },
      { routerName: '10_BARCELONA',
        intfName: 'ge-0/0/1.470',
        ipAddr: '172.16.0.110',
        type: '0',
        dataPoints: 
         [ '16521',
           '16529',
           '16525',
           '16526',
           '16526',
           '16470',
           '16524',
           '16527',
           '16529',
           '16527',
           '16525',
           '16523',
           '16527',
           '16473',
           '16577',
           '16528',
           '16467',
           '16582',
           '16528',
           '16469',
           '16583',
           '16470',
           '16523',
           '16526' ] },
    

    Example E:

    /IPMPLSView/API/v1/tenant/1/trafficData/1/network/tunTraffic

    (partial sample output)

    Same as PM

    Example F:

    /IPMPLSView/API/v1/tenant/1/trafficData/1/tunnelTraffic?routerName=5_PARIS&limit=2

    (partial sample output)

    [{"tunnelID":152,
    "timeSig":0,
    "collectedTS":0,
    "status":2,
    "recordedRoute":"null",
    "ingressBytes":0,
    "ingressBytesDelta":0,
    "ingressPackets":0,
    "ingressPacketsDelta":0,
    "routerID":1,
    "toRouterID":9,
    "tunnelName":"R5_PARIS1_DUBLIN_7"
    },
    {"tunnelID":153,
    "timeSig":0,
    "collectedTS":0,
    "status":-2,
    "recordedRoute":"null",
    "ingressBytes":0,
    "ingressBytesDelta":0,
    "ingressPackets":0,
    "ingressPacketsDelta":0,
    "routerID":1,
    "toRouterID":10,
    "tunnelName":"R5_PARIS2_AMSTERDAM_8"}
    ]

    Example G:

    /IPMPLSView/API/v1/tenant/1/trafficData/1/interfaceTraffic?routerName=5_PARIS&limit=10

    (partial sample output)

    [
    {
    "interfaceID": 1062,
          "interfaceDesc": "ge-0/0/1",
          "timeSig": 20151114239,
          "collectedTS": 1450123231,
          "status": 1,
          "ingressBytes": 1316525362950,
          "ingressBytesDelta": 98067,
          "ingressUtil": 0.0784536,
          "ingressPackets": 0,
          "ingressPacketsDelta": 0,
          "egressBytes": 1322019050049,
          "egressBytesDelta": 98299,
          "egressUtil": 0.0786392,
          "egressPackets": 0,
          "egressPacketsDelta": 0,
          "ifHCInUcastPkts": 3640909443,
          "ifHCInMulticastPkts": 0,
          "ifHCInBroadcastPkts": 0,
          "ifHCOutUcastPkts": 1066996921,
          "ifHCOutMulticastPkts": 0,
          "ifHCOutBroadcastPkts": 0,
          "ingressErrorCount": 2147483647,
          "egressErrorCount": 0,
          "ingressDiscardCount": 126336,
          "egressDiscardCount": 0
       },
       {
          "interfaceID": 1062,
          "interfaceDesc": "ge-0/0/1",
          "timeSig": 20151114240,
          "collectedTS": 1450123531,
          "status": 1,
          "ingressBytes": 1316554983037,
          "ingressBytesDelta": 98733,
          "ingressUtil": 0.0789864,
          "ingressPackets": 0,
          "ingressPacketsDelta": 0,
          "egressBytes": 1322048735396,
          "egressBytesDelta": 98951,
          "egressUtil": 0.0791608,
          "egressPackets": 0,
          "egressPacketsDelta": 0,
          "ifHCInUcastPkts": 3640964983,
          "ifHCInMulticastPkts": 0,
          "ifHCInBroadcastPkts": 0,
          "ifHCOutUcastPkts": 1067021777,
          "ifHCOutMulticastPkts": 0,
          "ifHCOutBroadcastPkts": 0,
          "ingressErrorCount": 2147483647,
          "egressErrorCount": 0,
          "ingressDiscardCount": 126336,
          "egressDiscardCount": 0
       }
    ]
    

    Example H:

    /IPMPLSView/API/v1/tenant/1/trafficData/1/cosTraffic?routerName=4_BERLIN &InterfaceDesc=ge-0/0/1.424

    (partial sample output of Juniper Networks device)

    [
       {
          "interfaceDesc":"ge-0/0/1.424",
          "queueID":45,
          "queueKey":"336+2+0",
          "routerID":2,
          "interfaceID":336,
          "queueNumber":0,
          "queueName":"INTERNET",
          "inOutType":2,
          "timeSig":0,
          "queuedBytesCounter":0,
          "queuedBytesDelta":0,
          "transmittedBytesCounter":0,
          "transmittedBytesDelta":0,
          "totalDroppedBytesCounter":0,
          "totalDroppedBytesDelta":0
       },
       {
          "interfaceDesc":"ge-0/0/1.424",
          "queueID":45,
          "queueKey":"336+2+0",
          "routerID":2,
          "interfaceID":336,
          "queueNumber":0,
          "queueName":"INTERNET",
          "inOutType":2,
          "timeSig":20150915182,
          "queuedBytesCounter":45168572,
          "queuedBytesDelta":null,
          "transmittedBytesCounter":45168572,
          "transmittedBytesDelta":null,
          "totalDroppedBytesCounter":0,
          "totalDroppedBytesDelta":null
       },
       {
          "interfaceDesc":"ge-0/0/1.424",
          "queueID":45,
          "queueKey":"336+2+0",
          "routerID":2,
          "interfaceID":336,
          "queueNumber":0,
          "queueName":"INTERNET",
          "inOutType":2,
          "timeSig":20150915184,
          "queuedBytesCounter":45171148,
          "queuedBytesDelta":8,
          "transmittedBytesCounter":45171148,
          "transmittedBytesDelta":8,
          "totalDroppedBytesCounter":0,
          "totalDroppedBytesDelta":0
       },
       {
          "interfaceDesc":"ge-0/0/1.424",
          "queueID":45,
          "queueKey":"336+2+0",
          "routerID":2,
          "interfaceID":336,
          "queueNumber":0,
          "queueName":"INTERNET",
          "inOutType":2,
          "timeSig":20150915185,
          "queuedBytesCounter":45171352,
          "queuedBytesDelta":0,
          "transmittedBytesCounter":45171352,
          "transmittedBytesDelta":0,
          "totalDroppedBytesCounter":0,
          "totalDroppedBytesDelta":0
       },
       
          "interfaceDesc":"ge-0/0/1.424",
          "queueID":46,
          "queueKey":"336+2+1",
          "routerID":2,
          "interfaceID":336,
          "queueNumber":1,
          "queueName":"BUSINESS",
          "inOutType":2,
          "timeSig":20150915237,
          "queuedBytesCounter":0,
          "queuedBytesDelta":0,
          "transmittedBytesCounter":0,
          "transmittedBytesDelta":0,
          "totalDroppedBytesCounter":0,
          "totalDroppedBytesDelta":0
       },
       {
          "interfaceDesc":"ge-0/0/1.424",
          "queueID":46,
          "queueKey":"336+2+1",
          "routerID":2,
          "interfaceID":336,
          "queueNumber":1,
          "queueName":"BUSINESS",
          "inOutType":2,
          "timeSig":20150915238,
          "queuedBytesCounter":0,
          "queuedBytesDelta":0,
          "transmittedBytesCounter":0,
          "transmittedBytesDelta":0,
          "totalDroppedBytesCounter":0,
          "totalDroppedBytesDelta":0
       
       {
          "interfaceDesc":"ge-0/0/1.424",
          "queueID":48,
          "queueKey":"336+2+3",
          "routerID":2,
          "interfaceID":336,
          "queueNumber":3,
          "queueName":"CONTROL",
          "inOutType":2,
          "timeSig":20150915185,
          "queuedBytesCounter":278741283,
          "queuedBytesDelta":15,
          "transmittedBytesCounter":278741283,
          "transmittedBytesDelta":15,
          "totalDroppedBytesCounter":0,
          "totalDroppedBytesDelta":0
       },
       
    . . . 
    
    ]

    Example I:

    /IPMPLSView/API/v1/tenant/1/trafficData/1/multiCastTraffic?routerName=12_MUNICH

    (partial sample output)

    [
       {
          "interfaceID":466,
          "interfaceDesc":"GigabitEthernet2.542",
          "timeSig":20150915182,
          "mcastInOctetsCounter":23666382708,
          "mcastInOctetsDelta":0,
          "mcastInUtil":0,
          "mcastOutOctetsCounter":0,
          "mcastOutOctetsDelta":0,
          "mcastOutUtil":0
       },
       {
          "interfaceID":466,
          "interfaceDesc":"GigabitEthernet2.542",
          "timeSig":20150915184,
          "mcastInOctetsCounter":23671007772,
          "mcastInOctetsDelta":15416,
          "mcastInUtil":0.0123328,
          "mcastOutOctetsCounter":0,
          "mcastOutOctetsDelta":0,
          "mcastOutUtil":0
       },
       {
          "interfaceID":466,
          "interfaceDesc":"GigabitEthernet2.542",
          "timeSig":20150915185,
          "mcastInOctetsCounter":23675541072,
          "mcastInOctetsDelta":15111,
          "mcastInUtil":0.0120888,
          "mcastOutOctetsCounter":0,
          "mcastOutOctetsDelta":0,
          "mcastOutUtil":0
       },
       {
          "interfaceID":466,
          "interfaceDesc":"GigabitEthernet2.542",
          "timeSig":20150915186,
          "mcastInOctetsCounter":23680071636,
          "mcastInOctetsDelta":15101,
          "mcastInUtil":0.0120808,
          "mcastOutOctetsCounter":0,
          "mcastOutOctetsDelta":0,
          "mcastOutUtil":0
       },
       {
          "interfaceID":466,
          "interfaceDesc":"GigabitEthernet2.542",
          "timeSig":20150915187,
          "mcastInOctetsCounter":23684540964,
          "mcastInOctetsDelta":14897,
          "mcastInUtil":0.0119176,
          "mcastOutOctetsCounter":0,
          "mcastOutOctetsDelta":0,
          "mcastOutUtil":0
       },
       {
          "interfaceID":466,
          "interfaceDesc":"GigabitEthernet2.542",
          "timeSig":20150915188,
          "mcastInOctetsCounter":23689124028,
          "mcastInOctetsDelta":15276,
          "mcastInUtil":0.0122208,
          "mcastOutOctetsCounter":0,
          "mcastOutOctetsDelta":0,
          "mcastOutUtil":0
       },
       {
          "interfaceID":466,
          "interfaceDesc":"GigabitEthernet2.542",
          "timeSig":20150915189,
          "mcastInOctetsCounter":23693670828,
          "mcastInOctetsDelta":15156,
          "mcastInUtil":0.0121248,
          "mcastOutOctetsCounter":0,
          "mcastOutOctetsDelta":0,
          "mcastOutUtil":0
       },
       {
          "interfaceID":466,
          "interfaceDesc":"GigabitEthernet2.542",
          "timeSig":20150915190,
          "mcastInOctetsCounter":23698244892,
          "mcastInOctetsDelta":15246,
          "mcastInUtil":0.0121968,
          "mcastOutOctetsCounter":0,
          "mcastOutOctetsDelta":0,
          "mcastOutUtil":0
       },
       ......
       ......
       ......
    ]

    Example J:

    /IPMPLSView/API/v1/tenant/1/pm/1/devicePerformance/systemUptime

    (partial sample output)

    { 
    "dates": ["150626","150625", … ,"120922","120921" ]
    }
    

    Example K:

    /IPMPLSView/API/v1/tenant/1/pm/1/devicePerformance/systemUptime?from=150611

    (partial sample output)

    {
    "totalCount": "18",
    "fields": ["Router","Availability(%)","2015-06-11 00:00:00”, … ,"2015-06-11 23:50:00","2015-06-11 23:55:00"],
    "routers":  "10_BARCELONA","11_MANCHESTER", … ,"BRG_MX80_07" ]
    }
    

    Example L:

    /IPMPLSView/API/v1/tenant/1/pm/1/devicePerformance/systemUptime?from=150611&offset=1&limit=10

    (partial sample output)

    {
    "fields": ["Router","Availability(%)","2015-06-11 00:00:00”, … ,"2015-06-11 23:50:00","2015-06-11 23:55:00"],
    "totalCount": "18",
    "count": "10", 
    "data": [
    ["10_BARCELONA","100"," "," ","9192120.0 / 106 day(s) 09:22:00", … ,"9277620.0 / 107 day(s) 09:07:00"],
    ["11_MANCHESTER","100"," "," ","9192120.0 / 106 day(s) 09:22:00", … ,"9277620.0 / 107 day(s) 09:07:00"],
    …
    ]
    }
    

    Modified: 2016-09-27