Nakivo Backup & Replication – Command Line Interface – Part 2

[addthis_horizontal_recommended_content]

Part 2:

As you may read my previous post which was first part of Nakivo Backup & Replication command line interface introducing posts, you can access to the command line by different ways and run your commands.

Now, we want to know, which commands are available to use?

The current commands categorized as the below five categories:

Job Management: You can use the commands to list, run, stop, enable, disable or get detailed information about your jobs as reports. Here is some examples of using the commands:

Nakivo CLI Example 1

Job Management

List jobs

job-list
  • Job ID
  • Job name
  • Current job status
  • Job last run result

Start a job

job-start [job_id] 

Stop a job

job-stop [job_id] 

Disable a job

job-disable [job_id] 

Enable a job

job-enable [job_id] 

Generate a report for a job

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: job-report [job_id] –save-to [dir_path]
 

Return information about a job

job-info [job_id]
  • Job ID
  • Job name
  • Current job status
  • Job last run result

Repositories:

If you want to find information about your repositories quickly, attach new repositories, detach them or keep them on maintenance mode you can use the commands:

Nakivo CLI Example 2

Repositories

List all repositories

repository-list
  • 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

repository-update 

Update a repository

repository-update [repo_id] 

Detach a repository

repository-detach [repo_id] 

Attach a repository

repository-attach [repo_id] 

Start repository maintenance

repository-maintenance [repo_id] [params]

  • Params:
    • –selfheal
    • –verify
    • –spacereclaim
 

Stop repository maintenance

repository-maintenance-stop [repo_id] 

Return information about a repository

repository-info [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: You know that Nakivo has one of best knowledge base and you can find solution of any error on that but if you have serious issues and you couldn’t find root cause of your problem, there is an useful command to generate support bundle to detect your issues by Nakivo support.

Nakivo CLI Example 3

Support

Generate a support bundle

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: bundle-create –save-to [dir_path]
  • To send the bundle to support over email: bundle-create –send-by-email
  • To send the bundle to other email: bundle-create –send-by-email [email_address]

Licensing: It’s so clear, you can find information about your license or replace your current license with new one.

Licensing

Get the current license information

license-info 

Replace the current license with a new license file

license-replace [file_path]

Multi Tenancy: This is actually useful for controlling tenants also you can create bundle files which including all tenants logs.

Multi Tenancy

List all tenants

tenant-list
  • Tenant ID
  • Tenant name
  • Allocated items type and count
  • Tenant status
  • Enabled or disabled

Disable a tenant

tenant-disable [tenant_id] 

Enable a tenant

tenant-enable [tenant_id] 

Return information about a tenant

tenant-info [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: bundle-create
  • Generate the support bundle with all tenants logs: bundle-create –include-tenants
 

You can read previous post on this link:

Nakivo Backup & Replication – Command Line Interface – Part 1

Also you can find more information on Nakivo help center.

Davoud Teimouri

Davoud Teimouri is as a professional blogger, vExpert 2015/2016/2017/2018/2019, VCA, MCITP. This blog is started with simple posts and now, it has large following readers.

Leave a Reply

Your email address will not be published. Required fields are marked *