Inventory service data

Information about the virtual switches can be optionally included in the inventory data provided by the Inventory Service.

Inventory entries for the Virtual Switch objects are included in the response to the Inventory Service's Get Inventory operation when the request specifies (explicitly by inventory class, implicitly through a containing category, or by default) that objects of the class "virtual-switch" to be included. An entry for a particular virtual switch is included only if the API user has access permission to that object as described in the Get Virtual Switch Properties operation.

For each Virtual Switch object to be included, the inventory response array includes an entry that is a JSON object with the same contents as is specified in the response body contents section for Get Virtual Switch Properties. That is, the data provided is the same as would be provided if a Get Virtual Switch Properties operation were requested targeting this object.

Sample inventory data

The following fragment is an example of the JSON object that would be included in the Get Inventory response to describe a single virtual switch. This object would appear as one array entry in the response array:

Figure 1. Virtual Switch object: Sample inventory data - Response
{
  "backing-adapter-uri":"/api/adapters/df863694-08b1-11e6-91a3-42f2e90df693",
  "class":"virtual-switch",
  "description":"",
  "name":"5F1.P0.OSD",
  "object-id":"dff0b71c-d491-11e4-a555-020000003058",
  "object-uri":"/api/virtual-switches/dff0b71c-d491-11e4-a555-020000003058",
  "parent":"/api/cpcs/8e543aa6-1c26-3544-8197-4400110ef5ef",  
  "port":0,
  "type":"osd"  
}