1LNST-CTL(1) General Commands Manual LNST-CTL(1)
2
6 lnst-ctl - Linux Network Stack Test controller
7
9 lnst-ctl [OPTION]... ACTION RECIPE...
10
12 Linux Network Stack Test is a tool that supports development and execu‐
13 tion of automated and portable network tests. For detailed description
14 of the architecture of LNST please refer to project website (link
15 listed on INTERNET RESOURCES bellow).
16 lnst-ctl is a script used for managing slaves. It reads a recipe XML
18 file as an input and executes tests on the specified slave machines.
19
21 -A, --override-alias name=value
22 Define top-level alias that will override any other definitions
23 in the recipe
24 -a, --define-alias name=value
26 Define top-level alias
27 -c, --config=file
29 Load a custom configuration file in addition to /etc/lnst-
30 ctl.conf and ~/lnst/lnst-ctl.conf that are loaded by default.
31 -d, --debug
33 Toggle emitting debugging messages.
34 --dump-config
36 Dumps the join of all loaded configuration files on stdout and
37 exits
38 -h, --help
40 Display usage of this command.
41 -m, --no-colours
43 Disable coloured terminal output.
44 -o, --disable-pool-checks
46 Skip the pool machine availability checks.
47 -p, --packet-capture
49 Capture and log all ongoing network communication between the
50 slaves during the test.
51 --pools=name[,...]
53 Restricts which pools to use for matching, value is a comma sep‐
54 arated list of values
55 --pools=path
57 Restrict which pool to use for matching, value is single path to
58 a pool directory
59 -r, --reduce-sync
61 Disable synchronization of module and tool resources to slave
62 machines, when python tasks are used in the recipe. Instead the
63 user can manually synchronize resources from the python task it‐
64 self. This option has no effect if the recipe only contains xml
65 tasks.
66 -s, --xslt-url=URL
68 URL to a XSLT document that will be used when transforming the
69 xml result file, only useful when -t is used as well
70 -t, --html=file
72 Generate a formatted result html
73 -u, --multi-match
75 Run each recipe with every pool match possible
76 -x, --result=file
78 Write results in XML format to the specified file.
79 -v, --verbose
81 Extends output of list_pools action
82 RECIPE can be either a LNST recipe file or a directory containing
84 recipe files. One or more files/directories can be passed at the same
85 time. Each recipe is a XML file. The format is described in detail in
86 the online documentation available at LNST wiki (link is listed on IN‐
87 TERNET RESOURCES bellow).
88 ACTION can be one of run, config_only, deconfigure, match_setup, and
90 list_pools.
91 When it is set to run, all provided recipe files will be sequentially
93 executed. The network will be configured accordingly to each recipe
94 file and clean up afterwards.
95 In case of config_only, the recipes provided are processed up to the
97 point where all the machines are prepared and properly configured. No
98 tests will be executed and the cleanup phase is omitted as well. This
99 mode of operation is useful if you want to perform some specific ac‐
100 tions or tests outside of LNST using the configuration specified in a
101 recipe file.
102 In case of deconfigure, the configuration from a previous config_only
104 run will be removed, including dynamically created devices on virtual
105 machines. There is no need to specify a recipe for this action.
106 In case of list_pools, lnst-ctl looks up all the pools entered in con‐
108 figs and dumps info about them. When used without -v or --verbose op‐
109 tion, only pool names and paths are printed. With verbose option, all
110 viable slave machine configs are printed in more human readable format.
111 At last, when the ACTION is set to match_setup, lnst-ctl will only try
113 to match the configuration in the recipe with its local pools and print
114 the resulting match, in case it was successful or an appropriate error
115 message, in case it was not.
116
119 lnst-ctl will look for configuration in the following locations:
120 /etc/lnst-ctl.conf
122 ~/.lnst/lnst-ctl.conf
123 For further description of file format or configuration options avail‐
125 able, please refer to the configuration file itself, where each option
126 is documented.
127
130 lnst-ctl will terminate with one of the following statuses:
131 0 All tests passed, no errors encountered
133 1 At least one test failed
134 2 There was an error during the execution
135
138 Project Homepage: http://lnst-project.org/
139 Online Documentation: https://github.com/jpirko/lnst/wiki#learn
140 Git Source Tree: https://github.com/jpirko/lnst
141 Mailing List: <lnst-developers@lists.fedorahosted.org>
142
145 Jiri Pirko <jiri@resnulli.us>
146 Jan Tluka <jtluka@redhat.com>
147 Ondrej Lichtner <olichtne@redhat.com>
148 Jiri Prochazka <jprochaz@redhat.com>
149 Jiri Zupka <jzupka@redhat.com>
150 Radek Pazdera <radek@pazdera.co.uk>
151
153 Copyright (C) 2011-2015 Red Hat, Inc.
154 LNST is distributed under the GNU General Public License version 2. See
156 the file "COPYING" in the source distribution for information on terms
157 & conditions for accessing and otherwise using LNST.
158 2022-01-20 LNST-CTL(1)