LoginSignup
1
3

More than 5 years have passed since last update.

@professor

sosreport 日本語訳

Posted at

はじめに

以下はRedhat系OSで提供されているsosパッケージに含まれるsosreportコマンドに関するmanpageの和訳であり、sos-3.3-5.el7.centos.noarch の英語版manpageを元に作成しています。

翻訳の誤り等があればご指摘ください。

ご注意

sosパッケージはGPLv2で提供されています。
転載、転記は自由ですが、この記事もGPLv2に準拠したものとなるかと思いますので、ご注意ください。

名前

sosreport - 診断データとサポートデータを収集してパッケージ化する

SYNOPSIS

       sosreport
                 [-l|--list-plugins]
                 [-n|--skip-plugins plugin-names]
                 [-e|--enable-plugins plugin-names]
                 [-o|--only-plugins plugin-names]
                 [-a|--alloptions] [-v|--verbose]
                 [-k plug.opt|--plugin-option plug.opt]
                 [--no-report] [--config-file conf]
                 [--batch] [--build] [--debug]
                 [--name name] [--case-id id] [--ticket-number nr]
                 [-s|--sysroot SYSROOT]
                 [-c|--chroot {auto|always|never}
                 [--tmp-dir directory]
                 [-p|--profile profile-name]
                 [--list-profiles]
                 [--verify]
                 [--log-size]
                 [--all-logs]
                 [-z|--compression-type method]
                 [--experimental]
                 [-h|--help]

DESCRIPTION

sosreport generates an archive of configuration and diagnostic information from the running system. The archive may be stored locally or centrally for recording or tracking
purposes or may be sent to technical support representatives, developers or system administrators to assist with technical fault-finding and debugging.

sosreportは、実行中のシステムから構成情報と診断情報のアーカイブを生成します。 アーカイブは、記録または追跡のためにローカルまたは中央で保存することができます

Sos is modular in design and is able to collect data from a wide range of subsystems and packages that may be installed. An XML or HTML report summarizing the collected information is optionally generated and stored within the archive.

Sosはモジュール式設計であり、インストール可能なさまざまなサブシステムおよびパッケージからデータを収集することができます。 収集された情報を要約するXMLまたはHTMLレポートを任意に生成し、アーカイブ内に格納します。

OPTIONS

  • -l, --list-plugins
    使用可能なすべてのプラグインとそのオプションを一覧表示します。 現在の構成では有効にならないプラグインは別々に表示されます。

    List all available plugins and their options. Plug-ins that would not be enabled by the current configuration are listed separately.

  • -n, --skip-plugins PLUGNAME[,PLUGNAME]
    指定したプラグインを無効にします。 複数のプラグインは、オプションを繰り返すかカンマで区切って指定することができます。

    Disable the specified plugin(s). Multiple plug-ins may be specified by repeating the option or as a comma-separated list.

  • -e, --enable-plugins PLUGNAME[,PLUGNAME]
    指定したプラグインを有効にします。 複数のプラグインは、オプションを繰り返すかカンマで区切って指定することができます。

    Enable the specified plugin(s). Multiple plug-ins may be specified by repeating the option or as a comma-separated list.

  • -o, --only-plugins PLUGNAME[,PLUGNAME]
    指定したプラグインのみを有効にします（他のすべてのプラグインは無効にする必要があります）。 複数のプラグインは、オプションを繰り返すかカンマで区切って指定することができます。

    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.

  • -k PLUGNAME.PLUGOPT[=VALUE], --plugin-option=PLUGNAME.PLUGOPT[=VALUE]
    プラグインオプションを指定します。 オプション "PLUGOPT"を有効にするか、プラグイン "PLUGNAME"を指定された値に設定します。

    Specify plug-in options. The option PLUGOPT is enabled, or set to the specified value in the plug-in PLUGNAME.

  • -a, --alloptions
    すべての有効なプラグインに対して、すべてのオプションをTrueに設定します。

    Set all boolean options to True for all enabled plug-ins.

  • -v, --verbose
    より詳細にロギングを行います。 追加のデバッグメッセージを有効にするために複数回指定することができます。

    Increase logging verbosity. May be specified multiple times to enable additional debugging messages.

  • -q, --quiet
    致命的エラーのみを標準エラー出力に出力します。

    Only log fatal errors to stderr.

  • --no-report
    HTML/XML形式の出力を無効化します

    Disable HTML/XML report writing.

  • --config-file CONFIG
    追加の設定ファイルを指定します

    Specify alternate configuration file.

  • -s, --sysroot SYSROOT
    追加のrootファイルシステムを追加します。コンテナやイメージのレポートを採取するとき有用です

    Specify an alternate root file system path. Useful for collecting reports from containers and images.

  • -c, --chroot {auto|always|never}
    chrootモードを設定します。 --sysrootが使用されると、コマンドはデフォルトでSYSROOTをルートディレクトリとして実行します（特定のプラグインによって無効にされていない限り）。 これは、--chrootを "always"（alwyas chroot）または "never"（常にホスト名前空間で実行）に設定することで上書きできます。

    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 overriden by setting --chroot to "always" (alwyas chroot) or "never" (always run in the host namespace).

  • --tmp-dir DIRECTORY
    圧縮されたレポートと同様に、データをコピーする追加の一時ディレクトリを指定します。

    Specify alternate temporary directory to copy data as well as the compressed report.

  • --list-profiles
    使用可能なプロファイルと、それらが有効にしているプラグインのリストを表示します。

    Display a list of available profiles and the plugins that they enable.

  • -p, --profile NAME
    指定されたプロファイルに対応するプラグインのみを実行します。 マルチプルプロファイルはコンマ区切りのリストとして指定できます。 実行されるプラグインのセットは、各プロファイルのプラグインセットの和集合です。 現在定義されているプロファイルには、 boot, cluster, desktop, debug, hardware, identity, network, openstack, packagemanager, security, services, storage, sysmgmt, system, performance, virt, そして webserverがあります

    Only run plugins that correspond to the given profile. Multple profiles may be specified as a comma-separated list; the set of plugins executed is the union of each of the profile's plugin sets. Currently defined profiles include: boot, cluster, desktop, debug, hardware, identity, network, openstack, packagemanager, security, services, storage, sysmgmt, system, performance, virt, and webserver.

  • --verify
    データ収集中にプラグイン固有の検証を実行するようにプラグインに指示します。 これには、パッケージマネージャー検証、ログ整合性テスト、またはその他のプラグイン定義の動作が含まれます。 --verifyを使用すると、レポートの生成に要する時間がかなり長くなる可能性があります。

    Instructs plugins to perform plugin-specific verification during data collection. This may include package manager verification, log integrity testing or other plugin defined behaviour. Use of --verify may cause the time taken to generate a report to be considerably longer.

  • --log-size
    収集するログセットのサイズにグローバルな制限を設定します。
    この制限は、すべてのプラグインによって収集されるログごとに個別に適用されます。

    Places a global limit on the size of any collected set of logs. The limit is applied separately for each set of logs collected by any plugin.

  • --all-logs
    すべてのサイズ制限を無視し、デフォルト以外の場所のログも含めて、可能なすべてのログデータを収集するようにプラグインに指示します。 このオプションを使用すると、レポートのサイズが大幅に増加する可能性があります。

    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 reports.

  • -z, --compression-type METHOD
    アクティブなポリシーで指定されているデフォルトの圧縮タイプを上書きします。

    Override the default compression type specified by the active policy.

  • --batch
    対話的な入力を求めるプロンプトを表示せずにアーカイブを生成します。

    Generate archive without prompting for interactive input.

  • --name NAME
    アーカイブに使用する名前を指定します。

    Specify a name to be used for the archive.

  • --case-id NUMBER
    アーカイブに関連付けるケース識別子を指定します。 識別子には、英数字、カンマおよびピリオド（ '.'）を含めることができます。 --ticket-numberと同義です。

    Specify a case identifier to associate with the archive. Identifiers may include alphanumeric characters, commas and periods ('.'). Synonymous with --ticket-number.

  • --ticket-number NUMBER
    アーカイブに関連付けるチケット番号またはその他の識別子を指定します。 識別子には、英数字、カンマおよびピリオド（ '.'）を含めることができます。 -case-idと同義です。

    Specify a ticket number or other identifier to associate with the archive. Identifiers may include alphanumeric characters, commas and periods ('.'). Synonymous with --case-id.

  • --build
    コピーしたデータをアーカイブ化しません。 これによってsosreportは、圧縮されていないアーカイブを一時ファイルまたはディレクトリツリーとして残します。

    Do not archive copied data. Causes sosreport to leave an uncompressed archive as a temporary file or directory tree.

  • --debug
    Pythonデバッガを使用してインタラクティブなデバッグを有効にします。 sosまたはプラグインコードの例外は、pdbシェルへのトラップを引き起こします。

    Enable interactive debugging using the python debugger. Exceptions in sos or plug-in code will cause a trap to the pdb shell.

  • --experimental
    実験的とマークされたプラグインを有効にします。 実験的なプラグインはこのポートでテストされていないか、まだ開発途中である可能性があります。

    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.

最後に

sosreportの作者、および英語版manpageを作成された著者の方々に感謝致します。

1
3
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
1
3