Obtain information about TCP/IP characteristics of the
current transaction.
EXTRACT TCPIP
>>-EXTRACT--TCPIP -+--------------------+----------------------->
'-AUTHENTICATE(cvda)-'
>--+-----------------------------------------------+------------>
'-CLIENTNAME(data-area)--CNAMELENGTH(data-area)-'
>--+-----------------------------------------------+------------>
'-SERVERNAME(data-area)--SNAMELENGTH(data-area)-'
>--+-----------------------------------------------+------------>
'-CLIENTADDR(data-area)--CADDRLENGTH(data-area)-'
>--+--------------------+--+-------------------------+---------->
'-CLNTIPFAMILY(cvda)-' '-CLIENTADDRNU(data-area)-'
>--+------------------------+----------------------------------->
'-CLNTADDR6NU(data-area)-'
>--+-----------------------------------------------+------------>
'-SERVERADDR(data-area)--SADDRLENGTH(data-area)-'
>--+--------------------+--+-------------------------+---------->
'-SRVRIPFAMILY(cvda)-' '-SERVERADDRNU(data-area)-'
>--+------------------------+--+---------------+---------------->
'-SRVRADDR6NU(data-area)-' '-SSLTYPE(cvda)-'
>--+-------------------------+--+-----------------------+------->
'-TCPIPSERVICE(data-area)-' '-PORTNUMBER(data-area)-'
>--+----------------------+--+---------------+------------------>
'-PORTNUMNU(data-area)-' '-PRIVACY(cvda)-'
>--+-----------------------+-----------------------------------><
'-MAXDATALEN(data-area)-'
Conditions: INVREQ, LENGERR
This command is threadsafe.
Description
EXTRACT TCPIP provides information
about the TCP/IP connection, and about security options specified
in the TCPIPSERVICE definition.
Options
- AUTHENTICATE(cvda)
- Returns a CVDA indicating the authentication requested for the
client using this transaction. Here are the values:
- ASSERTED
- AUTOAUTH
- AUTOREGISTER
- BASICAUTH
- CERTIFICAUTH
- NOAUTHENTIC
- CADDRLENGTH(data-area)
- Returns the length of the buffer supplied on the CLIENTADDR option,
and is set to the length of the data returned to the application. If the CLIENTADDR is an IPv6 address, you must set the
buffer length of CADDRLENGTH to at least 39 characters. If the
data exceeds the buffer length, a LENGERR condition is raised and
the data is truncated.
- CLIENTADDR(data-area)
- Returns
a buffer containing the IP address of the client. The
IP address can be in IPv4 or IPv6 format. IPv4 addresses are returned
as native IPv4 dotted decimal addresses; for example, 1.2.3.4 IPv6
addresses are returned as native IPv6 colon hexadecimal addresses;
for example, ::a:b:c:d
For
information on IP addresses, see IP addresses.
- CLIENTADDRNU(data-area)
- Returns
a fullword binary field containing the IPv4 address of the client
in binary form. If the address is in IPv6 format,
it is returned in the CLNTADDR6NU option and 0 is returned in CLIENTADDRNU.
- CLIENTNAME(data-area)
- Specifies
a buffer to contain the name of the client as known by the Domain
Name Server.
- CLNTADDR6NU(data-area)
- Returns
a 16-byte field containing the IPv6 address of the client in binary
form. This option is returned only if the option CLNTIPFAMILY has
a value of IPV6. If the address is in
IPv4 format, the address is returned in the CLNTADDRNU option and
zeros are returned to CLNTADDR6NU.
- CLNTIPFAMILY(cvda)
- Returns
the format of the IP address of the client. CVDA values are as follows:
- IPV4
- CLIENTADDR returns a dotted
decimal IPv4 address and CLIENTADDRNU returns the IPv4 address in
binary form.
- IPV6
- CLIENTADDR returns a colon
hexadecimal IPv6 address and CLIENTADDR6NU returns the IPv6 address
in binary form.
- NOTAPPLIC
- The source of the input
has not been determined. 0.0.0.0 is returned.
- CNAMELENGTH(data-area)
- Specifies
the length of the buffer supplied on the CLIENTNAME option, and is
set to the actual length of the data returned to the application,
or zero if the name of the client is not known to the domain name
server. If the data exceeds the buffer length, a LENGERR condition
is raised and the data is truncated.
- MAXDATALEN(data-area)
- Specifies
a fullword binary field to contain the setting for the maximum length
of data that can be received by CICS as an HTTP server.
- PRIVACY(cvda)
- Returns a CVDA indicating the level of SSL encryption used between
the transaction and its client for an inbound request. CVDA values
are as follows:
- NOTSUPPORTED
- REQUIRED
- SUPPORTED
- PORTNUMBER(data-area)
- Specifies
a 5-character field to contain the port number associated with this
transaction in character form. This port received the incoming data
that initiated this transaction.
- PORTNUMNU(data-area)
- Fullword
field to contain the port number associated with this transaction
in binary form. This port received the incoming data that initiated
this transaction.
- SADDRLENGTH(data-area)
- Returns
the length of the buffer supplied on the SERVERADDR option, and is
set to the length of the data returned to the application. If SERVERADDR is an IPv6 address, you must set the buffer
length of SADDRLENGTH to at least 39 characters. If the data
exceeds the buffer length, a LENGERR condition is raised and the data
is truncated.
- SERVERADDR(data-area)
- Returns
a buffer containing the IP address of the server. The
IP address can be in IPv4 or IPv6 format. IPv4 addresses are returned
as native IPv4 dotted decimal addresses, for example; 1.2.3.4.
IPv6 addresses are returned as native IPv6 colon hexadecimal addresses;
for example, ::a:b:c:d. If an error
occurs, 0.0.0.0 is returned and the data
is truncated.
- SERVERADDRNU(data-area)
- Returns
a fullword binary field containing the IPv4 address of the server
in binary form. If the address is IPv6 format, it
is returned in the SRVRADDR6NU option and 0 is returned to SERVERADDRNU.
- SERVERNAME(data-area)
- Specifies
a buffer to contain the name of the server as known by the Domain
Name Server.
- SNAMELENGTH(data-area)
- Specifies
the length of the buffer supplied on the SERVERNAME option, and is
set to the length of the data returned to the application. If the
data exceeds the buffer length, a LENGERR condition is raised and
the data is truncated.
- SRVRADDR6NU(data-area)
- Returns
a 16-byte field containing the IPv6 address of the server in binary
form. This option is returned only if the option SRVIPFAMILY has a
value of IPV6. If the address is in IPv4
format, the address is returned in the SERVERADDRNU option and zeros
are returned in SRVRADDR6NU.
- SRVRIPFAMILY(cvda)
- Returns
the format of the IP address of the server. CVDA values are as follows:
- IPV4
- SERVERADDR returns a dotted
decimal IPv4 address and SERVERADDRNU returns the IPv4 address in
binary form.
- IPV6
- SERVERADDR returns a colon
hexadecimal IPv6 address and SERVERADDR6NU returns the IPv6 address
in binary form.
- NOTAPPLIC
- The source of the input
has not been determined. 0.0.0.0 is returned.
- SSLTYPE(cvda)
- Returns
a CVDA indicating whether the Secure Sockets Layer (SSL) is being
used to secure communications for this transaction. Here are the values:
- SSL
- NOSSL
- CLIENTAUTH
- TCPIPSERVICE(data-area)
- An
8-byte field to contain the name of the TCPIPSERVICE associated with
this transaction.
Conditions
- 16 INVREQ
- RESP2
values:
- 2
- An incorrect socket response was received.
- 5
- The command was issued from a non-TCPIP application.
- 22 LENGERR
- RESP2
values:
- 1
- CLIENTADDR, SERVERADDR, CLIENTNAME, or SERVERNAME is specified,
but the relevant length field is either not specified, or it is less
than or equal to zero.
- 3
- CLIENTADDR is too small to contain the string extracted.
- 4
- SERVERADDR is too small to contain the string extracted.
- 6
- CLIENTNAME is too small to contain the string extracted.
- 7
- SERVERNAME is too small to contain the string extracted.