Session Management APIs for Python

NetApp Manageability SDK OLH - master : Programming Guide : SDK Core APIs : Python Core APIs : Session Management APIs for Python

Session Management APIs for Python

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 Python, 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 APIsNaServer:set_client_cert_and_key(), NaServer.set_ca_certs(), NaServer.set_server_cert_verification(), andNaServer.set_hostname_verification().

None on failure

NaServer.get_style

Retrieves the configured authentication style.

The authentication style

Following are the supported values:

◦

◦

◦

NaServer.set_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.

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.

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

◦

None 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.invoke

invoke(api, [argname, argval], ...)

Invokes any API on the given server.

This function takes the API name as the first argument. If the API has any input element, type it as input argument name-value pairs. This function takes only an odd number of arguments.

All the input elements are assembled and sent to the server.

Input	Description
api	The name of the API to be invoked
argname	The input element name
argval	The input element value

The NaElement object

NaServer.invoke_elem

invoke_elem(elt)

◦

Invokes any API on the given server.

◦

Creates an input output element for the API to be invoked. All the input elements of the API should be added to this input output element using NaElement. child_add*

Input	Description
elt	An object of NaElement

The NaElement object

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)

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 certificate
key	The name of the file in PEM format that contains the private key The key should not be password protected.

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:

•

TRUE if the server certificate verification is to be enabled.

•

FALSE if the server certificate verification is to be disabled.

NaServer.set_ca_certs

set_ca_certs(CAfile)

Specifies the certificates that belong to the trusted Certificate Authorities, and the certificates that are used to verify the remote server certificate.

Input	Description
CAfile	The name of the file that contains the certificate of the trusted Certificate Authorities in PEM format The file can contain several certificates from the trusted Certificate Authorities.

NaServer.is_server_cert_verification_enabled

is_server_cert_verification_enabled()

Determines whether server certificate verification is enabled or not.

True if server certificate verification is enabled.

False if server certificate verification is not enabled.

NaServer.set_hostname_verification

set_hostname_verification(enable)

Enables or disables hostname verification during server certificate verification.

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.

NaServer.is_hostname_verification_enabled

is_hostname_verification_enabled()

Determines whether hostname verification is enabled.

True if hostname verification is enabled

False if hostname verification is not enabled

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 NaServer.set_application_name()

◦

Empty string if not set

Parent topic: Python Core APIs

Was this topic helpful? Send comments to NetApp.

Copyright © 2017 NetApp, Inc. All rights reserved.