NVIDIA UFM Cable Validation Tool

Resources APIs

Get Clusters

  • Description – Gets all clusters.

  • Request URL – GET /cablevalidation/clusters

  • Response Content Type – application/json

  • Status Codes200 – OK

  • Response Example 

    ["default"]

Get Data Halls

  • Description – Get a list of all data halls

  • Request URL – GET /cablevalidation/resources/data_halls

  • Response Content Type – application/json

  • Status Codes200 – OK

  • Response Example 

    ["DH1", "DH2"]

Get Scalable Units

  • Description –  Get a list of scalable units.

  • Request URL – GET /cablevalidation/resources/scalable_units

  • Request Params

  • Response Content Type – application/json

  • Status Codes200 – OK404 - NOT FOUND

  • Response Example 

    ["SU1", "SU2"]

Get All Racks

  • Description – Gets a list of rack names.

  • Request URL – GET /cablevalidation/resources/racks

  • Request Paramscluster:  Name of the cluster. If set, the response will return the racks in that specific cluster.Type - stringOptional - trueDefault - default

  • Response Content Type – application/json

  • Status Codes200 – OK404 – NOT FOUND

  • Response Example 

    ["PXX", "PXH"]

Get Rack

  • Description – Gets a single rack by name.

  • Request URL – GET /cablevalidation/resources/racks/<rack_name>

  • Request Paramscluster:  Name of the cluster. If set, the response will return the rack in that specific cluster.Type - stringOptional - trueDefault - default

  • Response Content Type – application/json

  • Status Codes200 – OK404 – NOT FOUND

  • Response Example 

    {
      "name": "AAA",
      "port_type": "ib",
      "dh": "DH1",
      "su": "SU1",
      "units": [{
          "unit": "35",
          "nodedesc": "swx-ray09 mlx5_0",
          "nodetype": "Switch",
          "system_info": {
            "Manufacturer": "Nvidia",
            "Product Name": "Q3400_RA",
            "Version": "V0-F*Tb-L*GcNaEi-P*PaPa-O*Tb",
            "Serial Number": "MT2421X00988"
          },
          "device_health": {
            "Power Supply": 
              "Failed": 11,
              "Active": 1
            },
            "Power Supply Fans": {
              "Failed": 1,
              "Active": 1
            },
            "Fans": {
              "Failed": 0,
              "Active": 8
            }
          },
          "ports": [
            {
              "port": "sw26p1",
              "port_name": "",
              "syndrome": "Wrong-neighbor",
              "peer_port": "sw10p1",
              "peer_node": "x-spine-1"
            }]
    	}],
        "rear_view":{
          "cable_cartridges":{
             "1":{
                "label":"CC#1",
                "serial":"1782724110090",
                "part_number":"750-0584-000",
                "status":"ok",
                "syndrome":null,
                "action":null,
                "issues":[
                   
                ],
                "manufacturing_date":"08/20/24 - 05:25:00",
                "devices":{
                   "gb-nvl-063-switch01":{
                      "status":"ok",
                      "syndrome":"Active",
                      "action":null,
                      "unit":"19",
                      "expected_slot":5,
                      "nodetype":"Switch",
                      "slot_id":"5",
                      "tray_id":"0",
                      "serial":"1782724110090",
                      "part_number":"750-0584-000",
                      "manufacturing_date":"08/20/24 - 05:25:00"
                   }
                   }
                }
             },
             "2":{
                "label":"CC#2",
                "serial":"1782824110005",
                "part_number":"750-0584-000",
                "status":"ok",
                "syndrome":null,
                "action":null,
                "issues":[
                   
                ],
                "manufacturing_date":"08/21/24 - 03:36:00",
                "devices":{
                   
                   "gb-nvl-063-switch01":{
                      "status":"ok",
                      "syndrome":"Active",
                      "action":null,
                      "unit":"19",
                      "expected_slot":5,
                      "nodetype":"Switch",
                      "slot_id":"5",
                      "tray_id":"0",
                      "serial":"1782824110005",
                      "part_number":"750-0584-000",
                      "manufacturing_date":"08/21/24 - 03:36:00"
                   }
                   }
                }
             },
             "3":{
                "label":"CC#3",
                "serial":"1782724110099",
                "part_number":"750-0584-000",
                "status":"ok",
                "syndrome":null,
                "action":null,
                "issues":[
                   
                ],
                "manufacturing_date":"08/19/24 - 02:13:00",
                "devices":{
                   "gb-nvl-063-switch01":{
                      "status":"ok",
                      "syndrome":"Active",
                      "action":null,
                      "unit":"19",
                      "expected_slot":5,
                      "nodetype":"Switch",
                      "slot_id":"5",
                      "tray_id":"0",
                      "serial":"1782724110099",
                      "part_number":"750-0584-000",
                      "manufacturing_date":"08/19/24 - 02:13:00"
                   }
                   }
                }
             },
             "4":{
                "label":"CC#4",
                "serial":"1782824110040",
                "part_number":"750-0584-000",
                "status":"ok",
                "syndrome":null,
                "action":null,
                "issues":[
                   
                ],
                "manufacturing_date":"08/20/24 - 15:31:00",
                "devices":{
                   "gb-nvl-063-switch01":{
                      "status":"ok",
                      "syndrome":"Active",
                      "action":null,
                      "unit":"19",
                      "expected_slot":5,
                      "nodetype":"Switch",
                      "slot_id":"5",
                      "tray_id":"0",
                      "serial":"1782824110040",
                      "part_number":"750-0584-000",
                      "manufacturing_date":"08/20/24 - 15:31:00"
                   }
                }
             }
          },
          "summary":{
             "status":"ok",
             "failed_cc_count":0,
             "issues_count":0
          }
       }
    }

Get Nodes

  • Description – Gets a single rack by name.

  • Request URL – GET /cablevalidation/resources/nodes

  • Request Paramscluster:  Name of the cluster. If set, the response will return the nodes in that specific cluster.Type - stringOptional - trueDefault - default

  • Response Content Type – application/json

  • Status Codes200 – OK404 – NOT FOUND

  • Response Example 

    [
        {
            "node_desc": "MQM8700 sw-hdr-proton01",
            "node_name": "sw-hdr-proton01",
            "type": "Switch",
            "rack": "PXX",
            "unit": 27,
            "cluster": "default",
            "su_number": null,
            "data_hall": null,
            "health_summary": {
                "Power Supply": {
                    "failed": 1,
                    "active": 1
                },
                "Power Supply Fans": {
                    "failed": 1,
                    "active": 1
                },
                "Fans": {
                    "failed": 0,
                    "active": 12
                },
                "Ports": {
                    "failed": 0,
                    "active": 2
                }
            },
            "is_managed": true,
            "system_info": {
                "Manufacturer": "Mellanox Technologies Ltd.",
                "Product Name": "MQM8700",
                "Version": "AF",
                "Serial Number": "MT2019T11025"
            },
            "asset_tag": null,
            "ip": "10.209.44.74",
            "last_update_time": 1754222504
        }]

Get Resource Utilization

  • Description – Gets resource utilization.

  • Request URL – GET  /cablevalidation/resources/resource_utilization

  • Response Content Type – application/json

  • Status Codes200 – OK

  • Response Example 

    {
        "storage": {
            "space_total": "1.8T",
            "space_used": "156G",
            "space_available": "1.5T",
            "space_percent_used": "10%",
            "type": "ext4"
        },
        "memory": {
            "sys_mem_total": "125Gi",
            "sys_mem_used": "10Gi",
            "sys_mem_free": "71Gi",
            "sys_mem_used_percent": "8.24%",
            "swap_mem_total": "15Gi",
            "swap_mem_used": "0B",
            "swap_mem_free": "15Gi",
            "swap_mem_used_percent": "0.0%"
        },
        "cpu_util": {
            "timestamp": 1743960805.0907748,
            "cpu_util_all_cores": "1.43%",
            "cpu_util_current_core": "0.33%"
        }
    }


Last updated: