RTVCTLHOST RETRIEVE CONTROLLER DESCRIPTION HOST TAACFGK |
The Retrieve Controller Description Host tool retrieves information
about a host controller. Because many parameters exist, 3 commands
are provided (RTVCTLHOST, RTVCTLHOS2, and RTVCTLHOS3). This provides
the current information about the controller. The QDCRCTLD API is
used to retrieve the data.
A typical command would be:
DCL &NBRDEV *DEC LEN(5 0)
.
RTVCTLHOST CTLD(xxx) NBRDEV(&NBRDEV)
RTVCTLHOST escape messages you can monitor for
----------------------------------------------
TAA9891 The controller is not a HOST type.
Escape messages from based on functions will be re-sent.
RTVCTLHOST command parameters *CMD
-----------------------------
CTLD The local host controller name. It must be a HOST
type.
ONLINE The type of online request for IPL. A *YES or *NO
will be returned. This is an optional return
variable that if used must be specified as *CHAR
LEN(4).
MAXFRAME The maximum path information unit (PIU) size that
the controller can send or receive. A value of -17
indicates *LINKTYPE. This is an optional return
variable that if used must be specified as *DEC
LEN(9 0).
IDLCWDWSIZ The default window size used. A value of -16
indicates *LIND. This is an optional return
variable that if used must be specified as *DEC
LEN(9 0).
IDLCFRMRTY The maximum number of transmissions to attempt
before reporting an error. A value of -16 indicates
*LIND. This is an optional return variable that if
used must be specified as *DEC LEN(9 0).
IDLCRSPTMR The length of time to wait before retransmitting a
frame when an acknowledgement is not received. A
value of -16 indicates *LIND. The field is no
longer supported as of V5R3M0. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
IDLCCNNRTY The number of times to retry a transmission at
connection time. A value of -8 indicates *NOMAX. A
value of -16 indicates *LIND. The field is no
longer supported as of V5R3M0. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
PREDIALDLY The length of time to wait before dialing the number
to establish a connection to the controller. This
is an optional return variable that if used must be
specified as *DEC LEN(9 0).
REDIALDLY The length of time to wait before re-dialing the
number to establish a connection to the controller
if the previous attempt was unsuccessful. This is
an optional return variable that if used must be
specified as *DEC LEN(9 0).
DIALRTY The number of times to retry dialing the number
before considering the dialing unsuccessful. This
is an optional return variable that if used must be
specified as *DEC LEN(9 0).
DSCTMR The minimum length of time the link stays active
after the connection has been made. This is an
optional return variable that if used must be
specified as *DEC LEN(9 0).
DSCTMRDLY The length of time the system delays disconnection
after the last session for the controller that has
ended. This is an optional return variable that if
used must be specified as *DEC LEN(9 0).
LANFRMRTY The number of times a frame will be retransmitted if
there is no acknowledgement from the remote
controller during the time period specified by the
LANRSPTMR parameter. A value of -11 indicates
*CALC. This is an optional return variable that if
used must be specified as *DEC LEN(9 0).
LANCNNRTY The number of times a frame will be retransmitted if
there is no acknowledgement from the remote
controller during the time period specified by the
LANCNNTMR parameter. A value of -11 indicates
*CALC. This is an optional return variable that if
used must be specified as *DEC LEN(9 0).
LANRSPTMR The length of time to wait for an acknowledgement
from the remote controller before transmitting a
data frame. A value of -11 indicates *CALC. This
is an optional return variable that if used must be
specified as *DEC LEN(9 0).
LANCNNTMR The length of time to wait for an acknowledgement
from the remote controller during the connection
establishment before transmitting a frame. A value
of -11 indicates *CALC. This is an optional return
variable that if used must be specified as *DEC
LEN(9 0).
LANACKTMR The length of time to wait before sending an
acknowledgement for a received data frame. A value
of -11 indicates *CALC. This is an optional return
variable that if used must be specified as *DEC
LEN(9 0).
LANINACTMR The length of time to wait for a frame from the
remote controller before requesting data with a
frame of its own. A value of -11 indicates *CALC.
This is an optional return variable that if used
must be specified as *DEC LEN(9 0).
LANACKFRQ The maximum number of frames the system can receive
before sending an acknowledgement to the remote
controller. A value of -11 indicates *CALC. This
is an optional return variable that if used must be
specified as *DEC LEN(9 0).
LANMAXOUT The maximum number of outstanding frames the system
sends to the remote controller before it waits for
an acknowledgement. A value of -11 indicates *CALC.
This is an optional return variable that if used
must be specified as *DEC LEN(9 0).
LANACCPTY The priority set in the actual frames that the
system will send to the remote controller. A value
of -11 indicates *CALC. This is an optional return
variable that if used must be specified as *DEC
LEN(9 0).
LANWDWSTP Whether the number of outstanding frames (frames
sent without an acknowledgement) should be reduced
during periods of network congestion. A value of -3
indicates *NONE. This is an optional return
variable that if used must be specified as *DEC
LEN(9 0).
DFTPKTTRN The default packet size to use on the virtual
circuit represented by this controller for
transmission. A value of -10 indicates *TRANSMIT.
A value of -16 indicates *LIND. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
DFTPKTRCV The default packet size to use on the virtual
circuit represented by this controller for
receiving. A value of -10 indicates *TRANSMIT. A
value of -16 indicates *LIND. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
NGTPKTTRN The negotiated packet size to use on the virtual
circuit represented by this controller for
transmission. A value of -10 indicates *TRANSMIT.
A value of -16 indicates *LIND. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
NGTPKTRCV The negotiated packet size to use on the virtual
circuit represented by this controller for
receiving. A value of -10 indicates *TRANSMIT. A
value of -16 indicates *LIND. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
DFTWDWTRN The default window size to use on the virtual
circuit represented by this controller for
transmission. A value of -10 indicates *TRANSMIT.
A value of -16 indicates *LIND. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
DFTWDWRCV The default window size to use on the virtual
circuit represented by this controller for
receiving. A value of -10 indicates *TRANSMIT. A
value of -16 indicates *LIND. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
NGTWDWTRN The negotiated window size to use on the virtual
circuit represented by this controller for
receiving. A value of -10 indicates *TRANSMIT. A
value of -16 indicates *LIND. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
NGTWDWRCV The negotiated window size to use on the virtual
circuit represented by this controller for
transmission. A value of -10 indicates *TRANSMIT.
A value of -16 indicates *LIND. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
X25FRMSIZ The frame size of the X.25 frames. This is an
optional return variable that if used must be
specified as *DEC LEN(9 0).
X25RSPTMR The maximum amount of time allowed between the
transmission of data or logical link disconnection
link protocol data unit (PDU) and the receipt of a
corresponding acknowledgement. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
X25ACKTMR The ELLC LT2 acknowledgement timer is only used for
connections that have the X.25 link protocol set to
*ELLC. This is an optional return variable that if
used must be specified as *DEC LEN(9 0).
X25INACTMR The ELLC LT2 inactivity timer which is only used for
connections that have the X.25 link protocol set to
*ELLC. This is an optional return variable that if
used must be specified as *DEC LEN(9 0).
TMSGRPNBR The value to be used by the APPN support for
transmission group negotiation with the remote
system. A value of -11 indicates *CALC. This is an
optional return variable that if used must be
specified as *DEC LEN(9 0).
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.
A value of -2 indicates *NO. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
AUTOCRTDEV The devices which are created automatically. A
value of *ALL, *DEVINIT, or *NONE will be returned.
This is an optional return variable that if used
must be specified as *DEC LEN(9 0).
MSGQ The name of the message queue used for operational
messages. This is an optional return variable that
if used must be specified as *CHAR LEN(10).
MSGQLIB The name of the message queue library used for
operational messages. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
CURMSGQ The name of the current message queue used for
operational messages. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
CURMSGQLIB The name of the current message queue library used
for operational messages. This is an optional
return variable that if used must be specified as
*CHAR LEN(10).
SYSJOB The name of the system job associated with the
controller. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
NBRDEV The number of devices attached to the controller.
This is an optional return variable that if used
must be specified as *DEC LEN(5 0).
DEVICES A list of the devices attached to the controller. A
maximum of 300 devices exists with each device name
10 bytes in length. The remainder of the area is
filled with blanks. This is an optional return
variable that if used must be specified as *CHAR
LEN(3000).
TEXT The text description of the controller. This is an
optional return variable that if used must be
specified as *CHAR LEN(50).
RTVCTLHOS2 command parameters *CMD
-----------------------------
CTLD The local host controller name. It must be a *HOST
type.
USRDFN1 Used to define any unique characteristics. This is
an optional return variable that if used must be
specified as *DEC LEN(9 0).
USRDFN2 Used to define any unique characteristics. This is
an optional return variable that if used must be
specified as *DEC LEN(9 0).
USRDFN3 Used to define any unique characteristics. This is
an optional return variable that if used must be
specified as *DEC LEN(9 0).
CMNRCYLMTC The number of second-level recovery attempts to be
automatically performed. This is an optional return
variable that if used must be specified as *DEC
LEN(9 0).
CMNRCYLMTI The length of time in minutes in which second-level
recovery will be performed. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
LNKTYPE The type of line the controller is attached to.
This is an optional return variable that if used
must be specified as *CHAR LEN(10).
SWITCHED Whether the controller is attached to a switched
line. This is an optional return variable that if
used must be specified as *CHAR LEN(10).
SHM Whether the controller is used for X.21 short-hold
mode. This is an optional return variable that if
used must be specified as *CHAR LEN(10).
SNBU Whether switched network backup is requested. This
is an optional return variable that if used must be
specified as *CHAR LEN(10).
ACTSNBU Whether the switched network backup is activated.
This is an optional return variable that if used
must be specified as *CHAR LEN(10).
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. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
LINE The name of the line description that connects the
network to the system (attached non-switched line
name). This is an optional return variable that if
used must be specified as *CHAR LEN(10).
CODE The type of character code (EBCDIC or ASCII) used to
send the information in a remote work station data
stream over the communication line. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
RMTNETID The name of the remote network in which the adjacent
control point resides. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
RMTCPNAME The name of the remote control point. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
ADJLNKSTN The link station name of the adjacent system. This
is an optional return variable that if used must be
specified as *CHAR LEN(10).
SSCPID The system service control point identifier that the
system sends to the remote system in the activate
physical unit (ACTPU) request. This is an optional
return variable that if used must be specified as
*CHAR LEN(10).
LCLEXCHID A hexadecimal value used to identify the local
system to the remote system. This is an optional
return variable that if used must be specified as
*CHAR LEN(10).
INLCNN Whether the initial switched connection is made by
the system when it answers an incoming call or a
call started started from the system. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
DIALINIT Whether or not the system should dial the remote
system controller immediately when this controller
is varied on. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
CNNNBR The number (for a switched connection or a
non-switched connection with switched network
backup) of the remote controller that is called from
the system to establish a connection. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
ANSNBR The X.25 network address from which this controller
can accept calls. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
ACTX25NET The current X.25 network address for active X.25
controller descriptions. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
CNNLSTOUT The name of the connection list containing the
network assigned numbers used for outgoing calls on
this controller. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
CNNLSTOUTE The name of the connection list entry containing the
network-assigned numbers used for outgoing calls on
this controller. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
SWTDSC Whether the switched connection is dropped when the
last session is unbound and the disconnect timer has
ended. This is an optional return variable that if
used must be specified as *CHAR LEN(10).
STNADR The station address to be used when communicating
with the remote system using SDLC. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
ADPTADR The adapter address of the remote controller. This
is an optional return variable that if used must be
specified as *CHAR LEN(10).
DSAP The logical address that this system will use when
it communicates with the remote controller. This is
an optional return variable that if used must be
specified as *CHAR LEN(10).
SRCSRVACC The logical address that this system will use when
it sends data to the remote controller. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
RTVCTLHOS3 command parameters *CMD
-----------------------------
CTLD The local host controller name. It must be a *HOST
type.
NETLVL The level of support by the X.25 network and the
remote DTE represented by the controller
description. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
LINKPCL The logical link protocol to be used to communicate
with the remote DTE represented by the controller
description. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
LGLCHLID The logical channel identifier that is to be used
for this controller. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
X25CNNPWD For X.25 SVC connections, the password used when
connecting to the controller. This is an optional
return variable that if used must be specified as
*CHAR LEN(10).
SWTLINSLCT Which of the lines listed on the SWTLINLST parameter
will be selected for making the switched connection.
This is an optional return variable that if used
must be specified as *CHAR LEN(10).
X25USRGRP A value that is supplied as a unique identifier by
the network if the closed user group facility is
subscribed to. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
RVSCRG For incoming calls, whether reverse charging will be
accepted, and for outgoing calls, whether reverse
charging will be requested. This is an optional
return variable that if used must be specified as
*CHAR LEN(10).
APPCCPSSN Whether the controller supports control
point-to-control point sessions. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
NODETYPE The type of node that this controller represents.
This is an optional return variable that if used
must be specified as *CHAR LEN(10).
MINSWTSTS The minimum status required for this controller
description to be considered eligible for APPN
routing. This is an optional return variable that
if used must be specified as *CHAR LEN(10).
RECONTACT Whether a recontact request is to be sent to the
host system when this controller is varied off
normally. This is an optional return variable that
if used must be specified as *CHAR LEN(10).
USRFCL Allows network subscribers to request
network-supplied facilities that are not available
through the system parameters. This is an optional
return variable that if used must be specified as
*CHAR LEN(218).
HPR Whether to use APPN high-performance routing (HPR)
support. This is an optional return variable that
if used must be specified as *CHAR LEN(10).
PRIDLUS The primary DLUS name. This is the physical unit ID
of the APPN network that the remote DLUS resides in.
This is the network qualified CP name of the remote
DLUS (SSCP) that the system host controller prefers
to communicate with. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
PRIDLUSID The primary DLUS network ID. This is the network ID
of the APPN network that the remote DLUS resides in.
It is the network qualified CP name of the remote
DLUS (SSCP) that the system host controller prefers
to communicate with. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
BKPDLUS The backup DLUS name. This is the physical unit ID
of the APPN network that the remote DLUS resides in.
This is the network qualified CP name of the remote
DLUS (SSCP) that the system host communicates with
in the absence of the primary DLUS node. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
BKPDLUSID The backup DLUS network ID. This is the network ID
of the APPN network that the remote DLUS resides in.
It is the network qualified CP name of the remote
DLUS (SSCP) that the system dependent-unit-requester
(DLUR) host controller communicates with in the
absence of the primary DLUS node. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
DEPENDPU The dependent location name that is used for DLUR,
which provides additional security for the
connection. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
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.
This is an optional return variable that if used
must be specified as *DEC LEN(9 0).
RECNNTMR This timer is used when a session outage occurs to
the remote DLUS node. It is the amount of time the
system DLUR support will wait for for the DLUS node
to drive an activation request back to the system.
This is an optional return variable that if used
must be specified as *DEC LEN(9 0).
HPRPTHSWT Whether or not path switching is done for HPR
connections that use this controller at the time the
controller is varied off. This is an optional
return variable that if used must be specified as
*CHAR LEN(10).
CURMAXFRM The maximum frame size that is currently being used
by the controller. This field is only valid for
controllers that have been varied on and are
connected to a LAN. This is an optional return
variable that if used must be specified as *DEC
LEN(9 0).
BEXROLE The role of 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. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
NBRLIN The number of elements in the list of switched
lines. A value of zero is returned if the list is
empty. This is an optional return variable that if
used must be specified as *DEC LEN(5 0).
SWTLINLST The list of lines that can be connected to this
controller for switched connections. A maximum of
300 switched lines may exist with each switched line
10 bytes in length. The remainder of the area is
filled with blanks. This is an optional return
variable that if used must be specified as *CHAR
LEN(3000).
Restrictions
------------
Because RTVCTLHOST commands return variables, they may only be used
in a CL program.
Prerequisites
-------------
The following TAA Tools must be on your system:
SNDESCINF Send escape information
SNDESCMSG Send escape message
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
RTVCTLHOST *CMD TAACFGK QATTCMD
RTVCTLHOS2 *CMD TAACFGK2 QATTCMD
RTVCTLHOS3 *CMD TAACFGK3 QATTCMD
TAACFGKC *PGM CLP TAACFGKC QATTCL
TAACFGKC2 *PGM CLP TAACFGKC2 QATTCL
TAACFGKC3 *PGM CLP TAACFGKC3 QATTCL
Structure
---------
RTVCTLHOST Cmd
TAACFGKC CL
RTVCTLHOS2 Cmd
TAACFGKC2 CL
RTVCTLHOS3 Cmd
TAACFGKC3 CL
|
Added to TAA Productivity tools September 15, 2007
