Inventory

PCI Device Inventory


Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		2.1
name	The name. For more information, see Resource Property.		2.1
description	The description. For more information, see Resource Property.	Yes	2.1
hostUuid	The host UUID.		2.1
parentUuid	The physical PCI device UUID.		3.5.0
vmInstanceUuid	The VM instance UUID.		2.1
pciSpecUuid	The PCI device specification UUID.		3.5.0
vendorId	The vendor ID.		2.1
deviceId	The device ID.		2.1
subvendorId	The sub-vendor ID.		2.1
subdeviceId	The sub-device ID.		2.1
pciDeviceAddress	The PCI device address.		2.1
type	The type.		2.1
state			2.1
status	The status.		2.1
virtStatus			3.5.0
metaData			2.1
matchedPciDeviceOfferingRef			2.1
mdevSpecRefs			3.5.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	2.1
createDate	The creation date. For more information, see Resource Property.		2.1
lastOpDate	The last operation date. For more information, see Resource Property.		2.1
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.1
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.1

PCI Device Offering Inventory


Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		2.1
name	The name. For more information, see Resource Property.		2.1
description	The description. For more information, see Resource Property.	Yes	2.1
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	2.1
createDate	The creation date. For more information, see Resource Property.		2.1
lastOpDate	The last operation date. For more information, see Resource Property.		2.1
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.1
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.1

PCI Device and PCI Device Offering Reference Inventory


Name	Description	Optional	Starting Version
uuid	The UUID. For more information, see Resource Property.		2.1
description	The description. For more information, see Resource Property.	Yes	2.1
hostUuid	The host UUID.		2.1
vmInstanceUuid	The VM instance UUID.		2.1
vendorId			2.1
deviceId			2.1
subvendorId			2.1
subdeviceId			2.1
pciDeviceAddress	The PCI device address.		2.1
status			2.1
state			2.1
type	The type.		2.1
metaData			2.1
matchedPciDeviceOfferingRef			2.1
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	2.1
createDate	The creation date. For more information, see Resource Property.		2.1
lastOpDate	The last operation date. For more information, see Resource Property.		2.1
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.1
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.1

PCI Device Specification Inventory


Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			3.5.0
name	The name. For more information, see Resource Property.			3.5.0
description	The description. For more information, see Resource Property.	Yes		3.5.0
vendorId	The vendor ID.			3.5.0
deviceId	The device ID.			3.5.0
subvendorId	The sub-vendor ID.			3.5.0
subdeviceId	The sub-device ID.			3.5.0
ramSize	The RAM size.			3.5.0
maxPartNum	The maximum number of virtual functions.			3.5.0
isVirtual	Whether the device is a virtual device.			3.5.0
romVersion	The ROM version.			3.5.0
romMd5sum	The ROM MD5 checksum.			3.5.0
type	The type.		GPU_Video_Controller GPU_Audio_Controller GPU_3D_Controller Moxa_Device Generic	3.5.0
state	The state.		Enabled Disabled	3.5.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes		3.5.0
createDate	The creation date. For more information, see Resource Property.			3.5.0
lastOpDate	The last operation date. For more information, see Resource Property.			3.5.0
userTags	The user tags. For more information, see CreateUserTag.	Yes		3.5.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		3.5.0

Sample

{
  "inventories": [
    {
      "uuid": "4e583459b0bb4a8085f2acf4040ab802",
      "name": "MSI_GTX1060",
      "description": "NVIDIA Corporation, GP106 [GeForce GTX 1060 6GB], a1, VGA compatible controller",
      "vendorId": "10de",
      "deviceId": "1c03",
      "subvendorId": "1462",
      "subdeviceId": "3283",
      "type": "GPU_Video_Controller",
      "state": "Enabled",
      "romVersion": "86.06.0E.00.28",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

VM Instance and PCI Device Specification Reference Inventory


Name	Description	Optional	Starting Version
vmInstanceUuid	The VM instance UUID.		3.5.0
pciSpecUuid	The PCI device specification UUID.		3.5.0
pciDeviceNumber	The number of PCI devices to be attached to the VM instance. Note that these devices must conform to the PCI device specification. Default value: 1.		3.5.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.5.0
createDate	The creation date. For more information, see Resource Property.		3.5.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.5.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.5.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.5.0

Sample

{
  "inventories": [
    {
      "vmInstanceUuid": "c40d04f99f7647f2bf145aa6e3d463ff",
      "pciSpecUuid": "9afda707d3b14838adaa48d4295f3d5f",
      "pciDeviceNumber": 1.0,
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

MDEV Device Specification Inventory


Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			3.5.0
name	The name. For more information, see Resource Property.			3.5.0
description	The description. For more information, see Resource Property.	Yes		3.5.0
specification	The specification details.			3.5.0
type	The type.		GPU_Video_Controller	3.5.0
state	The state.		Enabled Disabled	3.5.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes		3.5.0
createDate	The creation date. For more information, see Resource Property.			3.5.0
lastOpDate	The last operation date. For more information, see Resource Property.			3.5.0
userTags	The user tags. For more information, see CreateUserTag.	Yes		3.5.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		3.5.0

Sample

{
  "inventories": [
    {
      "uuid": "18ebda01fb874e7db54ccd3a6712e92d",
      "name": "GRID_M60-2A",
      "specification": "{Max Resolution\u003d1920*1080, GRID License\u003dGRID-Virtual-Apps,3.0, Instance Number\u003d4, Display Heads\u003d4, Vendor\u003dNVIDIA, Frame Rate Limit\u003d60FPS, Name\u003dGRID_M60-2A, RAM\u003d2048MB}",
      "type": "GPU_Video_Controller",
      "state": "Enabled",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

MDEV Device Inventory


Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			3.5.0
name	The name. For more information, see Resource Property.			3.5.0
description	The description. For more information, see Resource Property.	Yes		3.5.0
parentUuid	The physical PCI device UUID.			3.5.0
hostUuid	The host UUID.			3.5.0
vmInstanceUuid	The VM instance UUID.			3.5.0
mdevSpecUuid	The UUID of the MDEV device specification.			3.5.0
type	The type.		GPU_Video_Controller	3.5.0
state	The state.		Enabled Disabled	3.5.0
status			Active Attached	3.5.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes		3.5.0
createDate	The creation date. For more information, see Resource Property.			3.5.0
lastOpDate	The last operation date. For more information, see Resource Property.			3.5.0
userTags	The user tags. For more information, see CreateUserTag.	Yes		3.5.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		3.5.0

Sample

{
  "inventories": [
    {
      "uuid": "597624b580d1458f82671b0ef77cf6a4",
      "name": "GRID M60-2A",
      "parentUuid": "90c171f07b21452b87b6d5ee58f4d687",
      "hostUuid": "b440c9393fc644cc8394d789ea1e18e1",
      "mdevSpecUuid": "91b07312092741f18a382942a92f1373",
      "type": "GPU_Video_Controller",
      "state": "Enabled",
      "status": "Active",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

VM Instance and MDEV Device Specification Reference Inventory


Name	Description	Optional	Starting Version
vmInstanceUuid	The VM instance UUID.		3.5.0
mdevSpecUuid	The UUID of the MDEV device specification.		3.5.0
mdevDeviceNumber	The number of MDEV devices to be attached to the VM instance. Note that these devices must conform to the MDEV device specification. Default value: 1.		3.5.0
groupBy	Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type.	Yes	3.5.0
createDate	The creation date. For more information, see Resource Property.		3.5.0
lastOpDate	The last operation date. For more information, see Resource Property.		3.5.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.5.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.5.0

Sample

{
  "inventories": [
    {
      "vmInstanceUuid": "56bfe280b3c84fe2abf1281a7050aabe",
      "mdevSpecUuid": "461d734e25824e4e9516c4798fa27068",
      "mdevDeviceNumber": 1.0,
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}