CLI User Guide

Owned by Vijayganesh Sivaprakasam
Nov 20, 2024
2 min read

Introduction

Dbvisit Command Line interface provides a command line access to Dbvisit functionality for all supported database platforms, as well as general system settings and overall maintenance.

The executable is called dbvcli / dbvcli.exe and is located in <standby_home>/bin directory. The usage is

dbvcli [-d CONFIGURATION_NAME] [-t DATABASE_TYPE] COMMAND [SUBCOMMAND] [--options]

Please refer to CLI Reference or use dbvcli --help or dbvcli COMMAND [SUBCOMMAND] --help for the full description of dbvcli commands.

Control Center Login

Dbvcit CLI utilizes Dbvisit Control Center (dbvcontrol service) to execute operations remotely. When executed for the first time, dbvcli asks for a login information to be able to process the request. This info can be saved for the future use. See the example below:

[postgres@project-16921 bin]$ ./dbvcli sync Control Center Login 1/4 Enter the host name at which the Control Center can be reached. Control Center Host: > project-16922 Control Center Login 2/4 Enter the port number at which the Control Center can be reached. Control Center Port: > 4433 Control Center Login 3/4 Enter the user name to use to log into the Control Center. Control Center User: > admin Control Center Login 4/4 Enter the password to use to log into the Control Center. Control Center Password: > ***** Connecting to the Control Center at project-16922:4433 ✓ Save Login Information Select whether to save the Control Center login information to a file so that you don't have to enter it again. The settings will be stored, with the password encrypted, in the file '/home/postgres/.config/dbvisit/login.ini'. Save Login Information: ( ) Yes (•) No up arrow: focus prev • down arrow: focus next • enter: confirm

Running mode

Dbvisit CLI can be run either in interactive mode when user is promted for any aditional values, or in non-inteactive mode if all the values and options are provided with the call. Non-interactive mode is triggered by --no-prompt option.

Oracle Legacy CLI

For backward compatibility with Dbvisit versions prior to version 12, a legacy CLI exacutable dbvctl is still supported. dbvctl can only be used for Oracle configurations and is fully replacable by the new dbvcli CLI. Please conatct Dbvisit support for more info on how to replace dbvctl with dbvcli or for any other questions related to dbvctl usage in version 12 or later.