Virtualization REST API
Description – get all virtual ports in the fabric
Request URL – GET /ufmRest/resources/vports
Request Content Type – Application/json
Request Data
[ { "virtual_port_state": "Active", "virtual_port_lid": 3434, "system_ip": "11.4.3.175", "system_name": "r-ufm77", "node_description": "r-ufm77 mlx5_0", "system_guid": "248a0703008a850a", "port_guid": "248a0703008a850a", "port_name": "248a0703008a850a_1", "physical_port_number": 1, "virtual_port_guid": "0002c90000000017" }, { "virtual_port_state": "Active", "virtual_port_lid": 3435, "system_ip": "11.4.3.175", "system_name": "r-ufm77", "node_description": "r-ufm77 mlx5_0", "system_guid": "248a0703008a850a", "port_guid": "248a0703008a850a", "port_name": "248a0703008a850a_1", "physical_port_number": 1, "virtual_port_guid": "0002c90000000018" }, { "virtual_port_state": "Active", "virtual_port_lid": 3435, "system_ip": "11.4.3.175", "system_name": "r-ufm77", "node_description": "r-ufm77 mlx5_1", "system_guid": "248a0703008a850a", "port_guid": "248a0703008a850b", "port_name": "248a0703008a850b_2", "physical_port_number": 2, "virtual_port_guid": "0002c90000000019" }, { "virtual_port_state": "Active", "virtual_port_lid": 3436, "system_ip": "0.0.0.0", "system_name": "r-ufm51", "node_description": "r-ufm51 HCA-1", "system_guid": "f452140300383a00", "port_guid": "f452140300383a01", "port_name": "f452140300383a01_1", "physical_port_number": 1, "virtual_port_guid": "0002c9000000001c" }, { "virtual_port_state": "Active", "virtual_port_lid": 3437, "system_ip": "0.0.0.0", "system_name": "r-ufm51", "node_description": "r-ufm51 HCA-1", "system_guid": "f452140300383a00", "port_guid": "f452140300383a02", "port_name": "f452140300383a02_2", "physical_port_number": 2, "virtual_port_guid": "0002c9000000001f" } ]
Status codes
200 – OK
400 – BAD_REQUEST
Description – get the list of all virtual ports for a specific system
Request URL – GET /ufmRest/resources/vports?system=<system_guid>
Request Content Type – Application/json
Request Data
[ { "virtual_port_state": "Active", "virtual_port_lid": 3434, "system_ip": "11.4.3.175", "system_name": "r-ufm77", "node_description": "r-ufm77 mlx5_0", "system_guid": "248a0703008a850a", "port_guid": "248a0703008a850a", "port_name": "248a0703008a850a_1", "physical_port_number": 1, "virtual_port_guid": "0002c90000000017" }, { "virtual_port_state": "Active", "virtual_port_lid": 3435, "system_ip": "11.4.3.175", "system_name": "r-ufm77", "node_description": "r-ufm77 mlx5_0", "system_guid": "248a0703008a850a", "port_guid": "248a0703008a850a", "port_name": "248a0703008a850a_1", "physical_port_number": 1, "virtual_port_guid": "0002c90000000018" }, { "virtual_port_state": "Active", "virtual_port_lid": 3435, "system_ip": "11.4.3.175", "system_name": "r-ufm77", "node_description": "r-ufm77 mlx5_1", "system_guid": "248a0703008a850a", "port_guid": "248a0703008a850b", "port_name": "248a0703008a850b_2", "physical_port_number": 2, "virtual_port_guid": "0002c90000000019" } ]
Status codes
200 – OK
400 – BAD_REQUEST
404 – NOT_FOUND
Description – get the list of virtual ports for specific physical port
Request URL – GET /ufmRest/resources/vports?port=<port_name>
Request Content Type – Application/json
Request Data
[ { "virtual_port_state": "Active", "virtual_port_lid": 3434, "system_ip": "11.4.3.175", "system_name": "r-ufm77", "node_description": "r-ufm77 mlx5_0", "system_guid": "248a0703008a850a", "port_guid": "248a0703008a850a", "port_name": "248a0703008a850a_1", "physical_port_number": 1, "virtual_port_guid": "0002c90000000017" }, { "virtual_port_state": "Active", "virtual_port_lid": 3435, "system_ip": "11.4.3.175", "system_name": "r-ufm77", "node_description": "r-ufm77 mlx5_0", "system_guid": "248a0703008a850a", "port_guid": "248a0703008a850a", "port_name": "248a0703008a850a_1", "physical_port_number": 1, "virtual_port_guid": "0002c90000000018" }, { "virtual_port_state": "Active", "virtual_port_lid": 3435, "system_ip": "11.4.3.175", "system_name": "r-ufm77", "node_description": "r-ufm77 mlx5_1", "system_guid": "248a0703008a850a", "port_guid": "248a0703008a850b", "port_name": "248a0703008a850b_2", "physical_port_number": 2, "virtual_port_guid": "0002c90000000019" } ]
Status codes
200 – OK
400 – BAD_REQUEST
404 – NOT_FOUND