You can run CLI commands either in interactive or non-interactive mode. Refer to the Operation Modes of Command Line Interface subsection of the Using Command Line Interface topic.
Use either long or short form of the commands*.
Command | Long form | Short form | Output |
Help | |||
---|---|---|---|
General help | cli.bat --help | cli.bat -h |
|
Job Management | |||
List all jobs | cli.bat --job-list | cli.bat -jl |
|
Start a job | cli.bat --job-start [job_id] | cli.bat -jr [job_id] | |
Stop a job | cli.bat --job-stop [job_id] | cli.bat -js [job_id] | |
Disable a job | cli.bat --job-disable [job_id] | cli.bat -jd [job_id] | |
Disable multiple jobs | cli.bat --job-disable [job_id1] [job_id2] [job_id3] ... [job_idX] | cli.bat -jd [job_id1] [job_id2] [job_id3] ... [job_idX] | |
Enable a job | cli.bat --job-enable [job_id] | cli.bat -je [job_id] | |
Enable multiple jobs | cli.bat --job-enable [job_id1] [job_id2] [job_id3] ... [job_idX] | cli.bat -je [job_id1] [job_id2] [job_id3] ... [job_idX] | |
Generate a report for a job | cli.bat --job-report [job_id]
| cli.bat -jp [job_id]
| |
Return information about a job | cli.bat --job-info [job_id] | cli.bat -ji [job_id] |
|
Inventory | |||
List all inventory items | cli.bat --inventory-list | cli.bat -il |
|
Update all inventory items | cli.bat --inventory-update | cli.bat -iu | |
Update an inventory item | cli.bat --inventory-update [item_id] | cli.bat -iu [item_id] | |
Return information about an inventory item | cli.bat --inventory-info [item_id] | cli.bat -ii [item_id] |
|
Transporters | |||
List all transporters | cli.bat --transporter-list | cli.bat -trl |
|
Update all transporters | cli.bat --transporter-update | cli.bat -tru | |
Update a transporter | cli.bat --transporter-update [transporter_id] | cli.bat -tru [transporter_id] | |
Return information about a transporter | cli.bat --transporter-info [transporter_id] | cli.bat -tri [transporter_id] |
|
Repositories | |||
List all repositories | cli.bat --repository-list | cli.bat -rl |
|
Update all repositories | cli.bat --repository-update | cli.bat -ru | |
Update a repository | cli.bat --repository-update [repo_id] | cli.bat -ru [repo_id] | |
Detach a repository | cli.bat --repository-detach [repo_id] | cli.bat -rd [repo_id] | |
Attach a repository | cli.bat --repository-attach [repo_id] | cli.bat -ra [repo_id] | |
Start repository maintenance | cli.bat --repository-maintenance [repo_id] [parameter] Parameters:
| cli.bat -rm [repo_id] [parameter] Parameters:
| |
Stop repository maintenance | cli.bat --repository-maintenance-stop [repo_id] | cli.bat -rms [repo_id] | |
Return information about a repository | cli.bat --repository-info [repo_id] | cli.bat -ri [repo_id] |
|
Support | |||
Generate a support bundle | cli.bat --bundle-create
| cli.bat -bc
| |
Licensing | |||
Get the current license information | cli.bat --license-info | cli.bat -li | |
Replace the current license with a new license file | cli.bat --license-replace [file_path] | cli.bat -lin [file_path] | |
Multi Tenancy | |||
List all tenants | cli.bat --tenant-list | cli.bat -tl |
|
Disable a tenant | cli.bat --tenant-disable [tenant_id] | cli.bat -td [tenant_id] | |
Enable a tenant | cli.bat --tenant-enable [tenant_id] | cli.bat -te [tenant_id] | |
Return information about a tenant | cli.bat --tenant-info [tenant_id] | cli.bat -ti [tenant_id] |
|
Create a support bundle for master admin level |
|
| |
Miscellaneous | |||
Get the CLI version | cli.bat --version The command returns the CLI version which is equal to the full version of NAKIVO Backup & Replication. | - | |
Run a command in the debug mode | cli.bat --repository-info [repo_id] --debug This is an option that can be added to any other CLI command. With the debug mode turned on, the commands will return the full error text. | cli.bat -ri [repo_id] --debug |
*Examples are given for Windows OS.