NetApp ONTAP List
CertifiedEnterprise EditionList ONTAP volumes
NetApp ONTAP List
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.
type: io.kestra.plugin.ee.netapp.ontap.volumes.ListExamples
List all volumes on an ONTAP cluster.
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
host *Requiredstring
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 *Requiredstring
ONTAP password
Password used for HTTP Basic authentication.
Store this value as a Kestra secret and reference it via {{ secret('ONTAP_PASSWORD') }}.
username *Requiredstring
ONTAP username
Username used for HTTP Basic authentication (for example: admin).
fetchType string
STORESTOREFETCHFETCH_ONENONEThe 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.
maxRecords integerstring
100Maximum records per page
Maximum number of volumes to retrieve per API page. ONTAP paginates results; all pages are fetched
automatically. Defaults to 100.
options Non-dynamic
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.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
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.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
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.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
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.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
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.
svmName string
SVM name filter
When provided, only volumes belonging to the named SVM are returned (for example: svm1).
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.
Outputs
row
First fetched volume
The first volume record. Populated for FETCH_ONE.
io.kestra.plugin.ee.netapp.ontap.volumes.List-VolumeRecord
rows array
Fetched volumes
List of all volume records. Populated for FETCH.
io.kestra.plugin.ee.netapp.ontap.volumes.List-VolumeRecord
size integer
Number of volumes returned
Total count of volumes retrieved. Populated for FETCH, FETCH_ONE, NONE, and STORE.
uri string
uriStored volumes URI
Internal storage URI of the ION file containing all volume records. Populated for STORE.
