ManageONTAP™ SDK v2.0P2

The core APIs are those necessary to actually make ONTAPI API calls to a filer. All of them deal with packaging up or unpackaging messages in XML format, or setting up connections, determining state and so on.

This document is a getting started guide. For complete documentation of the core routines, including discussion of memory management and so on, please see the language-specific documentation by following these links:

ONTAPI core routines in C
ONTAPI core routines in Perl
ONTAPI core routines in Java

The table in this companion document displays the primitives' names in the various languages side by side. In the event that you need to port code from one language to another, the ONTAPI calls in the code should port pretty easily using this reference.

#include <netapp_api.h>
...
char    err[256];

if (!na_startup(err, sizeof(err))) {
    fprintf(stderr, "Error: %s\n", err);
    exit(-1);
}

use lib '../../../lib/perl/NetApp';
use NaServer;
use NaElement;    #optional

import java.util.*;
import netapp.manage.*;

na_server_t*    s;
 
/*
 * server to talk to, and
 * API version, in this case 1.3 or higher
 */ 
s = na_server_open("jetfighter",1,3);  

 
 
 
 
 
my $s = NaServer->new("jetfighter", 1, 3);

NaServer     s;
 
 
 
 

s = new NaServer("jetfighter",1,3);

bool          use_rpc = 1;
bool          use_hosts_equiv = 0;

if (use_rpc) {
    na_server_set_style(s, NA_STYLE_RPC);
}
else if (use_hosts_equiv) {
    na_server_set_style(s,
                   NA_STYLE_HOSTSEQUIV);
}
else {
    na_server_set_style(s,
                   NA_STYLE_LOGIN_PASSWORD);
    na_server_set_admin_user(s,
                   "root", "F18fan");
}

my $use_hosts_equiv = 0;




if ($use_hosts_equiv) {
   $s->set_style(HOSTSEQUIV);
}

else {
   $s->set_style(LOGIN_PASSWORD);

   $s->set_admin_user("root", "F18fan");
}

boolean useHostsEquiv = false;




if (useHostsEquiv) {
   s.setStyle(NaServer.HOSTSEQUIV);
}

else {
   s.setStyle(NaServer.LOGIN_PASSWORD);

   s.setAdminUser("root", "F18fan");
}

na_server_close(s);  

s.close();

#include <stdio.h>
#include <netapp_api.h>

na_server_t*    s;
char            err[256];
na_elem_t*      out;

int main(int argc, char* argv[]) {
  if (argc < 4) {
    fprintf(stderr,
      "Usage: hello filer user passwd\n");
    exit(-1);
  }
  if (!na_startup(err, sizeof(err))){
    fprintf(stderr, "Error: %s\n",err);
    exit(-2);
  }
 
  s = na_server_open(argv[1],1,3);
  na_server_set_style(s,
        NA_STYLE_LOGIN_PASSWORD);
  na_server_set_admin_user(s,
        argv[2], argv[3]);

  out = na_server_invoke(s,
          "system-get-version", NULL);
  if (na_results_status(out) != NA_OK) {
    printf("Version 1.3 is unsupported: %s\n",
           na_results_reason(out));
  }
  else {
    printf("Hello!  Filer version is %s\n",
           na_child_get_string(out, "version")
          );
  }
 
  na_free(out);
  na_server_close(s);

  return 0;
}

use lib '../../../lib/perl/NetApp';
use NaServer;
use NaElement;    #optional

my $filer = shift;
my $user = shift;
my $pw = shift;

if ($user eq "") {
  print("Usage: hello filer user passwd");
  exit(-1);
}

my $s = NaServer->new($filer, 1, 3);

$s->set_style(LOGIN_PASSWORD);
$s->set_admin_user($user, $pw);

my $out = $s->invoke(
                 "system-get-version");
if ($out->results_status() eq "failed") {
    print($out->results_reason() . "\n");
}
else {
  print("Hello!  Filer version is " .
        $out->child_get_string("version")
        . "\n");
}

0;

import java.util.*;
import netapp.manage.*;

public class hello {
  public static void main(String[] args) {
    NaElement xi;
    NaElement xo;
    NaServer  s;

    if ( args.length < 3 ) {
      System.err.println(
        "Usage: hello filer user passwd");
      System.exit(1);
    }

    s = new NaServer(args[0],1,3);
    s.setStyle(NaServer.LOGIN_PASSWORD);
    s.setAdminUser(args[1], args[2]);

    xi = new NaElement(
             "system-get-version");
    try {
      xo = s.invokeElem(xi);
      System.out.print(
         "Hello!  Filer version is ");
      System.out.println(
         xo.childGetString("version"));
    }
    catch (Exception e) {
      System.out.println(e.toString());
    }
    finally {
      s.close();
    }
  }
}

For the sample code in this document to compile and run, you have to have the following things in place in your environment:

For the example code in this document to compile and run, you have to have the following things in place in your environment:

For the example code in this document to compile and run, you have to have the following things in place in your environment:

#include <stdio.h>
#include <netapp_api.h>

int main(int argc, char* argv[])
{
na_server_t*  s;
  na_elem_t*  out;
  char        err[256];
  int         use_rpc = 0;
  int         rtn = 0;
  char*       filername = argv[1];
  char*       user = argv[2]; 
  char*       passwd = argv[3]; 
  char*       vol = argv[4];
  char*       ssname = argv[5];

  if (argc < 6) {
    fprintf(stderr, "Usage: %s <filername> "
            "<user> <password> "
            "<volname> <newsnapshotname>\n",
            argv[0]);
    return -1;
  }

  if (!na_startup(err, sizeof(err))) {
    fprintf(stderr, "Error in na_startup: "
            "%s\n", err);
    return -2;
  }
  s = na_server_open(filername, 1, 1);

  if ( use_rpc) {
    na_server_set_style(s, NA_STYLE_RPC);
  }
  else {
    na_server_set_style(s,
          NA_STYLE_LOGIN_PASSWORD);
    na_server_adminuser(s, user, passwd);
  }
  rtn = na_server_set_transport_type(s,
          NA_SERVER_TRANSPORT_HTTPS,0);
       
  if (rtn == 0) {
    printf("Error setting transport              type");
    return -3;      
  }
       
  out = na_server_invoke(s,
          "snapshot-create",
          "snapshot", ssname,
          "volume", vol,
          NULL);

  if (na_results_status(out) != NA_OK) {
    printf("Error %d: %s\n",                                 na_results_errno(out),                 na_results_reason(out));
    return -4;      
  }
  else {
    na_elem_free(out);
  }
  return 0;
}

use lib '../../../lib/perl/NetApp';
use NaServer;
use NaElement;    #optional

my $filer = shift;
my $user = shift;
my $pw = shift;
my $vol = shift;
my $ssname = shift;

if ($ssname eq "") {
  print("Usage: snap filer user passwd");
  print(" volname newsnapshotname\n");
  exit(-1);
}

my $s = NaServer->new($filer, 1, 3);

$s->set_style(LOGIN_PASSWORD);
$s->set_admin_user($user, $pw);
$s->set_transport_type(
   NA_SERVER_TRANSPORT_HTTPS);

my $out = $s->invoke(
          "snapshot-create",
          "snapshot", $ssname,
          "volume", $vol);

if ($out->results_status() eq "failed") {
  print($out->results_reason() . "\n");
  exit(-2);
}

0;

import java.util.*;
import netapp.manage.*;

public class hello {
  public static void main(String[] args) {
    NaElement xi;
    NaElement xo;
    NaServer  s;
    String filer = args[0];
    String user = args[1];
    String passwd = args[2];
    String vol = args[3];
    String ssname = args[4];

    if ( args.length < 5 ) {
      System.err.print(
        "Usage: snap filer user passwd");
      System.err.println(
        " volume snapshotname");
      System.exit(-1);
    }

    s = new NaServer(filer,1,3);
    s.setStyle(NaServer.LOGIN_PASSWORD);
    s.setAdminUser(user, passwd);
    s.setTransportType(
      NaServer.NA_SERVER_TRANSPORT_HTTPS);

    xi = new NaElement(
             "snapshot-create");
    xi.addNewChild("volume", vol);
    xi.addNewChild("snapshot", ssname);

    try {
      xo = s.invokeElem(xi);
    }
    catch (Exception e) {
      e.printStackTrace();
      System.exit(-3);
    }
    finally {
      s.close();
    }
  }
}