Next Topic

Previous Topic

Book Contents

Session Management

When launched in interactive mode, bveCLI supports the following commands.

connect <n.n.n.n> [ <port> ]

Establishes a TCP connection to specified BVE API server. If the port number is not specified, 7661 is used by default. This step can be skipped by specifying the --host and --port command-line parameters. If a matching entry is found in the configuration file, automatic login will be attempted. Once a connection has been established, the prompt reflects the host name/address and port.

login <username> [ <password> ]

Logs into the BVE API server using the specified credentials. If the password is omitted, bveCLI attempts to lookup a matching entry from the configuration file. Until a valid credential has been supplied, the prompt displays the user as unauth.

exit

Logs out of the API server and close TCP connection.

Sample Session

% bveCLI.pl
traverse> connect 192.168.10.21
connected to '192.168.10.21:7661'
traverse(noauth)> login admin secret1
logged into api server as 'admin'
traverse[192.168.10.21:7661]# quit

% 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]# quit