第6章 管理 CLI の設定
管理 CLI の特定の設定は、設定ファイル jboss-cli.xml でカスタマイズできます。このファイルは EAP_HOME/bin ディレクトリーか、jboss.cli.config システムプロパティーで指定されたカスタムディレクトリーに存在する必要があります。
jboss-cli.xml ファイルでは以下の要素を設定できます。
default-protocol-
プロコトルの指定がない状態でコントローラーアドレスが提供された場合に使用するデフォルトのプロトコル。デフォルトは
remote+httpです。ポート9990が使用され、プロトコルの指定がない場合はuse-legacy-override属性がfalseに設定されていない限り、プロトコルは自動的にデフォルトのremotingに指定されます。 default-controllerconnectコマンドがパラメーターの指定なしで実行された場合に接続するコントローラーの設定。管理 CLI が引数--controller=またはcontroller=で開始された場合、引数に指定された値は設定のdefault-controller定義よりも優先されます。-
protocol- コントローラーのプロトコル名。指定のない場合、default-protocolの値が使用されます。 -
host- コントローラーのホスト名。デフォルトはlocalhostです。 -
port- コントローラーに接続するポート番号。デフォルト値は9990です。
-
controllersjboss-cli.xmlファイルに接続コントローラーのエイリアスを定義できます。以下に例を示します。<!-- The default controller to connect to when 'connect' command is executed w/o arguments --> <default-controller> <host>localhost</host> <port>9990</port> </default-controller> <!-- CLI connection controller aliases --> <controllers> <controller name="ServerOne"> <protocol>remoting</protocol> <host>192.168.3.45</host> <port>9990</port> </controller> <controller name="ServerTwo"> <protocol>http-remoting</protocol> <host>192.168.3.46</host> </controller> </controllers>コントローラー要素の
name属性は、--controller=引数の値として使用する必要があります。例:--controller=ServerTwovalidate-operation-requests-
実行のリクエストをコントローラーに送信する前に、操作リクエストのパラメーターリストを検証するかどうか。デフォルトは
trueです。 historyCLI コマンド履歴ログの設定。
-
enabled-historyを有効にするかどうか。デフォルトはtrueです。 -
file-name- 履歴を保存するファイル名。デフォルトは.jboss-cli-historyです。 -
file-dir- 履歴が保存されるディレクトリー。デフォルトはユーザーのホームディレクトリーです。 -
max-size- 履歴ファイルに格納されるコマンドの最大数。デフォルトは500です。
-
resolve-parameter-values-
操作のリクエストをコントローラーに送信する前に、コマンド引数 (または操作パラメーター) の値として指定されたシステムプロパティーを解決するかどうか。デフォルトは
falseです。 connection-timeout-
コントローラーで接続を確立できる期間 (ミリ秒単位)。デフォルトは
5000です。 sslSSL に使用されるキーストアおよびトラストストアの設定。
警告Red Hat では、影響するすべてのパッケージで TLSv1.1 または TLSv1.2 を利用するために SSLv2、SSLv3、および TLSv1.0 を明示的に無効化することを推奨しています。
-
vault- vault の設定。codeとmoduleの指定がない場合、デフォルトの実装が使用されます。codeは指定され、moduleは指定されていない場合、Picketbox モジュールで指定されたクラスを探します。moduleとcodeが指定されている場合、module によって指定されたモジュールのコードによって指定されたクラスを探します。 -
key-store- キーストア。 -
key-store-password- キーストアのパスワード。 -
alias- エイリアス。 -
key-password- キーのパスワード。 -
trust-store- トラストストア。 -
trust-store-password- トラストストアのパスワード。 -
modify-trust-store-trueに設定された場合、ユーザーに認識できない証明書が受信されたことを通知し、それらの証明書はトラストストアに格納することができます。デフォルトはtrueです。
-
silent-
ターミナルに情報およびエラーメッセージを書き込むかどうか。デフォルトは
falseです。 access-control-
現在のユーザーに付与されたパーミッションを基にして管理関連のコマンドおよび属性をフィルターすべきかどうか。たとえば、
trueの場合、ユーザーのアクセスが許可されていないコマンドおよび属性はタブ補完では表示されません。デフォルトはtrueです。 echo-command-
非対話モードで実行されたコマンドの出力にプロンプトおよびコマンドを含むかどうか。デフォルトは
falseです。 command-timeout-
コマンドが完了するまで待機する最大時間。
0の値はタイムアウトにならないことを意味します。デフォルトではタイムアウトは発生しません。 output-json- 操作の応答を純粋な JSON 形式で表示するかどうか。デフォルトでは、操作の応答は DMR 形式で表示されます。
color-outputCLI のログ出力をログメッセージの出力タイプに応じて色付けするかどうか。使用できる色は
black、blue、cyan、green、magenta、red、white、およびyellowです。-
enabled- カラー出力を有効にするかどうか。デフォルトはtrueです。 -
error-color- デフォルトはredです。 -
warn-color- デフォルトはyellowです。 -
success-color- デフォルトはdefaultで、ターミナルのデフォルトのフォアグラウンドの色になります。 -
required-color- デフォルトはmagentaです。 -
workflow-color- デフォルトはgreenです。 -
prompt-color- デフォルトはblueです。
-
output-paging-
管理 CLI は出力ページの表示後に一時停止するかどうか。出力の閲覧および検索が可能になります。このオプションが
falseに設定されている場合、出力全体がすぐに出力されます。デフォルトはtrueです。
6.1. プロパティーの置換 リンクのコピーリンクがクリップボードにコピーされました!
JBoss EAP は、管理 CLI での事前設定の要素式およびプロパティー式の使用をサポートします。これらの式は、コマンドの実行中に定義された値に解決されます。
式を以下のプロパティーに置き換えることができます。
- 操作リクエストの操作アドレス部分 (ノード型、名前など)
- 操作名
- 操作パラメーター名
- ヘッダー名および値
- コマンド名
- コマンド引数名
デフォルトでは、管理 CLI は引数またはパラメーターの値以外の各行に対してプロパティーの置換を実行します。引数およびパラメーターの値は起動時にサーバーで解決されます。引数またはパラメーターの値のプロパティー置換を管理 CLI で行い、解決された値をサーバーに送信する必要がある場合は、以下の手順に従います。
-
管理 CLI 設定ファイル
EAP_HOME/bin/jboss-cli.xmlを編集します。 resolve-parameter-valuesパラメーターをtrueに設定します (デフォルトはfalseです)。<resolve-parameter-values>true</resolve-parameter-values>
この要素は、操作リクエストのパラメーターの値とコマンド引数の値のみに影響します。他のコマンドラインには影響しません。そのため、パラメーターや引数の値でないコマンドライン上のシステムプロパティーは、resolve-parameter-values 要素の値に関係なく、行の解析中に解決されます。
管理 CLI コマンドで使用されるシステムプロパティーの値を解決するには、それらのプロパティーが定義されている必要があります。管理 CLI インスタンスの起動時にプロパティーファイル (--properties=/path/to/file.properties) またはプロパティーと値のペア (-Dkey=value) に渡す必要があります。プロパティーファイルは標準の KEY=VALUE 構文を使用します。
プロパティーキーは、以下の例のように ${MY_VAR} 構文を使用して管理 CLI コマンドで使用されます。
/host=${hostname}/server-config=${servername}:add(group=main-server-group)
その他の jboss-cli.xml 設定オプションは、管理 CLI の設定 を参照してください。