メインコンテンツまでスキップ
Sumo Logic Japanese

コマンド ライン インストーラのパラメータ

次の表に、コマンド ライン インストーラを使用してコレクタをインストールする際に使用できるすべてのパラメータの一覧を示します。コレクタのインストールの詳細と例については、「Linux へのコレクタのインストール」「MacOS へのコレクタのインストール」、および「Windows へのコレクタのインストール」をそれぞれ参照してください。 

パラメータ 説明

-console

 

-q と併用する場合にのみ効果があります。インストーラの進捗状況を示すメッセージを (インストーラを GUI またはコマンド ライン モードのどちらで実行している場合でも) コンソールに表示します。

Windows の場合、このオプションを有効にするにはインストーラを start /wait を使用して実行する必要があります。例:

start /wait installer.exe -q -console

-q

インストーラをクワイエット モードで実行し、インストール パラメータの入力を促すメッセージを表示しません。コマンド ラインで指定しなかったインストール パラメータについては、デフォルト値が使用されます。-console パラメータを一緒に指定しないと、コンソールには何も出力されません。  新規にコレクタをインストールする場合は、クワイエット モードを指定した場合でも承認トークン (またはアクセス ID/アクセス キー) の入力が求められます。

-Vsumo.token_and_url=[token]

このオプションまたはアクセス ID/アクセス キー オプションのいずれかの認証オプション (この表の次の項目を参照) は必須です。

Sumo Logic からインストールのためのワンタイム トークンが発行されている場合は、このパラメータで指定してください。

-Vsumo.accessid=[accessId]

-Vsumo.accesskey=[accessKey]

このオプションまたはトークン オプションのいずれかの認証オプション (この表の前の項目を参照) は必須です。

Sumo Logic のアクセス ID とアクセス キーを持っている場合は、両方とも指定してください。

-Vsumo.accessid-Vsumo.accesskey

システム管理者は、Web アプリケーションの [Preferences (環境設定)] ページでアクセス ID/アクセス キーのペアを生成できます。「アクセス キー」を参照してください。

-dir [directory]

デフォルト以外のインストール ディレクトリを指定します。

-Vcollector.name=[name]

Sumo Logic で使用するコレクタの名前を設定します。

-Vcollector.url=[url]

データ コレクション API 用にコレクタを登録するために使用する URL を設定します。

-Vproxy.host=[host]

プロキシ サーバを使用する場合にプロキシ ホストを設定します。

-Vproxy.port=[port]

プロキシ サーバを使用する場合にプロキシ ポートを設定します。

-Vproxy.user=[username]

プロキシ サーバで認証を使用する場合にプロキシ ユーザを設定します。

-Vproxy.password=[password]

プロキシ サーバで認証を使用する場合にプロキシ パスワードを設定します。

-Vproxy.ntlmdomain=[NTLM domain]

プロキシ サーバで NTLM 認証を使用する場合に NTLM ドメインを設定します。

 

-Vsources=[filepath]

登録時に設定するソースを記述した、UTF-8 でエンコードされた JSON ファイルの場所を設定します。コレクタの設定後にソースを変更したい場合は、コレクタ管理 API または Sumo Web アプリケーションを使用します。

-VsyncSources=[filepath]

登録時に設定するソースを記述した、UTF-8 でエンコードされた JSON ファイルの場所を設定します。このパラメータで指定したファイルは継続してモニタリングされ、コレクタの設定と同期されます。

syncSources パラメータの設定の詳細については、「ローカル設定ファイル管理」を参照してください。

-Vephemeral=[true/false]

true に設定すると、コレクタはオフライン状態で 12 時間後に削除されます。

-Vclobber=[true/false]

true に設定すると、同じ名前のコレクタがすでに存在する場合は、既存のコレクタが削除されます。

-VrunAs.username=[username]

設定すると、コレクタは指定されたユーザとして実行されます (Windows と Linux の場合)。

Windows では、
ユーザ アカウントが Log on as a Service 権限を持っている必要があります。

-VwinRunAs.password=[password]

(Windows のみ) -VrunAs.username と一緒に設定すると、コレクタは指定されたユーザとして指定されたパスワードで実行されます

-VskipRegistration=[true/false]

true に設定すると、コレクタはファイルをインストールして user.properties ファイルを作成しますが、コレクタの登録や起動は行いません。このオプションは、コレクタが AMI イメージの起動時に自動的に起動して登録するように、コレクタを AMI イメージに「焼く」場合に使用します。
注意: このオプションを使用する場合は、アクセス ID/アクセス キーによる資格情報が必要です。

詳細については、「Linux マシン イメージへのコレクタの追加」または「Windows マシン イメージへのコレクタの追加」を参照してください。

-Vcollector.secureFiles=[true|false]

デフォルトでは、新しいコレクタのインストールには、ファイル システム セキュリティ強化機能を使用します。インストール時にこの機能を無効にするには、次のコマンド ライン引数を指定します。
-Vcollector.secureFiles=false

-VhostName=[hostname]

* コレクタ バージョン 19.182 以降で使用できます。

コレクタが動作しているマシンのホスト名。
例:

-VhostName="My Host"

ホスト名は最大 128 文字です。

-VtimeZone=[timezone]

* コレクタ バージョン 19.182 以降で使用できます。

タイム ゾーンをタイム スタンプから抽出できない場合に使用するタイム ゾーン。
例:

-VtimeZone=America/Los_Angeles

指定できる値については、この Wikipedia 記事の「TZ」の列を参照してください。

-Vcategory=[category]

* コレクタ バージョン 19.182 以降で使用できます。

ソースでカテゴリが指定されていない場合に使用するソース カテゴリ。
例:

 -Vcategory=auth_logs

-VtargetCPU=[target]

* コレクタ バージョン 19.182 以降で使用できます。

CPU ターゲットを設定することで、コレクタが使用できる CPU リソースの量を制限できます。  値は、整数のパーセント値で指定します。
例:

-VtargetCPU=20

コレクタは、使用する最大 CPU リソースの量を 20% に制限します。  詳細については、 「コレクタが使用する CPU ターゲットの設定」を参照してください。

-Vdescription=[description]

* コレクタ バージョン 19.182 以降で使用できます。

Sumo Logic に表示するコレクタの説明。
例:

-Vdescription="This Collector will send Apache logs from our Production environment."

-VdisableScriptSource=[true/false]

組織の内部ポリシーによってスクリプトの使用が制限されている場合は、スクリプト ベース ソースの実行を無効にできます。このパラメータが渡されると、このコレクタではスクリプト ソースは実行されなくなります。

-VdisableActionSource=[true/false]

組織の内部ポリシーによってスクリプト アクションの使用が制限されている場合は、スクリプト ベースのアクション ソースの作成を無効にできます。このパラメータが渡されると、このコレクタではアクション ソースは実行されなくなります。

-VdisableUpgrade=[true/false]

true に設定すると、コレクタは Sumo Logic からのアップグレード リクエストを拒否します。

-varfile [fileName]

コマンド ラインで引数を渡す代わりに、引数が登録されたファイルを (-V フラグを指定せずに) 指定することができます。  多くのオペレーティング システムでは、他のユーザが所有するプロセスに関する情報をリストで指定できるため、-varfile オプションを使用して Sumo Logic の資格情報を指定することをお勧めします。

例: コレクタのインストール時に資格情報を渡すには、sumo_credentials.txt というファイルを次の内容で作成します。

sumo.accessid=<access id>
sumo.accesskey=<access key>
proxy.host=<proxy host>
proxy.port=<proxy port>

そして、このファイルを次のコマンド ラインで渡します。

sudo ./SumoCollector.sh -q -varfile /path/to/sumo_credentials.txt

-VskipAccessKeyRemoval=[true/false]

true に設定すると、user.properties ファイルからのアクセス キーの削除をスキップします。(デフォルトでは、コレクタが Sumo サービスに正しく登録された後に accesskeyuser.properties から削除します。)

 

  • この記事は役に立ちましたか?