.\"Generated by nroff_template.wdt (12-Sep-06). Do NOT edit this output file. Instead, edit the source FM+SGML file.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH bbcutil "" "" ""
.ds )H Hewlett-Packard Company
.ds ]L
.ds ]W June 2007
.SH NAME
bbcutil - a tool for debugging a BBC-based server.
.SH "SYNOPSIS"

.PP
bbcutil -h|-help 

.PP
bbcutil -version 

.PP
bbcutil -ovrg [<\fIovrg\fR>] 

.PP
bbcutil -reg|-registrations [<\fIhostname\fR>|<\fIip\fR>] [-v|-verbose] 

.PP
bbcutil -deregister {<\fIpath\fR>|*} [-force] [-v|-verbose] 

.PP
bbcutil -ping {[<\fIhostname\fR>|<\fIip\fR>[:<\fIport\fR>]] | [<\fIuri\fR>]} [count] [-v|-verbose] 

.PP
bbcutil -status {[<\fIhostname\fR>|<\fIip\fR>[:<\fIport\fR>]] | [<\fIuri\fR>} [-v|-verbose]] 

.PP
bbcutil -migrate {[<\fInamespace\fR>] [<\fIappname\fR>] [<\fIfilename\fR>]} [-v|-verbose] 

.PP
bbcutil -count|-size|-list [-p|-path \fI<path>\fR] [-t|-target \fI<target>\fR] [-v|-verbose] 

.PP
bbcutil -getcbport [<\fIhostname\fR>|<\fIip\fR>] 

.PP
bbcutil -gettarget [<\fIhostname\fR>|<\fIip\fR>] 

.SH "DESCRIPTION"

.LP
The bbcutil command helps you to debug a BBC-based server. The bbcutil command can be used to list all applications registered to a Communication Broker, to check whether specified communication services are alive, and to display details about the current state of the server.

.Sh "Parameters"

.LP
The bbcutil command incorporates the options in the following list. The syntax for the [<\fIhostname\fR>|<\fIip\fR>][:<\fIport\fR>]] string, for example; in the options -registrations or -ping, can be a hostname and a port separated by a colon (:) but can also be a full URL path (including protocol), such as:

.LP
https://merlin.guilford.mycom.com:383/com.hp.ov.coda

.LP
bbcutil recognizes the following options:

.TP
-h|-help

Displays and describes the available options for the bbcutil command.

.TP
-version

Displays the version of the OV communication in use.

.TP
-ovrg <\fIovrg\fR>

Executes a bbcutil command option in the context of the OV resource group specified by <\fIovrg\fR>. This is an optional command. It can be used with other bbcutil commands. For example, bbcutil -ovrg testsrv -getcbport command returns the HP OpenView Communications Broker port number of the OV resource group, testsrv.

.TP
-reg|-registrations [<\fIhostname\fR>|<\fIip\fR>]

Queries a Communications Broker on the node specified by \fI<hostname>\fR or \fI<ip>\fR and displays a list of all registered applications. If the hostname or IP address is not specified, localhost is assumed.

.TP
-deregister {<\fIpath\fR>|*} [-force]

Deregisters the specified path from the HP OpenView Communications Broker on the localhost. You can use the asterisk character '*' to denote \fIall\fR paths. The specified path will not be deregistered if the application servicing the specified path is currently running. Use the -force option to override this behavior and force the path to be deregistered.

.TP
-ping {[<\fIhostname\fR>|<\fIip\fR>][:<\fIport\fR>]] | [<\fIuri\fR>]} [count]

Pings the specified HP OpenView server process. A hostname or IP address with an optional port number or a URL may be given to locate the server process to ping. If a URL is given with the path of a valid process registered with the Communications Broker, the Communications Broker will automatically forward the ping to the registered process. Count specifies the number of times to execute the ping. The node may be specified with a hostname or IP address. Default for the node is "localhost". Default for the port is the HP OpenView Communications Broker port on the specified node. Default count is 1.

.TP
-status {[<\fIhostname\fR>|<\fIip\fR>[:<\fIport\fR>]] | [<\fIuri\fR>]}

Displays the status of the specified HP OpenView server process. A hostname or IP address with an optional port number or a URI may be given to locate the server process. The node may be specified with a hostname or IP address. Default for the node is localhost. Default for the port is the HP OpenView Communications Broker on the specified node.

.TP
-migrate {[<\fInamespace\fR>] [<\fIappname\fR>] [<\fIfilename\fR>]} [-v|-verbose]

Migrates the specified BBC configuration parameters. If no command parameters are specified the BBC 2 LLB and the BBC 4 CB parameters will be migrated to the namespace bbc.cb in the configuration database. The BBC 2/3 DEFAULT parameters will be migrated to the namespaces bbc.http, bbc.fx, and bbc.snf. BBC 4 CB parameters will override BBC 2 LLB parameters. The namespace specifies the BBC 2/3/4 namespace to migrate the parameters from. The <\fIappname\fR> specifies the application name to use in determining the BBC 5 target namespace. Parameters are migrated to the bbc.http.ext.<\fIappname\fR>, bbc.fx.ext.<\fIappname\fR>, and bbc.snf.ext.<\fIappname\fR> namespaces. The file name parameter specifies the file to read the parameters from. Default file name is the BBC 2 standard default.txt file and the standard BBC 4 Communications Broker settings.ini file. The BBC 4 settings.ini parameters override the BBC 2 default.txt parameters.

.TP
-count

Displays the number of requests in a store-and-forward buffer for the specified target, or the entire buffer if no target is specified. 

.TP
-size

The -size option displays the size of a store-and-forward buffer. If -verbose is specified as well, the size of each individual request is displayed. If a target is specified, only the size of the requests to this target are displayed.

.TP
-list

The -list option displays all requests in a store-and-forward buffer for the specified target or the entire buffer if no target is specified.

.TP
-p|-path \fI<path>\fR

The -path option defines the path to the store-and-forward buffer. This parameter is used to set the BUFFER_PATH parameter. 

.TP
-t|-target \fI<target>\fR

The -target option specifies the target URI, whose information you want to display. If no target is specified, information for all targets in the buffer is displayed.

.TP
-verbose

Shows more detailed output.

.TP
-getcbport [<\fIhostname\fR>|<\fIip\fR>]

Displays the HP OpenView Communications Broker port number of the node specified by \fI<hostname> \fRor \fI<ip>\fR. If the hostname or IP address is not specified, localhost is assumed.

.TP
-gettarget [<\fIhostname\fR>|<\fIip\fR>]

Displays the IP address of the target node and the HP OpenView Communications Broker port number, or the HTTP Proxy and port number, if a proxy is configured for the specified \fI<hostname> \fRor \fI<ip>\fR.

.SH "AUTHOR"

.LP
bbcutil was developed by Hewlett-Packard Company.

.SH "EXIT STATUS"

.LP
The following exit values are returned:

.TP
0

bbcutil exited normally with no error.

.TP
1

Command syntax error encountered. See command syntax for more details on possible values.

.TP
2

Command partially succeeded.

.TP
3

Command failed. See command output for more detailed information.

.TP
4

bbcutil could not complete the requested command due to an authorization error.

.TP
100

An exception was encountered causing the Communications Broker to exit.

.LP
Corresponding error messages are written to stderror.

.SH "EXAMPLES"

.LP
The following examples show you how to use the bbcutil command:

.TP 3
\(bu 
To show the status of HP OpenView Communication Broker on the local node:

bbcutil -status

.TP
\(bu 
To query the communication server located at https://merlin.guilford.mycom.com:383/com.hp.ov.coda for details about the current state of the server:

bbcutil -ping https://merlin.guilford.mycom.com:383/com.hp.ov.coda
.LP

.SH "SEE ALSO"

.LP
ovbbccb, bbc.ini

.Sh "COPYRIGHT"

.LP
(c) Copyright 2001-2007 Hewlett-Packard Development Company, L.P.

.LP
HP shall not be liable for technical or editorial errors or omissions contained herein.