TcpImage and PEPInstance statement
Use the TcpImage and PEPInstance statements to specify a TCP/IP image and its associated image configuration file to be installed to that image. These statements are synonyms and you can use either of them. If no TcpImage statement is specified, any policy definitions are installed to the default TCP/IP image (resolver supplied TCPIPuserid statement or TCPIPjobname statement). The parameters FLUSH or NOFLUSH can be used to force deletion of some policy types from the stack at startup and certain other events. The parameters PURGE or NOPURGE can be used to delete some policy types from the stack during normal shutdown (for example, KILL or STOP).
A single stack environment is defined in BPXPRMxx parmlib member by setting 'FILESYSTYPE TYPE(INET)'. For more information, see z/OS UNIX System Services Planning.
- If one or more TcpImage statements are specified, Policy Agent always uses the default TCP/IP image (resolver supplied TCPIPuserid statement or TCPIPjobname statement). All associated policy control statements are installed to the active TCP/IP stack.
- If no TcpImage statement is specified, any control statements are installed to the active TCP/IP stack.
- If Policy Agent cannot determine the name of the TCP/IP image (resolver supplied TCPIPuserid statement or TCPIPjobname statement), INET is the default name used. Any control statements are installed to the active TCP/IP stack.
- The default TCP/IP stack name is used in messages and displays. Policy Agent creates an internal TcpImage statement with default values to represent the specified TCP/IP image.
- The interface used by the stack to inform the Policy Agent about stack restarts does not function.
Syntax
Parameters
- name
- The jobname of the TCP/IP image.
Requirement: The name must be one to eight characters in length.
- path
- The path of the image configuration file to be installed. If an
image configuration file is not specified, the following policy definitions
(if any) in this policy configuration file are installed. You can specify an MVS data set name or a z/OS® UNIX file name. MVS data set names must be enclosed in single quotation marks (' ') and preceded by a double slash (//). Following are examples of both types of names:
TcpImage TCPIP1 //'USER1.PAGENT.CONF(TCPIP1)' FLUSH PURGE TcpImage TCPIP1 /u/user1/pagent.tcpip1 FLUSH PURGE - FLUSH
- Specifies that all policies installed in the Policy Agent and
the TCP/IP stack are deleted when:
- A new TcpImage statement is processed for the first time, including Policy Agent starting.
- A MODIFY PAGENT,REFRESH command is entered.
- NOFLUSH
- Specifies that all policies installed in the Policy Agent and the TCP/IP stack are to remain during initial startup and at each refresh interval. In addition, policies that are deleted from a configuration are not deleted from the Policy Agent or the TCP/IP stack. This is the default.
- PURGE
- Specifies that all policies installed in the TCP/IP stack are deleted during normal termination, and also when a TcpImage or PEPInstance statement is deleted.
- NOPURGE
- Specifies that all policies installed in the TCP/IP stack remain
during normal termination and when a TcpImage or PEPInstance statement
is deleted. This is the default.
For details, see the FLUSH and PURGE considerations in z/OS Communications Server: IP Configuration Guide.
- i
- An integer that specifies the time interval (in seconds) for checking the creation or modification time of the configuration file or files, and for refreshing policies from the LDAP server. The maximum value is 2 147 483 647. In the following cases, the update interval is changed:
- If a value is not specified, the default is 1 800 seconds (30 minutes).
- If a value of 0 is specified, the default value of 1 800 (30 minutes) is used.
- Any value in the range 1 - 59 is rounded up to 60 seconds (1 minute).
The Policy Agent always uses this time interval to check for changes, but also monitors the configuration file or files in real time if the -i startup option is specified. The smallest refresh interval specified on the set of TcpImage statements is used as the refresh interval for the main configuration file.
For example, if -i is set to 300, the corresponding configuration files and LDAP server are checked for changes every five minutes. If the configuration file or files have changed within the last 5 minutes, they are read again. The LDAP server (if configured) is also queried again for policies. Any new, changed, or deleted policies are installed to or removed from the stack as appropriate.
Restriction: Dynamic monitoring for file updates using the -i startup option is supported only for z/OS UNIX files; MVS data sets are not monitored for changes.
- If the Policy Agent was started with the -i startup option, no further action is necessary. Active policies are automatically installed to the stack when it becomes active.
- If the Policy Agent was not started with the -i startup option, take one of the following actions:
- Issue the MODIFY REFRESH or MODIFY UPDATE command after the stack becomes active. If the MODIFY REFRESH or MODIFY UPDATE command is issued before the stack becomes active, policies are not automatically installed.
- Wait on the next update interval to check for configuration changes. If the stack is not active, policies are not automatically installed.
Examples
The following example installs the image configuration file /tmp/TCPCS.policy to the TCPCS TCP/IP image, after flushing existing policy control data:
TcpImage TCPCS /tmp/TCPCS.policy FLUSH