第12章 参考資料

管理 CLI は、サーバーの起動と停止、アプリケーションのデプロイとアンデプロイ、システム設定の構成、およびその他の管理タスクの実行に役立つ多数のコマンドと引数をサポートしています。

このセクションの表を使用して、管理 CLI コマンドと引数の説明を表示します。

12.1. 管理 CLI の起動時の引数

以下の表には、jboss-cli スクリプトに渡して管理 CLI を起動できる引数が記載されています。

表12.1 管理 CLI の引数

引数説明

--bind

CLI がバインドされるアドレスを指定します。指定のない場合、CLI は必要に応じて自動的にアドレスを選択します。

--command

CLI セッションで実行される単一のコマンドまたは操作を指定します。コマンドまたは操作の実行後、CLI はセッションを即座に終了します。

--command-timeout

コマンドが完了するまで待機する最大時間。0 の値はタイムアウトにならないことを意味します。デフォルトではタイムアウトは発生しません。

--commands

CLI セッションで実行されるコマンドおよび操作のコンマ区切りリストを指定します。最後のコマンドの実行後またはコマンドが失敗した場合、CLI セッションが終了します。

--connect, -c

CLI が起動時にコントローラーに接続するよう指示します。この引数を使用すると、後で connect コマンドを実行する必要がなくなります。

--controller

起動時に --connect オプションが指定された場合、または管理 CLI で引数のない connect コマンド実行された場合に接続するデフォルトのコントローラーホスト、ポート、およびプロトコル。デフォルトのホストは localhost、デフォルトのポートは 9990、デフォルトのプロトコルは remote+http になります。この代わりに、ホスト、ポート、およびプロトコル情報が含まれるコントローラーエイリアスを指定することもできます。

--echo-command

非対話モードで実行されたコマンドの出力にプロンプトおよびコマンドが含まれるようにします。

--error-on-interact

非対話モードでセキュリティー関連の入力のプロンプトを無効にします。CLI プロセスの続行に入力が必要な場合、プロセスは突然エラーによって終了されます。

--file

非対話的に実行されるコマンドおよび操作 (1 行ずつ記述) が含まれるファイルへのパスを指定します。最後のコマンドの実行後またはコマンドが失敗した場合、CLI セッションが終了します。

--gui

コマンドラインインターフェイスの上に構築された GUI を起動します。この GUI を使用した JBoss EAP 管理 CLI との対話はサポートされないため、設定の表示や CLI コマンドの構築のみに使用してください。

--help, -h

ヘルプメッセージを表示します。

--no-color-output

CLI 出力およびプロンプトのカラー出力を無効にします。

--no-local-auth

ファイルシステムを使用してトークンの交換によって管理されるサーバーへローカル実行されたことを CLI が実証できる、ローカル認証メカニズムを無効にします。

--no-output-paging

出力ページが表示された後に管理 CLI が一時停止する際の出力ページングを無効にします。これにより、出力の閲覧と検索が可能になります。このオプションを指定すると、出力全体がすぐに出力されます。

--output-json

操作の応答を純粋な JSON 形式で表示します。デフォルトでは、操作の応答は DMR 形式で表示されます。

--password, -p

コントローラーへの接続中に認証のパスワードを指定します。引数の指定がなく、認証が必須である場合、 connect コマンドの実行時にユーザーはパスワードの入力を求められます。

--properties

プロパティーと値のペアが含まれるプロパティーファイルへのパスを指定し、システムプロパティーを定義します。プロパティーファイルは標準の KEY=VALUE 構文を使用します。

--resolve-parameter-values

操作のリクエストをコントローラーに送信する前に、コマンド引数の値 (または操作パラメーター) の値として指定されたシステムプロパティーを解決します。

--timeout

接続に成功するまで待機する時間をミリ秒単位で指定します。デフォルトは 5000 です。

--user, -u

コントローラーにユーザー認証が必要な場合にユーザー名を指定します。引数の指定がなく、認証が必須である場合、connect コマンドの実行時にユーザーはユーザー名の入力を求められます。ユーザーが指定された場合、ローカル認証が自動的に無効になります。

--version

アプリケーションサーバーバージョンと環境情報を表示します。