Retrieve PPP Connection Profiles (QtocRtvPPPCnnPrf) API
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Profile name | Input | Char(10) |
| 4 | Format name | Input | Char(8) |
| 5 | Error Code | I/O | Char(*) |
Service Program: QTOCPPPAPI
Threadsafe: Yes
The Retrieve PPP Connection Profiles (QtocRtvPPPCnnPrf) API retrieves the details of a specific PPP connection job profile. If the connection profile describes multiple connections, then details of each connection are also retrieved.
Authorities and Locks
None.
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The variable that is to receive the information requested. You can specify the size of this area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable. If the length is larger than the size of the receiver variable, the results may not be predictable. The minimum length is 8 bytes.
- Profile name
- INPUT; CHAR(10)
The name of the PPP connection profile to be returned.
- Format name
- INPUT; CHAR(8)
The format of the retrieved profile to be returned. The format names supported are:
PRFR0100 Connection profile attributes. Refer to PRFR0100 Format for details on the format. PRFR0200 Connection profile static parameters. Refer to PRFR0100 Format and PRFR0200 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 Attributes Information
To retrieve the basic connection profile information and current profile job status, use format PRFR0100. For more detailed profile and connection attributes, use format PRFR0200.
PRFR0100 Format
The following data about a connection profile is returned for the PRFR0100 format. For detailed descriptions of the fields in the table, see PRFR0100 Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Profile mode |
| 12 | C | BINARY(4) | Connection protocol |
| 16 | 10 | BINARY(4) | Connection status |
| 20 | 14 | BINARY(4) | Connection type |
| 24 | 18 | BINARY(4) | Profile job type |
| 28 | 1C | BINARY(4) | Automatic start |
| 32 | 20 | CHAR(10) | Profile name |
| 42 | 2A | CHAR(50) | Profile description |
| 92 | 5C | CHAR(16) | Reserved |
| 108 | 6C | BINARY(4) | Offset to additional information |
| 112 | 70 | BINARY(4) | Length of additional information |
PRFR0100 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. |
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
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 |
| 71 | IPV6CP initializing |
| 72 | IPV6CP starting |
| 73 | IPV6CP ending |
| 74 | IPV6CP stopped |
| 75 | IPV6CP waiting for configuration request |
| 76 | IPV6CP configuring |
| 77 | IPV6CP opening |
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 |
Length of additional information. The length in bytes of additional information returned that is not part of format PRFR0100.
Offset to additional information. The offset in bytes to the rest of the information if a format other than PRFR0100 is requested.
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.
PRFR0200 Format
The following data about a connection profile is returned for the PRFR0200 format. IP address information is IPv4 and IPv6. IPv4 fields are only valid if the "IPv4 Enabled" field is set to 1 (Yes). IPv6 fields are only valid if the "IPv6 Enabled" field is set to 1 (Yes). For detailed descriptions of the fields in the table, see PRFR0200 Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| Decimal and hexadecimal offsets are reached by using the offset to additional information field in format PRFR0100. This applies to all entries below. | Returns everything from format PRFR0100 | ||
| 0 | 0 | BINARY(4) | Move current remote phone number if dial operation is successful |
| 4 | 4 | BINARY(4) | Redial when disconnected |
| 8 | 8 | BINARY(4) | Number of dial attempts |
| 12 | C | BINARY(4) | Delay between dial attempts |
| 16 | 10 | BINARY(4) | Maximum number of connections |
| 20 | 14 | BINARY(4) | Multilink connection enabled |
| 24 | 18 | BINARY(4) | Maximum number of multilink connections |
| 28 | 1C | BINARY(4) | Inactivity timeout |
| 32 | 20 | BINARY(4) | Line definition |
| 36 | 24 | CHAR(10) | Line name |
| 46 | 2E | CHAR(10) | Line type |
| 56 | 38 | CHAR(15) | L2TP tunnel endpoint IP address |
| 71 | 47 | CHAR(5) | Reserved |
| 76 | 4C | BINARY(4) | Local user ID defined |
| 80 | 50 | BINARY(4) | Local user ID encryption type |
| 84 | 54 | CHAR(10) | Local user ID validation list name |
| 94 | 5E | CHAR(6) | Reserved |
| 100 | 64 | BINARY(4) | Remote user ID required for logon |
| 104 | 68 | BINARY(4) | Remote user ID authentication protocols allowed |
| 108 | 6C | BINARY(4) | Remote user ID validation method |
| 112 | 70 | BINARY(4) | Use Radius for connection auditing and accounting |
| 116 | 74 | CHAR(10) | Remote user ID validation list name |
| 126 | 7E | CHAR(6) | Reserved |
| 132 | 84 | BINARY(4) | ASCII CCSID of line data |
| 136 | 88 | BINARY(4) | Connection script file defined |
| 140 | 8C | CHAR(10) | Connection script library |
| 150 | 96 | CHAR(10) | Connection script file |
| 160 | A0 | CHAR(10) | Connection script member |
| 170 | AA | CHAR(2) | Reserved |
| 172 | AC | BINARY(4) | DNS definition |
| 176 | B0 | CHAR(15) | DNS IP address |
| 191 | BF | CHAR(5) | Reserved |
| 196 | C4 | BINARY(4) | Local IP address definition |
| 200 | C8 | CHAR(15) | Local IP address |
| 215 | D7 | CHAR(5) | Reserved |
| 220 | DC | BINARY(4) | Remote IP address definition |
| 224 | E0 | CHAR(15) | Remote IP address (or start of range) |
| 239 | EF | CHAR(5) | Reserved |
| 244 | F4 | BINARY(4) | Allow additional remote IP addresses by user ID |
| 248 | F8 | BINARY(4) | Allow remote system to assign remote IP address |
| 252 | FC | BINARY(4) | Allow IP datagram forwarding |
| 256 | 100 | BINARY(4) | Request VJ header compression |
| 260 | 104 | BINARY(4) | Routing definition |
| 264 | 108 | BINARY(4) | Hide address (full masquerading) |
| 268 | 10C | BINARY(4) | Number of remote IP addresses |
| 272 | 110 | CHAR(4) | Reserved |
| 276 | 114 | CHAR(64) | Line pool list name |
| 340 | 154 | CHAR(10) | Subsystem description |
| 350 | 15E | CHAR(6) | Reserved |
| 356 | 164 | BINARY(4) | Requires IP security protection |
| 360 | 168 | CHAR(40) | IP security connection group |
| 400 | 190 | CHAR(10) | Answer profile this dial-on-demand profile depends on |
| 410 | 19A | CHAR(6) | Reserved |
| 414 | 19E | BINARY(4) | Allow remote system to initate call |
| 418 | 1A2 | BINARY(4) | Allow BACP |
| 422 | 1A6 | BINARY(4) | Add link percentage |
| 426 | 1AA | BINARY(4) | Time to wait (in seconds) for adding a link |
| 430 | 1AE | BINARY(4) | Drop link percentage |
| 434 | 1B2 | BINARY(4) | Time to wait (in seconds) for dropping a link |
| 438 | 1B6 | BINARY(4) | Bandwidth test direction |
| 442 | 1BA | BINARY(4) | Use filter rule |
| 446 | 1BE | CHAR(32) | Filter rule name |
| 478 | 1DE | BINARY(4) | Allow L2TP Multihop connections |
| 482 | 1E2 | BINARY(4) | Allow L2TP outgoing call connections |
| 486 | 1E6 | BINARY(4) | L2TP outgoing call line definition |
| 490 | 1EA | CHAR(10) | L2TP outgoing call line name |
| 500 | 1F4 | CHAR(10) | Reserved |
| 510 | 1FE | BINARY(4) | Offset to profile detailed connection parameter entries |
| 514 | 202 | BINARY(4) | Number of profile detailed connection parameter entries |
| 518 | 206 | BINARY(4) | Entry length of profile detailed connection parameters |
| 522 | 20A | BINARY(4) | Offset to remote phone number entries |
| 526 | 20E | BINARY(4) | Number of remote phone number entries |
| 530 | 212 | BINARY(4) | Entry length of remote phone numbers |
| 534 | 216 | BINARY(4) | PPPoE server addressing |
| 538 | 21A | BINARY(4) | Persistent PPPoE connection |
| 542 | 21E | CHAR(256) | Requested PPPoE server name |
| 798 | 31E | CHAR(256) | Requested PPPoE service |
| 1054 | 41E | CHAR(64) | L2TP Host Name |
| 1118 | 45E | BINARY(4) | IPv4 Enabled |
| 1122 | 462 | BINARY(4) | IPv6 Enabled |
| 1126 | 466 | BINARY(4) | Allow IPv6 datagram forwarding |
| 1130 | 46A | BINARY(4) | IPv6 routing definition |
| 1134 | 46E | BINARY(4) | Advertise default route |
| 1138 | 472 | BINARY(4) | Accept default route |
| 1142 | 476 | BINARY(4) | Advertise DHCPv6 managed address configuration |
| 1146 | 47A | BINARY(4) | Advertise DHCPv6 other configuration |
| 1150 | 47E | BINARY(4) | DNS IPv6 definition |
| 1154 | 482 | CHAR(19) | Address prefix |
| 1173 | 495 | CHAR(1) | Reserved |
| 1174 | 496 | BINARY(8) | Interface identifier |
| 1182 | 49E | CHAR(45) | Local IPv6 address (Dial-on-demand only) |
| 1227 | 4CB | CHAR(45) | DNS IPv6 address |
| 1272 | 4F8 | CHAR(10) | Preferred line description 1 |
| 1282 | 502 | BINARY(4) | Virtual LAN identifier 1 |
| 1284 | 506 | CHAR(10) | Preferred line description 2 |
| 1294 | 510 | BINARY(4) | Virtual LAN identifier 2 |
| 1296 | 514 | CHAR(10) | Preferred line description 3 |
| 1306 | 51E | BINARY(4) | Virtual LAN identifier 3 |
| 1308 | 522 | CHAR(10) | Preferred line description 4 |
| 1318 | 52C | BINARY(4) | Virtual LAN identifier 4 |
PRFR0200 Field Descriptions
Accept default route. Specifies whether the system will accept a default route in a Router Advertisement message received on this link. Valid values are:
| 0 | No |
| 1 | Yes |
Add link percentage. The percentage utilization of the connection before adding another link to a connection. Valid values are:
| 1 |
| 5 |
| 10 |
| 25 |
| 50 |
| 75 |
| 90 (default) |
| 95 |
| 100 |
Address prefix. The 64-bit binary address prefix set in Router Advertisement messages sent on this link.
| hexadecimal-value | Address prefix |
| *NONE | No address prefix is sent in Router Advertisement messages on this link. |
| *PROXY | Neighbor Discovery (ND) Proxy is supported on this link. |
Advertise default route. Specifies whether a default route is set in Router Advertisement messages sent on this link. Valid values are:
| 0 | No |
| 1 | Yes |
Advertise DHCPv6 managed address configuration. Specifies whether the "Managed address configuration" flag (M flag) is set in Router Advertisement messages sent on this link. When the M flag is set, it indicates that addresses are available via Dynamic Host Configuration Protocol (DHCPv6). Valid values are:
| 0 | No |
| 1 | Yes |
Advertise DHCPv6 other configuration. Specifies whether the "Other configuration" flag (O flag) is set in Router Advertisement messages sent on this link. When the O flag is set, it indicates that other configuration information is available via Dynamic Host Configuration Protocol (DHCPv6). Valid values are:
| 0 | No |
| 1 | Yes |
Allow additional remote IP addresses by user ID. Whether additional remote IP addresses may be specified for specific user ID entries. Valid values are:
| 0 | No |
| 1 | Yes |
Allow BACP (Bandwidth Allocation Control Protocol). Whether BACP is allowed/required for this connection. Valid values are:
| 0 | No |
| 1 | Yes |
Allow IP datagram forwarding. Whether IP datagrams not destined for this system should be forwarded. Valid values are:
| 0 | No |
| 1 | Yes |
Allow IPv6 datagram forwarding. Specifies whether IPv6 datagrams received on this link and not destined for this system should be forwarded. Valid values are:
| 0 | No |
| 1 | Yes |
Allow L2TP Multihop connections. Whether L2TP multihop connections are allowed by this profile connection job. Valid values are:
| 0 | No |
| 1 | Yes |
Allow L2TP outgoing call connections. Whether L2TP outgoing call connections are allowed by this profile connection job. Valid values are:
| 0 | No |
| 1 | Yes |
Allow remote system to assign remote IP address. Whether the remote system is allowed to specify the remote IP address for the connection. Valid values are:
| 0 | No |
| 1 | Yes |
Allow remote system to initate call. The remote system is allowed to initate a call for an additional link for the connection. Valid values are:
| 0 | No |
| 1 | Yes |
Answer profile this dial-on-demand profile depends on. The name of the answer profile (connection job) that must be running to answer incoming connections before this profile connection job may be started.
ASCII CCSID of line data. The ASCII Coded Character Set ID of the line data for the connection that will be used to translate connection dialog to and from the EBCDIC character set of the Connection Script used by this profile connection job.
Bandwidth test direction. The data direction on the connection to test the bandwidth for adding and removing links. Valid values are:
| 0 | N/A |
| 1 | Inbound and outbound |
| 2 | Outbound only |
Connection script file. The name of the connection script file that is used by this profile connection job.
Connection script file defined. The connection script file that describes dialog for establishing a connection with the remote system. Valid values are:
| 0 | No |
| 1 | Yes |
Connection script library. The library containing a Connection Script file that is used by this profile connection job.
Connection script member. The member name of the Connection Script file that is used by this profile connection job.
Delay between dial attempts. The time (in seconds) to wait before next attempting to make a successful dialed connection. Valid values are:
| 1 - 60 | (default = 15) |
DNS definition. Whether a Domain Name System (DNS) IP address is to be added to the DNS address list when a connection is established for this profile connection job. Valid values are:
| 0 | DNS not used - no address will be added |
| 1 | By IP address - the IP address is statically specified |
| 2 | Dynamic - the IP address will be supplied by the remote system |
DNS IP address. The IP address of the DNS used by this profile connection job.
DNS IPv6 definition. Specifies whether a Domain Name System (DNS) IPv6 address is to be added to the DNS address list when an IPv6 connection is established for this profile connection job. Valid values are:
| 0 | DNS not used - no address will be added |
| 1 | By IP address - the IP address is statically specified |
DNS IPv6 address. The 128-bit binary IPv6 address of the DNS used by this profile connection job when an IPv6 connection is established.
| 64-bit value | The configured interface identifier. |
Drop link percentage. The percentage utilization of the connection before dropping a link of a connection. Valid values are:
| 1 |
| 5 |
| 10 |
| 25 |
| 40 (default) |
| 75 |
| 90 |
| 95 |
| 100 |
Entry length of profile detailed connection parameters. The length in bytes of each profile detailed connection parameter entry returned for this profile. A value of zero is returned if the list is empty.
Entry length of remote phone numbers. The length in bytes of each remote phone number entry returned for this profile. A value of zerois returned if the list is empty.
Filter rule name.The name of the filter rule to be used by this connection profile.
Hide address (full masquerading). Whether all other IP addresses should be hidden by the IP address of the PPP connections established by this profile connection job. Valid values are:
| 0 | No |
| 1 | Yes |
Inactivity timeout. The value used for the inactivity timeout in the line description. Valid values are 15 - 65535 seconds.
Interface identifier. The 64-bit interface identifier used as a starting value for IPV6CP negotiation on this link.
IP security connection group. The name of the connection group that describes the IP Security details for connections established by this profile connection job.
IPv4 enabled. Specifies whether an attempt is made to establish an IPv4 connection when this connection profile is activated. If this field is set to 1 (Yes), then IPv4-related PRFR0200 fields have valid values. Valid values are:
| 0 | No |
| 1 | Yes |
IPv6 enabled. Specifies whether an attempt is made to establish an IPv6 connection when this connection profile is activated. If this field is set to 1 (Yes), then IPv6-related PRFR0200 fields have valid values. Valid values are:
| 0 | No |
| 1 | Yes |
IPv6 routing definition. The additional routing requested when activating this profile connection job and an IPv6 connection is established. Valid values are:
| 0 | Not Used |
| 1 | Add default route |
| 2 | Additional static routes defined |
L2TP host name. The host name or IP address of the remote end of the tunnel for an L2TP initiator profile or the host name or IP address of the local end of the tunnel for an L2TP terminator profile. This field should be used instead of the L2TP tunnel endpoint address field.
L2TP outgoing call line definition. The line type to be used by this profile connection job for L2TP outgoing calls. Valid values are:
| 1 | Single line |
| 2 | LinePool (single line) |
| 5 | ISDN line |
L2TP outgoing call line name. The name of the line to be used by this profile connection job for L2TP outgoing calls.
L2TP tunnel endpoint address. The IP address of the remote end of the tunnel for an L2TP initiator profile or the IP address of the local end of the tunnel for an L2TP terminator profile. Usage of this field is deprecated and the L2TP host name field should be used instead.
Length of additional information. The length in bytes of additional information returned if format PRFR0300 is requested.
Line definition. The line selection method used by this profile connection job. Valid values are:
| 1 | Specified line name |
| 2 | LinePool (single line) |
| 3 | LinePool (all) |
| 5 | ISDN line |
| 6 | L2TP line |
| 7 | PPPOE virtual line |
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 pool list name. The name of the Line Pool list that contains the names of line descriptions available for use by this profile connection job.
Line type. The type of line connection defined in this connection profile. Possible values are:
| *PPP | PPP line description |
| *POOL | Line name is a member of a line pool |
| *ISDN | ISDN line description |
| *L2TP | L2TP line description |
| *PPPOE | PPPoE line description |
| *ERROR | The selected line type is undefined or is improperly defined |
Local IP address. The local IP address defined for connections established by this profile connection job.
Local IP address definition. How a local IP address is defined for connections established by this profile connection job. Valid values are:
| 0 | By IP address - the IP address is statically specified |
| 1 | By IP address - the IP address is statically specified |
| 2 | Dynamic - the IP address will be negotiated with the remote system |
Local IPv6 address. The 128-bit binary local IPv6 address used by this profile connection job. This field is only valid for dial-on-demand connection profiles.
Local user ID defined. The User ID that is defined if authentication is required by the remote system. Valid values are:
| 0 | No |
| 1 | Yes |
Local user ID encryption type. The encryption method for the local system user name and password when authenticating with the remote system. Valid values are:
| 0 | Undefined |
| 1 | PAP only |
| 2 | CHAP only |
| 3 | EAP only |
Local user ID validation list name. The name of the validation list containing the local User ID and password when authenticating with the remote system.
Maximum number of connections. The maximum number of connections supported by this PPP job profile.
Maximum number of multilink connections. The maximum number of physical connections connections that can be bundled into a single multi-linked connection.
Move current remote phone number if dial operation is successful. Whether the current remote phone number should be moved if the call attempt is successful. Valid values are:
| 0 | N/A |
| 1 | Do NOT move number (default for non-multilink connections) |
| 2 | Move number to the top of the list (default for multilink connections) |
| 3 | Move number to the bottom of the list |
Multilink connection enabled. Whether multilink connections are enabled for the profile. Values are:
| 0 | No |
| 1 | Yes |
Number of profile detailed connection parameter entries. The number of profile detailed connection parameter entries returned for this profile. A value of zero is returned if the list is empty.
Number of remote phone number entries. The number of remote phone number entries returned for this profile. A value of zero is returned if the list is empty.
Number of remote IP addresses. The number of IP addresses derived from the Remote IP start address defined for this profile connection job.
Number of dial attempts. The total number of dial attempts to achieve a successful connection.
Offset to additional information. The offset in bytes to the rest of the information if format PRFR0300 is requested.
Offset to profile detailed connection parameter entries. The offset from the beginning of the receiver variable, in bytes, to the first element in the profile detailed connection parameter entries returned for this profile. A value of zero is returned if the list is empty.
Offset to remote phone number entries. The offset from the beginning of the receiver variable, in bytes, to the first element in the remote phone number entries returned for this profile. A value of zero is returned if the list is empty.
Persistent PPPoE connection. Whether PPPoE connections for this profile are re-established when lost unexpectedly. Values are:
| 0 | No |
| 1 | Yes |
PPPoE server addressing. Describes the method used to select a PPPoE server connection. Valid values are:
| 0 | Undefined |
| 1 | Connect to the default service of the first server that replies (default) |
| 2 | Connect to the default service of the requested server |
| 3 | Connect to the first server offering the requested service |
| 4 | Connect to the requested server offering the requested service |
Preferred line description. The name of the line description that Neighbor Discovery (ND) Proxy processing prefers for the upstream interface. A value of *NONE indicates that this preferred line description has not been specified.
Re-dial when disconnected. Whether a dialed connection established by this profile connection job will be redialed if the connection is lost unexpectedly. Valid values are:
| 0 | No |
| 1 | Yes |
Remote IP address definition. How a remote IP address is defined for connections established by this profile connection job. Valid values are:
| 1 | By IP address - the IP address is statically specified |
| 2 | Dynamic - the IP address will be negotiated with the remote system |
| 3 | Route specified - the IP address is specified by remote user |
| 4 | Address pool - the IP address will be selected from the address pool |
| 5 | DHCP - the IP address will be supplied by the DHCP server |
| 6 | Radius - the IP address will be supplied by the Radius server |
Remote IP address (or start of IP address pool). The remote IP address (or starting IP address for multi-connection profiles) defined for connections established by this profile connection job.
Remote user ID authentication protocols allowed. The allowable protocols for remote user ID authentication. Valid values are:
| 0 | N/A |
| 1 | CHAP and PA |
| 2 | CHAP only |
| 3 | PAP only |
| 4 | EAP only |
| 5 | EAP and PAP |
| 6 | EAP and CHAP |
| 7 | EAP, CHAP, and PAP |
Remote user ID required for logon. Remote User ID authentication is required for logon to the local system. Valid values are:
| 0 | No |
| 1 | Yes |
Remote user ID validation method. The method for validation of the remote user ID. Valid values are:
| 0 | N/A |
| 1 | Validation list |
| 2 | Radius |
Remote user ID validation list name. The name of the Validation list containing the remote User ID and password for authenticating the connection with the remote system.
Requested PPPoE server name. The PPPoE server name requested for this PPPoE initiator profile to negotiate the remote end of the connection.
Requested PPPoE service. The PPPoE service requested for this PPPoE initiator profile to negotiate with the remote end of the connection.
Request VJ header compression. Whether VJ header compression should be performed on IP datagrams. Valid values are:
| 0 | No |
| 1 | Yes |
Requires IP security protection . Whether IP security is required for connections established by this profile connection job. Valid values are:
| 0 | No |
| 1 | Yes |
Routing definition. The additional routing requested when activating this profile connection job. Valid values are:
| 0 | Not Used |
| 1 | Add default route |
| 2 | Additional static routes defined |
Subsystem description. The name of the subsystem description in which the connection jobs for this profile connection job will be run.
Time to wait (in seconds) for adding a link. The time (in seconds) to wait before adding an additional link after the connection utilization has exceeded the specified percentage. Valid values are:
| 5 - 3600 | (in increments of 5, default = 15) |
Time to wait (in seconds) for dropping a link. The time (in seconds) to wait before dropping a link after the connection utilization has receeded below the specified percentage. Valid values are:
| 5 - 3600 | (in increments of 5, default = 15) |
Use filter rule. Whether a filter rule should be used by the profile connection job. Valid values are:
| 0 | No |
| 1 | Yes |
Use Radius for connection auditing and accounting. Whether Radius should be used for connection auditing and accounting. Valid values are:
| 0 | No |
| 1 | Yes |
Virtual LAN identifier. The virtual LAN identifier for the associated line description.
| 0 | Not used |
| 1 - 4094 | Virtual LAN identifier |
Connection Profile Detailed Parameters
The following data is returned for each profile detailed connection parameter entry, describing one connection for a profile. Multiple connection profiles may have one entry for each connection. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Connection status |
| 4 | 4 | BINARY(4) | Maximum transmission unit (MTU) |
| 8 | 8 | BINARY(4) | Maximum links per multilink connection bundle |
| 12 | C | BINARY(4) | Number of active links |
| 16 | 10 | BINARY(4) | Line inactivity timeout |
| 20 | 14 | CHAR(4) | Reserved |
| 24 | 18 | CHAR(6) | Job number |
| 30 | 1E | CHAR(10) | Job user |
| 40 | 28 | CHAR(10) | Job name |
| 50 | 32 | CHAR(10) | Line name |
| 60 | 3C | CHAR(15) | Active local IP address (set when profile is active) |
| 75 | 4B | CHAR(15) | Active remote IP address (set when profile is active) |
| 90 | 5A | CHAR(6) | Reserved |
| 96 | 60 | CHAR(48) | Remote user name |
| 144 | 90 | CHAR(64) | Group access policy |
| 208 | D0 | CHAR(32) | Filter rule name |
| 240 | F0 | CHAR(1) | IPv4 forwarding |
| 241 | F1 | CHAR(1) | Proxy ARP routing |
| 242 | F2 | CHAR(1) | TCP/IP header compression |
| 243 | F3 | CHAR(1) | Full masquerading |
| 244 | F4 | CHAR(1) | Authentication protocol |
| 245 | F5 | CHAR(1) | Multilink protocol enabled |
| 246 | F6 | CHAR(1) | Multilink bandwidth utilization monitoring enabled |
| 247 | F7 | CHAR(1) | Reserved |
| 248 | F8 | BINARY(4) | Detailed connection status |
| 252 | FC | CHAR(8) | Thread ID |
Field Descriptions
Active (binary) local IPv4 address. The binary local IPv4 address of the connection established by this profile connection job.
Active (binary) remote IPv4 address. The binary remote IPv4 address of the connection established by this profile connection job.
Authentication protocol. The authentication protocol that was negotiated for this profile connection. Valid values are:
| 0 | N/A |
| 1 | CHAP and PAP |
| 2 | CHAP only |
| 3 | PAP only |
| 4 | EAP only |
| 5 | EAP and PAP |
| 6 | EAP and CHAP |
| 7 | EAP, CHAP, and PAP |
Connection status. The current status of this profile connection. Valid values are:
| 0 | N/A |
| 1 | Inactive or ended |
| 2 | Ending |
| 3 | Starting |
| 4 | Waiting for connection |
| 5 | Connecting |
| 6 | Active |
Detailed connection status. Additional detail of the current status of this profile connection. Valid values are:
| 0 | No status set |
| 256 | Undefined |
| 257 | Connection operational |
| 258 | Initializing connection to modem |
| 259 | Initializing connection data structures |
| 260 | Selecting a line from a line pool |
| 261 | Requesting a shared line from current owner |
| 262 | Waiting for shared line to be available |
| 263 | Initializing modem |
| 264 | Incoming call detected |
| 265 | Dial on-demand connection requested |
| 266 | Waiting for modem to connect |
| 267 | Redialing remote system |
| 268 | Modem connected |
| 269 | Modem disconnected |
| 270 | Authenticating remote user |
| 271 | Negotiating IP address |
| 272 | Activating IP address |
| 273 | Modem or resource failure |
| 274 | Connection profile setings failure |
| 275 | Authentication failure |
| 276 | Modem failure |
| 277 | Retry threshold failure |
| 278 | Remote phone number busy |
| 279 | No local dial tone detected |
| 280 | Remote modem did not answer |
| 281 | IP address activation failure |
| 282 | PPP protocol rejected |
| 283 | PPP connection inactivity timeout |
| 300 | Sent PPPoE initiation packet |
| 301 | Received PPPoE offer from peer |
| 302 | Sent PPPoE request packet to peer |
| 303 | Received PPPoE session-confirmation from peer |
| 304 | Sent PPPoE termination packet to peer |
| 350 | Received PPPoE termination from peer |
| 351 | No response from PPPoE peer |
| 352 | PPPoE peer response did not match request sent |
| 353 | Received error from PPPoE peer |
| 354 | Unable to open communication stream |
| 355 | Unable to send packet to PPPoE peer |
| 356 | Unable to convert packet data |
| 357 | PPPoE link error |
| 400 | Starting L2TP tunnel negotiation |
| 401 | L2TP tunnel negotiation in progress |
| 402 | L2TP tunnel established |
| 403 | Starting L2TP call negotiation |
| 404 | Starting L2TP remote call negotiation |
| 405 | L2TP call established |
| 450 | L2TP tunnel authentication failed |
| 451 | L2TP tunnel maximum connections exceeded |
| 452 | Sent stop L2TP tunnel message to peer |
| 453 | Received stop L2TP tunnel message from peer |
| 454 | L2TP call maximum connections exceeded |
| 455 | Sent stop L2TP call message to peer |
| 456 | Received stop L2TP call message from peer |
Filter rule name. The name of the filter rule that is in effect for this profile connection. A value *NONE means that no filter rule is in use.
Full masquerading. Whether full masquerading is in effect for this profile connection. Valid values are:
| 0 | No |
| 1 | Yes |
Group access policy. The name of the group access policy that is in effect for this profile connection. A value *NONE means that no group policy is in use.
IP forwarding. Whether IP forwarding is active for this profile connection. Valid values are:
| 0 | No |
| 1 | Yes |
Job name. The job name of this profile connection job.
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 this profile connection job.
Job user. The job user name of this profile connection job.
Line name. The name of the line description used for this profile connection.
Line inactivity timeout. The value used for the inactivity timeout in the line description. Valid values are 15 - 65535 seconds.
Maximum links per multilink connection bundle. The maximum number of links allowed per bundle for multilink connections for this profile.
Maximum transmission unit. The maximum size of IP datagrams that can be sent over connections started by this profile connection job. This value is valid only when the profile is active.
Multilink protocol enabled. Whether multilink connections are allowed for this connection profile. Valid values are:
| 0 | No |
| 1 | Yes |
Multilink bandwidth utilization monitoring enabled. Whether bandwidth utilization monitoring is enabled for this profile connection. Valid values are:
| 0 | No |
| 1 | Yes |
Number of active links. The number of active links that constitute this profile connection.
Proxy ARP routing. Whether proxy ARP routing is in effect for this profile connection. Valid values are:
| 0 | No |
| 1 | Yes |
Remote user name. The name of the connected remote user that was authenticated for this profile connection. This value is valid only when authentication is enabled for this connection profile.
TCP/IP header compression. Whether TCP/IP header compression will be performed for this profile connection. Valid values are:
Thread ID.The thread id under which the connection is running in the point-to-point job.
| 0 | No |
| 1 | Yes |
Error Messages
| Message ID | Error Message Text |
|---|---|
| TCP8211 E | Point-to-point profile &1 not found |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended, reason code &3. |
API introduced: V5R1
| Top | Communications APIs | APIs by category |