1SOS(HELP)                                                            SOS(HELP)
2
3
4

NAME

6       sos help - get detailed help information on sos commands and components
7

SYNOPSIS

9       sos help TOPIC
10
11

DESCRIPTION

13       sos  help  is used to retrieve more detailed information on the various
14       SoS commands and components than is directly available in either  other
15       manpages or --help output.
16
17       This  information  could for example be investigating a specific plugin
18       to learn more about  its  purpose,  use  case,  collections,  available
19       plugin options, edge cases, and more.
20
21       Most  aspects  of SoS' operation can be investigated this way - the top
22       level functions such as  report, clean, and collect, as  well  as  con‐
23       structs  that allow those functions to work; e.g. transports within sos
24       collect that define how that function connects to remote nodes.
25
26

REQUIRED ARGUMENTS

28       TOPIC
29
30       The section or topic to retrieve detailed help information  for.  TOPIC
31       takes the general
32              form  of command.component.entity, with component and entity be‐
33              ing optional.
34
35       Top-level command help sections will often direct  users  to  component
36       sections which in turn may point to further entity subsections.
37
38       Some of the more useful or interesting sections are listed below:
39
40           Topic                     Description
41
42           report                    The sos report command
43           report.plugins            Information on what report plugins are
44           report.plugins.$plugin    Information on a specific plugin
45           clean or mask             The sos clean|mask command
46           collect                   The sos collect command
47           collect.clusters          How collect enumerates nodes in a cluster
48           policies                   How  SoS  behaves on different distribu‐
49       tions
50
51
52
53Fri Nov 05 2021                        1                             SOS(HELP)
Impressum