The Retrieve IP Interface  command retrieves the information for  an IP
address from  the QATOCIFC file  in QUSRSYS and  the QtocLstNetIfc API.
A variety of return variables exist.

Some of the information can be displayed by using:

       - CFGTCP
       - Option 1 for Work with TCP/IP interfaces
       - Option 5 for a specific internet address

A typical command would be:

             DCL           &LIND *CHAR LEN(10)
              .
             RTVIPIFC      IPADDR(xxxxx) LIND(&LIND)

You  must know the  internet address to be  retrieved.  The information
can be found in the QATOCIFC file in QUSRSYS.

RTVIPIFC escape messages you can monitor for
--------------------------------------------

      TAA9896    The internet address could not be found

Escape messages from based on functions will be re-sent.

Command parameters                                    *CMD
------------------

   IPADDR        The IP address to retrieve information for.

   STATUS        The interface  status  information.   The  information
                 is  retrieved  using  the   QtocLstNetIfc  API.    The
                 values  returned  are  *ACTIVE,  *INACTIVE, *STARTING,
                 *ENDING,   *RCYPND    (recovery   pending),    *RCYCNL
                 (recovery failed),  *FAILED (the line  description has
                 entered  the failed  state), *FAILEDTCP (an  error was
                 found in  TCP/IP), *NOTFOUND  (the address  could  not
                 be found by using the API).

                 This is  an optional variable  that if  specified must
                 be declared as *CHAR LEN(10).

   PING          A  *YES/*NO  value   for  whether  a  'ping'  done  by
                 VFYTCPCNN  was successful.   *YES  means the  ping was
                 successful.

                 *NO means the ping was unsuccessful.

                 This is  an optional variable  that if specified  must
                 be declared as *CHAR LEN(4).

   LIND          The  line   description  information.     This  is  an
                 optional  variable that if specified  must be declared
                 as *CHAR LEN(10).

   SUBNETMASK    The Subnet  mask information.    This is  an  optional
                 variable that if  specified must be declared  as *CHAR
                 LEN(15).

   TOS           The  type   of  service  information.     This  is  an
                 optional variable that if  specified must be  declared
                 as *CHAR LEN(10).

   MTU           The maximum  transmission unit  information.  This  is
                 an  optional  variable   that  if  specified  must  be
                 declared as *DEC LEN(9 0).

   AUTOSTART     The   automatic  start   information.     This  is  an
                 optional variable that  if specified must be  declared
                 as *CHAR LEN(1).

   IDLVCTTIMO    The  X.25  Idle  timeout  information.    This  is  an
                 optional  variable that if  specified must be declared
                 as *DEC LEN(9 0).

   MAXSVC        The  X.25  Maximum  SVC  information.    This   is  an
                 optional variable  that if specified must  be declared
                 as *DEC LEN(9 0).

   DDN           The  X.25   DDN  Network  information.    This  is  an
                 optional variable that if  specified must be  declared
                 as *CHAR LEN(1).

   BITSEQ        The Token Ring  bit sequence information.  This  is an
                 optional variable  that if specified  must be declared
                 as *CHAR LEN(4).

   IFCTYPE       The  type  of  interface  information.    This  is  an
                 optional variable that  if specified must  be declared
                 as *CHAR LEN(1).

   LINETYPE      The  line  type  information.   This  is  an  optional
                 variable  that if specified must  be declared as *CHAR
                 LEN(10).

   LOCALIFC      The associated local interface  information.  This  is
                 an  optional  variable  that   if  specified  must  be
                 declared as *CHAR LEN(15).

   CNNTYPE       The  connection type  interface information.   This is
                 an  optional  variable  that  if  specified  must   be
                 declared as *CHAR LEN(1).

   IFCINFO       The  interface  information.    This  is  an  optional
                 variable that  if specified must be  declared as *CHAR
                 LEN(1).

   PVCLGLCHLI    The  X.25 PVC  logical channel  information.   This is
                 an  optional  variable  that  if  specified   must  be
                 declared as *CHAR LEN(192).

   PPPPROF       The  PPP Profile  information.   This  is an  optional
                 variable  that if specified must  be declared as *CHAR
                 LEN(10).

   PPPRMTIP      The PPP Remote  IP information.   This is an  optional
                 variable that if  specified must be declared  as *CHAR
                 LEN(15).

   APPDFN        The  Application definition  information.  This  is an
                 optional variable that if  specified must be  declared
                 as *CHAR LEN(16).

   IFCNAME       The Interface name  information.  This is  an optional
                 variable that  if specified must be  declared as *CHAR
                 LEN(24).

   NETNAME       The  TCP/IP  network  name information.    This  is an
                 optional variable that  if specified must  be declared
                 as *CHAR LEN(24).

Restrictions
------------

Because the  command returns  variables, it  may only be  used in  a CL
program.

Prerequisites
-------------

The following TAA Tools must be on your system:

     SNDESCMSG       Send escape message

Implementation
--------------

None, the tool is ready to use.

Objects used by the tool
------------------------

   Object        Type    Attribute      Src member    Src file
   ------        ----    ---------      ----------    ----------

   RTVIPIFC      *CMD                   TAATCPA       QATTCMD
   TAATCPAC      *PGM       CLP         TAATCPAC      QATTCL
   TAATCPAR      *PGM       RPGLE       TAATCPAR      QATTRPG