Next Topic

Previous Topic

Book Contents

General Syntax

bveCLI is installed in the TRAVERSE_HOME/utils directory. The tool can be launched using the following parameters:

bveCLI.pl [ <server> ] [ <credentials> ] [ <query> ]

where <server> is specified as

--host n.n.n.n --port nnn

and credentials are provided as

--username USERNAME1 --password PASSWORD1

In absence of any server information, bveCLI starts a basic command shell and accepts a limited set of commands.

Sample Session

% bveCLI.pl --host 192.168.10.21 --user admin --password secret1
connected to '192.168.10.21:7661'
logged into api server as 'admin'
traverse[192.168.10.21:7661]#

Additional query parameters provide advanced functionality and are described in detail in relevant sections below.

Parameter

Short

Description

--config

-c

Load this configuration file instead of looking for .bveapirc under user's home directory

--exec

-x

Execute the specified query in batch mode; requires --host parameter

--input

-i

Execute the queries from specified file in batch mode; requires --host parameter

--output

-o

Save the result from query into specified file; if already exists, it will be overwritten

--format

-t

Result from query should be printed in specified format

--fields

-f

Include only the specified fields in the output; valid only with --exec or --input parameters

--debug

-d

Provide diagnostic details; use multiple times to increase logging detail