Updating Ironstream parameter cards - ironstream_for_servicenow_event_mgmt - 7.4

Ironstream for ServiceNow® Event Management for IBM Z Installation

Product type
Software
Portfolio
Integrate
Product family
Ironstream
Product
Ironstream > Ironstream for ServiceNow® Event Management
Version
7.4
Language
English
Content type
Installation
Product name
lronstream for ServiceNow® Event Management for IBM Z
Title
Ironstream for ServiceNow® Event Management for IBM Z Installation
Copyright
2022
First publish date
2007
Last updated
2023-09-04
Published on
2023-09-04T17:10:40.523800

Modify initialization parameter cards to match the resources you have configured for the Ironstream client configuration. The parameter card dataset member(s) are pointed to by the SYSIN DD of the started task.

The Ironstream parameter cards are located in:

hlq.SAMP (DDMPARM)

Parameter cards may contain system symbols to ensure uniqueness if the same dataset member is being used for multiple LPARs. Symbols must start with an ampersand (&) and must end with a period if the symbol substitution occurs in the middle of a string. For example, to incorporate the value of &SYSNAME. into the name of the console defined for the CMD subtask, the parameter card would look like:

CMD &SYSNAME.CON

Note: Strings resulting from symbol substitution must conform to the length and syntax requirements of the parameter.

 A detailed description of the parameter cards are as follows.

CMD Parameter Card

Provides Ironstream with the ability to issue z/OS (MVS) commands.

Valid Values

consname [LOG|NOLOG] [HC={YES|NO}]

Sample Syntax

CMD EVOCONS2 NOLOG HC=YES

Description

This card will initialize the CMD subtask, which is used to send z/OS (MVS) commands from Ironstream to the mainframe OS.

Parameters
consname Required. Specify a 1-8 character name for the extended MCS console you wish to define for issuing z/OS (MVS) commands. If this name is defined in RACF, the OPERPARM values in the RACF entry for this name are used for the console definition. Otherwise, a console is defined with default parameters AUTH=MASTER and ROUTCDE=NONE. (See Appendix A for information on defining an extended console to RACF.)
LOG|NOLOG Optional. Specify LOG to force a system log message to be written for all z/OS commands entered from an Ironstream server. The commands are recorded in the system log with an EVO033 message. Specifying NOLOG here suppresses the writing of the EVO033 message. NOLOG is the default.
HC={YES|NO} Optional. Specify HC=YES to record all commands and responses from this extended console in the mainframe hardcopy log. HC=NO will prevent any hardcopy logging of the commands that are sent in from the Ironstream client. HC=NO is the default.

DELAY Parameter Card

Number of seconds to wait until the next attempt to restart a subtask.

Valid Values

1 to 86400 (seconds)

Sample Syntax

DELAY 45

Description

Specifies the amount of time (in seconds) before a subtask attempts restarting itself following a termination. The maximum delay time allowed is 86,400 seconds (one day). Each subtask parameter card can be coded with its own unique delay time. Customize any subtask by entering in the desired DELAY card immediately before the subtask card. Any DELAY value entered becomes the default for all subsequent subtask cards.

The delay time reflects how quickly a needed resource can be recovered. A TCP subtask may require time to reset the port through which the workstation is connected. The default DELAY value is 30 seconds.

DROP_AUTOMATION_FLAGGED Parameter Card

Indicates whether to drop MVS messages with the 'Automation Requested' flag set.

Valid Parameters

{YES|NO} [LOG]

Sample Syntax

DROP_AUTOMATION_FLAGGED YES LOG

Description

The DROP_AUTOMATION_FLAGGED parameter card is used to capture or drop MVS messages with the “Automation Requested” bitflag set.

Parameters
YES | NO “YES” indicates that a message with the Automation Requested flag will be suppressed. “NO” indicates that the message will not be automatically suppressed, but the message ID must still be present in the message filter table to be passed on to the OM server. “NO” is the default.
LOG Optional. Add the LOG parameter to force any suppressed messages to be written to the NOMATCH log. (This parameter is only relevant if the NOMATCH logging subtask has been defined and is active.)

DROP_HARDCOPY_ONLY Parameter Card

Indicates whether to drop MVS messages with the 'Hardcopy Only' flag set.

Valid Parameters

{YES|NO} [LOG]

Sample Syntax

DROP_HARDCOPY_ONLY NO LOG

Description

The DROP_HARDCOPY_ONLY parameter card is used to capture or drop MVS messages with the “Hardcopy Only” bitflag set. This parameter is only relevant when the HC=YES option is used on the MVS parameter card.

Parameters
YES | NO “YES” indicates that a message with the Hardcopy Only flag will be suppressed. “NO” indicates that the message will not be automatically suppressed, but the message ID must still be present in the message filter table to be passed on to the OM server. “YES” is the default.
LOG Optional. Add the LOG parameter to force any suppressed messages to be written to the NOMATCH log. (This parameter is only relevant if the NOMATCH logging subtask has been defined and is active.)

DROP_MPF_SUPPRESSED Parameter Card

Indicate whether to drop MVS messages with the “MPF Suppressed” flag set.

Valid Parameters

{YES|NO} [LOG]

Sample Syntax

DROP_MPF_SUPPRESSED YES LOG

Description

The DROP_MPF_SUPPRESSED parameter card is used to capture or drop MVS messages with the “Message Suppressed by MPF” bitflag set.

Parameters
YES | NO “YES” indicates that a message with the “MPF Suppressed” flag will be suppressed. (This can also be accomplished by setting the "AUTO=NO" option on the MVS subtask definition card.) “NO” indicates that the message will not be automatically suppressed, but the message ID must still be present in the message filter table to be passed on to the OM server. “NO” is the default.
LOG Optional. Add the LOG parameter to force any suppressed messages to be written to the NOMATCH log. (This parameter is only relevant if the NOMATCH logging subtask has been defined and is active.)

DROP_SSI_SUPPRESSED Parameter Card

Indicate whether to honor the SSI suppression flag on MVS messages.

Valid Parameters

{YES|NO} [LOG]

Sample Syntax

DROP_SSI_SUPPRESSED YES LOG

Description

The DROP_SSI_SUPPRESSED parameter card is used when another application on the mainframe sets the Subsystem Interface (SSI) suppression flag on MVS messages (usually for the purpose of message filtering). Use this card if messages with the SSI flag should not be forwarded on to the OM server.

Parameters
YES | NO “YES” indicates that SSI suppression should be honored, and those MVS messages with the SSI flag set will not be forwarded to the OM server. “NO” indicates that the message will not be automatically suppressed, but the message ID must still be present in the message filter table to be passed on to the OM server. “NO” is the default.
LOG Optional. Add the LOG parameter to force any suppressed messages to be written to the NOMATCH log. (This parameter is only relevant if the NOMATCH logging subtask has been defined and is active.)

DROP_WTO_USER_EXIT_SUPPRESSED Parameter Card

Indicate whether to honor the WTO User Exit suppression flag on MVS messages.

Valid Parameters

{YES|NO} [LOG]

Sample Syntax

DROP_WTO_USER_EXIT_SUPPRESSED YES LOG

Description

The DROP_WTO_USER_EXIT_SUPPRESSED parameter card is used when MVS messages have been acted on by a WTO user exit (usually for the purpose of message filtering). Use this card if messages with the WTO user exit flag should not be forwarded on to the MID server.

Parameters
YES | NO “YES” indicates that WTO user exit suppression should be honored, and those MVS messages with the WTO user exit flag set will not be forwarded to the MID server and ServiceNow. “NO” indicates that the WTO user exit suppression flag will be ignored, but the message ID must still be present in the message filter table to be passed on to the MID server. “NO” is the default.
LOG Optional. Add the LOG parameter to force any suppressed messages to be written to the NOMATCH log. (This parameter is only relevant if the NOMATCH logging subtask has been defined and is active.)

FILTER Parameter Card

Identify the messages that are to be sent to the ServiceNow server and the commands that can be accepted from the server.

Valid Parameters

MSG {[+|-]msgid [JOBNAME=(jobname[,jobname]...)] [JOBID=(jobid[,jobid]...)] [REXX=script]} ...

Sample Syntax
FILTER MSG ABC123I XYZ1234I -IST663I +IEE114I
FILTER MSG DEF* QRS...I
FILTER MSG JKL* JOBNAME=(MYJOB*)
FILTER MSG JKL.... JOBID=(STC*,TSU*)
FILTER MSG IEE362A REXX=CLEARSMF
FILTER CMD ^D TCPIP,.*,NETSTAT,ROUTE$
FILTER CMD ^D NET,MAJNODES$

Description

The FILTER card adds message IDs to the message filter table or commands to the command filter table.

FILTER MSG

z/OS messages must have a match in the message filter table to be forwarded to ServiceNow. The message table holds up to 2,000 message IDs by default. If a successful match is found for a message ID, the job name and/or job ID of the job which generated the message can also be checked, and the message will only pass if it also matches the given job name or job ID. If a REXX script is specified and the RMA subtask is running, the named script will be called.

Parameters
msgid The message ID of the message to pass to ServiceNow. Typically, this is the first token of the message (up to the first space). msgid can contain the special period placeholder character (.) to indicate that any character in that position should match. If the msgid is terminated with an asterisk (*), matching will occur only on characters preceding the asterisk. Multi-line MVS messages will be forwarded to ServiceNow as one continuous message unless a plus sign “+” is placed in front of msgid, in which case the multiple lines will be sent as separate messages, each with prepended to the message text, or a minus sign “-” in front of msgid, in which case the multiple lines will be sent as separate messages, but without the msgid prepended to the message text. A msgid can be up to 15 characters in length.
jobname The job name of the job that issued the message. The same wildcarding rules used in msgid may be applied to this parameter. A jobname may be up to 8 characters in length.
jobid The job ID of the job that issued the message. The same wildcarding rules used in msgid may be applied to this parameter. A jobid may be up to 8 characters in length.
script A REXX program to be called if this message is encountered. The program will be called with one parameter: the message text, the job name, and the job ID, separated by carriage return characters (x'0A'). (If there is no job name or job ID, these fields are filled in with "N/A"). See the sample programs JOBSUB, PARSEMSG, and SMFDUMP in the Ironstream SAMP dataset for examples on how to set up automation programs. The REXX program must be available in the dataset specified by the DD card named on the RMA subtask card (see RMA Parameter Card definition).

FILTER CMD

Identify z/OS (MVS) commands that may be issued through the Ironstream extended console (initialized by the CMD parameter card). Specify only one command expression per FILTER CMD line. The command table holds up to 200 commands by default. If a command is issued which has no match in the command filter table, an EVO161 message will be returned to inform the caller that the command is unauthorized. Note that if no FILTER CMD cards are specified, then all commands will be forwarded to the console with no restrictions.

Parameters
regexpression A Unix-style regular expression. An incoming command must match one of the regular expressions in the table of command filters before it will be sent to the console for execution.
Be sure to use correct characters for the caret and square brackets if those characters are used in the regexpression. In the default IBM-1047 codeset, the values are:
Character   EBCDIC Hex Value
Caret ^ x’54’
Left Square bracket [ x’AD’
Right Square Bracket ] x’BD’
(Depending on the character mapping of the terminal emulator, the caret symbol may be displayed as a “not” ¬ symbol.)

FILTERTABLE Parameter Card

Specify the size of the message filter table.

Valid Values

MSGSIZE=entries

Sample Syntax

FILTERTABLE MSGSIZE=3000

Description

Use the FILTERTABLE card to set the number of message ID entries allowed in the message filter table. If this card is not present, the message filter table will default to allow 2000 message IDs. The FILTERTABLE card should only be used once, and it must be specified in the SYSIN deck ahead of any FILTER cards.

Parameters
entries Specify the maximum number of entries in the message filter table. entries must be an integer between 1 and 500000.

MVS Parameter Card

Provides Ironstream with z/OS console message support.

Valid Parameters

<Console Name> [IST]
 [DOM[=ALL] [DOMLIST[=size]]]
 [ROUT={ALL|NONE|rtcode[,rtcode]...}] 
 [DESC={ALL|NONE|dcode[,dcode]...}] 
 [MON={[NAME[,]][SESS]}|NONE]
 [AUTO={YES|NO}]
 [UD={YES|NO}]
 [HC={YES|NO}]
 [QL=limit]
 [QLP=percentage] 
      [HILITE={IGNORE|ONLY|ALL}]
      [MSCOPE={*|*ALL|sysname[,sysname...]}]

Sample Syntax

MVS EVOCONS1 DOM DOMLIST=800 ROUT=22,116-128 DESC=1-4,6-13 MON=NAME,SESS 
AUTO=NO UD=NO QL=15000 QLP=70 HILITE=ALL MSCOPE=LPARA,LPARB

Description

This card will initialize the MVS subtask and define an extended MCS software console to receive z/OS (MVS) messages for forwarding to ServiceNow.

Parameters
Console Name Required. Specify a 1-8 character name for the extended MCS console you wish to define for receiving z/OS (MVS) messages. If this name is defined in RACF, the OPERPARM values in the RACF entry for this name are used for the console definition. Otherwise, a console is defined with default parameter AUTH=INFO.
IST Optional. VTAM IST messages are normally filtered out by the MVS subtask. Use the IST parameter to remove this MVS subtask filter, allowing IST messages to flow. However, the IST parameter is not recommended unless both the PPO and the PPI interfaces are unavailable. (If the IST parameter is used in conjunction with either the PPO or PPI subtasks, the same VTAM message may be sent to the ServiceNow server twice.)
DOM Optional. Instruct the console to capture MVS "Delete Operator Messages" and forward them to ServiceNow. Specify DOM to capture standard messages or specify DOM=ALL to capture all DOMs (such as in a Sysplex environment). The DOM information will be sent in an EVO211 message, disclosing the MVS message key or token of the deleted message(s). This information may be used for ServiceNow event correlation and auto-acknowledgement. (The EVO211 message does not need to be added to the mainframe message filter table.)
DOMLIST Optional. This option maintains a list of message IDs or tokens for all MVS messages that have been forwarded to the ServiceNow server, and then only forwards DOMs which match an entry in this list. size is the number of message IDs and tokens to be saved in the list. If no size is specified, the DOMLIST defaults to 1000 messages. Use this parameter if the ServiceNow server is receiving a large number of DOM messages which do not match any relevant message event in ServiceNow. The DOMLIST parameter is valid only if the DOM parameter is also specified.
ROUT Optional. Initialize the extended console with specific routing codes. Only messages with the specified routing codes will be captured by the console. Valid routing codes are in the range of 1-128 and can be specified as a single number (ROUT=5), a range of numbers (ROUT=7-10), or multiple numbers and ranges separated by commas (ROUT=5,7-10,20,128). The default for this parameter is ALL. That is, the console will receive all messages regardless of routing code.
DESC Optional. Only messages with the specified descriptor codes will be captured by the console. Valid descriptor codes are in the range of 1-13 and can be specified as a single number (DESC=1), a range of numbers (DESC=7-10), or multiple numbers and ranges separated by commas (DESC=1,6-11,13). The default for this parameter is ALL. That is, the console will receive all messages regardless of descriptor code.
MON Optional. Allows the console to monitor messages regarding the starting or stopping of jobs and user sessions. The NAME parameter is used to capture messages regarding the start and end of jobs (such as IEF403I and IEF404I). The SESS parameter is used to capture messages regarding the start and end of user sessions (such as IEF125I and IEF126I). The default setting is to activate the capture of both NAME and SESS messages.
AUTO Optional. Specify that the console will or will not receive messages that have been automated by the MVS Message Processing Facility (MPF). The default for this parameter is YES. That is, this console will capture messages even if they were previously processed by MPF automation.
UD Optional. Specifies whether this console is to receive undelivered messages. If set to YES and another console is taken offline, any messages that would have been routed exclusively to that offline console will instead be sent this console. The default setting is YES.
HC Optional. Specifies whether this console should receive all messages destined for the hardcopy console. The default setting is NO.
QL Optional. Specifies the maximum number of messages that can be queued to this console. The queue limit may be any positive number up to 2147483647 (2 gigabytes). If not specified, limit is set to 5000.
QLP Optional. Specifies the percentage of the console’s internal queue that must be used before a warning message is sent to the MID server. percentage may be between 1 and 100. Message EVO703 is sent to the server when the console’s queue has met or exceeded this level. When the queue drops below the specified percentage, message EVO704 is sent to the MID server to inform that the backlog has been relieved. If not specified, VP390 will not issue the EVO703 and EVO704 messages:

EVO703 Console consname is utilizing n% of message queue EVO704 Console consname queue backlog has been relieved

HILITE

Optional. Allows special checking of highlighted MVS messages (messages preceded with an asterisk or at-sign) against the message filter table before forwarding to ServiceNow. Set the HILITE parameter to one of these options:

IGNORE This is the default behavior. That is, the message ID of highlighted messages must appear in the message filter table to allow the message to be passed on to ServiceNow.
ONLY Only highlighted messages with their message ID in the message filter table will be forwarded to ServiceNow. (To send all highlighted messages, add an asterisk entry to the message filter table.)
ALL All highlighted messages will be forwarded to ServiceNow regardless of their message ID. Non-highlighted messages will still be forwarded if their message ID is in the message filter table.

Regardless of this option's setting, all messages are still subject to other restrictions, such as the MPF or SSI suppression parameter cards listed above.

MSCOPE

Optional. Allows you to specify which systems in a Sysplex will send messages to this console. Set the MSCOPE parameter to one of these options:

* Messages will only be received from the local system on which the Ironstream job is running. This is the default.
*ALL Messages will be received from all systems in the Sysplex. (The additional information variable system_name will hold the name of the originating system when sending messages to ServiceNow.)
name ,... Only messages from the named systems will be received by Ironstream. The name values must be no more than eight characters long, with a comma between each. A maximum of eight names is allowed.

Fine, NLS Parameter Card

Set the National Language Support (NLS) codeset value.

Valid Parameters

[CODESET=value] [LANG=langcode]

Sample Syntax

NLS CODESET=IBM-1047

NLS CODESET=IBM-939 LANG=JPN

Description

This card is used to identify the character set used on the mainframe and language used for supported message translations. The value must be a codeset provided by the z/OS Language Environment. A list of codeset values is provided in Appendix D of the IBM C/C++ Programming Guide (IBM publication SC09-4765). The langcode must be a supported language code that is available on this mainframe.

Parameters
value The name of the codeset for the locale of the mainframe. The default is the EBCDIC "IBM-1047" codepage.
langcode The 3-character language code used for message translations. The default is "ENG" (English).

NOMATCHLOG Parameter Card

Identify the logging dataset(s) that record the messages that are not forwarded to the ServiceNow server.

Valid Parameters

log1 [log2 ...]

Sample Syntax

NOMATCHLOG NMLOG1 NMLOG2 NMLOG3

Description

This card will initialize a NOMATCH subtask, which is responsible for writing any mainframe messages that were not passed on to the ServiceNow server due to a defined filtering restriction. The logging datasets will be written in the following format:

Column Data
1
Reason for the filtering (in this order of precedence):
M MVS message had the MPF suppression flag set, and the DROP_MPF_SUPPRESSED parameter card indicated that these messages are to be suppressed and logged.
H MVS message had the Hardcopy Only flag set, and the DROP_HARDCOPY_ONLY parameter card indicated that these messages are to be suppressed and logged.
E MVS message had the WTO User Exit suppression flag set, and the DROP_WTO_USER_EXIT_SUPPRESSED parameter card indicated that these messages are to be suppressed and logged.
A MVS message had the Automation Requested flag set, and the DROP_AUTOMATION_FLAGGED parameter card indicated that these messages are to be suppressed and logged.
S MVS message had the SSI flag set, and the DROP_SSI_SUPPRESSED parameter card indicated that these messages are to be suppressed and logged.
V Message ID was not in the Ironstream message filter table.
3-9 Date of message in Julian format: YYYYDDD
11-18 Time of message in HH.MM.SS
20-27 Job name which produced message, if any
29-36 Originating system name of message, if available
38-45 Job ID which produced message, if any
47 MVS high intensity character (*or @), if any
48- Message Text

Parameters

logn The DD names of the logging datasets. Up to ten DD names may be specified. Each name given must match a DD card definition in the VP390 job’s started task JCL, and each logging dataset should be predefined with DCB=(DSORG=PS,RECFM=V,LRECL=1651).

OSINFO Parameter Card

Initializes the OSI subtask to respond to various requests for z/OS Operating System information and statistics.

Valid Values

[SDSFMAX=s] [BYTESMAX=b][CPCONV={cp,old,new}[,...]] [(q)]

Sample Syntax

OSINFO BYTESMAX=120000 CPCONV=IBM-1146,5B,4A,*,4A,4B4B (20000)

Description

Use the OSINFO card to initialize a subtask that will accept command type 46 requests from the ServiceNow server and return information about z/OS jobs and performance statistics. See the Administrator’s Reference for syntax of type 46 requests and the available options. Some of the options require SDSF to be active on the z/OS system and will also require two DD cards in the VP390 startup JCL: ISFIN and ISFOUT. Some of the options interface with TSO and require a defined dataset to hold the output from TSO (see the description of the TSOUTPUT Parameter Card).

Parameters

s (Optional) An integer value indicating the maximum number of lines of information that will be returned from the queries to SDSF (OSINFO type 06, 07, and 08 commands). Each line will contain information about one job. The default is 1000.
b (Optional) An integer value indicating the maximum number of bytes that can be returned from Rexx commands (OSINFO type 12) and MQ commands (type 50). The default is 100000. This value can be overridden in individual Type 12 and Type 50 commands by adding the MAXSIZE option to the command.
cp,old,new

(Optional) A set of code page conversion values that are used when the Dataset Display (OSINFO Type 10) is selected, to be used in situations where original data may not match the currently running codepage. If the current codepage matches the cp value (or an asterisk for all code pages), then any instance of an old character in a dataset display is converted to new, where old and new are specified by their two-character hexadecimal codes. Up to five characters may be specified for old and new. For example: *,4A,4B4B will replace all instances of the x’4A’ character with two x’4B’ characters, regardless of the codepage setting.

q (Optional) An integer value indicating the number of entries to reserve for addresses of Ironstream internal queue entries that are to be freed when no longer needed. The default is 12000. Use this parameter to increase the queue size if the Ironstream SYSPRINT output displays warning messages “could not add address to OSI free queue” following a large output. If used, the parenthetical queue size must be the last parameter on the OSINFO line.

OPC Parameter Card

Start a subtask to manage incoming OVOPCMSG calls and passes them on to the ServiceNow server.

Valid Values

[PORT=portnum]

Sample Syntax

OPC PORT=6200

Description

Use the OPC card to initialize a subtask which open a TCP/IP port and accept OVOPCMSG calls from other mainframe scripts to be forwarded to the OM server. This port number can be defined here or in the /etc/vp390info file with the identifier EV390_OPCMSG_PORT. See the Administrator's Reference for information on sending OPCMSG commands from the mainframe agent to the ServiceNow server.

Parameters

portnum Optional. An integer value between 1-65535 indicating the TCP/IP port number to listen to for OVOPCMSG data, but the preferred place to specify the port number is in the /etc/vp390info file. A port number specified on this card will override a number specified in the /etc/vp390info file. If no port number is specified on this card or in the /etc/vp390info file, the port number defaults to 6108.

PPI Parameter Card

Request setup of the PPI to NetView/390.

Valid Parameters

[BUFLEN=n]

Sample Syntax

PPI

PPI BUFLEN=40

Description

This card will initialize a PPI subtask. Add this card to connect Ironstream to the NetView/390 PPI for the receipt of VTAM messages. The PPI must be active in accordance with the NetView/390 documentation. This executable is responsible for communicating with the NTIPPI executable that runs as a user exit in the NetView/390 address space. The NetView/390 application will control the PPO connection to VTAM information. This PPI subtask should only be used when a NetView/390 is present on the system.

Note: If NetView/390 is not present on the system, use the PPO parameter card instead.

Parameters

n Optional. Add this parameter to the PPI card to specify a non-standard buffer length size. The default size is 104. Use BUFLEN=40 if you receive an EVO091 “RC=33” or EVO096 error message when attempting to connect to an older version of NetView.

PPO Parameter Card

PPO APPL defined to allow Ironstream to act as the VTAM Primary Program Operator.

Valid Parameters

<VTAM APPL Definition> [ECHO]

Sample Syntax

PPO EVOPPO1 ECHO

Description

This card will initialize a PPO subtask that initializes a Primary Program Operator ACB for the purpose of receiving unsolicited messages from VTAM, most importantly those messages regarding status changes of VTAM resources.

Note: Do not include this card if Ironstream if is running in combination with other network management software such as NetView/390, as only one application in a domain can be the PPO. Use the PPI parameter card instead.

Parameters

VTAM APPL Definition Required. Specify the name of the VTAM APPL definition coded with AUTH=PPO. The default APPL provided in the Ironstream application major node is "EVOPPO1". (See the section Adding the hlq.SAMP(EVAPPL) Definition.)
ECHO Optional. If used, it directs Ironstream to forward a copy of the VTAM messages received to the operator console.

PRINTCARDS Parameter Card

Write the SYSIN cards to the SYSPRINT.

Valid Values

None

Sample Syntax

PRINTCARDS

Description

The PRINTCARDS card instructs the VP390 job to print each of the SYSIN lines that it reads to the SYSPRINT, excluding blank lines and comment lines. This is usually only used to document the cards that have been read when sending the SYSPRINT output to support for problem analysis. Enter PRINTCARDS as the first line of the SYSIN dataset member to document all the lines of the SYSIN input.

The PRINTCARDS card can be used multiple times in the SYSIN as a toggle control. The second occurrence of PRINTCARDS will stop the writing to SYSPRINT, the third occurrence will resume the writing, and so forth.

Parameters

None

RESTART Parameter Card

Number of restart attempts to allow a subtask before giving up.

Valid Values

1 to 65535, or UNLIMITED

Sample Syntax

RESTART 100

Description

Specifies the number of times a subtask attempts to automatically restart. After this limit is reached, the subtask remains in a "down" state until it is manually reactivated using the INIT command. (See the description of the INIT command in Appendix A of the Administation Guide.) Specify UNLIMITED instead of a number to allow a subtask to make an unlimited number of restart attempts. Each subtask can have a unique restart count by specifying another RESTART card immediately before the card which defines the subtask. The default RESTART value is 5.

RMA Parameter Card

Start a subtask to manage REXX Message Automation.

Valid Values

[DD=ddname]

Sample Syntax

RMA DD=OVEXECS

Description

The RMA subtask processes any messages that are matched in the message filter table and have a REXX script associated with it (see the section FILTER Parameter Card definition). The named script will be called with one parameter, composed of the message text, the job name, and the job ID, separated by carriage return characters (x'0A'). If there is no job name or job ID, the field will be filled in with "N/A". Any text returned from the REXX script will be forwarded to the ServiceNow server.

See the Administrator's Reference for samples of REXX automation scripts. Multiple RMA cards may be defined to distribute the workload in case a long-running REXX program ties up one RMA for an extended period of time. If multiple cards are defined, all must have the same ddname specified (if the default is not used).

Parameters

ddname Optional. The DD name of the dataset that holds the REXX execs. This name must match a DD name in the VP390 startup JCL. The default DD name is SYSEXEC, which points to the Ironstream CLIST dataset.

SPO Parameter Card

SPO APPL to allow Ironstream to send commands to VTAM through a Secondary Program Operator.

Valid Parameters

<VTAM APPL Definition>

Sample Syntax

SPO EVOSPO1

Description

This card will initialize a SPO subtask with the ID of a VTAM APPL definition card coded with AUTH=SPO. This identifies a Secondary Program Operator (SPO) application, which receives solicited messages generated by commands issued from ServiceNow. This subtask executable is responsible for initializing a SPO ACB to VTAM, then receiving VTAM commands (for example, Vary or Display) from ServiceNow servers, sending the commands to VTAM over the SPO, and returning the VTAM responses to the server that initiated the command. Multiple SPO subtask cards may be defined to distribute the work if several commands come in at nearly the same time.

Parameters

VTAM APPL Definition Required. Specify the name of a VTAM APPL definition coded with AUTH=SPO. The default APPL provided in the Ironstream application major node is "EVOSPO1". (See the section: Adding the hlq.SAMP(EVAPPL) Definition.

TCP Parameter Card

Identify port numbers and parameters for the TCP/IP connection to the Ironstream client.

Valid Values

mmsport cmdport [hlq] [BUFDD=dd1,dd2 [ACK=ack] [LIMIT=limit]] [HB=hb] 
                      [BINDIP=bindaddr][SERVERIP=servaddr[/{maskaddr|maskprefix}]] 
                      [TLS=Y|N|V] [KEYF=filename1] [STAF=filename2]

Sample Syntax

TCP 6106 6107 BUFDD=BFR1,BFR2 ACK=5 LIMIT=20 HB=30 BINDIP=10.1.1.8 SERVERIP=10.1.1.0/24

Description

This card will initialize a TCP subtask, which is responsible for opening two TCP/IP ports on the mainframe, then waiting for an Ironstream client component to start communication with the mainframe agent via these ports. While it waits for a connection, the TCP subtask can optionally write new mainframe messages to a set of buffering files, and then send the buffered messages after a connection is established. If you are also using the same Ironstream job for Event Management and Operations Management, you will need to define two TCP parameter cards. The mmsport and cmdport parameters must be unique for each TCP card defined. TLS encryption between the agent and the server is available. The additional steps for setting up TLS encryption are given in Appendix B.

Parameters

mmsport Required. Port number opened on the mainframe for establishing a socket connection with the Message and Command Server (MCS) task on the MID server. This number must match the EVOMF_HCI_AGENT_PORT value entered when adding the mainframe node to ServiceNow.
cmdport Required. Port number opened on the mainframe for establishing a socket connection with the Message and Command Server (MCS) task on the MID server. This number must match the EVOMF_CMDS_AGENT_PORT value entered when adding the mainframe node to ServiceNow.
hlq Optional. High-level qualifier (hlq) for the mainframe TCP/IP datasets. This parameter is used to find the TCP/IP profile datasets and is needed only if the default hlq is not used during TCP/IP installation. The TCP subtask will not initialize if the hlq is misstated.
dd1,dd2 Optional. The DD names of the two buffering datasets. These DD names must be listed in the VP390 startup job, and they must point to predefined datasets with DCB=(DSORG=PS,RECFM=V,LRECL=1663).
ack

Optional. The number of unsolicited mainframe messages that will be passed on to the MID server before an acknowledgment is expected from the MID server. By default, the VP390 job will expect an acknowledgment after every 5 messages. If an acknowledgment is not received, the mainframe agent will resend all of the messages back to the last successful acknowledgment. Then, if the MID server acknowledgment is still not received, the mainframe agent will close the TCP/IP connection and wait for a reconnect request.

Upon reconnection, all unacknowledged messages back to the last successful acknowledgment will be resent to the MID server, and these messages may appear duplicated in the ServiceNow alerts. If this causes a problem, set the ACK parameter to 1 to ensure an acknowledgment from the MID server after every message is sent. The ACK parameter is only valid if BUFDD is specified.

limit Optional. The age limit (in minutes) of buffered messages that the mainframe agent will send to the MID server. By default, messages read from the buffering files that are over 20 minutes old will not be forwarded to the MID server. Set this value to 0 to receive all buffered messages regardless of their age. The LIMIT parameter is only valid if BUFDD is specified.
hb Optional. Length of time (in seconds) between heartbeat tests to verify the TCP/IP connection. By default, a short heartbeat message will be sent between the MID server and the mainframe agent every 30 seconds.
bindaddr Optional. Use the BINDIP option to specify which address the TCP ports should bind on (in cases where a system may be known by multiple IP addresses). bindaddr must be specified in the nnn.nnn.nnn.nnn IP address format.
servaddr Optional. Use the SERVERIP option to specify a specific MID server IP address that the listening ports will accept a connection from. servaddr  must be specified in the nnn.nnn.nnn.nnn IP address format. Additionally, the servaddr  can be masked to allow a range of IP addresses to connect to the ports. To specify a mask, add a slash (/) after the servaddr  followed by either a dotted decimal maskaddr (e.g., 255.255.255.0) or a numerical maskprefix between 0-32 to represent the number of bits to be included in the mask starting from the leftmost bit (e.g., "16" would be equivalent to 255.255.0.0).
filename1, filename2 Optional. The “TLS”, “KEYF”, and “STAF” options are used when defining TLS encryption for the connection. These options are only valid when “TLS=Y” is specified. See the section: Setting up TLS for the Server-Agent Connection for instructions on using these options.

TSOUTPUT Parameter Card

Identify a temporary dataset to hold TSO output.

Valid Parameters

dsname — dataset name

Sample Syntax

TSOUTPUT EV390.TSO.OUTPUT

Description

This parameter is only necessary if you are using options 110 through 114 of the OSINFO subtask. When using these commands, a connection to TSO is made, and the output from TSO is sent to a dataset in this search order:
  1. A dataset named on this TSOUTPUT parameter card.
  2. A dataset defined in the Ironstream startup JCL with a DD Name of “TSOUTPUT”.
  3. A default dataset named “EV390.TSOUTPUT”.

Parameters

dsname The dataset name to hold the generated output. It must be defined with DCB=(DSORG=PS,RECFM=VB,LRECL=1028,BLKSIZE=6144). If the dataset is a PDS, a member name may be specified in parentheses.