INQUIRE TCPIPSERVICE
使用 CICS® 内部 TCP/IP 支持检索有关服务状态的信息。
语法
通过指定 XCMD 系统初始化参数并确保事务的命令安全检查处于激活状态(在 TRANSACTION 资源定义中指定 CMDSEC(YES) 或在 CMDSEC 系统初始化参数中指定 ALWAYS),激活命令安全检查。
条件: END , ILLOGIC , NOTAUTH 和 NOTFND
NOHANDLE, RESP, 和 RESP2 是可以添加到所有 EXEC CICS 命令中的常用选项,用于处理错误条件。 命令语法图和选项说明中没有明确包含这些选项。 有关这些常用选项和 EXEC CICS 命令语法的信息,请参阅 EXEC CICS 命令格式和编程注意事项. 有关使用 CVDA 的更多信息,请参阅 CICS-值数据区 (CVDA)。
此命令是线程安全的。
描述
使用 INQUIRE TCPIPSERVICE 命令可检索有关 CICS 内部 TCP/IP 支持代表其他 CICS 服务当前正在侦听的 TCP/IP 端口的信息。
资源特征符
您可以使用此命令来检索资源签名字段。 您可以使用这些字段来管理资源,方法是捕获资源的定义,安装和上次更改时间的详细信息。 有关更多信息,请参阅 标识对资源的更改 (资源特征符)。 请参阅 资源签名字段值摘要 ,以获取有关资源签名字段内容的详细信息。
选项
- ATTACHSEC (cvda)
- 对于基于 TCP/IP 的 ECI 和 IPIC 服务,返回连接所使用的连接时间用户安全性级别。 CVDA 值如下:
- LOCAL
- CICS 不需要来自客户机的用户标识或密码。
- 验证
- 入局连接请求必须指定用户标识和用户密码。
此选项对于 CICS Web Support TCP/IP 连接没有意义。
- ATTLS
- 返回 CVDA ,指示在 INQUIRE 时连接中是否涉及 AT-TLS。
- MIXED
- TCPIPSERVICE 接收到不受保护的连接和 AT-TLS 受保护的连接。 应该仅对使用 SSL (NO) 和 HOSTTYPE (ANY) 定义的 TCPIPSERVICE 返回此值。 它指示 AT-TLS 配置为仅保护某些入站连接。 建议您不要使用此配置。
- 未使用
- 未使用 AT-TLS 保护为此 TCPIPSERVICE 接收的任何连接。
- 未确定
- 无法确定是否为此 TCPIPSERVICE 配置了 AT-TLS 安全连接。 TCPIPSERVICE 已关闭或未接收任何入站连接。
- 已用
- 此 TCPIPSERVICE 仅接收到 AT-TLS 安全连接。
- AUTHENTICATE (cvda)
- 返回一个 CVDA ,指示用于认证客户机的方案。 可能的值包括:
- 自动登录
- 如果客户没有发送证书,则使用 HTTP从客户那里获取用户ID和密码。 否则,将使用 TLS 客户机证书认证来认证客户机。 如果客户证书未与用户ID关联,则使用 HTTP来获取客户用户ID,并将其与证书关联。
仅当协议值HTTP 时,才会返回该值。
- AUTOREGISTER
- TLS 客户机证书认证用于认证客户机。 如果客户证书未与用户ID关联,则使用 HTTP来获取客户用户ID并将其与证书关联。
仅当协议值HTTP 时,才会返回该值。
- basicAuth
- HTTP 基本认证用于从客户机获取用户标识和密码。
仅当协议值HTTP 时,才会返回该值。
- 认证
- TLS 客户机证书认证用于认证和标识客户机。
仅当协议值HTTP 时,才会返回该值。
- 不真实
- 客户机无需发送认证或标识信息。 但是,如果客户机发送已向安全管理器注册并与用户标识关联的有效证书,那么该用户标识将标识该客户机。
仅当协议值HTTP 时,才会返回该值。
有关 HTTP 客户端认证和识别的更多信息,请参阅 CICS 中的安全意味着什么? 》。
- BACKLOG (value)
- 返回可以在本地 TCP/IP 堆栈中排队以供此 TCP/IP 服务处理的最大连接请求数。 当 OPENSTATUS 为 CLOSED 或 OPEN 时,此字段显示从 TCPIPSERVICE 资源定义中获取的 BACKLOG 的定义值。 当 OPENSTATUS 为 OPEN 或 CLOSING 时,此字段显示用于定义本地 TCP/IP 堆栈对此服务允许的最大排队请求数的实际值。 SOMAXCONN 参数定义 TCP/IP 堆栈允许其管理的任何套接字的最大连接请求数。 如果 BACKLOG 值设置为零或大于 SOMAXCONN 的值,那么将假定 SOMAXCONN 值。 可以在 TCPIPSERVICE 资源中显示的最大值为 99999。 本地堆栈的 SOMAXCONN 值可以更大。 如果返回 99999 ,那么可以使用 netstat 来查询实际排队请求数。
- CERTIFICATE (data-area)
- 返回一个 32 个字符的区域,其中包含密钥环中的证书标签,该证书在此服务上的所有安全套接字层连接的 SSL 握手中用作服务器证书。
- CHANGEAGENT (cvda)
- 返回用于标识上次对资源定义进行更改的代理程序的 CVDA 值。 可能的值如下所示:
- CREATESPI
- 上次由 EXEC CICS CREATE 命令更改资源定义。
- CSDAPI
- 上次由 CEDA 事务或 DFHEDAP 的可编程接口更改资源定义。
- CSDBATCH
- DFHCSDUP 作业上次更改资源定义。
- DREPAPI
- 资源定义上次由 CICSPlex ® SM BAS API 命令更改。
- OVERRIDE
- 资源定义上次由资源覆盖文件中的覆盖规则的应用程序更改。
- SYSTEM
- 上次由 CICS 或 CICSPlex 系统更改资源定义。
- CHANGEAGREL (data-area)
- 返回上次更改资源定义时运行的 CICS 版本的 4 位数字:例如, 0 760 是 CICS TS for z/OS®, Version 6. 3 的标识符。
- CHANGETIME (data-area)
- 返回表示上次更改资源定义时的时间戳记的 ABSTIME 值。 有关 ABSTIME 值的格式的更多信息,请参阅 FORMATTIME。
- CHANGEUSRID (data-area)
- 返回运行更改代理程序的 8 字符用户标识。
- CIPHERS (data-area)
返回 56–character 区域,其中包含在 SSL 握手过程中与客户端协商使用的密码套件列表,或者返回 SSL 密码套件规范文件的名称,即 USSCONFIG 系统初始化参数指定的目录 security/ciphers 子目录中的 z/OS UNIX 文件。
如果未指定列表,那么缺省值是使用 defaultciphers.xml的密码套件规范文件。
- CLOSETIMEOUT (data-area)
- 以全字二进制格式返回此服务等待新请求的数据的秒数。 此数字可以是 0-86400 (24 小时)。 对于 HTTP ,不要指定0,因为此设置意味着无法保持持久连接。
- 连接数
- 以全字二进制格式返回此服务的套接字连接数。
- DEFINESOURCE (数据区域)
- 返回资源定义的 8 字符源。 DEFINESOURCE 值取决于 CHANGEAGENT 值。 有关更多信息,请参阅 资源签名字段值的摘要。
- DEFINETIME (数据区)
- 返回 ABSTIME 值,该值表示创建资源定义时的时间戳记。
- GENERICTCPS (数据区 )
- 返回此特定 TCP/IP 服务在用作 IPIC 高可用性集群中的配置的一部分时所关联的 8 字符通用 TCPIPSERVICE 名称。 仅当打开了两个 TCP/IP 服务时,才会显示此信息。 当没有通用 TCPIPSERVICE 或此通用 TCPIPSERVICE 已关闭时,此属性为空白。
- 主机 (data-area)
- 返回远程系统的 116 个字符的主机名或其 IP 地址。
HOST 显示字符主机名, IPv4 地址, IPv6 地址, ANY 或 DEFAULT。 HOST 选项为定义的主机名和定义的 IPv4 地址提供与 IPADDRESS 相同的功能,但也支持定义的 IPv6 格式地址。 但是,它与 IPADDRESS 不同之处在于,将返回 DEFAULT 和 ANY 而不是 IP 地址,因为此信息在 IPRESOLVED 中可用。 如果您正在使用 IPv6 连接,请将 HOST 选项用于查询,而不是 IPADDRESS。 HOST 将所有 IPv4 地址显示为本机 IPv4 点分十进制地址; 例如,1.2.3.4,而不考虑所使用的地址格式的类型。
可以多种可接受格式指定 IPv4 和 IPv6 地址。 有关地址格式的更多信息,请参阅 IP 地址 。
在资源定义中指定了 HOST。
- 主机类型 (cvda)
- 返回 HOST 的地址格式,或者如果未指定 HOST ,那么返回 IPADDRESS 选项。 HOSTTYPE 由域在安装 TCPIPSERVICE 时设置。 CVDA 值如下所示:
- 任何
- 为 HOST 选项指定了 ANY 选项。
- 缺省值
- 为 HOST 选项指定了 DEFAULT 选项。
- 主机名
- HOST 选项包含字符主机名。 将在域名服务器中查找与主机名对应的 IP 地址。
- IPV4
- HOST 选项包含点分十进制 IPv4 地址。
- IPV6
- HOST 选项包含冒号十六进制 IPv6 地址。
- NOTAPPLIC
- 在 HOST 选项中指定了 0.0.0.0 。
- INSTALLAGENT (cvda)
- 返回用于标识安装资源的代理程序的 CVDA 值。 可能的值如下所示:
- BUNDLE
- 资源是由捆绑软件部署安装的。
- CREATESPI
- 资源是由 EXEC CICS CREATE 命令安装的。
- CSDAPI
- 该资源由 CEDA 事务或 DFHEDAP 的可编程接口安装。
- GRPLIST
- 资源已由 GRPLIST INSTALL安装。
- INSTALLTIME (数据区)
- 返回表示安装资源时的时间戳记的 ABSTIME 值。
- INSTALLUSRID (数据区)
- 返回安装资源的 8 字符用户标识。
- IPADDRESS (data-area)
- 返回此服务的 15 个字符点分十进制 IP 地址。 请勿将 IPADDRESS 用于新程序; 请改为使用 HOST。 HOST 选项返回与 IPADDRESS 相同的信息,但也可以返回 IPv6 格式的地址。 如果 HOST 返回 IPv4 地址,那么此地址也将返回到 IPADDRESS; 否则, IPADDRESS 返回0.0.0.0.
- IPFAMILY (cvda)
- 返回 IPRESOLVED 选项的地址格式。 CVDA 值如下所示:
- UNKNOWN
- 尚未使用 IpresOLVED 或无法解析地址。 当 IPRESOLVED 为0.0.0.0.
- IPV4
- IPRESOLVED 选项包含点分十进制 IPv4 地址。
- IPV6
- IPRESOLVED 选项包含冒号十六进制 IPv6 地址。
- IpresOLVED (data-area)
- 在 39 个字符的区域中,返回 HOST 选项的 IPv4或 IPv6 地址。 如果 OPENSTATUS 选项未设置为 OPEN ,或者无法解析地址,那么值为0.0.0.0返回。 如果 HOST 选项设置为 ANY ,那么 IPRESOLVED 始终返回运行 CICS 的系统的 IPv4 地址,即使其他 IPv4 或 IPv6 地址可用也是如此。
- MAXDATALEN (data-area)
- 以二进制形式完整返回 CICS 作为 HTTP所能接收的最大数据长度的设置。
- MAXPERSIST (数据区域)
- 以全字二进制格式返回 CICS 区域在任何时候允许此端口使用的来自 Web 客户机的最大持久连接数的设置。 此设置仅适用于 HTTP。 空值 (-1) 表示对持续连接数不设限制。 零设置表示不允许任何持久连接。 零设置不符合 HTTP/1.1 ,在处理外部请求CICS中不得设置。
- NUMCIPHERS (data-area)
- 返回一个二进制半字数据区,其中包含在 CIPHERS 属性中指定的密码套件数。 如果 CIPHERS 包含文件名,那么此字段包含零。
- OPENSTATUS (cvda)
- 返回 CVDA ,指示服务的 CICS 内部套接字支持的状态。 CVDA 值如下:
- OPEN
- 针对此服务打开了 CICS 内部套接字支持。
- 打开
- 正在为此服务打开 CICS 内部套接字支持。
- CLOSED
- 尚未对此服务激活或结束 CICS 内部套接字支持。
- 关闭
- 正在关闭此服务的 CICS 内部套接字支持。
- IMMCLOSE
- 此服务的 CICS 内部套接字支持已立即终止。
- 正在关闭
- CICS 内部套接字支持正在执行立即终止过程。
- OPTIONSPGM (数据区)
- 返回与此服务关联的 HTTP的8个字符名称。
- 端口 (data-area)
- 以全字二进制格式返回 CICS 代表此服务侦听的端口号。
- 隐私 (cvda)
- 返回 CVDA ,指示与此服务的入站连接所需的 SSL 加密级别。 CVDA 值如下:
- 必需
- 必须使用加密。 在 SSL 握手期间,CICS 仅公布可以提供加密的受支持的密码套件。
- 受支持
- 在客户机和服务器都支持加密时使用加密功能。 在 SSL 握手期间,CICS 公布所有受支持的密码套件。
- NotSupported
- 不得使用加密。 在 SSL 握手期间,CICS 仅公布不提供加密的受支持的密码套件。
- PROTOCOL (cvda)
- 返回一个 CVDA ,指示正在此服务上使用的底层协议。 CVDA 值如下:
- ECI
- 外部 CICS 接口协议。
- HTTP
- 超文本传输协议。
- IPIC
- IP 互连 (IPIC)。
- USER
- 用户定义的协议。
- REALM (data-area)
- 返回 HTTP过程中使用的56个字符的领域。 仅当协议值HTTP 时,才会返回该值。 如果未指定此服务的领域,则返回 CICS 使用的默认领域,即
CICS application aaaaaaaa,其中 aaaaaaaa 是 CICS APPLID。 - SOCKETCLOSE (cvda)
- 返回 CVDA ,指示 TIMEOUT 值是否对此服务生效。 CVDA 值如下:
- WAIT
- 在定义上指定了 NO。 套接字无限期地接收等待数据。
- 超时
- 为定义上的 SOCKETCLOSE 参数指定了值。 CLOSETIMEOUT 返回指定的值。
- SPECIFTCPS (数据区
- 返回此通用 TCP/IP 服务在接收高可用性 IPIC 连接请求时使用的特定于 8 字符的 TCPIPSERVICE 名称。
- SSLTYPE (cvda)
- 返回指定用于此服务的安全套接字支持级别的 CVDA。 CVDA 值如下:
- CLIENTAUTH
- 正在将具有客户机认证的安全套接字层用于此服务。
- ATTLSAWARE
- CICS 查询客户机连接以确定 AT-TLS 是否处于活动状态。 感知应用程序将感知 AT-TLS,并且可以在 AT-TLS 策略中不使用任何高级设置的情况下查询诸如 AT-TLS 状态、合作伙伴证书和派生的 RACF® 用户标识等信息。 CICS 从 TCP/IP 检索客户机证书 (如果伙伴提供了客户机证书)。
- 无 SSL
- 安全套接字层未用于此服务。
- SSL
- 没有客户机认证的安全套接字层正用于此服务。
- TCPIPSERVICE (data-value)
- 指定要查询的 TCP/IP 服务的 1-to 8 字符名称。
- TRANSID (data-area)
- 返回用于开始处理新请求的任务的连接的 4 字符事务标识。
- URM (data-area)
- 返回要由附加任务启动的用户可替换程序的 8 字符名称。
条件
- END
- RESP2 值:
- 2
- 没有更多此类型的资源定义。
- ILLOGIC
- RESP2 值:
- 1
- 当此资源类型的浏览已在进行时,发出了 START 命令,或者当此资源类型的浏览未在进行时,发出了 NEXT 或 END 命令。
- NOTAUTH
- RESP2 值:
- 100
- 未授权与发出任务关联的用户使用此命令。
- NOTFND
- RESP2 值:
- 3
- 找不到 TCPIPSERVICE 资源。
