Scroll to navigation

LAVA(1) General Commands Manual LAVA(1)
" "LAVA Tool"

NAME

lava - LAVA Command Line Support

SUMMARY

lava is a command-line tool to interact with LAVA. DEPRECATED

USAGE

lava [-h] <subcommand> [args]

OPTIONAL ARGUMENTS

-h, --help
show this help message and exit



SUBCOMMANDS

Type lava <subcommand> -h for help on a specific subcommand.

AVAILABLE SUBCOMMANDS

status
Retrieves the status of a job.
Usage:
lava status [-h] [--non-interactive] [JOB_ID]
Positional arguments:
JOB_ID Prints status information about the provided job id.
Optional arguments:
-h, --help
Show this help message and exit
--non-interactive, -n
Do not ask for input parameters.




run
Runs a job on the local dispatcher.
Usage: lava run [-h] [--non-interactive] [JOB]
Positional arguments:
JOB The job file to run, or a directory containing a job
file. If nothing is passed, it uses the current working directory.

Optional arguments:
-h, --help
Show this help message and exit
--non-interactive, -n
Do not ask for input parameters.




script
LAVA script file handling.
usage: lava script [-h] {run, submit} ...
Optional arguments:
-h, --help
show this help message and exit

Sub-command to invoke: {run, submit}
run
Runs the specified shell script on a local device.
submit
Submits the specified shell script to a LAVA server.




init
Set-ups the base directory structure.
Usage: lava init [-h] [--non-interactive] [DIR]
Positional arguments:
DIR The name of the directory to initialize. Defaults to
current working directory.

Optional arguments:
-h, --help
Show this help message and exit
--non-interactive, -n
Do not ask for input parameters.




submit
Submits a job to LAVA.
Usage:
lava submit [-h] [--non-interactive] [JOB_ID]
Positional arguments:
JOB The job file to send, or a directory containing a job
file. If nothing is passed, it uses the current working directory.

Optional arguments:
-h, --help
Show this help message and exit
--non-interactive, -n
Do not ask for input parameters.




update
Updates a job file with the correct data.
Usage:
lava update [-h] [--non-interactive] [JOB_ID]
Positional arguments:
JOB Automatically updates a job file definition. If
nothing is passed, it usesthe current working directory.

Optional arguments:
-h, --help
Show this help message and exit
--non-interactive, -n
Do not ask for input parameters.




job
LAVA job file handling.
Usage: lava job [-h] {status, new, run, details, submit} ...
Optional arguments:
-h, --help
show this help message and exit

Sub-command to invoke: {status, new, run, details, submit}
status
Retrieves the status of a job.
new
Creates a new job file.
run
Runs the specified job file on the local dispatcher.
details
Retrieves the details of a job.
submit
Submits the specified job file.




dashboard
Commands for interacting with LAVA Dashboard
Usage: lava dashboard [-h] {pull, deserialize, data-views, get, bundles, query-data-view, version, streams, server-version, put, make-stream}
Optional arguments:
-h, --help
show this help message and exit

Sub-command to invoke: {pull, deserialize, data-views, get, bundles, query-data-view, version, streams, server-version, put, make-stream}
pull
Copy bundles and bundle streams from one dashboard to another. This command checks for two environment varialbes: The value of DASHBOARD_URL is used as a replacement for --dashbard-url. The value of REMOTE_DASHBOARD_URL as a replacement for FROM. Their presence automatically makes the corresponding argument optional.
deserialize
Deserialize a bundle on the server
data-views
Show data views defined on the server
get
Download a bundle from the server
bundles
Show bundles in the specified stream
query-data-view
Invoke a specified data view
version
Show dashboard client version
streams
Show streams you have access to
server-version
Display LAVA server version
put
Upload a bundle on the server
make-stream
Create a bundle stream on the server





scheduler
Interact with LAVA Scheduler
Usage: lava scheduler [-h] {job-output, devices-list, cancel-job, resubmit-job, job-details, job-status, get-pipeline-device-config, submit-job, jobs-list}
Optional arguments:
-h, --help
show this help message and exit

Sub-command to invoke: {job-output, devices-list, cancel-job, resubmit-job, job-details, job-status, get-pipeline-device-config, submit-job, jobs-list}
job-output
Get job output from the scheduler.
devices-list
Get list of devices from the scheduler.
cancel-job
Cancel job, if exists.
resubmit-job
Resubmit job, if exists.
job-details
Get job details, if it existed, from the scheduler.
job-status
Get job status and bundle sha1, if it existed, from the scheduler.
get-pipeline-device-config
Get the pipeline device configuration from scheduler to a local file or stdout.
submit-job
Submit a job to lava-scheduler
jobs-list
Get list of running and submitted jobs from the scheduler.




device
LAVA devices handling.
Usage: lava device [-h] {list, add, config, remove} ...
Optional arguments:
-h, --help
show this help message and exit

Sub-command to invoke: {list,add,config,remove}
list
Lists configured devices.
add
Adds a new device.
config
Opens the specified device config file.
remove
Removes the specified device.




testdef
LAVA test definitions handling.
Usage: lava testdef [-h] {new, run, submit} ...
Optional arguments:
-h, --help
show this help message and exit

Sub-command to invoke: {new, run ,submit}
new
Creates a new test definition file.
run
Runs the specified test definition on a local device.
submit
Submits the specified test definition to a LAVA server.




details
Retrieves the details of a job.
Usage:
lava details [-h] [--non-interactive] [JOB_ID]
Positional arguments:
JOB_ID Prints information about job with the provided job id.
Optional arguments:
-h, --help
Show this help message and exit
--non-interactive, -n
Do not ask for input parameters.




devices
Lists all the configured devices in this LAVA instance.
Usage: lava devices [-h] [--config-dir CONFIG_DIR] [--config CONFIG]
Optional arguments:
-h, --help
Show this help message and exit
--config-dir CONFIG_DIR
Configuration directory override (currently None)
--config CONFIG
Custom config file




connect
Connects to the device is connection command is specified in device conf.
Uage: lava connect [-h] [--config-dir CONFIG_DIR] [--config CONFIG] device
Positional arguments:
device
Optional arguments:
-h, --help
show this help message and exit
--config-dir CONFIG_DIR
Configuration directory override (currently None)
--config CONFIG
Custom config file




dispatch
Run test scenarios on virtual and physical hardware
Usage: lava dispatch [-h] [--config-dir CONFIG_DIR] [--config CONFIG]
[--oob-fd OOB_FD] [--output-dir OUTPUT_DIR] [--validate] [--job-id JOB_ID] [--socket-addr SOCKET_ADDR] [--master-cert MASTER_CERT] [--slave-cert SLAVE_CERT] [--target TARGET] [--env-dut-path ENV_DUT_PATH] JOB
Positional arguments:
JOB Test scenario file
Optional arguments:
-h, --help
show this help message and exit
--config-dir CONFIG_DIR
Configuration directory override (currently None)
--config CONFIG
Custom config file
--oob-fd OOB_FD
Used internally by LAVA scheduler.
--output-dir OUTPUT_DIR
Directory to put structured output in.
--validate
Just validate the job file, do not execute any steps.
--job-id JOB_ID
Set the scheduler job identifier. This alters process name for easier debugging.
--socket-addr SOCKET_ADDR
Address of the ZMQ socket used to send the logs to the master.
--master-cert MASTER_CERT
Master certificate file
--slave-cert SLAVE_CERT
Slave certificate file
--target TARGET
Run the job on a specific target device
--env-dut-path ENV_DUT_PATH
File with environment variables to be exported to the device




power-cycle
Runs the hard_reset_command if specified in device configuration.
Usage: lava power-cycle [-h] [--config-dir CONFIG_DIR] [--config CONFIG]
device
Positional arguments:
device
Optional arguments:
-h, --help
show this help message and exit
--config-dir CONFIG_DIR
Configuration directory override (currently None)
--config CONFIG
Custom config file





AUTHOR

Linaro Validation Team

COPYRIGHT

2010-2017, Linaro Limited
August 23, 2017 0.21