Nutanix ListVmSnapshots
CertifiedEnterprise EditionList VM snapshots with filters
Nutanix ListVmSnapshots
List VM snapshots with filters
Retrieve AHV VM recovery points via the Nutanix dataprotection v4 API with optional VM filter, OData filtering/sorting/selection, and pagination; supports fetch modes for large result sets.
type: io.kestra.plugin.ee.nutanix.snapshot.ListVmSnapshotsExamples
List VM snapshots and store the result
id: nutanix_list_vm_snapshots
namespace: company.team
tasks:
- id: list_vm_snapshots
type: io.kestra.plugin.ee.nutanix.snapshot.ListVmSnapshots
host: "{{ secret('NUTANIX_HOST') }}"
token: "{{ secret('NUTANIX_TOKEN') }}"
vmExtId: "{{ secret('NUTANIX_VM_EXT_ID') }}"
fetchType: STORE
Properties
host *Requiredstring
Prism Central host
Required Nutanix Prism Central host or IP address.
apiVersion string
v4.0.a4Dataprotection API version
Dataprotection API version to use for recovery point operations.
fetchType string
FETCHSTOREFETCHFETCH_ONENONEFetch 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 string
Filter
OData filter expression applied to recovery points.
limit integerstring
Limit
Maximum snapshots per page; optional, uses API default when unset.
orderBy string
Order by
OData orderBy expression for sorting.
page integerstring
Page
Page number (0-based); optional, uses API default when unset.
password string
Password
Prism Central password; required when no token is provided.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
port integerstring
9440Prism Central port
API port for Prism Central; defaults to 9440.
scheme string
httpsScheme
HTTP scheme (https default) for the Prism Central API.
select string
Select
OData select expression to return specific recovery point fields.
token string
Bearer token
Bearer token for Prism Central; when set, username/password are optional.
username string
Username
Prism Central username; required when no token is provided.
verifySsl booleanstring
trueVerify 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.
vmExtId string
VM extId
Optional VM extId to filter snapshots for a single VM.
Outputs
row
Row
First snapshot row when fetchType is FETCH_ONE.
io.kestra.plugin.ee.nutanix.domain.RecoveryPoint
rows array
Rows
Full list of snapshot rows when fetchType is FETCH.
io.kestra.plugin.ee.nutanix.domain.RecoveryPoint
size integer
Size
Number of snapshots returned by the API after filtering.
timestamp integer
Timestamp
The timestamp (in milliseconds since epoch) when the operation completed.
uri string
uriURI
Storage URI when fetchType is STORE.
