ZExplore

The ZExplore utility enables you to test the APIs from a Windows dialog box.

Beginners can test both the Data ONTAP APIs and DataFabric Manager server APIs for OnCommand Core Package. This utility shows the raw output retrieved from a NetApp storage system.

ZExplore is at bin/nt/. To launch ZExplore, click here.

You can fine the terms Zephyr and zapi appear, occasionally, as identifiers.

 

Viewing an API structure:

Depending on the type of product API that you use, complete the following steps:

  1. Click either the Data ONTAP tab or the DataFabric Manager server tab.

  2. Select the desired API version from the API Explorer drop-down list.

    		3.

    You can also type a keyword in the search box under API Explorer to open a particular API.

  3. Go to the API category and expand.

  4. Right-click the API name and click Generate.

Result: The XML structure appears in the request pane under the Execute tab.

 

Viewing sample code for an API:

To view sample codes for an API, complete the following steps:

  1. Complete steps 1 to 4 of Viewing an API structure.

  2. To view sample code, click the Develop tab.

  3. Select Java tab or Perl tab to view the sample code in that language.

You can compile the Java sample codes on Java 5.0 or later.

 

Invoking an API on the server:

To invoke an API, complete the following steps:

1. Connect to the server.

If you are using...

Then...

Data ONTAP APIs

Click Data ONTAP > Connect to storage system or simulator: Enter the IP address or host name of the storage system that you want to connect to.

DataFabric Manager APIs

Click DataFabric Manager server > Connect to DataFabric Manager server: Enter the IP address of the server that you want to connect to.

2. Select HTTP or HTTPS from the Transport dropdown list.

3. If you do not use the default port number, enter the port number in Port field that corresponds to the transport type.

4. Enter the user name in Username field to log in to the server.

5. Enter the corresponding password in the Password field.

6. Select Use vFiler or Vserver tunneling check box if you want to enable vFiler tunneling (for Data ONTAP APIs only) or Vserver tunneling, and enter the name of the vFiler unit or Vserver name in the vFiler unit or Vserver name field.

7. Click Connect to establish a connection with the server.

    Result: A new tab opens, which loads the current API version of the server that you are connected to.

8. View the results

If you want to obtain...

Then...

API results

  1. Complete the steps described in Viewing_an_API_structure.

  2. Provide the input parameters.

  3. Click Execute.

  4. You can see the output in the results tab in the XML and tree structure under the XML and the tree tab respectively.

The HTTP tab provides information about the HTTP header file.

View sample codes

Complete the steps described in Viewing sample code for an API.

 

A new tab is created every time you connect to a new Data ONTAP or DataFabric Manager server. However, the older sessions are not saved.

 

About Options tab

The Options tab enables you to use the following options to enhance the results of an API invocation:

Include comments in generated code

Shows the description of the API used and the input type in the code that you can view in the input pane.

Include optional elements in code generated

Displays the optional elements in the code that you can view in the input pane.

Enable iterator comprehension

For iterative APIs, fetches the complete list of iterative results at one instance.

It is enabled by default.

Iterator fetch size

Sets the maximum number of iterative results that can be fetched at one instance.

The default value is 1000.

Save changes

Saves the current settings and applies the new settings to the next API request.

Restore Defaults

Restores the default settings.