discovery.vSphereGetPropertyTable

discovery.vSphereGetPropertyTable(target, vsphere_type, vsphere_id, table, [column, column, ...] )

Queries to retrieve a table of values from a given MOR and is intended to be used to retrieve nested properties from lists and arrays. The query returns multiple NodeState objects, one for each DataObject in the list or array.The required parameters are:

  • target - the ESX/ESXi node if discovering using vSphere or via vCenter, or the vCenter node if discovering information about the vCenter server.
  • vsphere_type - a vSphere managed object name specified in the VMware documentation. For example, Folder, Datacenter, ComputeResource, ResourcePool, or HostSystem.

  • vsphere_id - MOR (managed object reference). The type and id together uniquely identify a managed object in the system we are communicating with.

  • table - name of table property on managed object.

  • column - list of properties to retrieve from each entry in the table. It must not be the composite column name. For example, key or deviceName is a valid column. However, capacity.block is not a valid column.

This code example shows retrieving multipathing or LUN data properties from a storage device:

discovery.vSphereGetPropertyTable(host, "HostSystem", host_id, "config.storageDevice.scsiLun", ["serialNumber", "deviceName"])
Was this page helpful? Yes No Submitting... Thank you

Comments