管理 CLI ガイド

管理 CLI を起動するには、JBoss EAP に提供される jboss-cli スクリプトを実行します。

$ EAP_HOME/bin/jboss-cli.sh

管理 CLI を起動し、--connect 引数を使用して 1 度にサーバーへ接続する方法の詳細は、「サーバーへの接続」を参照してください。

利用可能なすべての jboss-cli スクリプト引数とそれらの目的の完全リストは、--help 引数を使用するか、「管理 CLI の起動時の引数」を参照してください。

connect コマンドを使用すると、稼働中のスタンドアロンサーバーまたは管理対象ドメインに接続できます。

connect

デフォルトのホストおよびポート設定は localhost:9990 です。サーバーが別のホストおよびポートをリッスンしている場合、これらを connect コマンドで指定する必要があります。

connect 192.168.0.1:9991

また、--connect 引数 (および必要な場合は --controller 引数) を使用して、管理 CLI を起動し、サーバーに一度に接続することもできます。

$ EAP_HOME/bin/jboss-cli.sh --connect --controller=192.168.0.1:9991

JBoss EAP 7.1 で http-remoting プロトコルを使用して接続するには、以下を実行します。

connect http-remoting://192.168.0.1:9999

別のノードパスに変更するには、cd コマンドを使用し、希望のパスを指定します。管理 CLI が最初に起動されると、これはルートレベル (/) になります。

cd /subsystem=datasources
cd data-source=ExampleDS

pwd コマンドを使用すると現在のノードの完全パスを表示できます。

pwd

/subsystem=datasources/data-source=ExampleDS

ls コマンドを使用すると、特定ノードパスのコンテンツをリストすることができます。パスがノード名で終わる場合、そのリソースの属性も表示されます。

以下の例は、standard-sockets ソケットバインディンググループを探し、そのコンテンツをリストします。

cd /socket-binding-group=standard-sockets
ls -l

ATTRIBUTE         VALUE                                 TYPE
default-interface public                                STRING
name              standard-sockets                      STRING
port-offset       ${jboss.socket.binding.port-offset:0} INT

CHILD                                      MIN-OCCURS MAX-OCCURS
local-destination-outbound-socket-binding  n/a        n/a
remote-destination-outbound-socket-binding n/a        n/a
socket-binding                             n/a        n/a

ls コマンドにノードパスを指定すると、リソースツリー階層のどこからでも同じ結果を得ることができます。

ls -l /socket-binding-group=standard-sockets

ATTRIBUTE         VALUE                                 TYPE
default-interface public                                STRING
name              standard-sockets                      STRING
port-offset       ${jboss.socket.binding.port-offset:0} INT

CHILD                                      MIN-OCCURS MAX-OCCURS
local-destination-outbound-socket-binding  n/a        n/a
remote-destination-outbound-socket-binding n/a        n/a
socket-binding                             n/a        n/a

また、 --resolve-expressions パラメーターを使用して、返された属性の式をサーバーの値に解決することもできます。

ls -l /socket-binding-group=standard-sockets --resolve-expressions

ATTRIBUTE         VALUE            TYPE
default-interface public           STRING
name              standard-sockets STRING
port-offset       0                INT

CHILD                                      MIN-OCCURS MAX-OCCURS
local-destination-outbound-socket-binding  n/a        n/a
remote-destination-outbound-socket-binding n/a        n/a
socket-binding                             n/a        n/a

この例では、port-offset 属性は式 (${jboss.socket.binding.port-offset:0}) の代わりに解決された値 (0) を表しています。

管理 CLI を使用してヘルプを表示する方法は複数あります。

管理 CLI コマンドのリストは、「管理 CLI コマンド」を参照してください。

quit コマンドを入力すると、管理 CLI を終了できます。

quit

管理 CLI を起動せず、管理 CLI と対話しなくても、管理 CLI コマンドを実行できます。これは、コマンドのバッチ処理や、スクリプトからのコマンド実行に便利です。jboss-cli 起動スクリプトに コマンドを渡すか、コマンドが含まれるファイルを渡す ことが可能です。

コマンドを渡す

--command 引数を使用すると、実行する単一の CLI コマンドを指定できます。コマンドの完了後、管理 CLI が終了します。

$ EAP_HOME/bin/jboss-cli.sh --connect --command="/interface=public:read-attribute(name=inet-address,resolve-expressions=true)"

指定された各コマンドの出力は実行時に表示されます。

{
    "outcome" => "success",
    "result" => "127.0.0.1"
}

--commands 引数を使用して、実行する CLI コマンドのカンマ区切りリストを指定することもできます。

コマンドのファイルを渡す

--file 引数を使用して、実行する CLI コマンドのテキストファイルを渡すことができます。このファイルでは、各コマンドを行ごとに指定します。

$ EAP_HOME/bin/jboss-cli.sh --connect --file=/path/to/cli_commands.txt

ファイルの各コマンドからの出力は、実行時の表示されます。

{
    "outcome" => "success",
    "result" => "NORMAL"
}
helloworld.war

--echo-command 引数を使用すると、出力にプロンプトとコマンドを含めることができます。これは、出力と実行したコマンドを照合して障害を解決するときに便利です。

$ EAP_HOME/bin/jboss-cli.sh --connect --file=/path/to/cli_commands.txt --echo-command

コマンドと出力は、コマンドが実行されると表示されます。

[standalone@localhost:9990 /] :read-attribute(name=running-mode)
{
    "outcome" => "success",
    "result" => "NORMAL"
}
[standalone@localhost:9990 /] ls /deployment
helloworld.war

read-resource 操作を使用して、リソースの属性値を表示できます。

:read-resource

パラメーターを指定して、子リソースに関する完全情報を再帰的に提供することができます。また、パラメーターを指定して、ランタイム属性の追加、式の解決、およびエイリアスの追加を行うこともできます。read-operation-description(name=read-resource) を使用すると、read-resource に使用できるすべてのパラメーターの説明を表示できます。

以下の例は、デプロイメントの属性を読み取ります。これには、デプロイメント名、有効あるいは無効であるか、最後に有効になった時間などの詳細が含まれます。

/deployment=DEPLOYMENT_NAME:read-resource
{
    "outcome" => "success",
    "result" => {
        ...
        "enabled" => true,
        "enabled-time" => 1453929902598L,
        "enabled-timestamp" => "2016-01-27 16:25:02,598 EST",
        "name" => "DEPLOYMENT_NAME",
        "owner" => undefined,
        "persistent" => true,
        "runtime-name" => "DEPLOYMENT_NAME",
        "subdeployment" => undefined,
        "subsystem" => {
            "undertow" => undefined,
            "logging" => undefined
        }
    }
}

ランタイム属性の追加

include-runtime パラメーターを使用するとランタイム属性を取得できます。

以下の例は、デプロイメントの属性を読み取ります。永続属性の他に、デプロイメントの状態や最後に無効になった時間などのランタイム属性も含まれます。

/deployment=DEPLOYMENT_NAME:read-resource(include-runtime=true)
{
    "outcome" => "success",
    "result" => {
        ...
        "disabled-time" => undefined,
        "disabled-timestamp" => undefined,
        "enabled" => true,
        "enabled-time" => 1453929902598L,
        "enabled-timestamp" => "2016-01-27 16:25:02,598 EST",
        "name" => "DEPLOYMENT_NAME",
        "owner" => undefined,
        "persistent" => true,
        "runtime-name" => "DEPLOYMENT_NAME",
        "status" => "OK",
        "subdeployment" => undefined,
        "subsystem" => {
            "undertow" => undefined,
            "logging" => undefined
        }
    }
}

また、ブール値パラメータに渡すときに not 演算子 (!) を使用することもできます。

子リソースの再帰的な読み取り

recursive パラメーターを使用すると、子リソースから再帰的に属性を読み出しできます。

以下の例は、デプロイメントの属性を読み取ります。リソース独自の属性の他に、undertow サブシステムなどの子リソースの属性を再帰的に返します。

/deployment=DEPLOYMENT_NAME:read-resource(recursive=true)
{
    "outcome" => "success",
    "result" => {
        ...
        "enabled" => true,
        "enabled-time" => 1453929902598L,
        "enabled-timestamp" => "2016-01-27 16:25:02,598 EST",
        "name" => "DEPLOYMENT_NAME",
        "owner" => undefined,
        "persistent" => true,
        "runtime-name" => "DEPLOYMENT_NAME",
        "subdeployment" => undefined,
        "subsystem" => {
            "undertow" => {
                "context-root" => "/test",
                "server" => "default-server",
                "virtual-host" => "default-host",
                "servlet" => undefined,
                "websocket" => undefined
            },
            "logging" => {"configuration" => undefined}
        }
    }
}

デフォルト値の除外

include-defaults パラメーターを使用するとリソースの属性の読み取り時にデフォルト値を表示または非表示するにすることができます。デフォルトは true で、 read-resource 操作の使用時にデフォルト値が表示されます。

以下の例は、undertow サブシステムで read-resource 操作を使用します。

/subsystem=undertow:read-resource
{
    "outcome" => "success",
    "result" => {
        "default-security-domain" => "other",
        "default-server" => "default-server",
        "default-servlet-container" => "default",
        "default-virtual-host" => "default-host",
        "instance-id" => expression "${jboss.node.name}",
        "statistics-enabled" => false,
        "buffer-cache" => {"default" => undefined},
        "configuration" => {
            "filter" => undefined,
            "handler" => undefined
        },
        "server" => {"default-server" => undefined},
        "servlet-container" => {"default" => undefined}
    }
}

以下の例も、undertow サブシステムで read-resource 操作を使用しますが、include-defaults パラメーターを false に設定します。この例では、statistics-enabled や default-server などの複数の属性がデフォルト値ではなく undefined を表示します。

/subsystem=undertow:read-resource(include-defaults=false)
{
    "outcome" => "success",
    "result" => {
        "default-security-domain" => undefined,
        "default-server" => undefined,
        "default-servlet-container" => undefined,
        "default-virtual-host" => undefined,
        "instance-id" => undefined,
        "statistics-enabled" => undefined,
        "buffer-cache" => {"default" => undefined},
        "configuration" => {
            "filter" => undefined,
            "handler" => undefined
        },
        "server" => {"default-server" => undefined},
        "servlet-container" => {"default" => undefined}
    }
}

式の解決

resolve-expressions パラメーターを使用すると、返された属性の式をサーバーの値に解決することができます。

式を値として持つ属性は、${PARAMETER:DEFAULT_VALUE} という形式を使用します。詳細は、『設定ガイド』の「プロパティーの置換」を参照してください。

以下の例は、デプロイメントの属性を読み取ります。instance-id 属性は、式 (${jboss.node.name}) ではなく、解決された値 (test-name) を表示します。

/subsystem=undertow:read-resource(resolve-expressions=true)
{
    "outcome" => "success",
    "result" => {
        "default-security-domain" => "other",
        "default-server" => "default-server",
        "default-servlet-container" => "default",
        "default-virtual-host" => "default-host",
        "instance-id" => "test-name",
        "statistics-enabled" => false,
        "buffer-cache" => {"default" => undefined},
        "configuration" => {
            "filter" => undefined,
            "handler" => undefined
        },
        "server" => {"default-server" => undefined},
        "servlet-container" => {"default" => undefined}
    }
}

read-resource-description 操作を使用すると、リソースおよびその属性に関する詳細を表示できます。

:read-resource-description

パラメータを指定して、子リソースに関する完全詳細を再帰的に提供することができます。また、パラメーターを指定して、リソースの操作および通知の詳細を含めることもできます。read-operation-description(name=read-resource-description) を使用すると、read-resource-description に使用できるすべてのパラメーターの詳細を表示できます。

以下の例は、バッファーキャッシュの属性の詳細を表示します。

/subsystem=undertow/buffer-cache=default:read-resource-description
{
    "outcome" => "success",
    "result" => {
        "description" => "The buffer cache used to cache static content",
        "attributes" => {
            "buffer-size" => {
                "type" => INT,
                "description" => "The size of an individual buffer",
                "expressions-allowed" => true,
                "nillable" => true,
                "default" => 1024,
                "min" => 0L,
                "max" => 2147483647L,
                "access-type" => "read-write",
                "storage" => "configuration",
                "restart-required" => "resource-services"
            },
            "buffers-per-region" => {
                "type" => INT,
                "description" => "The numbers of buffers in a region",
                "expressions-allowed" => true,
                "nillable" => true,
                "default" => 1024,
                "min" => 0L,
                "max" => 2147483647L,
                "access-type" => "read-write",
                "storage" => "configuration",
                "restart-required" => "resource-services"
            },
            "max-regions" => {
                "type" => INT,
                "description" => "The maximum number of regions",
                "expressions-allowed" => true,
                "nillable" => true,
                "default" => 10,
                "min" => 0L,
                "max" => 2147483647L,
                "access-type" => "read-write",
                "storage" => "configuration",
                "restart-required" => "resource-services"
            }
        },
        "operations" => undefined,
        "notifications" => undefined,
        "children" => {}
    }
}

属性に対して返されたフィールドの詳細については、「リソース属性の詳細」を参照してください。

read-attribute 操作を使用すると、1 つの属性の現在の値を表示できます。

:read-attribute(name=ATTRIBUTE_NAME)

以下の例は、level 属性を読み取って、ルートロガーのログレベルを表示します。

/subsystem=logging/root-logger=ROOT:read-attribute(name=level)
{
    "outcome" => "success",
    "result" => "INFO"
}

read-attribute 操作を使用する利点の 1 つは、属性の現在のランタイム値を公開できることです。

/interface=public:read-attribute(name=resolved-address)
{
    "outcome" => "success",
    "result" => "127.0.0.1"
}

resolved-address 属性はランタイム属性です。この属性は、include-runtime パラメーターに渡さないと、read-resource 操作の使用時に表示されません。表示された場合でも、リソースの他の属性とともに表示されます。

include-defaults および resolve-expressions パラメーターを使用することもできます。これらのパラメーターに関する詳細は、「リソース値の表示」を参照してください。

write-attribute 操作を使用して、リソースの属性の値を更新できます。

:write-attribute(name=ATTRIBUTE_NAME, value=ATTRIBUTE_VALUE)

以下の例は、scan-enabled 属性を false に設定して、デプロイメントスキャナーを無効にします。

/subsystem=deployment-scanner/scanner=default:write-attribute(name=scan-enabled,value=false)
{"outcome" => "success"}

操作リクエストからの応答は、この操作が成功したことを表しています。また、read-attribute 操作を使用して scan-enabled 属性を読み取り (現在は false と表示)、結果を確認することもできます。

/subsystem=deployment-scanner/scanner=default:read-attribute(name=scan-enabled)
{
    "outcome" => "success",
    "result" => false
}

属性の値を undefined に設定できます。この属性にデフォルト値がある場合、デフォルト値が使用されます。

以下の例は、ルートロガーの level 属性の定義を削除します。

/subsystem=logging/root-logger=ROOT:undefine-attribute(name=level)

level 属性のデフォルト値は ALL です。read-resource 操作の実行時に、このデフォルトの使用を確認できます。

/subsystem=logging/root-logger=ROOT:read-resource
{
    "outcome" => "success",
    "result" => {
        "filter" => undefined,
        "filter-spec" => undefined,
        "handlers" => [
            "CONSOLE",
            "FILE"
        ],
        "level" => "ALL"
    }
}

デフォルト値を読み取らずにリソースを表示するには、include-defaults パラメーターを false に設定する必要があります。そうすると、level の値が undefined になります。

/subsystem=logging/root-logger=ROOT:read-resource(include-defaults=false)
{
    "outcome" => "success",
    "result" => {
        "filter" => undefined,
        "filter-spec" => undefined,
        "handlers" => [
            "CONSOLE",
            "FILE"
        ],
        "level" => undefined
    }
}

read-operation-names を使用すると、指定のリソースで使用できる操作を一覧表示できます。

:read-operation-names

以下の例は、デプロイメントで実行できる操作の一覧を表示します。

/deployment=DEPLOYMENT_NAME:read-operation-names
{
    "outcome" => "success",
    "result" => [
        "add",
        "deploy",
        "list-add",
        "list-clear",
        "list-get",
        "list-remove",
        "map-clear",
        "map-get",
        "map-put",
        "map-remove",
        "query",
        "read-attribute",
        "read-attribute-group",
        "read-attribute-group-names",
        "read-children-names",
        "read-children-resources",
        "read-children-types",
        "read-operation-description",
        "read-operation-names",
        "read-resource",
        "read-resource-description",
        "redeploy",
        "remove",
        "undefine-attribute",
        "undeploy",
        "whoami",
        "write-attribute"
    ]
}

read-operation-description 操作を使用して 操作の詳細を表示します。

read-operation-description 操作を使用すると、リソースの特定操作の詳細を表示できます。これには、パラメーターの説明と必須のパラメーターが含まれます。

:read-operation-description(name=OPERATION_NAME)

以下の例は、システムプロパティーにおける add 操作の詳細およびパラメーター情報を提供します。

/system-property=SYSTEM_PROPERTY:read-operation-description(name=add)
{
    "outcome" => "success",
    "result" => {
        "operation-name" => "add",
        "description" => "Adds a system property or updates an existing one.",
        "request-properties" => {"value" => {
            "type" => STRING,
            "description" => "The value of the system property.",
            "expressions-allowed" => true,
            "required" => false,
            "nillable" => true,
            "min-length" => 0L,
            "max-length" => 2147483647L
        }},
        "reply-properties" => {},
        "read-only" => false,
        "runtime-only" => false
    }
}

管理 CLI リクエストの作成時、特殊文字が含まれる値を追加する必要があることがあります。管理 CLI リクエストの構文に使われる特殊文字などの一部の特殊文字は、特定の方法で入力する必要があります。

多くの場合、値を二重引用符 ("") を囲めば適切に処理されます。使用する特殊文字が許可されるプロパティーであるかどうか分からない場合は、値を追加した後に属性またはリソースを読み取り、適切に保存されたことを確認してください。

以下の特殊文字の処理方法は、該当する項を参照してください。

空白文字

デフォルトでは、空白は管理 CLI で追加された値から取り除かれます。値に空白が含まれるようにするには、値を二重引用符 ("") または中かっこ ({}) で囲むか、バックスラッシュ (\) を使ってエスケープ処理します。

/system-property=test1:add(value="Hello World")
/system-property=test2:add(value={Hello World})
/system-property=test3:add(value=Hello\ World)

これにより、値が Hello World に設定されます。

引用符

値で単一引用符 (') を使用するには、値を二重引用符 ("") で囲むか、バックスラッシュ (\) を使用してエスケープ処理します。以下の例は、システムプロパティーの値を server's に設定します。

/system-property=test1:add(value="server's")
/system-property=test2:add(value=server\'s)

値で二重引用符 (") を使用するには、バックスラッシュ (\) を使用してエスケープ処理します。引用符の場所によっては、さらに二重引用符 ("") で値を囲む必要がある場合もあります。以下の例は、システムプロパティーの値を "quote" に設定します。

/system-property=test1:add(value="\"quote\"")

コンマ

値でコンマ (,) を使用するには、値を二重引用符 ("") で囲みます。

/system-property=test:add(value="Last,First")

これにより、値が Last,First に設定されます。

かっこ

値にかっこ (()) が含まれるようにするには、値を二重引用符 ("") または中かっこ ({}) で囲むか、バックスラッシュ (\) を使ってエスケープ処理します。

/system-property=test1:add(value="one(1)")
/system-property=test2:add(value={one(1)})
/system-property=test3:add(value=one\(1\))

これにより、値が one(1) に設定されます。

中かっこ

値に中かっこ ({}) が含まれるようにするには、値を二重引用符 ("") で囲みます。

/system-property=test:add(value="{braces}")

これにより、値が {braces} に設定されます。

角かっこ

値に角かっこ ([]) が含まれるようにするには、値を二重引用符 ("") で囲みます。

/system-property=test:add(value="[brackets]")

これにより、値が [brackets] に設定されます。

発音区別符号

ñ、ř、ý などの発音区別符号は、管理 CLI を使用して値を追加するときに使用できます。

/system-property=test1:add(value=Año)

ただし、値は二重引用符 ("") で囲まないでください。二重引用符で囲むと、発音区別符号が疑問符 (?) に置き換えられます。値に空白文字が含まれる場合は、中かっこ ({}) で値を囲むか、バックスラッシュ (\) を使ってエスケープ処理します。

/system-property=test2:add(value={Dos años})
/system-property=test3:add(value=Dos\ años)

これにより、値が Dos años に設定されます。

操作ヘッダーを指定すると、操作実行方法の特定の内容を制御することができます。以下の操作ヘッダーを使用することができます。

deploy /path/to/deployment.war --headers={allow-resource-service-restart=true}

/subsystem=infinispan/cache-container=test:remove() {allow-resource-service-restart=true}

セミコロン(;) を使用して複数の操作ヘッダーを区切ります。

管理 CLI は、条件を基にして実行するコマンドおよび操作のセットを選択可能にする if-else 制御フローをサポートします。if 条件は、of キーワードの後に指定された管理コマンドまたは操作の応答を評価するブール式です。

以下の項目をどれでも式に含めることができます。

以下は、正規表現と一致 (~=) の演算子を使用して、features システムプロパティーの値に jgroups が含まれるかどうかをチェックします。

if (result ~= ".*jgroups.*") of /:resolve-expression(expression=${features})
  echo Configuring JGroups
end-if

以下の例は、システムプロパティー test の読み取りを試みます。outcome が success でない場合 (プロパティーが存在しないことを意味します)、システムプロパティーが追加され、true に設定されます。

if (outcome != success) of /system-property=test:read-resource
    /system-property=test:add(value=true)
end-if

上記の条件は、outcome を使用します。これは、以下のように of キーワードの後の CLI コマンドが実行されると返されます。

/system-property=test:read-resource
{
    "outcome" => "failed",
    "failure-description" => "JBAS014807: Management resource '[(\"system-property\" => \"test\")]' not found",
    "rolled-back" => true
}

以下の例は、サーバープロセスの起動型 (STANDALONE または DOMAIN) をチェックし、適切な管理 CLI コマンドを実行して ExampleDS データソースを有効にします。

if (result == STANDALONE) of /:read-attribute(name=launch-type)
    /subsystem=datasources/data-source=ExampleDS:write-attribute(name=enabled, value=true)
else
    /profile=full/subsystem=datasources/data-source=ExampleDS:write-attribute(name=enabled, value=true)
end-if

if-else 制御フローを使用する管理 CLI コマンドをファイルに指定することができ、ファイルには各コマンドを各行に個別に指定します。ファイルを jboss-cli スクリプトに渡すと、--file パラメーターを使用して非対話的に実行されます。

$ EAP_HOME/bin/jboss-cli.sh --connect --file=CLI_FILE

管理 CLI は簡単な try-catch-finally 制御フローを提供します。これは、try、catch、および finally ブロックに対応する 3 つの操作およびコマンドのセットで構成されます。catch および finally ブロックは任意ですが、最低でも 1 つが存在するべきで、1 つの catch ブロックのみを指定できます。

制御フローは try バッチの実行で始まります。try バッチが正常に完了すると、catch バッチはスキップされ、finally バッチが実行されます。java.io.IOException などが原因で try バッチが失敗すると、try-catch-finally 制御フローは即座に終了します。利用できる場合は catch バッチが実行されます。finally バッチは、try および catch バッチの実行に成功または失敗に関わらず、制御フロードサイドに実行されます。

try-catch-finally 制御フローを定義するコマンドは 4 つあります。

以下の例はデータソースを作成または再作成し、有効化します。

try
/subsystem=datasources/data-source=myds:add(connection-url=CONNECTION_URL,jndi-name=java:/myds,driver-name=h2)

catch
/subsystem=datasources/data-source=myds:remove
/subsystem=datasources/data-source=myds:add(connection-url=CONNECTION_URL,jndi-name=java:/myds,driver-name=h2)

finally
/subsystem=datasources/data-source=myds:enable
end-try

JBoss EAP 管理 CLI は、query 操作を提供してリソースをクエリーします。:read-resource 操作を使用して、リソースのすべての属性を読み取りできます。選択された属性のみを一覧表示するには、:query 操作を使用します。

たとえば、name および enabled 属性のリストを表示するには、以下のコマンドを実行します。

/deployment=jboss-modules.jar:query(select=["name","enabled"])

以下の応答は操作の成功を表しています。name および enabled 属性は jboss-modules.jar デプロイメントに対して表示されています。

{
    "outcome" => "success",
    "result" => {
        "name" => "jboss-modules.jar",
        "enabled" => true
    }
}

ワイルドカードを使用すると、すべてのデプロイメントの name および enabled 属性の表示など、複数のリソース全体でクエリーを制御できます。

/deployment=*:query(select=["name","enabled"])

以下の応答は、操作に成功したことを表しています。すべてのデプロイメントの name および enabled 属性が一覧表示されています。

{
     "outcome" => "success",
     "result" => [
         {
             "address" => [("deployment" => "helloworld.war")],
             "outcome" => "success",
             "result" => {
                 "name" => "helloworld.war",
                 "enabled" => true
             }
         },
         {
             "address" => [("deployment" => "kitchensink.war")],
             "outcome" => "success",
             "result" => {
                 "name" => "kitchensink.war",
                 "enabled" => true
             }
         },
         {
             "address" => [("deployment" => "xyz.jar")],
             "outcome" => "success",
             "result" => {
                 "name" => "xyz.jar",
                 "enabled" => false
             }
         }
     ]
 }

:query 操作は、関連するオブジェクトもフィルターします。たとえば、 enabled が true である、デプロイメントの name および enabled 属性値を表示します。

/deployment=*:query(select=["name","enabled"],where=["enabled","true"])

以下の応答は、操作に成功したことを表しています。enabled が true である、デプロイメントの name および enabled 属性値が表示されます。

{
     "outcome" => "success",
     "result" => [
         {
             "address" => [("deployment" => "helloworld.war")],
             "outcome" => "success",
             "result" => {
                 "name" => "helloworld.war",
                 "enabled" => true
             }
         },
         {
             "address" => [("deployment" => "kitchensink.war")],
             "outcome" => "success",
             "result" => {
                 "name" => "kitchensink.war",
                 "enabled" => true
             }
         }
     ]
 }

JBoss EAP は、管理 CLI での事前設定の要素式およびプロパティー式の使用をサポートします。これらの式は、コマンドの実行中に定義された値に解決されます。

式を以下のプロパティーに置き換えることができます。

デフォルトでは、管理 CLI は引数またはパラメーターの値以外の各行に対してプロパティーの置換を実行します。引数およびパラメーターの値は起動時にサーバーで解決されます。引数またはパラメーターの値のプロパティー置換を管理 CLI で行い、解決された値をサーバーに送信する必要がある場合は、以下の手順に従います。

この要素は、操作リクエストのパラメーターの値とコマンド引数の値のみに影響します。他のコマンドラインには影響しません。そのため、パラメーターや引数の値でないコマンドライン上のシステムプロパティーは、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 の設定」を参照してください。

alias コマンドを使用すると、CLI セッション中に CLI コマンドおよび操作のエイリアスを定義できます。

以下の例は、alias コマンドを使用して undertow サブシステムのリソースを読み取る、read_undertow という名前の新しい CLI コマンドエイリアスを作成します。

alias read_undertow='/subsystem=undertow:read-resource'

read_undertow エイリアスの作成をテストするには、管理 CLI にエイリアス名を入力します。

read_undertow

結果は以下のようになります。

{
    "outcome" => "success",
    "result" => {
        "default-security-domain" => "other",
        "default-server" => "default-server",
        "default-servlet-container" => "default",
        "default-virtual-host" => "default-host",
        "instance-id" => expression "${jboss.node.name}",
        "statistics-enabled" => false,
        "buffer-cache" => {"default" => undefined},
        "configuration" => {
            "filter" => undefined,
            "handler" => undefined
        },
        "server" => {"default-server" => undefined},
        "servlet-container" => {"default" => undefined}
    }
}

使用できるエイリアスのリストを表示するには、alias コマンドを使用します。

alias

結果は以下のようになります。

alias read_undertow='/subsystem=undertow:read-resource'

エイリアスを削除するには、unalias コマンドを使用します。

unalias read_undertow

JBoss EAP には、新規セッションの開始時に環境を初期化できるようにする、ランタイム設定の .jbossclirc ファイルが含まれます。このファイルは、EAP_HOME/bin/ ディレクトリーにあります。ファイルにある例は、ユーザー固有の環境を設定するためのテンプレートとして使用することができます。.jbossclirc ファイルはグローバル CLI 変数の格納に適しています。

.jbossclirc ファイルの内容は、CLI がサポートするコマンドおよび操作のリストです。このファイルは、ユーザーに制御を渡す前、新しい管理 CLI セッションの開始時に実行されます。--properties 引数で指定されたシステムプロパティーがある場合、.jbossclirc ファイルはプロパティーの設定後に実行されます。

.jbossclirc ファイルの例

set console=/subsystem=logging/console-handler=CONSOLE

.jbossclirc ファイルを見つけるため、以下の場所が以下の順にチェックされます。

set コマンドの使用

以下のように、set コマンドを使用すると、サーバーモデルから変数へのパスを定義できます。

set s1=/host=master/server=server-one

これは、変数を使用してホストおよびプロファイルへの参照を含めると、異なるサーバー上でスクリプトを簡単に複製できるため、管理対象ドメインで活用できます。例を以下に示します。

$s1/subsystem=datasources/data-source=ExampleDS:test-connection-in-pool

unset コマンドの使用

unset コマンドを使用すると変数を削除できます。

unset prod_db

jbossclirc ファイルの使用

CLI セッション全体で変数を使用するには、これらの変数を .jbossclirc ファイルに追加します。このファイルは EAP_HOME/bin/ ディレクトリーにあります。

例を以下に示します。

set s1=/host=master/server=server-one
set s2=/host=master/server=server-two

管理 CLI を再起動して、set コマンドを実行し、使用できる変数を確認します。

set

出力は次のようになります。

s1=/host=master/server=server-one
s2=/host=master/server=server-two

変数はコマンドラインのどこにでも使用され、コマンドラインの解析中に解決されます。この例では、prod_db 変数はデータソースに解決されます。

$prod_db/statistics=jdbc:read-resource

echo コマンドの使用

echo コマンドを使用して変数の値をチェックします。

echo $prod_db

出力は次のようになります。

/subsystem=datasources/data-source=ExampleDS

例

以下の例は、変数が表示される場所と、コマンド全体を変数で構成できることを示しています。

$prod_db:$op($param=$param_value)
$cmd --$param=$param_value

data-source add --name=DATASOURCE_NAME --jndi-name=JNDI_NAME --driver-name=DRIVER_NAME  --connection-url=CONNECTION_URL

jms-queue add --queue-address=QUEUE_NAME --entries=JNDI_NAME

jms-topic add --topic-address=TOPIC_NAME --entries=JNDI_NAME

module add --name=MODULE_NAME --resources=PATH_TO_RESOURCE --dependencies=DEPENDENCIES

/system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)

deploy /path/to/DEPLOYMENT.war

undeploy * --keep-content

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

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"
    }]}
}

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

attachment display --operation=/subsystem=logging/log-file=server.log:read-attribute(name=stream)

これは、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
...

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

:read-operation-description(name=product-info)

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

...
management-major-version=4
management-micro-version=0
management-minor-version=1
...

:product-info

{
    "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"
        }
    }}]
}

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

/host=HOST_NAME:product-info

/host=HOST_NAME/server=SERVER_NAME:product-info

command-timeout get

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

deploy --name=*

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

reload --host=HOST_NAME

reload --host=HOST_NAME --admin-only=true

reload

module remove --name=MODULE_NAME

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"
    }]}
}

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

attachment save --operation=/subsystem=logging/log-file=server.log:read-attribute(name=stream) --file=log-output.txt

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

command-timeout set TIMEOUT_VALUE

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

undeploy *

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

undeploy DEPLOYMENT.war --all-relevant-server-groups

undeploy DEPLOYMENT.war --server-groups=SERVER_GROUP_NAME --keep-content

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

undeploy DEPLOYMENT.war

/host=EXISTING_HOST_NAME:write-attribute(name=name,value=NEW_HOST_NAME)
reload --host=EXISTING_HOST_NAME

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

ファイルストリームを許可する管理操作にローカルファイルを添付としてアップロードすることができます。たとえば、以下の管理 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}]

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

/subsystem=logging/log-file=SERVER_LOG_NAME:read-log-file