Retrieve Controller Description (QDCRCTLD) API

The Retrieve Controller Description (QDCRCTLD) API retrieves information about a controller description.

Authorities and Locks

Controller Description Authority

*USE

Device Description Authority

*USE

Controller Description Lock

*EXCLRD

Device Description Lock

*EXCLRD

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The variable that is to receive the controller information.

Length of receiver variable

INPUT; BINARY(4)

The length of the area referenced by the receiver variable parameter. If the amount of information to be returned is greater than this value, the information will be truncated to this length.

Format name

INPUT; CHAR(8)

The content and format of the information returned for each controller description. The possible format names are:

CTLD0100	Basic controller information.
CTLD0200	Basic controller information, plus list of attached devices.
CTLD0300	Detailed information for controller category *APPC
CTLD0400	Detailed information for controller category *ASC
CTLD0500	Detailed information for controller category *BSC
CTLD0600	Detailed information for controller category *FNC
CTLD0700	Detailed information for controller category *HOST
CTLD0800	Detailed information for controller category *NET
CTLD0900	Detailed information for controller category *RTL
CTLD1000	Detailed information for controller category *RWS
CTLD1100	Detailed information for controller category *VWS
CTLD1200	Detailed information for controller category *LWS
CTLD1300	Detailed information for controller category *TAP

See Format of Controller Information for a description of these formats.

Controller name

INPUT; CHAR(10)

The name of the controller description to be retrieved.

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 Controller Information

When the controller category is unknown, specify CTLD0100 or CTLD0200 and the basic information (including controller category) will be returned. When the controller category is known, specify one of the other category-specific formats.

For detailed descriptions of the fields returned in these formats, see Field Descriptions.

CTLD0100 Format

Use this format to find out the controller category, plus some very basic information about the controller. Then you may use the returned controller category to select one of the other (category-specific) formats to call the API again for detailed information about the controller description. This format also returns the number of devices currently attached to this controller.

CTLD0200 Format

This format returns basic controller information, plus a list of attached devices. Some basic information is also included for each attached device.

CTLD0300 Format

This format returns detailed information about a controller of category *APPC.

CTLD0400 Format

This format returns detailed information about a controller of category *ASC.

CTLD0500 Format

This format returns detailed information about a controller of category *BSC.

CTLD0600 Format

This format returns detailed information about a controller of category *FNC.

CTLD0700 Format

This format returns detailed information about a controller of category *HOST.

CTLD0800 Format

This format returns detailed information about a controller of category *NET.

CTLD0900 Format

This format returns detailed information about a controller of category *RTL.

CTLD1000 Format

This format returns detailed information about a controller of category *RWS.

CTLD1100 Format

This format returns detailed information about a controller of category *VWS.

CTLD1200 Format

This format returns detailed information about a controller of category *LWS.

CTLD1300 Format

This format returns detailed information about a controller of category *TAP.

Field Descriptions

Some of the fields in the various formats returned by this API are described in greater detail in the documentation for the particular CL command that was used to create the controller description object. See CL command finder. They are also described in the online help for the particular command. For these fields, the CL parameter keyword is specified in parentheses following the field name. The CL command name is specified in the field description.

In certain cases, numeric values are assigned by this API to represent character values for some of the returned fields. Where a numeric value is assigned, the numeric value and the equivalent character value are listed as an Exception in the following field descriptions.

Activate switched network backup. Shows whether the switched network backup is activated.

Activate X.25 network address. The current X.25 network address for active X.25 controller descriptions.

Activation timer (ACTTMR). This timer is used when the system attempts to activate a session to the remote dependent-logical-unit-server (DLUS) node (initial connection *DIAL). It is the amount of time this system will wait for an answer from the remote DLUS. (See the ACTTMR parameter in the CRTCTLHOST command.)

Active switched line. The switched line that is active and that the controller is using for communications. If no switched line is active, the value in this field is blanks.

Adjacent link station (ADJLNKSTN). The link station name of the adjacent system. (See the ADJLNKSTN parameter in the CRTCTLHOST command.)

Allocation retry timer (ALCRTYTMR). The time to wait between attempts to activate devices associated with this controller. (See the ALCRTYTMR parameter in the CRTCTLRWS command.)

Answer number (ANSNBR). The X.25 network addresses from which this controller can accept calls. (See the ANSNBR parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

APPC CP session support (CPSSN). Whether this controller supports control point-to-control point sessions. (See the CPSSN parameter in the CRTCTLAPPC or CRTCTLHOST command.)

Application type (APPTYPE). The type of application that this controller is to be used for. (See the APPTYPE parameter in the CRTCTLBSC command.)

APPN capable (APPN). Whether the local system appears to the adjacent system as either a network node or an end node in the local system network attributes, or the local system appears to the adjacent system as a low-entry networking node. (See the APPN parameter in the CRTCTLAPPC or CRTCTLHOST command.)

APPN/HPR capable (HPR). Whether to use APPN high-performance routing (HPR) support. (See the HPR parameter in the CRTCTLAPPC or CRTCTLHOST command.)

APPN minimum switched status (MINSWTSTS). The minimum status required for this controller description to be considered eligible for APPN routing. (See the MINSWTSTS parameter in the CRTCTLAPPC or CRTCTLHOST command.)

APPN transmission group number (TMSGRPNBR). The value to be used by the APPN support for transmission group negotiation with the remote system. (See the TMSGRPNBR parameter in the CRTCTLAPPC or CRTCTLHOST command.)

Exception:

• Value of -11 implies *CALC

Associated APPC device. The APPC device associated with the remote workstation controller description. This is the device name that is displayed when F15 (Display associated APPC device) is used on the Display Controller Description (DSPCTLD) command. If there is no associated APPC device, the value in this field is blanks.

Attached device name (DEV). The name of one or more devices to be attached to this controller. (See the DEV parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLLWS, CRTCTLNET, CRTCTLRTL, CRTCTLRWS, CRTCTLTAP, or CRTCTLVWS command.)

Attached line. For network controllers, the name of the line that connects the network to the system.

Attached nonswitched line name (LINE). The name of the line description that connects the network to the system. (See the LINE parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLNET, CRTCTLRTL, or CRTCTLRWS command.)

Autocreate device (AUTOCRTDEV). Which devices are automatically created. (See the AUTOCRTDEV parameter in the CRTCTLAPPC, CRTCTLHOST, or CRTCTLRWS command.)

Autodelete device (AUTODLTDEV). The number of minutes an automatically created device can remain in an idle state with no bound sessions and no active conversations on the device. (See the AUTODLTDEV parameter in the CRTCTLAPPC or CRTCTLHOST command.)

Exception:

• Value of -2 implies *NO

Automatic configuration. Whether this controller has been configured 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.

Backup DLUS name--network ID (BKUDLUS). The backup DLUS network ID. This is the network ID of the APPN network (subnet) that the remote DLUS resides in. It is the network-qualified CP name of the remote DLUS (SSCP) that the System i™ dependent-logical-unit-requester (DLUR) host controller communicates with in the absence of the primary DLUS node (See the BKUDLUS parameter in the CRTCTLHOST command.)

Backup DLUS name--PU name (BKUDLUS). The backup DLUS name. This is the physical unit name of the remote DLUS. This is the network-qualified CP name of the remote DLUS (SSCP) that the System i DLUR host controller communicates with in the absence of the primary DLUS node (See the BKUDLUS parameter in the CRTCTLHOST command.)

Branch extender role (BEXROLE). The role of the the local system in an APPN network for the remote controller being configured. This parameter is used only when the local system supports the branch extender function. (See the BEXROLE parameter in the CRTCTLAPPC or CRTCTLHOST command.)

Character code (CODE). The type of character code (EBCDIC or ASCII) used to send the information in a remote work station data stream over the communications line. (See the CODE parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Connection list (CNNLSTOUT). The name of a connection list containing the network-assigned numbers used for outgoing calls on this controller. (See the CNNLSTOUT parameter in the CRTCTLAPPC, CRTCTLHOST, or CRTCTLRWS command.)

Note: This field is no longer supported as of V5R3M0.

Connection list entry (CNNLSTOUTE). The name of the connection list entry containing the network-assigned numbers used for outgoing calls on this controller. (See the CNNLSTOUTE parameter in the CRTCTLAPPC, CRTCTLHOST, or CRTCTLRWS command.)

Note: This field is no longer supported as of V5R3M0.

Connection network CP name (CNNCPNAME). The name of the connection network control point. (See the CNNCPNAME parameter in the CRTCTLAPPC command.)

Connection network identifier (CNNNETID). The name of the connection network identifier. (See the CNNNETID parameter in the CRTCTLAPPC command.)

Connection number (CNNNBR). The number (for a switched connection or a nonswitched connection with switched network backup) of the remote controller that is called from the system to establish a connection. (See the CNNNBR parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Connection response timer (CNNRSPTMR). The amount of time to wait for a response to an incoming connection request. (See the CNNRSPTMR parameter in the CRTCTLNET command.)

Connection type (CNN). The type of connection this BSC controller will be used on. (See the CNN parameter in the CRTCTLBSC command.)

Control owner. Whether this description is owned by the system or the user. *USER identifies the user as the owner, and *SYS identifies the system as the owner. If the system is the control owner, the user cannot make any changes to the description.

Controller category. This value will be one of the following:

• *APPC
• *ASC
• *BSC
• *FNC
• *HOST
• *LWS
• *NET
• *RTL
• *RWS
• *TAP
• *VWS

The category value is derived from the command used to create the controller description.

Controller model (MODEL). The model number of the controller. (See the MODEL parameter in the CRTCTLFNC, CRTCTLLWS, CRTCTLRTL, CRTCTLRWS, or CRTCTLTAP command.)

Controller name (CTLD). The name of the controller description. (See the CTLD parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLLWS, CRTCTLNET, CRTCTLRTL, CRTCTLRWS, CRTCTLTAP, or CRTCTLVWS command.)

Controller type (TYPE). The type of controller being described. (See the TYPE parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLLWS, CRTCTLRTL, CRTCTLRWS, or CRTCTLTAP command.)

Cost/byte. The cost of sending and receiving data over the link. (See the LDLCTMSGRP parameter in the CRTCTLAPPC command.)

Cost/connect time. The cost of being connected over the link. (See the LDLCTMSGRP parameter in the CRTCTLAPPC command.)

Current maximum frame size. The maximum frame size that is currently being used by this controller. This field is only valid for controllers that have been varied on and are connected to a LAN.

Current message queue (MSGQ). The message queue to which messages are currently being sent using this controller description. This field is valid only for controllers that are varied on. Note that the value of the current message queue may be different from the message queue field (MSGQ parameter) under certain error conditions. (See the MSGQ parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLHOST, CRTCTLLWS, CRTCTLRWS, or CRTCTLVWS command.) This information is returned in two separate fields:

• Name of the queue
• Library in which the queue can be found

Data link role (ROLE). Whether the remote system is primary, secondary, or dynamically negotiates its role. (See the ROLE parameter in the CRTCTLAPPC command.)

Date information retrieved. The date that the information was provided by the API. This is returned as 7 characters in the form CYYMMDD, where:

Default packet size (DFTPKTSIZE). The default packet size to use on the virtual circuit represented by this controller. This information is returned in two separate fields:

• Transmit
• Receive

(See the DFTPKTSIZE parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exceptions:

• Value of -10 implies *TRANSMIT
• Value of -16 implies *LIND

Default window size (DFTWDWSIZE). The default window size to use on the virtual circuit represented by this controller. This information is returned in two separate fields:

• Transmit
• Receive

(See the DFTWDWSIZE parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exceptions:

• Value of -10 implies *TRANSMIT
• Value of -16 implies *LIND

Dependent PU name. The dependent location name that is used for DLUR, which provides additional security for the connection.

Destination service access point (DSAP). The logical address that this system will send to when it communicates with the remote controller. (See the DSAP parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Device category. This value will be one of the following:

• *APPC
• *ASC
• *ASP
• *BSC
• *CRP
• *DKT
• *DSP
• *FNC
• *HOST
• *INTR
• *MLB
• *NET
• *OPT
• *PRT
• *RTL
• *SNPT
• *SNUF
• *TAP

The category value is derived from the command used to create the device description.

Device name. The name of a device associated with this controller.

Device text description. A brief description of a device associated with this controller.

Device type (TYPE). The type of device being described. (See the TYPE parameter in the CRTDEVDSP, CRTDEVFNC, CRTDEVMLB, CRTDEVNET, CRTDEVOPT, CRTDEVPRT, or CRTDEVTAP command.)

Device wait timer (DEVWAITTMR). The device wait time-out value. (See the DEVWAITTMR parameter in the CRTCTLLWS, CRTCTLRWS, or CRTCTLVWS command.)

Dial initiation (DIALINIT). Whether or not the system should dial the remote system or controller immediately when this controller description is varied on. (See the DIALINIT parameter in the CRTCTLAPPC, CRTCTLHOST, or CRTCTLRWS command.)

Dial retries (DIALRTY). The number of times to retry dialing the number before considering the dialing unsuccessful. (See the DIALRTY parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Disconnect timer (DSCTMR). The options for automatic disconnection. These options are returned in two separate fields:

• Minimum connect: The minimum length of time the link stays active after the connection has been made.
• Disconnect delay: The length of time the system delays disconnection after the last session for the controller is ended.

(See the DSCTMR parameter in the CRTCTLAPPC or CRTCTLHOST command.)

Entry length for list of attached devices. Entry length in bytes of each element in the list of attached devices returned with this format. A value of zero is returned if the list is empty.

Entry length for list of remote identifiers. Entry length in bytes of each element in the list of remote identifiers returned with this format. A value of zero is returned if the list is empty.

Entry length for list of switched lines. Entry length in bytes of each element in the list of switched lines returned with this format. A value of zero is returned if the list is empty.

Exchange identifier (EXCHID). A hexadecimal value used to identify the remote controller. (See the EXCHID parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLRTL, or CRTCTLRWS command.)

File transfer acknowledgement timer (ACKTMR). The time allowed, in seconds, for an acknowledgement when using file transfer support. (See the ACKTMR parameter in the CRTCTLASC command.)

File transfer retry (RETRY). The number of attempts to transmit a frame after an unsuccessful transmission when using file transfer support. (See the RETRY parameter in the CRTCTLASC command.)

HPR path switching (HPRPTHSWT). Whether or not path switching is done for HPR connections that use this controller at the time the controller is varied off. (See the HPRPTHSWT parameter in the CRTCTLAPPC or CRTCTLHOST command.)

IDLC connect retry (IDLCCNNRTY). The number of times to retry a transmission at connection time. (See the IDLCCNNRTY parameter in the CRTCTLAPPC, CRTCTLHOST, or CRTCTLRWS command.)

Exceptions:

• Value of -8 implies *NOMAX
• Value of -16 implies *LIND

Note: This field is no longer supported as of V5R3M0.

IDLC default window size (IDLCWDWSIZ). The default window size used for this line description. (See the IDLCWDWSIZ parameter in the CRTCTLAPPC, CRTCTLHOST, or CRTCTLRWS command.)

Exception:

• Value of -16 implies *LIND

Note: This field is no longer supported as of V5R3M0.

IDLC frame retry (IDLCFRMRTY). The maximum number of transmissions to attempt before reporting an error. (See the IDLCFRMRTY parameter in the CRTCTLAPPC, CRTCTLHOST, or CRTCTLRWS command.)

Exception:

• Value of -16 implies *LIND

Note: This field is no longer supported as of V5R3M0.

IDLC response timer (IDLCRSPTMR). The length of time to wait before retransmitting a frame when an acknowledgement is not received. (See the IDLCRSPTMR parameter in the CRTCTLAPPC, CRTCTLHOST, or CRTCTLRWS command.)

Exception:

• Value of -16 implies *LIND

Note: This field is no longer supported as of V5R3M0.

Initial connection (INLCNN). Whether the initial switched connection is made by the system when it answers an incoming call or by a call started from the system. (See the INLCNN parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Initialization program library name. The name of the library in which the initialization program resides.

Initialization program name. The name of a program that is called to manage configuration initialization data.

Initialization source file library name. The name of the library in which the initialization source file resides.

Initialization source file name. The name of a source file containing configuration initialization data.

Initialization source member name. The name of a source member containing configuration initialization data.

IPv6 Local internet address. The TCP/IP interface specified in IPv6 form to be used to communicate with the remote system. (See the LCLINTNETA parameter in the CRTCTLAPPC command.)

Exception:

• The value of *IPV4 implies that the controller is using IPv4 addresses. The IPv4 address is returned in the Local internet address field.

IPv6 Remote internet address. The Remote internet address specified in IPv6 form to which the controller responds. (See the RMTINTNETA parameter in the CRTCTLAPPC command.)

Exception:

• The value of *IPV4 implies that the controller is using IPv4 addresses. The IPv4 address is returned in the Remote internet address field.

LAN access priority (LANACCPTY). The priority set in the actual frames that the system will send to the remote controller. (See the LANACCPTY parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

LAN acknowledgement frequency (LANACKFRQ). The maximum number of frames the system can receive before sending an acknowledgement to the remote controller. (See the LANACKFRQ parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

LAN acknowledgement timer (LANACKTMR). The length of time the system will delay before sending an acknowledgement to the remote controller for a received data frame. (See the LANACKTMR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

LAN connection retry (LANCNNRTY). The number of times a frame will be retransmitted during the connection establishment if there is no acknowledgement from the remote controller in the time period specified by the LANCNNTMR parameter. (See the LANCNNRTY parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

LAN connection timer (LANCNNTMR). The length of time to wait for an acknowledgement from the remote controller during the connection establishment before retransmitting a frame. (See the LANCNNTMR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

LAN frame retry (LANFRMRTY). The number of times a frame will be retransmitted if there is no acknowledgement from the remote controller in the time period specified by the LANRSPTMR parameter. (See the LANFRMRTY parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

LAN inactivity timer (LANINACTMR). The length of time that the system will wait for a frame from the remote controller before requesting data with a frame of its own. (See the LANINACTMR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

LAN maximum outstanding frames (LANMAXOUT). The maximum number of outstanding frames that the system sends to the remote controller before it waits for an acknowledgment. (See the LANMAXOUT parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

LAN remote adapter address (ADPTADR). The adapter address of the remote controller. (See the ADPTADR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

LAN response timer (LANRSPTMR). The length of time to wait for an acknowledgement from the remote controller before retransmitting a data frame. (See the LANRSPTMR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

LAN window step (LANWDWSTP). Whether the number of outstanding frames (frames sent without receiving an acknowledgement from the remote system) should be reduced during periods of network congestion. (See the LANWDWSTP parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -3 implies *NONE

Last activity date. The date of last activity on the object. The date format used is CYYMMDD, where:

LDLC link speed (LDLCLNKSPD). The LDLC link speed. (See the LDLCLNKSPD parameter in the CRTCTLAPPC command.)

LDLC liveness timer. The LDLC liveness timer. (See the LDLCTMR parameter in the CRTCTLAPPC command.)

LDLC retry count. The LDLC retry counter. (See the LDLCTMR parameter in the CRTCTLAPPC command.)

LDLC retry timer. The LDLC retry timer. (See the LDLCTMR parameter in the CRTCTLAPPC command.)

Link type (LINKTYPE). The type of line this controller will be attached to. (See the LINKTYPE parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Local exchange identifier (LCLEXCHID). A hexadecimal value used to identify the local system to the remote system. (See the LCLEXCHID parameter in the CRTCTLHOST command.)

Local identifier (LCLID). The name that, when combined with the local location name, identifies your controller to a remote system. (See the LCLID parameter in the CRTCTLASC or CRTCTLBSC command.)

Local internet address (LCLINTNETA). The TCP/IP interface to be used to communicate with the remote system. (See the LCLINTNETA parameter in the CRTCTLAPPC command.)

Exception:

• The value of *IPV6 implies that the controller is using IPv6 addresses. The IPv6 address is returned in the IPv6 Local internet address field.

Local location name (LCLLOCNAME). The name which, when combined with the local identifier, identifies your controller to a remote system. (See the LCLLOCNAME parameter in the CRTCTLASC or CRTCTLRWS command.)

Maximum frame size (MAXFRAME). The maximum path information unit (PIU) size that the controller can send or receive. (See the MAXFRAME parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL or CRTCTLRWS command.)

Exception:

• Value of -17 implies *LINKTYPE

Message queue (MSGQ). The message queue to which operational messages for this controller should normally be sent. Note that this is the value entered on the MSGQ parameter of the CL command, but under certain error conditions it may not be the message queue currently in use. See the current message queue field to determine what message queue is actually being used at a given time. (See the MSGQ parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLHOST, CRTCTLLWS, CRTCTLRWS, or CRTCTLVWS command.) This information is returned in two separate fields:

• Name of the queue
• Library in which the queue can be found

Model controller description (MDLCTL). Whether this controller description is to be used as a model controller for automatically created controller descriptions associated with the line description specified on the SWTLINLST parameter. (See the MDLCTL parameter in the CRTCTLAPPC command.)

Negotiated packet size (DFTPKTSIZE). The default packet size to use on the virtual circuit represented by this controller. This information is returned in two separate fields:

• Transmit
• Receive

(See the DFTPKTSIZE parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Negotiated window size. The default window size to use on the virtual circuit represented by this controller. This information is returned in two separate fields:

• Transmit
• Receive

(See the DFTWDWSIZE parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Number of attached devices. The number of elements in the list of attached devices returned with this format. A value of zero is returned if the list is empty.

Number of remote identifiers. The number of elements in the list of remote identifiers returned with this format. A value of zero is returned if the list is empty.

Number of switched lines. The number of elements in the list of switched lines returned with this format. A value of zero is returned if the list is empty.

Offset to list of attached devices. The offset in bytes to the first element in the list of attached devices returned with this format. A value of zero is returned if the list is empty.

Offset to list of remote identifiers. The offset in bytes to the first element in the list of remote identifiers returned with this format. A value of zero is returned if the list is empty.

Offset to list of switched lines. The offset in bytes to the first element in the list of switched lines returned with this format. A value of zero is returned if the list is empty.

Online at IPL (ONLINE). Whether the controller is varied on automatically when the system is turned on or you want to vary it on manually by using the Vary Configuration (VRYCFG) command. (See the ONLINE parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLLWS, CRTCTLNET, CRTCTLRTL, CRTCTLRWS, CRTCTLTAP, or CRTCTLVWS command.)

PAD emulation (PADEML). Whether or not this controller is to emulate an X.25 packet assembler/disassembler (PAD). (See the PADEML parameter in the CRTCTLASC command.)

Predial delay (PREDIALDLY). The length of time to wait before dialing the number to establish a connection to the specified controller. (See the PREDIALDLY parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Primary DLUS name--network ID (PRIDLUS). The primary DLUS network ID. This is the network ID of the APPN network (subnet) that the remote DLUS resides in. It is the network-qualified CP name of the remote DLUS (SSCP) that the System i DLUR host controller prefers to communicate with (See the PRIDLUS parameter in the CRTCTLHOST command.)

Primary DLUS name--PU name (PRIDLUS). The primary DLUS name. This is the physical unit name of the remote DLUS. This is the network-qualified CP name of the remote DLUS (SSCP) that the System i DLUR host controller prefers to communicate with (See the PRIDLUS parameter in the CRTCTLHOST command.)

Propagation delay. The time required for a signal to travel from one end of a link to the other end.(See the LDLCTMSGRP parameter in the CRTCTLAPPC command.)

Reconnect timer (RECNNTMR). This timer is used when a session outage occurs to the remote DLUS node. It is the amount of time the System i DLUR support will wait for the DLUS node to drive an activation request back to the system(See the RECNNTMR parameter in the CRTCTLHOST command.)

Recontact at vary off (RECONTACT). Whether a recontact request is to be sent to the host system when this controller is varied off normally. (See the RECONTACT parameter in the CRTCTLHOST command.)

Recovery limits (CMNRCYLMT). The second-level communications recovery limit for each controller description. These limits are returned in two separate fields:

• Count limit: The number of second-level recovery attempts to be automatically performed by the system.
• Time interval: The length of time (in minutes) in which the specified number of second-level recoveries can be attempted.

(See the CMNRCYLMT parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -14 implies *SYSVAL

Redial delay (REDIALDLY). The length of time to wait before redialing the number to establish a connection to the specified controller if the previous attempt was unsuccessful. (See the REDIALDLY parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Release level. The release level reported by the remote control unit the last time the controller was varied on. The value is blanks when no release level is reported.

Remote control point name (RMTCPNAME). The name of the remote control point. (See the RMTCPNAME parameter in the CRTCTLAPPC or CRTCTLHOST command.)

Remote host name.The remote TCP/IP host name to which the controller will respond. (See the RMTINTNETA parameter in the CRTCTLAPPC command).

Remote identifier. The identifier used to identify the remote system to the local system.

Remote internet address (RMTINTNETA). The Remote internet address to which the controller will respond. (See the RMTINTNETA parameter in the CRTCTLAPPC command.)

Exception:

• The value of *IPV6 implies that the controller is using IPv6 addresses. The IPv6 address is returned in the IPv6 Remote internet address field.

Remote location name (RMTLOCNAME). The name by which the remote work station controller is known to the network. (See the RMTLOCNAME parameter in the CRTCTLRWS command.)

Remote network identifier (RMTNETID). The name of the remote network in which the adjacent control point resides. (See the RMTNETID parameter in the CRTCTLAPPC, CRTCTLHOST, or CRTCTLRWS command.)

Remote APPN node type (NODETYPE). The type of node that this controller represents. (See the NODETYPE parameter in the CRTCTLAPPC or CRTCTLHOST command.)

Remote system name (RMTSYSNAME). The remote system name supplied should be a current system name of an adjacent system to which there is an OptiConnect bus connection. The current system name of that system can be found by using the Display Network Attributes (DSPNETA) command on that system. (See the RMTSYSNAME parameter in the CRTCTLAPPC command.)

Remote verify (RMTVFY). Whether a remote system requires verification if a generic controller and device are configured to accept calls from any X.25 network address. (See the RMTVFY parameter in the CRTCTLASC command.)

Reserved. Space included for alignment.

Resource name (RSRCNAME). The unique name that is assigned by the system to the physical equipment (in this case, a communications port) attached to the system. (See the RSRCNAME parameter in the CRTCTLLWS or CRTCTLTAP command.)

RJE host type (RJEHOST). The name of the host system used by remote job entry. (See the RJEHOST parameter in the CRTCTLBSC command.)

RJE host signon/logon (RJELOGON). The logon information required by the host system if you specified remote job entry as the application type. (See the RJELOGON parameter in the CRTCTLBSC command.)

SDLC connect poll retry (CNNPOLLRTY). The number of connect poll retries that will be attempted before the system indicates an error in contacting the remote system. (See the CNNPOLLRTY parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLRTL, or CRTCTLRWS command.)

Exceptions:

• Value of -8 implies *NOMAX
• Value of -11 implies *CALC

SDLC NDM poll timer (NDMPOLLTMR). The minimum interval at which a secondary station should be polled if a poll from the primary to the secondary station (which is in normal disconnect mode) does not result in receiving the appropriate response. (See the NDMPOLLTMR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

SDLC out limit (OUTLMT). The number of additional frame sequences the system will send to the controller before polling the next station in the poll list. (See the OUTLMT parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLRTL, or CRTCTLRWS command.)

Exception:

• Value of -18 implies *POLLLMT

SDLC poll limit (POLLLMT). The number of additional consecutive polls the system will send to a controller when that controller responds by sending a number of frames equal to the maximum outstanding frames (MAXOUT parameter) specified on the line description. (See the POLLLMT parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLRTL, or CRTCTLRWS command.)

SDLC poll priority (POLLPTY). Whether this controller should have priority when being polled. (See the POLLPTY parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLRTL, or CRTCTLRWS command.)

Security. The security over the link. (See the LDLCTMSGRP parameter in the CRTCTLAPPC command.)

Serial number. The serial number reported by the resource the last time the resource was varied on. The value is blanks when no serial number is reported.

Short-hold mode (SHM). Whether this controller is used for X.21 short-hold mode. (See the SHM parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, or CRTCTLRWS command.)

Short-hold mode disconnect limit (SHMDSCLMT). The number of consecutive nonproductive responses (RR or RNR) that are required from the remote station before the connection can be suspended for this X.21 short-hold mode connection. (See the SHMDSCLMT parameter in the CRTCTLAPPC, CRTCTLFNC, or CRTCTLRWS command.)

Exception:

• Value of -8 implies *NOMAX

Short-hold mode disconnect timer (SHMDSCTMR). The minimum length of time that the primary station will maintain the connection to the remote system for this X.21 short-hold mode controller. (See the SHMDSCTMR parameter in the CRTCTLAPPC, CRTCTLFNC, or CRTCTLRWS command.)

Source service access point (SSAP). The logical address this system will use when it sends data to the remote controller. (See the SSAP parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Station address (STNADR). The station address to be used when communicating with the remote system using SDLC. (See the STNADR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Switched connection (SWITCHED). Whether this controller is attached to a switched line, a local area network, or an X.25 switched virtual circuit (SVC) connection. (See the SWITCHED parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Switched disconnect (SWTDSC). Whether the switched connection is dropped when the last session is unbound and the disconnect timer (DSCTMR) has ended. (See the SWTDSC parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Switched line. Whether this controller is attached to a switched line. (See the SWITCHED parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Switched line name (SWTLINLST). The name of a line that can be connected to this controller for switched connections. (See the SWTLINLST parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Switched network backup (SNBU). Whether you want the switched network backup capability. (See the SNBU parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

System job name. The name of the system job that is associated with this controller.

System service control point identifier (SSCPID). The system service control point identifier that the system sends to the remote system in the activate physical unit (ACTPU) request. (See the SSCPID parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

TDLC line name. The name of a line associated with this controller.

Text description (TEXT). A brief description of the controller and its location. (See the TEXT parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLBSC, CRTCTLFNC, CRTCTLHOST, CRTCTLLWS, CRTCTLNET, CRTCTLRTL, CRTCTLRWS, CRTCTLTAP, or CRTCTLVWS command.)

Time information retrieved. The time that the information was provided by the API. It is returned as 6 characters in the form HHMMSS, where:

User facilities (USRFCL). Allows network subscribers to request network-supplied facilities that are not available through the system parameters. (See the USRFCL parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

User-defined 1, 2, and 3 (USRDFN1, USRDFN2, USRDFN3). Used to describe any unique characteristics of this connection that you want to control. (See the USRDFN1, USRDFN2, or USRDFN3 parameter in the CRTCTLAPPC or CRTCTLHOST command.)

Exception:

• Value of -16 implies *LIND

X.25 acknowledgement timer (X25ACKTMR). The ELLC LT2 acknowledgement timer, which is only used for controllers that have the X.25 link protocol (LINKPCL) set to *ELLC. (See the X25ACKTMR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, or CRTCTLRWS command.)

X.25 connection password. For X.25 SVC connections, the password used when connecting to this controller.

X.25 connection retry (X25CNNRTY). Same as the X25FRMRTY parameter, except that it applies only to logical link control (LLC) connection establishment, such as LSABME-LUA LLC protocol data units for ELLC and QSM-QUA for QLLC LLC protocol data units. (See the X25CNNRTY parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, or CRTCTLRWS command.)

X.25 connection timer (X25CNNTMR). Same as the X25RSPTMR parameter, except that it applies only to LLC connection establishment, such as LSABME-LUA LLC protocol data units for ELLC and QSM-QUA LLC protocol data units for QLLC. (See the X25CNNTMR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, or CRTCTLRWS command.)

X.25 delayed connection timer (X25DLYTMR). The time between retries of polling exchange identifier commands when the system is trying to establish a connection to the remote data terminal equipment (DTE) represented by the controller description. (See the X25DLYTMR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, or CRTCTLRWS command.)

Exception:

• Value of -11 implies *CALC

X.25 frame retry (X25FRMRTY). The number of times that a data or logical link disconnection protocol data unit (PDU) can be retransmitted if no acknowledgement is received from the adjacent logical link station in the remote DTE in the time specified by the X.25 response timer (X25RSPTMR). (See the X25FRMRTY parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

X.25 inactivity timer (X25INACTMR). The ELLC LTI inactivity timer, which is only used for controllers that have the X.25 link protocol (LINKPCL) set to *ELLC. (See the X25INACTMR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, or CRTCTLRWS command.)

X.25 link protocol (LINKPCL). The logical link protocol to be used to communicate with the remote DTE represented by this controller description. (See the LINKPCL parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, or CRTCTLRWS command.)

X.25 logical channel ID (LGLCHLID). The logical channel identifier that is to be used for this controller. (See the LGLCHLID parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

X.25 network level (NETLVL). The level of the support by the X.25 network and the remote DTE represented by this controller description. (See the NETLVL parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

X.25 response timer (X25RSPTMR). The maximum amount of time allowed between the transmission of a data or logical link disconnection link protocol data unit (PDU) and the receipt of a corresponding acknowledgement from the adjacent link station on the remote DTE. (See the X25RSPTMR parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

X.25 reverse charging (RVSCRG). For incoming calls, whether reverse charging will be accepted, and for outgoing calls, whether reverse charging will be requested. (See the RVSCRG parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

X.25 switched line selection (SWTLINSLCT). Which of the lines listed on the SWTLINLST parameter will be selected for making the switched connection. (See the SWTLINSLCT parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

X.25 user group ID (USRGRPID). A value that is supplied as a unique identifier by the network if the closed user group facility is subscribed to. (See the USRGRPID parameter in the CRTCTLAPPC, CRTCTLASC, CRTCTLFNC, CRTCTLHOST, CRTCTLRTL, or CRTCTLRWS command.)

Error Messages

[ Back to top | >Configuration APIs | APIs by category ]