NetApp ONTAP Python Client Library

9.18.1.0 · active · verified Wed Apr 15

The netapp-ontap Python client library simplifies interaction with NetApp ONTAP's REST APIs. It provides services for connection management, asynchronous request processing, and exception handling, enabling Python developers to quickly automate ONTAP deployments. The library's version aligns with the ONTAP major and minor versions it's generated from, with feature releases typically twice a year (Q2 and Q4) and service updates every 4-12 weeks.

Warnings

breaking Property names in ONTAP REST API that conflict with Python reserved keywords (e.g., 'class') are transposed by the library (e.g., to 'class_'). Similarly, if an action method name conflicts with a resource field, the action method might be renamed (e.g., 'sign()' to 'sign_action()').
Fix: Always refer to the official documentation or use introspection to discover the correct Python property/method name for conflicting ONTAP API fields.
gotcha Client library versions are designed for specific ONTAP releases. A client library with a major version less than the target ONTAP release might not be fully compatible and unable to access newer REST APIs or correctly interpret new fields. The library may ignore unknown fields, return errors, or raise runtime exceptions.
Fix: Ensure your `netapp-ontap` library version's major and minor components (e.g., 9.X.Y) align with or are newer than the target ONTAP cluster's version (e.g., ONTAP 9.X). Always upgrade the library to match or exceed your ONTAP cluster's version for full compatibility.
deprecated The `netapp-lib` library, which supported the legacy ONTAP API (ONTAPI/ZAPI), is no longer maintained. While this `netapp-ontap` library focuses on REST APIs, users transitioning from older automation might encounter references to `netapp-lib`.
Fix: Migrate any automation using `netapp-lib` (ZAPI) to use the `netapp-ontap` client library with ONTAP REST APIs. Consult NetApp's End-of-Availability announcements for ONTAPI.
gotcha Newer ONTAP versions (e.g., 9.8 and later for TLS 1.0, 9.12.0 and later for TLS 1.1) disable older TLS protocols by default for new installations. For upgraded systems, TLS 1.0/1.1 might be automatically disabled if FIPS is enabled. This can impact connections from older clients or scripts.
Fix: Ensure your Python environment and client scripts support modern TLS versions (1.2 or 1.3). If necessary, configure ONTAP to re-enable older TLS protocols (with caution for security implications) or update client systems.

Install

pip install netapp-ontap Install netapp-ontap

Imports

HostConnection
```
from netapp_ontap import HostConnection
```
Used to establish a connection to an ONTAP cluster.
Cluster
wrong:
```
from netapp_ontap import Cluster
```
correct:
```
from netapp_ontap.resources import Cluster
```
Resource objects like 'Cluster' are typically found in the 'resources' submodule.
Volume
```
from netapp_ontap.resources import Volume
```
Resource objects like 'Volume' are typically found in the 'resources' submodule.

Quickstart

This quickstart demonstrates how to establish a connection to an ONTAP cluster using environment variables for credentials and retrieve basic cluster information (name and UUID). It sets `verify=False` for simplicity in the example, but `verify=True` and proper certificate handling are recommended for production environments.

import os
from netapp_ontap import HostConnection
from netapp_ontap.resources import Cluster

# Set connection details via environment variables for security
ONTAP_HOST = os.environ.get('ONTAP_HOST', 'your_ontap_cluster_ip_or_hostname')
ONTAP_USER = os.environ.get('ONTAP_USER', 'admin')
ONTAP_PASS = os.environ.get('ONTAP_PASS', 'password')

if ONTAP_HOST == 'your_ontap_cluster_ip_or_hostname':
    print("Please set ONTAP_HOST, ONTAP_USER, and ONTAP_PASS environment variables.")
    exit(1)

try:
    # Establish a connection
    HostConnection(ONTAP_HOST, username=ONTAP_USER, password=ONTAP_PASS, verify=False)

    # Get cluster details
    cluster = Cluster.get_collection(fields='uuid,name')[0]

    print(f"Successfully connected to ONTAP cluster: {cluster.name} (UUID: {cluster.uuid})")
except Exception as e:
    print(f"Error connecting to ONTAP or retrieving cluster details: {e}")

view raw JSON →