topic Re: List of available API calls on node vserver? in Software Development Kit (SDK) and API Discussions

List of available API calls on node vserver?

acjackson — Wed, 04 Jun 2025 16:09:32 GMT

Hi,

I'm trying to use nmsdk for python to connect to a node with vserver tunneling.

python apitest.py -v NODE_VSERVER CLUSTER USER PASSWORD  system-get-version

But for almost every api call, I get the error, that the cluster was unable to find the API.

Example:

<results reason="Unable to find API: system-get-version on node vserver on06-01" errno="13005" status="failed"></results>

Some API calls seem to work, like file-list-directory-iter-start work

python apitest.py -v NODE_VSERVER CLUSTER USER PASSWORD file-list-directory-iter-start  path /vol/vol0

is there a way to get a list of all available API calls?

Re: List of available API calls on node vserver?

asulliva — Tue, 24 Jan 2017 16:30:57 GMT

Hello @acjackson,

If you look in the API documentation you'll notice that it's broken into two parts..."cluster" and "vserver". While there is some overlap, there are many APIs which must be targeted at SVMs and vice versa. In particular APIs which manipulate volumes and volume access are targeted at SVMs.

SVM level APIs can be invoked by connecting to the SVM management interface or by using tunneling through the cluster management interface.

Hope that helps.

Andrew

Re: List of available API calls on node vserver?

acjackson — Thu, 02 Feb 2017 12:03:10 GMT

I'm fimiliar with the separation of cluster/vserver APIs, but those vserver APIs listed in the API documentation and ZEDI seem to be only working on data SVMs.

Only very few APIs like 'options-list-info' work on a node SVM.

I was looking for a list of APIs specifically for node SVMs to see what I can do

edit:

The following article was helpful to find out, that only white-listed APIs are allowed on a node vserver.

What is Vserver Tunneling in Data ONTAP 8.1.0?

So what are white-listed APIs?

In the Reference Manual for ONTAP 9.1 APIs you find the following explanation:

ONTAP White-list API
The Data ONTAP 7-Mode APIs that do not create, modify, or delete a cluster object are called ONTAP White-list APIs.
A user in a cluster environment can use these 7-Mode API by using Storage Virtual Machine (SVM, formerly known as Vserver) tunneling.

And a list with the following APIs:

aggr-space-list-info
clock-get-clock
clock-get-timezone
clone-list-status
disk-list-info
ems-autosupport-log
ems-invoke
file-inode-info
file-list-directory-iter-end
file-list-directory-iter-next
file-list-directory-iter-start
file-read-file
file-get-file-info
license-add
license-delete
license-list-info
net-ifconfig-get
net-ping
net-ping-info
net-resolve
net-reverse-resolve
options-list-info
options-get
reallocate-list-info
system-get-info
volume-charmap-get
volume-get-filer-info
volume-get-supported-guarantees