1sos-collector(1) General Commands Manual sos-collector(1)
2
6 sos-collector - Collect sosreports from multiple (cluster) nodes
7
9 sos-collector
10 [-a|--all-options]
11 [-b|--become]
12 [--batch]
13 [-c CLUSTER_OPTIONS]
14 [--chroot CHROOT]
15 [--case-id CASE_ID]
16 [--cluster-type CLUSTER_TYPE]
17 [-e ENABLE_PLUGINS]
18 [--insecure-sudo]
19 [-k PLUGIN_OPTION]
20 [--label LABEL]
21 [-n SKIP_PLUGINS]
22 [--nodes NODES]
23 [--no-pkg-check]
24 [--no-local]
25 [--master MASTER]
26 [-o ONLY_PLUGINS]
27 [-p SSH_PORT]
28 [--password PASSWORD]
29 [--preset PRESET]
30 [-s|--sysroot SYSROOT]
31 [--ssh-user SSH_USER]
32 [--sos-cmd SOS_CMD]
33 [-t|--threads THREADS]
34 [--timeout TIMEOUT]
35 [--tmp-dir TMP_DIR]
36 [-v|--verbose]
37 [--verify]
38 [-z|--compression-type COMPRESSION_TYPE]
39
42 sos-collector is a utility to collect sosreports from multiple nodes
43 and package them in a single useful tar archive.
44 sos-collector can be run either on a workstation that has SSH key
46 authentication setup for the nodes in a given cluster, or from a "mas‐
47 ter" node in a cluster that has SSH keys configured for the other
48 nodes.
49 Some sosreport options are supported by sos-collector and are passed
51 directly to the sosreport command run on each node.
52
55 -a, --alloptions
56 Enables all sosreport options.
57 This does NOT enable all sos-collector options.
59 -b, --become
61 Become the root user on the remote node when connecting as a
62 non-root user.
63 --batch
65 Run in non-interactive mode. This will skip prompts for user
66 input, with the exception of a prompt for the SSH password.
67 --all-logs
69 Sosreport option. Collects all logs regardless of size.
70 Default: no
72 -c CLUSTER_OPTIONS
74 Specify options used by cluster profiles. The format is 'pro‐
75 file.option_name=value'.
76 For example, for the ovirt plugin if you wanted to restrict node
78 enumeration to a specific cluster you would use '-c ovirt.clus‐
79 ter=example_cluster'.
80 Available cluster options can be listed by running 'sos-collec‐
82 tor -l'.
83 --chroot CHROOT
85 Sosreport option. Set the chroot mode. When --sysroot is used
86 commands default to executing with SYSROOT as the root direc‐
87 tory. This can be overridden by setting --chroot to "always"
88 (always chroot) or "never" (always run in the host namespace).
89 --case-id CASE_ID
91 Sosreport option. Specifies a case number identifier.
92 --cluster-type CLUSTER_TYPE
94 When run by itself, sos-collector will attempt to identify the
95 type of cluster at play. This is done by checking package or
96 configuration information against the localhost, or the master
97 node if "--master" is supplied.
98 Setting --cluster-type skips this step and forcibly sets a par‐
100 ticular profile.
101 Using a value of none or jbon (just a bunch of nodes) will
103 effectively disable all cluster-specific checks, and cause sos-
104 collector to only use the nodes specified by the --nodes option.
105 Note that in this scenario, regex string(s) for node names will
106 be ignored.
107 Example: sos-collector --cluster-type=kubernetes will force the
109 kubernetes profile to be run, and thus set sosreport options and
110 attempt to determine a list of nodes using that profile.
111 -e ENABLE_PLUGINS, --enable-plugins ENABLE_PLUGINS
113 Sosreport option. Use this to enable a plugin that would other‐
114 wise not be run.
115 This option supports providing a comma-delimited list of plug‐
117 ins.
118 --insecure-sudo
120 Use this option when connecting as a non-root user that has
121 passwordless sudo configured.
122 If this option is omitted and a bogus sudo password is supplied,
124 collection of sosreports may exhibit unexpected behavior and/or
125 fail entirely.
126 -k PLUGIN_OPTION, --plugin-option PLUGIN_OPTION
128 Sosreport option. Set a plugin option to a particular value.
129 This takes the form of plugin_name.option_name=value.
130 Example: To enable the kubernetes "all" option in sosreport use
132 -k kubernetes.all=on.
133 --label LABEL
135 Specify a label to be added to the archive names. This label
136 will be applied to both the sos-collector archive and the sosre‐
137 port archives.
138 If a cluster sets a default label, the user-provided label will
140 be appended to that cluster default.
141 -n SKIP_PLUGINS, --skip-plugins SKIP_PLUGINS
143 Sosreport option. Disable (skip) a particular plugin that would
144 otherwise run. This is useful if a particular plugin is prone
145 to hanging for one reason or another.
146 This option supports providing a comma-delimited list of plug‐
148 ins.
149 --nodes NODES
151 Provide a comma-delimited list of nodes to collect sosreports
152 from, or a regex string to be used to compare discovered node
153 names against. If using a regex, only nodes matching the regex
154 will be used - i.e. it can be used as a whitelist but not a
155 blacklist.
156 This option can be handed multiple regex strings separated by
158 commas. Additionally, both whole node names/addresses and regex
159 strings may be provided at the same time.
160 --no-pkg-check
162 Do not perform package checks. Most cluster profiles check
163 against installed packages to determine if the cluster profile
164 should be applied or not.
165 Use this with --cluster-type if there are rpm or apt issues on
167 the master/local node.
168 --no-local
170 Do not collect a sosreport from the local system.
171 If --master is not supplied, it is assumed that the host running
173 sosreport is part of the cluster that is to be collected. Use
174 this option to skip collection of a local sosreport.
175 This option is NOT needed if --master is provided.
177 --master MASTER
179 Specify a master node for the cluster.
180 If provided, then sos-collector will check the master node, not
182 localhost, for determining the type of cluster in use.
183 -o ONLY_PLUGINS, --only-plugins ONLY_PLUGINS
185 Sosreport option. Run ONLY the plugins listed.
186 Note that a cluster profile will NOT override this option. This
188 may cause the sosreports generated to not contain the relevant
189 output for a given type of cluster.
190 This option supports providing a comma-delimited list of plug‐
192 ins.
193 --password PASSWORD
195 Specifying this option will cause sos-collector to prompt the
196 user for an SSH password that will be used to connect to all
197 nodes.
198 If you have differing passwords for the same user across cluster
200 nodes, you should deploy SSH keys.
201 --preset PRESET
203 Specify a sos preset to use, note that this requires sos-3.6 or
204 later to be installed on the node. The given preset must also
205 exist on the remote node - local presets are not used.
206 If --preset is specified and a given node either does not have
208 that preset defined, or has a version of sos prior to 3.6, this
209 option is ignored for that node.
210 -p SSH_PORT, --ssh-port SSH_PORT
212 Specify SSH port for all nodes. Use this if SSH runs on any port
213 other than 22.
214 --ssh-user SSH_USER
216 Specify an SSH user for sos-collector to connect to nodes with.
217 Default is root.
218 sos-collector will prompt for a sudo password for non-root
220 users.
221 -s SYSROOT, --sysroot SYSROOT
223 Sosreport option. Specify an alternate root file system path.
224 --sos-cmd SOS_CMD
226 Define all options that sosreport should be run with on the
227 nodes. This will override any other commandline options as well
228 as any options specified by a cluster profile.
229 The sosreport command will execute as 'sosreport --batch
231 SOS_CMD'. The BATCH option cannot be removed from the sosreport
232 command as it is required to run sosreport non-interactively for
233 sos-collector to function.
234 -t THREADS --threads THREADS
236 Specify the number of threads to use for concurrent collection
237 of sosreports.
238 If the number of nodes enumerated exceeds the number of threads,
240 then sos-collector will start collecting from the first X number
241 of nodes and then continue to iterate through the remaining
242 nodes as sosreport collection finishes.
243 Defaults to 4.
245 --timeout TIMEOUT
247 Timeout for sosreport generation on each node, in seconds.
248 Note that sosreports are collected in parallel, so this can also
250 be considered to be approximately the same as a timeout for the
251 entire collection process.
252 Default is 180 seconds.
254 --tmp-dir TMP_DIR
256 Specify a temporary directory to save sos archives to. By
257 default one will be created in /tmp and then removed after sos-
258 collector has finished running.
259 This is NOT the same as specifying a temporary directory for
261 sosreport on the remote nodes.
262 -v --verbose
264 Print debug information to screen.
265 --verfiy
267 Sosreport option. Passes the "--verify" option to sosreport on
268 the nodes which causes sosreport to validate plugin-specific
269 data during collection.
270 Note that this option may considerably extend the time it takes
272 sosreport to run on the nodes. Consider increasing --timeout
273 when using this option.
274 -z COMPRESSION, --compression-type COMPRESSION
276 Sosreport option. Override the default compression type.
277
280 sosreport(1)
281
284 Jake Hunsaker <jhunsake@redhat.com>
285 April 2018 sos-collector(1)