Nutanix ListVms

Nutanix ListVms

Certified
Enterprise Edition

List AHV VMs with filters

Retrieve Nutanix AHV VMs via the VMM v4 API with optional OData filter, sorting, selection, and pagination. Supports fetchType to return one row, full rows, or store large result sets as JSON in internal storage.

yaml
type: io.kestra.plugin.ee.nutanix.ahv.ListVms

List VMs and store the result

yaml
id: nutanix_list_vms
namespace: company.team
tasks:
  - id: list_vms
    type: io.kestra.plugin.ee.nutanix.ahv.ListVms
    host: "{{ secret('NUTANIX_HOST') }}"
    token: "{{ secret('NUTANIX_TOKEN') }}"
    filter: "startswith(name, 'prod-')"
    orderBy: "name desc"
    fetchType: STORE
Properties

Prism Central host

Required Nutanix Prism Central host or IP address.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch type

How to return results: FETCH (default) for all rows, FETCH_ONE for the first row, or STORE to write JSON to internal storage (kestra://) for large datasets.

Filter

OData filter expression applied server-side to the VM list.

Limit

Maximum VMs per page (1-100); optional, uses API default when unset.

Order by

OData orderBy expression for sorting.

Page

Page number (0-based); optional, uses API default when unset.

Password

Prism Central password; required when no token is provided.

Reference (ref) of the pluginDefaults to apply to this task.

Default9440

Prism Central port

API port for Prism Central; defaults to 9440.

Defaulthttps

Scheme

HTTP scheme (https default) for the Prism Central API.

Select

OData select expression to return specific VM fields.

Bearer token

Bearer token for Prism Central; when set, username/password are optional.

Username

Prism Central username; required when no token is provided.

Defaulttrue

Verify SSL

Whether to verify SSL certificates; defaults to true. Disabling this (setting to false) causes the client to trust all certificates without validation, exposing connections to man-in-the-middle attacks. Only set to false for trusted, isolated test environments, never in production.

Row

First VM row when fetchType is FETCH_ONE.

Definitions
clusterobject
descriptionstring
extIdstring
ipstring
namestring
resources
disksarray
SubTypeobject
memorySizeBytesinteger
nicsarray
SubTypeobject
numCoresPerSocketinteger
numSocketsinteger
numThreadsPerCoreinteger

Rows

Full list of VM rows when fetchType is FETCH.

Definitions
clusterobject
descriptionstring
extIdstring
ipstring
namestring
resources
disksarray
SubTypeobject
memorySizeBytesinteger
nicsarray
SubTypeobject
numCoresPerSocketinteger
numSocketsinteger
numThreadsPerCoreinteger

Size

Number of VMs returned by the API.

Timestamp

The timestamp (in milliseconds since epoch) when the operation completed.

Formaturi

URI

Storage URI when fetchType is STORE.