apitest

apitest is a command-line utility to test APIs. This utility is suitable for API users who are at the beginner's level. This utility is available in C, Java, Perl, C#, VB.NET, PowerShell in Windows, Python, and Ruby. In UNIX-like environments, apitest is available in C, Java, Perl, Python, and Ruby.

 

How to use the apitest utility:

apitest in C

For Windows, complete the following steps:

  1. Open the command prompt.

  2. Go to the bin\nt\ directory.

  3. To execute, run apitest.

 

For a UNIX-like environment, complete the following steps:

  1. Open the command prompt.

  2. Go to the src/util/apitest/ directory.

  3. Run make to create the executable.

 

apitest in Java

For Windows, complete the following steps:

  1. Open the command prompt.

  2. Go to the src\sample\Data_ONTAP\Java\apitest\ directory.

  3. Run MAKE.BAT file to create the class file.

 

For a UNIX-like environment, complete the following steps:

  1. Open the command prompt.

  2. Go to the src/sample/Data_ONTAP/Java/apitest/ directory.

  3. Run make to create the class file.

 

apitest in Perl

Complete the following steps:

  1. Open the command prompt.

  2. Go to the src/sample/Data_ONTAP/Perl/ directory.

  3. Run the perl apitest.pl command.

 

apitest in C#

Complete the following steps:

  1. Open apitest.sln located at src\sample\Data_ONTAP\DotNet\CSharp\apitest\ in Visual Studio editor.

  2. From the Build menu, click Build apitest to generate the executable.

 

apitest in VB.NET

Complete the following steps:

  1. Open apitest.sln located at src\sample\Data_ONTAP\DotNet\VB.NET\apitest\ in Visual Studio editor.

  2. From the Build menu, click Build apitest to generate the executable.

 

apitest in PowerShell

Complete the following steps:

  1. Open the PowerShell command prompt.

  2. Go to the src\sample\Data_ONTAP\DotNet\PowerShell\ directory.

  3. Run the .\apitest.ps1 command.

 

apitest in Python

Complete the following steps:

  1. Open the command prompt.

  2. Go to the src/sample/Data_ONTAP/Python/ directory.

  3. Run the python apitest.py command.

 

apitest in Ruby

Complete the following steps:

  1. Open the command prompt.

  2. Go to the src/sample/Data_ONTAP/Ruby directory.

  3. Run the ruby apitest.rb command.

 

Command syntax

The command syntax is as follows:

apitest {options} <host> <user> <password> <API> [ <paramname> <arg> ...]

 

Command details

Description

apitest

The command name.

options

An optional parameter.

See the table below for more information.

host

The host name or IP address of the server.

user

The user name.

password

The corresponding password.

API

The name of the API.

paramname

The input element of the API.

arg

The value of the input element.

 

Following are the options of the apitest command:

Options

Description

-i

API specified as XML output, on the command line.

-I

API specified as XML output, on standard input.

-t

Server type.

Following are the possible values:

  • filer

  • dfm

  • agent

-v

The vFiler unit name or the Storage Virtual Machine (SVM, formerly known as Vserver)  name, if the API has to be executed in the context of a vFiler unit or a SVM respectively.

-r

Uses RPC transport.

Does not support clustered Data ONTAP APIs

-s

Uses SSL.

-p

Overrides port to use.

-x

Shows the XML input and output.

-X

Shows the raw XML input and output.

-h

Authenticates hosts using the hosts.equiv file.

-c

Sets the connection timeout.

 

To view more options for certificate-based authentication, see the following language-specific links:

 

The -v, -r, and -h options are not applicable for DataFabric Manager server.

 

The following are examples of the apitest command:

Sending an API query to a storage system running Data ONTAP

$apitest -x <host> <user> <password> file-read-file length 100 offset 0 path /vol/vol0/etc/temp/1

INPUT:

<file-read-file>

        <length>100</length>

        <offset>0</offset>

        <path>/vol/vol0/etc/temp/1</path>

</file-read-file>

 

OUTPUT:

<results status="passed">

        <length>3</length>

        <data>00abcd</data>

</results>

 

Sending an API query to a DataFabric Manager server

apitest.exe -t dfm sweetpea root tryme dfm-user-priv-get

<results status="passed">

        <privilege>FULL</privilege>

</results>

 

On the Windows platform, the RPC transport layer does not work without the ntapadmin.dll file in the DLL search path of the application. The file ntapadmin.dll is at bin/nt/.