User Guide
Page tree
Skip to end of metadata
Go to start of metadata

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 --helpcli.bat -h
  • Command name
  • Description

Job Management

List all jobs

cli.bat --job-listcli.bat -jl
  • Job ID
  • Job name
  • Current job status
  • Job last run result

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]

  • The command with no arguments creates the job report and saves it to the current directory.
  • To save the report to other directory: cli.bat --job-report [job_id] --save-to [dir_path]
  • To send the report to default email(s): cli.bat. --job-report [job_id] --send-by-email
  • To send the report to other email: cli.bat. --job-report [job_id] --send-by-email [email_address]

cli.bat -jp [job_id]

  • The command with no arguments creates the job report and saves it to the current directory.
  • To save the report to other directory: cli.bat -jp [job_id] -f [dir_path]
  • To send the report to default email(s): cli.bat. -jp [job_id] -eml
  • To send the report to other email: cli.bat. -jp [job_id] -eml [email_address]

Return information about a job

cli.bat --job-info [job_id]cli.bat -ji [job_id]
  • Job ID
  • Job name
  • Current job status
  • Job last run result

Inventory

List all inventory items

cli.bat --inventory-listcli.bat -il
  • Item ID
  • Item IP/host name
  • Item type (host/vCenter)
  • Item children count (X hosts, E VMs)
  • Item current state
  • Item current status

Update all inventory items

cli.bat --inventory-updatecli.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]
  • Item ID
  • Item IP/host name
  • Item type (host/vCenter)
  • Item children count (X hosts, E VMs)
  • Item current state
  • Item current status

Transporters




List all transporters

cli.bat --transporter-listcli.bat -trl
  • Transporter ID
  • Transporter IP/host name
  • Transporter current load
  • Transporter maximum load
  • Transporter current state
  • Transporter current status

Update all transporters

cli.bat --transporter-updatecli.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]
  • Transporter ID
  • Transporter IP/host name
  • Transporter current load
  • Transporter maximum load
  • Transporter current state
  • Transporter current status

Repositories

List all repositories

cli.bat --repository-listcli.bat -rl 
  • Repository ID
  • Repository name
  • Assigned transporter
  • Backup count
  • Free space
  • Attached or detached
  • Consistent or inconsistent
  • Repository current state
  • Repository current status

Update all repositories

cli.bat --repository-updatecli.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:

    • --selfheal

    • --verify

    • --spacereclaim

cli.bat -rm [repo_id] [parameter]

Parameters:

    • --selfheal

    • --verify

    • --spacereclaim


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]
  • Repository ID
  • Repository name
  • Assigned transporter
  • Backup count and free space
  • Attached or detached
  • Consistent or inconsistent
  • Repository current state
  • Repository current status

Support

Generate a support bundle

cli.bat --bundle-create

  • The command with no parameters will create a support bundle and save it in the current directory.
  • To save the bundle to other directory: cli.bat --bundle-create --save-to [dir_path]
  • To send the bundle to support over email: cli.bat --bundle-create --send-to-support
  • To send the bundle to other email: cli.bat --bundle-create --send-by-email [email_address]

cli.bat -bc

  • The command with no parameters will create a support bundle and save it in the current directory.
  • To save the bundle to other directory: cli.bat -bc -f [dir_path]
  • To send the bundle to support over email: cli.bat -bc -sup
  • To send the bundle to other email: cli.bat -bc -eml [email_address]

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  
  • Tenant ID
  • Tenant name
  • Allocated items type and count
  • Tenant status
  • Enabled or disabled

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]
  • Tenant ID
  • Tenant Account ID
  • Tenant name
  • Allocated items type and count
  • Tenant status
  • Enabled or disabled

Create a support bundle for master admin level

  • Generate the support bundle for master level only: cli.bat --bundle-create
  • Generate the support bundle with all tenants logs: cli.bat --bundle-create --include-tenants

  • Generate the support bundle for master level only: cli.bat -bc

  • Generate the support bundle with all tenants logs: cli.bat -bc -ite
     


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.


  • No labels