NVIDIA UFM Enterprise REST API Guide

Forge InfiniBand Anti-Spoofing REST API

Create Physical-Virtual GUID Mapping

  • Description: Creates a physical-virtual GUID mapping by sending the physical and virtual GUID list. 

  • Request URL: POST /ufmRest/app/smconf/physical_virtual_mapping 

  • Request Content Type – Application/json 

  • Request Data: 

    { 
       "physical-port-guid": ["PHYS_PORT_GUID_A", "PHYS_PORT_GUID_B"], 
       "virtual-port-guid": ["VIRT_PORT_GUID_A", "VIRT_PORT_GUID_B"] 
    } 
    
  • If either the physical-port-guid or virtual-port-guid were not sent, the default value is an empty list.

  • Response: Integer <id> associated with this map group.

    Status 

    Description 

    200 

    OK 

    400 

    BAD_REQUEST (bad or missing parameters) 

Get All Physical-Virtual GUID Mapping

  • Description: Gets all created physical-virtual GUID mapping. 

  • Request URL: GET /ufmRest/app/smconf/physical_virtual_mapping 

  • Request Data: N/A 

  • Response Content Type – Application/json 

  • Response: 

{ 
   "1": { 
      "physical-port-guid": ["PHYS_PORT_GUID_A", "PHYS_PORT_GUID_B"], 
      "virtual-port-guid": ["VIRT_PORT_GUID_A", "VIRT_PORT_GUID_B"] 
   } 
} 
  • Status Code:

Status 

Description 

200 

OK 

400 

BAD_REQUEST 

Get Specific Physical-Virtual GUID Mapping

  • Description: Gets a specific physical-virtual GUID mapping. 

  • Request URL: GET /ufmRest/app/smconf/physical_virtual_mapping/<mapping_id> 

  • Request Data: N/A 

  • Response Content Type – Application/json 

  • Response: 

    { 
    "physical-port-guid": ["PHYS_PORT_GUID_A", "PHYS_PORT_GUID_B"], 
    "virtual-port-guid": ["VIRT_PORT_GUID_A", "VIRT_PORT_GUID_B"] 
    } 
    

    Status 

    Description 

    200 

    OK 

    400 

    BAD_REQUEST 

    404 

    NOT_FOUND 

Update Physical-Virtual GUID Mapping

  • Description: Replaces map GUID with a new GUID mapping for a specific group ID. 

  • Request URL: PUT /ufmRest/app/smconf/physical_virtual_mapping/<mapping_id> 

  • Response Content Type – Application/json 

  • Request Data:  

{ 
"physical-port-guid": ["PHYS_PORT_GUID_A", "PHYS_PORT_GUID_B"], 
"virtual-port-guid": ["VIRT_PORT_GUID_A", "VIRT_PORT_GUID_B"] 
} 
  • Status Code:

    Status 

    Description 

    200 

    OK 

    400 

    BAD_REQUEST 

Add New Physical-Virtual GUID Mapping to an Existing Group

  • Description: Adds a new physical-virtual GUID to an existing group ID. 

  • Request URL: PUT /ufmRest/app/smconf/physical_virtual_mapping /<mapping_id>/add 

  • Response Content Type – Application/json 

  • Request Data:  

{ 
"physical-port-guid": ["PHYS_PORT_GUID_A", "PHYS_PORT_GUID_B"], 
"virtual-port-guid": ["VIRT_PORT_GUID_A", "VIRT_PORT_GUID_B"] 
} 
  • Status Code:

    Status 

    Description 

    200 

    OK 

    400 

    BAD_REQUEST 

Delete Physical-Virtual GUID Mapping

  • Description: Deletes a group ID mapping. 

  • Request URL: DELETE /ufmRest/app/smconf/physical_virtual_mapping/<mapping_id> 

  • Response Content Type – Application/json 

  • Status Code:

    Status 

    Description 

    200 

    OK 

    400 

    BAD_REQUEST 

    404 

    NOT_FOUND 

     

Last updated: