Nakivo Backup & Replication – Command Line Interface – Part 1

by Davoud Teimouri · Published 30/11/2016 · Updated 04/04/2019

Nakivo Backup & Replication is now one of favorite backup and replication suites for vSphere environments and many small businesses using it for keeping their data secure, preventing down time during DR and recover any file or object from their services which hosting by virtual machines.

I wrote some posts about Nakivo Backup & Replication and I suggest that read the previous posts, if you are not familiar with that:

Nakivo Backup & Replication 6 – Review

Nakivo BR has many features and the features will be useful when you have an automation tools for doing management tasks easier and faster. hopefully, Nakivo BR has it essentially.

How can you access to CLI?

There is three ways that you can access to CLI and run your commands:

Using Command Line Interface Locally

To use the product’s command line interface (CLI) on the machine where NAKIVO Backup & Replication Director is installed, follow the steps below:

Run the CLI executable:
- If NAKIVO Backup & Replication is installed on a Windows OS, run the cli.bat file located in the bin folder inside the product installation folder (“C:\Program Files\NAKIVO Backup & Replication” by default).
- If NAKIVO Backup & Replication is installed on a Linux OS, run the cli.sh file located in the director/bin folder inside the product installation folder (“/opt/nakivo/” by default).
  - If you have access to SSH, you can run CLI via SSH session.
  - Also if you have deployed your director as virtual appliance, CLI s accessible via director menu:

Run your commands.

Using Command Line Interface Remotely

To use the product’s command line interface (CLI) from a remote machine, follow the steps below:

Copy the CLI executable and jar files to the machine from where you plan to use the CLI:
- If NAKIVO Backup & Replication is installed on a Windows OS, copy the cli.bat and cli.jar files located in the bin folder inside the product installation folder (“C:\Program Files\NAKIVO Backup & Replication” by default).
- If NAKIVO Backup & Replication is installed on a Linux OS, copy the cli.sh and cli.jar files located in the director/bin folder inside the product installation folder (“/opt/nakivo/” by default).
On the machine from where you plan to use the CLI, configure the PATH system variable as described at http://java.com/en/download/help/path.xml

Run commands using the following format: <command> <host> <port> <username> <password>

Example: To get a list of jobs of the product which is installed on the machine with the 192.168.10.10 IP address, uses the 4443 port number for the Director Web HTTPS port, and has “admin” as login and password for the product’s web UI, run the following command: –job-list –host 192.168.10.10 –port 4443 –username admin –password admin

Using Command Line Interface in Multi-Tenant Mode

Triggering an action inside tenant in the multi tenant mode via command line interface requires providing a tenant ID as an argument:

cli.bat –repository-detach [repo_id] –username [login] –password [password] –tenant [tenant-id]