.\" Man page generated from reStructuredText.
.
.TH "LAVA-SERVER" "1" "November 19, 2018" "2018.11
" "LAVA"
.SH NAME
lava-server \- lava-server 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\-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\fP,\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.
"myproject.settings.main". 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.
"/home/djangoprojects/myproject".
.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 <subcommand>\fP for help on a specific subcommand.
.SH AVAILABLE SUBCOMMANDS
.sp
Type \fBlava\-server manage <subcommand> \-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 "default".
.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_scheduler_app
.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 \-\-non\-pipeline
Create a v1 device (v2 by default)
.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
.sp
\-\-tags TAG1 TAG2      List of tags for the device
.UNINDENT
.UNINDENT
.UNINDENT
.sp
copy                Copy an existing device as a new device
.INDENT 7.0
.INDENT 3.5
optional arguments:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.BI \-\-original \ ORIGINAL
Hostname of the existing device
.TP
.BI \-\-target \ TARGET
Hostname of the device to create
.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
.UNINDENT
.sp
details             Details about a device
.INDENT 7.0
.INDENT 3.5
positional arguments:
.INDENT 0.0
.INDENT 3.5
hostname    Hostname of the device
.UNINDENT
.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 \-\-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
.INDENT 7.0
.TP
.B set                 Set properties of the given device
.INDENT 7.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
.TP
.BI \-\-dictionary \ DICTIONARY
Device dictionary
.TP
.B \-\-public
make the device public
.TP
.B \-\-private
Make the device private
.TP
.B \-\-status
{OFFLINE, IDLE, RUNNING, OFFLINING,
RETIRED, RESERVED}
Set the device status
.TP
.B \-\-health
{UNKNOWN, PASS, FAIL, LOOPING}
Set the device health status
.TP
.BI \-\-worker \ WORKER
Set the worker
.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:
.INDENT 7.0
.TP
.B {add, list}            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 health check:
Only supported when creating a single device\-type
.INDENT 7.0
.TP
.BI \-\-health\-check \ HEALTH_CHECK
The health check (filename) for the
given device type.
.UNINDENT
.INDENT 7.0
.TP
.B \-\-health \- frequency  HEALTH_FREQUENCY
How often to run health checks.
.UNINDENT
.INDENT 7.0
.TP
.B \-\-health\-denominator
{hours, jobs}
Initiate health checks by hours or by jobs.
.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
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B device\-transitions
Export device state transitions in either yaml or csv format.
Output can be filtered by old_state and new_state field values.
.INDENT 7.0
.INDENT 3.5
positional arguments:
.INDENT 0.0
.INDENT 3.5
{export}            Sub commands
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B export            Export existing device state transitions
.INDENT 7.0
.INDENT 3.5
Fields exported: created_on, created_by, device,
job, old_state, new_state, message
Available states are: RETIRED, IDLE, RUNNING,
OFFLINING, RESERVED, OFFLINE
Not all combinations of states will exist.
Not all fields are populated for all transitions.
Example: To see transitions where an admin put
the device back online, use: lava\-server manage
device\-transition export \-\-old\-state OFFLINE
\-\-new\-state IDLE
Note: exporting all transitions will produce a
lot of output, it is recommended to always
specify \-\-old\-state and \-\-new\-state.
.UNINDENT
.UNINDENT
.sp
optional arguments:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \-h\fP,\fB  \-\-help
show this help message and exit
.UNINDENT
\(em csv       Print as csv
\-\-old\-state Filter output by old device status
\-\-new\-state Filter output by new device status
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
pipeline\-worker
.INDENT 0.0
.TP
.B LAVA Pipeline worker helper
.INDENT 7.0
.TP
.B optional arguments:
.INDENT 7.0
.TP
.BI \-\-hostname \ HOSTNAME
Hostname of the new worker
.TP
.BI \-\-description \ DESCRIPTION
optional description of the new worker
.TP
.B \-\-disable
prevent pipeline jobs running on this worker.
.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
JSON 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, or anyone on your team, would like to register with Linaro directly,
this will allow you to file an upstream bug, submit code for review by
the LAVA team, etc. Register at the following url:
.sp
\fI\%https://register.linaro.org/\fP
.sp
If you are considering large changes, it is best to register and also
to subscribe to the Linaro Validation mailing list at:
.sp
\fI\%http://lists.linaro.org/mailman/listinfo/linaro\-validation\fP
.sp
Also talk to us on IRC:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
irc.freenode.net
#linaro\-lava
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
Linaro Validation Team
.SH COPYRIGHT
2010-2018, Linaro Limited
.\" Generated by docutils manpage writer.
.