{ "content": [ { "type": "text", "text": "# sos-report(1) (man)\n\n**Summary:** sosreport - Collect and package diagnostic and support data\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| -l | --list-plugins | — | List all available plugins and their options. Plug-ins that would not be enabled by the current configuration are listed |\n| -n | --skip-plugins | — | Disable the specified plugin(s). Multiple plug-ins may be specified by repeating the option or as a comma-separated list |\n| -e | --enable-plugins | — | Enable the specified plugin(s) that would otherwise be disabled. Multiple plugins may be specified by repeating the opti |\n| -o | --only-plugins | — | Enable the specified plugin(s) only (all other plugins should be disabled). Multiple plugins may be specified by repeati |\n| -k | --plugopts | PLUG | |\n| -a | --alloptions | — | Set all boolean options to True for all enabled plug-ins. |\n| -v | --verbose | — | Increase logging verbosity. May be specified multiple times to enable additional de‐ bugging messages. |\n| -q | --quiet | — | Only log fatal errors to stderr. |\n| — | --no-report | — | Disable HTML report writing. |\n| — | --config-file | CONFIG | Specify alternate configuration file. |\n| — | --no-postproc | — | Disable postprocessing globally for all plugins. This will mean data is not obfus‐ cated/sanitized from the archive duri |\n| — | --preset | PRESET | Specify an existing preset to use for sos options. Presets are pre-configured sets of options for both sos and sos plugi |\n| — | --list-presets | — | Display a list of available presets and what options they carry. |\n| — | --desc | DESCRIPTION | When using --add-preset use this option to add a description of the preset that will be displayed when using --list-pres |\n| -s | --sysroot | SYSROOT | Specify an alternate root file system path. Useful for collecting reports from con‐ tainers and images. |\n| -c | --chroot | — | Set the chroot mode. When --sysroot is used commands default to executing with SYSROOT as the root directory (unless dis |\n| — | --tmp-dir | DIRECTORY | Specify alternate temporary directory to copy data as well as the compressed report. |\n| — | --list-profiles | — | Display a list of available profiles and the plugins that they enable. |\n| -p | --profiles | NAME | Only run plugins that correspond to the given profile. Multiple profiles may be speci‐ fied as a comma-separated list; t |\n| — | --verify | — | Instructs plugins to perform plugin-specific verification during data collection. This may include package manager verif |\n| — | --log-size | — | Places a limit on the size of collected logs and output in MiB. Note that this causes sos to capture the last X amount o |\n| — | --journal-size | — | Places a limit on the size of journals collected in MiB. Note that this causes sos to capture the last X amount of the j |\n| — | --all-logs | — | Tell plugins to collect all possible log data ignoring any size limits and including logs in non-default locations. This |\n| — | --since | — | Limits the collection of log archives to those newer than this date. A log archive is any file not found in /etc, that h |\n| — | --skip-commands | COMMANDS | A comma delimited list of commands to skip execution of, but still allowing the rest of the plugin that calls the comman |\n| — | --skip-files | FILES | A comma delimited list of files or filepath wildcard matches to skip collection of. Values may either be exact filepaths |\n| — | --allow-system-changes | — | Run commands even if they can change the system (e.g. load kernel modules). |\n| — | --low-priority | — | Set sos to execute as a low priority process so that is does not interfere with other processes running on the system. S |\n| — | --encrypt | — | Encrypt the resulting archive, and determine the method by which that encryption is done by either a user prompt or envi |\n| — | --encrypt-key | KEY | Encrypts the resulting archive that sos report produces using GPG. KEY must be an ex‐ isting key in the user's keyring a |\n| — | --encrypt-pass | PASS | The same as --encrypt-key, but use the provided PASS for symmetric encryption rather than key-pair encryption. |\n| — | --batch | — | Generate archive without prompting for interactive input. |\n| — | --name | NAME | Deprecated. See --label |\n| — | --label | LABEL | Specify an arbitrary identifier to associate with the archive. Labels will be ap‐ pended after the system's short hostna |\n| — | --threads | THREADS | Specify the number of threads sos report will use for concurrency. Defaults to 4. |\n| — | --plugin-timeout | TIMEOUT | Specify a timeout in seconds to allow each plugin to run for. A value of 0 means no timeout will be set. A value of -1 i |\n| — | --cmd-timeout | TIMEOUT | Specify a timeout limit in seconds for a command execution. Same defaults logic from --plugin-timeout applies here. This |\n| — | --namespaces | NAMESPACES | For plugins that iterate collections over namespaces that exist on the system, for ex‐ ample the networking plugin colle |\n| — | --container-runtime | RUNTIME | Force the use of the specified RUNTIME as the default runtime that plugins will use to collect data from and about conta |\n| — | --case-id | NUMBER | Specify a case identifier to associate with the archive. Identifiers may include al‐ phanumeric characters, commas and p |\n| — | --build | — | Do not archive copied data. Causes sos report to leave an uncompressed archive as a temporary file or directory tree. |\n| — | --debug | — | Enable interactive debugging using the python debugger. Exceptions in sos or plug-in code will cause a trap to the pdb s |\n| — | --dry-run | — | Execute plugins as normal, but do not collect any file content, command output, or string data from the system. The resu |\n| — | --estimate-only | — | Estimate disk space requirements when running sos report. This can be valuable to pre‐ vent sos report working dir to co |\n| — | --upload | — | If specified, attempt to upload the resulting archive to a vendor defined location. This option is implied if --upload-u |\n| — | --upload-url | URL | If a vendor does not provide a default upload location, or if you would like to upload the archive to a different locati |\n| — | --upload-user | USER | If a vendor does not provide a default user for uploading, specify the username here. If this option is unused and uploa |\n| — | --upload-pass | PASS | Specify the password to use for authentication with the destination server. If this option is omitted and upload is requ |\n| — | --upload-directory | DIR | Specify a directory to upload to, if one is not specified by a vendor default location or if your destination server doe |\n| — | --upload-method | METHOD | Specify the HTTP method to use for uploading to the provided --upload-url. Valid val‐ ues are 'auto' (default), 'put', o |\n| — | --upload-no-ssl-verify | — | Disable SSL verification for HTTPS uploads. This may be used to allow uploading to lo‐ cations that have self-signed cer |\n| — | --upload-protocol | PROTO | Manually specify the protocol to use for uploading to the target upload-url. Normally this is determined via the upload |\n| — | --experimental | — | Enable plugins marked as experimental. Experimental plugins may not have been tested for this port or may still be under |\n\n## See Also\n\n- sos(1)\n- sos-clean(1)\n- sos-collect(1)\n- sos.conf(5)\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (1 lines) — 1 subsections\n - sos report (43 lines)\n- **DESCRIPTION** (12 lines)\n- **OPTIONS** (1 lines) — 54 subsections\n - -l, --list-plugins (3 lines)\n - -n, --skip-plugins PLUGNAME[,PLUGNAME] (3 lines)\n - -e, --enable-plugins PLUGNAME[,PLUGNAME] (7 lines)\n - -o, --only-plugins PLUGNAME[,PLUGNAME] (3 lines)\n - -k --plugin-option=PLUGNAME.PLUGOPT[=VALUE], --plugopts=PLUG (1 lines)\n - NAME.PLUGOPT[=VALUE] (3 lines)\n - -a, --alloptions (2 lines)\n - -v, --verbose (3 lines)\n - -q, --quiet (2 lines)\n - --no-report (2 lines)\n - --config-file CONFIG (2 lines)\n - --no-postproc (9 lines)\n - --preset PRESET (27 lines)\n - --list-presets (2 lines)\n - --desc DESCRIPTION (3 lines)\n - -s, --sysroot SYSROOT (3 lines)\n - -c, --chroot {auto|always|never} (5 lines)\n - --tmp-dir DIRECTORY (2 lines)\n - --list-profiles (2 lines)\n - -p, --profile, --profiles NAME (10 lines)\n - --verify (5 lines)\n - --log-size (13 lines)\n - --journal-size (7 lines)\n - --all-logs (4 lines)\n - --since YYYYMMDD[HHMMSS] (5 lines)\n - --skip-commands COMMANDS (6 lines)\n - --skip-files FILES (4 lines)\n - --allow-system-changes (2 lines)\n - --low-priority (6 lines)\n - --encrypt (18 lines)\n - --encrypt-key KEY (22 lines)\n - --encrypt-pass PASS (3 lines)\n - --batch (2 lines)\n - --name NAME (2 lines)\n - --label LABEL (3 lines)\n - --threads THREADS (2 lines)\n - --plugin-timeout TIMEOUT (12 lines)\n - --cmd-timeout TIMEOUT (13 lines)\n - --namespaces NAMESPACES (9 lines)\n - --container-runtime RUNTIME (15 lines)\n - --case-id NUMBER (3 lines)\n - --build (3 lines)\n - --debug (3 lines)\n - --dry-run (4 lines)\n - --estimate-only (14 lines)\n - --upload (19 lines)\n - --upload-url URL (9 lines)\n - --upload-user USER (14 lines)\n - --upload-pass PASS (19 lines)\n - --upload-directory DIR (3 lines)\n - --upload-method METHOD (6 lines)\n - --upload-no-ssl-verify (6 lines)\n - --upload-protocol PROTO (12 lines)\n - --experimental (5 lines)\n- **SEE ALSO** (3 lines)\n- **MAINTAINER** (2 lines) — 1 subsections\n - AUTHORS & CONTRIBUTORS (5 lines)\n\n## Full Content\n\n### NAME\n\nsosreport - Collect and package diagnostic and support data\n\n### SYNOPSIS\n\n#### sos report\n\n[-l|--list-plugins]\n[-n|--skip-plugins plugin-names]\n[-e|--enable-plugins plugin-names]\n[-o|--only-plugins plugin-names]\n[-a|--alloptions] [-v|--verbose]\n[-k plug.opt|--plugin-option plug.opt]|--plugopts plug.opt\n[--no-report] [--config-file conf]\n[--no-postproc]\n[--preset preset] [--add-preset addpreset]\n[--del-preset delpreset] [--desc description]\n[--batch] [--build] [--debug] [--dry-run]\n[--estimate-only] [--label label] [--case-id id]\n[--threads threads]\n[--plugin-timeout TIMEOUT]\n[--cmd-timeout TIMEOUT]\n[--namespaces NAMESPACES]\n[--container-runtime RUNTIME]\n[-s|--sysroot SYSROOT]\n[-c|--chroot {auto|always|never}\n[--tmp-dir directory]\n[-p|--profile profile-name]\n[--list-profiles]\n[--verify]\n[--log-size]\n[--journal-size]\n[--all-logs]\n[--since YYYYMMDD[HHMMSS]]\n[--skip-commands commands]\n[--skip-files files]\n[--allow-system-changes]\n[--low-priority]\n[-z|--compression-type method]\n[--encrypt]\n[--encrypt-key KEY]\n[--encrypt-pass PASS]\n[--upload] [--upload-url url] [--upload-user user]\n[--upload-directory dir] [--upload-pass pass]\n[--upload-no-ssl-verify] [--upload-method]\n[--upload-protocol protocol]\n[--experimental]\n[-h|--help]\n\n### DESCRIPTION\n\nreport is an sos subcommand that generates an archive of configuration and diagnostic infor‐\nmation from the running system. The archive may be stored locally or centrally for recording\nor tracking purposes or may be sent to technical support representatives, developers or sys‐\ntem administrators to assist with technical fault-finding and debugging.\n\nSos is modular in design and is able to collect data from a wide range of subsystems and\npackages that may be installed. An HTML report summarizing the collected information is op‐\ntionally generated and stored within the archive.\n\nNote: the sosreport command has been deprecated and will be removed in sos-4.9. Use the new\nsos report syntax instead.\n\n### OPTIONS\n\n#### -l, --list-plugins\n\nList all available plugins and their options. Plug-ins that would not be enabled by\nthe current configuration are listed separately.\n\n#### -n, --skip-plugins PLUGNAME[,PLUGNAME]\n\nDisable the specified plugin(s). Multiple plug-ins may be specified by repeating the\noption or as a comma-separated list.\n\n#### -e, --enable-plugins PLUGNAME[,PLUGNAME]\n\nEnable the specified plugin(s) that would otherwise be disabled. Multiple plugins may\nbe specified by repeating the option or as a comma-separated list.\n\nNote that if using -p, --profile this option will not enable further plugins. Use -o,\n--only-plugins to extend the list of plugins enabled by profiles.\n\n#### -o, --only-plugins PLUGNAME[,PLUGNAME]\n\nEnable the specified plugin(s) only (all other plugins should be disabled). Multiple\nplugins may be specified by repeating the option or as a comma-separated list.\n\n#### -k --plugin-option=PLUGNAME.PLUGOPT[=VALUE], --plugopts=PLUG\n\n#### NAME.PLUGOPT[=VALUE]\n\nSpecify plug-in options. The option PLUGOPT is enabled, or set to the specified value\nin the plug-in PLUGNAME.\n\n#### -a, --alloptions\n\nSet all boolean options to True for all enabled plug-ins.\n\n#### -v, --verbose\n\nIncrease logging verbosity. May be specified multiple times to enable additional de‐\nbugging messages.\n\n#### -q, --quiet\n\nOnly log fatal errors to stderr.\n\n#### --no-report\n\nDisable HTML report writing.\n\n#### --config-file CONFIG\n\nSpecify alternate configuration file.\n\n#### --no-postproc\n\nDisable postprocessing globally for all plugins. This will mean data is not obfus‐\ncated/sanitized from the archive during collection.\n\nNote that this means data such as password, SSH keys, certificates, etc... will be\ncollected in plain text.\n\nTo selectively disable postprocessing on a per-plugin basis, use the 'postproc' plugin\noption available to all plugins, e.g. '-k podman.postproc=off'.\n\n#### --preset PRESET\n\nSpecify an existing preset to use for sos options.\n\nPresets are pre-configured sets of options for both sos and sos plugins. For example a\npreset may enable a certain set of plugins, disable others, or enable specific plugin\noptions. They may also specify sos options such as log-size or package verification.\n\nUser defined presets are saved under /etc/sos/presets.d as JSON-formatted files.\n\n--add-preset ADDPRESET [options]\nAdd a preset with name ADDPRESET that enables [options] when called.\n\nFor example, 'sos report --add-preset mypreset --log-size=50 -n logs' will enable a\nuser to run 'sos report --preset mypreset' that sets the maximum log size to 50 and\ndisables the logs plugin.\n\nNote: to set a description for the preset that is displayed with --list-presets, use\nthe --desc option.\n\nNote: to set a behaviour note of the preset, use --note option.\n\nNote: The root filesystem, as seen by sos if running within a container, must be\nwritable to save presets using this option.\n\n--del-preset DELPRESET\nDeletes the preset with name DELPRESET from the filesystem so that it can no longer\nbe used.\n\n#### --list-presets\n\nDisplay a list of available presets and what options they carry.\n\n#### --desc DESCRIPTION\n\nWhen using --add-preset use this option to add a description of the preset that will\nbe displayed when using --list-presets.\n\n#### -s, --sysroot SYSROOT\n\nSpecify an alternate root file system path. Useful for collecting reports from con‐\ntainers and images.\n\n#### -c, --chroot {auto|always|never}\n\nSet the chroot mode. When --sysroot is used commands default to executing with SYSROOT\nas the root directory (unless disabled by a specific plugin). This can be overridden\nby setting --chroot to \"always\" (always chroot) or \"never\" (always run in the host\nnamespace).\n\n#### --tmp-dir DIRECTORY\n\nSpecify alternate temporary directory to copy data as well as the compressed report.\n\n#### --list-profiles\n\nDisplay a list of available profiles and the plugins that they enable.\n\n#### -p, --profile, --profiles NAME\n\nOnly run plugins that correspond to the given profile. Multiple profiles may be speci‐\nfied as a comma-separated list; the set of plugins executed is the union of each of\nthe profile's plugin sets.\n\nNote that if there are specific plugins outside of the profile(s) passed to this op‐\ntion that you would also want to enable, use -o, --only-plugins to add those plugins\nto the list.\n\nSee sos report --list-profiles for a list of currently supported profiles.\n\n#### --verify\n\nInstructs plugins to perform plugin-specific verification during data collection. This\nmay include package manager verification, log integrity testing or other plugin de‐\nfined behaviour. Use of --verify may cause the time taken to generate a report to be\nconsiderably longer.\n\n#### --log-size\n\nPlaces a limit on the size of collected logs and output in MiB. Note that this causes\nsos to capture the last X amount of the file or command output collected.\n\nBy default, this is set to 25 MiB and applies to all files and command output col‐\nlected with the exception of journal collections, which are limited by the --journal-\nsize option instead.\n\nSetting this value to 0 removes all size limitations, and any files or commands col‐\nlected will be collected in their entirety, which may drastically increase the size of\nthe final sos report tarball and the memory usage of sos during collection of com‐\nmands.\n\n#### --journal-size\n\nPlaces a limit on the size of journals collected in MiB. Note that this causes sos to\ncapture the last X amount of the journal.\n\nBy default, this is set to 100 MiB. Setting this value to 0 removes all size limita‐\ntions, as does the use of the --all-logs option. This may drastically increase the\nsize of the final sos report tarball.\n\n#### --all-logs\n\nTell plugins to collect all possible log data ignoring any size limits and including\nlogs in non-default locations. This option may significantly increase the size of re‐\nports.\n\n#### --since YYYYMMDD[HHMMSS]\n\nLimits the collection of log archives to those newer than this date. A log archive is\nany file not found in /etc, that has either a numeric or a compression-type file ex‐\ntension for example \".zip\". \".1\", \".gz\" etc.). This also affects --all-logs. The date\nstring will be padded with zeros if HHMMSS is not specified.\n\n#### --skip-commands COMMANDS\n\nA comma delimited list of commands to skip execution of, but still allowing the rest\nof the plugin that calls the command to run. This will generally need to be some form\nof UNIX shell-style wildcard matching. For example, using a value of hostname will\nskip only that single command, while using hostname* will skip all commands with names\nthat begin with the string \"hostname\".\n\n#### --skip-files FILES\n\nA comma delimited list of files or filepath wildcard matches to skip collection of.\nValues may either be exact filepaths or paths using UNIX shell-style wildcards, for\nexample /etc/sos/*.\n\n#### --allow-system-changes\n\nRun commands even if they can change the system (e.g. load kernel modules).\n\n#### --low-priority\n\nSet sos to execute as a low priority process so that is does not interfere with other\nprocesses running on the system. Specific distributions may set their own constraints,\nbut by default this involves setting process niceness to 19 and, if available, setting\nan idle IO class via ionice. -z, --compression-type METHOD Override the default com‐\npression type specified by the active policy.\n\n#### --encrypt\n\nEncrypt the resulting archive, and determine the method by which that encryption is\ndone by either a user prompt or environment variables.\n\nWhen run with --batch, using this option will cause sos to look for either the SOSEN‐‐\nCRYPTKEY or SOSENCRYPTPASS environment variables. If set, this will implicitly enable\nthe --encrypt-key or --encrypt-pass options, respectively, to the values set by the\nenvironment variable. This enables the use of these options without directly setting\nthose options in a config file or command line string. Note that use of an encryption\nkey has precedence over a passphrase.\n\nOtherwise, using this option will cause sos to prompt the user to choose the method of\nencryption to use. Choices will be [P]assphrase, [K]ey, [E]nv vars, or [N]o encryp‐\ntion. If passphrase or key the user will then be prompted for the respective value,\nenv vars will cause sos to source the information in the manner stated above, and\nchoosing no encryption will disable encryption.\n\nSee the sections on --encrypt-key and --encrypt-pass below for more information.\n\n#### --encrypt-key KEY\n\nEncrypts the resulting archive that sos report produces using GPG. KEY must be an ex‐\nisting key in the user's keyring as GPG does not allow for keyfiles. KEY can be any\nvalue accepted by gpg's 'recipient' option.\n\nNote that the user running sos report must match the user owning the keyring from\nwhich keys will be obtained. In particular this means that if sudo is used to run sos\nreport, the keyring must also be set up using sudo (or direct shell access to the ac‐\ncount).\n\nUsers should be aware that encrypting the final archive will result in sos using dou‐\nble the amount of temporary disk space - the encrypted archive must be written as a\nseparate, rather than replacement, file within the temp directory that sos writes the\narchive to. However, since the encrypted archive will be the same size as the original\narchive, there is no additional space consumption once the temporary directory is re‐\nmoved at the end of execution.\n\nThis means that only the encrypted archive is present on disk after sos finishes run‐\nning.\n\nIf encryption fails for any reason, the original unencrypted archive is preserved in‐\nstead.\n\n#### --encrypt-pass PASS\n\nThe same as --encrypt-key, but use the provided PASS for symmetric encryption rather\nthan key-pair encryption.\n\n#### --batch\n\nGenerate archive without prompting for interactive input.\n\n#### --name NAME\n\nDeprecated. See --label\n\n#### --label LABEL\n\nSpecify an arbitrary identifier to associate with the archive. Labels will be ap‐\npended after the system's short hostname and may contain alphanumeric characters.\n\n#### --threads THREADS\n\nSpecify the number of threads sos report will use for concurrency. Defaults to 4.\n\n#### --plugin-timeout TIMEOUT\n\nSpecify a timeout in seconds to allow each plugin to run for. A value of 0 means no\ntimeout will be set. A value of -1 is used to indicate the default timeout of 300 sec‐\nonds.\n\nNote that this option sets the timeout for all plugins. If you want to set a timeout\nfor a specific plugin, use the 'timeout' plugin option available to all plugins - e.g.\n'-k logs.timeout=600'.\n\nThe plugin-specific timeout option will override this option. For example, using\n'--plugin-timeout=60 -k logs.timeout=600' will set a timeout of 600 seconds for the\nlogs plugin and 60 seconds for all other enabled plugins.\n\n#### --cmd-timeout TIMEOUT\n\nSpecify a timeout limit in seconds for a command execution. Same defaults logic from\n--plugin-timeout applies here.\n\nThis option sets the command timeout for all plugins. If you want to set a cmd timeout\nfor a specific plugin, use the 'cmd-timeout' plugin option available to all plugins -\ne.g. '-k logs.cmd-timeout=600'.\n\nAgain, the same plugin/global precedence logic as for --plugin-timeout applies here.\n\nNote that setting --cmd-timeout (or -k logs.cmd-timeout) high should be followed by\nincreasing the --plugin-timeout equivalent, otherwise the plugin can easily timeout on\nslow commands execution.\n\n#### --namespaces NAMESPACES\n\nFor plugins that iterate collections over namespaces that exist on the system, for ex‐\nample the networking plugin collecting `ip` command output for each network namespace,\nuse this option to limit the number of namespaces that will be collected.\n\nUse '0' (default) for no limit - all namespaces will be used for collections.\n\nNote that specific plugins may provide a similar `namespaces` plugin option. If the\nplugin option is used, it will override this option.\n\n#### --container-runtime RUNTIME\n\nForce the use of the specified RUNTIME as the default runtime that plugins will use to\ncollect data from and about containers and container images. By default, the setting\nof auto results in the local policy determining what runtime will be the default run‐\ntime (in configurations where multiple runtimes are installed and active).\n\nIf no container runtimes are active, this option is ignored. If there are runtimes ac‐\ntive, but not one with a name matching RUNTIME, sos will abort.\n\nSetting this to none, off, or disabled will cause plugins to NOT leverage any active\nruntimes for collections. Note that if disabled, plugins specifically for runtimes\n(e.g. the podman or docker plugins) will still collect general data about the runtime,\nbut will not inspect existing containers or images.\n\nDefault: 'auto' (policy determined)\n\n#### --case-id NUMBER\n\nSpecify a case identifier to associate with the archive. Identifiers may include al‐\nphanumeric characters, commas and periods ('.').\n\n#### --build\n\nDo not archive copied data. Causes sos report to leave an uncompressed archive as a\ntemporary file or directory tree.\n\n#### --debug\n\nEnable interactive debugging using the python debugger. Exceptions in sos or plug-in\ncode will cause a trap to the pdb shell.\n\n#### --dry-run\n\nExecute plugins as normal, but do not collect any file content, command output, or\nstring data from the system. The resulting logs may be used to understand the actions\nthat sos would have taken without the dry run option.\n\n#### --estimate-only\n\nEstimate disk space requirements when running sos report. This can be valuable to pre‐\nvent sos report working dir to consume all free disk space. No plugin data is avail‐\nable at the end.\n\nPlugins will be collected sequentially, size of collected files and commands outputs\nwill be calculated and the plugin files will be immediately deleted prior execution of\nthe next plugin. This still can consume whole free disk space, though.\n\nPlease note, size estimations may not be accurate for highly utilized systems due to\nchanges between an estimate and a real execution. Also some difference between estima‐\ntion (using `stat` command) and other commands used (i.e. `du`).\n\nA rule of thumb is to reserve at least double the estimation.\n\n#### --upload\n\nIf specified, attempt to upload the resulting archive to a vendor defined location.\n\nThis option is implied if --upload-url is used.\n\nYou may be prompted for a username and password if these are not defined by the vendor\nas well. If these credentials are not provided, sos will still run and create an ar‐\nchive but will not attempt an automatic upload, instead relying on the end user to up‐\nload it as needed.\n\nThe sos report archive will still remain on the local filesystem even after a success‐\nful upload.\n\nNote that depending on the distribution sos is being run on, or the vendor policy de‐\ntected during execution, there may be dependencies that are not strictly required by\nthe package at installation time.\n\nFor example, for HTTPS uploads the python-requests library must be available. If this\nlibrary is not available, HTTPS uploads will not be attempted.\n\n#### --upload-url URL\n\nIf a vendor does not provide a default upload location, or if you would like to upload\nthe archive to a different location, specify the address here.\n\nA support protocol MUST be specified in this URL. Currently uploading is supported for\nHTTPS, SFTP, and FTP protocols.\n\nIf your destination server listens on a non-standard port, specify the listening port\nin the URL.\n\n#### --upload-user USER\n\nIf a vendor does not provide a default user for uploading, specify the username here.\n\nIf this option is unused and upload is request, and a vendor default is not set, you\nwill be prompted for one. If --batch is used and this option is omitted, no username\nwill be collected and thus uploads will fail if no vendor default is set.\n\nYou also have the option of providing this value via the SOSUPLOADUSER environment\nvariable. If this variable is set, then no username prompt will occur and --batch may\nbe used provided all other required values (case number, upload password) are pro‐\nvided.\n\nThis option is ignored when uploading to the Red Customer Portal or Red Hat Secure FTP\nserver in favour of web token authentication.\n\n#### --upload-pass PASS\n\nSpecify the password to use for authentication with the destination server.\n\nIf this option is omitted and upload is requested, you will be prompted for one.\n\nIf --batch is used, this prompt will not occur, so any uploads are likely to fail un‐\nless this option is used.\n\nNote that this may result in the plaintext string appearing in `ps` output that may be\ncollected by sos and be in the archive. If a password must be provided by you for up‐\nloading, it is strongly recommended to not use --batch and enter the password when\nprompted rather than using this option.\n\nYou also have the option of providing this value via the SOSUPLOADPASSWORD environment\nvariable. If this variable is set, then no password prompt will occur and --batch may\nbe used provided all other required values (case number, upload user) are provided.\n\nThis option is ignored when uploading to the Red Customer Portal or Red Hat Secure FTP\nserver in favour of web token authentication.\n\n#### --upload-directory DIR\n\nSpecify a directory to upload to, if one is not specified by a vendor default location\nor if your destination server does not allow writes to '/'.\n\n#### --upload-method METHOD\n\nSpecify the HTTP method to use for uploading to the provided --upload-url. Valid val‐\nues are 'auto' (default), 'put', or 'post'. The use of 'auto' will default to the\nmethod required by the policy-default upload location, if one exists.\n\nThis option has no effect on upload protocols other than HTTPS.\n\n#### --upload-no-ssl-verify\n\nDisable SSL verification for HTTPS uploads. This may be used to allow uploading to lo‐\ncations that have self-signed certificates, or certificates that are otherwise un‐\ntrusted by the local system.\n\nDefault behavior is to perform SSL verification against all upload locations.\n\n#### --upload-protocol PROTO\n\nManually specify the protocol to use for uploading to the target upload-url.\n\nNormally this is determined via the upload address, assuming that the protocol is part\nof the address provided, e.g. 'https://example.com'. By using this option, sos will\nskip the protocol check and use the method defined for the specified PROTO.\n\nFor RHEL systems, setting this option to sftp will skip the initial attempt to upload\nto the Red Hat Customer Portal, and only attempt an upload to Red Hat's SFTP server,\nwhich is typically used as a fallback target.\n\nValid values for PROTO are: 'auto' (default), 'https', 'ftp', 'sftp'.\n\n#### --experimental\n\nEnable plugins marked as experimental. Experimental plugins may not have been tested\nfor this port or may still be under active development.\n\n--help Display usage message.\n\n### SEE ALSO\n\nsos(1) sos-clean(1) sos-collect(1) sos.conf(5)\n\n### MAINTAINER\n\nMaintained on GitHub at https://github.com/sosreport/sos\n\n#### AUTHORS & CONTRIBUTORS\n\nSee AUTHORS file in the package documentation.\n\n\n\nMon Mar 25 2013 SOSREPORT(1)\n\n" } ], "structuredContent": { "command": "sos-report", "section": "1", "mode": "man", "summary": "sosreport - Collect and package diagnostic and support data", "synopsis": "", "flags": [ { "flag": "-l", "long": "--list-plugins", "arg": null, "description": "List all available plugins and their options. Plug-ins that would not be enabled by the current configuration are listed separately." }, { "flag": "-n", "long": "--skip-plugins", "arg": null, "description": "Disable the specified plugin(s). Multiple plug-ins may be specified by repeating the option or as a comma-separated list." }, { "flag": "-e", "long": "--enable-plugins", "arg": null, "description": "Enable the specified plugin(s) that would otherwise be disabled. Multiple plugins may be specified by repeating the option or as a comma-separated list. Note that if using -p, --profile this option will not enable further plugins. Use -o, --only-plugins to extend the list of plugins enabled by profiles." }, { "flag": "-o", "long": "--only-plugins", "arg": null, "description": "Enable the specified plugin(s) only (all other plugins should be disabled). Multiple plugins may be specified by repeating the option or as a comma-separated list." }, { "flag": "-k", "long": "--plugopts", "arg": "PLUG", "description": "" }, { "flag": "-a", "long": "--alloptions", "arg": null, "description": "Set all boolean options to True for all enabled plug-ins." }, { "flag": "-v", "long": "--verbose", "arg": null, "description": "Increase logging verbosity. May be specified multiple times to enable additional de‐ bugging messages." }, { "flag": "-q", "long": "--quiet", "arg": null, "description": "Only log fatal errors to stderr." }, { "flag": "", "long": "--no-report", "arg": null, "description": "Disable HTML report writing." }, { "flag": "", "long": "--config-file", "arg": "CONFIG", "description": "Specify alternate configuration file." }, { "flag": "", "long": "--no-postproc", "arg": null, "description": "Disable postprocessing globally for all plugins. This will mean data is not obfus‐ cated/sanitized from the archive during collection. Note that this means data such as password, SSH keys, certificates, etc... will be collected in plain text. To selectively disable postprocessing on a per-plugin basis, use the 'postproc' plugin option available to all plugins, e.g. '-k podman.postproc=off'." }, { "flag": "", "long": "--preset", "arg": "PRESET", "description": "Specify an existing preset to use for sos options. Presets are pre-configured sets of options for both sos and sos plugins. For example a preset may enable a certain set of plugins, disable others, or enable specific plugin options. They may also specify sos options such as log-size or package verification. User defined presets are saved under /etc/sos/presets.d as JSON-formatted files. --add-preset ADDPRESET [options] Add a preset with name ADDPRESET that enables [options] when called. For example, 'sos report --add-preset mypreset --log-size=50 -n logs' will enable a user to run 'sos report --preset mypreset' that sets the maximum log size to 50 and disables the logs plugin. Note: to set a description for the preset that is displayed with --list-presets, use the --desc option. Note: to set a behaviour note of the preset, use --note option. Note: The root filesystem, as seen by sos if running within a container, must be writable to save presets using this option. --del-preset DELPRESET Deletes the preset with name DELPRESET from the filesystem so that it can no longer be used." }, { "flag": "", "long": "--list-presets", "arg": null, "description": "Display a list of available presets and what options they carry." }, { "flag": "", "long": "--desc", "arg": "DESCRIPTION", "description": "When using --add-preset use this option to add a description of the preset that will be displayed when using --list-presets." }, { "flag": "-s", "long": "--sysroot", "arg": "SYSROOT", "description": "Specify an alternate root file system path. Useful for collecting reports from con‐ tainers and images." }, { "flag": "-c", "long": "--chroot", "arg": null, "description": "Set the chroot mode. When --sysroot is used commands default to executing with SYSROOT as the root directory (unless disabled by a specific plugin). This can be overridden by setting --chroot to \"always\" (always chroot) or \"never\" (always run in the host namespace)." }, { "flag": "", "long": "--tmp-dir", "arg": "DIRECTORY", "description": "Specify alternate temporary directory to copy data as well as the compressed report." }, { "flag": "", "long": "--list-profiles", "arg": null, "description": "Display a list of available profiles and the plugins that they enable." }, { "flag": "-p", "long": "--profiles", "arg": "NAME", "description": "Only run plugins that correspond to the given profile. Multiple profiles may be speci‐ fied as a comma-separated list; the set of plugins executed is the union of each of the profile's plugin sets. Note that if there are specific plugins outside of the profile(s) passed to this op‐ tion that you would also want to enable, use -o, --only-plugins to add those plugins to the list. See sos report --list-profiles for a list of currently supported profiles." }, { "flag": "", "long": "--verify", "arg": null, "description": "Instructs plugins to perform plugin-specific verification during data collection. This may include package manager verification, log integrity testing or other plugin de‐ fined behaviour. Use of --verify may cause the time taken to generate a report to be considerably longer." }, { "flag": "", "long": "--log-size", "arg": null, "description": "Places a limit on the size of collected logs and output in MiB. Note that this causes sos to capture the last X amount of the file or command output collected. By default, this is set to 25 MiB and applies to all files and command output col‐ lected with the exception of journal collections, which are limited by the --journal- size option instead. Setting this value to 0 removes all size limitations, and any files or commands col‐ lected will be collected in their entirety, which may drastically increase the size of the final sos report tarball and the memory usage of sos during collection of com‐ mands." }, { "flag": "", "long": "--journal-size", "arg": null, "description": "Places a limit on the size of journals collected in MiB. Note that this causes sos to capture the last X amount of the journal. By default, this is set to 100 MiB. Setting this value to 0 removes all size limita‐ tions, as does the use of the --all-logs option. This may drastically increase the size of the final sos report tarball." }, { "flag": "", "long": "--all-logs", "arg": null, "description": "Tell plugins to collect all possible log data ignoring any size limits and including logs in non-default locations. This option may significantly increase the size of re‐ ports." }, { "flag": "", "long": "--since", "arg": null, "description": "Limits the collection of log archives to those newer than this date. A log archive is any file not found in /etc, that has either a numeric or a compression-type file ex‐ tension for example \".zip\". \".1\", \".gz\" etc.). This also affects --all-logs. The date string will be padded with zeros if HHMMSS is not specified." }, { "flag": "", "long": "--skip-commands", "arg": "COMMANDS", "description": "A comma delimited list of commands to skip execution of, but still allowing the rest of the plugin that calls the command to run. This will generally need to be some form of UNIX shell-style wildcard matching. For example, using a value of hostname will skip only that single command, while using hostname* will skip all commands with names that begin with the string \"hostname\"." }, { "flag": "", "long": "--skip-files", "arg": "FILES", "description": "A comma delimited list of files or filepath wildcard matches to skip collection of. Values may either be exact filepaths or paths using UNIX shell-style wildcards, for example /etc/sos/*." }, { "flag": "", "long": "--allow-system-changes", "arg": null, "description": "Run commands even if they can change the system (e.g. load kernel modules)." }, { "flag": "", "long": "--low-priority", "arg": null, "description": "Set sos to execute as a low priority process so that is does not interfere with other processes running on the system. Specific distributions may set their own constraints, but by default this involves setting process niceness to 19 and, if available, setting an idle IO class via ionice. -z, --compression-type METHOD Override the default com‐ pression type specified by the active policy." }, { "flag": "", "long": "--encrypt", "arg": null, "description": "Encrypt the resulting archive, and determine the method by which that encryption is done by either a user prompt or environment variables. When run with --batch, using this option will cause sos to look for either the SOSEN‐‐ CRYPTKEY or SOSENCRYPTPASS environment variables. If set, this will implicitly enable the --encrypt-key or --encrypt-pass options, respectively, to the values set by the environment variable. This enables the use of these options without directly setting those options in a config file or command line string. Note that use of an encryption key has precedence over a passphrase. Otherwise, using this option will cause sos to prompt the user to choose the method of encryption to use. Choices will be [P]assphrase, [K]ey, [E]nv vars, or [N]o encryp‐ tion. If passphrase or key the user will then be prompted for the respective value, env vars will cause sos to source the information in the manner stated above, and choosing no encryption will disable encryption. See the sections on --encrypt-key and --encrypt-pass below for more information." }, { "flag": "", "long": "--encrypt-key", "arg": "KEY", "description": "Encrypts the resulting archive that sos report produces using GPG. KEY must be an ex‐ isting key in the user's keyring as GPG does not allow for keyfiles. KEY can be any value accepted by gpg's 'recipient' option. Note that the user running sos report must match the user owning the keyring from which keys will be obtained. In particular this means that if sudo is used to run sos report, the keyring must also be set up using sudo (or direct shell access to the ac‐ count). Users should be aware that encrypting the final archive will result in sos using dou‐ ble the amount of temporary disk space - the encrypted archive must be written as a separate, rather than replacement, file within the temp directory that sos writes the archive to. However, since the encrypted archive will be the same size as the original archive, there is no additional space consumption once the temporary directory is re‐ moved at the end of execution. This means that only the encrypted archive is present on disk after sos finishes run‐ ning. If encryption fails for any reason, the original unencrypted archive is preserved in‐ stead." }, { "flag": "", "long": "--encrypt-pass", "arg": "PASS", "description": "The same as --encrypt-key, but use the provided PASS for symmetric encryption rather than key-pair encryption." }, { "flag": "", "long": "--batch", "arg": null, "description": "Generate archive without prompting for interactive input." }, { "flag": "", "long": "--name", "arg": "NAME", "description": "Deprecated. See --label" }, { "flag": "", "long": "--label", "arg": "LABEL", "description": "Specify an arbitrary identifier to associate with the archive. Labels will be ap‐ pended after the system's short hostname and may contain alphanumeric characters." }, { "flag": "", "long": "--threads", "arg": "THREADS", "description": "Specify the number of threads sos report will use for concurrency. Defaults to 4." }, { "flag": "", "long": "--plugin-timeout", "arg": "TIMEOUT", "description": "Specify a timeout in seconds to allow each plugin to run for. A value of 0 means no timeout will be set. A value of -1 is used to indicate the default timeout of 300 sec‐ onds. Note that this option sets the timeout for all plugins. If you want to set a timeout for a specific plugin, use the 'timeout' plugin option available to all plugins - e.g. '-k logs.timeout=600'. The plugin-specific timeout option will override this option. For example, using '--plugin-timeout=60 -k logs.timeout=600' will set a timeout of 600 seconds for the logs plugin and 60 seconds for all other enabled plugins." }, { "flag": "", "long": "--cmd-timeout", "arg": "TIMEOUT", "description": "Specify a timeout limit in seconds for a command execution. Same defaults logic from --plugin-timeout applies here. This option sets the command timeout for all plugins. If you want to set a cmd timeout for a specific plugin, use the 'cmd-timeout' plugin option available to all plugins - e.g. '-k logs.cmd-timeout=600'. Again, the same plugin/global precedence logic as for --plugin-timeout applies here. Note that setting --cmd-timeout (or -k logs.cmd-timeout) high should be followed by increasing the --plugin-timeout equivalent, otherwise the plugin can easily timeout on slow commands execution." }, { "flag": "", "long": "--namespaces", "arg": "NAMESPACES", "description": "For plugins that iterate collections over namespaces that exist on the system, for ex‐ ample the networking plugin collecting `ip` command output for each network namespace, use this option to limit the number of namespaces that will be collected. Use '0' (default) for no limit - all namespaces will be used for collections. Note that specific plugins may provide a similar `namespaces` plugin option. If the plugin option is used, it will override this option." }, { "flag": "", "long": "--container-runtime", "arg": "RUNTIME", "description": "Force the use of the specified RUNTIME as the default runtime that plugins will use to collect data from and about containers and container images. By default, the setting of auto results in the local policy determining what runtime will be the default run‐ time (in configurations where multiple runtimes are installed and active). If no container runtimes are active, this option is ignored. If there are runtimes ac‐ tive, but not one with a name matching RUNTIME, sos will abort. Setting this to none, off, or disabled will cause plugins to NOT leverage any active runtimes for collections. Note that if disabled, plugins specifically for runtimes (e.g. the podman or docker plugins) will still collect general data about the runtime, but will not inspect existing containers or images. Default: 'auto' (policy determined)" }, { "flag": "", "long": "--case-id", "arg": "NUMBER", "description": "Specify a case identifier to associate with the archive. Identifiers may include al‐ phanumeric characters, commas and periods ('.')." }, { "flag": "", "long": "--build", "arg": null, "description": "Do not archive copied data. Causes sos report to leave an uncompressed archive as a temporary file or directory tree." }, { "flag": "", "long": "--debug", "arg": null, "description": "Enable interactive debugging using the python debugger. Exceptions in sos or plug-in code will cause a trap to the pdb shell." }, { "flag": "", "long": "--dry-run", "arg": null, "description": "Execute plugins as normal, but do not collect any file content, command output, or string data from the system. The resulting logs may be used to understand the actions that sos would have taken without the dry run option." }, { "flag": "", "long": "--estimate-only", "arg": null, "description": "Estimate disk space requirements when running sos report. This can be valuable to pre‐ vent sos report working dir to consume all free disk space. No plugin data is avail‐ able at the end. Plugins will be collected sequentially, size of collected files and commands outputs will be calculated and the plugin files will be immediately deleted prior execution of the next plugin. This still can consume whole free disk space, though. Please note, size estimations may not be accurate for highly utilized systems due to changes between an estimate and a real execution. Also some difference between estima‐ tion (using `stat` command) and other commands used (i.e. `du`). A rule of thumb is to reserve at least double the estimation." }, { "flag": "", "long": "--upload", "arg": null, "description": "If specified, attempt to upload the resulting archive to a vendor defined location. This option is implied if --upload-url is used. You may be prompted for a username and password if these are not defined by the vendor as well. If these credentials are not provided, sos will still run and create an ar‐ chive but will not attempt an automatic upload, instead relying on the end user to up‐ load it as needed. The sos report archive will still remain on the local filesystem even after a success‐ ful upload. Note that depending on the distribution sos is being run on, or the vendor policy de‐ tected during execution, there may be dependencies that are not strictly required by the package at installation time. For example, for HTTPS uploads the python-requests library must be available. If this library is not available, HTTPS uploads will not be attempted." }, { "flag": "", "long": "--upload-url", "arg": "URL", "description": "If a vendor does not provide a default upload location, or if you would like to upload the archive to a different location, specify the address here. A support protocol MUST be specified in this URL. Currently uploading is supported for HTTPS, SFTP, and FTP protocols. If your destination server listens on a non-standard port, specify the listening port in the URL." }, { "flag": "", "long": "--upload-user", "arg": "USER", "description": "If a vendor does not provide a default user for uploading, specify the username here. If this option is unused and upload is request, and a vendor default is not set, you will be prompted for one. If --batch is used and this option is omitted, no username will be collected and thus uploads will fail if no vendor default is set. You also have the option of providing this value via the SOSUPLOADUSER environment variable. If this variable is set, then no username prompt will occur and --batch may be used provided all other required values (case number, upload password) are pro‐ vided. This option is ignored when uploading to the Red Customer Portal or Red Hat Secure FTP server in favour of web token authentication." }, { "flag": "", "long": "--upload-pass", "arg": "PASS", "description": "Specify the password to use for authentication with the destination server. If this option is omitted and upload is requested, you will be prompted for one. If --batch is used, this prompt will not occur, so any uploads are likely to fail un‐ less this option is used. Note that this may result in the plaintext string appearing in `ps` output that may be collected by sos and be in the archive. If a password must be provided by you for up‐ loading, it is strongly recommended to not use --batch and enter the password when prompted rather than using this option. You also have the option of providing this value via the SOSUPLOADPASSWORD environment variable. If this variable is set, then no password prompt will occur and --batch may be used provided all other required values (case number, upload user) are provided. This option is ignored when uploading to the Red Customer Portal or Red Hat Secure FTP server in favour of web token authentication." }, { "flag": "", "long": "--upload-directory", "arg": "DIR", "description": "Specify a directory to upload to, if one is not specified by a vendor default location or if your destination server does not allow writes to '/'." }, { "flag": "", "long": "--upload-method", "arg": "METHOD", "description": "Specify the HTTP method to use for uploading to the provided --upload-url. Valid val‐ ues are 'auto' (default), 'put', or 'post'. The use of 'auto' will default to the method required by the policy-default upload location, if one exists. This option has no effect on upload protocols other than HTTPS." }, { "flag": "", "long": "--upload-no-ssl-verify", "arg": null, "description": "Disable SSL verification for HTTPS uploads. This may be used to allow uploading to lo‐ cations that have self-signed certificates, or certificates that are otherwise un‐ trusted by the local system. Default behavior is to perform SSL verification against all upload locations." }, { "flag": "", "long": "--upload-protocol", "arg": "PROTO", "description": "Manually specify the protocol to use for uploading to the target upload-url. Normally this is determined via the upload address, assuming that the protocol is part of the address provided, e.g. 'https://example.com'. By using this option, sos will skip the protocol check and use the method defined for the specified PROTO. For RHEL systems, setting this option to sftp will skip the initial attempt to upload to the Red Hat Customer Portal, and only attempt an upload to Red Hat's SFTP server, which is typically used as a fallback target. Valid values for PROTO are: 'auto' (default), 'https', 'ftp', 'sftp'." }, { "flag": "", "long": "--experimental", "arg": null, "description": "Enable plugins marked as experimental. Experimental plugins may not have been tested for this port or may still be under active development. --help Display usage message." } ], "examples": [], "see_also": [ { "name": "sos", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/sos/1/json" }, { "name": "sos-clean", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/sos-clean/1/json" }, { "name": "sos-collect", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/sos-collect/1/json" }, { "name": "sos.conf", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/sos.conf/5/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 1, "subsections": [ { "name": "sos report", "lines": 43 } ] }, { "name": "DESCRIPTION", "lines": 12, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-l, --list-plugins", "lines": 3, "flag": "-l", "long": "--list-plugins" }, { "name": "-n, --skip-plugins PLUGNAME[,PLUGNAME]", "lines": 3, "flag": "-n", "long": "--skip-plugins" }, { "name": "-e, --enable-plugins PLUGNAME[,PLUGNAME]", "lines": 7, "flag": "-e", "long": "--enable-plugins" }, { "name": "-o, --only-plugins PLUGNAME[,PLUGNAME]", "lines": 3, "flag": "-o", "long": "--only-plugins" }, { "name": "-k --plugin-option=PLUGNAME.PLUGOPT[=VALUE], --plugopts=PLUG", "lines": 1, "flag": "-k", "long": "--plugopts", "arg": "PLUG" }, { "name": "NAME.PLUGOPT[=VALUE]", "lines": 3 }, { "name": "-a, --alloptions", "lines": 2, "flag": "-a", "long": "--alloptions" }, { "name": "-v, --verbose", "lines": 3, "flag": "-v", "long": "--verbose" }, { "name": "-q, --quiet", "lines": 2, "flag": "-q", "long": "--quiet" }, { "name": "--no-report", "lines": 2, "long": "--no-report" }, { "name": "--config-file CONFIG", "lines": 2, "long": "--config-file", "arg": "CONFIG" }, { "name": "--no-postproc", "lines": 9, "long": "--no-postproc" }, { "name": "--preset PRESET", "lines": 27, "long": "--preset", "arg": "PRESET" }, { "name": "--list-presets", "lines": 2, "long": "--list-presets" }, { "name": "--desc DESCRIPTION", "lines": 3, "long": "--desc", "arg": "DESCRIPTION" }, { "name": "-s, --sysroot SYSROOT", "lines": 3, "flag": "-s", "long": "--sysroot", "arg": "SYSROOT" }, { "name": "-c, --chroot {auto|always|never}", "lines": 5, "flag": "-c", "long": "--chroot" }, { "name": "--tmp-dir DIRECTORY", "lines": 2, "long": "--tmp-dir", "arg": "DIRECTORY" }, { "name": "--list-profiles", "lines": 2, "long": "--list-profiles" }, { "name": "-p, --profile, --profiles NAME", "lines": 10, "flag": "-p", "long": "--profiles", "arg": "NAME" }, { "name": "--verify", "lines": 5, "long": "--verify" }, { "name": "--log-size", "lines": 13, "long": "--log-size" }, { "name": "--journal-size", "lines": 7, "long": "--journal-size" }, { "name": "--all-logs", "lines": 4, "long": "--all-logs" }, { "name": "--since YYYYMMDD[HHMMSS]", "lines": 5, "long": "--since" }, { "name": "--skip-commands COMMANDS", "lines": 6, "long": "--skip-commands", "arg": "COMMANDS" }, { "name": "--skip-files FILES", "lines": 4, "long": "--skip-files", "arg": "FILES" }, { "name": "--allow-system-changes", "lines": 2, "long": "--allow-system-changes" }, { "name": "--low-priority", "lines": 6, "long": "--low-priority" }, { "name": "--encrypt", "lines": 18, "long": "--encrypt" }, { "name": "--encrypt-key KEY", "lines": 22, "long": "--encrypt-key", "arg": "KEY" }, { "name": "--encrypt-pass PASS", "lines": 3, "long": "--encrypt-pass", "arg": "PASS" }, { "name": "--batch", "lines": 2, "long": "--batch" }, { "name": "--name NAME", "lines": 2, "long": "--name", "arg": "NAME" }, { "name": "--label LABEL", "lines": 3, "long": "--label", "arg": "LABEL" }, { "name": "--threads THREADS", "lines": 2, "long": "--threads", "arg": "THREADS" }, { "name": "--plugin-timeout TIMEOUT", "lines": 12, "long": "--plugin-timeout", "arg": "TIMEOUT" }, { "name": "--cmd-timeout TIMEOUT", "lines": 13, "long": "--cmd-timeout", "arg": "TIMEOUT" }, { "name": "--namespaces NAMESPACES", "lines": 9, "long": "--namespaces", "arg": "NAMESPACES" }, { "name": "--container-runtime RUNTIME", "lines": 15, "long": "--container-runtime", "arg": "RUNTIME" }, { "name": "--case-id NUMBER", "lines": 3, "long": "--case-id", "arg": "NUMBER" }, { "name": "--build", "lines": 3, "long": "--build" }, { "name": "--debug", "lines": 3, "long": "--debug" }, { "name": "--dry-run", "lines": 4, "long": "--dry-run" }, { "name": "--estimate-only", "lines": 14, "long": "--estimate-only" }, { "name": "--upload", "lines": 19, "long": "--upload" }, { "name": "--upload-url URL", "lines": 9, "long": "--upload-url", "arg": "URL" }, { "name": "--upload-user USER", "lines": 14, "long": "--upload-user", "arg": "USER" }, { "name": "--upload-pass PASS", "lines": 19, "long": "--upload-pass", "arg": "PASS" }, { "name": "--upload-directory DIR", "lines": 3, "long": "--upload-directory", "arg": "DIR" }, { "name": "--upload-method METHOD", "lines": 6, "long": "--upload-method", "arg": "METHOD" }, { "name": "--upload-no-ssl-verify", "lines": 6, "long": "--upload-no-ssl-verify" }, { "name": "--upload-protocol PROTO", "lines": 12, "long": "--upload-protocol", "arg": "PROTO" }, { "name": "--experimental", "lines": 5, "long": "--experimental" } ] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] }, { "name": "MAINTAINER", "lines": 2, "subsections": [ { "name": "AUTHORS & CONTRIBUTORS", "lines": 5 } ] } ] } }