Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

第10章 ハウツー集

以下の CLI コマンドおよび操作は、特定のタスクを達成する方法の基本的な例になります。手順の詳細は、『設定ガイド』やその他の JBoss EAP ガイド の該当する項目を参照してください。

指定のない限り、これらの例はスタンドアロンサーバーとして実行される場合に適用されます。コマンドの使用方法を表示するには、コマンド上で --help 引数を使用します。ソースの特定操作の情報を取得するには、read-operation-description を使用します。

10.1. データソースの追加
リンクのコピー

data-source add --name=DATASOURCE_NAME --jndi-name=JNDI_NAME --driver-name=DRIVER_NAME  --connection-url=CONNECTION_URL
Copy to Clipboard Toggle word wrap

10.2. 拡張機能の追加
リンクのコピー

例: 新しい拡張機能を設定に追加する

/extension=EXTENSION_NAME:add
Copy to Clipboard Toggle word wrap

10.3. JMS キューの追加
リンクのコピー

jms-queue add --queue-address=QUEUE_NAME --entries=JNDI_NAME
Copy to Clipboard Toggle word wrap

10.4. JMS トピックの追加
リンクのコピー

jms-topic add --topic-address=TOPIC_NAME --entries=JNDI_NAME
Copy to Clipboard Toggle word wrap

10.5. モジュールの追加
リンクのコピー

module add --name=MODULE_NAME --resources=PATH_TO_RESOURCE --dependencies=DEPENDENCIES
Copy to Clipboard Toggle word wrap
重要

module 管理 CLI コマンドを使用したモジュールの追加および削除は、テクノロジープレビューとしてのみ提供されます。このコマンドは、管理対象ドメインでの使用や、リモートによる管理 CLI への接続時には適していません。本番環境では、モジュールを手作業で追加および削除する必要があります。詳細は、JBoss EAP『設定ガイド』の「カスタムモジュールの手動作成」および「手作業によるカスタムモジュールの削除」を参照してください。

テクノロジープレビューの機能は、Red Hat の本番環境のサービスレベルアグリーメント (SLA) ではサポートされず、機能的に完全ではないことがあるため、Red Hat は本番環境での使用は推奨しません。テクノロジープレビューの機能は、最新の技術をいち早く提供して、開発段階で機能のテストやフィードバックの収集を可能にするために提供されます。

テクノロジープレビュー機能のサポート範囲については、Red Hat カスタマーポータルの「テクノロジプレビュー機能のサポート範囲」を参照してください。

10.6. サーバーの追加
リンクのコピー

例: 管理対象ドメインで新しいサーバーをホストに追加する

/host=HOST_NAME/server-config=SERVER_NAME:add(group=SERVER_GROUP_NAME)
Copy to Clipboard Toggle word wrap

10.7. サーバーグループの追加
リンクのコピー

例: 管理対象ドメインで新しいサーバーグループを追加する

/server-group=SERVER_GROUP_NAME:add(profile=PROFILE_NAME, socket-binding-group=SOCKET_BINDING_GROUP_NAME)
Copy to Clipboard Toggle word wrap

10.8. システムプロパティーの追加
リンクのコピー

/system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)
Copy to Clipboard Toggle word wrap

10.9. プロファイルのクローン
リンクのコピー

例: 管理対象ドメインでプロファイルをクローンする

/profile=PROFILE_TO_CLONE:clone(to-profile=NEW_PROFILE_NAME)
Copy to Clipboard Toggle word wrap

10.10. 階層プロファイルの作成
リンクのコピー

例: 他のプロファイルを継承する新しいプロファイルを作成する

/profile=NEW_PROFILE_NAME:add(includes=[PROFILE_1,PROFILE_2])
Copy to Clipboard Toggle word wrap

10.11. アプリケーションの管理対象ドメインへのデプロイ
リンクのコピー

例: すべてのサーバーグループにアプリケーションをデプロイする

deploy /path/to/DEPLOYMENT.war --all-server-groups
Copy to Clipboard Toggle word wrap

例: 1 つ以上のサーバーグループにアプリケーションをデプロイする

deploy /path/to/DEPLOYMENT.war --server-groups=SERVER_GROUP_1,SERVER_GROUP_2
Copy to Clipboard Toggle word wrap

10.12. アプリケーションのスタンドアロンサーバーへのデプロイ
リンクのコピー

deploy /path/to/DEPLOYMENT.war
Copy to Clipboard Toggle word wrap

10.13. すべてのアプリケーションを無効化
リンクのコピー

undeploy * --keep-content
Copy to Clipboard Toggle word wrap

デプロイメント名にワイルドカード (*) を使用します。

10.14. アクティブなユーザーの表示
リンクのコピー

例: 現在のユーザーを表示するコマンド

:whoami
Copy to Clipboard Toggle word wrap

例: 現在のユーザーの出力

{
    "outcome" => "success",
    "result" => {"identity" => {
        "username" => "$local",
        "realm" => "ManagementRealm"
    }}
}
Copy to Clipboard Toggle word wrap

10.15. 添付内容の表示
リンクのコピー

attachment display コマンドを使用すると、管理操作から返された添付の内容を表示することができます。これは、attached-streams 応答ヘッダーを返す管理操作に適用されます。

たとえば、以下の操作はストリームとして添付された server.log ファイルを返します。 

/subsystem=logging/log-file=server.log:read-attribute(name=stream)
{
    "outcome" => "success",
    "result" => "f61a27c4-c5a7-43ac-af1f-29e90c9acb3e",
    "response-headers" => {"attached-streams" => [{
        "uuid" => "f61a27c4-c5a7-43ac-af1f-29e90c9acb3e",
        "mime-type" => "text/plain"
    }]}
}
Copy to Clipboard Toggle word wrap

attachment display コマンドを使用すると、この操作からコンソールに返されたストリームの内容を表示できます。 

attachment display --operation=/subsystem=logging/log-file=server.log:read-attribute(name=stream)
Copy to Clipboard Toggle word wrap

これは、server.log ファイルの内容をコンソールに出力します。 

ATTACHMENT f61a27c4-c5a7-43ac-af1f-29e90c9acb3e:
2017-08-14 15:20:01,472 INFO  [org.jboss.modules] (main) JBoss Modules version 1.6.0.CR2-redhat-1
2017-08-14 15:20:01,721 INFO  [org.jboss.msc] (main) JBoss MSC version 1.2.7.SP1-redhat-1
2017-08-14 15:20:01,853 INFO  [org.jboss.as] (MSC service thread 1-8) WFLYSRV0049: JBoss EAP 7.1.0.GA (WildFly Core 3.0.0.Beta30-redhat-1) starting
...
Copy to Clipboard Toggle word wrap

10.16. スキーマ情報の表示
リンクのコピー

:product-info コマンドのスキーマ情報を表示します。 

:read-operation-description(name=product-info)
Copy to Clipboard Toggle word wrap

スキーマバージョンを表示するには、管理 CLI のルートで ls コマンドを実行し、management-*-version の値を見つけます。 

...
management-major-version=4
management-micro-version=0
management-minor-version=1
...
Copy to Clipboard Toggle word wrap

10.17. システムおよびサーバー情報の表示
リンクのコピー

例: システムおよびサーバー情報を表示するコマンド

:product-info
Copy to Clipboard Toggle word wrap

例: システムおよびサーバー情報の出力

{
    "outcome" => "success",
    "result" => [{"summary" => {
        "host-name" => "HOST_NAME",
        "instance-identifier" => "INSTANCE_ID",
        "product-name" => "JBoss EAP",
        "product-version" => "7.1.0.GA",
        "product-community-identifier" => "Product",
        "product-home" => "EAP_HOME",
        "standalone-or-domain-identifier" => "OPERATING_MODE",
        "host-operating-system" => "OS_NAME",
        "host-cpu" => {
            "host-cpu-arch" => "CPU_ARCH",
            "host-core-count" => CORE_COUNT
        },
        "jvm" => {
            "name" => "JAVA_VM_NAME",
            "java-version" => "JAVA_VERSION",
            "jvm-version" => "JAVA_VM_VERSION",
            "jvm-vendor" => "JAVA_VM_VENDOR",
            "java-home" => "JAVA_HOME"
        }
    }}]
}
Copy to Clipboard Toggle word wrap

同様に、管理対象ドメインでは、特定の JBoss EAP ホストまたはサーバーの情報を表示できます。 

/host=HOST_NAME:product-info
Copy to Clipboard Toggle word wrap 
/host=HOST_NAME/server=SERVER_NAME:product-info
Copy to Clipboard Toggle word wrap

10.18. コマンドタイムアウト値の取得
リンクのコピー

例: CLI コマンドのタイムアウト値を表示する

command-timeout get
Copy to Clipboard Toggle word wrap

秒単位の値が返されます。0 はタイムアウトがないことを意味します。

10.19. 無効なデプロイメントをすべて再デプロイ
リンクのコピー

deploy --name=*
Copy to Clipboard Toggle word wrap

デプロイメント名にワイルドカード (*) を使用します。

10.20. ホストコントローラーのリロード
リンクのコピー

reload --host=HOST_NAME
Copy to Clipboard Toggle word wrap

10.21. Admin-only モードでのホストコントローラーのリロード
リンクのコピー

reload --host=HOST_NAME --admin-only=true
Copy to Clipboard Toggle word wrap

10.22. サーバーグループのすべてのサーバーをリロード
リンクのコピー

例: 管理対象ドメインの特定サーバーグループのサーバーをすべてリロードする

/server-group=SERVER_GROUP_NAME:reload-servers
Copy to Clipboard Toggle word wrap

注記

停止状態でサーバーをリロードするには、start-mode=suspend 引数を渡します。

10.23. サーバーのリロード
リンクのコピー

例: 管理対象ドメインでサーバーをリロードする

/host=HOST_NAME/server-config=SERVER_NAME:reload
Copy to Clipboard Toggle word wrap

注記

停止状態でサーバーをリロードするには、start-mode=suspend 引数を渡します。

10.24. スタンドアロンサーバーのリロード
リンクのコピー

reload
Copy to Clipboard Toggle word wrap
注記

admin-only モードでサーバーをリロードするには、--start-mode=admin-only 引数を渡します。停止状態でサーバーをリロードするには、start-mode=suspend 引数を渡します。

10.25. 拡張機能の削除
リンクのコピー

例: 既存の拡張機能を削除する

/extension=EXTENSION_NAME:remove
Copy to Clipboard Toggle word wrap

10.26. モジュールの削除
リンクのコピー

module remove --name=MODULE_NAME
Copy to Clipboard Toggle word wrap
重要

module 管理 CLI コマンドを使用したモジュールの追加および削除は、テクノロジープレビューとしてのみ提供されます。このコマンドは、管理対象ドメインでの使用や、リモートによる管理 CLI への接続時には適していません。本番環境では、モジュールを手作業で追加および削除する必要があります。詳細は、JBoss EAP『設定ガイド』の「カスタムモジュールの手動作成」および「手作業によるカスタムモジュールの削除」を参照してください。

テクノロジープレビューの機能は、Red Hat の本番環境のサービスレベルアグリーメント (SLA) ではサポートされず、機能的に完全ではないことがあるため、Red Hat は本番環境での使用は推奨しません。テクノロジープレビューの機能は、最新の技術をいち早く提供して、開発段階で機能のテストやフィードバックの収集を可能にするために提供されます。

テクノロジープレビュー機能のサポート範囲については、Red Hat カスタマーポータルの「テクノロジプレビュー機能のサポート範囲」を参照してください。

10.27. コマンドのタイムアウト値のリセット
リンクのコピー

例: コマンドのタイムアウトをデフォルト値にリセットする

command-timeout reset default
Copy to Clipboard Toggle word wrap

例: コマンドのタイムアウトを CLI 設定によって提供される値にリセットする

command-timeout reset config
Copy to Clipboard Toggle word wrap

注記

CLI 設定によって提供される値は、EAP_HOME/bin/jboss-cli.xml ファイルに設定でき、また管理 CLI の起動時に --command-timeout 引数で渡すこともできます。

10.28. サーバーグループのすべてのサーバーを再起動
リンクのコピー

例: 管理対象ドメインで特定のサーバーグループのサーバーをすべて再起動する

/server-group=SERVER_GROUP_NAME:restart-servers
Copy to Clipboard Toggle word wrap

注記

停止状態でサーバーを再起動するには、start-mode=suspend 引数を渡します。

10.29. サーバーの再起動
リンクのコピー

例: 管理対象ドメインでサーバーを再起動する

/host=HOST_NAME/server-config=SERVER_NAME:restart
Copy to Clipboard Toggle word wrap

注記

停止状態でサーバーを再起動するには、start-mode=suspend 引数を渡します。

10.30. 添付内容の保存
リンクのコピー

attachment save コマンドを使用すると、管理操作から返された添付の内容を保存することができます。これは、attached-streams 応答ヘッダーを返す管理操作に適用されます。

たとえば、以下の操作はストリームとして添付された server.log ファイルを返します。 

/subsystem=logging/log-file=server.log:read-attribute(name=stream)
{
    "outcome" => "success",
    "result" => "f61a27c4-c5a7-43ac-af1f-29e90c9acb3e",
    "response-headers" => {"attached-streams" => [{
        "uuid" => "f61a27c4-c5a7-43ac-af1f-29e90c9acb3e",
        "mime-type" => "text/plain"
    }]}
}
Copy to Clipboard Toggle word wrap

attachment save コマンドを使用すると、この操作からコンソールに返されたストリームの内容を保存できます。 

attachment save --operation=/subsystem=logging/log-file=server.log:read-attribute(name=stream) --file=log-output.txt
Copy to Clipboard Toggle word wrap

これは、server.log ファイルの内容を EAP_HOME/bin/log-output.txt に保存します。

10.31. コマンドのタイムアウト値の設定
リンクのコピー

例: CLI コマンドが完了するまでの最大待機時間を設定する

command-timeout set TIMEOUT_VALUE
Copy to Clipboard Toggle word wrap

値は秒単位で設定されます。0 はタイムアウトがないことを意味します。

10.32. ホストコントローラーのシャットダウン
リンクのコピー

例: 管理対象ドメインでホストコントローラーをシャットダウンする

shutdown --host=HOST_NAME
Copy to Clipboard Toggle word wrap

10.33. サーバーのシャットダウン
リンクのコピー

例: スタンドアロンサーバーのシャットダウン

shutdown
Copy to Clipboard Toggle word wrap

10.34. サーバーグループのすべてのサーバーの起動
リンクのコピー

例: 管理対象ドメインで特定のサーバーグループのサーバーをすべて起動する

/server-group=SERVER_GROUP_NAME:start-servers
Copy to Clipboard Toggle word wrap

注記

停止状態でサーバーを起動するには、start-mode=suspend 引数を渡します。

10.35. サーバーの起動
リンクのコピー

例: 管理対象ドメインでサーバーを起動する

/host=HOST_NAME/server-config=SERVER_NAME:start
Copy to Clipboard Toggle word wrap

注記

停止状態でサーバーを起動するには、start-mode=suspend 引数を渡します。

10.36. サーバーグループのすべてのサーバーの停止
リンクのコピー

例: 管理対象ドメインで特定のサーバーグループのサーバーをすべて停止する

/server-group=SERVER_GROUP_NAME:stop-servers
Copy to Clipboard Toggle word wrap

10.37. サーバーの停止
リンクのコピー

例: 管理対象ドメインでサーバーを停止する

/host=HOST_NAME/server-config=SERVER_NAME:stop
Copy to Clipboard Toggle word wrap

10.38. 設定スナップショットの作成
リンクのコピー

例: 現在の設定のスナップショットを作成する

:take-snapshot
Copy to Clipboard Toggle word wrap

10.39. すべてのアプリケーションのアンデプロイ
リンクのコピー

undeploy *
Copy to Clipboard Toggle word wrap

デプロイメント名にワイルドカード (*) を使用します。

10.40. 管理対象ドメインからのアプリケーションのアンデプロイ
リンクのコピー

例: 指定のデプロイメントのサーバーグループすべてからアプリケーションをアンデプロイする

undeploy DEPLOYMENT.war --all-relevant-server-groups
Copy to Clipboard Toggle word wrap

例: 特定のサーバーグループからアプリケーションをアンデプロイする

undeploy DEPLOYMENT.war --server-groups=SERVER_GROUP_NAME --keep-content
Copy to Clipboard Toggle word wrap

指定のデプロイメントの他のサーバーグループ向けにコンテンツをリポジトリーに保持するため、--keep-content パラメーターが必要になります。

10.41. スタンドアロンサーバーからのアプリケーションのアンデプロイ
リンクのコピー

undeploy DEPLOYMENT.war
Copy to Clipboard Toggle word wrap

10.42. ホスト名の更新
リンクのコピー

例: 管理対象ドメインでホストの名前を更新する

/host=EXISTING_HOST_NAME:write-attribute(name=name,value=NEW_HOST_NAME)
reload --host=EXISTING_HOST_NAME
Copy to Clipboard Toggle word wrap

変更を反映するには、ホストをリロードする必要があります。

10.43. 添付のアップロード
リンクのコピー

ファイルストリームを許可する管理操作にローカルファイルを添付としてアップロードすることができます。たとえば、以下の管理 CLI コマンドは input-stream-index オプションを使用してローカルファイルの内容を展開形式 (exploded) のデプロイメントにアップロードします。 

/deployment=DEPLOYMENT_NAME.war:add-content(content=[{target-path=/path/to/FILE_IN_DEPLOYMENT, input-stream-index=/path/to/LOCAL_FILE_TO_UPLOAD}]
Copy to Clipboard Toggle word wrap

デプロイメントにファイルをアップロードするための詳細については、『設定ガイド』の「展開形式のデプロイメントへのコンテンツの追加」を参照してください。

10.44. サーバーログの表示
リンクのコピー

/subsystem=logging/log-file=SERVER_LOG_NAME:read-log-file
Copy to Clipboard Toggle word wrap
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2026 Red Hatトップに戻る