name: inventory-vsphere
description: vSphere inventory field reference and TSL query examples. Use when querying VMware vSphere provider inventory (VMs, networks, datastores, hosts, clusters, folders).
vSphere Inventory Reference
Field names and query examples for VMware vSphere providers. Replace <PROVIDER> and <NS> with actual values.
VM Fields
Identity and State
| Field |
Type |
Example |
name |
string |
"my-vm" |
id |
string |
"vm-147" |
uuid |
string |
"423ed598-..." |
path |
string |
"/Datacenter/vm/my-vm" |
parent.id |
string |
"group-v4" |
parent.kind |
string |
"Folder" |
powerState |
string |
"poweredOn", "poweredOff" |
connectionState |
string |
"connected" |
Compute
| Field |
Type |
Example |
cpuCount |
number |
2 |
coresPerSocket |
number |
2 |
memoryMB |
number |
4096 |
balloonedMemory |
number |
0 |
cpuHotAddEnabled |
bool |
false |
cpuHotRemoveEnabled |
bool |
false |
memoryHotAddEnabled |
bool |
false |
Guest and Firmware
| Field |
Type |
Example |
guestId |
string |
"rhel8_64Guest" |
guestName |
string |
"Red Hat Enterprise Linux 8 (64-bit)" |
firmware |
string |
"efi", "bios" |
isTemplate |
bool |
false |
ipAddress |
string |
"10.0.0.5" |
hostName |
string |
"myhost.example.com" |
host |
string |
"host-10" |
Storage and Security
| Field |
Type |
Example |
storageUsed |
number |
15762181155 (bytes) |
diskEnableUuid |
bool |
true |
secureBoot |
bool |
true |
tpmEnabled |
bool |
false |
changeTrackingEnabled |
bool |
true |
VMware Tools and Snapshot
| Field |
Type |
Example |
toolsRunningStatus |
string |
"guestToolsRunning", "guestToolsNotRunning" |
toolsStatus |
string |
"toolsOk", "toolsNotRunning" |
toolsVersionStatus2 |
string |
"guestToolsCurrent", "guestToolsUnmanaged" |
snapshot.id |
string |
"", "snapshot-2355" |
snapshot.kind |
string |
"", "VirtualMachineSnapshot" |
faultToleranceEnabled |
bool |
false |
Concerns
| Field |
Type |
Example |
concerns[*].category |
string |
"Critical", "Warning", "Information" |
concerns[*].label |
string |
"VM snapshot detected" |
concerns[*].assessment |
string |
description text |
concerns[*].id |
string |
"vmware.snapshot.detected" |
Disks (disks[*])
| Field |
Type |
Example |
disks[*].key |
number |
2000 |
disks[*].file |
string |
"[datastore] vm/vm.vmdk" |
disks[*].datastore.id |
string |
"datastore-16" |
disks[*].datastore.kind |
string |
"Datastore" |
disks[*].capacity |
number |
17179869184 (bytes) |
disks[*].shared |
bool |
false |
disks[*].rdm |
bool |
false |
disks[*].bus |
string |
"scsi", "nvme" |
disks[*].mode |
string |
"persistent" |
disks[*].serial |
string |
"6000C29d-..." |
disks[*].controllerKey |
number |
1000 |
disks[*].unitNumber |
number |
0 |
disks[*].parent |
string |
"" or base disk path |
disks[*].changeTrackingEnabled |
bool |
true |
NICs (nics[*])
| Field |
Type |
Example |
nics[*].network.id |
string |
"network-20" |
nics[*].network.kind |
string |
"Network" |
nics[*].mac |
string |
"00:50:56:be:9c:85" |
nics[*].order |
number |
0 |
nics[*].deviceKey |
number |
4000 |
Devices
| Field |
Type |
Example |
devices[*].kind |
string |
"VirtualE1000e", "VirtualVmxnet3" |
Network Fields
| Field |
Type |
Example |
name |
string |
"VM Network" |
id |
string |
"network-21" |
path |
string |
"/Datacenter/network/VM Network" |
variant |
string |
"Standard" |
vlanId |
string |
"" |
Datastore Fields
| Field |
Type |
Example |
name |
string |
"datastore1" |
id |
string |
"datastore-14" |
path |
string |
"/Datacenter/datastore/datastore1" |
type |
string |
"VMFS", "NFS", "NFS41" |
capacity |
number |
101737037824 (bytes) |
free |
number |
2010120192 (bytes) |
maintenance |
string |
"normal", "inMaintenance" |
Host Fields
| Field |
Type |
Example |
name |
string |
"10.6.46.28" |
id |
string |
"host-10" |
path |
string |
"/Datacenter/host/..." |
cluster |
string |
"domain-s8" |
status |
string |
"green" |
cpuCores |
number |
16 |
cpuSockets |
number |
1 |
memoryBytes |
number |
49897058304 |
inMaintenance |
bool |
false |
productName |
string |
"VMware ESXi" |
productVersion |
string |
"7.0.0" |
managementServerIp |
string |
"10.6.46.248" |
Datacenter Fields
| Field |
Type |
Example |
name |
string |
"Datacenter" |
id |
string |
"datacenter-3" |
path |
string |
"/Datacenter" |
Cluster Fields
| Field |
Type |
Example |
name |
string |
"cluster-01" |
id |
string |
"domain-s8" |
path |
string |
"/Datacenter/host/cluster-01" |
Folder Fields
| Field |
Type |
Example |
name |
string |
"vm", "windows-vms" |
id |
string |
"group-v4" |
path |
string |
"/Datacenter/vm" |
datacenter |
string |
"datacenter-3" |
children[*].id |
string |
"vm-147" |
children[*].kind |
string |
"VM", "Folder" |
VM Query Examples
mtv_read { "command": "get inventory vm", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where name ~= 'prod-.*'", "output": "markdown" } }
mtv_read { "command": "get inventory vm", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where powerState = 'poweredOn' and memoryMB > 4096", "output": "markdown" } }
mtv_read { "command": "get inventory vm", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where firmware = 'efi' and guestName ~= '.*Windows.*'", "output": "markdown" } }
mtv_read { "command": "get inventory vm", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where any(disks[*].bus = 'nvme')", "output": "markdown" } }
mtv_read { "command": "get inventory vm", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where any(disks[*].rdm = true)", "output": "markdown" } }
mtv_read { "command": "get inventory vm", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where len(disks) > 1 and len(nics) >= 2", "output": "markdown" } }
mtv_read { "command": "get inventory vm", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where any(concerns[*].category = 'Critical')", "output": "markdown" } }
mtv_read { "command": "get inventory vm", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where snapshot.id != ''", "output": "markdown" } }
mtv_read { "command": "get inventory vm", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where toolsRunningStatus = 'guestToolsRunning'", "output": "markdown" } }
mtv_read { "command": "get inventory vm", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where powerState = 'poweredOn' order by memoryMB desc limit 10", "output": "markdown" } }
Infrastructure Query Examples
mtv_read { "command": "get inventory network", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where name ~= 'VM Network.*'", "output": "markdown" } }
mtv_read { "command": "get inventory datastore", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where type = 'VMFS' and free < 100Gi", "output": "markdown" } }
mtv_read { "command": "get inventory datastore", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where maintenance = 'normal' order by free asc", "output": "markdown" } }
mtv_read { "command": "get inventory host", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where inMaintenance = false and cpuCores >= 16", "output": "markdown" } }
mtv_read { "command": "get inventory folder", "flags": { "provider": "<PROVIDER>", "namespace": "<NS>", "query": "where path ~= '/Datacenter/vm/.*'", "output": "markdown" } }