Description status: Functional area: Domain: Privileges: | MSCF V21.0A Pubset and MRSCAT management MULTI-CATALOG-AND-PUBSET-MGMT TSOS |
Routing code: | R |
Function
The SET-MSCF-ENVIRONMENT command conveys global system and network data to the MSCF subsystem. The following configuration parameters can be set:
password for the local system
connection to an XCS network
minimum number of MSCF server tasks
dimension figure for limiting the MSCF server tasks
maximum time for network error detection
time available for the termination of user tasks when disconnecting from an XCS network
how recovery measures are to be initiated
whether or not MSCF traces are to be written and to which file
interval after which abort processing will be performed for an incomplete exit from the XCS network (i.e. interval after which a blocked leave reconfiguration is to be converted into an abort)
interval after which incomplete abort processing triggers abnormal system termination
priority of a processor for automatic recovery triggering after a loss of connection in XCS.
specification whether a user ID and which user ID is notified by email when particular errors and critical situations occur
The command is evaluated only as part of an MSCF configuration file. Outside the configuration file the command is rejected with message MCS0032.
Some of the configuration parameters can be modified during an MSCF session with the MODIFY-MSCF-ENVIRONMENT command.
The MSCF configuration parameters are described in section “Parameterization of MSCF”.
Format
SET-MSCF-ENVIRONMENT | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operands
LOCAL-PASSWORD = *NONE / <c-string 0..8> / <x-string 1..16>
Password for the local system. A password defined here must be specified outside the configuration file by the local system and each partner system when CCS connections are established. By default, no password is assigned.
XCS-NAME = *NONE / *SUSPEND <alphanum-name 1..8>
Specifies whether the system is participate in an XCS network and, if so, which one.
XCS-NAME = *NONE
By default, the system does not participate in any XCS network.
MSCF is started in CCS mode.
If the system parameter MCXSPXCS is set to “Y” or “N” then XCS functionality is made available locally. The system cannot join any XCS network during the current BS2000 session. If the system parameter MCXSPXCS is set to “V” then no XCS functionality is made available. However, MSCF can be restarted in XCS mode following the end of the MSCF session.
XCS-NAME = *SUSPEND
The system is not permitted to participate in any XCS network.
MSCF is started in CCS mode. No XCS functionality is made available. However, the system can be started in a new MSCF session in XCS mode within the same BS2000 session. The value *SUSPEND is not permitted if the system parameter MCXSPXCS is set to “N”.
XCS-NAME = <alphanum-name 1..8>
Name of the XCS network in which the system is to participate. MSCF is started in XCS mode. XCS functionality is made available across the various systems.
This value may not be specified if the system parameter MCXSPXCS is set to “N” or if the load operation was performed with the setting MCXSPXCS=“Y” MSCF in the same BS2000 session with XCS-NAME=*NONE.
If one of these prohibited specifications is used, the message MCS1014 is output and MSCF is terminated.
NUMBER-OF-SERVERS = *STD / <integer 2..10>
Number of MSCF server tasks that are to be made available on the local system during an MSCF session.
The default is 4 MSCF server tasks.
Note
Values specified in the START-SUBSYSTEM MSCF command, SUBSYSTEM-PARAMETER=’ NUMBER-OF-SERVERS’ take precedence.
SERVER-TASK-LIMIT = *STD / <integer 10..500>
Number of server tasks used by MSCF as a yardstick to limit the number of jobs accepted on the job side. The default value is 20.
FAIL-DETECTION-LIMIT = *STD / <integer 176..3300 seconds >
Specifies the failure detection time in an MSCF network (in seconds, multiples of 44). The intervals at which monitoring mechanisms run are defined through this value. The default setting is 176 seconds. The value has to be coordinated with the partner system (see "Global control parameters").
USER-TERM-LIMIT = *STD / *UNLIMITED / <integer 0..6000 seconds >
Time left to the user to terminate jobs once XCS shutdown has been initialized. The default setting is 300 seconds. The default is 300 seconds.
RECOVERY-START = *AUTOMATIC / *BY-OPERATOR / *CONSISTENT-BY-OPERATOR / *SECURE
Defines how the system is to initiate recovery measures in the event of an error (e.g. failure of a system or connection).
Note
The fail reconfiguration can only be started automatically if partner monitoring is certain that the partner has failed and this is permitted by both the general and the partner-specific RECOVERY-START settings on the local system and on the partner system (see section “Inhibiting the automatic start of fail reconfiguration” (Global control parameters)).
RECOVERY-START = *AUTOMATIC
The recovery measures are to be initiated automatically.
RECOVERY-START = *BY-OPERATOR
The recovery measures are not to be initiated by the local system until the action is confirmed by systems support.
RECOVERY-START = *CONSISTENT-BY-OPERATOR
The same behavior as on RECOVERY-START=*BY-OPERATOR. In addition, the partner system does not initiate fail reconfiguration for the local system unless confirmed by systems support.
RECOVERY-START = *SECURE
The value *SECURE is still accepted for reasons of compatibility. It works like *CONSISTENT-BY-OPERATOR.
TRACE-FILE = *NONE / *STD / <partial-filename 2..31>
Governs whether MSCF traces are to be logged in a file and if so, which file.
TRACE-FILE = *NONE
MSCF traces are not to be logged in a file.
TRACE-FILE = *STD
MSCF traces are to be logged in a file with the default name
SYS.MSCF-TRACE.<date>.<sysid>.<session>.<index>
Key:
<date> <sysid> | Date in yyyy-mm-dd format External representation of the system ID of the local system |
<session> <index> | Number of the current BS2000 session Number of the MSCF trace file in the current BS2000 session |
Example: SYS.MSCF-TRACE.2009-01-14.152.030.001
TRACE-FILE = <partial-filename 2..31>
HIPLEX MSCF traces are to be logged in a file named
<partial-filename 2..31><date>.<sysid>.<session>.<index>
(for <date>, <sysid>, <session> and <index> see TRACE-FILE=*STD above).
Example: SYSTEM-TRACES.MSCF.2009-01-15.152.030.002
LEAVE-LIMIT = *UNLIMITED / <integer 1..6000 seconds >
Determines the time within which a system must have concluded a LEAVE reconfiguration. If the LEAVE reconfiguration cannot be concluded within this time span, an ABORT reconfiguration is performed. By default, there is no time limit set for a LEAVE reconfiguration.See also "Global control parameters".
ABORT-LIMIT = *UNLIMITED / <integer 0..6000 seconds >
Specifies the interval within which the system must have completed an abort process. When this interval expires, the system’s exit from the network is forced by an abnormal system termination (SETS) with MCS1304. By default no time limit is set for the system for its abort process.
HOST-PRIORITY = *STD / <integer 1..32>
In an XCS network, this defines a system’s priority for automatic recovery after a connection breakdown. The system to which the higher value was assigned is removed from the XCS network with an ABORT. If the systems have the same value assigned to them, then the system that entered the network last will be removed. The default value *STD corresponds to the value 16. See also "Global control parameters ".
FADING-INTERVAL = *STD / <integer 0..300 seconds >
For reasons of compatibility, this parameter is still accepted, but is no longer evaluated.
NOTIFY-BY-MAIL = *UNCHANGED / *NO / *YES(...)
Specifies whether a user should also be notified by email when the following problems occur:
In the event of unexpected loss of an MSCF connection
If there is a danger of a change of master not succeeding
NOTIFY-BY-MAIL = *NO
No notification is to be provided by email.
NOTIFY-BY-MAIL = *YES(...)
Notifications are to be sent by email to a user ID. When an email is sent, the email address is taken from the EMAIL-ADDRESS field of the user entry concerned (see the MAIL-FILE command).
USER-ID = TSOS / <name 1..8>
Receiver’s user ID. The default is TSOS.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | Command executed without error | |
1 | CMD2201 | Parameter error | |
1 | MCA0032 | Command only permitted within an MSCF configuration file | |
2 | CMD2202 | MSCF subsystem not defined | |
3 | CMD2203 | Installation error | |
32 | MCS0025 | Internal error (bourse call, request memory) | |
64 | CMD0216 | User is not privileged | |
65 | CMD2241 | MSCF subsystem is not loaded | |
65 | MCS0003 | MSCF subsystem currently being loaded | |
65 | MCS0004 | MSCF subsystem currently being unloaded | |
66 | CMD2242 | No connection to the MSCF subsystem | |
128 | CMD2280 | MSCF subsystem temporarily not available | |
129 | CMD2281 | MSCF subsystem unavailable for an extended period | |
130 | CMD2282 | MSCF subsystem unavailable for an undefined period |