# Control Commands

You can enter the Control commands on the z/OS console. The Control commands include SET, SHUT, SWITCH, and TERM commands.

## SET Command

The SET commands change various entities. For information about the command values, see "Substation ES Parameters" in TIBCO Substation ES Installation.

The SET commands are used in the following ways:

SET,`CICS,STATS={Y|N}[,INTF|IID=intf-id]`
  This command starts and stops the CICS interface statistics recording. The optional keyword `INTF|IID=intf-id` specifies a CICS interface identifier.
  For the CICS interface statistics recording function to work correctly, you must set the parameter STATISTICS to YES in the TIBSLOG member in the PARM dataset.
SET,`CICS,TRCLVL-HVS=value[,INTF|IID=intf-id]`
  This command changes the trace level of CICS when tracing reliable TSQ trigger entries that pass through the interface. The range of the valid values is from 0 to 3. The optional keyword `INTF|IID=intf-id` specifies a CICS interface identifier.
SET,`CICS,TRCLVL-ONL=value[,INTF|IID=intf-id]`
  This command changes the level of information messages produced by CICS resident programs that act on or on behalf of Substation ES. Messages are written to the CEEOUT and CEEMSG CICS output data sets. The range of the valid values is from 0 to 5. The optional keyword `INTF|IID=intf-id` specifies a CICS or IMS interface identifier.
  Use the transaction SXTH,VER to view the current CICS interface online tracing level.
SET,`CICS|IMS,TRCLVL-TRIG=value[,INTF|IID=intf-id]`
  This command changes the level of CICS or IMS trigger information recorded to the trace file. The range of the valid values is from 0 to 3. The optional keyword `INTF|IID=intf-id` specifies a CICS or IMS interface identifier.
SET,`IMS,BUFFER-PURGE[,INTF|IID=intf-id]`
  This command cleans the OTMA buffers currently in use for all IMS interfaces that are active within the current Substation ES instance. The optional keyword and IMS identifier `INTF|IID=intf-id` can be used to specify a particular IMS interface for cleanup.
SET,`IMS,FREE-TRIG[,INTF|IID=intf-id]`
  This command starts the tpipes associated with the IMS trigger processes. The optional keyword `INTF|IID=intf-id` specifies a particular IMS interface identifier.
SET,`IMS,HOLD-TRIG[,INTF|IID=intf-id]`
  This command stops the tpipes for the IMS trigger processes. The optional keyword `INTF|IID=intf-id` specifies a particular IMS interface identifier.
SET,`IMS,REL-TRNAK[,SXITRNAK|DFS$$TOQ]`
  This command starts processing of triggers that were NAKd and requeued to the NAKd trigger queue (`SXITRNAK`), or were timed out by IMS (`DFS$$TOQ`). If a queue name is not specified, the default is `SXITRNAK`. Any other queue name is rejected.
  This command might only be issued when triggers are enabled. If triggers are held, the command is rejected.
SET,`LOGDEST=value`
  This command changes the destination for the Substation ES log file. The valid values are D(isk) or P(rint).
SET,`LOGLVL=value`
  This command changes the level of information recorded to the log file. The range of the valid values is from 1 to 5.
SET,`LOGFWRITE=value`
  This command changes the number of centiseconds (1/100 of a second) of the Force Write for the LTA Log agent. The range of the valid values is from 0 to 30.
SET,`RED,ABEND-RESET[,INTF|IID=intf-id]`
  This command resets the abend counter to 0. The counter is the number of times that #RED or the application abend. The optional keyword `INTF|IID=intf-id` specifies a particular RED interface identifier. This command does not change the maximum abend value in the RED interface. The maximum abend is determined by parameter "CICS-ABEND-VALUE" in the Substation ES RED interface definitions. The default is 5. Once this is set, it cannot be changed without re-cycling the CICS region.
SET,`RED,STATS|STATISTICS={Y|N},INTF|IID=intf-id]`
  This command starts and stops the CICS RED interface statistics recording. The optional keyword `INTF|IID=intf-id` specifies a RED CICS interface identifier.
SET,`RED,TRCLVL-AMSG|TRCLVL-SSRED|TRCLVL-CICS|TRCLVL-#RED|TRCLVL-TRG|TRCLVL-VIEW=value`
  This command changes the level of information recorded from the following processes to the trace file:
  - `TRCLVL-AMSG`: the RED interface for AMSG related messages. The range of the valid values is from 0 to 3.
  - `TRCLVL-SSRED`: the RED interface for general messages. The range of the valid values is from 0 to 5.
  - `TRCLVL-CICS`: the RED trace level for online relate messages. The range of the valid values is from 0 to 5. If it is set to zero (0) then all the following trace levels will also be set to zero (0). TRCLVL-#RED, TRCLVL-TRG and TRCLVL-VIEW.
  - `TRCLVL-#RED`: the RED trace level only for #RED transaction relate messages. The range of the valid values is from 0 to 5.
  - `TRCLVL-TRG`: the RED trace level only for OTRED the trigger processes relate messages. The range of the valid values is from 0 to 5.
  - `TRCLVL-VIEW`: the RED trace level only for VIEW transaction relate messages. The range of the valid values is from 0 to 5.
SET,`RVFT[=value],INTF|IID=intf-id`
  This command allows dynamic switch between the RVFT daemons. The value can be 1, 2 or 3 indicating the number of the daemon to be switched to. If no value is specified, it will be switched to the number 1 daemon in the sequence.
  Note: The command is executed for all transports in the interface that are active and which use Substation ES RV Fault Tolerant URL.
  The command output of 'SET,RVFT=3,IID=ESB01' is as follows:

      SXA2601I Console Command 'SET,RVFT=3,IID=ESB01'
      SXT5470I IId:ESB01 INFO Advisory RVD.CONNECTED for RV-ESB-3URL
      SXT5490I IId:ESB01 Starting RV transport: RV-ESB-3URL, svc:
               8233, network: NULL, daemon: daemon3.tibco.com:8200,
               DistQ: N
      SXT5995I IId:ESB01 RV-ESB-3URL was #1 daemon1.tibco.com:8200
      SXT5995I IId:ESB01 RV-ESB-3URL now #3 daemon3.tibco.com:8200

  The command output of 'SET,RVFT,IID=ESB01' is as follows:

      SXA2601I Console Command 'SET,RVFT,IID=ESBRAI'
      SXT5470I IId:ESBRAI INFO Advisory RVD.CONNECTED for RV-ESB-3URL
      SXT5490I IId:ESBRAI Starting RV transport: RV-ESB-3URL, svc:
               8233, network: NULL, daemon: daemon1.tibco.com:8200,
               DistQ: N
      SXT5995I IId:ESBRAI RV-ESB-3URL was #3 daemon3.tibco.com:8200
      SXT5995I IId:ESBRAI RV-ESB-3URL now #1 daemon1.tibco.com:8200
      SXA2666I End-of-Command

SET,`STATS={Y|N}`
  This command sets the Substation ES Statistics recording to On or Off.
SET,`STATS={Y|N},INTF|IID=intf-id]`
  This command starts and stops the Substation ES and the CICS interfaces (RED and EXCI) statistics recording. The optional keyword `INTF|IID=intf-id` specifies a CICS interface identifier.
SET,`TRACE-ENTRY=CONFIG,DETAIL`
  This command sets `TRACE-ENTRY` for the Substation ES transformer.
SET,`TRCDEST=value`
  This command changes the destination for Substation ES trace information. The valid values are D(isk) or P(rint).
SET,`TRCLVL=value`
  This command changes the level of information recorded to the trace file. The range of the valid values is from 1 to 5.
SET,`TRCLVL=value[,OTMA|OPS|RR]`
  This command changes the level of information recorded from the following processes to the trace file:
  - `OTMA`: the OTMA modules of the IMS interface.
  - `OPS`: the operational command processor and the internal message process of Admin Interface.
  - `RR`: the CICS outbound Request/Reply Trigger process. For levels greater than or equal to 3, the message SXT5328I writes to the log file.
  The range of the valid values is from 1 to 5.
SET,`TRCFWRITE=value`
  This command changes the number of centiseconds (1/100 of a second) of the Force Write for LTA Trace Agent. The range of the valid values is from 0 to 30.

## SHUT Command

The SHUT command causes an active Substation ES instance to terminate in an orderly manner. All input is stopped and all active requests within the Substation ES instance can be completed before the final termination request is sent to all active Substation ES interfaces.

## SWITCH Command

The SWITCH instructs the appropriate LTA Log agent or LTA Trace agent to continue recording events on the next available disk file. If no files are available, an error is recorded to the log file and processing continues. You can use this command only if the recording medium is set to disk on the Substation ES SSP member.

SWITCH,`LOGFILE`

SWITCH,`TRCFILE`

## TERM Command

The TERM command causes an active Substation ES instance to terminate in an orderly manner. Termination proceeds as if a SHUT command were issued. However, if the Substation ES tasks do not appear to be terminating, the Substation ES master task attempts to cancel all the active tasks within each Substation ES interface.

Warning: For better results do not use this command because in-flight messages can be lost due to cancellation of active tasks.
Copyright © TIBCO Software Inc. All rights reserved.