Ports REST API
Important: For InfiniBand network devices that support port labels (e.g., XDR, NDR switches, HCAs of type ConnectX-6 or later), the port
dname
will include port labels (e.g.,
"dname": "1/3/1"
). For other types, only the port number will be displayed.
Description – returns information about all ports in the fabric, ports of a specific system, or all active and external ports in the fabric
Request URL – GET /ufmRest/resources/ports
Main Operations
Get all ports
Get port/s by name
Get all ports of a system
Get all active ports
Get all external ports
Get All Ports
Description – lists all ports in the fabric
Request URL – GET /ufmRest/resources/ports
Request Content Type – Application/json
Response – Get all ports by system type (/ufmRest/resources/ports?sys_type=Switch).
[ {
"description":"Switch IB Port","number":52,"external_number":52,"physical_state":"Polling","path":"default(5) / Switch: sw-ufm-ndr03 / 1/26/2","tier":3,"high_ber_severity":"N/A","lid":34,"mirror":"disable","logical_state":"Down","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"N/A","severity":"Info","active_speed":null,"enabled_speed": [],"supported_speed": [],"active_width":null,"enabled_width": [],"supported_width": [],"dname":"1/26/2","peer_node_name":"N/A","peer":"N/A","peer_node_guid":"N/A","systemID":"900a840300ac8c40","node_description":"sw-ufm-ndr03:1/26/2","label":"1/26/2","name":"900a840300ac8c40_52","module":"N/A","peer_lid":"N/A","peer_guid":"N/A","peer_node_description":"N/A","guid":"900a840300ac8c40","system_name":"sw-ufm-ndr03","system_ip":"10.209.226.152","peer_ip":"N/A","system_capabilities": ["burn_cables_transceivers","ssh","sysinfo","reboot","mark_device_unhealthy","collect_system_dump","burn_cables_transceivers","sw_upgrade","collect_system_dump","Provisioning"],"system_mirroring_template":false,"hw_technology":null}, {"description":"Switch IB Port","number":64,"external_number":64,"physical_state":"Polling","path":"default(5) / Switch: sw-ufm-ndr03 / 1/32/2","tier":3,"high_ber_severity":"N/A","lid":34,"mirror":"disable","logical_state":"Down","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"N/A","severity":"Info","active_speed":null,"enabled_speed": [],"supported_speed": [],"active_width":null,"enabled_width": [],"supported_width": [],"dname":"1/32/2","peer_node_name":"N/A","peer":"N/A","peer_node_guid":"N/A","systemID":"900a840300ac8c40","node_description":"sw-ufm-ndr03:1/32/2","label":"1/32/2","name":"900a840300ac8c40_64","module":"N/A","peer_lid":"N/A","peer_guid":"N/A","peer_node_description":"N/A","guid":"900a840300ac8c40","system_name":"sw-ufm-ndr03","system_ip":"10.209.226.152","peer_ip":"N/A","system_capabilities": ["burn_cables_transceivers","ssh","sysinfo","reboot","mark_device_unhealthy","collect_system_dump","burn_cables_transceivers","sw_upgrade","collect_system_dump","Provisioning"],"system_mirroring_template":false,"hw_technology":null}, {"description":"Switch IB Port","number":40,"external_number":40,"physical_state":"Polling","path":"default(5) / Switch: sw-ufm-ndr03 / 1/20/2","tier":3,"high_ber_severity":"N/A","lid":34,"mirror":"disable","logical_state":"Down","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"N/A","severity":"Info","active_speed":null,"enabled_speed": [],"supported_speed": [],"active_width":null,"enabled_width": [],"supported_width": [],"dname":"1/20/2","peer_node_name":"N/A","peer":"N/A","peer_node_guid":"N/A","systemID":"900a840300ac8c40","node_description":"sw-ufm-ndr03:1/20/2","label":"1/20/2","name":"900a840300ac8c40_40","module":"N/A","peer_lid":"N/A","peer_guid":"N/A","peer_node_description":"N/A","guid":"900a840300ac8c40","system_name":"sw-ufm-ndr03","system_ip":"10.209.226.152","peer_ip":"N/A","system_capabilities": ["burn_cables_transceivers","ssh","sysinfo","reboot","mark_device_unhealthy","collect_system_dump","burn_cables_transceivers","sw_upgrade","collect_system_dump","Provisioning"],"system_mirroring_template":false,"hw_technology":null},...Response with brief flag (/ufmRest/resources/ports?active=true&page_number=1&rpp=10&sorting=system_name[asc],dname[asc])
{
"total_resources":41,"filtered_resources":41,"num_of_pages":5,"first_index":1,"last_index":10,"data": [ {"description":"Computer IB Port","number":1,"external_number":1,"physical_state":"Link Up","path":"default(5) / Computer: r-dcs96 / HCA-1/1","tier":1,"high_ber_severity":"N/A","lid":4660,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable"],"mtu":4096,"peer_port_dname":"36","severity":"Critical","active_speed":"EDR","enabled_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"HCA-1/1","peer_node_name":"r-ufm-sw95","peer":"b8599f0300fc6de4_36","peer_node_guid":"b8599f0300fc6de4","systemID":"1070fd030071aa4e","node_description":"r-dcs96 HCA-3","label":"N/A","name":"1070fd030071aa4e_1","module":"N/A","peer_lid":31,"peer_guid":"b8599f0300fc6de4","peer_node_description":"r-ufm-sw95:36","guid":"1070fd030071aa4e","system_name":"r-dcs96","system_ip":"0.0.0.0","peer_ip":"10.209.37.95","system_capabilities": ["mark_device_unhealthy"],"system_mirroring_template":false,"hw_technology":null}, {"description":"Computer IB Port","number":1,"external_number":1,"physical_state":"Link Up","path":"default(5) / Computer: r-dmz-ufm128 / HCA-1/1","tier":1,"high_ber_severity":"N/A","lid":14,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable"],"mtu":4096,"peer_port_dname":"3","severity":"Critical","active_speed":"EDR","enabled_speed": ["SDR","DDR","QDR","FDR10","FDR","EDR"],"supported_speed": ["SDR","DDR","QDR","FDR10","FDR","EDR"],"active_width":"4x","enabled_width": ["1x","4x"],"supported_width": ["1x","4x"],"dname":"HCA-1/1","peer_node_name":"r-dmz-ufm-sw49","peer":"a088c2030078231c_3","peer_node_guid":"a088c2030078231c","systemID":"ec0d9a03008cc956","node_description":"r-dmz-ufm128 HCA-1","label":"N/A","name":"ec0d9a03008cc956_1","module":"N/A","peer_lid":13,"peer_guid":"a088c2030078231c","peer_node_description":"r-dmz-ufm-sw49:3","guid":"ec0d9a03008cc956","system_name":"r-dmz-ufm128","system_ip":"0.0.0.0","peer_ip":"10.209.37.226","system_capabilities": ["mark_device_unhealthy"],"system_mirroring_template":false,"hw_technology":null}, {"description":"Computer IB Port","number":1,"external_number":1,"physical_state":"Link Up","path":"default(5) / Computer: r-dmz-ufm131 / HCA-1/1","tier":1,"high_ber_severity":"N/A","lid":1,"mirror":"disable","logical_state":"Active","capabilities": [],"mtu":4096,"peer_port_dname":"2","severity":"Critical","active_speed":"HDR","enabled_speed": ["SDR","DDR","QDR","FDR10","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR10","FDR","EDR","HDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"HCA-1/1","peer_node_name":"r-ufm-sw95","peer":"b8599f0300fc6de4_2","peer_node_guid":"b8599f0300fc6de4","systemID":"1070fd03000b22c4","node_description":"r-dmz-ufm131 mlx5_0","label":"N/A","name":"1070fd03000b22c4_1","module":"N/A","peer_lid":31,"peer_guid":"b8599f0300fc6de4","peer_node_description":"r-ufm-sw95:2","guid":"1070fd03000b22c4","system_name":"r-dmz-ufm131","system_ip":"0.0.0.0","peer_ip":"10.209.37.95","system_capabilities": [],"system_mirroring_template":false,"hw_technology":null}, {"description":"Switch IB Port","number":1,"external_number":1,"physical_state":"Link Up","path":"default(5) / Switch: r-dmz-ufm-sw49 / 1","tier":2,"high_ber_severity":"N/A","lid":13,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"3","severity":"Minor","active_speed":"EDR","enabled_speed": ["SDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","QDR","FDR","EDR","HDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"1","peer_node_name":"r-ufm-sw95","peer":"b8599f0300fc6de4_3","peer_node_guid":"b8599f0300fc6de4","systemID":"a088c2030078231c","node_description":"r-dmz-ufm-sw49:1","label":"N/A","name":"a088c2030078231c_1","module":"N/A","peer_lid":31,"peer_guid":"b8599f0300fc6de4","peer_node_description":"r-ufm-sw95:3","guid":"a088c2030078231c","system_name":"r-dmz-ufm-sw49","system_ip":"10.209.37.226","peer_ip":"10.209.37.95","system_capabilities": ["ssh","sysinfo","reboot","mark_device_unhealthy","collect_system_dump","burn_cables_transceivers","sw_upgrade","Provisioning"],"system_mirroring_template":false,"hw_technology":null} ]...Status Codes
200 – OK
Get Port/s by Name
Description – get specific port/s using their names
Request URL – GET /ufmRest/resources/ports/<port-name1>,<port-name2>,…
Request Content Type – Application/json
Response
[ {
"description":"Switch IB Port","number":40,"external_number":40,"physical_state":"Polling","path":"default(5) / Switch: r-ufm-sw95 / 40","tier":2,"high_ber_severity":"N/A","lid":31,"mirror":"disable","logical_state":"Down","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"N/A","severity":"Info","active_speed":null,"enabled_speed": [],"supported_speed": [],"active_width":null,"enabled_width": [],"supported_width": [],"dname":"40","peer_node_name":"N/A","peer":"N/A","peer_node_guid":"N/A","systemID":"b8599f0300fc6de4","node_description":"r-ufm-sw95:40","label":"N/A","name":"b8599f0300fc6de4_40","module":"N/A","peer_lid":"N/A","peer_guid":"N/A","peer_node_description":"N/A","guid":"b8599f0300fc6de4","system_name":"r-ufm-sw95","system_ip":"10.209.37.95","peer_ip":"N/A","system_capabilities": ["ssh","sysinfo","reboot","collect_system_dump","burn_cables_transceivers","sw_upgrade","Provisioning"],"system_mirroring_template":false,"hw_technology":null}, {"description":"Switch IB Port","number":36,"external_number":36,"physical_state":"Link Up","path":"default(5) / Switch: r-ufm-sw95 / 36","tier":4,"high_ber_severity":"N/A","lid":31,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"HCA-1/1","severity":"Minor","active_speed":"EDR","enabled_speed": ["SDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","QDR","FDR","EDR","HDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"36","peer_node_name":"r-dcs96","peer":"1070fd030071aa4e_1","peer_node_guid":"1070fd030071aa4e","systemID":"b8599f0300fc6de4","node_description":"r-ufm-sw95:36","label":"N/A","name":"b8599f0300fc6de4_36","module":"N/A","peer_lid":4660,"peer_guid":"1070fd030071aa4e","peer_node_description":"r-dcs96 HCA-3","guid":"b8599f0300fc6de4","system_name":"r-ufm-sw95","system_ip":"10.209.37.95","peer_ip":"0.0.0.0","system_capabilities": ["ssh","sysinfo","reboot","collect_system_dump","burn_cables_transceivers","sw_upgrade","Provisioning"],"system_mirroring_template":false,"hw_technology":null} ]Code Status
200 – OK
404 – NOT FOUND—port not found (by name)
Get All System Ports
Description – lists all ports of a specific system
Request URL – GET /ufmRest/resources/ports?system=<system-name>
Request Content Type – Application/json
Response
[ {
"description":"Switch IB Port","number":1,"external_number":1,"physical_state":"Polling","path":"default(5) / Switch: sw-ufm-ndr04 / 1/1/1","tier":3,"high_ber_severity":"N/A","lid":41,"mirror":"disable","logical_state":"Down","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"N/A","severity":"Info","active_speed":null,"enabled_speed": [],"supported_speed": [],"active_width":null,"enabled_width": [],"supported_width": [],"dname":"1/1/1","peer_node_name":"N/A","peer":"N/A","peer_node_guid":"N/A","systemID":"9c0591030085abc0","node_description":"sw-ufm-ndr04:1/1/1","label":"1/1/1","name":"9c0591030085abc0_1","module":"N/A","peer_lid":"N/A","peer_guid":"N/A","peer_node_description":"N/A","guid":"9c0591030085abc0","system_name":"sw-ufm-ndr04","system_ip":"10.209.226.229","peer_ip":"N/A","system_capabilities": ["burn_cables_transceivers","ssh","sysinfo","reboot","mark_device_unhealthy","collect_system_dump","burn_cables_transceivers","sw_upgrade","collect_system_dump","Provisioning"],"system_mirroring_template":false,"hw_technology":null}, {"description":"Switch IB Port","number":2,"external_number":2,"physical_state":"Polling","path":"default(5) / Switch: sw-ufm-ndr04 / 1/1/2","tier":3,"high_ber_severity":"N/A","lid":41,"mirror":"disable","logical_state":"Down","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"N/A","severity":"Info","active_speed":null,"enabled_speed": [],"supported_speed": [],"active_width":null,"enabled_width": [],"supported_width": [],"dname":"1/1/2","peer_node_name":"N/A","peer":"N/A","peer_node_guid":"N/A","systemID":"9c0591030085abc0","node_description":"sw-ufm-ndr04:1/1/2","label":"1/1/2","name":"9c0591030085abc0_2","module":"N/A","peer_lid":"N/A","peer_guid":"N/A","peer_node_description":"N/A","guid":"9c0591030085abc0","system_name":"sw-ufm-ndr04","system_ip":"10.209.226.229","peer_ip":"N/A","system_capabilities": ["burn_cables_transceivers","ssh","sysinfo","reboot","mark_device_unhealthy","collect_system_dump","burn_cables_transceivers","sw_upgrade","collect_system_dump","Provisioning"],"system_mirroring_template":false,"hw_technology":null}, {"description":"Switch IB Port","number":3,"external_number":3,"physical_state":"Link Up","path":"default(5) / Switch: sw-ufm-ndr04 / 1/2/1","tier":3,"high_ber_severity":"N/A","lid":41,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"1/2/2","severity":"Info","active_speed":"NDR","enabled_speed": ["SDR","FDR","EDR","HDR","NDR"],"supported_speed": ["SDR","FDR","EDR","HDR","NDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"1/2/1","peer_node_name":"sw-ufm-ndr03","peer":"900a840300ac8c40_4","peer_node_guid":"900a840300ac8c40","systemID":"9c0591030085abc0","node_description":"sw-ufm-ndr04:1/2/1","label":"1/2/1","name":"9c0591030085abc0_3","module":"N/A","peer_lid":34,"peer_guid":"900a840300ac8c40","peer_node_description":"sw-ufm-ndr03:1/2/2","guid":"9c0591030085abc0","system_name":"sw-ufm-ndr04","system_ip":"10.209.226.229","peer_ip":"10.209.226.152","system_capabilities": ["burn_cables_transceivers","ssh","sysinfo","reboot","mark_device_unhealthy","collect_system_dump","burn_cables_transceivers","sw_upgrade","collect_system_dump","Provisioning"],"system_mirroring_template":false,"hw_technology":null} .... ]Code Status
200 – OK
Get All Active Ports
Description – lists all active ports of a specific system, or for all systems
Request URL
GET /ufmRest/resources/ports?active=<'true'/'True'/'TRUE'/'t'/'T'>
or
GET /ufmRest/resources/ports?system=<system-name>&active=<'true'/'True'/'TRUE'/'t'/'T'>
Request Content Type – Application/json
Response
[ {
"description":"Computer IB Port","number":1,"external_number":1,"physical_state":"Link Up","path":"default(5) / Computer: r-dmz-ufm134 / HCA-1/1","tier":1,"high_ber_severity":"N/A","lid":120,"mirror":"disable","logical_state":"Active","capabilities": [],"mtu":4096,"peer_port_dname":"4","severity":"Info","active_speed":"HDR","enabled_speed": ["SDR","DDR","QDR","FDR10","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR10","FDR","EDR","HDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"HCA-1/1","peer_node_name":"r-ufm-sw95","peer":"b8599f0300fc6de4_4","peer_node_guid":"b8599f0300fc6de4","systemID":"1070fd03000b22f8","node_description":"r-dmz-ufm134 mlx5_0","label":"N/A","name":"1070fd03000b22f8_1","module":"N/A","peer_lid":31,"peer_guid":"b8599f0300fc6de4","peer_node_description":"r-ufm-sw95:4","guid":"1070fd03000b22f8","system_name":"r-dmz-ufm134","system_ip":"0.0.0.0","peer_ip":"10.209.37.95","system_capabilities": [],"system_mirroring_template":false,"hw_technology":null}, {"description":"Computer IB Port","number":1,"external_number":1,"physical_state":"Link Up","path":"default(5) / Computer: r-dmz-ufm131 / HCA-1/1","tier":1,"high_ber_severity":"N/A","lid":1,"mirror":"disable","logical_state":"Active","capabilities": [],"mtu":4096,"peer_port_dname":"2","severity":"Critical","active_speed":"HDR","enabled_speed": ["SDR","DDR","QDR","FDR10","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR10","FDR","EDR","HDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"HCA-1/1","peer_node_name":"r-ufm-sw95","peer":"b8599f0300fc6de4_2","peer_node_guid":"b8599f0300fc6de4","systemID":"1070fd03000b22c4","node_description":"r-dmz-ufm131 mlx5_0","label":"N/A","name":"1070fd03000b22c4_1","module":"N/A","peer_lid":31,"peer_guid":"b8599f0300fc6de4","peer_node_description":"r-ufm-sw95:2","guid":"1070fd03000b22c4","system_name":"r-dmz-ufm131","system_ip":"0.0.0.0","peer_ip":"10.209.37.95","system_capabilities": [],"system_mirroring_template":false,"hw_technology":null}, {"description":"Computer IB Port","number":1,"external_number":1,"physical_state":"Link Up","path":"default(5) / Computer: r-dmz-ufm137 / HCA-1/1","tier":1,"high_ber_severity":"N/A","lid":18,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable"],"mtu":4096,"peer_port_dname":"39","severity":"Critical","active_speed":"HDR","enabled_speed": ["SDR","DDR","QDR","FDR10","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR10","FDR","EDR","HDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"HCA-1/1","peer_node_name":"r-ufm-sw95","peer":"b8599f0300fc6de4_39","peer_node_guid":"b8599f0300fc6de4","systemID":"1070fd03000b22cc","node_description":"r-dmz-ufm137 HCA-1","label":"N/A","name":"1070fd03000b22cc_1","module":"N/A","peer_lid":31,"peer_guid":"b8599f0300fc6de4","peer_node_description":"r-ufm-sw95:39","guid":"1070fd03000b22cc","system_name":"r-dmz-ufm137","system_ip":"0.0.0.0","peer_ip":"10.209.37.95","system_capabilities": ["mark_device_unhealthy"],"system_mirroring_template":false,"hw_technology":null} ... ]Code Status
200 – OK
Get All External Ports
Description – lists all external ports of a specific system, or for all systems
Request URL – GET /ufmRest/resources/ports?external=<'true'/'True'/'TRUE'/'t'/'T'>
Request Content Type – Application/json
Response
[ {
"description":"Computer IB Port","number":1,"external_number":1,"physical_state":"Link Up","path":"default(5) / Computer: r-dcs96 / HCA-1/1","tier":1,"high_ber_severity":"N/A","lid":4660,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable"],"mtu":4096,"peer_port_dname":"36","severity":"Critical","active_speed":"EDR","enabled_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"HCA-1/1","peer_node_name":"r-ufm-sw95","peer":"b8599f0300fc6de4_36","peer_node_guid":"b8599f0300fc6de4","systemID":"1070fd030071aa4e","node_description":"r-dcs96 HCA-3","label":"N/A","name":"1070fd030071aa4e_1","module":"N/A","peer_lid":31,"peer_guid":"b8599f0300fc6de4","peer_node_description":"r-ufm-sw95:36","guid":"1070fd030071aa4e","system_name":"r-dcs96","system_ip":"0.0.0.0","peer_ip":"10.209.37.95","system_capabilities": ["mark_device_unhealthy"],"system_mirroring_template":false,"hw_technology":null}, {"description":"Computer IB Port","number":2,"external_number":2,"physical_state":"Link Up","path":"default(5) / Computer: r-dcs96 / HCA-1/2","tier":1,"high_ber_severity":"N/A","lid":24,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable"],"mtu":4096,"peer_port_dname":"19","severity":"Info","active_speed":"EDR","enabled_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"HCA-1/2","peer_node_name":"r-dmz-ufm-sw49","peer":"a088c2030078231c_19","peer_node_guid":"a088c2030078231c","systemID":"1070fd030071aa4e","node_description":"r-dcs96 HCA-4","label":"N/A","name":"1070fd030071aa4f_2","module":"N/A","peer_lid":13,"peer_guid":"a088c2030078231c","peer_node_description":"r-dmz-ufm-sw49:19","guid":"1070fd030071aa4f","system_name":"r-dcs96","system_ip":"0.0.0.0","peer_ip":"10.209.37.226","system_capabilities": ["mark_device_unhealthy"],"system_mirroring_template":false,"hw_technology":null}, ...Code Status
200 – OK
Get List of All High BER Ports
Description – lists all high BER ports
Request URL – GET /ufmRest/resources/ports?high_ber_only=true
Request Content Type – Application/json
Response
[ {
"description":"Switch IB Port","number":1,"external_number":1,"physical_state":"Link Up","path":"default(1) / Switch: mantaray177 / MCS8500 L10 10 / 1 / 1","tier":3,"high_ber_severity":"Critical","lid":42365,"mirror":"disable","logical_state":"Active","capabilities": ["healthy_operations","reset","disable","get_cables_info"],"mtu":2048,"peer_port_dname":"L10/U2/19","severity":"Info","active_speed":"HDR","enabled_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR","EDR","HDR","NDR"],"active_width":"4x","enabled_width": ["1x","4x"],"supported_width": ["1x","2x","4x","8x","12x"],"dname":"L10/U1/1","peer_node_name":"mantaray177","peer":"98039b0300a2b814_19","peer_node_guid":"b8599f0300065d16","systemID":"b8599f0300065d16","node_description":"mantaray177:L10/U1/1","name":"98039b0300a2b804_1","module":"N/A","peer_lid":42368,"peer_guid":"98039b0300a2b814","peer_node_description":"mantaray177:L10/U2/19","guid":"98039b0300a2b804","system_name":"mantaray177","system_ip":"0.0.0.0","peer_ip":"0.0.0.0","system_capabilities": ["burn_cables_transceivers"],"system_mirroring_template":false}, {"description":"Switch IB Port","number":3,"external_number":3,"physical_state":"Link Up","path":"default(1) / Switch: mantaray177 / MCS8500 L10 10 / 1 / 3","tier":3,"high_ber_severity":"Critical","lid":42365,"mirror":"disable","logical_state":"Active","capabilities": ["healthy_operations","reset","disable","get_cables_info"],"mtu":2048,"peer_port_dname":"L10/U2/17","severity":"Info","active_speed":"HDR","enabled_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR","EDR","HDR","NDR"],"active_width":"4x","enabled_width": ["1x","4x"],"supported_width": ["1x","2x","4x","8x","12x"],"dname":"L10/U1/3","peer_node_name":"mantaray177","peer":"98039b0300a2b814_17","peer_node_guid":"b8599f0300065d16","systemID":"b8599f0300065d16","node_description":"mantaray177:L10/U1/3","name":"98039b0300a2b804_3","module":"N/A","peer_lid":42368,"peer_guid":"98039b0300a2b814","peer_node_description":"mantaray177:L10/U2/17","guid":"98039b0300a2b804","system_name":"mantaray177","system_ip":"0.0.0.0","peer_ip":"0.0.0.0","system_capabilities": ["burn_cables_transceivers"],"system_mirroring_template":false}, {"description":"Switch IB Port","number":4,"external_number":4,"physical_state":"Link Up","path":"default(1) / Switch: mantaray177 / MCS8500 L10 10 / 1 / 4","tier":3,"high_ber_severity":"Critical","lid":42365,"mirror":"disable","logical_state":"Active","capabilities": ["healthy_operations","reset","disable","get_cables_info"],"mtu":2048,"peer_port_dname":"L10/U2/18","severity":"Info","active_speed":"HDR","enabled_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR","EDR","HDR","NDR"],"active_width":"4x","enabled_width": ["1x","4x"],"supported_width": ["1x","2x","4x","8x","12x"],"dname":"L10/U1/4","peer_node_name":"mantaray177","peer":"98039b0300a2b814_18","peer_node_guid":"b8599f0300065d16","systemID":"b8599f0300065d16","node_description":"mantaray177:L10/U1/4","name":"98039b0300a2b804_4","module":"N/A","peer_lid":42368,"peer_guid":"98039b0300a2b814","peer_node_description":"mantaray177:L10/U2/18","guid":"98039b0300a2b804","system_name":"mantaray177","system_ip":"0.0.0.0","peer_ip":"0.0.0.0","system_capabilities": ["burn_cables_transceivers"],"system_mirroring_template":false}.... ]
Get List of High BER Ports with Specific Severity
Description – lists high BER ports based on severity (warning or error)
Request URL – GET /ufmRest/resources/ports?high_ber_only=true&high_ber_severity=error
Request Content Type – Application/json
Response
[ {
"description":"Switch IB Port","number":1,"external_number":1,"physical_state":"Link Up","path":"default(1) / Switch: mantaray177 / MCS8500 L10 10 / 1 / 1","tier":3,"high_ber_severity":"Critical","lid":42365,"mirror":"disable","logical_state":"Active","capabilities": ["healthy_operations","reset","disable","get_cables_info"],"mtu":2048,"peer_port_dname":"L10/U2/19","severity":"Info","active_speed":"HDR","enabled_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR","EDR","HDR","NDR"],"active_width":"4x","enabled_width": ["1x","4x"],"supported_width": ["1x","2x","4x","8x","12x"],"dname":"L10/U1/1","peer_node_name":"mantaray177","peer":"98039b0300a2b814_19","peer_node_guid":"b8599f0300065d16","systemID":"b8599f0300065d16","node_description":"mantaray177:L10/U1/1","name":"98039b0300a2b804_1","module":"N/A","peer_lid":42368,"peer_guid":"98039b0300a2b814","peer_node_description":"mantaray177:L10/U2/19","guid":"98039b0300a2b804","system_name":"mantaray177","system_ip":"0.0.0.0","peer_ip":"0.0.0.0","system_capabilities": ["burn_cables_transceivers"],"system_mirroring_template":false}, {"description":"Switch IB Port","number":3,"external_number":3,"physical_state":"Link Up","path":"default(1) / Switch: mantaray177 / MCS8500 L10 10 / 1 / 3","tier":3,"high_ber_severity":"Critical","lid":42365,"mirror":"disable","logical_state":"Active","capabilities": ["healthy_operations","reset","disable","get_cables_info"],"mtu":2048,"peer_port_dname":"L10/U2/17","severity":"Info","active_speed":"HDR","enabled_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR","EDR","HDR","NDR"],"active_width":"4x","enabled_width": ["1x","4x"],"supported_width": ["1x","2x","4x","8x","12x"],"dname":"L10/U1/3","peer_node_name":"mantaray177","peer":"98039b0300a2b814_17","peer_node_guid":"b8599f0300065d16","systemID":"b8599f0300065d16","node_description":"mantaray177:L10/U1/3","name":"98039b0300a2b804_3","module":"N/A","peer_lid":42368,"peer_guid":"98039b0300a2b814","peer_node_description":"mantaray177:L10/U2/17","guid":"98039b0300a2b804","system_name":"mantaray177","system_ip":"0.0.0.0","peer_ip":"0.0.0.0","system_capabilities": ["burn_cables_transceivers"],"system_mirroring_template":false}, {"description":"Switch IB Port","number":4,"external_number":4,"physical_state":"Link Up","path":"default(1) / Switch: mantaray177 / MCS8500 L10 10 / 1 / 4","tier":3,"high_ber_severity":"Critical","lid":42365,"mirror":"disable","logical_state":"Active","capabilities": ["healthy_operations","reset","disable","get_cables_info"],"mtu":2048,"peer_port_dname":"L10/U2/18","severity":"Info","active_speed":"HDR","enabled_speed": ["SDR","DDR","QDR","FDR","EDR","HDR"],"supported_speed": ["SDR","DDR","QDR","FDR","EDR","HDR","NDR"],"active_width":"4x","enabled_width": ["1x","4x"],"supported_width": ["1x","2x","4x","8x","12x"],"dname":"L10/U1/4","peer_node_name":"mantaray177","peer":"98039b0300a2b814_18","peer_node_guid":"b8599f0300065d16","systemID":"b8599f0300065d16","node_description":"mantaray177:L10/U1/4","name":"98039b0300a2b804_4","module":"N/A","peer_lid":42368,"peer_guid":"98039b0300a2b814","peer_node_description":"mantaray177:L10/U2/18","guid":"98039b0300a2b804","system_name":"mantaray177","system_ip":"0.0.0.0","peer_ip":"0.0.0.0","system_capabilities": ["burn_cables_transceivers"],"system_mirroring_template":false} ]
Description – Gets ports with cable Information.
Request URL – GET / ufmRest/resources/ports?cable_info=true
Parameters -
cable_info (optional): Set this flag to true to include cable information in the response.Response
[ {
"description":"Switch IB Port","number":2,"external_number":2,"physical_state":"Link Up","path":"default(5) / Switch: sw-ufm-ndr03 / 1/1/2","tier":3,"high_ber_severity":"N/A","lid":34,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"8","severity":"Info","active_speed":"HDR","enabled_speed": ["SDR","FDR","EDR","HDR","NDR"],"supported_speed": ["SDR","FDR","EDR","HDR","NDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"1/1/2","peer_node_name":"r-ufm-sw95","peer":"b8599f0300fc6de4_8","peer_node_guid":"b8599f0300fc6de4","systemID":"900a840300ac8c40","node_description":"sw-ufm-ndr03:1/1/2","label":"1/1/2","name":"900a840300ac8c40_2","module":"N/A","peer_lid":31,"peer_guid":"b8599f0300fc6de4","peer_node_description":"r-ufm-sw95:8","guid":"900a840300ac8c40","system_name":"sw-ufm-ndr03","system_ip":"10.209.226.152","peer_ip":"10.209.37.95","system_capabilities": ["burn_cables_transceivers","ssh","sysinfo","reboot","mark_device_unhealthy","collect_system_dump","burn_cables_transceivers","sw_upgrade","collect_system_dump","Provisioning"],"system_mirroring_template":false,"hw_technology":null,"cable_info": {"technology":"Copper cable- unequalized","fw_version":"N/A","serial_number":"MT2137VS00400","part_number":"MCP7Y60-H01A","length":"1.5 m","revision":"A2","temperature":"0C","identifier":"OSFP"} }, {"description":"Switch IB Port","number":3,"external_number":3,"physical_state":"Link Up","path":"default(5) / Switch: sw-ufm-ndr03 / 1/2/1","tier":3,"high_ber_severity":"N/A","lid":34,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"1/2/2","severity":"Info","active_speed":"NDR","enabled_speed": ["SDR","FDR","EDR","HDR","NDR"],"supported_speed": ["SDR","FDR","EDR","HDR","NDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"1/2/1","peer_node_name":"sw-ufm-ndr04","peer":"9c0591030085abc0_4","peer_node_guid":"9c0591030085abc0","systemID":"900a840300ac8c40","node_description":"sw-ufm-ndr03:1/2/1","label":"1/2/1","name":"900a840300ac8c40_3","module":"N/A","peer_lid":41,"peer_guid":"9c0591030085abc0","peer_node_description":"sw-ufm-ndr04:1/2/2","guid":"900a840300ac8c40","system_name":"sw-ufm-ndr03","system_ip":"10.209.226.152","peer_ip":"10.209.226.229","system_capabilities": ["burn_cables_transceivers","ssh","sysinfo","reboot","mark_device_unhealthy","collect_system_dump","burn_cables_transceivers","sw_upgrade","collect_system_dump","Provisioning"],"system_mirroring_template":false,"hw_technology":null,"cable_info": {"technology":"1310 nm EML","fw_version":"79.252.0","serial_number":"MT2324NS02371","part_number":"MMS4X00-NS","length":"19.4 m","revision":"B1","temperature":"53C","identifier":"OSFP"} }, {"description":"Switch IB Port","number":4,"external_number":4,"physical_state":"Link Up","path":"default(5) / Switch: sw-ufm-ndr03 / 1/2/2","tier":3,"high_ber_severity":"N/A","lid":34,"mirror":"disable","logical_state":"Active","capabilities": ["reset","healthy_operations","disable","get_cables_info"],"mtu":4096,"peer_port_dname":"1/2/1","severity":"Info","active_speed":"NDR","enabled_speed": ["SDR","FDR","EDR","HDR","NDR"],"supported_speed": ["SDR","FDR","EDR","HDR","NDR"],"active_width":"4x","enabled_width": ["1x","2x","4x"],"supported_width": ["1x","2x","4x"],"dname":"1/2/2","peer_node_name":"sw-ufm-ndr04","peer":"9c0591030085abc0_3","peer_node_guid":"9c0591030085abc0","systemID":"900a840300ac8c40","node_description":"sw-ufm-ndr03:1/2/2","label":"1/2/2","name":"900a840300ac8c40_4","module":"N/A","peer_lid":41,"peer_guid":"9c0591030085abc0","peer_node_description":"sw-ufm-ndr04:1/2/1","guid":"900a840300ac8c40","system_name":"sw-ufm-ndr03","system_ip":"10.209.226.152","peer_ip":"10.209.226.229","system_capabilities": ["burn_cables_transceivers","ssh","sysinfo","reboot","mark_device_unhealthy","collect_system_dump","burn_cables_transceivers","sw_upgrade","collect_system_dump","Provisioning"],"system_mirroring_template":false,"hw_technology":null,"cable_info": {"technology":"1310 nm EML","fw_version":"79.252.0","serial_number":"MT2324NS02371","part_number":"MMS4X00-NS","length":"6.6 m","revision":"B1","temperature":"53C","identifier":"OSFP"} } ]Status Codes:
200-OK