Telemetry Data

NVIDIA UFM Cyber-AI Documentation v2.5.0
  • URL

    Copy
    Copied!
                

    GET /cyber-ai/telemetry/counters?type=<type>

    Allowed Types:

    • Link

    • Cable

    • Network

    • Tenant

    • Logical-server

  • Request Data

    Copy
    Copied!
                

    None

  • Response

    Copy
    Copied!
                

    { "LinkDownedCounterExtended": "Link Downed Counter Extended", "MaxRetransmissionRate": "Max Retransmission Rate", "PortBufferOverrunErrors": "Port Buffer Overrun Errors", "PortDLIDMappingErrors": "Port DLID Mapping Errors", "PortFECCorrectableBlockCounter": "Port FEC Correctable Block Counter", "PortFECCorrectedSymbolCounter": "Port FEC Corrected Symbol Counter", "PortFECUncorrectableBlockCounter": "Port FEC Uncorrectable Block Counter", ... }

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/telemetry/network/traffic?period=<period_type>

    Where period_type can be:

    • weekly_average

    • last_week

    • current_week

  • Request Data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    [ { "time": "06:00:00", "DOW": "Wed", "value": 50 }, { "time": "07:00:00", "DOW": "Wed", "value": 45 } ]

  • URL for tenant

    Copy
    Copied!
                

    GET /cyber-ai/telemetry/tenant/{tenant_id}/{counter}

  • URL filters:

    • From – retrieve alerts triggered within the last given time period:

      Copy
      Copied!
                  

      ?from=-<time>

      Supported time units: h (for hours), d (for days), w (for weeks), m (for months). For example: ?from=-6h.

    • To – retrieve telemetry data for a given time point:

      Copy
      Copied!
                  

      ?to=-<time>

  • Request Data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    [ { "time": "06:00:00", "value": 45 }, { "time": "07:00:00", "value": 55 } ]

  • Response codes

    Status

    Description

    200

    Success

    400

    Bad Request (invalid argument)

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/telemetry/tenant/network/{counter}

  • URL filters:

    • margin – retrieve telemetry data from a given time point:

      Copy
      Copied!
                  

      ?margin=<time>

      Supported time units: h (for hours), d (for days), w (for weeks), m (for months). For example: ? margin=1d.

    • Time Per Tenant

      Copy
      Copied!
                  

      ?time_per_tenant=<tenant_id>

  • Request Data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    [ { "time": "06:00:00", "value": 45 }, { "time": "07:00:00", "value": 55 } ]

  • Response codes

    Status

    Description

    200

    Success

    400

    Bad Request (invalid argument)

  • URL for tenant

    Copy
    Copied!
                

    GET /cyber-ai/telemetry/logical-server/<logical_server_id>/{counter}

  • URL filters

    • From – retrieve telemetry data within the latest given time period

      Copy
      Copied!
                  

      ?from=-<time>

      Warning

      Supported time units: h (for hours), d (for days), w (for weeks) and m (for months). For example: ?from=-6h.

    • To – retrieve telemetry data for any given time point

      Copy
      Copied!
                  

      ?to=-<time>

  • Request data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    [ { "time": "2022-03-01 14:51:07.000000", "value": 1.1666666666666647e-254 }, { "time": "2022-03-01 15:51:07.000000", "value": 1.16668418566647e-182 } ]

  • Response codes

    Status

    Description

    200

    Success

    400

    Bad request

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/telemetry/link/{node_id}

  • URL filters:

    • From – retrieve alerts triggered within the last given time period:

      Copy
      Copied!
                  

      ?from=-<time>

      Supported time units: h (for hours), d (for days), w (for weeks), m (for months). For example: ?from=-1d.

    • Influencers

      Copy
      Copied!
                  

      ?influencers=<comma-separated list of influencers>

    • Average, return average data:

      Copy
      Copied!
                  

      ?average=["True"|"False"]

  • Request Data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    [ { "time": "06:00:00", "value": 45 }, { "time": "07:00:00", "value": 55 } ]

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/telemetry/cable/{cable_id}/{influencer}

  • URL filters:

    • From – retrieve telemetry data within the last given time period:

      Copy
      Copied!
                  

      ?from=-<time>

      Supported time units: h (for hours), d (for days), w (for weeks), m (for months). For example: ?from=-6h.

    • Probability – return all alerts with probability equal to, or greater than the given probability

      Copy
      Copied!
                  

      ?min_probability=<0-100>

    • Influencers:

      Copy
      Copied!
                  

      ?influencers=<comma-separated list of influencers>

  • Request Data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    { "time": "06:00:00", "value": 45 }, { "time": "07:00:00", "value": 55 } ]

© Copyright 2023, NVIDIA. Last updated on Sep 5, 2023.