Data ONTAP APIs sample codes

You can use Data ONTAP APIs retrieve information about various NetApp storage system features, such as qtrees, quotas, volumes, LUNs, Snapshot, SnapMirror, and so on.

The following list describes the sample codes that demonstrate the use of a few Data ONTAP APIs. The list also provides links to view those codes.

Sample code in languages...

Name

Description

Perl

Java

VB.NET

PoweShell

Python

Ruby

FlexClone

This sample code demonstrates how to create a clone for a flexible volume. It estimates the size, splits the clone, and shows the status.

flexclone.c

flexclone.pl

flexclone.java

flexclone.py

flexclone.rb

Quota listing

This sample code demonstrates how to list the quota available on a storage system.

quotalist.c

quotalist.pl

quotalist.java

quotalist.py

quotalist.rb

Snapshot

This sample code shows how to manage Snapshot copies.

It demonstrates how to create a Snapshot copy, rename it, and delete it. The sample code also demonstrates how to get Snapshot copy lists and schedules.

snapman.c

snapman.pl

snapman.cs

snapman.vb

snapman.ps1

snapman.py

snapman.rb

SNMP

This sample code describes how to use the SNMP API. The following actions are performed with this sample code:

Adding new SNMP community
Deleting specific SNMP community
Deleting all SNMP communities
Disabling SNMP interface
Enabling SNMP interface
Obtaining SNMP get for specific OID
Obtaining SNMP getnext for specific OID
Getting SNMP Status
Disabling Traps
Enabling Trap
Adding Trap Host
Deleting Trap Host

snmp.c

snmp.pl

snmp.java

snmp.py

snmp.rb

Consistency Group

This sample code shows how to manage a consistency group, that is how to start and commit a consistency group.

cg_operation.c

cg_operation.pl

cg_operation.py

cg_operation.rb

Volume List

This sample code lists the volumes that are available on a storage system.

vollist.c

print_volume.pl

vollist.java

vollist.cs

vollist.vb

vollist.ps1

print_volume.py

print_volume.rb

MAC address List

This sample code shows a list of IP addresses and the corresponding MAC addresses.

getmac.c

view

Option List

This sample code shows a list of the options and demonstrates the use of the following functions:

Listing all the options
Getting the value of a particular option
Setting the value of a particular option

optmgmt.c

optmgmt.pl

optmgmt.java

optmgmt.cs

optmgmt.vb

optmgmt.ps1

optmgmt.py

optmgmt.rb

SnapMirror

This code demonstrates the management of SnapMirror operations.

sm.cpp

snapmirror.pl

snapmirror.java

snapmirror.py

snapmirror.rb

Symlink

This is a sample code for symbolic links from Windows. It demonstrates the use of the following functions:

Creating a symlink—file-create-symlink
Reading the content of a symlink—file-read-symlink

symlink.c

view

Volume Monitor

This sample code shows how to monitor a volume on a storage system.

monitor_volume.pl

view

monitor_volume.py

view

monitor_volume.rb

view

qtree

This sample code creates a qtree on a specified volume and adds a quota entry.

qtree_quota.pl

view

qtree_quota.py

view

qtree_quota.rb

view

vFiler

This sample code demonstrates how to create, destroy, and list vFiler units on the storage system.

vfiler.c

vfiler.pl

vfiler.java

vfiler.py

vfiler.rb

vFiler Tunnelling

This sample code demonstrates how to invoke Data ONTAP APIs on a vFiler through the physical storage system.

vfiler_tunnel.c

vfiler_tunnel.pl

vfiler_tunnel.java

vfiler_tunnel.cs

vfiler_tunnel.vb

vfiler_tunnel.ps1

vfiler_tunnel.py

vfiler_tunnel.rb

Unified Capacity Management

This sample code demonstrates the usage of Data ONTAP APIs for capacity management of NetApp storage systems.

It demonstrates the following function:

Calculating the total installed capacity of the system—raw-capacity
Calculating the total formatted capacity of the system—formatted-capacity
Calculating the total space reserved for the volume and the space used by nonreserved data—allocated-capacity
Calculating the total capacity available for user data—available-user-data-capacity
Calculating the usable space for provisioning—provisioning-capacity
Calculating the total capacity in RAID overhead and WAFL overhead—raid-overhead and wafl-overhead

unified_capacity_mgmt.c

view

unified_capacity_mgmt.pl

view

unified_capacity_mgmt.py

view

unified_capacity_mgmt.rb

view

User administration

This sample code demonstrates how to add, modify. and list the user administration capabilities using Data ONTAP APIs

It demonstrates the following functions:

Adding a new user to a group with defined capabilities—user-add
Modifying the user with allowed-capability and group-info values—user-modify
Listing the administrative users with allowed-capabilities and group-information—user-list
Adding a new role with allowed capabilities—role-add
Modifying a user role—role-modify
Listing information about all roles on the system—role-list
Adding a new group with allowed capabilities—group-add
Listing information about all the groups in the system—group-list

useradmin.c

view

Performance Operation

This sample code demonstrates the use of some of the perf family APIs. The sample code lists the system-wide performance objects, the counters for a given performance object, the object instances for a given object, and also provides values for counters of a given performance object.

perf_operation.c

perf_operation.pl

perf_operation.java

perf_operation.cs

perf_operation.vb

perf_operation.ps1

perf_operation.py

perf_operation.rb

NFS

This sample code demonstrates the use of some of the NFS family API. The sample code enables you to start, stop, and query the status of the NFS service. It also lists the current NFS export rules.

nfs.c

nfs.pl

nfs.java

nfs.cs

nfs.vb

nfs.ps1

nfs.py

nfs.rb

File SnapLock

This sample code demonstrates how to get the retention time and how to set the retention for SnapLock files.

file_snaplock.c

file_snaplock.pl

file_snaplock.java

file_snaplock.py

file_snaplock.rb

SAN Management

This sample code demonstrates the following functions:

Creating, deleting, and listing LUN clone
Mapping and unmapping LUNs
Creating, deleting, and listing igroups
Configuring FCP and iSCSI

san_mgmt.c

san_mgmt.pl

san_mgmt.py

san_mgmt.rb

Sample codes for clustered Data ONTAP:

Name	Description	C	Perl	Java	C#	VB.NET	Python	Perl API bindings
Data ONTAP mode	This sample code finds out whether Data ONTAP is 7-Mode or clustered Data ONTAP:	-	-	system_mode.java view	-	-	system_mode.py view	-
Volume list	This sample code lists the volumes that are available on a storage system .	vollist.c view	vollist.pl view	vollist.java view	vollist.cs view	vollist.vb view	-	-
Vserver	This sample code demonstrates how to manage a Storage Virtual Machine (SVM, formerly known as Vserver) in clustered Data ONTAP. It demonstrates the following functions: Listing SVMs Adding aggregates Creating new volumes Configure LIFs, NFS service, NIS domain and export rules for a SVM	-	vserver.pl view	vserver.java view	-	-	-	vserver.pl view
Vserver list	This sample code demonstrates how to lists all or few SVMs on clustered Data ONTAP.	vserverlist.c view	vserverlist.pl view	vserverlist.java view	vserverlist.cs view	vserverlist.vb view	-	-
Vserver tunneling	This sample code demonstrates how to use SVM tunneling	-	-	vserver_tunnel.java view	-	-	vserver_tunnel.py view	-