cbeutil(1m)cbeutil(1m)NAMEcbeutil - CDB back-end database utility tool
SYNOPSIScbeutil [ option... ] cmd...
DESCRIPTIONcbeutil provides direct access to an individual back-end database that is
part of the Cluster Administration Services (CAS) configuration database
(CDB). It does so by means of commands that correspond roughly to
functions in the CDB back-end API. cbeutil can read these commands from
command-line arguments, script files and interactively from the user.
cbeutil commands consist of a command name followed by zero or more
arguments and terminated by a semicolon or newline. Individual arguments
are normally separated by whitespace; to include whitespace in a single
argument (e.g. a string value) enclose the argument in double quotes. A
single argument or command can be continued across multiple lines in a
script file by ending intermediate lines with a backslash character. If
the first non-whitespace character in a line is a "#" then the rest of
the line will be treated as a comment and discarded.
Individual commands are documented online within cbeutil. For a list of
the commands, type "help" while in interactive mode, or "cbeutil help"
from the command line.
OPTIONScbeutil takes several options:
-c string Process the single argument string as a cbeutil command line.
Multiple commands can be included on this command line by
separating them with semicolons. Unless string is a single
word, it will normally need to be enclosed in quotes so that
it is treated as a single command-line argument by the shell.
This option can be specified any number of times.
-f path Read cbeutil commands from the file path. This option can be
specified any number of times.
-i Switch to interactive mode after any commands specified on
the command line and/or with the "-f" options have been
processed. Commands will be accepted from stdin until the
"exit" command is issued or EOF is received.
-p Print a prompt before accepting each command in interactive
mode. This is the default behavior; the option is provided
primarily to undo a "-np" option earlier on the command line
or in the CBEUTIL_OPTS environment variable (see below).
-q Turns on "quiet" mode: successful completion messages will
not be printed, though error messages will continue to be
printed as usual. Note that the only purpose of some
Page 1
cbeutil(1m)cbeutil(1m)
commands is to print information (e.g. the value of a node),
and this will not be affected by quiet mode.
-x Enables "expert" mode. If this option is specified, then the
"expert on" command can be used to turn on expert mode. This
will permit some additional operations that are usually not
useful to ordinary users.
-- This will cause the rest of the command line to be treated as
a single command string, with exactly one space between each
of the remaining arguments. Strictly speaking, the "--" is
optional unless it is needed to resolve some ambiguity.
Options can also be specified in the environment variable CBEUTIL_OPTS.
Options specified in this way will be processed before the options on the
command line itself.
The "-i", "-p", "-q" and "-x" options can all be negated later on in the
command line by preceding the letter with "n". For example, "-nq" will
turn off quiet mode. This may be useful to counteract an option
specified in CBEUTIL_OPTS.
The "-c", "-f" and "--" options will be processed in the order they are
encountered. If one of these input sources specifies multiple commands
and one of those commands should fail for some reason, the remainder of
the commands from that source will be discarded and processing will
continue with the next input source. After all of those sources have
been exhausted, cbeutil will enter interactive mode if the "-i" option
was specified.
NOTES
The default location for the CBE database is /var/cluster/cdb/cdb.db#.
To specify a different location, set the environment variable CBE_DB to
the pathname of the database file containing the root node.
Page 2
