Scroll to navigation

LAVA-SERVER(1) General Commands Manual LAVA-SERVER(1)
" "LAVA"

NAME

lava-server - lava-server command line support

SUMMARY

lava-server is a command-line management interface to a LAVA instance, and the Django database management tools for that instance.

USAGE

lava-server manage subcommand [options] [args]

COMMON OPTIONS

Most of these options are imported from django and more information can be found in the django documentation.

These options are supported for all subcommands.

Verbosity level; 0=minimal output, 1=normal output, 2=verbose output, 3=very verbose output
The Python path to a settings module, e.g. "myproject.settings.main". If this isn't provided, the DJANGO_SETTINGS_MODULE environment variable will be used.
A directory to add to the Python path, e.g. "/home/djangoprojects/myproject".
Print traceback on exception
show program's version number and exit
show this help message and exit



SUBCOMMANDS

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

AVAILABLE SUBCOMMANDS

Type lava-server manage <subcommand> -h for help on an option available to a specific subcommand.

Change a user's password for django.contrib.auth.
lava-server manage changepassword [options]
Specifies the database to use. Default is "default".


Used to create a superuser.
lava-server manage createsuperuser [options]
Specifies the username for the superuser.
Specifies the email address for the superuser.
Tells Django to NOT prompt the user for input of any kind. You must use --username and --email with --noinput and superusers created with --noinput will not be able to log in until they are given a valid password.
Specifies the database to use. Default is default.




django

django functions change with releases of the django package. See the documentation for python-django.


lava_server

Manage devices
{add, details, list, set}
add Add a device
hostname Hostname of the device
show this help message and exit
Device type
Device description
Device dictionary
Create the device offline (online by default)
Make the device private (public by default)
The name of the worker

List of tags to add to the device

Username of the user with physical access to the device
Name of the group with physical access to the device
Username of the user with ownership of the device
Name of the group with ownership of the device




copy Copy an existing device as a new device

original Hostname of the existing device target Hostname of the device to create
show this help message and exit
Create the device offline (online by default)
Make the device private (public by default)
The name of the worker
Set all the tags of the original device on the target device




details Details about a device

hostname Hostname of the device



list List the installed devices

show this help message and exit

Show only devices with the given state

Show all devices, including retired ones

Show only devices with the given health

Print as csv
Show all devices, including retired ones
{OFFLINE, IDLE, RUNNING, OFFLINING, RETIRED, RESERVED} Show only devices with this status
Print as csv




update Update device details

hostname Hostname of the device
show this help message and exit
Set the description

Update the device health

Update the worker
make the device public
Make the device private
Username of the user with physical access to the device
Name of the group with physical access to the device
Username of the user with ownership of the device
Name of the group with ownership of the device





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.
{add, details, list, update}
add Add V2 device type(s) to the database.
V2 device types.

show this help message and exit

Only supported when creating a single device-type
Name of an alias for this device-type.

Only supported when creating a single device-type
How often to run health checks.
{hours, jobs} Initiate health checks by hours or by jobs.




details Details about a device-type

name Name of the device-type
show this help message and exit
Print the corresponding devices




show this help message and exit
Show all device types in the database, including types not currently installed.
Print as csv


device-type The device type name.
show this help message and exit

Name of an alias for this device-type.






Manage jobs
{compress,fail,rm,validate}
compress Compress job logs
show this help message and exit
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.
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.
Filter jobs by submitter
Do not compress any logs, simulate the output
Be nice with the system by sleeping regularly




fail Fail the given canceled job

job_id job id
show this help message and exit




rm Remove the jobs

show this help message and exit
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.

Filter by job state

Filter jobs by submitter
Do not remove any data, simulate the output
Be nice with the system by sleeping regularly




validate Validate job definition

show this help message and exit
Send a mail to the admins with a list of failing jobs
Filter jobs by submitter
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.
If set to True, the validator will reject any extra keys that are present in the job definition but not defined in the schema







Manage workers
{add, details, list, update}
add Create a worker
hostname Hostname of the worker
show this help message and exit
Worker description

Worker health




details Details of a worker

hostname Hostname of the worker
show this help message and exit
Print the list of attached devices




list List the workers

show this help message and exit
Show all workers (including retired ones)
Print as csv




update Update worker properties

hostname Hostname of the worker
show this help message and exit
Worker description

Set worker health







Runs the test suite for the specified applications, or the entire site if no apps are specified.
lava-server manage test [options] [appname ...]
Tells Django to NOT prompt the user for input of any kind.
Tells Django to stop running the test suite after first failed test.
Tells Django to use specified test runner class instead of the one specified by the TEST_RUNNER setting.
Overrides the default address where the live server (used with LiveServerTestCase) is expected to run from. The default value is localhost:8081.





BUGS

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).

If your device type is not one found on existing LAVA instances, please supply as much information as you can on the board itself.

CONTRIBUTING UPSTREAM

If you want to contribute, refer to https://docs.lavasoftware.org/lava/contribution.html

If you are considering large changes, it is best to subscribe to the Linaro Validation mailing list at:

http://lists.lavasoftware.org/mailman/listinfo/lava-users

Also talk to us on IRC:

irc.libera.chat
#lavasoftware


AUTHOR

Linaro Validation Team

COPYRIGHT

2010-2023, Linaro Limited

January 23, 2023 2023.01