NetApp ONTAP Snapshots Restore
CertifiedEnterprise EditionRestore an ONTAP volume from a snapshot
NetApp ONTAP Snapshots Restore
Restore an ONTAP volume from a snapshot
Restores an ONTAP volume to the state captured in a snapshot via
PATCH /api/storage/volumes/{volumeUuid}?restore_to.snapshot.uuid={snapshotUuid}.
The snapshot UUID is sent both as the restore_to.snapshot.uuid query parameter (per the
ONTAP OpenAPI spec) and in the equivalent nested request body, so the request succeeds
regardless of which form the target ONTAP version expects.
This is an in-place, non-destructive revert — the volume is rolled back to the snapshot point-in-time.
The operation is typically asynchronous (HTTP 202); this task polls the job to completion before returning.
type: io.kestra.plugin.ee.netapp.ontap.snapshots.RestoreExamples
Restore a volume to a previous snapshot.
id: ontap_restore_snapshot
namespace: company.team
tasks:
- id: restore_snapshot
type: io.kestra.plugin.ee.netapp.ontap.snapshots.Restore
host: "{{ secret('ONTAP_HOST') }}"
username: admin
password: "{{ secret('ONTAP_PASSWORD') }}"
volumeUuid: "{{ inputs.volume_uuid }}"
snapshotUuid: "{{ inputs.snapshot_uuid }}"
Properties
host *string
ONTAP cluster management IP or hostname
Hostname or IP address of the ONTAP cluster management interface (for example: ontap.example.com or 192.168.1.10).
The REST API is reached at https://{host}/api/.
password *string
ONTAP password
Password used for HTTP Basic authentication.
Store this value as a Kestra secret and reference it via {{ secret('ONTAP_PASSWORD') }}.
snapshotUuid *string
Snapshot UUID
UUID of the snapshot to restore the volume to.
username *string
ONTAP username
Username used for HTTP Basic authentication (for example: admin).
volumeUuid *string
Volume UUID
UUID of the ONTAP volume to restore.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150options
HTTP client configuration
Optional HTTP client overrides such as timeouts, TLS settings, and proxy. For example:
options:
timeout:
connectTimeout: PT10S
readIdleTimeout: PT30S
ssl:
insecureTrustAllCertificates: true # accept self-signed cluster certs (insecure — lab use only)
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
Retry strategy for HTTP requests.
retry is disabled by default.
Constant retry
Retry with a fixed delay between attempts.
durationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseExponential retry
Retry with exponentially increasing delays between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseRandom retry
Retry with a random delay within a configurable range between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalse[502,503,504]HTTP status codes that should be retried.
Used for idempotent methods (GET, HEAD) without their own entry in retryOnStatusCodesByMethod. Non-idempotent methods are never retried on a status code unless listed in retryOnStatusCodesByMethod. Defaults to 502, 503 and 504 for idempotent methods (GET, HEAD) only.
Per-HTTP-method overrides for which status codes should be retried.
Keys are HTTP methods (e.g. GET, POST). A method with no entry here falls back to retryOnStatusCodes. This lets a caller retry more broadly for safe, read-only methods (for example, every 5xx and a 429 for GET/HEAD) while keeping a narrower list for methods that write, where retrying a request that may have already been processed by the origin risks duplicating the effect. Example: {GET: [429, 500, 502, 503, 504], HEAD: [429, 500, 502, 503, 504]}.
["GET","HEAD"]HTTP methods for which any transport-level failure may be retried.
A transport-level failure is a connection or timeout error rather than an HTTP response (e.g. a read timeout or a connection reset mid-request). For a method listed here, any such failure is retried. Defaults to GET and HEAD HTTP methods.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
port integerstring
443ONTAP port
Port for the ONTAP REST API. Defaults to 443.
scheme string
httpsHTTP scheme
Protocol scheme used to reach the ONTAP REST API. Defaults to https.
Set to http only for testing against local stubs; production clusters always use https.
waitTimeout string
PT5MAsync job wait timeout
Maximum time to wait for ONTAP asynchronous jobs (those that return HTTP 202 + a job UUID) to reach a terminal
state. Defaults to PT5M (5 minutes). The job is polled every 2 seconds within this window.
