.\" Man page generated from reStructuredText. . .TH "LAVA" "1" "August 23, 2017" "0.21 " "LAVA Tool" .SH NAME lava \- LAVA Command Line Support . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SUMMARY .sp \fBlava\fP is a command\-line tool to interact with LAVA. \fBDEPRECATED\fP .SH USAGE .sp lava [\-h] [args] .SH OPTIONAL ARGUMENTS .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .UNINDENT .UNINDENT .SH SUBCOMMANDS .sp Type \fBlava \-h\fP for help on a specific subcommand. .SH AVAILABLE SUBCOMMANDS .INDENT 0.0 .TP .B status Retrieves the status of a job. .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava status [\-h] [\-\-non\-interactive] [JOB_ID] .TP .B Positional arguments: JOB_ID Prints status information about the provided job id. .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help Show this help message and exit .TP .B \-\-non\-interactive\fP,\fB \-n Do not ask for input parameters. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B run Runs a job on the local dispatcher. .INDENT 7.0 .INDENT 3.5 Usage: lava run [\-h] [\-\-non\-interactive] [JOB] .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .B JOB The job file to run, or a directory containing a job file. If nothing is passed, it uses the current working directory. .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help Show this help message and exit .TP .B \-\-non\-interactive\fP,\fB \-n Do not ask for input parameters. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B script LAVA script file handling. .INDENT 7.0 .INDENT 3.5 usage: lava script [\-h] {run, submit} ... .INDENT 0.0 .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Sub\-command to invoke: {run, submit} .INDENT 7.0 .TP .B run Runs the specified shell script on a local device. .TP .B submit Submits the specified shell script to a LAVA server. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B init Set\-ups the base directory structure. .INDENT 7.0 .INDENT 3.5 Usage: lava init [\-h] [\-\-non\-interactive] [DIR] .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .B DIR The name of the directory to initialize. Defaults to current working directory. .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help Show this help message and exit .TP .B \-\-non\-interactive\fP,\fB \-n Do not ask for input parameters. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B submit Submits a job to LAVA. .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava submit [\-h] [\-\-non\-interactive] [JOB_ID] .TP .B Positional arguments: .INDENT 7.0 .TP .B JOB The job file to send, or a directory containing a job file. If nothing is passed, it uses the current working directory. .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help Show this help message and exit .TP .B \-\-non\-interactive\fP,\fB \-n Do not ask for input parameters. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B update Updates a job file with the correct data. .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava update [\-h] [\-\-non\-interactive] [JOB_ID] .TP .B Positional arguments: .INDENT 7.0 .TP .B JOB Automatically updates a job file definition. If nothing is passed, it usesthe current working directory. .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help Show this help message and exit .TP .B \-\-non\-interactive\fP,\fB \-n Do not ask for input parameters. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B job LAVA job file handling. .INDENT 7.0 .INDENT 3.5 Usage: lava job [\-h] {status, new, run, details, submit} ... .INDENT 0.0 .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Sub\-command to invoke: {status, new, run, details, submit} .INDENT 7.0 .TP .B status Retrieves the status of a job. .TP .B new Creates a new job file. .TP .B run Runs the specified job file on the local dispatcher. .TP .B details Retrieves the details of a job. .TP .B submit Submits the specified job file. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B dashboard Commands for interacting with LAVA Dashboard .INDENT 7.0 .INDENT 3.5 Usage: lava dashboard [\-h] {pull, deserialize, data\-views, get, bundles, query\-data\-view, version, streams, server\-version, put, make\-stream} .INDENT 0.0 .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .INDENT 7.0 .TP .B Sub\-command to invoke: {pull, deserialize, data\-views, get, bundles, query\-data\-view, version, streams, server\-version, put, make\-stream} .INDENT 7.0 .TP .B 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. .TP .B deserialize Deserialize a bundle on the server .TP .B data\-views Show data views defined on the server .TP .B get Download a bundle from the server .TP .B bundles Show bundles in the specified stream .TP .B query\-data\-view Invoke a specified data view .TP .B version Show dashboard client version .TP .B streams Show streams you have access to .TP .B server\-version Display LAVA server version .TP .B put Upload a bundle on the server .TP .B make\-stream Create a bundle stream on the server .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B scheduler Interact with LAVA Scheduler .INDENT 7.0 .INDENT 3.5 Usage: lava scheduler [\-h] {job\-output, devices\-list, cancel\-job, resubmit\-job, job\-details, job\-status, get\-pipeline\-device\-config, submit\-job, jobs\-list} .INDENT 0.0 .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Sub\-command to invoke: {job\-output, devices\-list, cancel\-job, resubmit\-job, job\-details, job\-status, get\-pipeline\-device\-config, submit\-job, jobs\-list} .INDENT 7.0 .TP .B job\-output Get job output from the scheduler. .TP .B devices\-list Get list of devices from the scheduler. .TP .B cancel\-job Cancel job, if exists. .TP .B resubmit\-job Resubmit job, if exists. .TP .B job\-details Get job details, if it existed, from the scheduler. .TP .B job\-status Get job status and bundle sha1, if it existed, from the scheduler. .TP .B get\-pipeline\-device\-config Get the pipeline device configuration from scheduler to a local file or stdout. .TP .B submit\-job Submit a job to lava\-scheduler .TP .B jobs\-list Get list of running and submitted jobs from the scheduler. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B device LAVA devices handling. .INDENT 7.0 .INDENT 3.5 Usage: lava device [\-h] {list, add, config, remove} ... .INDENT 0.0 .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Sub\-command to invoke: {list,add,config,remove} .INDENT 7.0 .TP .B list Lists configured devices. .TP .B add Adds a new device. .TP .B config Opens the specified device config file. .TP .B remove Removes the specified device. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B testdef LAVA test definitions handling. .INDENT 7.0 .INDENT 3.5 Usage: lava testdef [\-h] {new, run, submit} ... .INDENT 0.0 .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Sub\-command to invoke: {new, run ,submit} .INDENT 7.0 .TP .B new Creates a new test definition file. .TP .B run Runs the specified test definition on a local device. .TP .B submit Submits the specified test definition to a LAVA server. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B details Retrieves the details of a job. .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava details [\-h] [\-\-non\-interactive] [JOB_ID] .TP .B Positional arguments: JOB_ID Prints information about job with the provided job id. .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help Show this help message and exit .TP .B \-\-non\-interactive\fP,\fB \-n Do not ask for input parameters. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B devices Lists all the configured devices in this LAVA instance. .INDENT 7.0 .INDENT 3.5 Usage: lava devices [\-h] [\-\-config\-dir CONFIG_DIR] [\-\-config CONFIG] .INDENT 0.0 .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help Show this help message and exit .TP .BI \-\-config\-dir \ CONFIG_DIR Configuration directory override (currently None) .TP .BI \-\-config \ CONFIG Custom config file .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B connect Connects to the device is connection command is specified in device conf. .INDENT 7.0 .INDENT 3.5 Uage: lava connect [\-h] [\-\-config\-dir CONFIG_DIR] [\-\-config CONFIG] device .INDENT 0.0 .TP .B Positional arguments: device .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-config\-dir \ CONFIG_DIR Configuration directory override (currently None) .TP .BI \-\-config \ CONFIG Custom config file .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B dispatch Run test scenarios on virtual and physical hardware .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B 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 .TP .B Positional arguments: JOB Test scenario file .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-config\-dir \ CONFIG_DIR Configuration directory override (currently None) .TP .BI \-\-config \ CONFIG Custom config file .TP .BI \-\-oob\-fd \ OOB_FD Used internally by LAVA scheduler. .TP .BI \-\-output\-dir \ OUTPUT_DIR Directory to put structured output in. .TP .B \-\-validate Just validate the job file, do not execute any steps. .TP .BI \-\-job\-id \ JOB_ID Set the scheduler job identifier. This alters process name for easier debugging. .TP .BI \-\-socket\-addr \ SOCKET_ADDR Address of the ZMQ socket used to send the logs to the master. .TP .BI \-\-master\-cert \ MASTER_CERT Master certificate file .TP .BI \-\-slave\-cert \ SLAVE_CERT Slave certificate file .TP .BI \-\-target \ TARGET Run the job on a specific target device .TP .BI \-\-env\-dut\-path \ ENV_DUT_PATH File with environment variables to be exported to the device .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B power\-cycle Runs the hard_reset_command if specified in device configuration. .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava power\-cycle [\-h] [\-\-config\-dir CONFIG_DIR] [\-\-config CONFIG] device .TP .B Positional arguments: device .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-config\-dir \ CONFIG_DIR Configuration directory override (currently None) .TP .BI \-\-config \ CONFIG Custom config file .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .SH AUTHOR Linaro Validation Team .SH COPYRIGHT 2010-2017, Linaro Limited .\" Generated by docutils manpage writer. .