Session Management APIs for C and C++

na_server_t* na_server_open(const char* server, int major, int minor);

Sets the server context and assigns default values to the session parameters.

Following are the default values:

username= ""

password = ""

style = NA_STYLE_LOGIN_PASSWORD

port = 80

transport = NA_SERVER_TRANSPORT_HTTP

servertype = NA_SERVER_TYPE_FILER

You can overwrite the default values by using the na_server* Core APIs.

The address of the server context

Input	Type	Description
server	const char*	The name or the IP address of the server in IPv4 or IPv6 format
major	int	The major version of the ONTAP API
			For OnCommand Unified Manager server, use 1 as the major version.
minor	int	The minor version of the ONTAP API
			For OnCommand Unified Manager server, use 0 as the major version.

•

•

NULL on failure

na_server_style

void na_server_style(na_server_t* srv, na_style_t style);

Sets the authentication mechanism to be used for communicating with the given server.

Input	Type	Description
srv	na_server_t *	The pointer to the server context
style	na_style_t	The communication or authentication style that is to be set Following are the supported values: NA_STYLE_LOGIN_PASSWORD NA_STYLE_RPC NA_STYLE_HOSTSEQUIV NA_STYLE_CERTIFICATE If style= NA_STYLE_LOGIN_PASSWORD, you must provide an administrator user name and password with na_server_adminuser(). If style= NA_STYLE_RPC, your code should run on the Windows system so that a native Windows authentication based on remote procedure call is used. This is applicable for ONTAP APIs only. If style= NA_STYLE_HOSTSEQUIV, the server context authenticates the against the /etc/hosts.equiv file on the NetApp storage system. In such a case, you do not have to set the administrator user name and password. This is applicable for ONTAP APIs. If style =NA_STYLE_CERTIFICATE, you can use certificates to authenticate clients who attempt to connect to a server, without using login credentials. This style automatically sets HTTPS as the transport mechanism. You can use this authentication mechanism for clustered Data ONTAP 8.2 and OnCommand Unified Manager 5.0.2, 5.1, and 5.2. To authenticate the server, server certificate verification and hostname verification is required. For more information, see the APIs na_server_set_client_cert_and_key(), na_server_set_ca_certs(), na_server_set_server_cert_verification(), and na_server_set_hostname_verification().

int na_server_adminuser(na_server_t* srv, const char* login, const char* pwd);

Sets the user name and password for a server context, where authentication style is NA_STYLE_LOGIN_PASSWORD.

Input	Type	Description
srv	na_server_t*	The pointer to the server context
login	const char*	The login name
pwd	const char*	The password

na_server_set_server_type

•

1 (TRUE) on success

•

0 (FALSE) on failure

int na_server_set_server_type(na_server_t *srv, na_server_type_t type);

Sets the type of system you are connecting to.

Input	Type	Description
srv	na_server_t*	Pointer to the server context
type	na_server_type_t	The server type to be set Following are the supported values: NA_SERVER_TYPE_FILER — to connect to a NetApp storage system. NA_SERVER_TYPE_DFM — to connect to a OnCommand Unified Manager server 5.2 or earlier. NA_SERVER_TYPE_OCUM — to connect to a OnCommand Unified Manager server 6.0 or later. The default server type is NA_SERVER_TYPE_FILER.

na_server_set_transport_type

•

1 (TRUE) on success

•

0 (FALSE) on failure

int na_server_set_transport_type(na_server_t* srv, na_server_transport_t transport, const union zfd_setopt* transportarg);

Overrides the default transport type.

•

•

After setting the transport type, invoke the na_set_port() to set the port number used for that transport type.

The pointer to the server context

transport

na_server_transport_t

The transport type

Following are the supported transport types for NA_SERVER_TYPE_FILER and NA_SERVER_TYPE_DFM:

•

NA_SERVER_TRANSPORT_HTT

•

NA_SERVER_TRANSPORT_HTTPS

The default transport type is NA_SERVER_TRANSPORT_HTTP. For secure transport, use NA_SERVER_TRANSPORT_HTTPS as the transport type.

For NA_SERVER_TYPE_OCUM, only NA_SERVER_TRANSPORT_ HTTPS is supported and is set by default.

transportarg

const union zfd_setopt*

The transport argument

You should set transportarg to zero for both the HTTP and HTTPS transport protocols.

•

1 (TRUE) on success

•

0 (FALSE) on failure

na_server_set_sslv3

int na_server_set_sslv3(na_server_t *srv, int enable);

Enables or disables SSLv3 protocol for use over HTTPS transport. SSLlv3 is disabled by default.

Input	Type	Description
srv	na_server_t*	The pointer to the server context
enable	int*	State of SSLv3 Set enable = 1 to enable SSLv3, and set 0 to disable.

na_server_is_sslv3_enabled

•

1 (TRUE) on success

•

0 (FALSE) on failure

int na_server_is_sslv3_enabled(na_server_t *srv);

Determines whether SSLv3 is enabled.

Input	Type	Description
srv	na_server_t*	The pointer to the server context

•

1 (TRUE) if SSLv3 is enabled

•

0 (FALSE) if SSLV3 is disabled

na_server_set_vfiler

int na_server_set_vfiler(na_server_t* srv, const char * vfilerserver);

Sets the name of the vFiler unit on which the ONTAP API commands need to be invoked for the given server context.

After the command is set, all the API commands are executed on the vFiler unit through the actual server.

The API supports the vFiler tunneling feature.

Input	Type	Description
srv	na_server_t*	The pointer to the server context
vfilerserver	const char *	The name of the vFiler unit that is to be set

•

1 (TRUE) on success

•

0 (FALSE) on failure

na_server_set_port

int na_server_set_port(na_server_t* srv, int port);

Sets the port on which the API commands need to be invoked for the given server context.

Following is the default port on the storage system for ONTAP API communication:

HTTP=80

HTTPS=443

Following is the default port on the server for OnCommand Unified Manager Core Package 5.2 or earlier for API communication:

HTTP=8080

HTTPS=8488

Following is the only supported and default port on the server for OnCommand Unified Manager 6.0 or later for API communication:

HTTPS=443

You must invoke this API to set the port, if ONTAP or OnCommand Unified Manager does not have the default port settings.

Input	Type	Description
srv	na_server_t *	The pointer to the server context
port	int	The port number that is to be set

•

1 (TRUE) on success

•

0 (FALSE) on failure

na_server_set_timeout

int na_server_set_timeout(na_server_t* srv, int timeout);

Sets a connection timeout for the following actions:

•

Establishing a connection with the server.

•

Reading and writing data to and from the server socket used for API communication.

Input	Type	Description
srv	na_server_t *	The pointer to the server context
timeout	int	The timeout value This value is in seconds and should be zero or a positive number. If it is non-zero, the server uses non-blocking socket connection. If it is zero, the server uses blocking connection, which is the default behavior.

•

1 (TRUE) on success

•

0 (FALSE) on failure

na_server_set_vserver

int na_server_set_vserver(na_server_t* srv, const char* vsrv);

Sets the name of the Storage Virtual Machine (SVM, formerly known as Vserver) to which a Cluster API need to be tunneled from a Cluster Management Interface.

Input	Type	Description
srv	na_server_t *	The pointer to the server context
vsrv	const char *	The name of the SVM that is to be set

•

1 (TRUE) on success

•

0 (FALSE) on failure

na_server_invoke

na_elem_t* na_server_invoke(na_server_t* srv, const char* api, ...);

Invokes any API on the given server.

Enter the name-value pairs and terminate the list with NULL. You can enter only an even number of arguments to this function. The name-value pairs take only strings. All these contexts are then assembled and sent to the server.

Input	Type	Description
srv	na_server_t*	The pointer to the server context
api	const char*	The name of the API that is to be invoked
...	char *	The input arguments as a name-value pair

The pointer to the input output context that contains the server response

na_server_invoke_elem

na_elem_t* na_server_invoke_elem(na_server_t* srv, na_elem_t* elt);

Sends the API request in the form of input output context, in which the API command and its input arguments are embedded.

After the API call ends, you must free the context elt by invoking na_elem_free().

While processing optional inputs from a dialog box, it is recommended that you construct a context chain instead of using na_server_invoke().

Input	Type	Description
srv	na_server_t*	The pointer to the server context
elt	na_elem_t*	The pointer to the context chain

The pointer to the context that contains the server's reply

na_server_close

int na_server_close(na_server_t* srv);

You can have multiple server contexts opened at the same time and each opened server context has to be closed individually.

Clears the server context opened by na_server_open(). This is done by freeing all the allocated resources for that server context.

Input	Type	Description
srv	na_server_t*	The pointer to the server context

•

1 (TRUE) on success

•

0 (FALSE) on failure

na_server_set_debugstyle

void na_server_set_debugstyle(na_server_t * srv, na_debug_style_t style);

Sets the debug style for the given server context.

The pointer to the server context

style

na_debug_style_t

The debug style that is to be set

The default value is NA_PRINT_DONT_PARSE, which prints the raw XML output derived from the server by using na_server_get_raw_xml_output.

Following are the supported values for style:

•

NA_NO_DEBUG

•

NA_PRINT_DONT_PARSE

•

NA_DONT_PRINT_DONT_PARSE

na_server_set_client_cert_and_key

None

int na_server_set_client_cert_and_key (na_server_t* srv, const char* cert, const char* key, const char* passwd);

Sets the client's certificate for authentication by the server in a Secure Sockets Layer (SSL) session.

Input	Type	Description
srv	na_server_t*	The pointer to the server context.
cert	const char*	The name of the file in Privacy Enhanced Mail (PEM) format that contains the certificate.
key	const char*	The name of the file in PEM format that contains the private key. If key = NULL, then the certificate file is used as the key file.
passwd	const char*	The password to access the private key file passwd = NULL if the private key file is not password-protected.

na_server_set_server_cert_verification

•

1 (TRUE) on success

•

0 (FALSE) on failure

int na_server_is_server_cert_verification_enabled (na_server_t* srv);

Determines whether server certificate verification is enabled.

Input	Type	Description
srv	na_server_t*	The pointer to the server context

•

1 (TRUE) if server certificate verification enabled

•

0 (FALSE) if server certificate verification disabled

na_server_set_ca_certs

int na_server_set_ca_certs (na_server_t* srv, const char* CAfile);

Sets the location of trusted certificates that is used for server certificate verification during an SSL session.

The APIs na_server_set_ca_certs() and na_server_set_client_cert_and_key() can be used to build a client certificate chain that is sent to the server during an SSL session.

Input	Type	Description
srv	na_server_t*	The pointer to the server context
CAfile	const char*	The name of the file in Privacy Enhanced Mail (PEM) format that contains the trusted certificate The file can contain several certificates from the trusted Certificate Authority.

na_server_set_hostname_verification

•

1 (TRUE) on success

•

0 (FALSE) on failure

int na_server_set_hostname_verification (na_server_t *srv, int enable);