ESCWA コマンド ライン オプション

構文：

escwa.exe [OPTION]...

オプション

引数付きのオプションは、「OPTION=ARG」または「OPTION ARG」として指定できます。

-c、--config=<file>

commonwebadmin.json の代わりに使用する構成ファイル。

-h、--help

パラメーター リストを表示します。

-s、--service

ESCWA をサービスとして実行している場合にのみ、このオプションを設定します。ESCWA をサービスとして実行する場合に必須となります。

注: このオプションは Windows の場合にのみ使用します。

-V、--version

使用している ESCWA のバージョンを表示します。

-w、--write[=<bool>]

ESCWA で加えた構成変更を構成ファイルに書き込みます。

--config も --<ConfigNode> も設定していない場合に、このオプションを指定しないと、暗黙的に true になります。

--config または --<ConfigNode> のいずれかを設定している場合に、このオプションを指定しないと、暗黙的に false になります。「TRUE」、「true」、「YES」、「yes」、および「1」はすべて true として解釈されます。その他の引数はすべて false として解釈されます。

デフォルト値は true です。

-u、--vault[=<bool>]

Secrets Vault の使用を有効または無効にします。「true」の場合、BasicConfig.VaultSpecification の値が有効であれば使用されます。「TRUE」、「true」、「YES」、「yes」、および「1」はすべて true として解釈されます。その他の引数はすべて false として解釈されます。

デフォルト値は true です。

-p、--shutdown [<user> [<password>]]

実行中の ESCWA インスタンスをシャットダウンします。複数の ESCWA インスタンスが実行されている場合は、構成ファイルの場所でインスタンスを指定します。ESCWA が制限されている場合は、Common Web Administration クラスのコントロール リソースに対する実行権限を持つユーザーを指定する必要があります。ESCWA を Windows サービスとして実行している場合、このコマンドでシャットダウンすることはできません。

--<ConfigNode>[<.<ConfigNode>>...]=<value>

構成ファイル内の指定されたノードを指定された値でオーバーライドします。構成ファイルは JSON であり、オプションの形式はその構造を反映しています。構成ファイル内のノードをピリオド (「.」) で区切られたリストで指定し、最初のノードはいずれかのルート ノードで、後続の各ノードはその前のノードの子です。たとえば、--TraceConfig.TraceEnabled は、ルート ノード TraceConfig の設定 TraceEnabled に対応します。

配列内の要素には、整数をノードとして使用してアクセスできます。JSON 配列には 0 から始まるインデックスが付けられます。たとえば、--MfdsList.1.MfdsHost は、ルート ノードでもある配列 MfdsList の 2 番目の項目の設定 MfdsHost に対応します。

最終的に指定するノードは、ファイルのリーフ ノードにする必要はありません。JSON オブジェクトおよび配列全体をオーバーライドできます。要素は、「+」を使用して子ノードとして配列に追加できます。たとえば、--MfdsList.+ により、指定した要素が MfdsList に追加されます。

引数は、指定された設定に応じて、数値、文字列、ブール値、JSON 配列、または JSON オブジェクトになります。ブール値の場合、「TRUE」、「true」、「YES」、「yes」、および「1」はすべて true として解釈されます。その他の値はすべて false として解釈されます。JSON オブジェクトまたは配列をオーバーライドする場合、指定する JSON オブジェクトまたは配列は、元の JSON と構造が同一の正確で完全な JSON にする必要があり (配列内の項目数は、0 を含む異なる数にできます。例：--MfdsList=[])、コマンド ラインに関してはエスケープする必要があります。引用符で囲まれていない項目はエスケープする必要はありません。エスケープ要件はプラットフォームによって異なります。次に例を示します。

--TraceConfig="{\"TraceEnabled\":false,\"TraceLevel\":0,\"TraceFileName\":\"\/home\/user\/trace file\", ... }"

オプションの構成ブロック (K8sConfig など) は、適切で有効な JSON オブジェクトを引数として渡して追加したり、「null」を引数として渡して削除したりできます。使用可能な設定およびその値については、commonwebadmin.json ファイルを参照してください。