vsphere_list_vms
List VMware VMs with power state, resources, and guest details. Filter by name, datacenter, cluster, power state, or IP, and page through results.
Instructions
List virtual machines with power state, resources and guest details.
All filters are combined with AND. Results are capped; check the
truncated field and page with offset when it is true.
Args:
name: VM name filter. Plain text matches as a case-insensitive
substring; * and ? enable glob matching.
power_state: poweredOn, poweredOff or suspended.
datacenter: Only VMs in this datacenter.
cluster: Only VMs whose host belongs to this cluster.
host: Only VMs registered to this ESXi host (name or moid).
guest_os: Filter on the configured guest OS name, e.g. Ubuntu.
ip_address: Filter on the primary guest IP address (substring match).
include_templates: Include VM templates alongside real VMs.
only_templates: Return only VM templates.
limit: Maximum number of VMs to return.
offset: Number of matches to skip, for paging.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | No | ||
| name | No | ||
| limit | No | ||
| offset | No | ||
| cluster | No | ||
| guest_os | No | ||
| datacenter | No | ||
| ip_address | No | ||
| power_state | No | ||
| only_templates | No | ||
| include_templates | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||