Previous Next
Command-Line API Reference
This section describes the command-line client API and contains the following topics:
Command Syntax
The command-line client, vmwb-lbcli, has syntax consistent with tools like git or p4 from the command line, that is, you give the executable name, a command, command specific option, and then command specific arguments, if applicable.
There are many options that are common to various commands such as --project, which specifies the name of the project you are operating on, as well as --resource which is the resource within the project. Many of these commands can inherit the values for the command from the environment, if certain environment variables are defined. For example, if you do not specify the --resource option for a command that requires it, the value of the VMLB_RESOURCE environment variable, if defined, will be used. See the help for particular commands to see which variables are applicable if you desire to use this facility.
Getting the List of Available Commands
$ vmwb-lbcli help
vmwb_lbcli <command> [options]
 
define Define an additional user provided logx file type to the log browser server.
save Save the specified filter.
count Print the number of log entries currently filtered in.
select Select a log to be loaded in the log browser server.
adjust Adjust log entry timestamps by the specified time value.
delete Delete bundle and cached files for the project host. Optionally specify particular resource.
download Download and analyze a log file from the given host.
print Print the specified log entries to the console.
find Find the index of log entries that match the specified pattern.
filter Appy the filter with the specified name. The filter must have already been added.
getfilter Get filters/a single filter if name specified.
help Display top level help information.
version Display program version number.
Getting Help on a Particular Command
For detailed help on a particular command, type the following:
vmwb-lbcli help <command>