bbcutil()bbcutil()NAMEbbcutil - a tool for debugging a BBC-based server.
SYNOPSISbbcutil -h|-help
bbcutil-version
bbcutil-ovrg [<ovrg>]
bbcutil -reg|-registrations [<hostname>|<ip>] [-v|-verbose]
bbcutil-deregister {<path>|*} [-force] [-v|-verbose]
bbcutil-ping {[<hostname>|<ip>[:<port>]] | [<uri>]} [count] [-v|-ver‐
bose]
bbcutil-status {[<hostname>|<ip>[:<port>]] | [<uri>} [-v|-verbose]]
bbcutil-migrate {[<namespace>] [<appname>] [<filename>]} [-v|-verbose]
bbcutil -count|-size|-list [-p|-path <path>] [-t|-target <target>]
[-v|-verbose]
bbcutil-getcbport [<hostname>|<ip>]
bbcutil-gettarget [<hostname>|<ip>]
DESCRIPTION
The bbcutil command helps you to debug a BBC-based server. The bbcutil
command can be used to list all applications registered to a Communica‐
tion Broker, to check whether specified communication services are
alive, and to display details about the current state of the server.
Parameters
The bbcutil command incorporates the options in the following list. The
syntax for the [<hostname>|<ip>][:<port>]] 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:
https://merlin.guilford.mycom.com:383/com.hp.ov.coda
bbcutil recognizes the following options:
-h|-help
Displays and describes the available options for the bbcutil
command.
-version
Displays the version of the OV communication in use.
-ovrg <ovrg>
Executes a bbcutil command option in the context of the OV
resource group specified by <ovrg>. This is an optional command.
It can be used with other bbcutil commands. For example, bbcutil-ovrg testsrv -getcbport command returns the HP OpenView Commu‐
nications Broker port number of the OV resource group, testsrv.
-reg|-registrations [<hostname>|<ip>]
Queries a Communications Broker on the node specified by <host‐
name> or <ip> and displays a list of all registered applica‐
tions. If the hostname or IP address is not specified, localhost
is assumed.
-deregister {<path>|*} [-force]
Deregisters the specified path from the HP OpenView Communica‐
tions Broker on the localhost. You can use the asterisk charac‐
ter '*' to denote all 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 behav‐
ior and force the path to be deregistered.
-ping {[<hostname>|<ip>][:<port>]] | [<uri>]} [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 Bro‐
ker, 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.
-status {[<hostname>|<ip>[:<port>]] | [<uri>]}
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 spec‐
ified with a hostname or IP address. Default for the node is
localhost. Default for the port is the HP OpenView Communica‐
tions Broker on the specified node.
-migrate {[<namespace>] [<appname>] [<filename>]} [-v|-verbose]
Migrates the specified BBC configuration parameters. If no com‐
mand parameters are specified the BBC 2 LLB and the BBC 4 CB
parameters will be migrated to the namespace bbc.cb in the con‐
figuration 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 <appname> specifies the application name to use in
determining the BBC 5 target namespace. Parameters are migrated
to the bbc.http.ext.<appname>, bbc.fx.ext.<appname>, and
bbc.snf.ext.<appname> namespaces. The file name parameter speci‐
fies the file to read the parameters from. Default file name is
the BBC 2 standard default.txt file and the standard BBC 4 Com‐
munications Broker settings.ini file. The BBC 4 settings.ini
parameters override the BBC 2 default.txt parameters.
-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.
-size
The -size option displays the size of a store-and-forward buf‐
fer. If -verbose is specified as well, the size of each individ‐
ual request is displayed. If a target is specified, only the
size of the requests to this target are displayed.
-list
The -list option displays all requests in a store-and-forward
buffer for the specified target or the entire buffer if no tar‐
get is specified.
-p|-path <path>
The -path option defines the path to the store-and-forward buf‐
fer. This parameter is used to set the BUFFER_PATH parameter.
-t|-target <target>
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.
-verbose
Shows more detailed output.
-getcbport [<hostname>|<ip>]
Displays the HP OpenView Communications Broker port number of
the node specified by <hostname> or <ip>. If the hostname or IP
address is not specified, localhost is assumed.
-gettarget [<hostname>|<ip>]
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 <hostname> or
<ip>.
AUTHORbbcutil was developed by Hewlett-Packard Company.
EXIT STATUS
The following exit values are returned:
0
bbcutil exited normally with no error.
1
Command syntax error encountered. See command syntax for more
details on possible values.
2
Command partially succeeded.
3
Command failed. See command output for more detailed informa‐
tion.
4
bbcutil could not complete the requested command due to an
authorization error.
100
An exception was encountered causing the Communications Broker
to exit.
Corresponding error messages are written to stderror.
EXAMPLES
The following examples show you how to use the bbcutil command:
· To show the status of HP OpenView Communication Broker on the local
node:
bbcutil-status
· To query the communication server located at https://merlin.guil‐
ford.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
SEE ALSO
ovbbccb, bbc.ini
COPYRIGHT
(c) Copyright 2001-2007 Hewlett-Packard Development Company, L.P.
HP shall not be liable for technical or editorial errors or omissions
contained herein.
bbcutil()