z/OS Communications Server: IP Programmer's Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


IPSec NMI control request formats

z/OS Communications Server: IP Programmer's Guide and Reference
SC27-3659-02

Control request record formats vary with each request type.

  • The following section, NMsecTunnel, is used across several record types.
  • All EBCDIC fields are blank-padded and they are not NUL-terminated.
Table 1. NMsecTunnel field descriptions
Field Offset Length Format Description
NMsTunName 0 48 bytes EBCDIC The name that is associated with the tunnel. This name comes from a Policy Agent configuration file.
  • For manual tunnels, this is an IpManVpnActionName name.
  • For dynamic IPSec tunnels, this is a LocalDynVpnRuleName name.
  • For IKE tunnels, this is a KeyExchangeRuleName name.
This field must be set to blanks when a tunnel name is not specified.
NMsTunTunnelID 48 48 bytes EBCDIC The tunnel ID that is associated with this tunnel. This field is used for any refresh and deactivation requests. This field must be set to blanks when a tunnel ID is not specified.
NMsTunStatus 96 1 byte Binary Tunnel Status. This field is set to 0 on a request message. On a response this field is set to the status of the tunnel's state change. Valid state values are as follows:
NMsec_TUNSTATUS_NOTFOUND (1)
The requested tunnel was not found.
NMsec_TUNSTATUS_STATEUPDATED (2)
The tunnel's state was updated.
NMsec_TUNSTATUS_STATEALREADYSET (3)
The tunnel's state was already set to the state requested.
NMsec_TUNSTATUS_NOKER (5)
Applicable only to dynamic tunnel activation, this status indicates that there is no KeyExchangeRule rule corresponding to the requested LocalDynVpnRule rule.
NMsec_TUNSTATUS_NOFILTER (6)
Applicable only to dynamic tunnel activation, this status indicates that there is no dynamic IPSec IpFilterRule rule corresponding to the requested LocalDynVpnRule rule.
NMsec_TUNSTATUS_NODATAOFFER (7)
Applicable only to dynamic tunnel activation, this status indicates that the IpDataOffers defined on the dynamic IPSec IpFilterRule, corresponding to the requested LocalDynVpnRule, could not be used.
NMsTunRsvd1 97 3 bytes Binary Reserved. Must be set to 0.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014