Nutanix RestoreVmSnapshot

Nutanix RestoreVmSnapshot
Certified
Enterprise Edition
Restore VM snapshot

Restore an AHV VM recovery point via the Nutanix dataprotection v4 API; accepts an optional restore spec for advanced options and returns the async task extId.

yaml
type: io.kestra.plugin.ee.nutanix.snapshot.RestoreVmSnapshot

Examples

Restore a VM snapshot

yaml
id: nutanix_restore_vm_snapshot
namespace: company.team
tasks:
  - id: restore_vm_snapshot
    type: io.kestra.plugin.ee.nutanix.snapshot.RestoreVmSnapshot
    host: "{{ secret('NUTANIX_HOST') }}"
    token: "{{ secret('NUTANIX_TOKEN') }}"
    snapshotExtId: "{{ secret('NUTANIX_SNAPSHOT_EXT_ID') }}"

Properties

host *string

Prism Central host

Required Nutanix Prism Central host or IP address.

snapshotExtId *string

Snapshot extId

Required extId of the snapshot (recovery point) to restore.

apiVersion string

Defaultv4.0.a4

Dataprotection API version

Dataprotection API version to use for recovery point operations.

password string

Password

Prism Central password; required when no token is provided.

pluginDefaultsRef string

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

port integerstring

Default9440

Prism Central port

API port for Prism Central; defaults to 9440.

restoreSpec string

Restore spec

Optional restore specification for advanced restore options; leave unset for a default restore.

Definitions

io.kestra.plugin.ee.nutanix.domain.RestoreSpec

scheme string

Defaulthttps

Scheme

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

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

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.

Outputs

taskExtId string

Task extId

ExtId of the asynchronous task, when the API returns a task reference.

timestamp integer

Timestamp

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