Clear LU6.2 Partners (QTNCLRLU) API
Required Parameter Group:
| 1 | Partner LU remote network identifier | Input | Char(8) |
| 2 | Partner LU location name | Input | Char(8) |
Optional Parameter:
| 3 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Clear LU6.2 Partners (QTNCLRLU) API clears the specified partner logical unit (LU) from the LU6.2 log on this system. In terms of the LU6.2 Peer Protocols, this is known as forcing a cold start with the partner LU during the next connection attempt. This API can be used to eliminate connection problems after the partner LU is moved to a backup system with the same SNA configuration as the original system.
The following informational message is sent to the joblog of the job issuing the API to identify each partner that is cleared:
| CPI83DB | Partner LU &1.&2 cleared. |
Clearing a partner LU will be rejected if there is an active protected conversation between this system and the partner, or if resynchronization to the partner is pending due to a prior communications or system failure. In such cases, the following diagnostic messages will be sent to the joblog to identify any partners that were not cleared, and the API will return error message CPF83EF.
| CPD83C3 | Partner LU &1.&2 not cleared due to active connection. |
| CPD83C4 | Partner LU &1.&2 not cleared due to pending resynchronization. |
Authorities and Locks
- Authority
- *ALLOBJ special authority is required.
- Locks
- None.
Required Parameters
- Partner LU remote network identifier
- INPUT; CHAR(8)
The remote network identifier of the partner that is to be cleared.
*ALL All partners with the specified partner LU location name will be reset. All partners known to this system will be cleared if *ALL is specified for both partner LU remote network identifier and partner LU location name. - Partner LU location name
- INPUT; CHAR(8)
The location name of the partner that is to be cleared.
*ALL All partners with the specified partner LU remote network identifier will be cleared. All partners known to this system will be cleared if *ALL is specified for both partner LU remote network identifier and partner LU location name.
Optional Parameter
- 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 caller of the API.
Usage Notes
This API was designed so that it would be easy to use from a CL command line. For example, the following CL command will clear partner APPC.SYSTEM1 from the LU6.2 log:
CALL PGM(QTNCLRLU) PARM(APPC SYSTEM1)
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3CF1 E | Error code parameter not valid. |
| CPF83ED E | &1 API requires &2 special authority. |
| CPF83EE E | Partner LU &1.&2 is not known to this system. |
| CPF83EF E | At least one partner LU was not cleared. See previous messages. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V5R3
[ Back to top | Journal and Commit APIs | APIs by category ]