Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 16 Operator Commands : Commands to Control a Data Object Broker

Commands to Control a Data Object Broker
The format for Data Object Broker operator commands is:
MODIFY dob_jobname,osbcommand
or
F dob_jobname,osbcommand
where
Keywords and all commands except the TIBCO Object Service Broker Shutdown command can be abbreviated to a unique truncated form.
Issuing Data Object Broker Operator Commands
If you do not have access to a z/OS operator console, you can issue a Data Object Broker command in batch mode using S6BTLCMD, the Batch Operator Command utility. TIBCO Object Service Broker operator commands can also be issued using the Operator Functions option of the Administration menu, described in 2. Operator Functions.
See Also
TIBCO Object Service Broker for z/OS Utilities for information about S6BTLCMD.
Commands
The following table describes the Data Object Broker operator commands and gives examples of how the commands are entered.
Displays the current Backup While Open (BWO) status of the page and journal DOB data sets. Refer to message S6BKF051I for an explanation of the information displayed. See related FREEZE and UNFREEZE commands. Refer to TIBCO Object Service Broker for z/OS Managing Backup and Recovery for information about BWO.
MODIFY dob_jobname, BWOSTATUS
By quiescing by terminal ID you can differentiate between sessions.
MODIFY dob_jobname, Canceltermid=HNMAD001
Canceluser=userid a, 2
Canceluser= userid;commnum
MODIFY dob_jobname, Canceluser=USR001
MODIFY dob_jobname, Checkpoint
Requests the communications subsystem to restart any of the protocols that are currently inactive.
MODIFY dob_jobname, Comrestart
A single or double asterisk (*) beside a task indicates a potentially serious problem that should be investigated.
MODIFY dob_jobname,CRstatus displays:
Attempts to disable processing via the HCS relay using the currently loaded parameters.
F Mycomponent,CS,DISABLE
Attempts to enable processing via the HCS relay using the currently loaded parameters.
Modifies the name held by the RELAY for the RELAY parameter file. It does not load it. In order to load it use either the REFRESH command if this is sufficient, or use REFRESH followed by DISABLE and ENABLE the RELAY.
F Mycomponent,CS,PARMDSN=
CS,PARMDSN=new.dataset.name
F Mycomponent,CS,PARMDSN=
new.dataset.name
CS,PARMDSN=new.dataset.name(xxxxxxxx)
Changes the parameter file to member xxxxxxxx of data set new.dataset.name.
F Mycomponent,CS,PARMDSN=
new.dataset.name(xxxxxxxx)
Reloads the RELAY parameter file that was allocated to the component at initialization time, or after modification by a subsequent F,Mycomponent,CS,PARMDSN= command.
If an error occurs the RELAY continues processing without modifying the parameters in use. This allows an administrator to change the mapping of communication identifiers to TCP/IP hosts and ports. Changes to tcpipparms will not be honored and you will need to DISABLE and ENABLE the RELAY for any such changes to become effective.
F Mycomponent,CS,REFRESH
Displays the status of the RELAY and the name of the current RELAY parameter data set.
Dbjrnloff=segname or segnumber
MODIFY dob_jobname, Dbjrnloff=sales
MODIFY dob_jobname, Dbjrnloff=1
Dbjrnlon=segname or segnumber
The segment referenced by this command must currently be offline.
Note  If journal processing is turned off in the Data Object Broker startup parameters, journals cannot be individually activated.
MODIFY dob_jobname, Dbjrnlon=sales
Dboffline=segname or segnumber
To be varied offline, the segment must not be designated as a system segment in the DBDLIB.
If there are pending updates for the specified segment, the segment is quiesced and is not terminated until the next checkpoint is complete.
MODIFY dob_jobname, Dboffline=sales
Dbonline=segname or segnumber
MODIFY dob_jobname, Dbonline=sales
Dbreadonly=segname or segnumber
MODIFY dob_jobname, Dbreadonly=sales
Dbreadwrite=segname or segnumber
MODIFY dob_jobname, Dbreadwrite=sales
MODIFY dob_jobname, Dbsegmentstatus displays:
Forceuser=userid b
Forceuser=userid; commnum
WARNING  Every effort is taken to ensure a clean termination but data integrity could be compromised. Use this command with extreme caution.
The command releases all resources and logical locks, and frees the specified commarea, no matter the state of the commarea.
If the command is issued and there was no previous CANCELUSER, the request is automatically downgraded to a CANCELUSER and a message is produced.
The command is logged as an alert to ensure that there is a record in case of inconsistent results.
MODIFY dob_jobname, Forceuser=USR001
The FREEZE command flushes all updated pages from storage to the page data sets. If necessary, checkpoints are taken and flushed. When all the I/O activity for this operation is complete, the operator message S6BKX09I appears. While the TIBCO Object Service Broker system is frozen, transactions proceed as normal, but no write I/O is performed to the database and journals. If the BWO feature is used, the page and journal data sets that are under the control of DFSMSDFP are set into BWO status and enables the data sets for DFSMSDSS dump/copy operations. See also BWOSTATUS and UNFREEZE. Refer to TIBCO Object Service Broker for z/OS Managing Backup and Recovery for information about BWO.
MODIFY dob_jobname, FREEZE
Tells you whether a GTF task is active for collecting GTF records. See also related Data Object Broker parameters SSTRACE and MSGTRACE.
MODIFY dob_jobname, GTFstatus
Journaloff=journalnumber
Jrnloff=journalnumber
Brings a journal data set offline, withdrawing it from the pool of journal data sets.
Journalon=journalnumber
Jrnlon=journalnumber
Brings a journal data set online to make it available in the pool of journal data sets.
MODIFY dob_jobname, Jrnlon=01
The statistics for the active journal (the one showing status flag A) include a percentage that indicates how full the journal is.
MODIFY dob_jobname, Journalstatus
Displays the current status of all members of a Data Object Broker XCF group.
MODIFY dob_jobname, MEMBERLIST
Enables the TIBCO Object Service Broker network and cross-memory communications access, if possible.
MODIFY dob_jobname, Netrestart
Notrace=userid b
Notrace=userid; commnum
MODIFY dob_jobname,Notrace=usr01
Parm=parmname= value
Parameter=parmname= value
Provides you with the ability to override many Data Object Broker startup parameters.
MODIFY dob_jobname, Parm=Chpagelimit=500
Peercancel=applid
Disconnects all inbound peer connections from the specified peer server.
WARNING  The command releases all resources and logical locks, and frees the specified commarea, no matter the state of the commarea. Use the Peercancel command with extreme caution, only, for example, when a network problem has disrupted communications with the remote peer.
MODIFY dob_jobname, Peercancel=HKXU0003
After the command is issued, the Administration menu (S6BTLADM) remains fully functional and new users cannot log in and existing users can browse only.
Refer to Administration Menu for more information.
MODIFY dob_jobname, Quiesce
MODIFY dob_jobname, Resume
Note  Shutdown cannot be abbreviated.
MODIFY dob_jobname, Shutdown
Spinenable=Yes or No
MODIFY dob_jobname, Spinenable=Y
Refreshes spin JCL in memory for the specified journal number without requiring that the Data Object Broker be restarted.
MODIFY dob_jobname, Spinloadjcl=1
Spinsubmit=Normal or Checkpoint or Immediate
N (Normal) Cancels a SPINSUBMIT=Check-point request.
MODIFY dob_jobname, Spinsubmit=I
Startpeer=applid
Starts a specified outbound peer connection (for example, after a network outage).
Before the request is processed, it is validated to ensure that the specified peer is valid and is not currently involved in connection processing. The number of peer connections must be below defined limits.
Refer to Chapter 13, Managing TIBCO Object Service Broker Networked Resources for more information about peer connections and to the Peercancel command.
MODIFY dob_jobname, Startpeer=HKXU0003
ALLserver_type
SRVIDgroup
Quiesces the specified servers. If the server is currently associated with a transaction, it is not stopped until the transaction ends.
connection_id is the unique identifier for the connection.
This identifier typically consists of a prefix and a sequence number. It appears in the login message and also on the Resource Manager PATH LIST screen of the Administration menu. Refer to 3. Resource Management for more information.
ALLDBMS stops all external database servers. Outbound peer servers not affected.
ALLHURON stops all outbound peer connections. Same as ALLHRN.
ALLserver_type stops all servers of server_type, which is a three-character abbreviation for the type of server; for example, Adabas servers have a type of ADA, peer servers (also referred to as rules API servers) have type API.
SRVIDserverid stops all servers with a matching serverid.
MODIFY dob_jobname, Stopserver=IMS01
MODIFY dob_jobname, Stopserver=ALLDB2
MODIFY dob_jobname, Stopserver=SRVIDDEFAULT0
Sweepaction=(action, userid) b
Sweepaction=(action, userid;commnum)
Modifies the previously specified method of Page Sweep reporting for the specified user ID. This method is specified by either a Sweepaction command or by the PAGESWEEPACTION Data Object Broker parameter. Valid action values:
NODUMP: Disable the request for SVC dumps for page sweep violations
userid is the user ID of the connection.
commnum is required only in the case of duplicate user IDs.
MODIFY dob_jobname, Sweepaction=(SMF,usr40;1)
MODIFY dob_jobname, Sweepaction=(NODUMP,usr40)
Sweeplimit=(limit, userid) b
Sweeplimit=(limit, userid;commnum)
Modifies the previously specified threshold at which to trigger Page Sweep reporting. This limit is specified by either a Sweeplimit command or by the PAGESWEEPLIMIT Data Object Broker parameter. Valid values are 0 to 65535. A value of 0 disables Page Sweep reporting for the specified user.
userid is the user ID of the connection.
commnum is required only in the case of duplicate user IDs.
MODIFY dob_jobname, Sweeplimit=(1000,usr40)
Controls switch processing. MEMBERNAME and ANY are only supported by the primary Data Object Broker. FORCE and ALLOW are only supported by a secondary Data Object Broker.
MEMBERNAME – terminate the current primary Data Object Broker and switch to the secondary Data Object Broker identified by MEMBERNAME.
ANY – terminate the current primary Data Object Broker and switch to any available secondary Data Object Broker.
FORCE – if there is no active primary Data Object Broker in the Data Object Broker XCF group, initialize this secondary Data Object Broker to become the primary Data Object Broker.
ALLOW – allow this secondary Data Object Broker to be the target of a SWITCH command (if the secondary Data Object Broker is set to the NSWITCH state due to a mismatch of configuration data with the primary Data Object Broker, then ALLOW will set this secondary Data Object Broker’s state to 2READY, thus allowing it to be the target of a SWITCH command).
MODIFY dob_jobname, SWITCH=ALLOW
Issues a TIBCO Object Service Broker date/time WTO message to the system log.
MODIFY dob_jobname, Timestamp
Traceid=userid b
Traceid=userid; commnum
Traces all system service activity for the specified userid. Data is written to GTF. Appropriate GTF setup is required.
Note  You can either use the full system service trace (Sstrace), or you set the trace for a specific userid.
MODIFY dob_jobname,
Traceid =USR08
The UNFREEZE command allows I/O activity to database and journals to resume. If BWO support is used, prior to resuming I/O, the page and journal data sets that are under the control of DFSMSDFP are reset to normal access thus disabling concurrent access. See also BWOSTATUS and FREEZE. Refer to TIBCO Object Service Broker for z/OS Managing Backup and Recovery for information about BWO.
MODIFY dob_jobname, UNFREEZE
Displays a count of TIBCO Object Service Broker user IDs by category (for example, users, external database servers, jobs). See also Userlist.
MODIFY dob_jobname, Usercount
Displays a list of all users who are logged in, followed by the counts in each category (for example, users, external database servers, jobs). If no users are logged in, only user counts appear. See also Usercount.
MODIFY dob_jobname, Userlist
The list of users is given in the format x-uuuuuuuu where the x is the session type prefix, followed by a - or + character, and then a character user identifier uuuuuuuu.
The second character indicates whether the session is being traced or not. + indicates tracing for the session is active; - indicates no tracing. See command TRACEID for more information on tracing.
The type of session is identified by the one character prefix. The meanings are:
" " (blank) – TSO user
C – CICS user
D – DBMS or rules server session
J – Batch job
N – Native Execution user
U – UNIX user
I – IMS/DC user
L – deferred logoff
O – Operator or OAI session
t – Standby / “other type” session
P – Peer server (HIN)
Usermax=value
Adjusts the maximum number of Execution Environment users allowed to log in to TIBCO Object Service Broker. Users already logged in and administrators are not affected. Minimum value is 0. Maximum is the same as the Maxuser value defined at TIBCO Object Service Broker startup.
Usermax=0 can be useful to prevent anyone logging in just before a Data Object Broker shutdown.
MODIFY dob_jobname, Usermax=0
Closes the TIBCO Object Service Broker WTO message log SYSOUT file. Open a new WTO log file.
MODIFY dob_jobname, Wtoprint
Wtosysout=value
Determines whether TIBCO Object Service Broker WTO messages are written to a SYSOUT file.
MODIFY dob_jobname, Wtosysout=yes

1
If the connection is idle, that is, waiting for an Execution Environment request, it is terminated immediately. If the Data Object Broker is processing a query on behalf of the Execution Environment, the connection is terminated when the next service request is received by the query processor. If the Data Object Broker is processing a commit, the connection is terminated when the commit is completed.

2
If the specified user ID is not unique, a list of connections with the specified user ID appears. This list contains additional information to help identify the connection to be processed. You must reenter the command with “;commnum” where commnum is selected from the list.


Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved