This chapter discusses CA MIC statements and commands.
This section contains the following topics:
DISPLAY GCMF Command-Display GCMF Information
DOM Command-Delete Action Messages
DUMP GCMF Command-Create GCMF Dump
GCMINIT Statement-Set GCMF Initialization Statements
ROUTE Command-Assign z/OS Routing Codes to Messages
SETOPTION GCMF Command-Set GCMF Operating Values
The DISPLAY GCMF command lets you display information about the status of the Global Command and Message Facility (GCMF).
This command has the following format:
DISPLAY GCMF [ALL]
[ATMCOMM ]
[DOM [{ALL [{DETAIL | SUMMARY }] |
[PREFIX=msgid ]
[USER=userid ]}]]
[INIT]
[LINK [{ALL | SOURCE | USER={ALL|userid} }] ]
[OPTIONS[=({ALL | [ACTIONPREFIX]
[ACTIONTYPE]
[ACTIONUSER]
[EXCLUDEPREFIX]
[EXCLUDETYPE]
[EXCLUDEUSER]
[VALUES]} ) ]
[ROUTE[ {ALL| PREFIX=msgid | TYPE=msgtype | USER=userid } ]
Tells CA MIM to display information about GCMF rather than any other facility. Specify this operand before the ALL, INIT, or OPTIONS operands. You also should specify the GCMF operand before any other operand that is truncated in such a way that it may be ambiguous with operands for other facilities.
Because GCMF is a positional operand, you must specify it before any other operand on the DISPLAY command.
(Optional) Displays one of these types of information:
Specify the ALL operand only once per command, even when it qualifies two or more operands. For example, you can specify DISPLAY DOM ALL to see the GCMF initialization and operating values and to see information about all outstanding messages. Note that ALL is a default value when you specify DISPLAY DOM.
Displays the user ID of the virtual machine where the ATMCOMM module is running. It also shows the status of the IUCV communication path between that virtual machine and the MIMGR service machine. This information is displayed in message MIM3500.
(Optional) Displays information about outstanding action messages. This information is displayed in message MIM3061 (if you specify DISPLAY DOM DETAIL) or in message MIM3062 (if you specify DISPLAY DOM SUMMARY).
Displays detailed information about outstanding action messages.
Displays summarized information about outstanding action messages. Specify SUMMARY only once per command, even when it qualifies two or more operands. SUMMARY is a default value if you specify DISPLAY DOM ALL.
(Optional) Displays information about the GCMF initialization values that are set through the GCMINIT statement. This information is shown in message MIM3031.
Displays information about linkages for specified user. This information is shown in message MIM3016.
Information about all linkages
This displays information about the user that issued this DISPLAY command.
Displays????
Displays information about the GCMF operating values set by the SETOPTION command. The GCMF OPTIONS information is shown in message MIM3030.
You can enter one or more of the following values for GCMF OPTIONS:
Displays the list of additional highlighted messages, in addition to the standard display.
Displays all GCMF operating values.
Displays the value you entered on the SETOPTION command for routing broadcast messages to a defined list of systems.
Displays the list of job names used to unconditionally exclude messages from cross-system message routing, in addition to the standard display.
Displays the list of message IDs used to unconditionally exclude messages from cross-system message routing, in addition to the standard display.
Displays the systems supporting the system authorization facility.
Displays the list of systems from which imported messages are being written to the system log, in addition to the standard display.
Displays the GCMF operating values listed in the standard display.
Default: OPTIONS=VALUES
Displays information about route code definitions defined through the ROUTE command. These definitions are shown in message MIM3507.
This displays information about outstanding messages that have a designated message prefix. Specify the prefix in place of the msgid variable.
This displays information about route code definitions for messages of a certain type. Valid types are MSG, WNG, IMSG, EMSG, SCIF, CPCONIO, and SMSG.
This displays information about a designated user ID. Specify a user ID in place of the userid variable. The asterisk (*) wildcard character is supported in the last position of the user ID when you are displaying information about route code assignments or outstanding action messages.
Usage Notes: DISPLAY GCMF Command
Example: DISPLAY GCMF Command
To display route code definitions for messages originating on user ID RSCS1, with message IDs beginning with DMT, issue the following command:
DISPLAY ROUTE USER=RSCS1 PREFIX=DMT*
The DOM command lets you immediately delete one or more action messages from local, global, or both consoles. In this context, delete actually means that highlighted messages are changed to normal intensity, so they will scroll off the console.
You would use this command if you did not want to wait for the highlighted message to be automatically changed to a non-highlighted message by the SETOPTION DELETEINTERVAL command.
This command has the following format:
DOM {CLEAR | ERASE | PREFIX=msgid
SEQNUM=number
USER=userid }
Deletes all action messages that originated on this system from any console that collected them.
This parameter is identical to CLEAR in a z/VM system.
Deletes all action messages with the designated message ID. Specify a single ID in place of the msgid variable. GCMF deletes these messages from all consoles that collected them.
You can use the asterisk (*) wildcard character as the last character in the string, or the pound (#) sign in any string position when specifying a user ID.
Deletes an action message by its unique sequence number. Specify this number in place of the number variable. GCMF deletes the message from all z/OS consoles to which it was routed. You can use the DISPLAY DOM DETAIL command to see which sequence numbers are assigned to which messages.
Deletes all action messages issued by the designated user ID on the local system. Specify a user ID in place of the userid variable. GCMF deletes these messages from all z/OS consoles to which the messages were routed.
You can use the asterisk (*) wildcard character as the last character in the string, or the pound (#) sign in any string position when specifying a user ID.
Usage Notes: DOM Command
Examples: DOM Command
DOM CLEAR
DOM USER=USER1
The DUMP GCMF command is used by CA Technical Support for diagnostic purposes. This command is to be used only when you are directed by CA Technical Support.
This command has the following format:
DUMP GCMF [CAES]
[D0AREA]
[D1AREA]
[D10AREA]
[HASH]
[LINKS]
[MLRSPBLK]
[RTE]
[SE [(sysid [,CE][,DE][,OE] )] ]
[UTJIDMAP ]
[WHE]
(Optional) Dumps the CAE control blocks on the external and available chains.
(Optional) Dumps the D0AREA control block.
(Optional) Dumps the D1AREA control block.
Dumps the D10AREA control block.
(Optional) Dumps the HASH table.
(Optional) Dumps the CAE control blocks on the link chain.
Dumps the MLRSPBLK control block.
Dumps the RTE control block.
(Optional) Dumps the SE control blocks for all active systems. Optionally, you can specify the one- to eight-character system name for systemid to select the SE control block for the named system, regardless of active status.
You can also specify dumping the CE, DE, and OE control blocks associated with the SE control blocks being dumped.
umps the UTJIDMAP control blocks.
(Optional) Dumps the WHE control blocks.
Usage Notes: DUMP GCMF Command
Example: DUMP GCMF Command
To dump the contents of the CAE control blocks on the external and available chains, issue the following command:
DUMP GCMF CAES
The GCMINIT statement lets you set initialization values for the Global Command and Message Facility (GCMF).
This command has the following format:
GCMINIT [ATMCOMM={userid|NONE}]
[EDITMESSAGE[={ALL | EXTERNAL | NONE}]]
[EDITUSERID=(nn,{LEFT|RIGHT})]
[TRANSLATE={NO|YES}]
Determines the user ID of the virtual machine where ATMCOMM is running. It grants authority for ATMCOMM to establish an IUCV connection to MIMGR. MIMGR will reject attempts by any other user to establish this connection. You can specify NONE, or a value in place of the userid variable.
Default: ATMCOMM=OPERATOR
Affects the way messages that are collected on the local system are displayed when they are sent to a console on another system. This parameter and EDITUSERID work together to determine the contents of the job stamp field wherever the message is displayed. Specify one of these values on the EDITMESSAGE parameter:
This value causes CA MIC to insert the system alias of the local system into the job stamp field of all messages being routed to external systems. The alias overlays the first two characters of the field, leaving only six character spaces for insertion of the user ID. The EDITUSERID parameter determines the contents of the rest of the job stamp field.
This value is the same as ALL for z/VM systems. It is supported for compatibility with z/OS systems.
The eight-character user ID of the user where the message originated is sent in the job stamp field, without modification. The setting of EDITUSERID has no effect.
Default: EDITMESSAGE=EXTERNAL
Selects whether to use the leftmost or rightmost characters of the user ID, and how many characters to use. This parameter is operative only when the EDITMESSAGE parameter is set to ALL or EXTERNAL, which restricts the space available for user ID in the message jobstamp field to a maximum of six characters. Specify both of the following operands:
Specifies how many characters should be inserted in the job stamp field. Specify any number between 0 and 6.
Selects whether the leftmost or rightmost characters of the user ID will appear in the messages.
Default: EDITUSERID=(5,LEFT)
(Optional) Indicates whether GCMF should convert non-printable and non-displayable message characters into blanks. Specify NO or YES on this parameter.
Default: TRANSLATE=YES
Usage Notes: GCMINIT Statement
Example: GCMINIT Statement
To tell GCMF to use the full eight-character user ID, and not to insert the system alias into the z/OS job stamp field for messages sent to other systems, specify this statement in the INIT MIM file:
GCMINIT EDITMESSAGE=NONE
The LINK command lets you create, modify, and delete linkages that enable users on the local system to issue commands to any system. This command is available when you are using the Global Command and Message Facility (GCMF). Each linkage you create by using the LINK ADD command has a unique name based on the command source you specify.
After a linkage is defined (by a LINK command), you can modify the linkage parameters by specifying the same command source on subsequent LINK commands. You also use the command source name to delete a linkage.
Note: There cannot be two linkages with the same name.
LINK [{ADD] |
DELETE} ]
[{SOURCE |
USER={ALL|userid}}]
[SYSID = {ALL |
EXTERNAL |
LOCAL |
sysids } ]
[{POOL [={DEDICATE|
SHARE} ] |
TGTCONS=tgtconname }]
[AUTHORITY[={NONE |
SOURCE |
ALL |
CONS |
INFO |
IO] |
MASTER] |
OPERPRIV |
SYS |
USERPRIV}]]
(Optional) Creates a linkage if this linkage does not exist. Otherwise, GCMF modifies the existing linkage.
(Optional.) Assigns the specified authority level to the target console when executing a cross-system command. When a cross-system command is directed to a z/OS system, the target console assumes the assigned authority, and commands are restricted to that authority level.
When a cross-system command is directed to a z/VM system, CA MIC uses the LINKAUTH MIM file to determine the authority level required to execute the command. The command is rejected if the user does not have adequate authority.
Specify one of the following values on the AUTHORITY operand:
Authorizes the target console to execute any information request, system control, I/O control, or console control command. This option is equivalent to specifying the command AUTH=(CONS, IO, and SYS). The ALL authority level does not include MASTER authority, or the z/VM OPERPRIV and USERPRIV authority levels.
(Optional) Authorizes the target console to execute console control commands, such as VARY, when changing the status of a console.
Authorizes the target console to execute informational commands, such as MONITOR, DISPLAY, and REPLY, when replying to a WTOR.
(Optional) Authorizes the target console to execute I/O control commands, such as MOUNT, UNLOAD, and VARY, for any device except a console.
Authorizes the user to execute commands that require master console authority. The MASTER authority level includes ALL authority, but not OPERPRIV or USERPRIV.
Prevents the target console from executing any cross-system command.
This value authorizes the user to execute any cross-system command that has been assigned to the OPERPRIV class in the LINKAUTH MIM file of the target system.
This value assigns cross-system command authority to a command issuer according to the user authority level specified in the AUTHUSER MIM file. A user with OPER authority is assigned a status of AUTHORITY=ALL, and is able to execute any information request, system control, I/O control, or console control command.
A user with USER authority is assigned AUTHORITY=INFO status, and is able to execute informational commands.
Note: AUTHORITY=SOURCE is a default value.
(Optional) Authorizes the target console to execute system control commands, such as SET, START, and STOP.
This value authorizes the user to execute any cross-system command that has been assigned to the USERPRIV class in the LINKAUTH MIM file of the target system.
From your own console, you cannot issue a LINK command that increases the authority of that console. However, another console can issue a LINK command that increases the authority of your console to any level, but not exceeding the authority of the other console.
For example, if you want to issue cross-system console control commands from your INFO-level console, then you need to specify LINK AUTHORITY=CONS from a console that is authorized to issue console control commands.
Note: You only need SYS authority to issue a LINK command with MASTER authority.
Default: AUTHORITY=SOURCE
(Optional) Deletes part of the linkage or the entire linkage, depending on what other operands you specify.
(Optional) Indicates that GCMF should use the next available member of the console pool to execute commands. Specify one of the following values on the POOL operand.
Note: This parameter is ignored when linking to z/VM systems.
Creates a dedicated linkage in which the same console pool member is used to execute all commands from the source on the linkage. The console is removed from the pool.
Creates a shared linkage in which any available console pool member is used to execute commands. GCMF may share (or reassign) the selected console to another linkage as needed.
Default: POOL=SHARE
Authorizes the current user to issue commands through this linkage. SOURCE is invalid when the LINK command is issued from the CMNDS MIM or SYNCH MIM files.
(Optional) Identifies the systems to which the command source can issue commands. Specify one of the following values:
Allows the command source to issue commands to all systems, including ICMF systems. ALL is the default.
Allows the command source to issue commands to all ICMF systems only (excluding control file systems).
Allows the command source to issue commands to all control file systems only (excluding ICMF systems).
Allows the command source to issue commands to all systems except the local system.
Allows the command source to issue commands to all control file systems except the local system (excluding ICMF systems).
Allows the command source to issue commands to the local system only.
Specifies the IDs of the systems to which the command source can issue commands. Specify up to 32 IDs. You can use system names, aliases, or index numbers to identify systems.
You must specify POOL=DEDICATE or POOL=SHARE if you specify more than one system ID for sysids, or if you specify any keyword value except LOCAL. The default is POOL=SHARE.
To issue a cross-system command with a scope value of ALL, you must create a linkage that specifies SYSID=ALL. To issue a cross-system command with a scope value of EXTERNAL, you must create a linkage that specifies SYSID=EXTERNAL or SYSID=ALL.
Default: SYSID=ALL
Authorizes one or more CMS users to issue commands through this linkage. Specify one of these values on the USER parameter:
This value authorizes all CMS users on the local system.
This variable represents the ID of the CMS user who is authorized to issue commands through this linkage.
(Optional) Creates an exclusive linkage to the designated console, tgtconname. The console executes all commands using this linkage. This console can be an active or an inactive MCS console; however, it cannot be a member of the console pool of GCMF, and it cannot be currently allocated to another product.
Notes:
Default: LINK=ADD
Usage Notes: LINK Command
Examples: LINK Command
(Note that default values are omitted in these examples.)
LINK SYSID=B1
LINK DELETE
LINK USER=MAINT SYSID=EXTERNAL
The ROUTE command allows CA MIC users to assign z/OS routing codes to messages generated on the local z/VM system. Routing codes are used to direct messages to certain consoles on z/OS systems.
This command has the following format:
ROUTE [{ADD | DELETE} {ALL | ROUTCDE=codes
[PREFIX=msgid ]
[TYPE=msgtype]
[USER=userid ]} ]
The ALL, PREFIX, TYPE, and USER keywords are used to select messages to which route codes should be assigned. The ROUTCDE keyword specifies the routing code to be used for selected messages.
Creates a route code definition if one does not exist. Otherwise, GCMF adds the specified route codes to the existing definition. This is the default value for the ROUTE command.
Assigns the specified route code to all messages.
Deletes the specified route codes from the route code definition or deletes the route code definition if no other route codes were included in the definition.
Specifies the first word of the message (maximum 10 characters).
Specifies the route codes that should be assigned to the selected messages.
Specifies the type of message. These are SCIF, MSG, WNG, SMSG, IMSG, EMSG, and CPCONIO.
Specifies the user ID where the message originated. For SCIF type messages, this is the user ID that is forwarding messages to its secondary user. For message type MSG, WNG, and SMSG this is the user ID issuing the command. For all other message types, this is the user ID where the message was originally captured.
Usage Notes: ROUTE Command
To delete a route code from the definition, specify the route code on the ROUTCDE keyword. To delete the entire route code definition, omit the ROUTCDE keyword on the command.
The ROUTE DELETE command can delete only one route code definition at a time. The PREFIX, TYPE, and USER values specified on the ROUTE DELETE command must match exactly the values specified on the original ROUTE command that created the route code definition. For example, suppose you created the following two route code definitions:
ROUTE USER=USER1 TYPE=WNG ROUTCDE=1
ROUTE USER=USER1 ROUTCDE=128
If you then issue the command ROUTE DELETE USER=USER1, only the second route code definition will be deleted. To delete the first definition, you must issue the command ROUTE DELETE USER=USER1 TYPE=WNG.
Examples: ROUTE Command
On z/VM: ROUTE TYPE=WNG ROUTCDE=1
On z/OS: COLLECT CONSOLE=MASTER ROUTCDE(1) SYSID=VMXA
On z/VM: ROUTE USER=VMTAPE ROUTCDE=(3,5)
or
ROUTE PREFIX=VMT* ROUTCDE=(3,5)000000
On z/OS: COLLECT DROUTCDE(ASIS) ROUTCDE(3,5) SYSID=ALL
ROUTE DELETE TYPE=WNG
The SETOPTION GCMF command lets you set operating values for the Global Command and Message Facility (GCMF).
This command has the following format:
SETOPTION GCMF [{ADD|DELETE} ACTIONPREFIX={msgids|NONE}
ACTIONTYPE={msgtypes|NONE}
ACTIONUSER={userids|NONE}
EXCLUDEPREFIX={msgids|NONE}
EXCLUDETYPE={msgtypes|NONE}
EXCLUDEUSER={userids|NONE }]
[AUTODELETE={GCMONLY|GLOBAL}]
[BUFLIMIT=nnn]
[DELETEINTERVAL=nnn]
[ESCAPE=character]
[LINEND=character]
[MSGFILTER={nn|OFF}]
[RESETPRINT=(options)]
[RESETTRACE=(options)]
[SETPRINT=(options)]
[SETTRACE=(options)]
This tells CA MIM that you are setting operating values for GCMF rather than any other facility. Specify the GCMF parameter if you want to truncate a parameter in a way that may be ambiguous with parameters for other facilities.
GCMF is positional. You must specify it before any other parameter.
Adds the corresponding entry for the following parameters:
Indicates whether GCMF should force a designated group of messages to be highlighted when routed to external z/OS systems. This option can be abbreviated as ACTP.
Specify one of these values on the ACTIONPREFIX parameter:
Specifies the IDs of the messages that GCMF should reissue (to a maximum of 20 IDs). You can specify additional IDs on a separate SETOPTION command. You also can use the asterisk (*) and pound (#) wildcard characters.
Deletes the existing list of IDs.
To delete an individual ID from this list, specify the DELETE operand before the ACTIONPREFIX operand.
Default: ACTIONPREFIX=NONE
Specifies the originating user IDs of messages that should be highlighted messages when routed to external systems. This option can be abbreviated as ACTU.
Specify one of these values:
Specify this value to delete the existing list of message IDs.
This variable represents the user IDs where the messages originate. For SCIF message types, this is the user ID that is forwarding messages to its secondary user.
For MSG, WNG, and SMSG message types, this is the user ID where the command was issued. For all other types, it is the user ID where the message was originally captured.
You can use the asterisk (*) wildcard character at the end of a user ID, or the pound (#) sign at any position within an ID.
To delete an individual ID from this list, specify the DELETE parameter before the ACTIONUSER parameter.
Default: ACTIONUSER=NONE
Specifies the types of messages that should be highlighted when routed to external z/OS systems. This option can be abbreviated as ACTT.
Specify one of these values:
This variable represents the types of messages that should be highlighted. Valid types are SCIF, MSG, WNG, SMSG, IMSG, EMSG, and CPCONIO.
Specify this value to delete the existing list of message types.
To delete an individual type from this list, specify the DELETE parameter before the ACTIONTYPE parameter.
Default: ACTIONTYPE=NONE
This parameter is not operative for z/VM systems. On z/OS systems, the default value is AUTODELETE=GLOBAL.
Specifies the maximum number of 4K pages of virtual storage that will be used by CA MIC to represent messages. Specify a value from 2 to 999 in place of the nnn variable.
Default: BUFLIMIT=999
Removes the corresponding entry for the following parameters:
Specifies how many minutes GCMF should wait before considering an outstanding highlighted message to be obsolete. Once this time interval has expired, the message will be deleted (un-highlighted) from external z/OS systems. Specify a value from 1 to 32767.
Default: DELETEINTERVAL=15
Note: If you specify 0, the DELETEINTERVAL will remain unchanged.
Defines the logical escape character used when issuing cross-system CP commands to this system. This parameter can be specified as a single character or in hexadecimal format. For example, you can specify ESCAPE=” or ESCAPE=X'7F'.
Default: ESCAPE=”
(Optional) Tells GCMF whether to prevent users from collecting messages that have a specified ID. Specify one of these values on the EXCLUDEPREFIX operand:
Specifies the IDs of the messages that should not be collected (to a maximum of 20 IDs). You can specify additional IDs on a separate SETOPTION command. You also can use the asterisk (*) and pound (#) wildcard characters in an ID. For a description, see Wildcard Characters in (MIC) COLLECT Command in this chapter.
Tells GCMF to delete any existing list of IDs.
You can use the abbreviation EXP for this operand.
To delete an individual ID from this list, specify the DELETE operand before the EXCLUDEPREFIX operand.
Default: EXCLUDEPREFIX=NONE
Tells GCMF whether to prevent external systems from collecting messages with a certain message type. This option can be abbreviated as EXT.
Specify one of these values on the EXCLUDETYPE parameter:
Represents the types of the messages that should not be collected. Valid types are SCIF, MSG, WNG, SMSG, IMSG, EMSG, and CPCONIO.
Tells GCMF to delete any existing list of message types.
To delete an individual ID from this list, specify the DELETE parameter before the EXCLUDETYPE parameter.
Default: EXCLUDETYPE=NONE
Tells GCMF whether to prevent external systems from collecting messages that originated on a certain user ID. This option can be abbreviated as EXU.
For a definition of the originating user ID, see the ACTIONUSER parameter. Specify one of these values on the EXCLUDEUSER parameter:
This value tells GCMF to delete any existing list of user IDs.
This variable represents the user IDs from which messages should not be collected.
You can use the asterisk (*) wildcard character at the end of the user ID, or the pound sign (#) at any position within an ID.
To delete an individual ID from this list, specify the DELETE parameter before the EXCLUDETYPE parameter.
Default: EXCLUDEUSER=NONE
Defines the logical line end character used when cross-system CP commands are issued to this system. The LINEND parameter can be specified in character format (#) or in hexadecimal format (X'7B').
Default: LINEND=#
(Optional) Filters messages when GCMF encounters the specified number of duplicate messages issued in succession.
A WTO buffer shortage can occur when, for example, a program loops while issuing WTOs. You can use the MSGFILTER parameter on the SETOPTION command to limit the number of identical messages that CA MIC routes cross-system.
When the number of consecutive WTOs with the same message ID is issued, CA MIC stops routing that message cross-system. CA MIC resets its counter when it processes a different message.
Specify one of the following values:
GCMF should not filter duplicate (looping) messages from the same job.
GCMF should not route duplicate (looping) messages after nn consecutive messages with the same ID, issued by the same job. Specify a number between 1 and 1000.
Default: MSGFILTER=50
(Optional) Allows you to turn off trace event printing for the specified trace option or all options. For an explanation of options, see the SETTRACE operand.
(Optional) Allows you to turn off trace event capturing for the specified trace option or options. For an explanation of the available options, see the SETTRACE operand.
(Optional) Turns on the print function for the specified trace event options. For an explanation of the options, see the SETTRACE operand.
Usage Notes: SETOPTION
Example: SETOPTION GCMF
To exclude all messages issued by users USER4 and USER5 from cross-system message routing, issue the following command:
SETOPTION EXCLUDEUSER=(USER4,USER5)
|
Copyright © 2014 CA.
All rights reserved.
|
|