How to use the Unitrends CLI

SUMMARY

This article describes the Unitrends Command Line Interface

ISSUE

Release 9.0 and later of Unitrends Backup software includes a built in Command Line Interface.   The CLI executable is located on the appliance at /usr/bp/bin/unitrends-cli
 
Help for the CLI may be obtained by the “-h” option.  As of the initial release of 9.0, the available CLI options are:
 
# ./unitrends-cli -h
Usage: unitrends-cli [-h] operation resource
-h, --help  display this help and exit
 
GET
active-directory  advisor  alerts  applications  assets  audits  backup-copy  backups  capabilities  catalog  clients  credentials  date-time  encryption  forum  hostname  inventory  joborders  jobs  license  mail-config  networks  preferences  replication  retention  storage  summary  systems  traps  updates  users
 
PUT
active-directory  advisor  clients  credentials  date-time  encryption  forum  hostname  inventory  joborders  jobs  license  mail-config  networks  preferences  replication  retention  storage  systems  traps  users
 
POST
backups  clients  commands  credentials  encryption  feedback  forum  joborders  login  logout  networks  replication  retention  storage  systems  traps  updates  users
 
DELETE
active-directory  alerts  backups  clients  credentials  date-time  forum  joborders  jobs  mail-config  networks  replication  retention  storage  systems  traps  users
 
Executing CLI Commands Remotely
To execute unitrends-cli commands from remote systems, use a remote shell execution technique such as this example:
ssh HOSTNAME 'unitrends-cli get alerts'

 
 
 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Contact us