.\" Man page generated from reStructuredText. . . .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 .. .TH "LAVA-SERVER" "1" "January 23, 2023" "2023.01 " "LAVA" .SH NAME lava-server \- lava-server command line support .SH SUMMARY .sp \fBlava\-server\fP is a command\-line management interface to a LAVA instance, and the Django database management tools for that instance. .SH USAGE .sp lava\-server manage subcommand [options] [args] .SH COMMON OPTIONS .sp Most of these options are imported from \fBdjango\fP and more information can be found in the django documentation. .sp These options are supported for all subcommands. .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .TP .BI \-v \ VERBOSITY\fR,\fB \ \-\-verbosity\fB= VERBOSITY Verbosity level; 0=minimal output, 1=normal output, 2=verbose output, 3=very verbose output .TP .BI \-\-settings\fB= SETTINGS The Python path to a settings module, e.g. \(dqmyproject.settings.main\(dq. If this isn\(aqt provided, the DJANGO_SETTINGS_MODULE environment variable will be used. .TP .BI \-\-pythonpath\fB= PYTHONPATH A directory to add to the Python path, e.g. \(dq/home/djangoprojects/myproject\(dq. .TP .B \-\-traceback Print traceback on exception .TP .B \-\-version show program\(aqs version number and exit .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .UNINDENT .UNINDENT .SH SUBCOMMANDS .sp Type \fBlava\-server manage help \fP for help on a specific subcommand. .SH AVAILABLE SUBCOMMANDS .sp Type \fBlava\-server manage \-h\fP for help on an option available to a specific subcommand. .INDENT 0.0 .TP .B auth .INDENT 7.0 .TP .B changepassword Change a user\(aqs password for django.contrib.auth. .INDENT 7.0 .TP .B Usage: lava\-server manage changepassword [options] .TP .B Options: .INDENT 7.0 .TP .BI \-\-database\fB= DATABASE Specifies the database to use. Default is \(dqdefault\(dq. .UNINDENT .UNINDENT .TP .B createsuperuser Used to create a superuser. .INDENT 7.0 .TP .B Usage: lava\-server manage createsuperuser [options] .TP .B Options: .INDENT 7.0 .TP .BI \-\-username\fB= USERNAME Specifies the username for the superuser. .TP .BI \-\-email\fB= EMAIL Specifies the email address for the superuser. .TP .B \-\-noinput Tells Django to NOT prompt the user for input of any kind. You must use \fB\-\-username\fP and \fB\-\-email\fP with \fB\-\-noinput\fP and superusers created with \fB\-\-noinput\fP will not be able to log in until they are given a valid password. .TP .BI \-\-database\fB= DATABASE Specifies the database to use. Default is \fBdefault\fP\&. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp django .INDENT 0.0 .INDENT 3.5 django functions change with releases of the django package. See the documentation for python\-django. .UNINDENT .UNINDENT .sp lava_server .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .TP .B devices Manage devices .INDENT 7.0 .TP .B positional arguments: {add, details, list, set} .TP .B Sub commands add Add a device .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: hostname Hostname of the device .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-device\-type \ DEVICE_TYPE Device type .TP .BI \-\-description \ DESCRIPTION Device description .TP .BI \-\-dictionary \ DICTIONARY Device dictionary .TP .B \-\-offline Create the device offline (online by default) .TP .B \-\-private Make the device private (public by default) .TP .BI \-\-worker \ WORKER The name of the worker .UNINDENT .INDENT 7.0 .TP .B \-\-tags [TAGS [TAGS ...]] List of tags to add to the device .UNINDENT .INDENT 7.0 .TP .BI \-\-physical\-user \ PHYSICAL_USER Username of the user with physical access to the device .TP .BI \-\-physical\-group \ PHYSICAL_GROUP Name of the group with physical access to the device .TP .BI \-\-owner \ OWNER Username of the user with ownership of the device .TP .BI \-\-group \ GROUP Name of the group with ownership of the device .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp copy Copy an existing device as a new device .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: original Hostname of the existing device target Hostname of the device to create .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-offline Create the device offline (online by default) .TP .B \-\-private Make the device private (public by default) .TP .BI \-\-worker \ WORKER The name of the worker .TP .B \-\-copy\-with\-tags Set all the tags of the original device on the target device .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp details Details about a device .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: hostname Hostname of the device .UNINDENT .UNINDENT .UNINDENT .sp list List the installed devices .INDENT 7.0 .INDENT 3.5 .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 \-\-state {IDLE,RESERVED,RUNNING} Show only devices with the given state .UNINDENT .INDENT 7.0 .TP .B \-\-all\fP,\fB \-a Show all devices, including retired ones .UNINDENT .INDENT 7.0 .TP .B \-\-health {GOOD,UNKNOWN,LOOPING,BAD,MAINTENANCE,RETIRED} Show only devices with the given health .UNINDENT .INDENT 7.0 .TP .B \-\-csv Print as csv .TP .B \-\-all\fP,\fB \-a Show all devices, including retired ones .TP .B \-\-status {OFFLINE, IDLE, RUNNING, OFFLINING, RETIRED, RESERVED} Show only devices with this status .TP .B \-\-csv Print as csv .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp update Update device details .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: hostname Hostname of the device .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-description \ DESCRIPTION Set the description .UNINDENT .INDENT 7.0 .TP .B \-\-health {GOOD,UNKNOWN,LOOPING,BAD,MAINTENANCE,RETIRED} Update the device health .UNINDENT .INDENT 7.0 .TP .BI \-\-worker \ WORKER Update the worker .TP .B \-\-public make the device public .TP .B \-\-private Make the device private .TP .BI \-\-physical\-user \ PHYSICAL_USER Username of the user with physical access to the device .TP .BI \-\-physical\-group \ PHYSICAL_GROUP Name of the group with physical access to the device .TP .BI \-\-owner \ OWNER Username of the user with ownership of the device .TP .BI \-\-group \ GROUP Name of the group with ownership of the device .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B device\-types Manage device types according to which templates are available and which device\-types are defined in the database. When counting the number of devices, Retired devices are included. .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: {add, details, list, update} .TP .B Sub commands add Add V2 device type(s) to the database. .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: .INDENT 7.0 .TP .B device\-type The device type name. Passing \(aq*\(aq will add all known V2 device types. .UNINDENT .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B alias: Only supported when creating a single device\-type .INDENT 7.0 .TP .BI \-\-alias \ ALIAS Name of an alias for this device\-type. .UNINDENT .TP .B health check: Only supported when creating a single device\-type .INDENT 7.0 .TP .BI \-\-health\-frequency \ HEALTH_FREQUENCY How often to run health checks. .TP .B \-\-health\-denominator {hours, jobs} Initiate health checks by hours or by jobs. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp details Details about a device\-type .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: name Name of the device\-type .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-devices Print the corresponding devices .UNINDENT .UNINDENT .UNINDENT .UNINDENT .INDENT 7.0 .TP .B list List the installed device types .INDENT 7.0 .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-all\fP,\fB \-a Show all device types in the database, including types not currently installed. .TP .B \-\-csv Print as csv .UNINDENT .UNINDENT .TP .B update Update an existing V2 device type in the database .INDENT 7.0 .TP .B positional arguments: device\-type The device type name. .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B alias: .INDENT 7.0 .TP .BI \-\-alias \ ALIAS Name of an alias for this device\-type. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B jobs Manage jobs .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: {compress,fail,rm,validate} .TP .B Sub commands compress Compress job logs .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-newer\-than \ NEWER_THAN Compress jobs newer than this. The time is of the form: 1h (one hour) or 2d (two days). By default, all jobs will be compressed. .TP .BI \-\-older\-than \ OLDER_THAN Compress jobs older than this. The time is of the form: 1h (one hour) or 2d (two days). By default, all jobs logs will be compressed. .TP .BI \-\-submitter \ SUBMITTER Filter jobs by submitter .TP .B \-\-dry\-run Do not compress any logs, simulate the output .TP .B \-\-slow Be nice with the system by sleeping regularly .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp fail Fail the given canceled job .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: job_id job id .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp rm Remove the jobs .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-older\-than \ OLDER_THAN Remove jobs older than this. The time is of the form: 1h (one hour) or 2d (two days). By default, all jobs will be removed. .UNINDENT .INDENT 7.0 .TP .B \-\-state {SUBMITTED,SCHEDULING,SCHEDULED,RUNNING,CANCELING,FINISHED} Filter by job state .UNINDENT .INDENT 7.0 .TP .BI \-\-submitter \ SUBMITTER Filter jobs by submitter .TP .B \-\-dry\-run Do not remove any data, simulate the output .TP .B \-\-slow Be nice with the system by sleeping regularly .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp validate Validate job definition .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-mail\-admins Send a mail to the admins with a list of failing jobs .TP .BI \-\-submitter \ SUBMITTER Filter jobs by submitter .TP .BI \-\-newer\-than \ NEWER_THAN Validate jobs newer than this. The time is of the form: 1h (one hour) or 2d (two days). By default, only jobs in the last 24 hours will be validated. .TP .B \-\-strict If set to True, the validator will reject any extra keys that are present in the job definition but not defined in the schema .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B workers Manage workers .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B position arguments: {add, details, list, update} .TP .B Sub commands add Create a worker .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: hostname Hostname of the worker .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-description \ DESCRIPTION Worker description .UNINDENT .INDENT 7.0 .TP .B \-\-health {ACTIVE,MAINTENANCE,RETIRED} Worker health .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp details Details of a worker .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: hostname Hostname of the worker .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-devices Print the list of attached devices .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp list List the workers .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-a\fP,\fB \-\-all Show all workers (including retired ones) .TP .B \-\-csv Print as csv .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp update Update worker properties .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B positional arguments: hostname Hostname of the worker .TP .B optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-description \ DESCRIPTION Worker description .UNINDENT .INDENT 7.0 .TP .B \-\-health {ACTIVE,MAINTENANCE,RETIRED} Set worker health .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B test Runs the test suite for the specified applications, or the entire site if no apps are specified. .INDENT 7.0 .TP .B Usage: lava\-server manage test [options] [appname ...] .TP .B Options: .INDENT 7.0 .TP .B \-\-noinput Tells Django to NOT prompt the user for input of any kind. .TP .B \-\-failfast Tells Django to stop running the test suite after first failed test. .TP .BI \-\-testrunner \ TESTRUNNER Tells Django to use specified test runner class instead of the one specified by the TEST_RUNNER setting. .TP .BI \-\-liveserver \ LIVESERVER Overrides the default address where the live server (used with LiveServerTestCase) is expected to run from. The default value is localhost:8081. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .SH BUGS .sp If your bug relates to a specific type of device, please include all configuration details for that device type as well as the job submission and as much of the LAVA test job log file as you can (e.g. as a compressed file attached to the bug report). .sp If your device type is not one found on existing LAVA instances, please supply as much information as you can on the board itself. .SH CONTRIBUTING UPSTREAM .sp If you want to contribute, refer to \fI\%https://docs.lavasoftware.org/lava/contribution.html\fP .sp If you are considering large changes, it is best to subscribe to the Linaro Validation mailing list at: .sp \fI\%http://lists.lavasoftware.org/mailman/listinfo/lava\-users\fP .sp Also talk to us on IRC: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C irc.libera.chat #lavasoftware .ft P .fi .UNINDENT .UNINDENT .SH AUTHOR Linaro Validation Team .SH COPYRIGHT 2010-2023, Linaro Limited .\" Generated by docutils manpage writer. .