Modules

Description

This interface is used to retrieve the system's modules (CPU, fan, power supply etc) in NEO

Request URL

GET /neo/resources/modules

Request Data

N/A

Response:

Copy
Copied!
            

[{ "SKU": "CPU_X86", "Vendor": "Mellanox", "Name": "CPU_X86", "InstanceID": "<system_ip>.cpu.1", "S/N": "MT1416X01801", "P/N": "SA001001", "State": "OK", "Health": "OK", "Device": "switch-d3f962", "Model": "CPU" }, { "SKU": "SX1024_FAN", "Vendor": "Mellanox", "Name": "FAN1", "InstanceID": "<system_ip>.fan.1", "S/N": "MT1417X05517", "P/N": "MSX62-FF", "State": "OK", "Health": "OK", "Device": "switch-d3f962", "Model": "FAN" } ]

Description

Retrieves module data for requested modules

Request URL

GET /neo/resources/modules/<module ids>

Request Data

N/A

Response:

Copy
Copied!
            

[{ "systemIP": "10.224.15.89", "sku": "MSN2700", "vendor": "Mellanox", "name": "MGMT", "serialNumber": "MT1619X05217", "model": "MGMT", "state": "OK", "health": "OK", "systemName": "ufm-switch19", "systemID": "10.224.15.89.system", "partNumber": "MSN2700-CS2F", "id": "10.224.15.89.mgmt.1" }, { "systemIP": "10.224.15.89", "sku": "FAN", "vendor": "Mellanox", "name": "FAN3", "serialNumber": "MT1619X04906", "model": "FAN", "state": "OK", "health": "OK", "systemName": "ufm-switch19", "systemID": "10.224.15.89.system", "partNumber": "MTEF-FANF-A", "id": "10.224.15.89.fan.3" } ]

Description

Retrieves modules data for specific systems in the NEO

Request URL

GET /neo/resources/modules?system_ids=<list of system ids>

list_of_systems: can be one or more instanceID for systems separated by comma, such as <system1_IP>.system,<system2_IP>.system …

Request Data

N/A

Response:

Copy
Copied!
            

[{ "SKU": "CPU_X86", "Vendor": "Mellanox", "Name": "CPU_X86", "InstanceID": "<system_ip>.cpu.1", "S/N": "MT1416X01801", "P/N": "SA001001", "State": "OK", "Health": "OK", "Device": "switch-d3f962", "Model": "CPU" }, { "SKU": "SX1024_FAN", "Vendor": "Mellanox", "Name": "FAN1", "InstanceID": "<system_ip>.fan.1", "S/N": "MT1417X05517", "P/N": "MSX62-FF", "State": "OK", "Health": "OK", "Device": "switch-d3f962", "Model": "FAN" } ]

Warning
  • If an invalid or a non-existing system is specified, an empty list will be returned.

  • In this API, users can specify one system or more by adding systems instanceID's in Request URL.

© Copyright 2023, NVIDIA. Last updated on Nov 16, 2023.