Physical-Virtual GUID Mapping 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"],
     "properties": {
  	"tenant_vport_lids": true,
      "max_tenant_mc_groups": 5
      }
  } 
  

  
  

• 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":["0x0002c90000000005"],
        "virtual-port-guid":["0x0002c90000000066","0x0002c90000000067"],
        "properties": {
        "tenant_vport_lids": true,
        "max_tenant_mc_groups": 5
        }
	},
	"2":{
        "physical-port-guid":["0x0002c90000000005"],
        "virtual-port-guid":["0x0002c90000000066","0x0002c90000000067"]
        }
	} 

• Status Code:

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"],
  "properties": {
  "tenant_vport_lids": true,
  "max_tenant_mc_groups": 5
  	}
  } 
  

  
  

  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"],
"properties": {
        "tenant_vport_lids": true,
        "max_tenant_mc_groups": 5
        }
} 

• 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: July 28, 2024