NetApp ONTAP Restore

NetApp ONTAP Restore

Certified
Enterprise Edition

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.

yaml
type: io.kestra.plugin.ee.netapp.ontap.snapshots.Restore

Restore a volume to a previous snapshot.

yaml
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

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/.

ONTAP password

Password used for HTTP Basic authentication. Store this value as a Kestra secret and reference it via {{ secret('ONTAP_PASSWORD') }}.

Snapshot UUID

UUID of the snapshot to restore the volume to.

ONTAP username

Username used for HTTP Basic authentication (for example: admin).

Volume UUID

UUID of the ONTAP volume to restore.

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)
Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether 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.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

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.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

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

Default443

ONTAP port

Port for the ONTAP REST API. Defaults to 443.

Defaulthttps

HTTP 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.

DefaultPT5M

Async 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.

More Plugins in this Category

NetBox (EE)
NetBox
Enterprise

Enterprise NetBox tasks to create, update, and query devices, IP addresses, and sites over the NetBox API.

Infrastructure

7 tasks

4 blueprints

AS400
AS400

Tasks that connect to AS400 via JDBC to run queries and loads.

DataInfrastructure

3 tasks