Session Management APIs for Perl bindings

NetApp Manageability SDK OLH - master : Programming Guide : Perl API bindings : Session Management APIs for Perl bindings

Session Management APIs for Perl bindings

The session management APIs are used to open the server connection, and to set and retrieve the server session parameters, such as transport type and authentication style.

This page contains information about the Session Management APIs for Perl, including the description and syntax, and the input, input types, input description, and input return values.

NaServer::set_style

set_style($style)

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

The authentication style

Following are the supported values:

•

HOSTS—to use the hosts.equiv file on the storage system to determine access rights.

•

LOGIN—to provide user name and password information. You can set the user name by using the API set_admin_user.

•

CERTIFICATE —to 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

NaServer::set_client_cert_and_key(),

NaServer::set_ca_certs(),

NaServer::set_server_cert_verification(),

and NaServer::set_hostname_verification().

•

undef on success

•

The NaElement object that contains the reason for failure

NaServer::get_style

Retrieves the configured authentication style.

The authentication style

Following are the supported values:

NaServer::set_port

set_port($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:

Following is the default port on the server for OnCommand Unified Manager Core Package

5.2 or earlier for API communication:

Following is the only supported and default port on the server for OnCommand Unified

Manager 6.0 or later for API communication:

You must invoke this API to set the port, if ONTAP or OnCommand Unified Manager does

not have the default port settings.

Input	Description
$port	The port number that is to be set

NaServer::get_port

Retrieves the port number used for invoking API commands.

The port number

NaServer::set_admin_user

set_admin_user($user,$passwd)

Sets the administrator user name and password for a server context.

This API is used if style= LOGIN.

Input	Description
$user	The user name
$passwd	The password

NaServer::set_server_type

set_server_type($type)

Sets the type of system you are connecting to.

Input	Description
$type	The server-type to be set Following are the supported values: FILER —to connect to a NetApp storage system. DFM—to connect to an OnCommand Unified Manager 5.2 or earlier server. OCUM- to connect to an OnCommand Unified Manager 6.0 or later server. The default server type is FILER.

•

undef on success

•

The NaElement object that contains the reason for failure

NaServer::get_server_type

get_server_type()

Retrieves the value of the server-type.

The type of the given server.

Following are the possible return values:

•

•

•

NaServer::set_transport_type

set_transport_type($type)

Set the connection transport type.

The connection transport type

Following are the supported values:

•

•

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

For server type OCUM, only HTTPS is supported and is set as default.

•

undef on success

•

The NaElement object that contains the reason for failure

NaServer::get_transport_type

get_transport_type()

Retrieves the connection transport type.

The connection transport type

Following are the supported values:

NaServer::set_debug_style

set_debug_style($debug_style)

Sets the debug style for the given server context.

Input	Description
$debug_style	The debug style that is to be set It takes the value NA_PRINT_DONT_PARSE. If set to NA_PRINT_DONT_PARSE, then the raw XML input and output of the API are printed.

•

undef on success

•

The NaServer object that contains the reason for failure

NaServer::set_vfiler

set_vfiler($vfiler)

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

After you set the command, all the API commands are executed on the vFiler unit through the actual storage system.

This API supports the vFiler tunneling feature.

Input	Description
$vfiler	The name of the vFiler unit that is to be set

•

•

NaServer::set_vserver

set_vserver($ 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	Description
$vsrv	The name of the SVM that is to be set

•

•

NaServer::get_vserver

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

Name of the SVM

NaServer::use_https

Determines whether HTTPS is enabled.

•

1 if HTTPS is enabled

•

0 if HTTPS is not enabled

NaServer::set_timeout

set_timeout($timeout)

Sets the connection timeout value, in seconds, for the given server context.

Input	Description
$timeout	The timeout value that is to be set

NaServer::get_timeout

Retrieves the connection timeout value for the given server context.

The connection timeout value in seconds

NaServer::set_client_cert_and_key

set_client_cert_and_key ($cert, $key, $passwd)

Sets the client's certificate and private key files that are required during the Secure Sockets Layer (SSL) session.

Input	Description
$cert	The name of the file in Privacy Enhanced Mail (PEM) format that contains the client certificate To set intermediate certificates and root certificate, you can use the NaServer::set_ca_certs() API.
$key	The name of the file in PEM format that contains the private key If key=NULL, the certificate file is used in place of the key.
$passwd	The password to access the private key file The value is undef if the private key file is not password-protected.

•

undef on success

•

The NaElement object that contains the reason for failure

NaServer::set_server_cert_verification

set_server_cert_verification($enable)

Enables or disables the server certificate verification by the client.

When the authentication style is set to CERTIFICATE, server certificate verification is enabled by default. Otherwise, you have to set the transport type to HTTPS, and then provide the trusted CA certificates by using the NaServer::set_ca_certs() API to verify the server certificate.

Hostname verification is enabled by default during server certificate verification.

The status of the server certificate validation

Following are the supported values:

•

1 if the server certificate verification is to be enabled.

•

0 if the server certificate verification is to be disabled.

•

undef on success

•

The NaElement object that contains the reason for failure

NaServer::is_server_cert_verification_enabled

is_server_cert_verification_enabled()

Determines whether server certificate verification is enabled.

•

1 if server certificate verification is enabled

•

0 if server certificate verification is disabled

NaServer::set_ca_certs

set_ca_certs($CAfile)

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

You can use the APIs NaServer::set_ca_certs() and

NaServer::set_client_cert_and_key()to build the client certificate chain that is sent to the server.

Input	Description
$CAfile	The name of the file that contains the certificate of the trusted Certificate Authorities in PEM format

•

undef on success

•

The NaElement object that contains the reason for failure

NaServer::set_hostname_verification

set_hostname_verification($enable)

Enables or disables hostname verification during server certificate verification.

Input	Description
$enable	The status of the hostname certificate validation TRUE if the hostname verification is to be enabled. FALSE if the hostname verification is to be disabled.

•

undef on success

•

The NaElement object that contains the reason for failure

NaServer::is_hostname_verification_enabled

is_hostname_verification_enabled()

Determines whether hostname verification is enabled.

•

1 if hostname verification is enabled

•

0 if hostname verification is disabled

NaServer::set_application_name

set_application_name($app_name)

Sets the name of the client application that initiates an operation using ONTAP APIs, and requires a response from the ONTAP server.

The name of the client application helps you track the actions performed by the application on the server. This information is logged in the server audit log file.

Input	Description
$app_name	The name of the client application that is to be set

NaServer::get_application_name

get_application_name()

Gets the name of the client application.

•

Name of the client application if set using set_application_name()

•

Empty string if not set.

NaServer::set_bindings_validation

set_bindings_validation($enable)

Enables or disables API bindings validation (which is enabled by default) for ONTAP or OnCommand Unified Manager server.

The Status of the API bindings validation:

•

1 if the API bindings validation is to be enabled.

•

0 if the API bindings validation is to be disabled.

NaServer::set_bindings_family

set_bindings_family($family)

Set the API family of ONTAP or OnCommand Unified Manager server for API bindings validation. The bindings validation must already be enabled using NaServer::set_bindings_validation().

Valid family names (not case-sensitive) are:

•

Cluster-Mode: This family is set by default for “FILER” server type and is used for validating ONTAP APIs (including Vserver APIs).

•

7-Mode: This family is applicable only for “FILER” server type and is used for validating ONTAP operating in 7-Mode or 7G APIs.

•

OCUM: This family is set by default for “OCUM” server type and is used for validating OnCommand Unified Manager server 6.0 or later.

•

OCUM-Classic: This family is set by default for “DFM” server type and is used for validating OnCommand Unified Manager server 5.2 or earlier.

Parent topic: Perl API bindings

Was this topic helpful? Send comments to NetApp.

Copyright © 2017 NetApp, Inc. All rights reserved.