NVIDIA UFM Cable Validation Tool v1.6.0

Amber Simulation APIs

  • Description – Gets amber simulation.

  • Request URL –GET /cablevalidation/simulation/amber

  • Request Params:

    Parameter

    Description

    Type

    Optional/Required

    node_name

    Node name. If set, gets a simulation info for that node

    string

    Optional

  • Response Content Type – application/json

  • Status Codes

    • 200 – OK

  • Response Data Example

    Copy
    Copied!
                

    [{"node_name": "sw-hdr-proton01", "device": null}]

  • Description – Load amber simulation.

  • Request URL –POST /cablevalidation/simulation/amber/load

  • Request Data

    Parameter

    Description

    Type

    Optional/Required

    node_name

    Node name

    string

    Required

    device

    Device's name, if the node contains multiple devices

    string

    Optional

    file

    The binary file

    Binary

    Required

  • Response Content Type – application/json

  • Status Codes

    • 201 – CREATED

    • 400 - Bad Request

    • 409 - CONFLICT

  • Response Data Example

    Copy
    Copied!
                

    {     "status": "success",     "node_name": "sw-hdr-proton01",     "saved_file": "/tmp/amber_simulation_sw-hdr-proton01_device1_1754227317.csv",     "size_bytes": 185578 }

  • Description – Load amber simulation.

  • Request URL –DELETE /cablevalidation/simulation/amber/stop

  • Request Parameters:

    Parameter

    Description

    Type

    Optional/Required

    node_name

    Node name

    string

    Required

    device

    Device's name, if the node contains multiple devices

    string

    Optional

  • Response Content Type – no content

  • Status Codes

    • 204 – NO CONTENT

    • 400 - BAD REQUEST

    • 404 - NOT FOUND

© Copyright 2025, NVIDIA. Last updated on Aug 14, 2025.