List PPP Connection Profiles (QtocLstPPPCnnPrf) API
| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | Error Code | I/O | Char(*) |
Service Program: QTOCPPPAPI
Threadsafe: Yes
The List PPP Connection Profiles API (QtocLstPPPCnnPrf) returns a list of PPP connection profiles with some basic information about each profile.
Authorities and Locks
- User Space Library Authority
- *EXECUTE
- User Space Authority
- *CHANGE
- User Space Lock
- *SHRNUP
Required Parameter Group
- Qualified user space name
- INPUT; CHAR(20)
The user space for which you want to retrieve information, and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the library name. You can use these special values for the library name:
*CURLIB The job's current library *LIBL The library list
- Format name
- INPUT; CHAR(8)
The format of the space information to be returned. The format names supported are:
PRFD0100 Connection profile lists. Refer to PRFD0100 Format for details on the format.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format of Connection Profile Lists
To request a list of PPP Connection Profiles, use format PRFD0100.
The PPP Connection Profile list consists of:
- A user area
- A generic header
- An input parameter section
- A header section
- A list data section:
- PRFD0100 format
For details about the user area and generic header, see User spaces. For details about the remaining items, see the following sections.
When you retrieve list entry information from a user space, you must use the entry size returned in the generic header. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid. For examples of how to process lists, see Examples: APIs and exit programs.
Input Parameter Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name specified |
| 10 | A | CHAR(10) | User space library name specified |
| 20 | 14 | CHAR(8) | Format name specified |
Header Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name |
| 10 | A | CHAR(10) | User space library name used |
PRFD0100 Format
The following data about a PPP Connection Profile is returned for the PRFD0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Profile mode |
| 4 | 4 | BINARY(4) | Connection protocol |
| 8 | 8 | BINARY(4) | Connection status |
| 12 | C | BINARY(4) | Connection type |
| 16 | 10 | BINARY(4) | Profile job type |
| 20 | 14 | BINARY(4) | Multilink connection enabled |
| 24 | 18 | CHAR(10) | Profile name |
| 34 | 22 | CHAR(10) | Line name |
| 44 | 2C | CHAR(10) | Line type |
| 54 | 36 | CHAR(10) | Job name |
| 64 | 40 | CHAR(10) | Job user profile |
| 74 | 4A | CHAR(6) | Job number |
| 80 | 50 | CHAR(50) | profile description |
| 130 | 82 | CHAR(10) | Dial-on-demand peer answer profile |
| 140 | 8C | BINARY(4) | Automatic start |
| 144 | 90 | CHAR(8) | Thread ID |
| 152 | 98 | CHAR(8) | Reserved |
Field Descriptions
Automatic start. Whether the profile is started automatically when the TCP/IP stack is activated. Possible values are:
| 0 | NO. This profile is not started automatically. |
| 1 | YES. This profile is started automatically. |
Connection protocol. The type of point-to-point connection provided by the profile job.
| 1 | SLIP. |
| 2 | PPP. |
Connection status. The current connection of job status of the profile job.Values are as follows:
| 1 | Inactive |
| 2 | Session error |
| 3 | Ended - information available |
| 4 | Session start submitted |
| 11 | Session job starting |
| 12 | Session job ending |
| 13 | Session ended - job log pending |
| 14 | Adding TCP/IP configuration |
| 15 | Removing TCP/IP configuration |
| 16 | Message pending |
| 17 | Session error |
| 18 | Starting TCP/IP |
| 19 | Ending TCP/IP |
| 21 | Calling remote system |
| 22 | Waiting for incoming call |
| 23 | Connecting |
| 24 | Active |
| 26 | Switched line-dial on demand |
| 27 | Waiting for incoming call - switched line-answer enabled dial on demand |
| 28 | Waiting for shared line resource |
| 29 | Requesting shared line resource |
| 31 | LCP initializing |
| 32 | LCP starting |
| 33 | LCP closing |
| 34 | LCP closed |
| 35 | LCP waiting for configuration request |
| 36 | LCP configuring |
| 37 | LCP authenticating |
| 41 | IPCP initializing |
| 42 | IPCP starting |
| 43 | IPCP ending |
| 44 | IPCP stopped |
| 45 | IPCP waiting for configuration request |
| 46 | IPCP configuring |
| 47 | IPCP opening |
| 51 | Multi-connection - waiting for incoming call(s) |
| 52 | Multi-connection L2TP initiator waiting for tunnel |
| 53 | Multi-connection - at least one connection active |
| 54 | Multi-hop terminator starting multi-hop initiator |
| 55 | Multi-hop initiator establishing second hop tunnel |
| 56 | Multi-hop initiator tunnel pre-started |
| 57 | Multi-hop connection active |
| 58 | Starting VPN connection |
| 59 | Negotiating IPSEC SA |
| 60 | PPPoE discovery stage |
| 61 | PPPoE session stage |
Connection type. The type of connection provided by the profile job. Values are:
| 1 | Switched or dialed connection |
| 2 | Leased or non-switched connection |
| 3 | Virtual circuit connection |
| 4 | PPPoE |
Dial-on-demand peer answer profile. Specifies the name of the answer only profile that answers incoming calls from the remote peer.
Job name. The job name of the job that currently or most recently executed this profile job description. This field is blank if this connection profile job has not been run.
Note that the connection job may not be unique. That is, multiple connections can share a single job by running in separate threads.
Job number. The job number of the job that currently or most recently executed this profile job description. This field is blank if this connection profile job has not been run.
Job user profile. The user profile of the job that currently or most recently executed this profile job description. This field is blank if this connection profile job has not been run.
Line name. Each TCP/IP interface is associated with a physical network. This field displays the name of the communications line description that identifies the physical network associated with an interface. May be blank when Line type selection is *LINEPOOL and no member line has been selected.
Line type. The type of line connection defined in this connection profile. Possible values are:
| *PPP | PPP line description |
| *LINEPOOL | Line name is a member of a line pool |
| *L2TP | L2TP line description |
| *PPPOE | PPPoE line description |
| *ERROR | The selected line type is undefined or is improperly defined |
Multilink connection enabled. Whether multilink connections are enabled for the profile. Values are:
| 0 | No |
| 1 | Yes |
Profile description. The text description of the function performed by this profile connection job.
Profile job type. The type of job support required for the profile.
| 1 | Single connection profile |
| 2 | Multi-connection or multilink connection profile |
Profile mode. The function provided by the profile job. Values are:
| 1 | Dial only. |
| 2 | Answer only. |
| 3 | Dial-on-demand. |
| 4 | Answer enabled dial-on-demand. |
| 5 | L2TP virtual Initiator. |
| 6 | Remote peer enabled dial-on-demand. |
| 7 | L2TP initiator-on-demand. |
| 8 | L2TP multihop initiator. |
| 9 | PPPoE initiator. |
Profile name. The name of this connection profile description.
Reserved. An ignored field.
Thread ID. The thread id under which the connection is running in the point-to-point job.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3CAA E | List is too large for user space &1. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF811A E | User space &4 in &9 damaged. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V5R1