Ask the Community
Groups
How to use the Unitrends CLI - Connect IT Community | Kaseya
<main> <article class="userContent"> <h2 data-id="summary"><strong>SUMMARY</strong></h2> <p>This article describes the Unitrends Command Line Interface</p> <h2 data-id="issue"><strong>ISSUE</strong></h2> <p>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<br> <br>Help for the CLI may be obtained by the “-h” option. As of the initial release of 9.0, the available CLI options are:<br> <br># ./unitrends-cli -h<br>Usage: unitrends-cli [-h] operation resource<br>-h, --help display this help and exit<br> <br>GET<br>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<br> <br>PUT<br>active-directory advisor clients credentials date-time encryption forum hostname inventory joborders jobs license mail-config networks preferences replication retention storage systems traps users<br> <br>POST<br>backups clients commands credentials encryption feedback forum joborders login logout networks replication retention storage systems traps updates users<br> <br>DELETE<br>active-directory alerts backups clients credentials date-time forum joborders jobs mail-config networks replication retention storage systems traps users<br> <br><b>Executing CLI Commands Remotely</b><br>To execute unitrends-cli commands from remote systems, use a remote shell execution technique such as this example:<br>ssh HOSTNAME 'unitrends-cli get alerts'<br><br> <br> <br> </p> </article> </main>