OPTION
Administration z/OS | Manager for RACF z/VM | Compliance and Auditing z/OS | Adapters for SIEM | ||||
Admin | Visual | Audit for RACF® | Audit for ACF2 | Audit for TSS | Alert | ||
• | • | • | • | • | • | • | • |
Use the OPTION
command to modify global, print, and
file options. For file option settings, the values you specify in an OPTION
statement apply to all files. If you want to apply specific options to a specified file, use the
FILEOPTION
command. See FILEOPTION.
The effects of OPTION
print settings (as opposed to global
or file options) depend on where the OPTION
statement or command is specified in
the CARLa program or
command input.
- When an option setting precedes the first occurrence of a
NEWLIST
statement, it sets the defaults for allNEWLIST
statements. - When an option is specified in a
BUNDLE
statement, it specifies the settings for allNEWLIST
statements that precede the matchingENDBUNDLE
statement. - When an option is specified in a
NEWLIST
statement or inside anOPTION
statement within theNEWLIST
statement, the options apply only to thatNEWLIST
statement. - In a
MERGELIST
context, mostOPTION
andNEWLIST
settings are taken from the firstNEWLIST
statement within theMERGELIST
andENDMERGE
statements. The settings from the otherNEWLIST
statements are ignored. - Print options are processed from left to right. Therefore, a print option that is early in the command can be silently overridden by a print options that is further to the right (for instance HEADER). Only in a few cases a message is issued, for example, about a print option not being able to locally override an option set by FILEOPTION (for instance NOPAGE).
- ACTIVITY_REPORT_INTERVAL=minutes
- This option can be used to request a message
CKR2103 Activity report interval ended at ...
with a timestamp, issued with the indicated frequency. The message shows local time of day and CPU time spent in the interval. It is followed by continuation lines that list input records that are processed (SMF or ACCESS) and output to TCP syslog, UDP syslog, and SNMP ports, as well as alert WTOs and remedial commands that are issued in the interval. By default, this option is not set. For CKQRADAR, this option is set in CARLa specification member CKQSPECL (see SCKRCARL for default). For CKQCEF, this option is set in CARLa specification member CKQCEFP (see SCKRSAMP for sample). - ALLOWRESTRICT
- When
you specify the
ALLOWRESTRICT
keyword, CARLa queries can contain restricted fields in restricted mode. MessagesCKR0170
,CKR0217
,CKR0384
,CKR1276
,CKR1382
, andCKR1455
are still issued, but with a severity 4 warning message instead of a severity 12 syntax error message.The
ALLOWRESTRICT
keyword is useful for running queries with restricted output fields and for complexSELECT
statements with both restricted and unrestricted fields. Specifying this option setting means that you can generate some output in restricted mode. Without this option, a query with restricted fields fails because of syntax errors.If you specify the
ALLOWRESTRICT
keyword in aNEWLIST
statement that selects on restricted fields in restricted mode, the select operation processes the restricted fields like missing fields. In reports, the columns for restricted fields are empty.The presence of a restricted field in a query's selection criteria might result in no output. If no output is available, the ISPF selection panel shows the following message:
CKRM948 No selections in scope.
If REQUIRED is also specified for any NEWLIST statement, then the message pertains only to those NEWLIST statements with the REQUIRED option. To prevent modification of a query in a manner that makes the query ineffective in restricted mode, you can specify the ALLOWRESTRICT keyword for individual output fields.You can suppress an entire query in restricted mode by specifying the UNRESTRICTED format modifier on the NEWLIST statement.
- AUTODETAILSELECT
- If a record display (not a summary level) has only one row/object, then the detail display is also automatically included. This behavior is not the default.
- AUTOSELECT
- If
a summary level has only one line, then automatically select the line with
S
action command. This behavior is the default. - BCC= email address list
- Sets the destination for blind carbon copy email messages. The
email address list variable specifies the list of recipients that are
confidentially copied on email messages. The value specified is a string that can be enclosed in any
type of quotation marks or specified without quotation marks. The string content is interpreted as
an address list conforming to the RFC (2)822 protocol, with some restrictions. For more information
about the restrictions, see MAILTOMT= email address list MAILTO=:deftype.field. If omitted, no RFC 2822
field
BCC:
is added to the email. - BUNDLEBY= variablename
- This
option setting only applies within a
BUNDLE...ENDBUNDLE
group and is documented with theBUNDLE
statement. See BUNDLE. Specifying theBUNDLEBY=
value on anOPTION
statement that precedes the firstBUNDLE
statement defines the default value. - CAPS
- See CAPS.
- CC= email address list
- Sets the destination for carbon copy email messages. The
email address list variable specifies the list of recipients that receive
an email in addition to the primary recipients specified by the
MAILTO
keyword.Specify a string value for the email address list with or without quotation marks. The string content is interpreted as an address list conforming to the RFC (2)822 protocol, with some restrictions. For information about the restrictions, see MAILTOMT= email address list MAILTO=:deftype.field. If omitted, the RFC2822
CC:
field is not added to the email. - CHECKSUM_ALG_CHANGE=number
-
This option facilitates migration to SHA algorithms in the Audit Libraries application (main menu option AU.L). It specifies the length of time interval in which zSecure assumes equality of checksums that zSecure Collect computes with different algorithms. In other words, if two CKFREEZE files are produced with different CHKALG= options and within number hours of each other, then data sets that have their fingerprints and anti-tamper digests stored in both CKFREEZE files are considered unchanged.
This option setting applies only to the MEMBER newlist type or zSecure option AU.L (Libraries). The maximum allowed value is 840, which corresponds with 5 weeks.
- CMDTOFILE
- Specify this option together with
the
CMD NEWLIST
statement to test the CARLa query without actually issuing commands. The commands are written to theC2RCMD
file. Verify that theC2RCMD
file has been configured for a usable line length of 4096. - COMPAREOPT=compareopt
- Specifies the default
COMPAREOPT
specification for allNEWLIST
statements that do not explicitly specify theCOMPAREOPT
option. Thecompareopt
value specified must match the name specified for a definedCOMPAREOPT
statement.If a default
COMPAREOPT
statement has been established by the specification of theFUNCTION=BASE
setting on an applicableALLOC
statement. You can use this default value by specifying valueCOMPAREOPT=DEFAULT
. - COND
- This field conditionally displays all fields unless it is locally
overridden with
UNCOND
orUNC
. It is displayed only if the result is not missing and not blank. The condition extends to the field separator, the prefix, the prefix separator, and the suffix separator.COND
suppresses the field separator before the field as field separators are always printed before the field. - ddname=name
DD=name
FILE=name
F=name - Specifies
the ddname or file name for the report output. The following rules apply to the ddname
specification.
- If the
DDNAME
keyword is used on theOPTION
statement before the firstNEWLIST
statement, it applies to allNEWLIST
statements. If theDDNAME
keyword is used on aNEWLIST
statement, it applies only to thatNEWLIST
statement. - If the
DDNAME
keyword is also specified on a precedingFILEOPTION
statement, the file options specified for theFILEOPTION
are used. - The following ddnames cannot be specified as a name value:
CKRUNLIN
,CKRUNLOU
,STEPLIB
,SYSABEND
,SYSUDUMP
,SYSMDUMP
,CNRSAMP
,CKRCARLA
,CKRTSPRT
,XMLIN
,XMLOUT
,CKRACF*
,CKRSMF*
. - For some ddnames that are specified as the name value, the actual ddnames that are affected might be different if the file has been redirected with an ALLOC statement. This rule applies to the following ddname values: SYSPRINT, CKRCMD, CMDOUT, CNROUT, and CKR2PASS.
- When specified as a name value, the ddnames CKRCMD and CMDOUT
are treated differently in the following respects.
- A different command output file is used for each complex. This requires sufficient TYPE=CMDOUT files to be available using ALLOC statements.
- TSO command line wrapping is activated and line continuation characters are used if the output record length is insufficient.
- The sequence number fields are blank. Sequence number fields are the first 8 positions for variable record length files, and the last 8 positions for fixed record length files.
- If the
- DETAILINHERIT
- Echo
the
DISPLAY
statement output for non-repeat group, non-detail fields for the selected object at the top of the detail display. This is the default setting for theDISPLAY
output. The echo includes multiple two-line entries showing the column header line and first line for each summary-level display and the column header and first line of the object-level display output. Specifying theDETAILINHERIT
keyword implies theDETAILSUMINHERIT
option setting. - DETAILSUMINHERIT
- Echo
the
DISPLAY
summary and non-repeat-group fields of the selected object at the top of the detail display. The echo includes multiple two line entries showing the column header line and first line for each summary-level display and the column header and first line of the object-level display. Specifying theDETAILSUMINHERIT
keyword implies theDETAILINHERIT
option setting.The
DETAILSUMINHERIT
option setting is automatically turned off when theNOSUMINHERIT
keyword is specified. - DISPLAYTOFILE
- When
running in ISPF, treat the
DISPLAY
statement as if it were aSORTLIST
statement. That is, write a batch report instead of creating an ISPF panel. TheDISPLAYTOFILE
keyword makes it possible to interactively test a query that can be specified for both ISPF and for a printed report, depending on anOPTION
command in the preamble. - EGN
- Format
profile names as if enhanced generic naming were active. Generally, the
EGN
keyword option setting is not required. However, it is helpful if you have just converted fromEGN
toNOEGN
because it can help identify profile names on the new system. The EGN keyword is not supported in restricted mode. - EMPTYLIST=HIDE
EMPTYLIST=SHOW
EMPTYLIST='string'
EMPTYLIST="string"
EMPTYLIST=`string`
EMPTYLIST=:ISPFvar - Specify
the action to be taken when a
NEWLIST
statement does not generate any output, when the query returns no record selections for example. This option setting specifies both the inclusion of theNEWLIST
report and the contents of the report itself. You can specify the following values.Table 1. Empty NEWLIST
output sets - Processing optionsProcessing option Processing behavior HIDE
- Suppress the empty table from the ISPF display panel.
- In the
SYSPRINT
, do not show that the NEWLIST report was run. - Suppress the empty page from a batch report
SHOW
Displays panel or report to show that the NEWLIST
statement was processed even if no output was generated. SHOW is the default setting for the option. The display panel and report output is processed in the following manner.- Show the empty table from the
NEWLIST
statement on the ISPF display panel. - In the
SYSPRINT
, include the title for theNEWLIST
report data. - Suppress the empty page from batch reports.
stringvalue or ISPFVAR
An extension of the SHOW
option, the text specified in stringvalue or by ISPFVAR is shown on the printed report.The
EMPTYLIST
keyword can be abbreviated toEMPTY
. For a bundle, theEMPTYLIST
keyword applies to each bundle value.If
SUPPRESS_IF_COMPARE
is in effect due to a comparison, that parameter overrides theEMPTYLIST
setting. SeeSUPPRESS_IF_COMPARE
in NEWLIST parameter descriptions. - ERRORMAILTO
EMT= email address list - If this keyword is specified in combination with the
BUNDLEMAILTO
keyword, reports for which no valid address is found are sent to the addresses specified in the list. This keyword also sets the addresses for the mail sender. If noFROM
orSMTPMAILFROM
value has been specified, the first address in this keyword also sets the default value for the SMTPMAIL FROM
setting. In that case, this default value specifies the address for any error reports or delivery warnings the email server issues when routing the message. The string content is interpreted as an address list conforming to the RFC (2)822 protocol, with some restrictions. For information about the restrictions, see MAILTOMT= email address list MAILTO=:deftype.field. - FIELDSEP=quoted-char
- This
designates the separator character that must be used before a field. The separator is generated
unless the concatenation operator is used, the field is the first on the statement, or the first
after a newline. A quoted-char is a character that is enclosed in any of the three quotation marks (single, double, or left quotation marks), or the word TAB
or NL.
FIELDSEP
is forbidden withHEADER
specifications that set it implicitly (other thanNO
andPREFIX
).HEADER=LEEF
sets it to TAB,HEADER=CSV
andHEADER=RFC4180
set it to ','. - FIRST_PER_NAME
- Suppress
a
NEWLIST
statement if it is preceded by anotherNEWLIST
statement with the same name. Only the firstNEWLIST
statement with a particular name is processed. Any subsequentNEWLIST
statement with the same name is suppressed. When aNEWLIST
statement is suppressed for this reason, theCKR1232
is issued. - FROM= email address list
- Sets the
From:
address list for an email.Specify a string value for the email address list with or without quotation marks. The string content is interpreted as an address list conforming to RFC 2822, with some restrictions. The string content is interpreted as an address list conforming to the RFC (2)822 protocol, with some restrictions. For information about the restrictions, see MAILTOMT= email address list MAILTO=:deftype.field.
If the
FROM=
keyword is omitted, the RFC 2822From:
field value is set to the value from the first available mail destination option. In priority order, the value is taken from one of the following keywords:SMTPMAILFROM
,ERRORMAILTO
, andREPLYTO
. - HEADER=CEF
- Request prefix headers that are compatible with the HPE Security ArcSight Common Event Format (CEF). This option sets:
It switches offNOPAGE COND PREFIXLEN=0 PREFIXSEP='=' REPLACE_CHAR=(('\n','\n'),('\r','\r'),('=','\='),('\','\\'),(NL,' ') )
SUFFIX_SEP
,FIELD_SEP
,QUOTE
,QUOTE_TRIGGER
,QUOTE_REPLACE_CHAR
, and column headers. This option is only available for print format output; it is not usable withDISPLAY
orDSUMMARY
. See Table 2 for a comparison of the properties that are set byHEADER
. - HEADER=COLUMN
- Display column headers. Do not use field prefixing. This setting is
the default unless NOPAGE is set. It switches off
TRIM
,PREFIX_SEP
,FIELD_SEP
,REPLACE_CHAR
,QUOTE
,QUOTE_TRIGGER
,QUOTE_REPLACE_CHAR
, and prefix headers. - HEADER=CSV
HEADER=RFC4180 - Request a layout that is compatible with the Comma Separated Value format, RFC4180. This option sets:
It switches offNOPAGE TRIM FIELDSEP=',' QUOTE='"' QUOTE_TRIGGER=(`"`, `'`, ' ', '&', ':', ';', '\', '`' NOTEXTDATA) QUOTE_REPLACE_CHAR=((`"`,`""`))
COND
,PREFIX_SEP
,REPLACE_CHAR
, prefix headers, and column headers. This option is only available for print format output; it is not usable withDISPLAY
orDSUMMARY
. Although RFC4180 defines ASCII ranges x20-21, x23-2B, and x2D-7E as non-TEXTDATA that triggers quoting, zSecure also triggers quoting when blank, quotation mark, ampersand, colon, semicolon, backslash, or backquote are found in the field. See Table 2 for a comparison of the properties that are set byHEADER
.Some CSV-consuming applications do not support hex zeroes in a string. RFC4180 only requires hex zero to trigger putting the whole cell in quotation marks. If that is a problem, add
NONULLS
to the print option as this replaces hex zero by blanks. Another option is to use theIFHEX
modifier to conditionally format values in hexadecimal. - HEADER=CSVT
- Same as
HEADER=CSV
, with the difference that the first record will show the field headers in a comma separated line. See Table 2 for a comparison of the properties that are set byHEADER
. The header line is not subject toQUOTE
andREPLACE_CHAR
processing; you need to make sure that the header is acceptable. - HEADER=LEEF
- Request prefix headers that are compatible with the IBM QRadar Log Event Enhanced Format (LEEF). This option sets:
It switches offNOPAGE COND FIELDSEP=TAB PREFIXLEN=0 PREFIXSEP='=' REPLACE_CHAR=((tab,' '), (NL,' '),(CR,' '),(FF,' '),(LF,' '),(NUL,' '))
SUFFIX_SEP
,QUOTE
,QUOTE_TRIGGER
,QUOTE_REPLACE_CHAR
, and column headers. This option is only available for print format output; it is not usable withDISPLAY
orDSUMMARY
. See Table 2 for a comparison of the properties that are set byHEADER
. - HEADER=NO
HEADER=NONE - Suppress column headers as well as prefix headers. This setting is the
default if NOPAGE is set. It switches off
COND
,TRIM
,PREFIX_SEP
,FIELD_SEP
,REPLACE_CHAR
,QUOTE
,QUOTE_TRIGGER
, andQUOTE_REPLACE_CHAR
. - HEADER=PREFIX
- Suppress column headers. Activate field comment prefixing. See also
PREFIX. It switches off
COND
,TRIM
,PREFIX_SEP
,FIELD_SEP
,REPLACE_CHAR
,QUOTE
,QUOTE_TRIGGER
,QUOTE_REPLACE_CHAR
, and column headers.The difference with
HEADER=PREFIX_ALL
is thatHEADER=PREFIX_ALL
also applies to SUMMARY output. - HEADER=PREFIX_ALL
- This requests prefix headers on SORTLIST, LIST,
DISPLAY, and SUMMARY output unless it is locally overridden with
NOPREFIX
orNOP
. It switches offCOND
,TRIM
,PREFIX_SEP
,FIELD_SEP
,REPLACE_CHAR
,QUOTE
,QUOTE_TRIGGER
,QUOTE_REPLACE_CHAR
, and column headers.The difference with
HEADER=PREFIX
is thatHEADER=PREFIX_ALL
also applies to SUMMARY output. - HEADER=RFC5424
- Request prefix headers that are compatible with RFC5424 (new syslog)
format. This option sets:
It switches offNOPAGE COND TRIM PREFIXLEN=0 PREFIXSEP='=' QUOTE=`"` QUOTE_REPLACE_CHAR=((`\`,`\\`),(`"`,`\"`),(`]`,`\]`))
SUFFIX_SEP
,FIELD_SEP
,REPLACE_CHAR
,QUOTE_TRIGGER
, and column headers. This option is only available for print format output; it is not usable withDISPLAY
orDSUMMARY
. See Table 2 for a comparison of the properties that are set byHEADER
. - HEADER=TSOCMD
- Request prefix headers that are compatible with the TSO command
format. This option sets:
It switches offNOPAGE TRIM PREFIXLEN=0 PREFIXSEP='(',SUFFIXSEP=')' QUOTE=`'` QUOTE_TRIGGER=(",; ", NOALPHANUM) QUOTE_REPLACE_CHAR=((`'`,`''`))
COND
,FIELD_SEP
,REPLACE_CHAR
, and column headers. This option is only available for print format output; it is not usable withDISPLAY
orDSUMMARY
. See Table 2 for a comparison of the properties that are set byHEADER
. - HEADER=TSV
- This generates a tab-separated value file similar to Definition of
TSV but without the top line with column headers. Fields values are trimmed and separated by
tabs. See also
HEADER=TSVT
to put headers in the first line. This option sets:
It switches offNOPAGE TRIM FIELDSEP=TAB REPLACE_CHAR=((tab,' '),(NL,' '))
COND
,PREFIX_SEP
,REPLACE_CHAR
, prefix headers, and column headers. This option is only available for print format output; it is not usable withDISPLAY
orDSUMMARY
. Tabs and new lines inside the values are replaced with blanks. - HEADER=TSVT
- This generates a tab-separated value file according to Definition of
TSV. Fields values are trimmed and separated by tabs, and the top line shows the column
headers. See also
HEADER=TSV
to suppress the column header. Tabs and new lines inside the values are replaced with blanks.Table 2. Comparison of HEADER specifications NO COLUMN PREFIX CSV CSVT TSV TSVT LEEF CEF RFC5424 TSOCMD COND No No No No No No No Yes Yes Yes Yes TRIM Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes FIELDSEP b b b , , TAB TAB TAB b b b Prefix header No No Yes No No No No Yes Yes Yes Yes PREFIXLEN 0/29-71 0 0 0 0 PREFIXSEP = = = ( SUFFIXSEP ) QUOTE " " " ' QUOTE_TRIGGER NOTEXTDATA
, b : ; \ & ' " `NOTEXTDATA
, b : ; \ & ' " `NOALPHANUM QUOTE_REPLACE_CHAR ","" \,\\ ",\"
],\]','' REPLACE_CHAR CR,b
FF,b
LF,b
NL,b
NUL,b
TAB,b\n,\n \r,\r
=,\= \,\\
NL,bNOPAGE free free Yes Yes Yes Yes Yes Yes Yes Yes Yes Column header No Yes No No Yes No No No No No No - HELPDETAILPANEL= panel
DETAILHELPPANEL=panel
DETHELPPANEL=panel - Set
the name of the ISPF help panel associated with a detail (repeat group) panel. The help panel is
taken from the
SCKRPLIB
. The default isC2R&CKREREL.nn@0
, where nn represents theNEWLIST
type. SeeFIELDS - Show CARLa fields available
in the User Reference Manual.For a
NEWLIST
type specified with aDEFTYPE
statement, you can specify a default help panel name on theDEFTYPE
statement. If you do not specify a value for the help panel, the value defaults to C2R&CKREREL.NN@0. The panel name is stored in ISPF variableCKRTHLPR
. The panel name specified can contain the variable &CKREREL, which is replaced with 2 (for z/VM) or 3 depending on the ISPF level. but not in the first position.When running on z/VM, if the help panel name starts with the string
C2R&CKREREL.
, this prefix is replaced withCKV
. For example, if the help panel name is C2R&CKREREL.HELP, the actual panel called is CKVHELP. - HELPPANEL= panel
- Set
the name of the ISPF help panel associated with the overview panel.
The
help panel is taken from the SCKRPLIB. The default value is
C2R&CKREREL.nn#0
, where nn represents theNEWLIST
type (seeFIELDS - Show CARLa fields available
in the User Reference Manual).For a
NEWLIST statement
type defined by aDEFTYPE
statement, the default help panel name can be specified on theDETYPE
statement. If you do not specify a value for the help panel, the value defaults toC2R&CKREREL.NN#0
. The panel name is stored in ISPF variableCKRTHLPP
. The panel name specified can contain the variable&CKREREL
, which is replaced with 2 (for z/VM) or 3 depending on the ISPF level. but not in the first position.When running on z/VM, if the help panel name starts with the string
C2R&CKREREL.
, this prefix is replaced withCKV
. For example, if the help panel name is C2R&CKREREL.HELP, the actual panel called is CKVHELP. - LINELEN= value
LINELENGTH=value
LL=value - See LINELENGTH.
- MAILFONTSIZE
MFS= - Sets the HTML font size for email. The HTML font size is a number in the range 1–7 and corresponds to one of the following point sizes: 8, 10, 12, 14, 18, 24, and 26 point size if the browser default font is set at 12 point. The default is 1. The user can change the default point size.
- MAILTO
MT= email address list MAILTO=:deftype.field - Requests that the
NEWLIST
results are emailed to the addresses specified. This keyword must be either a string or an indirect reference to a field in a file defined with the DEFTYPE command. See DEFTYPE and Field value manipulation. With an indirect reference, the addresses found in each record specify the email recipients. The general RFC 2822 syntax states that an email address must include a local part, followed by an @ sign, followed by a host part,user_id@host.net
for example. If the address contains other special characters for routing or other purpose, it must be enclosed in < and >,<@mailgate:user_id@host.net>
for example. A list of email addresses can be specified, separated by commas.The following restrictions apply to the RFC 2822 syntax.- Quotation marks are not supported within a quoted string within a phrase.
- Line continuation within the RFC 822 string must conform to the CARLa string line continuation syntax–that is, continue on the first character of the next line. The line continuation does not conform to the RFC 822 line continuation syntax–that is, end with a comma and start the next line with a leading white space.
- The canonized length of the phrase is limited to 512 characters. Canonized length means that white space is eliminated if it is not permitted by the RFC 821 protocol or reduced to one blank if it white space is required.
- Phrase atoms equal to
&system
,&SYSTEM
, or&System
are replaced by the SMF system ID where the program is running. - Phrase atoms equal to
&jobname
,&JOBNAME
, or&Jobname
are replaced by the JES job name where the program is running.
The subject of the email is taken from the title or toptitle specified on the
NEWLIST
statement. This value overrides the DD and FILE specifications set previously.Note: If any of theMAILTO
keywords are specified, verify that the SMTPWRITER and SMTPCLASS options settings are valid, or include a C2REMAIL DD statement with an allocation to the SMTP writer. For more information, seeC2REMAIL
inSupported file definitions
in the User Reference Manual. You must also include at least one sender address on either the FROM, REPLYTO, SMTPMAILFROM, or ERRORMAILTO keyword. The email function of zSecure is not intended to be combined with the INFOPRINT email support.Note for VM users: When using any of the MAILTO options, no direct connection with the SMTP server is made. Instead, the SMTP command stream is written to the C2REMAIL file if it is not already present. Then, you can specify that this file be sent to the SMTP server.
- MASKTYPE= type
- Set the way filters are interpreted. The type can be either EGN or ACF2. If your product contains an ACF2 component and no RACF components, then the default setting is ACF2 masking. In the other cases, EGN masking is the default setting. For a DOMAIN in an old syntax STANDARD statement, the External Security Manager (ESM) parameter of the STANDARD statement determines the default mask type. If the ESM is limited to ACF2, the mask type defaults to ACF2. Otherwise, it defaults to EGN.
- MAXP= number
MAXPAGE=number
PRTMAXP=number - See MAXPAGE.
- MSGRC=(msgno, level)
- Change
the severity of specific messages to the indicated value. This keyword is supported for the
following message numbers only.
- 171 - Class not in descriptor table.
- 172 - ICHCNX00 problem.
- 231 - (SUB/TOP)TITLE must occur before fields.
- 438 - Storage shortage processing SMF.
- 617 - Security database is missing.
- 1322 - Unsupported segment segment.
- 1788 - UNIX file system audit ID not unique.
- 2151 - WRAP layout not well-defined.
- 2202 - Conflicting jobname for ASID.
- 2266 - Warning that the SEGMENT= specification on a NEWLIST does not appear to match the segment selection of that newlist
- 2287 - Newlist option FLATTEN(field) has no effect (on DOMAIN statement OPTION parameter).
- 2289 - Newlist option FLATTEN(field) has no effect (on NEWLIST statement).
- 2335 through 2337 - Warning that the SUPPRESS options (for example, LICENSE=, ESM=, UNRESTRICTED) on the NEWLISTs within a MERGELIST seem to be incompatible.
- 2339 - Warning that the value for the SEGMENT parameter in a select clause in a RACF report is not known to the program.
- 3082 - Simulated risk level without a proper ID.
MSGRC
keyword is only supported for theOPTION
command. - MY_CCSID= number
- Change the default EBCDIC encoding value of 1047 to the specified number value. If you change the encoding, there is no guarantee that all program-generated text can be read. For example, if you change the default encoding, the output of the RECORDDESC field in NEWLIST TYPE=SMF might not be readable. The MY_CCSID keyword is supported only on OPTION statements.
- NOACTION
- Suppresses action characters on ISPF panels, even if the actions are available. When you specify this keyword, the action character column is not included in the panels. If you do not specify this keyword, the default behavior is to analyze the permissions for each action character on a record-by-record basis. Based on the results, each record entry is modifiable or non-modifiable. You can also use the NOACTION keyword for individual NEWLIST statements.
- NOAUTODETAILSELECT
- If a record-level display has only one row, do not automatically show detailed information. This behavior is the default setting because scrolling to the right on the detail does not scroll to the right on the record level display.
- NOAUTOSELECT
- Controls the selection behavior on summary level display panels that include only one summary line. The default behavior is to automatically select the summary line. Use the NOAUTOSELECT keyword to disable the automatic selection.
- NODETAILINHERIT
- Suppress automatic display of the non-detail line and its column header. Specifying this option gives the detail display more room, but leaves it to the query writer to show the object key somewhere on the display.
- NODETAILSUMINHERIT
- Suppresses repetition of summary information for the detail display. This behavior is implied when the NOSUMINHERIT keyword is specified
- NOEGN
- Format profile names as if enhanced generic naming (EGN) was not active. Profiles that would be supported by EGN but not by NOEGN can be found by searching for a colon (:). This option can be helpful if you have converted profile names from NOEGN to EGN and are considering returning to the NOEGN format. You cannot specify this option in restricted mode.
- NOMAIL
- Turns off the email function for any NEWLIST statements that occur after this NOMAIL setting is specified. This setting turns off any default email setting specified by a preceding OPTION command.
- NOMODIFY
- For ISPF display panels, specify this option to make NEWLIST output read-only when it is initially shown. This parameter overrides the initial setting. After the information is shown, users can specify the MODIFY or SET MODIFY ON options to make the display modifiable. The MODIFY setting in the application profile for the user ID is not changed.
- NONULLS
- See NONULLS.
- NOPAGE
- See NOPAGE.
- NOQUOTE
- If
NOQUOTE
is specified on a field, the field values are never quoted, regardless of the newlist-wideQUOTE
settings. - NOSEP
- This print option can be used to request that no field separators are being written out by print format output, as requested by LIST, SORTLIST, and SUMMARY commands. It is implied by newlist option SMF1154.
- NOSMFTOFILE
- This option can be used to reset an earlier SMFTOFILE option. See also NEWLIST parameter SMF1154 and OPTION parameter SMFTOFILE.
- NOSMTPTOFILE
- Turns off SMTPTOFILE redirection for the NEWLIST. This is a local option that only applies to the current NEWLIST. If this option is specified, any output from the NEWLIST is sent by email.
- NOSUMINHERIT
- Disables echo behavior for the DISPLAY summary lines and headers for the selected object. By default, an echo is shown that includes two lines: the column header line and the first line for each summary-level display.
- NOTEMPTY
- Suppress
empty lines for print format output (LIST, SORTLIST and SUMMARY). This is similar to adding
NOTEMPTY
to every first field of the line. See also COND for field level suppression. TheNOTEMPTY
property can also be used on the first field of the line. SeeNOTEMPTY
in Field headers and automatic formatting. - NOWARNING
- Reset the return code to 0 when warning messages have been issued. If the internal return code is set to 4 or less as a result of warning messages, the return code is reset to 0 at the end of the CARLa run. This option is valid only on the OPTION command.
- NOWTOFILE
- Turns off WTOFILE redirection for the NEWLIST. This is a local option that only applies to the current NEWLIST. If this option is specified, any NEWLIST output is sent by WTO message.
- NULLS
- See NULLS.
- OUTLIM= n
- This halts output processing for subsequent LIST/SORTLIST/DISPLAY/SUMMARY command if the indicated number of records has been selected for output processing.
- ONLYAT
- Provides support for targeted deletion of data set profiles from nodes in an RRSF
network if profiles are no longer in use by any other node in the system. The intent of the ONLYAT
option is to prevent the accidental deletion of RACF database profiles that protect an existing
resource.
Multi-system support can direct RACF commands through the RRSF network. In an RRSF configuration, deletion of a data set profile from any RACF database by a CARLa-generated command is not permitted if the profile is still in use by any RRSF node in the network. CARLa suppresses the generation of profile delete commands that are valid for some RRSF nodes but not all. You can override the default behavior and allow CARLa to generate profile delete commands that are directed at a specific node by using the ONLYAT option.
For this support to function correctly, system (CKFREEZE) images must be available for all systems being analyzed, either through an active zSecure Network Server connection, or by allocating them directly.
If the zSecure ONLYAT option is not specified, CARLa suppresses the generation of a DELDSD command if a data set profile is in use on any RRSF node in the network. A profile cannot be deleted as long as it is in use on at least one RRSF node.
If the zSecure ONLYAT option is specified, CARLa generates the DELDSD command that would have otherwise been suppressed and adds the ONLYAT keyword to:- Allow deletion of a profile on a target RRSF node if the profile is no longer in use
- Prevent deletion of a profile that is in use on other RRSF-connected nodes
This keyword is specified in conjunction with the
VERIFY PERMIT
,VERIFY NOTEMPTY
, andVERIFY ALLNOTEMPTY
options to add theONLYAT
parameter to generated RACF commands that support theONLYAT
parameter. - OPTIMIZE=[STORAGE|IO]
- This option can be used to select
the bias of the program to save virtual storage at the expense of doing more I/O (OPTIMIZE=STORAGE)
or to minimize I/O at the expense of using more virtual storage (OPTIMIZE=IO). The default is IO. In
the user interface, the option OPTIMIZE=STORAGE can be set under option SETUP RUN
(SE.0) by placing a check mark, as in
/ Use IO in preference to storage (mainly for RA.U/D/R/G queries)
It is unpredictable what will give the best result in general. Performance is a trade-off between storage use, I/O, and CPU. It also depends on the characteristics of the data analyzed, and on the characteristics of the query. OPTION OPTIMIZE=STORAGE, when activated, tries to minimize the virtual storage used at the expense of doing more I/O. Depending on the efficiency of the I/O, this can take longer. On the other hand, storing less information in storage also means using less CPU to do so, which in turn takes less time. Which of the factors has the upper hand depends on the RACF database, on the query, and on your hardware. So the net effect in terms of CPU and elapsed time varies from case to case.
The option only has an effect for basic RACF database queries like searching for a user's name in RA.U, or searching for a qualifier in RA.D, but not for auditing reports.
- OUTPUTFORMAT=TEXT
OUTPUTFORMAT=EMAILDEFAULT
OUTPUTFORMAT=ATTACH - Specifies the method for including the results from a NEWLIST
in an email. The following values are supported.
TEXT
includes the report inline as plain-text with limited HTML encoding. This is the only valid format for reports that are not emailed.ATTACH
includes the report as an attachment. This is the default value for emailed XML NEWLIST data. This format is also required if UTF-8 encoding is specified.EMAILDEFAULT
includes the report inline as MIME or HTML with limited HTML encoding. This is the default value for non-XML NEWLIST data.
- OVERPRINT= n
OVP=n - See OVERPRINT.
- PAGEALIGN= value
- Ensures
that the output from a NEWLIST statement for a specific BUNDLE value starts at a multiple of the
value specified for the PAGEALIGN keyword. This behavior is achieved by
generating empty pages at the end of the previous until the alignment is met. For example, if
PAGEALIGN=4 is specified, the NEWLIST output can start on page 5, 9, or 13, but not on page 6. This
feature can safely be combined with the PAGERESET keyword.
The PAGEALIGN= keyword is a normal OPTION setting that propagates to all NEWLIST statements. As a result, if the PAGEALIGN= keyword is specified on a BUNDLE statement, it applies to each NEWLIST statement within a specific bundle value.
When applied to a NEWLIST statement outside of a bundle, the PAGEALIGN= setting applies only to that NEWLIST statement.Note: If you specify the PAGERESET keyword in a stream of CARLa command input with multiple in combination with multiple PAGEALIGN= keywords with different values, the result might not be as expected. - PAGELENGTH= number
PAGELEN=number
PL=number - See PAGELENGTH.
- PAGERESET
- Reset
the page number of NEWLIST output for a specific bundle value to 1 at the
start of the report. You can safely combine this keyword with the PAGEALIGN= keyword on the first
NEWLIST in the BUNDLE only, and not on the BUNDLE statement.
The PAGERESET= keyword is a normal OPTION setting that propagates to all NEWLIST statements. As a result, if the PAGEALIGN= keyword is specified on a BUNDLE statement, it applies to each NEWLIST statement within a specific bundle value. The best way to restart page numbering for each bundle value is to specify the PAGERESET on the first NEWLIST statement in the bundle rather than specifying it on each NEWLIST statement within the bundle.
When applied to a NEWLIST statement outside of a bundle, the PAGERESET setting applies only to that NEWLIST statement. - PREFIXLEN=nn
- Specifies the length of the prefix
headers for output from a NEWLIST statement. If this OPTION setting precedes the first NEWLIST
statement, it applies to all output. You can include prefix headers in both detail displays and
print detail output by specifying the output modifier PREFIX or the NEWLIST option HEADER=PREFIX.
The following syntax rules and guidelines apply to the PREFIXLEN keyword.
- To use variable length trimmed prefix headers use 0. This is only supported on
print format output and not on a
DISPLAY
orDSUMMARY
command. - The minimum and default fixed length is 29.
- The maximum length is 70.
- You can specify the SYMBOLIC option to define a number that represents the value in the
following example.
PREFIXLEN=name|29
- If you specify a large value for the PREFIXLEN keyword, the space available for the variable output can be smaller if the value was specified with overriding length of 0, which is interpreted as until end of line or end of screen.
- You can also control the prefix length value from the NEWLIST clause in a LANGUAGE statement.
- To use variable length trimmed prefix headers use 0. This is only supported on
print format output and not on a
- PREFIXSEP=quoted-char
- Designates
the separator character that must be used between a field value prefix header and the value. A
quoted-char is a character enclosed in any of the three
quotation marks (single, double, or left quotation marks, or the word TAB or NL.
PREFIXSEP
is forbidden withHEADER
specifications that set it implicitly (other than NO and PREFIX). HEADER=LEEF and HEADER=CEF set it to '='. HEADER=TSOCMD sets PREFIXSEP to '(' and SUFFIXSEP to ')'. - QUOTE=quoted-char
This designates the character that must be used to surround field values when they must be quoted. If
NOQUOTE
is specified on a field, its values are not quoted. Otherwise,QUOTE_TRIGGER
specifies the condition under which field values must be quoted. IfQUOTE_TRIGGER
is absent, the values for all other fields are always quoted. SeeQUOTE_TRIGGER
. A quoted-char is a character that is enclosed in any of the three quotation marks (single, double, or left quotation marks), or the word TAB or NL.The
QUOTE
parameter is forbidden with HEADER specifications that set it implicitly (other than NO and PREFIX).HEADER=CSV
andHEADER=RFC5424
set it to a double quotation character (").HEADER=TSOCMD
sets it to a single quotation character (').If characters within the quoted string need to be replaced, for example, for quote doubling or escaping certain characters by preceding them with a backslash, the QUOTE_REPLACE_CHAR print option can be used in conjunction. The quoting is not applicable to fixed strings; if characters need to be escaped there you must use the
REPLACE_CHAR
parameter on theNEWLIST
statement.- QUOTE_REPLACE_CHAR=(('string1','string2'),("string1",`string2`)...)
QUOTE_REPLACE_CHAR=(("string1","string2")...)
QUOTE_REPLACE_CHAR=((`string1`,`string2`)...) - This
is a list of replacements that must be done when field values are quoted (see
QUOTE
andQUOTE_TRIGGER
). The second string (string2) replaces the first string (string1) in the pair.Each replacement pair is enclosed in parentheses. Each string in the pair must be enclosed in one of the three quotation marks (single, double, or left quotation marks), or be TAB or NL. Line breaks inside the
QUOTE_REPLACE_CHAR
list are only supported outside a pair specification, that is, after the comma separating pairs. Both the 'from' and the 'to' strings can be more than one character. Like with most print options, the lastQUOTE_REPLACE_CHAR
specification wins. - QUOTE_TRIGGER
- This is a list of characters; if any of these characters is present, the field values
are quoted (except when a field includes the NOQUOTE modifier). If
QUOTE_TRIGGER
is omitted, these field values are always quoted. Each character must be enclosed in one of the three quotation marks (single, double, or left quotation marks), or be TAB or NL. Like with most print options, the lastQUOTE_TRIGGER
specification wins. If NOQUOTE is specified on a field, the field values are never quoted (seeQUOTE
). - RACF_CCSID
- This option specifies what code set (CCSID) is to be used to convert the NAME and INSTDATA fields in the RACF database to UTF8. The result is visible only in TYPE=RACF fields DATA_UTF8 and NAME_UTF8.
- REPLACE_CHAR
- This
is a list of replacement pairs. Each replacement pair is enclosed in parentheses. Each string in the
pair must be enclosed in one of the three quotation marks (single, double, or left
quotation marks), or be CR, FF, LF, NL, NUL, or TAB. When a value is formatted for a field, the second string in the pair replaces the first
string. The
REPLACE_CHAR
substitution applies after conditional quoting andQUOTE_REPLACE_CHAR
processing, and also applies to fixed strings. So theREPLACE_CHAR
can be used even if quoted characters or escape characters used in the quote replacement themselves must be escaped to make a valid file for transmission. Line breaks inside theQUOTE_REPLACE_CHAR
list are only supported outside a pair specification, that is, after the comma separating pairs. Both the 'from' and the 'to' strings can be more than one character.Like with most print options, the last
REPLACE_CHAR
specification wins. TheREPLACE_CHAR
processing can be suppressed locally on a field of string by adding a NOREPL modifier. - REPLYTO= email address list
- Sets the Reply-To: address list for an email. The
string value can be specified with or without quotation marks. The string content is interpreted as
an address list conforming to the RFC (2)822 protocol, with some restrictions. For information about
the restrictions, see MAILTOMT= email address list MAILTO=:deftype.field. If omitted, the RFC 2822 field
Reply-To: is set to 'Reply-To: DontReply@AutoGenerated'.
In addition, the address list can serve as a default value for the MAILFROM and FROM keywords.
- REQUIRED
- This
option only applies when running from the ISPF interface. If the REQUIRED option is specified for
any NEWLIST statement, at least one of the NEWLIST statements with REQUIRED setting must select at
least one record. If this criterion is not satisfied, you are returned to the selection panel with
ISPF message
CKR769 Nothing selected.
- RESTART_INTERVAL=value
- This option can be used to periodically restart the program. All files are closed and re-opened
and program storage freed and reallocated. A small amount of persistent state information is
retained to be able to successfully enrich SMF records (kept in storage above the 2GB boundary); for
example, transient Db2 and CICS information. The restart can be delayed if not all required data
sets are available.
The interval value is specified in minutes. It must be in the range of 10 to 1440 minutes (24 hours). It is possible to request a task to be restarted earlier by issuing an
F jobname,RESTART
operator command. Note that a restart deletes and replaces the current content of the output data sets of the currently running program unless they were routed to spool or allocated with DISP=MOD. The time interval starts after reading CKFREEZE files and processing of the security database; so it starts shortly before the start of SMF processing. After a manual F jobname,RESTART command, the restart interval is restarted. - RESTRICT_AUDITOR
- Specifies that the NEWLIST statement is processed only if the program is run by a system-wide RACF auditor. Otherwise, the NEWLIST statement and the commands within its context are ignored. Because the commands are skipped, no error message is issued.
- SERIALIZATION(serialization-options)
- Specify which measures the program must take to ensure data integrity for zSecure data
sets, like CKFREEZE, UNLOAD, ACCESS, and SMF data sets. Also specifies the action to take when all
required resources are not immediately available. For serialization to operate properly, all jobs
involved must specify the same resource name. That is, all jobs must specify the same value for the
ENQ request. To safeguard against other zSecure programs
updating the data sets, specify ENQ on CKRDSN. To safeguard against
non-zSecure programs
updating the data sets, specify ENQ on SYSDSN. The ENQ on SYSDSN is only
possible when you use the APF authorized CKRCARLX program.
There are situations where using an ENQ only on CKRDSN does not provide full protection against failures. For example, when a data set must be allocated in preparation for DSNPREF DELETE processing or when a data set is allocated in JCL using DISP=OLD or DISP=NEW. In such situations, the system uses an exclusive ENQ on SYSDSN. When you are using program CKRCARLA (or when running under TSO), the ENQ on SYSDSN is not available. You might encounter IKJ56225I messages that indicate that the data set is allocated to another job or user. To avoid most data set allocation failures, you can use the CARLa ALLOC option ASAPFREE or the JCL DD keyword FREE=CLOSE. When you use these options, the release of the ENQ on SYSDSN held by the system nearly coincides with the release of the ENQ on CKRDSN by the zSecure program. As a result, using an ENQ only on CKRDSN might be sufficient for all practical purposes.
The following values can be specified for the serialization options.
- ENQ(qnames)
-
Serialization option to provide data integrity and input data availability by specifying that the program issues the appropriate ENQ request. You can specify the following sub-parameters to indicate the desired type of processing.
- CKRDSN
- The program issues a sysplex-wide ENQ with this QNAME for all zSecure data sets, like CKFREEZE, UNLOAD, ACCESS, and SMF data sets. The ENQ is a shared enqueue for data sets that are read-only. It is an exclusive enqueue for data sets that the program writes to. The ENQ(CKRDSN) specification safeguards only against other zSecure jobs that use the same data sets. This method guarantees that no other process attempts to refresh an UNLOAD or a CKFREEZE data set while the data set is being processed.
- SYSDSN
- The program issues a system-wide shared ENQ request with this QNAME for all
zSecure
data sets that the program processes except for the following types:
- CARLa input data sets like the CARLa script library.
- Output data sets that are job-specific, like SYSPRINT and SYSTERM.
- Based on the DISP= specification, the operating system also issues an enqueue for SYSDSN for data sets that are allocated through JCL. To avoid internal deadlocks, the program ignores the ENQ(SYSDSN) specification for data sets that are already allocated through JCL or the TSO ALLOC statement.
Issuing an ENQ request for QNAME SYSDSN requires that you use the APF-authorized CKRCARLX program. The enqueue on SYSDSN can be combined with the CKRDSN enqueue.
This option is mutually exclusive with the NOENQ keyword.
- FAIL
- This serialization option specifies that the program is to stop further processing if the data sets for which an ENQ is requested are not immediately available. This option is mutually exclusive with WAIT. If neither is specified, FAIL is the default.
- MAXWAIT(nn)
- This serialization option specifies the maximum time the program waits for the data sets for which an ENQ is requested to become available, in minutes. Supported values are in the range 1 – 59, inclusive, with a default value of 5 minutes. The MAXWAIT setting is only effective when it is specified in combination with the WAIT serialization option.
- NOENQ
- Specifies that no ENQ requests are to be issued. This option is mutually exclusive with the ENQ serialization option.
- UNIT
- Specifies that dynamic allocation is not performed until a unit becomes available to satisfy the allocation request. This setting applies mostly to tape data sets. This option requires that the program be APF-authorized.
- VOLSER
- This serialization option specifies that, if need be, dynamic allocation is not performed until the required volser becomes available. It applies mostly to tape data sets. This option requires that the program be APF-authorized.
- WAIT
- Specifies that the program waits until the required data sets are available. This applies to both the ENQ(CKRDSN) and the ENQ(SYSDSN) options. The WAIT option is mutually exclusive with the FAIL serialization option. You can also use the MAXWAIT serialization option to set a maximum wait time. After the MAXWAIT time has passed, the program issues an error message and stops.
By default, the program uses the following settings for the SERIALIZATION keyword:
SERIALIZATION(ENQ(CKRDSN),FAIL)
- SERVERTOKEN=ServerToken
- A keyword that specifies the eight-character suffix for the name of the name-token pair used for locating the Program Call (PC) information for the zSecure Server. The specified value is prefixed by the value CKNACTIV. The default value for SERVERTOKEN is PRODSERV. If this keyword is not specified, the default value is used. Specifying a value for the SERVERTOKEN is required if you run multiple zSecure servers on the same system or if the value for the zSecure server is not the default.
- SETROPTS_REFRESH_ON_END
- Generate interactive SETROPTS REFRESH commands for selected profiles at the end of the CARLa run. This option is only valid on the OPTION command.
- SITE_BANNER=[name|name(member)]
- The
SITE_BANNER option specifies the DD name and optional member
name of a file with the standard mandatory logon warning banner as your
organization specified it. The default is CKA@CUSV(NOTICE).
zSecure compares it with logon warning banners that TN3270 Telnet and z/OS UNIX Telnet servers
display:
- The USSTAB_CONTAINS_BANNER flag field in NEWLIST TYPE=EXIT shows whether each line from the SITE_BANNER file occurs in the first 64KB of a USS table. The USS table stores banner strings that TN3270 Telnet servers display
- The TELNET_POSTBANNER_MATCH and TELNET_PREBANNER_MATCH flag fields in NEWLIST TYPE=SYSTEM show whether each line from the SITE banner file occurs in the first 64kB of the /etc/otelnetd.banner and /etc/banner files, respectively. These files store banner strings that z/OS UNIX Telnet servers display.
- SMF1154_REQUEST=string
- This option can be passed to the program to select what Request ID must be written into the SMF 1154 record common section. Normally, the ENF 86 listener CKCS1154 does this automatically.
- SMFTOFILE
- This option can be used to write this newlist's output to the CKCSMF DD name instead of passing the record to SMF. See also NEWLIST parameter SMF1154.
- SMTPATSIGN=at-sign
- This global option specifies the single character that SMTP uses instead of @ from the default codepage 1047 (hex value X'7C') to indicate the start of the domain of an email address. The value of this parameter must match the ATSIGN option of the SMTP or CSSMTP server and it must be enclosed in quotation marks.
- SMTPCLASS= sysoutclass
- See file option SMTPCLASS.
- SMTPMAILFROM= email address list
- Specifies the email address list for routing emails. The first address
in the list sets the RFC (2)821 SMTP header MAIL FROM address for emails. Email servers along the
delivery route send error reports and delivery warnings to the specified address. In addition, the
full address list can serve as a default for the FROM address.
Specify the email address as a string enclosed with any type of quotation mark or specified without any quotation mark. The string content is interpreted as an address list conforming to the RFC (2)822 protocol, with some restrictions. For information about the restrictions, see page MAILTOMT= email address list MAILTO=:deftype.field. If omitted, the RFC 2821 field MAIL FROM is completed from the first available option in the order FROM, REPLYTO, and ERRORMAILTO. To send email, at least one of the following four options must have been specified: SMTPMAILFROM, FROM, REPLYTO, or ERRORMAILTO.
- SMTPNJENODE= nodename
- See file option SMTPNJENODE.
- SMTPTOFILE
- This option can be set to redirect email (SMTP) output. The default destination is DD C2RSMTP. Only output generated as the result of a MAILTO or BUNDLEMAILTO keyword is redirected. It is meant for testing purposes, to be specified preceding the first NEWLIST statement. If specified on or after a NEWLIST, it only applies to an email specification on that NEWLIST.
- SMTPWRITER= name
- See file option SMTPWRITER.
- SNMPTO= destination:port
SNMPTO=(destination:port,destination:port, ...) - If
the SNMPTO= keyword specification precedes the first NEWLIST statement or if it is specified on a
NEWLIST statement that specifies the SNMP option, it determines the output destination for SNMP
traps. If SNMPTO= is omitted, the default destination for SNMP output is the normal file output in
file C2RSNMP by default.
The destination can be a name looked up through DNS or an IP address. The destination can be followed by an optional colon and port specification in decimal form. If the destination is an IPv6 address containing at least one colon character and it is followed by a colon and a port specification, enclose the value in square brackets. For example,
[::1]:1169
where::1
is the IPv6 address and1169
is a port number. This specification is different from::1:1169
, where 1169 is the last part of the IPv6 address::1:1169
, and where no port specification is present. Square brackets around an IP address are optional if the address is not followed by a port specification or if the address is IPv4. - SNMPTOFILE
- Redirects
SNMP output. The default destination is DD C2RSNMP. Only output generated as the result of an SNMP
keyword is redirected. The SNMPTOFILE keyword is helpful for testing output.
Make sure the SNMPTOFILE keyword precedes the first occurrence of the NEWLIST statement. If specified on or after a NEWLIST statement, the keyword applies only to the SNMP specification for that NEWLIST statement. For this keyword, the RECFM and LRECL settings for the C2RSNMP file are used, which default to a logical line length of 132 bytes for printed output files. To simulate the line length used when writing SNMP traps, you need an effective line length of 1056 bytes and therefore you must specify values of RECFM=VB,LRECL=1060 for the C2RSNMP allocation.
- SUFFIXSEP=quoted-char
- Designates
the separator character that must be used at the end of a field value if a prefix is present. A
quoted-char is a character that is enclosed in any of the three
quotation marks (single, double, or left quotation marks), or the word TAB or NL.
SUFFIXSEP
is forbidden withHEADER
specifications that set it implicitly (other than NO and PREFIX). HEADER=TSOCMD sets it to ')'. - SUMHELPPANEL= panel
HELPSUMPANEL=panel - Set
the name of the ISPF help panel associated with the summary panel. The help panel is taken from the
SCKRPLIB
. The default is the value ofHELPPANEL
. The value is stored in ISPF variableCKRTHLPS
. The panel name specified can contain the variable &CKREREL, which is replaced with 2 (for z/VM) or 3 depending on the ISPF level, but not in the first position. So for example, C2R&CKREREL.HELP becomes CKVHELP (for z/VM) or C2R3HELP (for z/OS). - SUMINHERIT
- Echo the DISPLAY summary line and header of the selected object at the top of the record display. The echo includes a multiple of two lines: the column header line and first line for each summary-level display. It is on by default.
- SYSLOGTCP=destination[:port]
SYSLOGTCP=(destination[:port],destination[:port],…) - If
the
SYSLOGTCP=
specification precedes the firstNEWLIST
statement or if it is specified on aNEWLIST
statement that specifies the SYSLOG option, it determines the output destination for TCP SYSLOG traps.The destination can be a name from a DNS or IP address lookup. The default port is 514. For more information, see the SNMPTO= keyword description. You can also specify a destination ID for the destination, but in that case the optional port must be specified on the DESTINATION statement, and cannot be specified as a SYSLOGTCP parameter. Note that the destid on the DESTINATION statement is case sensitive.
For more information about syslog destination alternatives, see the description of the SYSLOG option for the NEWLIST statement.
- [SYSLOGTO|SYSLOGUDP]=destination[:port]
[SYSLOGTO|SYSLOGUDP]=(destination[:port],destination[:port],…) - If
the
SYSLOGTO=
orSYSLOGUDP=
specification precedes the firstNEWLIST
statement or if it is specified on aNEWLIST
statement that specifies the SYSLOG option, it determines the output destination for UDP SYSLOG messages.The destination can be a name from a DNS or IP address lookup. The default port is 514. For more information about IP addresses, see the SNMPTO= option description.
For more information about syslog destination alternatives, see the description of the SYSLOG option for the NEWLIST statement.
- SYSLOGTOFILE
- Redirects output to the default syslog file C2RSYSLG. To redirect
output for all NEWLIST statements with SYSLOG specified, you must specify this keyword before the
first NEWLIST statement. Only output generated as the result of a SYSLOG keyword is redirected. The
SYSLOGTOFILE keyword can also be specified on a NEWLIST statement to apply to that NEWLIST
only.
Use the SYSLOGTOFILE keyword to send syslog output to a file for testing. When you specify this keyword, the LRECL and RECFM settings for the C2RSYSLG file are used, which default to a logical line length of 2048 bytes for printed output files. To accommodate the RFC5424-defined maximum line length of 2048 used when writing syslog output, specify RECFM=VB,LRECL=2052 for the C2RSYSLG allocation. If you specify SYSLOGTOFILE on a NEWLIST statement, the redirection applies only to that NEWLIST statement.
- TCP_BUFFER_KB=size
- This option can be used to help diagnose problems by varying the buffer size that is used for accumulating traffic to syslog TCP destinations. The number that is given is multiplied by 1024 to give the size in bytes. The minimum is 4; the maximum is 256. The default and recommended size is 64.
- TCP_KEEPALIVE_INTERVAL=seconds
- This option can be used to request TCP syslog connections to exploit the KEEPALIVE option with the indicated interval in seconds. For instance, if a firewall is set to drop connections after five minutes of idle time, dropping of connections can be prevented by adding an OPTION TCP_KEEPALIVE_INTERVAL=240 statement to request a four minute interval of TCP keep-alive messages. The default is 0 (no KEEPALIVE interval).
- TOPTITLE,TT
TITLE,T
SUBTITLE,ST
PAGETEXT - See the (TOP)TITLE option on the NEWLIST command.
- TRIM
- If this parameter is specified, it trims all
field values unless a specific length override is used on the field. This is similar to adding a
modifier '0' to all fields in a
SORTLIST
statement. Use PREFIXLEN=0 to trim prefix headers. - UNRESTRICTED
NONPADS - Specifies
that the
NEWLIST
statement is only processed if the program is running in unrestricted (non-PADS) mode. Otherwise, ignore the NEWLIST statement and the commands within its context. Because the commands are skipped, no error message is issued.Note: You can use the ALLOWRESTRICT keyword to suppress output from restricted fields in restricted mode instead of suppressing the entire query. - WTOTOFILE
- This option can be set to redirect WTO output. The default destination is DD C2RWTO. Only output generated as the result of a WTO keyword is redirected. Use the WTOTOFILE keyword for verifying WTO output during the test process. If this keyword precedes the first NEWLIST statement, the setting applies to all NEWLIST statements that do not specify the setting directly. If the keyword comes after the first NEWLIST statement, it only applies to a WTO specification on that NEWLIST statement.