labgrid-client.1

.\" 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 "LABGRID-CLIENT" "1" "2025" "" "labgrid"
.SH NAME
labgrid-client \- labgrid's client interface to control boards
.sp
Labgrid is a scalable infrastructure and test architecture for embedded (linux) systems.
.sp
This is the client to control a boards status and interface with it on remote machines.
.SH LABGRID-CLIENT
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client [\-x ADDRESS] [\-c CONFIG] [\-p PLACE] [\-s STATE]
                      [\-i INITIAL_STATE] [\-d] [\-v] [\-P PROXY]
                      COMMAND ...
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-x <address>, \-\-coordinator <address>
coordinator HOST[:PORT] (default: value from env variable LG_COORDINATOR, otherwise 127.0.0.1:20408)
.UNINDENT
.INDENT 0.0
.TP
.B \-c <config>, \-\-config <config>
env config file (default: value from env variable LG_ENV)
.UNINDENT
.INDENT 0.0
.TP
.B \-p <place>, \-\-place <place>
place name/alias (default: value from env variable LG_PLACE)
.UNINDENT
.INDENT 0.0
.TP
.B \-s <state>, \-\-state <state>
strategy state to switch into before command (default: value from env varibale LG_STATE)
.UNINDENT
.INDENT 0.0
.TP
.B \-i <initial_state>, \-\-initial\-state <initial_state>
strategy state to force into before switching to desired state
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-debug
enable debug mode (show python tracebacks)
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose
.UNINDENT
.INDENT 0.0
.TP
.B \-P <proxy>, \-\-proxy <proxy>
proxy connections via given ssh host
.UNINDENT
.SS labgrid\-client acquire|lock
.sp
acquire a place
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client acquire|lock [\-\-allow\-unmatched]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-allow\-unmatched
allow missing resources for matches when locking the place
.UNINDENT
.SS labgrid\-client add\-alias
.sp
add an alias to a place
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client add\-alias alias
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B alias
.UNINDENT
.SS labgrid\-client add\-match
.sp
add one (or multiple) match pattern(s) to a place
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client add\-match PATTERN [PATTERN ...]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B pattern
.UNINDENT
.SS labgrid\-client add\-named\-match
.sp
add one match pattern with a name to a place
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client add\-named\-match PATTERN NAME
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B pattern
.UNINDENT
.INDENT 0.0
.TP
.B name
.UNINDENT
.SS labgrid\-client allow
.sp
allow another user to access a place
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client allow user
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B user
<host>/<username>
.UNINDENT
.SS labgrid\-client audio
.sp
start a audio stream
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client audio [\-\-name NAME]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client bootstrap
.sp
start a bootloader
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client bootstrap [\-w WAIT] [\-\-name NAME] filename ...
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B filename
filename to boot on the target
.UNINDENT
.INDENT 0.0
.TP
.B arg
extra bootstrap arguments
.UNINDENT
.INDENT 0.0
.TP
.B \-w <wait>, \-\-wait <wait>
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client cancel\-reservation
.sp
cancel a reservation
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client cancel\-reservation [token]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B token
.UNINDENT
.SS labgrid\-client console|con
.sp
connect to the console
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client console|con [\-l] [\-o] [\-\-logfile FILE] [name]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B name
optional resource name
.UNINDENT
.INDENT 0.0
.TP
.B \-l, \-\-loop
keep trying to connect if the console is unavailable
.UNINDENT
.INDENT 0.0
.TP
.B \-o, \-\-listenonly
do not modify local terminal, do not send input from stdin
.UNINDENT
.INDENT 0.0
.TP
.B \-\-logfile <file>
Log output to FILE
.UNINDENT
.SS labgrid\-client create
.sp
add a new place with the name specified via \-\-place or the LG_PLACE environment variable
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client create
.EE
.UNINDENT
.UNINDENT
.SS labgrid\-client del\-alias
.sp
delete an alias from a place
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client del\-alias alias
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B alias
.UNINDENT
.SS labgrid\-client del\-match
.sp
delete one (or multiple) match pattern(s) from a place
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client del\-match PATTERN [PATTERN ...]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B pattern
.UNINDENT
.SS labgrid\-client delete
.sp
delete an existing place
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client delete
.EE
.UNINDENT
.UNINDENT
.SS labgrid\-client dfu
.sp
communicate with device in DFU mode
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client dfu [\-\-wait WAIT] [\-\-name NAME]
                          {download,detach,list} [altsetting] [filename]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B action
action
.UNINDENT
.INDENT 0.0
.TP
.B altsetting
altsetting name or number (download, detach only)
.UNINDENT
.INDENT 0.0
.TP
.B filename
file to write into device (download only)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-wait <wait>
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client env
.sp
generate a labgrid environment file for a place
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client env
.EE
.UNINDENT
.UNINDENT
.SS labgrid\-client export
.sp
export driver information to a file (needs environment with drivers)
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client export [\-\-format {shell,shell\-export,json}] filename
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B filename
output filename
.UNINDENT
.INDENT 0.0
.TP
.B \-\-format {shell,shell\-export,json}
output format (default: shell\-export)
.UNINDENT
.SS labgrid\-client fastboot
.sp
run fastboot
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client fastboot [\-\-wait WAIT] [\-\-name NAME] ...
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B arg
fastboot arguments
.UNINDENT
.INDENT 0.0
.TP
.B \-\-wait <wait>
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client flashscript
.sp
Run arbitrary script with arguments to flash device
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client flashscript [\-\-name NAME] script ...
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B script
Flashing script
.UNINDENT
.INDENT 0.0
.TP
.B arg
script arguments
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client forward
.sp
forward local port to remote target
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client forward [\-\-name NAME] [\-\-local [LOCAL:]REMOTE]
                              [\-\-remote REMOTE:LOCAL]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.INDENT 0.0
.TP
.B \-\-local, \-L
Forward local port LOCAL to remote port REMOTE. If LOCAL is unspecified, an arbitrary port will be chosen
.UNINDENT
.INDENT 0.0
.TP
.B \-\-remote, \-R
Forward remote port REMOTE to local port LOCAL
.UNINDENT
.SS labgrid\-client io
.sp
change (or get) a digital IO status
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client io {high,low,get} [name]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B action
action
.UNINDENT
.INDENT 0.0
.TP
.B name
optional resource name
.UNINDENT
.SS labgrid\-client monitor
.sp
monitor events from the coordinator
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client monitor
.EE
.UNINDENT
.UNINDENT
.SS labgrid\-client places|p
.sp
list available places
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client places|p [\-a] [\-r] [\-\-sort\-last\-changed]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-a, \-\-acquired
.UNINDENT
.INDENT 0.0
.TP
.B \-r, \-\-released
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sort\-last\-changed
sort by last changed date (oldest first)
.UNINDENT
.SS labgrid\-client power|pw
.sp
change (or get) a place\(aqs power status
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client power|pw [\-t DELAY] [\-\-name NAME] {on,off,cycle,get}
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B action
.UNINDENT
.INDENT 0.0
.TP
.B \-t <delay>, \-\-delay <delay>
wait time in seconds between off and on during cycle
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client release\-from
.sp
atomically release a place, but only if locked by a specific user
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client release\-from HOST/USER
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B host/user
User and host to match against when releasing
.UNINDENT
.sp
Note that this command returns success as long as the specified user no longer owns the place, meaning it may be acquired by another user or not at all.
.SS labgrid\-client release|unlock
.sp
release a place
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client release|unlock [\-k]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-k, \-\-kick
release a place even if it is acquired by a different user
.UNINDENT
.SS labgrid\-client reservations
.sp
list current reservations
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client reservations
.EE
.UNINDENT
.UNINDENT
.SS labgrid\-client reserve
.sp
create a reservation
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client reserve [\-\-wait] [\-\-shell] [\-\-prio PRIO]
                              KEY=VALUE [KEY=VALUE ...]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B key=value
required tags
.UNINDENT
.INDENT 0.0
.TP
.B \-\-wait
wait until the reservation is allocated
.UNINDENT
.INDENT 0.0
.TP
.B \-\-shell
format output as shell variables
.UNINDENT
.INDENT 0.0
.TP
.B \-\-prio <prio>
priority relative to other reservations (default 0)
.UNINDENT
.SS labgrid\-client resources|r
.sp
list available resources
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client resources|r [\-a] [\-e EXPORTER]
                                  [\-\-sort\-by\-matched\-place\-change]
                                  [match]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B match
.UNINDENT
.INDENT 0.0
.TP
.B \-a, \-\-acquired
.UNINDENT
.INDENT 0.0
.TP
.B \-e <exporter>, \-\-exporter <exporter>
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sort\-by\-matched\-place\-change
sort by matched place\(aqs changed date (oldest first) and show place and date
.UNINDENT
.SS labgrid\-client rsync
.sp
transfer files via rsync
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client rsync [\-\-name NAME] src dst
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B src
source path (use :dir/file for remote side)
.UNINDENT
.INDENT 0.0
.TP
.B dst
destination path (use :dir/file for remote side)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.sp
Additional arguments are passed to the rsync subprocess.
.SS labgrid\-client scp
.sp
transfer file via scp
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client scp [\-\-name NAME] [\-\-recursive] src [src ...] dst
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B src
source path (use :dir/file for remote side)
.UNINDENT
.INDENT 0.0
.TP
.B dst
destination path (use :dir/file for remote side)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.INDENT 0.0
.TP
.B \-\-recursive, \-r
copy recursive
.UNINDENT
.SS labgrid\-client sd\-mux
.sp
switch USB SD Muxer or get current mode
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client sd\-mux [\-\-name NAME] {dut,host,off,client,get}
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B action
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client set\-comment
.sp
update the place comment
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client set\-comment comment [comment ...]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B comment
.UNINDENT
.SS labgrid\-client set\-tags
.sp
update the place tags
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client set\-tags KEY=VALUE [KEY=VALUE ...]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B key=value
use an empty value for deletion
.UNINDENT
.SS labgrid\-client show
.sp
show a place and related resources
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client show
.EE
.UNINDENT
.UNINDENT
.SS labgrid\-client ssh
.sp
connect via ssh (with optional arguments)
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client ssh [\-\-name NAME]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.sp
Additional arguments are passed to the ssh subprocess.
.SS labgrid\-client sshfs
.sp
mount via sshfs (blocking)
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client sshfs [\-\-name NAME] path mountpoint
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B path
remote path on the target
.UNINDENT
.INDENT 0.0
.TP
.B mountpoint
local path
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client telnet
.sp
connect via telnet
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client telnet
.EE
.UNINDENT
.UNINDENT
.SS labgrid\-client tmc
.sp
control a USB TMC device
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client tmc [\-\-name NAME] SUBCOMMAND ...
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client tmc channel
.sp
use a channel
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client tmc channel channel {info,values}
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B channel
.UNINDENT
.INDENT 0.0
.TP
.B action
.UNINDENT
.SS labgrid\-client tmc cmd|c
.sp
execute raw command
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client tmc cmd|c command [command ...]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B command
.UNINDENT
.SS labgrid\-client tmc query|q
.sp
execute raw query
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client tmc query|q query [query ...]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B query
.UNINDENT
.SS labgrid\-client tmc screen
.sp
show or save a screenshot
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client tmc screen {show,save}
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B action
.UNINDENT
.SS labgrid\-client usb\-mux
.sp
switch USB Muxer
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client usb\-mux [\-\-name NAME]
                              {off,dut\-device,host\-dut,host\-device,host\-dut+host\-device}
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B links
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client version
.sp
show version
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client version
.EE
.UNINDENT
.UNINDENT
.SS labgrid\-client video
.sp
start a video stream
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client video [\-q QUALITY] [\-c CONTROLS] [\-\-name NAME]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-q <quality>, \-\-quality <quality>
select a video quality (use \(aqlist\(aq to show options)
.UNINDENT
.INDENT 0.0
.TP
.B \-c <controls>, \-\-controls <controls>
configure v4l controls (such as \(aqfocus_auto=0,focus_absolute=40\(aq)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client wait
.sp
wait for a reservation to be allocated
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client wait [token]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B token
.UNINDENT
.SS labgrid\-client who
.sp
list acquired places by user
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client who [\-e]
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-e, \-\-show\-exporters
show exporters currently used by each place
.UNINDENT
.SS labgrid\-client write\-files
.sp
copy files onto mass storage device
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client write\-files [OPTION]... \-T SOURCE DEST
       labgrid\-client write\-files [OPTION]... [\-t DIRECTORY] SOURCE...
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B source
source file(s) to copy
.UNINDENT
.INDENT 0.0
.TP
.B dest
destination file name for SOURCE
.UNINDENT
.INDENT 0.0
.TP
.B \-w <wait>, \-\-wait <wait>
storage poll timeout in seconds
.UNINDENT
.INDENT 0.0
.TP
.B \-p <0\-255>, \-\-partition <0\-255>
partition number to mount or 0 to mount whole disk (default: 1)
.UNINDENT
.INDENT 0.0
.TP
.B \-t <directory>, \-\-target\-directory <directory>
copy all SOURCE files into DIRECTORY (default: partition root)
.UNINDENT
.INDENT 0.0
.TP
.B \-T
copy SOURCE file and rename to DEST
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SS labgrid\-client write\-image
.sp
write an image onto mass storage
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: labgrid\-client write\-image [\-w WAIT] [\-p PARTITION] [\-\-skip SKIP]
                                  [\-\-seek SEEK] [\-\-mode {dd,bmaptool}]
                                  [\-\-name NAME]
                                  filename
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B filename
filename to boot on the target
.UNINDENT
.INDENT 0.0
.TP
.B \-w <wait>, \-\-wait <wait>
.UNINDENT
.INDENT 0.0
.TP
.B \-p <partition>, \-\-partition <partition>
partition number to write to
.UNINDENT
.INDENT 0.0
.TP
.B \-\-skip <skip>
skip n 512\-sized blocks at start of input
.UNINDENT
.INDENT 0.0
.TP
.B \-\-seek <seek>
skip n 512\-sized blocks at start of output
.UNINDENT
.INDENT 0.0
.TP
.B \-\-mode {dd,bmaptool}
Choose tool for writing images (default: dd)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name <name>, \-n <name>
optional resource name
.UNINDENT
.SH CONFIGURATION FILE
.sp
The configuration file follows the description in \fBlabgrid\-device\-config\fP(5).
.SH ENVIRONMENT VARIABLES
.sp
Various labgrid\-client commands use the following environment variable:
.SS LG_PLACE
.sp
This variable can be used to specify a place without using the \fB\-p\fP option, the \fB\-p\fP option overrides it.
.SS LG_TOKEN
.sp
This variable can be used to specify a reservation for the \fBwait\fP command and
for the \fB+\fP place expansion.
.SS LG_STATE
.sp
This variable can be used to specify a state which the device transitions into
before executing a command. Requires a configuration file and a Strategy
specified for the device.
.SS LG_INITIAL_STATE
.sp
This variable can be used to specify an initial state the device is known to
be in.
This is useful during development. The Strategy used must implement the
\fBforce()\fP method.
A desired state must be set using \fBLG_STATE\fP or \fB\-s\fP/\fB\-\-state\fP\&.
.SS LG_ENV
.sp
This variable can be used to specify the configuration file to use without
using the \fB\-\-config\fP option, the \fB\-\-config\fP option overrides it.
.SS LG_COORDINATOR
.sp
This variable can be used to set the default coordinator in the format
\fBHOST[:PORT]\fP (instead of using the \fB\-x\fP option).
.SS LG_PROXY
.sp
This variable can be used to specify a SSH proxy hostname which should be used
to connect to the coordinator and any resources which are normally accessed
directly.
.SS LG_HOSTNAME
.sp
Override the hostname used when accessing a resource. Typically only useful for
CI pipelines where the hostname may not be consistent between pipeline stages.
.SS LG_USERNAME
.sp
Override the username used when accessing a resource. Typically only useful for
CI pipelines where the username may not be consistent between pipeline stages.
.SS LG_SSH_CONNECT_TIMEOUT
.sp
Set the connection timeout when using SSH (The \fBConnectTimeout\fP option). If
unspecified, defaults to 30 seconds.
.SS LG_AGENT_PREFIX
.sp
Add a prefix to \fB\&.labgrid_agent_{agent_hash}.py\fP allowing specification for
where on the exporter it should be uploaded to.
.SH MATCHES
.sp
Match patterns are used to assign a resource to a specific place. The format is:
exporter/group/cls/name, exporter is the name of the exporting machine, group is
a name defined within the exporter, cls is the class of the exported resource
and name is its name. Wild cards in match patterns are explicitly allowed, *
matches anything.
.SH ADDING NAMED RESOURCES
.sp
If a target contains multiple Resources of the same type, named matches need to
be used to address the individual resources. In addition to the \fImatch\fP taken by
\fBadd\-match\fP, \fBadd\-named\-match\fP also takes a name for the resource. The other
client commands support the name as an optional parameter and will inform the
user that a name is required if multiple resources are found, but no name is
given.
.sp
If one of the resources should be used by default when no resource name is
explicitly specified, it can be named \fBdefault\fP\&.
.SH EXAMPLES
.sp
To retrieve a list of places run:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ labgrid\-client places
.EE
.UNINDENT
.UNINDENT
.sp
To access a place, it needs to be acquired first, this can be done by running
the \fBacquire command\fP and passing the placename as a \-p parameter:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ labgrid\-client \-p <placename> acquire
.EE
.UNINDENT
.UNINDENT
.sp
Open a console to the acquired place:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ labgrid\-client \-p <placename> console
.EE
.UNINDENT
.UNINDENT
.sp
Add all resources with the group \(dqexample\-group\(dq to the place example\-place:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ labgrid\-client \-p example\-place add\-match */example\-group/*/*
.EE
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBlabgrid\-exporter\fP(1)
.SH AUTHOR
Jan Luebbe, Rouven Czerwinski
.SH COPYRIGHT
2016-2025 Pengutronix, Jan Luebbe and Rouven Czerwinski
.\" Generated by docutils manpage writer.
.