TIBCO Object Service Broker Operator Commands

You can use the hrncr command to send TIBCO Object Service Broker operator commands to a running Data Object Broker. You do this by issuing the operator command as an argument to hrncr. The Data Object Broker records error messages or results in the log. If you want, you can dedicate a window to monitoring the Data Object Broker log and issue operator commands from other windows as needed. You can use this to see error messages or results as you enter operator commands.

varies segment 1 offline, and

cancels TIBCO Object Service Broker sessions for user ID usr40.

The Administration menu (hrntladm) utility provides an Operator Command option (Option O) that shows the local Data Object Broker log and where you can issue operator commands at the same time. You cannot use the Administration menu Operator Command option to view remote Data Object Broker logs.

For more information about the Administration menu, refer to Chapter 6, Monitoring TIBCO Object Service Broker.

-d databasedir	Override the TIBCO Object Service Broker database directory. By default this is under the TIBCO Object Service Broker installation directory, %HURON%/database.
-f	Prevent hrncr from closing its console window. When, in Windows, hrncr is invoked with a start command from a command prompt or is launched from an icon, it creates a temporary console window in which it displays a message for each of the Data Object Broker processes it creates. This argument keeps the window (which can be minimized by the user) open as long as the Data Object Broker is running.
-h hurondir	Override the TIBCO Object Service Broker installation directory. By default this is extracted from the environment variable HURON. If the HURON variable is not set, this argument must be specified.
-l logdir	Override the TIBCO Object Service Broker log directory. By default this is the log directory under the TIBCO Object Service Broker installation directory, %HURON%/log. This argument is ignored if the Data Object Broker is active.
-o parmoverrides	Override one or more Data Object Broker parameters. Data Object Broker parameters are normally set in the crparm file (%HURON%/database/crparm). Parameters set with this argument override those in the crparm file. The syntax is: parm1=val[,parm2=val[,parm3=val[...]]]
-p parmfile	Override the Data Object Broker parameter file. By default this is under the TIBCO Object Service Broker database directory, %HURON%/database/crparm.

-d databasedir

Override the TIBCO Object Service Broker database directory. By default this is under the TIBCO Object Service Broker installation directory, %HURON%/database.

-f

Prevent hrncr from closing its console window. When, in Windows, hrncr is invoked with a start command from a command prompt or is launched from an icon, it creates a temporary console window in which it displays a message for each of the Data Object Broker processes it creates. This argument keeps the window (which can be minimized by the user) open as long as the Data Object Broker is running.

-h hurondir

Override the TIBCO Object Service Broker installation directory. By default this is extracted from the environment variable HURON. If the HURON variable is not set, this argument must be specified.

-l logdir

Override the TIBCO Object Service Broker log directory. By default this is the log directory under the TIBCO Object Service Broker installation directory, %HURON%/log. This argument is ignored if the Data Object Broker is active.

-o parmoverrides

Override one or more Data Object Broker parameters. Data Object Broker parameters are normally set in the crparm file (%HURON%/database/crparm). Parameters set with this argument override those in the crparm file. The syntax is:

parm1=val[,parm2=val[,parm3=val[...]]]

-p parmfile

Override the Data Object Broker parameter file. By default this is under the TIBCO Object Service Broker database directory, %HURON%/database/crparm.

You can enter the following operator commands using hrncr or the Operator Command option as described:

?	Displays command usage information.
CANCELUSER= sessionid where sessionid= userid[.terminalid] The optional terminalid may be found in the osMon log, the DOB log or using the hrntladm utility.	Disconnects a session from the Data Object Broker or Execution Environment specified by jobname. Can be issued from a command prompt as an argument to hrncr. Example: CANCELUSER=USR001
CHECKPOINT	Forces an immediate checkpoint. Can be issued from a command prompt as an argument to hrncr.
DBOFFLINE=segname or segnumber	Moves the specified segment offline. Can be issued from a command prompt as an argument to hrncr.
DBONLINE=segname or segnumber	Varies the specified segment online. Can be issued from a command prompt as an argument to hrncr. Example: DBONLINE=7
KILL	Stops the Data Object Broker without the normal shutdown procedure. This sub command should be used only if the Data Object Broker is not responding to a shutdown command or if there is an urgent need to bring it down quickly.
LOG	Creates a window to monitor the Data Object Broker log file. Updates to the log appear as they are written to the log.
NOTRACE=sessionid where sessionid= userid[.terminalid] The optional terminalid may be found in the osMon log, the DOB log or using the hrntladm utility.	Terminates tracing of the indicated session.
PARM= parmname=value	Overrides the specified Data Object Broker startup parameter. Refer to Dynamically Modifying the Parameters additional information about this command. Example: PARM=CHPAGELIMIT=500
RESUME	Not used
SHUTDOWN	Shuts down the Data Object Broker. Can be issued from a command prompt as an argument to hrncr. The request is sent to the active Data Object Broker. The shutdown process can take anywhere from half a minute to several minutes depending on Data Object Broker activity shortly before shutdown.
SPINSUBMIT	Submits a journal spin job, either immediately (I) or deferred until the next checkpoint (D). Example: SPINSUBMIT=I
STATE	Returns the state of the Data Object Broker: Active Online Offline Shutdown
STOP	Shuts down the Data Object Broker (same as the SHUTDOWN command). Can be issued from a command prompt as an argument to hrncr. The request is sent to the active Data Object Broker. The shutdown process can take anywhere from half a minute to several minutes depending on Data Object Broker activity shortly before shutdown.
STOPSERVER= ALLDBMS \| ALLHURON \| ALLserver_type \| ALLREMOTE \| SRVIDserverid \| server_userid	Disconnects one or more external servers. Can be issued from a command prompt as an argument to hrncr, where: server_type is a three-character abbreviation for the type of external server; for example, SQL based servers have a type SLK, peer servers (also referred to as rules API servers) have type PRS. ALLDBMS stops all external database servers. ALLHURON stops all inbound connections. ALLserver_type stops all servers of type server_type; for example, ALLPRS stops all peer servers. ALLREMOTE combines ALLDBMS and ALLPRS. SRVIDserverid stops all external servers with ID serverid. server_userid stops the server with the user ID server_userid. Example: STOPSERVER=ALLDBMS
TRACEID=sessionid where sessionid= userid[.terminalid] The optional terminalid may be found in the osMon log, the DOB log or using the hrntladm utility.	Traces all system service activity for the specified session. Note You can specify a full system service trace (using the value SSTRACE), or the trace for a specific session.

Displays command usage information.

CANCELUSER=
sessionid

where sessionid=
userid[.terminalid]

The optional terminalid may be found in the osMon log, the DOB log or using the hrntladm utility.

Disconnects a session from the Data Object Broker or Execution Environment specified by jobname. Can be issued from a command prompt as an argument to hrncr.

Example: CANCELUSER=USR001

CHECKPOINT

Forces an immediate checkpoint. Can be issued from a command prompt as an argument to hrncr.

DBOFFLINE=segname or segnumber

Moves the specified segment offline. Can be issued from a command prompt as an argument to hrncr.

DBONLINE=segname or segnumber

Varies the specified segment online. Can be issued from a command prompt as an argument to hrncr.

Example: DBONLINE=7

KILL

Stops the Data Object Broker without the normal shutdown procedure. This sub command should be used only if the Data Object Broker is not responding to a shutdown command or if there is an urgent need to bring it down quickly.

LOG

Creates a window to monitor the Data Object Broker log file. Updates to the log appear as they are written to the log.

NOTRACE=sessionid

where sessionid=
userid[.terminalid]

The optional terminalid may be found in the osMon log, the DOB log or using the hrntladm utility.

Terminates tracing of the indicated session.

PARM= parmname=value

Overrides the specified Data Object Broker startup parameter.

Refer to Dynamically Modifying the Parameters additional information about this command.

Example: PARM=CHPAGELIMIT=500

RESUME

Not used

SHUTDOWN

Shuts down the Data Object Broker. Can be issued from a command prompt as an argument to hrncr.

The request is sent to the active Data Object Broker. The shutdown process can take anywhere from half a minute to several minutes depending on Data Object Broker activity shortly before shutdown.

SPINSUBMIT

Submits a journal spin job, either immediately (I) or deferred until the next checkpoint (D).

Example: SPINSUBMIT=I

STATE

Returns the state of the Data Object Broker:

Active
Online
Offline
Shutdown

STOP

Shuts down the Data Object Broker (same as the SHUTDOWN command). Can be issued from a command prompt as an argument to hrncr.

The request is sent to the active Data Object Broker. The shutdown process can take anywhere from half a minute to several minutes depending on Data Object Broker activity shortly before shutdown.

ALLserver_type |

SRVIDserverid |

Disconnects one or more external servers. Can be issued from a command prompt as an argument to hrncr, where:

server_type is a three-character abbreviation for the type of external server; for example, SQL based servers have a type SLK, peer servers (also referred to as rules API servers) have type PRS.

ALLDBMS stops all external database servers.

ALLHURON stops all inbound connections.

ALLserver_type stops all servers of type server_type; for example, ALLPRS stops all peer servers.

ALLREMOTE combines ALLDBMS and ALLPRS.

SRVIDserverid stops all external servers with ID serverid.

server_userid stops the server with the user ID server_userid.

Example: STOPSERVER=ALLDBMS

TRACEID=sessionid

where sessionid=
userid[.terminalid]

The optional terminalid may be found in the osMon log, the DOB log or using the hrntladm utility.

Traces all system service activity for the specified session.

Note You can specify a full system service trace (using the value SSTRACE), or the trace for a specific session.

TIBCO Object Service Broker for Open Systems Utilities for a complete description of the hrncr command and its options and sub commands.