Statements/parameters for IXGCNFxx

CTRACE(parmlib_member_name)
Specifies the member of SYS1.PARMLIB that contains the tracing options to be used when the z/OS® system logger component is initialized (IXGLOGR address space starts) or when a SET IXGCNF command is entered. You can specify a CTnLOGxx parmlib member name.

Use this statement to provide initial tracing options while system logger is starting and as an alternative approach to issuing a CTRACE command to specify tracing options other than those in default member CTILOG00. For information about coding the component trace member of SYS1.PARMLIB, see CTncccxx (component trace parameters).

Logger converts the input to a TRACE CT,ON,COMP=SYSLOGR,PARM=CTnLOGxx command. Look at the syslog for IEE538I or other error messages to verify the options specified in the parmlib_member_name are accepted. You can verify the logger tracing options in effect by using the D TRACE,COMP=SYSLOGR command.

For more information about viewing (D TRACE) the current system logger trace settings and specifying new options for the system logger (SYSLOGR) component trace, see z/OS MVS System Commandsz/OS MVS Diagnosis: Tools and Service Aids and z/OS MVS Diagnosis: Tools and Service Aids, respectively.

Value range: The 8 character member name must be in the format CTnLOGxx where:
n
An alphanumeric character to specify the source of the member. IBM-supplied members will use "I".
xx
Any two characters.
Default: CTILOGOO
MONITOR
Provide system logger monitoring specifications.
OFFLOAD
Specify the initial and secondary delay intervals for monitoring system logger log stream offload activity. See Offload and Service Task Monitoring in z/OS MVS Setting Up a Sysplex for more information about the logger offload monitoring.
WARNALLOC(initial-delay-interval)
Specifies the amount of time, in seconds, allowed before the log stream offload monitor will start issuing warning message indicating an offload is delayed waiting for a data set allocation or deletion request to complete.

If the data set allocation and/or deletion request does not complete within this interval, system logger issues message IXG310I to warn the operator of the log stream offload being delayed. If this value is not less than the ACTIONALLOC secondary-delay-interval, then logger will not issue the IXG310I warning message as part of its log stream offload monitoring.

D LOGGER,IXGCNF[,MONITOR] displays system logger monitoring settings.

Value range: Must be a decimal number from 5 to 86400 seconds (meaning 5 seconds to 24 hours, respectively).

Default: 30 (30 seconds, 1/2 minute)

ACTIONALLOC(secondary-delay-interval)
Specifies the amount of time, in seconds, allowed before the log stream offload monitor will issue messages to allow possible action be taken by the installation because of an offload being delayed waiting for a data set allocation or deletion request to complete.

If the data set allocation and/or deletion request does not complete within this interval, system logger issues messages IXG311I identifying the log stream and data set resources, and logger also issues WTOR message IXG312E to allow action to be taken if necessary.

D LOGGER,IXGCNF[,MONITOR] displays system logger monitoring settings

Value range: Must be a decimal number from 5 to 86400 seconds (meaning 5 seconds to 24 hours, respectively).

Default: 60 (60 seconds, 1 minute)

WARNRECALL(initial-delay-interval)
Specifies the amount of time, in seconds, allowed before the log stream offload monitor will start issuing warning message indicating an offload is delayed waiting for a migrated data set recall request to complete.

If the migrated data set recall request does not complete within this interval, system logger issues message IXG310I to warn the operator of the log stream offload being delayed.

If this value is not less than the ACTIONRECALL secondary-delay-interval, then logger will not issue the IXG310I warning message as part of its log stream offload monitoring.

D LOGGER,IXGCNF[,MONITOR] displays system logger monitoring settings.

Value range: Must be a decimal number from 5 to 86400 seconds (meaning 5 seconds to 24 hours, respectively).

Default: 60 (60 seconds, 1 minute)

ACTIONRECALL(secondary-delay-interval)
Specifies the amount of time, in seconds, allowed before the log stream offload monitor will issue messages to allow possible action be taken by the installation because of an offload being delayed waiting for a migrated data set recall request to complete.

If the migrated data set recall request does not complete within this interval, system logger issues messages IXG311I identifying the log stream and data set resources, and logger also issues WTOR message IXG312E to allow action to be taken if necessary.

D LOGGER,IXGCNF[,MONITOR] displays system logger monitoring settings.

Value range: Must be a decimal number from 5 to 86400 seconds (meaning 5 seconds to 24 hours, respectively).

Default: 120 (120 seconds, 2 minutes)

Start of changeLSPRIMARYEnd of change
Start of changeSpecify the log stream primary (interim) storage monitoring.End of change
Start of changeCONSUMPTIONALERT(ALLOW | SUPPRESS)End of change
Start of changeSpecifies whether log streams defined with WARNPRIMARY(YES) will issue log stream primary storage consumption alert messages on this system when the imminent threshold is exceeded or an entry threshold occurs, or for any log stream when a primary storage full consumption point is reached.

ALLOW indicates that the primary storage consumption and offload messages will be issued if the log stream is defined with the correct parameters.

SUPPRESS indicates that this system will suppress any alerts or messages, regardless of the log stream definition.

Seez/OS MVS Setting Up a Sysplex.

Display LOGGER,IXGCNF[,MONITOR] system logger monitoring settings.

Default: ALLOW

End of change
ZAI
Specify the definitions for the z/OS IBM zAware log stream client socket communication and log data buffering details in order to send log stream data to the IBM zAware server.

By default, no communication with the IBM zAware server will occur unless it is explicitly requested and the z/OS IBM zAware log stream client requirements are established.

See Preparing for z/OS IBM® zAware log stream client usage in z/OS MVS Setting Up a Sysplex for more details on establishing and using z/OS IBM zAware log stream clients.

SERVER({NONE | host_name | IP_addr})
Specifies the host name (as defined by domain name system, DNS) or TCP/IP location where the "IBM System z® Advanced Workload Analysis Reporter" (z/OS IBM zAware) server is running and will receive the z/OS IBM zAware log stream client data.
NONE
Indicates no IBM zAware server is desired and does not indicate a server name. Therefore, no z/OS IBM zAware log stream client is to be established by system logger.
host_name
Specifies the canonical host name, as defined by DNS, where the IBM zAware server is located:
  • Consist of alphabetic letters (A-Z), numeric digits (0-9), hyphens(-) and periods(.),
  • Consist of 1 to multiple sections (labels) of 1-63 characters separated by a period(.),
  • Alphabetic characters are case insensitive,
  • Each section must start and end with either an alphabetic character (A-Z) or numeric digit (0-9). For example: WWW.IBM.COM
Note: The DNS server does not need to be up and running when the IXGCNFxx parmlib member is processed as the host_name and will be resolved when the z/OS IBM zAware log stream client needs to make a connection to the IBM zAware server (see more details below).
IP_addr
Specifies an IP address for the IBM zAware server location. Can be either IPv4 or IPv6 address format.
IPv4_address must be specified as a dotted decimal quad: ddd.ddd.ddd.ddd format, that is:
  • Must have 3 dots(.) and the rest of the characters must be decimal numbers (0-9),
  • Start of changeMust consist of 4 sections of 1-3 decimal digits separated by dots(.),End of change
  • The decimal digits must represent numbers between 0 and 255.
  • Leading (non-significant) zeros for each number can either be specified or suppressed.
  • Start of changeMinimum length is 7 characters, maximum length is 15 characters.End of change

For example: 192.0.2.255

IPv6_address must be specified with colons as delimiters, that is:
  • Must have 2 to 7 colons (:) and contain hexadecimal numbers (0-9, A-F, a-f),
  • Start of changeConsist of up to 8 sections of 0-4 hexadecimal numbers separated by a colon(:).End of change
  • Start of changeLeading (non-significant) zeros for each number can either be specified or suppressed.End of change
  • Start of changeWhen all 8 sections are not specified, then zero compression via double colons must be used and can only appear once to designate the zero compression range.End of change
  • Start of changeIP address cannot start or end with a colon unless part of a double-colon (zero compression range).End of change
  • Start of changeSection specified prior to a double colon (zero compression range) correspond to left-justified sections 1 through nth specified section, and sections specified after the double colon correspond to right-justified sections 8 down to number of sections following double colon.End of change
  • Start of changeMinimum length is 2 characters, maximum length is 39 characters.End of change
For example: Start of change
SERVER(2001:db8:85a3::8a2e:370:7334)
has 3 sections before and 3 sections after the double colon, so it would yield 16 byte (4 word) value of 20010DB8 85A30000 00008A2E 03707334.
SERVER(2001:db8:85a3::8a2e:370)
has 3 sections before and 2 sections after the double colon, so it would yield 16 byte (4 word) value of 20010DB8 85A30000 00000000 8A2E0370.
End of change
Start of change
Note: When specifying an IPv6_address, all the routers in the path of the socket connection between the z/OS IBM zAware client and IBM zAware server must also support IPv6 format addresses, otherwise the socket connection can fail when attempted.
End of change

When a value other than NONE is provided, the z/OS system logger component will establish a socket connection for communication with the IBM zAware server on behalf of a z/OS IBM zAware log stream client. By default, no communication with the IBM zAware server will occur unless it is explicitly requested and thez/OS IBM zAware log stream client requirements are established.

D LOGGER,IXGCNF[,ZAI] and D LOGGER,STatus,ZAI commands display the details on the system logger z/OS IBM zAware log stream client information.

Value range: Up to 64 characters, consisting of alphabetic characters (A-Z), numeric digits (0-9), periods (.), colons (:), and hyphens (-).
  • Considered an IPv6 address if there are colons (:).
  • Considered and IPv4 address if there are numeric digits (0-9) and periods(.), but no alphabetic characters (A-Z) or hyphens(-).
  • Otherwise is considered a host_name, unless NONE meaning no IBM zAware server. See format details above.

Default: None

Start of changeDefault port number for ZAI server is 2001.End of change

PORT(port_num)
Identifies the port number associated with the SERVER specification for the IBM zAware server, as shown in the following examples:
  • PORT(3801)
  • PORT(10120)

D LOGGER,IXGCNF[,ZAI] and D LOGGER,STatus,ZAI commands display the details on the system logger z/OS IBM zAware log stream client information.

Value range: 1 to 65535 (up to 5 digits).

Start of changeDefault: 2001End of change

LOGBUFMAX(value)
Identifies the maximum amount of storage buffers (in gigabytes) to be used by system logger for managing z/OS IBM zAware log stream client data being sent to the IBM zAware server. Allows clients ability to set a threshold (for their environment) on the amount of (pageable, above the 2 gigabyte bar) storage that could be utilized on their z/OS system in the case of spiking or inhibited data flow to the IBM zAware server.

If the maximum for these storage buffers are used, then any new log stream data needing to be sent to the IBM zAware server will be lost. See LOGBUFFULL specification on how system logger will handle the z/OS IBM zAware log stream client data when a storage buffer full condition occurs.

D LOGGER,IXGCNF[,ZAI] and D LOGGER,STatus,ZAI commands display the details on the system logger z/OS IBM zAware log stream client buffer usage.

Value range: 1-99 (in gigabytes)

Default: 2 (2 gigabytes)

LOGBUFWARN(nn)
Specifies the z/OS IBM zAware log stream client manager buffer warning level percentage when system logger will start issuing message IXG375E.

When the z/OS IBM zAware log stream client manager is using this percent of overall buffer space (see LOGBUFMAX), message IXG375E will be issued. As the buffer pool is expanded/extended by the next incremental amount, system logger will issue an updated instance of IXG375E with the new buffer storage percent in use indication. As in-use system logger z/OS IBM zAware log stream client buffers are no longer needed, the buffers will be released and message IXG375E will be issued for the new percent in use.

When the overall percentage of buffers in use is at least 5% below the LOGBUFWARN value, system logger will DOM message IXG375E.

D LOGGER,IXGCNF[,ZAI] and D LOGGER,STatus,ZAI commands display the details on the system logger z/OS IBM zAware log stream client buffer usage.

Value range: 10-90 (10% to 90%)

Default: 75 (75% of LOGBUFMAX value)

LOGBUFFULL({MSG|QUIESCE})
Specifies the action to be taken by system logger when the z/OS IBM zAware log stream client manager buffers become full (see LOGBUFMAX).

MSG indicates system logger should continue attempting to send log data to the IBM zAware server and keep a count of the number of log blocks that could not be buffered and were lost. When buffers become available, then message IXG383I will be issued indicating that not all the log data was sent to the IBM zAware server.

QUIESCE indicates that when system logger reaches the full amount of buffers then disconnect the socket connection to the IBM zAware server. The socket connection will remain disconnected until either a SETLOGR command (for example, SETLOGR FORCE,ZAICONNECT,ALL) or SET IXGCNF command that has specifications to connect to the IBM zAware server. No z/OS IBM zAware log stream client data will be maintained while in the quiesced state, meaning the buffers holding the log data for this purpose will be released (freed). Logger will issue message IXG382I for each log stream that is quiesced.

D LOGGER,IXGCNF[,ZAI] and D LOGGER,STatus,ZAI commands display the details on the system logger z/OS IBM zAware log stream client buffer usage.

Default: MSG