Process Network Server User (QFPADPNU) API


  Required Parameter Group:

1 Option Input Char(10)
2 Profile type Input Char(10)
3 Profile name Input Char(10)
4 Windows domain name Input Char(*)
5 Length of Windows domain name Input Binary(4)
6 Windows server name Input Char(*)
7 Length of Windows server name Input Binary(4)
8 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Process Network Server User (QFPADPNU) API performs an error recovery operation on a selected user or group enrollment entry for a particular Windows domain or server.

Enrollment and unenrollment requests can fail for various reasons. If an enrollment or unenrollment request has failed, the administrator can correct the error and then use this API with the *RETRY option to retry the failed enrollment or unenrollment request. If an unenrollment request has failed and the error cannot be corrected, the administrator can use this API with the *REMOVE option to remove the user or group from the list of enrolled users or groups for a domain or server.


Authorities and Locks

User profile
*READ

Required Parameter Group

Option
INPUT; CHAR(10)

The type of operation to be performed. You must use one of the following options:

*REMOVE This option removes the entry from the list of users or groups that are enrolled to a Windows domain or server. This option is only valid for those entries that are in the process of being unenrolled (status of unenrollment pending, unenrollment retry pending, or unenrollment failed).
For example, if an unenrollment request failed because the server that the user was enrolled to no longer exists, then the administrator could use the *REMOVE option of this API to remove the user from the enrollment list for that server.
*RETRY This option immediately retries the enrollment request to the Windows domain or server. This option is normally used after an enrollment or unenrollment request has failed and the reason for the failure has been corrected.
For example, if an enrollment request failed because the user template does not exist on the server, then the administrator could create the user template and then use the *RETRY option of this API to reattempt the enrollment request.

Profile type
INPUT; CHAR(10)

Whether profile information is for a user profile or group profile. Values can be:

*USER The profile information is for a user profile on the selected domain or server.
*GROUP The profile information is for a group profile on the selected domain or server

Profile name
INPUT; CHAR(10)

The name of the profile to process. Allowable values are:

Profile name Perform the operation for the specified user or group profile.

Usage note: Avoid the use of characters '5B'X, '7B'X, and '7C'X (CCSID 37 characters '$', '#', and '@', respectively) in profile names.

Windows domain name
INPUT; CHAR(*)

The name of the Windows domain to process. Allowable values are:

*NONE No domain is to be processed.
Domain name Perform the operation for the specified domain.

Length of Windows domain name
INPUT; BINARY(4)

The length of the Windows domain name.

Windows server name
INPUT; CHAR(*)

The name of the Windows server to process. Allowable values are:

*NONE No server are to be processed.
Server name Perform the operation for the specified server.

Length of Windows server name
INPUT; BINARY(4)

The length of the Windows server name.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.


Error Messages

Message ID Error Message Text
CPF24B4 E Severe error while addressing parameter list.
CPF2634 E Not authorized to object &1.
CPF3C1D E Length specified in parameter &1 not valid.
CPF3C3C E Value for parameter &1 not valid.
CPF3CF1 E Error code parameter not valid.
CPF3C36 E Number of parameters, &1, entered for this API was not valid.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.
CPF9999 E Function check. &1 unmonitored by &2 at statement &5, instruction &3.


API introduced: V5R1

Top | Server Support APIs | APIs by category