NetApp ONTAP List

NetApp ONTAP List

Certified
Enterprise Edition

List ONTAP volumes

Retrieves all volumes from a NetApp ONTAP cluster via the REST API (GET /api/storage/volumes). Results include volume name, UUID, SVM, state, and space statistics. Supports pagination via maxRecords. Use fetchType=STORE for large clusters to avoid memory pressure.

yaml
type: io.kestra.plugin.ee.netapp.ontap.volumes.List

List all volumes on an ONTAP cluster.

yaml
id: ontap_list_volumes
namespace: company.team

tasks:
  - id: list_volumes
    type: io.kestra.plugin.ee.netapp.ontap.volumes.List
    host: "{{ secret('ONTAP_HOST') }}"
    username: admin
    password: "{{ secret('ONTAP_PASSWORD') }}"
    maxRecords: 100
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') }}.

ONTAP username

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

DefaultSTORE
Possible Values
STOREFETCHFETCH_ONENONE

The way you want to fetch the results

STORE (default) streams every volume to a file in Kestra internal storage and outputs its uri — best for large clusters. FETCH returns all volumes in the rows output. FETCH_ONE returns only the first volume in the row output. NONE returns just the size count.

Default100

Maximum records per page

Maximum number of volumes to retrieve per API page. ONTAP paginates results; all pages are fetched automatically. Defaults to 100.

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.

SVM name filter

When provided, only volumes belonging to the named SVM are returned (for example: svm1).

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.

First fetched volume

The first volume record. Populated for FETCH_ONE.

Definitions
namestring
sizeBytesinteger
statestring
stylestring
svmstring
usedBytesinteger
uuidstring

Fetched volumes

List of all volume records. Populated for FETCH.

Definitions
namestring
sizeBytesinteger
statestring
stylestring
svmstring
usedBytesinteger
uuidstring

Number of volumes returned

Total count of volumes retrieved. Populated for FETCH, FETCH_ONE, NONE, and STORE.

Formaturi

Stored volumes URI

Internal storage URI of the ION file containing all volume records. Populated for STORE.