第 6 章 配置管理 CLI
可以在其配置文件中自定义管理 CLI 的某些方面 jboss-cli.xml
。此文件必须位于 EAP_HOME/bin
目录中,或者位于通过 jboss.cli.config
系统属性指定的自定义目录中。
以下元素可以在 jboss-cli.xml 文件中配置
:
default-protocol
-
当控制器地址没有提供时要使用的默认协议。默认值为
remote+http
。如果使用端口9990
并且未指定协议,则该协议将默认自动进行远程移动,除非
将 use-legacy-override
属性设置为false
。 default-controller
如果不带任何参数执行
connect
命令,则配置要连接的控制器。如果管理 CLI 使用参数--controller= 或
controller=
启动,则参数中指定的值会覆盖来自配置的default-controller
定义。-
协议
- 控制器的协议名称。如果未提供,则将使用default-protocol
的值。 -
Host
-
控制器的主机名。默认值为localhost
。 -
port
- 用于连接到控制器的端口号。默认值为9990
。
-
controllers
您可以在
jboss-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>
controller 元素的
name
属性应当用作--controller=
参数的值。例如:--controller=ServerTwo
。validate-operation-requests
-
在将请求发送到控制器以执行之前,是否验证操作请求的参数列表。默认值为
true
。 history
CLI 命令历史记录日志的配置。
-
启用
- 是否启用历史记录
。默认值为true
。 -
file-name
- 保存历史记录的文件名。默认值为.jboss-cli-history
。 -
file-dir
- 保存历史记录的目录。默认为用户的主目录。 -
max-size
- 历史记录文件中存储的命令的最大数量。默认值为500
。
-
resolve-parameter-values
-
在向控制器发送操作请求前,是否解析作为命令参数(或 operation 参数)指定的系统属性。默认值为
false
。 connection-timeout
-
允许建立与控制器连接的时间(毫秒为单位)。默认值为
5000
。 ssl
用于 SSL 的密钥存储和信任存储的配置。
警告红帽建议显式禁用 SSLv2、SSLv3 和 TLSv1.0,以便在所有受影响的软件包中明确禁用 TLSv1.1 或 TLSv1.2。
-
Vault
- 库配置.如果未指定代码
或模块
,则将使用默认的实施。如果指定了代码
,但不指定模块
,它将在 Picketbox 模块中查找指定的类。如果指定了模块和代码
,它将在"模块
"指定的模块中查找由代码指定的类。 -
key-store
- 密钥存储. -
key-store-password
- 密钥存储密码。 -
alias
- 别名. -
key-password
- 密钥密码. -
trust-store
- truststore。 -
trust-store-password
- truststore 密码。 -
modify-trust-store
- 如果设置为true,则
CLI 将在收到未经识别的证书时提示用户,并允许它们存储在信任存储中。默认值为true
。
-
静默
-
是否将信息和错误消息写入终端。默认值为
false
。 access-control
-
是否应根据授予用户的权限为当前用户筛选与管理相关的命令和属性。例如,如果为
true
,则 Tab 补全将隐藏不允许该用户访问的命令和属性。默认值为true
。 echo-command
-
是否在输出中包含提示和命令,以非交互模式执行的命令。默认值为
false
。 command-timeout
-
等待命令完成的最长时间(以秒为单位)。值
0
表示没有超时。默认情况下没有超时。 output-json
- 是否以纯 JSON 格式显示操作响应。默认情况下,操作响应以 DMR 格式显示。
color-output
是否根据日志消息输出类型以颜色打印 CLI 日志输出:可用的颜色为
black
、蓝色
、cyan
、绿色
、magenta
、红色
、白色
和黄色
。-
启用
- 是否启用颜色输出。默认值为true
。 -
error-color
- 默认设置为红色
. -
warn-color
- 默认至黄色
. -
success-color
-默认到 default
,这是终端的默认前台颜色。 -
required-color
- 默认为magenta
。 -
workflow-color
- 默认为绿色
. -
prompt-color
- 默认到蓝色
.
-
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
)或属性值对(-D键=值
)。属性文件使用标准 KEY=VALUE
语法。
属性键在您的管理 CLI 命令中使用 ${MY_VAR}
语法表示,例如:
/host=${hostname}/server-config=${servername}:add(group=main-server-group)
有关其他 jboss-cli.xml
配置选项,请参阅 配置管理 CLI。