管理 CLI 指南

您可以通过运行随 JBoss EAP 提供的 jboss-cli 脚本来启动管理 CLI。

$ EAP_HOME/bin/jboss-cli.sh

有关使用 --connect 参数启动管理 CLI 和连接到服务器的详细信息，请参阅 连接到 服务器。

有关所有可用 jboss-cli 脚本参数及其用途的完整列表，请使用 --help 参数，或参阅 管理 CLI 启动参数 部分。

您可以使用 connect 命令来连接正在运行的单机服务器或受管域。

connect

默认主机和端口配置是 localhost:9990。如果服务器正在侦听其他主机和端口，则需要将它们提供给 connect 命令。

connect 192.168.0.1:9991

您还可以启动管理 CLI，并使用 --connect 参数（如有必要，使用 -- controller 参数）连接服务器。

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

在 JBoss EAP 7.4 中，若要使用 http-remoing 协议进行连接，请使用：

connect http-remoting://192.168.0.1:9990

管理 CLI 提供了多种方法，供您使用管理 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

您可以使用 the cd 命令并提供所需的路径来更改到不同的节点路径。首次启动管理 CLI 时，它处于根级别(/)。

cd /subsystem=datasources
cd data-source=ExampleDS

您可以使用 pwd 命令打印当前节点的路径。首次启动管理 CLI 时，路径为 root 级别(/)。

cd /subsystem=undertow
cd server=default-server
pwd

以上示例使用 the cd 命令更改路径，然后将以下内容输出到控制台：

/subsystem=undertow/server=default-server

您可以使用 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 属性显示其解析值0，而不是表达式(${jboss.socket.binding.port-offset:0})。

以交互模式运行管理 CLI 时，操作会导致多个输出页，命令处理器将在第一页面末尾暂停屏幕。这样，您可以一次页面浏览输出结果。在输出信息 的末尾，输出的出现通过一行文本显示 --More(NN%) 表示。

以下是一个管理 CLI 命令的示例，它提供了多个页面的输出：

/subsystem=undertow:read-resource(recursive=true)
{
    "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,
          "application-security-domain" => {"other" => {
          "enable-jacc" => false,
          "http-authentication-factory" => "application-http-authentication",
          "override-deployment-config" => false,
          "setting" => undefined
      }},
      "buffer-cache" => {"default" => {
          "buffer-size" => 1024,
          "buffers-per-region" => 1024,
--More(7%)--

浏览多页输出

当您遇到文本行表示输出更多时，您可以继续使用以下选项之一：

搜索多页输出

您可以在多页输出中搜索文本。

您还可以使用上下箭头浏览搜索历史记录。

以交互模式运行管理 CLI 时，您可以使用键盘快捷方式快速编辑管理 CLI 命令。

您可以使用的键盘快捷方式因您正在运行的支持平台而异：

您可以使用 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 运算符(!)。例如：

递归读取子资源

可以使用 递归 参数从子资源中以递归方式检索属性。

以下示例读取部署的属性：除了资源自己的属性外，它还以递归方式返回其子资源的属性，如 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 和 default-server ）显示 未定义 的值，而不是默认值。

/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

resolve-expressions 参数可用于将返回属性的表达式解析为服务器上对应的值。

带有表达式的属性，作为其值使用格式 ${PARAMETER: DEFAULT_VALUE}。如需更多信息 ，请参阅《 配置指南》 中的属性替换。

以下示例读取部署的属性：instance-id 属性显示其解析值(test-name)，而不显示表达式(${jboss.node.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) 查看所有可用参数的描述 。

以下示例显示了缓冲区缓存的属性详细信息：

/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" => {}
    }
}

请参阅 Resource Attribute Details，以了解更多有关属性返回的字段的信息。

您可以使用 read-attribute 操作来查看单个属性的当前值。

:read-attribute(name=ATTRIBUTE_NAME)

以下示例通过读取 level 属性来显示根日志记录器的日志级别：

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

使用 read-attribute 操作的一个优点是能够公开属性的当前运行时值。

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

resolve -address 属性是 runtime 属性。在公共接口上使用 read-resource 操作时不会显示此属性，除非您通过了 include-runtime 参数。即使这样，它也会显示在资源的其余属性中。

您还可以使用 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
}

您可以将属性的值设置为 未定义。如果此属性具有默认值，则将使用该值。

以下示例取消定义根日志记录器的 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 的值 尚未定义。

/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。

/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\))

这会将该值设置为 1(1)。

大括号

您可以通过用双引号("")括起值，将大括号({})包含在值中。

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

这会将值设置为 {braces}。

方括号

您可以将方括号([])包含在值中，方法是用双引号("")括起该值。

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

这会将值设置为 [brackets]。

diacritic Marks

在使用管理 CLI 添加值时，可以使用dia critic 标记（如 ñ 、 sudel 或 SAS）。

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

但是，不要将值包括在双引号("")中。这可导致 diacritic 标记替换为问号(?)。如果值有需要维护的空格，则需要将值括在大括号({})中，或使用反斜杠(\)转义空格。

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

这会将该值设置为 Dos años。

您可以指定操作标头来控制操作执行方式的某些方面。可用的操作标头如下：

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

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

使用分号(;)来分隔多个操作标头。

管理 CLI 支持 if-其他 控制流，它允许您根据条件选择要执行的命令和操作集合。if 条件是一个布尔值表达式，评估在 关键字 后指定的管理命令或操作的响应。

表达式可以包含以下任一项目：

以下示例使用 match 正则表达式(~=)运算符来检查 features 系统属性的值是否包含 jgroups。

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

以下示例尝试读取系统属性 test。如果 结果 不成功 （这意味着该属性不存在），则系统属性将被添加并设为 true。

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

以上条件使用 结果，在执行 关键字 后 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

使用 的管理 CLI 命令 如果可以在文件中指定 -其他 控制流，则在文件中单独一行执行每个命令。然后，您可以使用 --file 参数以非交互方式将 文件传递到 jboss-cli 脚本。

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

管理 CLI 提供了一个简单的 尝试概括性 控制流程。它由与 try、catch 和 最终 块对应的三组操作和命令组成。捕获 块 和最终 块是可选的，但其中至少应存在，并且只能指定一个捕获块。

控制流程从执行 尝试 批处理开始。如果 尝试 批处理成功完成，则将跳过 捕获 批处理并执行 最终 批处理。如果 尝试 批量失败，例如 java.io.IOException，try- catch -finally 控制流将立即终止，如果可用，则会执行 catch 批处理。最后 的批处理始终在控制流程的末尾执行，尝试 和 捕获 批处理是成功还是无法执行。

有四个命令定义了 try-catch-finally 控制流：

以下示例创建或重新创建数据源并启用它：

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

管理 CLI 支持 for-done 控制流，允许您迭代从操作返回的集合，并对集合中的每个项目执行命令。您可以在交互或非交互模式下将 for-done 语句与管理 CLI 搭配使用。for-done 语句使用以下语法：

for VARIABLE_NAME in OPERATION
  COMMANDS_TO_EXECUTE
done

以下示例迭代所有部署，并显示每项部署是启用或禁用的。

for deploymentName in :read-children-names(child-type=deployment)
  if (result == true) of /deployment=$deploymentName:read-attribute(name=enabled)
    echo $deploymentName is enabled.
  else
    echo $deploymentName is disabled.
  end-if
done

如果您想要丢弃当前 的块 而不执行命令，请输入 done --discard。

JBoss EAP 管理 CLI 提供 查询 操作以查询资源。您可以使用 :read-resource 操作来读取资源的所有属性。如果只列出所选属性，您可以使用 :query 操作。

例如，要查看 名称和 已启用 的属性列表，请使用以下命令：

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

以下响应显示操作成功：name 和 enabled 属性列在 jboss-modules.jar 部署中。

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

您还可以使用通配符来跨多个资源查询，例如，列出所有部署 的名称和 启用 的属性：

/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"])

以下响应显示操作成功：列出了已启用为 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
             }
         }
     ]
 }

您可以将输出重定向到 文件或 另一个命令，而不是从管理 CLI 操作打印输出到终端。

将输出重定向到文件

使用 > operator 将管理 CLI 操作的输出重定向到文件系统中的文件。

:read-resource > myfile.txt

使用 >> operator 重定向管理 CLI 操作的输出并将其附加到文件系统中的文件中。

:read-resource >> myfile.txt

将输出重定向到命令

使用 | 运算符将管理 CLI 操作的输出重定向到 grep 命令，以搜索正则表达式匹配的输出。目前，gr ep 是 | 运算符唯一支持的命令。

/subsystem=logging/log-file=server.log:read-log-file | grep Deployed
        "2018-03-06 09:48:02,389 INFO  [org.jboss.as.server] (management-handler-thread - 5) WFLYSRV0010: Deployed \"jboss-helloworld.war\" (runtime-name : \"jboss-helloworld.war\")",

JBoss EAP 支持在管理 CLI 中使用预设元素和属性表达式。这些表达式将在执行 命令期间解析为其定义的值。

您可以替换以下属性的表达式：

默认情况下，管理 CLI 对每行执行属性替换，但参数或参数值除外。参数和参数值在服务器运行时解析。如果您需要在管理 CLI 中发生参数或参数值的属性替换，并将其解析的值发送到服务器，请完成以下步骤。

此元素仅影响操作请求参数值和命令参数值。它不会影响其余命令行。这意味着命令行中存在的系统属性将在行解析期间解析，而不论 resolve-parameter-values 元素的值是什么，除非它是参数/参数值。

管理 CLI 命令中使用的系统属性值必须已经定义，以便能被解析。启动管理 CLI 实例时，您必须通过属性文件(--properties=/path/to/file.properties)或属性值对（-D键=值）。属性文件使用标准 KEY=VALUE 语法。

属性键在您的管理 CLI 命令中使用 ${MY_VAR} 语法表示，例如：

/host=${hostname}/server-config=${servername}:add(group=main-server-group)

有关其他 jboss-cli.xml 配置选项，请参阅 配置管理 CLI。

您可以使用 alias 命令在 CLI 会话期间为 CLI 命令 和操作定义别名。

以下示例创建一个名为 read_undertow 的新 CLI 命令别名，以使用 alias 命令读取 undertow 子系统中的资源：

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/ 目录中。文件中提供的示例可用作用户特定环境设置的模板。jboss clirc 文件是存储全局 CLI 变量的理想选择。

jboss clirc 文件的内容是 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)

deployment deploy-file /path/to/DEPLOYMENT.war

deployment disable /path/to/DEPLOYMENT.war

您可以使用 deployment disable-all 命令禁用所有部署。

deployment disable-all

您可以使用 附加 display 命令显示 从管理操作返回的附件的内容。这适用于返回 attach -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"
    }]}
}

您可以使用 附加 display 命令显示 从此操作返回的流的内容到控制台。

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

这会将 server.log 文件的内容输出到控制台。

ATTACHMENT 3480a327-31dd-4412-bdf3-f36c94ac4a09:
2019-10-18 09:19:37,082 INFO  [org.jboss.modules] (main) JBoss Modules version 1.8.6.Final-redhat-00001
2019-10-18 09:19:37,366 INFO  [org.jboss.msc] (main) JBoss MSC version 1.4.5.Final-redhat-00001
2019-10-18 09:19:37,380 INFO  [org.jboss.threads] (main) JBoss Threads version 2.3.2.Final-redhat-1
2019-10-18 09:19:37,510 INFO  [org.jboss.as] (MSC service thread 1-1) WFLYSRV0049: JBoss EAP 7.4.0 (WildFly Core 10.0.0.Final-redhat-20190924) starting
...

显示 :product-info 命令的 schema 信息：

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

要显示 schema 版本，在管理 CLI root 执行 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" => "EAP 7.4.0",
        "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

deployment enable DEPLOYMENT.war

您可以使用 deployment enable-all 命令启用所有部署。

deployment enable-all --server-groups=other-server-group

command-timeout get

返回的值以秒为单位。值 0 表示没有超时。

reload --host=HOST_NAME

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

reload

module remove --name=MODULE_NAME

您可以使用 附加 save 命令将从管理操作返回的附件的内容保存到文件中。这适用于返回 attach -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"
    }]}
}

您可以使用 附加 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 表示没有超时。

deployment undeploy DEPLOYMENT.war

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

必须重新加载主机才能使更改生效。

您可以将本地文件作为附件上传到接受文件流的管理操作。例如，以下管理 CLI 命令使用 input-stream-index 选项将本地文件的内容上传到展开的部署：

/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

您可以使用 --node-type 参数将通用类型 命令 分配给特定的节点类型。您可以使用通用 type 命令来 编辑属性，或在管理模型中调用特定节点类型的操作。

node-type 参数可用于单机服务器和受管域中的服务器上。调用 命令后，服务器配置文件将更新。

在终端中发出 help 命令，以查看通用类型 命令 及其任何参数的描述。您可以显示您通过发出 帮助 [COMMAND_NAME] 创建的命令的说明，其中 [COMMAND_NAME] 是命令的名称。

该流程使用演示为单机服务器上的特定节点类型分配通用类型 命令 的示例。

您还可以将通用类型 命令 分配给受管域中的特定节点类型。您必须在每个命令中添加配置集。以下示例将 default 设置为配置集。

[domain@localhost:9999 /] data-source --profile=default --jndi-name=myds --min-pool-size=11 --max-pool-size=22

您可以使用 --node-child 参数为现有子节点分配通用类型 命令。您可以使用通用 type 命令来 编辑属性，或在管理模型中调用子节点的操作。

node-child 参数可用于单机服务器和受管域中的服务器上。调用 命令后，服务器配置文件将更新。

该流程使用演示为单机服务器中的子节点分配通用类型 命令 的示例。

您还可以为受管域中的子节点分配通用类型 命令。您必须在每个命令中添加配置集。以下示例将 default 设置为配置集。

[domain@localhost:9999 /] authorization --profile=default --provider=rbac --permission-combination-policy=permissive --use-identity-roles=false

下表列出了可以传递到 jboss-cli 脚本以启动管理 CLI 的参数：

此表提供了可用于管理 CLI 以处理批处理的命令列表。

下表列出了管理 CLI 命令及其用途：要获得更多用法和参数详情，请在特定命令中使用 --help 参数。

下表列出了 root 级别(/)可用的管理 CLI 操作。特定资源的实际可用操作因资源而异，也取决于操作模式（单机服务器或受管域）。

操作通过冒号(:)调用。可以使用 read-operation-names 操作或使用冒号后使用 tab 自动完成来公开资源的可用操作。操作说明可使用 read-operation-description 操作显示。例如：

:read-operation-description(name=write-attribute)

read-resource-description 操作显示资源的属性以及属性的详细信息。下表列出了可能返回的字段，具体取决于它是否与 属性相关。

更新于 2024-02-09