Resources

NVIDIA UFM Cyber-AI Documentation v2.5.0
  • URL

    Copy
    Copied!
                

    GET /cyber-ai/resources/nodes/top-link-failure

  • URL filters:

    • from – retrieve nodes with triggered link failures 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 nodes whose link failures with probability equal to, or greater than the given probability

      Copy
      Copied!
                  

      ?min_probability=<0-100>

    • count – retrieve specific number of nodes

    • Severity – retrieve nodes based on the severity of link failures:

      Copy
      Copied!
                  

      ?severities=<comma-separated list of severities>

    • Node Type – retrieve nodes based on the type (“host”, “switch”)

      Copy
      Copied!
                  

      ?node_type=<type>

  • Request

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    [ { "failure_indications": 1, "port_name": "0x506b4b03005c2360:7" }, { "failure_indications": 1, "port_name": "0x506b4b0300623360:8" }, { "failure_indications": 1, "port_name": "0x506b4b03006c1f20:13" } ]

  • Response codes

    Status

    Description

    200

    Success

    400

    Bad Request (invalid argument)

    Get Anomaly Nodes

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/resources/nodes/anomaly

  • URL filters:

    • From – retrieve nodes whose triggered alerts 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>

    • Severity – retrieve only alerts with a severity included in the list:

      Copy
      Copied!
                  

      ?severities=<comma-separated list of severities>

  • Request

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    {}

  • Response codes

    Status

    Description

    200

    Success

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/resources/cable/anomaly

  • URL filters:

    • From – retrieve cables whose triggered alerts 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:

      Copy
      Copied!
                  

       ?from=-6h.

    • Request

      Copy
      Copied!
                  

      none

    • Response

      Copy
      Copied!
                  

      "nodes": { "anomaly": 473, "normal": 1663 }, "switches": { "anomaly": 31, "normal": 167 } }

    • Response codes

      Status

      Descriptions

      200

      Success

      400

      Bad Request (invalid argument)

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/resources/tenant/allocation

  • Request

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    { "allocated": 15, "free": 993 }

  • Response codes

    Status

    Description

    200

    Success

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/resources/tenant/{tenant_id}/nodes

  • Request

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    [ { "port_guid": "0xec0d9a03008460a6", "port_name": "HCA-2/1", "system_name": "nia-m4-bb02", "utilization": 15.4 }, { "port_guid": "0xec0d9a0300845e6a", "port_name": "HCA-2/1", "system_name": "nia-m4-bb06", "utilization": 15.4 } ]

  • Response code

    Status

    Description

    200

    Success

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/resources/tenant/top-congested

  • 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.

    • Count – retrieve specific number of nodes

      Copy
      Copied!
                  

      ?count=<integer larger than 0>

  • Request

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    [ { "tenant_id": "0x0001", "congestion": 4 }{ "tenant_id": "0x0003", "congestion": 3 }{ "tenant_id": "0x0005", "congestion": 2 } ]

  • Response codes

    Status

    Description

    200

    Success

    400

    Bad Request

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/resources/logical-server/allocation

  • Request

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    { "allocated": 15, "free": 2131 }

  • Response codes

    Status

    Description

    200

    Success

    400

    Bad request

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/resources/logical-server/top-congested

  • URL filters

    • From – retrieve alerts triggered 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.

    • Count – retrieve a specific number of nodes

      Copy
      Copied!
                  

      ?count=<integer larger than 0>

  • Request

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    [ { "logical_server": "LS", "utilization": 0.0315922587555555 }, { "logical_server": "LS_test", "utilization": 0.0060010954666666 } ]

  • Response codes

    Status

    Description

    200

    Success

    400

    Bad request

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/resources/link-anomaly

  • URL filters:

    • Influencers:

      Copy
      Copied!
                  

      ?influencers=<comma-separated list of influencers>

    • Request

      Copy
      Copied!
                  

      none

    • Response

      Copy
      Copied!
                  

      [ { "name": "vl15_dropped", "description": "Number of incoming VL15 packets dropped due to resource limitations (e.g., lack of buffers) in the port." } ]

    • Response codes

      Status

      Description

      200

      Success

      400

      Bad Request

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/resources/link-anomaly/{influencer}

  • Request

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    { "name": "vl15_dropped", "description": "Number of incoming VL15 packets dropped due to resource limitations (e.g., lack of buffers) in the port." }

  • Response codes

    Status

    Description

    200

    Success

    404

    Not Found

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