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, and Perl.

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> ...]

Following are the options of the apitest command:

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

• C

  Option name	Has parameter	Description
  -C	Yes	Name of the client certificate file to be used.
  -K	Yes	Private key file to be used. If not specified, the name of certificate file is used
  -P	Yes	Password to access the private key file
  -T	Yes	File that contains the trusted certificate that is to be used for server certificate verification
  -S	No	Enables server certificate verification
  -H	No	Enables hostname verification

• Java

  Option name	Has parameter	Description
  -K	Yes	Client keystore file to be used.
  -P	Yes	Password to access the keystore file.
  -E	Yes	Password to access the private key in the keystore file.
  -Y	Yes	Type of the keystore file (JKS/PKCS12). The default value is JKS
  -T	Yes	Truststore file to be used during server certificate verification
  -S	No	Enables server certificate verification
  -H	No	Enables hostname verification

   

• Perl

  Option name	Has parameter	Description
  -C	Yes	Name of the client certificate file to be used. By default, the certificate is not used.
  -K	Yes	Private key file to be used. If not specified, the name of certificate file is used
  -P	Yes	Password to access the private key file
  -T	Yes	File that contains the trusted certificates that is to be used for server certificate verification
  -S	No	Enables server certificate verification
  -H	No	Enables hostname verification

   

• C#, VB.NET and PowerShell

  Option name	Has parameter	Description
  -C	Yes	Location of the client certificate file.
  -P	Yes	Password to access the certificate file.
  -T	Yes	Client certificate store name. The default is 'My' store.
  -L	Yes	Client certificate store location. The default is 'CurrentUser'.
  -N	Yes	Subject name of the client certificate in the certificate store.
  -S	No	Enables server certificate verification.
  -H	No	Enables hostname verification

   

• Python

  Option name	Has parameter	Description
  -C	Yes	Name of the client certificate file to be used. By default, the certificate is not used.
  -K	Yes	Private key file to be used. If not specified, the name of certificate file is used
  -T	Yes	File that contains the trusted certificates that is to be used for server certificate verification
  -S	No	Enables server certificate verification
  -H	No	Enables hostname verification

   

• Ruby

  Option name	Has parameter	Description
  -C	Yes	Name of the client certificate file to be used. By default, the certificate is not used.
  -K	Yes	Private key file to be used. If not specified, the name of certificate file is used
  -P	Yes	Password to access the private key file
  -T	Yes	File that contains the trusted certificate that is to be used for server certificate verification
  -S	No	Enables server certificate verification
  -H	No	Enables hostname verification

   

The following are examples of the apitest command:

Sending an API query to a storage system running Data ONTAP

Sending an API query to a DataFabric Manager server