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

Help

General help

cli.bat –help
  • Command name
  • Description

Job Management

List jobs

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

Start a job

cli.bat --job-start [job_id] 

Stop a job

cli.bat --job-stop [job_id] 

Disable a job

cli.bat --job-disable [job_id] 

Enable a job

cli.bat --job-enable [job_id] 

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]
 

Return information about a job

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

Repositories

List all repositories

cli.bat --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

cli.bat --repository-update 

Update a repository

cli.bat --repository-update [repo_id] 

Detach a repository

cli.bat --repository-detach [repo_id] 

Attach a repository

cli.bat --repository-attach [repo_id] 

Start repository maintenance

 cli.bat --repository-maintenance [repo_id] [params]

  • Params:
    • --selfheal
    • --verify
    • --spacereclaim
 

Stop repository maintenance

cli.bat --repository-maintenance-stop [repo_id] 

Return information about a repository

cli.bat --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

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]
 

Licensing

Get the current license information

cli.bat --license-info 

Replace the current license with a new license file

cli.bat --license-replace [file_path] 

Multi Tenancy

List all tenants

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

Disable a tenant

cli.bat --tenant-disable [tenant_id] 

Enable a tenant

cli.bat --tenant-enable [tenant_id] 

Return information about a tenant

cli.bat --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: cli.bat --bundle-create
  • Generate the support bundle with all tenants logs: cli.bat --bundle-create --include-tenants
 
  • No labels