NetApp ONTAP CreateRelationship

NetApp ONTAP CreateRelationship
Certified
Enterprise Edition
Create an ONTAP SnapMirror relationship

Creates a SnapMirror replication relationship between a source and destination volume via POST /api/snapmirror/relationships. Both source and destination are identified by SVM name and volume name. ONTAP may return HTTP 202 (async job); this task polls the job to completion before returning.

yaml
type: io.kestra.plugin.ee.netapp.ontap.replication.CreateRelationship

Examples

Create a SnapMirror relationship between two volumes.

yaml
id: ontap_create_snapmirror
namespace: company.team

tasks:
  - id: create_relationship
    type: io.kestra.plugin.ee.netapp.ontap.replication.CreateRelationship
    host: "{{ secret('ONTAP_HOST') }}"
    username: admin
    password: "{{ secret('ONTAP_PASSWORD') }}"
    sourceSvmName: svm_source
    sourceVolumeName: vol_primary
    destinationSvmName: svm_dest
    destinationVolumeName: vol_replica
    policyName: MirrorAllSnapshots

Properties

destinationSvmName *string

Destination SVM name

Name of the destination SVM (for example: svm_dest).

destinationVolumeName *string

Destination volume name

Name of the destination volume (for example: vol_replica).

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') }}.

sourceSvmName *string

Source SVM name

Name of the source SVM (for example: svm_source).

sourceVolumeName *string

Source volume name

Name of the source volume (for example: vol_primary).

username *string

ONTAP username

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

options

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

io.kestra.core.http.client.configurations.HttpConfiguration

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.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type*object

passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

io.kestra.core.http.client.configurations.BearerAuthConfiguration

type*object

tokenstring

The token for bearer token authentication.

io.kestra.core.http.client.configurations.DigestAuthConfiguration

type*object

passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordstring

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

basicAuthUserstring

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

connectTimeoutstring

Formatduration

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

connectionPoolIdleTimeoutstring

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.

java.nio.charset.Charset

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.

logLevelstring

Possible Values

ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray

SubTypestring

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthinteger

The maximum content length of the response.

proxy

The proxy configuration.

io.kestra.core.http.client.configurations.ProxyConfiguration

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.

proxyAddressstring

The address of the proxy server.

proxyPasswordstring

The password for proxy authentication.

proxyPortinteger

The port of the proxy server.

proxyTypestring

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernamestring

The username for proxy authentication.

readIdleTimeoutstring

Formatduration

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

readTimeoutstring

Formatduration

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

ssl

The SSL request options

io.kestra.core.http.client.configurations.SslOptions

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.

io.kestra.core.http.client.configurations.TimeoutConfiguration

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.

pluginDefaultsRef string

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

policyName string

DefaultMirrorAllSnapshots

SnapMirror policy name

Name of the SnapMirror policy to use (for example: MirrorAllSnapshots, MirrorLatest). Defaults to MirrorAllSnapshots.

port integerstring

Default443

ONTAP port

Port for the ONTAP REST API. Defaults to 443.

scheme string

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.

waitTimeout string

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.

Outputs

destinationPath string

Destination path

Destination path in svm: volume format.

relationshipUuid string

Relationship UUID

UUID assigned by ONTAP to the SnapMirror relationship. May be null when the creation completed via an asynchronous job (HTTP 202) and ONTAP did not return the record UUID in the job response.

sourcePath string

Source path

Source path in svm: volume format.