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 Sosreport option. Collects all logs regardless of
68 size.
69 Default: no
71 -c CLUSTER_OPTIONS
73 Specify options used by cluster profiles. The format is 'pro‐
74 file.option_name=value'.
75 For example, for the ovirt plugin if you wanted to restrict node
77 enumeration to a specific cluster you would use '-c ovirt.clus‐
78 ter=example_cluster'.
79 Available cluster options can be listed by running 'sos-collec‐
81 tor -l'.
82 --chroot CHROOT
84 Sosreport option. Set the chroot mode. When --sysroot is used
85 commands default to executing with SYSROOT as the root direc‐
86 tory. This can be overridden by setting --chroot to "always"
87 (always chroot) or "never" (always run in the host namespace).
88 --case-id CASE_ID
90 Sosreport option. Specifies a case number identifier.
91 --cluster-type CLUSTER_TYPE
93 When run by itself, sos-collector will attempt to identify the
94 type of cluster at play. This is done by checking package or
95 configuration information against the localhost, or the master
96 node if "--master" is supplied.
97 Setting --cluster-type skips this step and forcibly sets a par‐
99 ticular profile.
100 Example: sos-collector --cluster-type=kubernetes will force the
102 kubernetes profile to be run, and thus set sosreport options and
103 attempt to determine a list of nodes using that profile.
104 -e ENABLE_PLUGINS, --enable-plugins ENABLE_PLUGINS
106 Sosreport option. Use this to enable a plugin that would other‐
107 wise not be run.
108 This option supports providing a comma-delimited list of plug‐
110 ins.
111 --insecure-sudo
113 Use this option when connecting as a non-root user that has
114 passwordless sudo configured.
115 If this option is omitted and a bogus sudo password is supplied,
117 collection of sosreports may exhibit unexpected behavior and/or
118 fail entirely.
119 -k PLUGIN_OPTION, --plugin-option PLUGIN_OPTION
121 Sosreport option. Set a plugin option to a particular value.
122 This takes the form of plugin_name.option_name=value.
123 Example: To enable the kubernetes "all" option in sosreport use
125 -k kubernetes.all=on.
126 --label LABEL
128 Specify a label to be added to the archive names. This label
129 will be applied to both the sos-collector archive and the sosre‐
130 port archives.
131 If a cluster sets a default label, the user-provided label will
133 be appended to that cluster default.
134 -n SKIP_PLUGINS, --skip-plugins SKIP_PLUGINS
136 Sosreport option. Disable (skip) a particular plugin that would
137 otherwise run. This is useful if a particular plugin is prone
138 to hanging for one reason or another.
139 This option supports providing a comma-delimited list of plug‐
141 ins.
142 --nodes NODES
144 Provide a comma-delimited list of nodes to collect sosreports
145 from, or a regex string to be used to compare discovered node
146 names against. If using a regex, only nodes matching the regex
147 will be used - i.e. it can be used as a whitelist but not a
148 blacklist.
149 This option can be handed multiple regex strings separated by
151 commas. Additionally, both whole node names/addresses and regex
152 strings may be provided at the same time.
153 --no-pkg-check
155 Do not perform package checks. Most cluster profiles check
156 against installed packages to determine if the cluster profile
157 should be applied or not.
158 Use this with --cluster-type if there are rpm or apt issues on
160 the master/local node.
161 --no-local
163 Do not collect a sosreport from the local system.
164 If --master is not supplied, it is assumed that the host running
166 sosreport is part of the cluster that is to be collected. Use
167 this option to skip collection of a local sosreport.
168 This option is NOT needed if --master is provided.
170 --master MASTER
172 Specify a master node for the cluster.
173 If provided, then sos-collector will check the master node, not
175 localhost, for determining the type of cluster in use.
176 -o ONLY_PLUGINS, --only-plugins ONLY_PLUGINS
178 Sosreport option. Run ONLY the plugins listed.
179 Note that a cluster profile will NOT override this option. This
181 may cause the sosreports generated to not contain the relevant
182 output for a given type of cluster.
183 This option supports providing a comma-delimited list of plug‐
185 ins.
186 --password PASSWORD
188 Specifying this option will cause sos-collector to prompt the
189 user for an SSH password that will be used to connect to all
190 nodes.
191 If you have differing passwords for the same user across cluster
193 nodes, you should deploy SSH keys.
194 --preset PRESET
196 Specify a sos preset to use, note that this requires sos-3.6 or
197 later to be installed on the node. The given preset must also
198 exist on the remote node - local presets are not used.
199 If --preset is specified and a given node either does not have
201 that preset defined, or has a version of sos prior to 3.6, this
202 option is ignored for that node.
203 -p SSH_PORT, --ssh-port SSH_PORT
205 Specify SSH port for all nodes. Use this if SSH runs on any port
206 other than 22.
207 --ssh-user SSH_USER
209 Specify an SSH user for sos-collector to connect to nodes with.
210 Default is root.
211 sos-collector will prompt for a sudo password for non-root
213 users.
214 -s SYSROOT, --sysroot SYSROOT
216 Sosreport option. Specify an alternate root file system path.
217 --sos-cmd SOS_CMD
219 Define all options that sosreport should be run with on the
220 nodes. This will override any other commandline options as well
221 as any options specified by a cluster profile.
222 The sosreport command will execute as 'sosreport --batch
224 SOS_CMD'. The BATCH option cannot be removed from the sosreport
225 command as it is required to run sosreport non-interactively for
226 sos-collector to function.
227 -t THREADS --threads THREADS
229 Specify the number of threads to use for concurrent collection
230 of sosreports.
231 If the number of nodes enumerated exceeds the number of threads,
233 then sos-collector will start collecting from the first X number
234 of nodes and then continue to iterate through the remaining
235 nodes as sosreport collection finishes.
236 Defaults to 4.
238 --timeout TIMEOUT
240 Timeout for sosreport generation on each node, in seconds.
241 Note that sosreports are collected in parallel, so this can also
243 be considered to be approximately the same as a timeout for the
244 entire collection process.
245 Default is 180 seconds.
247 --tmp-dir TMP_DIR
249 Specify a temporary directory to save sos archives to. By
250 default one will be created in /tmp and then removed after sos-
251 collector has finished running.
252 This is NOT the same as specifying a temporary directory for
254 sosreport on the remote nodes.
255 -v --verbose
257 Print debug information to screen.
258 --verfiy
260 Sosreport option. Passes the "--verify" option to sosreport on
261 the nodes which causes sosreport to validate plugin-specific
262 data during collection.
263 Note that this option may considerably extend the time it takes
265 sosreport to run on the nodes. Consider increasing --timeout
266 when using this option.
267 -z COMPRESSION, --compression-type COMPRESSION
269 Sosreport option. Override the default compression type.
270
273 Jake Hunsaker <jhunsake@redhat.com>
274 April 2018 sos-collector(1)