.. _usage: Usage ##### Here is the list of available commands and sub-commands. Aliases ======= LAVA aliases can be managed by: .. code-block:: shell lavacli aliases add lavacli aliases delete lavacli aliases list lavacli aliases show Device types ============ LAVA device types can be managed by: .. code-block:: shell lavacli device-types add [...] lavacli device-types aliases add lavacli device-types aliases delete lavacli device-types aliases list lavacli device-types health-check get lavacli device-types health-check set lavacli device-types list lavacli device-types show lavacli device-types template get lavacli device-types template set lavacli device-types update [...] Devices ======= LAVA devices can be managed by: .. code-block:: shell lavacli devices add [...] lavacli devices dict get lavacli devices dict set lavacli devices list lavacli devices maintenance lavacli devices show lavacli devices tags add lavacli devices tags delete lavacli devices tags list lavacli devices update [...] Events ====== LAVA events can be used by: .. code-block:: shell lavacli events listen lavacli events wait device [...] lavacli events wait job [...] lavacli events wait worker [...] Identities ========== lavacli identities can be managed by: .. code-block:: shell lavacli identities add [...] lavacli identities delete lavacli identities list lavacli identities show Jobs ==== LAVA jobs can be managed by: .. code-block:: shell lavacli jobs cancel lavacli jobs config lavacli jobs definition lavacli jobs list lavacli jobs logs lavacli jobs queue lavacli jobs resubmit lavacli jobs run lavacli jobs show lavacli jobs submit lavacli jobs validate lavacli jobs wait Lab === LAVA lab can be managed by: .. code-block:: shell lavacli lab apply lavacli lab import Results ======= LAVA results can be managed by: .. code-block:: shell lavacli results lavacli results lavacli results System ====== LAVA instance can be managed by: .. code-block:: shell lavacli system active lavacli system api lavacli system export lavacli system maintenance lavacli system methods list lavacli system methods help lavacli system methods signature lavacli system version lavacli system whoami In order to put a full instance into maintenance, an admin could call **system maintenance**. This function will: * set all workers health to *MAINTENANCE* * wait for all jobs to finish If the instance should be put into into maintenance immediately, addind **--force** will: * set all workers health to *MAINTENANCE* * cancel all running jobs * wait for all jobs to finish It also possible to exclude some workers with **--exclude**. When the maintenance is finished, calling **system active** will move every worker into *MAINTENANCE* to *ACTIVE*. Tags ==== LAVA tag can be managed by: .. code-block:: shell lavacli tags add [...] lavacli tags delete lavacli tags list lavacli tags show Utils ===== Some utilities are available with: .. code-block:: shell lavacli utils logs print lavacli utils templates render Printing logs ************* When working with raw logs, lavacli might help by coloring the logs by levels. It's also possible to filter the logs by level. To only print the serial output and the commands sent by LAVA to the board, use: .. code-block:: shell lavacli utils logs print --filter target,input Available log levels are: exception, error, warning, info, debug, target, input, feedback, results. Workers ======= LAVA workers can be managed by: .. code-block:: shell lavacli workers add [...] lavacli workers config get lavacli workers config set lavacli workers env get lavacli workers env set lavacli workers list lavacli workers maintenance lavacli workers update [...] lavacli workers show