sntl_lmadmin_post

Library Information

>This API belongs to the License Manager administration library.

>The corresponding header is lmadmin.h.

Description

Executes an admin command using the admin context on the targeted Sentinel RMS License Manager.

Syntax

SNTL_DECLARE(sntl_lmadmin_status_t) sntl_lmadmin_post(sntl_lmadmin_context_t   *admin_context,
                                                       const char               *input,	
					  		char                     **status);					

Argument	Description
admin_context [in]	Pointer to the admin context object.
input [in]	Used to provide XML-based input to the API function. This argument is used to identify the client that will be terminated.
status [out]	Pointer to the buffer containing XML-based output. Memory resources are allocated by the API and can be released using the sntl_lmadmin_free API.

Input

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<lmadmin>
	<terminateLoginSession>
		<hostName>CLIENT_HOSTNAME</hostName>
		<userName>CLIENT_USERNAME</userName>
		<xDisplayName>CLIENT_XDISPLAYNAME</xDisplayName>
		<vendorDefinedSharingId>CLIENT_VENDORDEFINEDSHAREID</vendorDefinedSharingId>
	</terminateLoginSession>
</lmadmin>

NOTE   The client macro names in this XML (such as CLIENT_HOSTNAME) should be replaced with actual client identification names. The clientInfo API can be called to obtain the actual values for client macro names.

Argument	Description
hostName	Mandatory parameter; hostname of the machine where the session is running.
userName	Mandatory parameter; username of the machine where the session is running.
xDisplayName	Optional parameter; xDisplayName of the machine where the session is running.
vendorDefinedSharingId	Optional parameter; vendorDefinedSharingId of the machine where the session is running.

Status

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<lmadminResponse>
	<lmadminStatus>
		<code>0</code>
		<text>Keys terminated successfully</text>
	</lmadminStatus>
</lmadminResponse>
</lmadminResponse>

NOTE    The above mentioned output XML is displayed when the sntl_lmadmin_post API successfully terminates all the active client sessions.

The following table lists down the arguments provided by the output XML along with their respective descriptions.

Argument	Description
code	Provides the error code in the output XML regarding the status of the server after successful execution of sntl_lmadmin_post API.
text	Provides the error description in the output XML regarding the status of server after successful execution of sntl_lmadmin_post API.

Returns

The following error/status codes are returned by the output XML of this API.

Code	Text
0	Keys terminated successfully. This requires that the name of the contact server to be specified as NULL, localhost, or loopback address.
410011	Not supported. This may also result when admin_context supplied to this API is created with "IP address" or "hostname" of the License Manager machine.
410012	No resources.
410013	No active keys are available for termination.
410014	Keys terminated successfully with exclusion.
410015	Client is not authorized for terminating keys.

For the complete list of error codes and description, refer to LmAdmin Library Error and Result Codes.