配置键
配置键是对应于软件代理的配置参数的字符串。您可以使用配置键在创建容器时设置软件事件代理的配置参数。您可以通过在启动时将配置键及其值传递给容器运行时来实现（例如，作为docker create的参数）。
有关使用这些键的信息，请参见初始化软件事件代理容器。
以下表格列出了软件事件代理的配置键。
| 配置键 | 描述 | 值 |
|---|---|---|
| bruteforceprotection/enable | 启用暴力破解保护。有关更多信息，请参见配置暴力破解保护。 | yes 或 no |
默认值为 yes。 | ||
| configsync/enable | 启用配置同步。 | |
| 在软件事件代理初始化后，要同步HA对，您必须手动断言一个事件代理的系统级配置覆盖其配对。有关更多信息，请参见断言事件代理系统配置。 | yes 或 no | |
默认值为 no。 | ||
| configsync/tls/enable | 启用TLS加密的使用。 | |
| 如果启用，并且也启用了冗余，必须为config-sync配置预共享密钥才能操作。 | yes 或 no | 默认值为 no。 |
interface/<ip_intf>/physical | Docker主机（Linux）绑定到Solace PubSub+ IP接口的物理接口。 | <os interface> |
interface/<ip_intf>/virtualrouter | 分配给Solace PubSub+ IP接口的虚拟路由器。 | static, primary 或 backup |
默认值为 static。 | ||
interface/<ip_intf>/enable | 指示是否启用Solace PubSub+ IP接口。 | yes 或 no |
logging/<log_facility>/output | 日志流发送的位置。有关更多信息，请参见配置容器日志。 | file, stdout, all 或 none |
默认值为 file。 | ||
有效的<log_facility>值为 debug, command, system, event 或 kernel。 | ||
logging/<log_facility>/format | 如果日志流发送到stdout，其格式。有关更多信息，请参见配置容器日志。 | legacy, rfc5424, graylog 或 raw |
默认值为 legacy。 | ||
如果指定file作为日志流目的地，输出始终以legacy格式。 | ||
有效的<log_facility>值为 debug, command, system, event 或 kernel。 | ||
logging/<log_facility>/messageformat | 从事件代理发出的syslog消息的格式。 | |
messageformat键仅适用于事件和系统syslog设施。 | text 或 json | |
默认值为 text。 | ||
如果指定json，则忽略对应的logging/<log_facility>/format值（格式始终为raw） 。如果后来通过CLI切换此值，也是如此。 | ||
| logging/maxjsonmessagesize | JSON日志消息的最大字节大小。如果配置了远程syslog目的地，包括syslog头。 | <max-size>值在1024和8192之间。 |
默认值为8192。 | ||
| logging/retentionpolicy | 控制SolOS日志文件保留的政策。如果指定了max-size，则日志文件将保留到SolOS允许的最大文件大小。如果指定了days，则日志文件将保留logging/retentionpolicymaxnumdays键指示的天数。 | max-size 或 days。 |
默认值为 max-size。 | ||
| logging/retentionpolicymaxnumdays | 仅当logging/retentionpolicy键设置为days时适用。SolOS日志文件保留的最大天数。如果日志输出量很大，实际保留的天数可能小于此值。 | <max-num-days>值在2和90之间。默认值为30。 |
| messagespool/maxspoolusage | 事件代理的可用消息缓冲资源（以MB为单位）的最大用量，可用于缓冲消息。有关详细信息，请参见配置最大缓冲使用量。 | 有效范围从0（在这种情况下，缓冲实际上被禁用）到整个系统支持的最大消息缓冲磁盘空间。 |
| messagevpn/<name>/service/amqp/port | 软件事件代理容器中与<name>消息VPN关联的AMQP服务使用的端口。 | <port_number> |
| messagevpn/<name>/service/amqp/tlsport | 与消息VPN <name>关联的AMQP服务在软件事件代理容器中用于TLS流量的端口。 | <port_number> 此设置仅在配置了TLS服务器证书时生效。 |
| messagevpn/<name>/service/mqtt/port | 与消息VPN <name>关联的MQTT服务在软件事件代理容器中使用的端口。 | <port_number> |
| messagevpn/<name>/service/mqtt/tlsport | 与消息VPN <name>关联的MQTT服务在软件事件代理容器中用于TLS流量的端口。 | <port_number> 此设置仅在配置了TLS服务器证书时生效。 |
| messagevpn/<name>/service/mqtt/webport | 与消息VPN <name>关联的MQTT服务在软件事件代理容器中通过WebSockets使用的端口。 | <port_number> |
| messagevpn/<name>/service/mqtt/tlswebport | 与消息VPN <name>关联的MQTT服务在软件事件代理容器中通过WebSockets用于TLS流量的端口。 | <port_number>此设置仅在配置了TLS服务器证书时生效。 |
| messagevpn/<name>/service/rest/port | 与消息VPN <name>关联的REST服务在软件事件代理容器中使用的端口。 | <port_number> |
| messagevpn/<name>/service/rest/tlsport | 与消息VPN <name>关联的REST服务在软件事件代理容器中用于TLS流量的端口。 | <port_number> |
| 此设置仅在配置了TLS服务器证书时生效。 | ||
| nodetype | 高可用性（HA）组节点类型。 | message_routing 或 monitoring |
默认值为 message_routing。 | ||
| productkey | 安装与指定产品密钥关联的功能。有关更多信息，请参见软件事件代理上的产品密钥。 | 与所需功能关联的产品密钥。 |
| redundancy/activestandbyrole | HA组中消息路由节点的主动备用角色。 | primary 或 backup |
默认值为 primary。 | ||
| redundancy/authentication/presharedkey/key | 用作冗余预共享密钥的base64编码密钥。 | <key> |
| redundancy/authentication/presharedkey/keyfilepath | 包含用作冗余预共享密钥的base64编码密钥的文件路径。 | <key-file-path> |
必须提供key或keyfilepath中的一个。包含密钥的文件的相对路径是相对于/run/secrets目录的。 | ||
| redundancy/enable | 启用冗余。 | yes 或 no |
默认值为 no。 | ||
| redundancy/group/node/<name>/connectvia | HA组中节点的完全限定域名（FQDN）或IP地址（和可选端口）。 | <addr-port> |
| redundancy/group/node/<name>/nodetype | 高可用性（HA）组节点类型。 | message_routing 或 monitoring |
默认值为 message_routing。 | ||
| redundancy/matelink/tls/enable | 启用mate-link使用TLS加密。 | yes 或 no |
默认值为 no。 | ||
| redundancy/matelink/remote/port | mate-links在HA配对上连接的端口。 | <port> |
| redundancy/mate/smf/port | 配对事件代理用于纯文本SMF流量的端口。仅当每个HA配对监听不同端口时需要此设置。 | <port_number> |
| redundancy/mate/smf/compressedport | 配对事件代理用于压缩SMF流量的端口。仅当每个HA配对监听不同端口时需要此设置。 | <port_number> |
| redundancy/mate/smf/tlsport | 配对事件代理用于TLS/SSL SMF流量的端口。仅当每个HA配对监听不同端口时需要此设置。 | <port_number> |
| routername | Solace PubSub+路由器名称。 | <router_name> <router_name>必须仅使用小写字母和0到9的数字构造，特别是当它用于配置冗余时。使用其他字符将阻止冗余的正常工作。 |
| service/healthcheck/port | 健康检查服务监听的端口。 | <port_number> |
| service/healthcheck/tlsport | 健康检查服务监听TLS流量的端口。 | <port_number> 此设置仅在配置了TLS服务器证书时生效。 |
| service/matelink/port | matelink服务监听的端口。 | <port_number> |
| service/ssh/port | 软件事件代理容器中sshd进程使用的端口（对应于Solace PubSub+ SSH，请参见软件事件代理的默认配置）。 | <port_number> |
| service/semp/port | SEMP服务在软件事件代理容器中使用的端口。 | <port_number> |
| service/semp/tlsport | SEMP服务在软件事件代理容器中用于TLS流量的端口。此设置仅在配置了TLS服务器证书时生效。 | <port_number> |
| service/smf/compressedport | SMF服务在软件事件代理容器中用于压缩流量的端口。 | <port_number> |
| service/smf/port | SMF服务在软件事件代理容器中使用的端口。 | <port_number> |
| service/smf/routingport | SMF服务在软件事件代理容器中用于路由控制流量的端口。 | <port_number> |
| service/smf/tlsport | SMF服务在软件事件代理容器中用于TLS流量的端口。 | <port_number> |
| 此设置仅在配置了TLS服务器证书时生效。 | ||
| service/amqp/tlsport | AMQP服务在软件事件代理容器中用于TLS流量的全局端口。 | <port> |
| 此设置仅在配置了TLS服务器证书时生效。 | ||
| service/webtransport/port | Web Transport服务在软件事件代理容器中使用的端口。 | <port_number> |
| service/webtransport/tlsport | Web Transport服务在软件事件代理容器中用于TLS流量的端口。 | <port_number> |
| 此设置仅在配置了TLS服务器证书时生效。 | ||
| service/redundancy/firstlistenport | 前三个端口用于冗余活动选举。第二和第三个端口根据需要使用。有关更多信息，请参见软件事件代理的默认配置。 | <port_number> |
| system/scaling/maxbridgecount | 支持的最大VPN桥接连接数。有关更多信息，请参见VPN桥接的最大数量。 | 25, 500, 或 5000。 |
对于10.7.1及更高版本的事件代理，默认值是25如果max-connections是100或1000，否则是500。 | ||
| system/scaling/maxconnectioncount | 支持的最大客户端连接数。有关更多信息，请参见客户端连接的最大数量。 | 100, 1000, 10000, 100000 或 200000 |
默认值为 100。 | ||
| system/scaling/maxkafkabridgecount | 支持的最大Kafka桥接数。有关更多信息，请参见Kafka桥接的最大数量。 | 0, 10, 50, 或 200 |
默认值为 0。 | ||
| system/scaling/maxkafkabrokerconnectioncount | 支持的最大Kafka代理连接数。有关更多信息，请参见Kafka代理连接的最大数量。 | 0, 300, 2000, 或 10000 |
默认值为 0。 | ||
| system/scaling/maxqueuemessagecount | 支持的最大队列消息数，以百万条消息为单位。有关更多信息，请参见队列消息的最大数量。 | 100, 240, 或 3000 |
对于10.8.1及更高版本的事件代理，默认值是100如果max-connections是100，否则是240。 | ||
| system/scaling/maxsubscriptioncount | 支持的最大订阅数。有关更多信息，请参见订阅的最大数量。 | 50000, 500000, 或 5000000 |
默认值是100连接的50000和1000连接的500000。 | ||
| tls/crimeexploitprotection/enable | 启用TLS+压缩的CRIME漏洞保护。有关更多信息，请参见配置CRIME漏洞保护。 | yes 或 no |
默认值为 yes。 | ||
| tls/servercertificate/filepath | 包含TLS服务器证书的文件的完整路径。 | <filepath> |
如果文件中的TLS服务器证书是加密的，则必须通过tls/servercertificate/passphrasefilepath配置键提供包含用于解密的密码短语的文件路径。 | ||
包含密钥的文件的相对路径是相对于/run/secrets目录的。 | ||
| tls/servercertificate/passphrasefilepath | 包含用于解密加密TLS服务器证书的密码短语的文件的完整路径。 | <filepath> |
包含密钥的文件的相 对路径是相对于/run/secrets目录的。 | ||
| username/<name>/password | Solace CLI用户名<name>的明文密码。 | <password> |
| 此配置键仅适用于开发和测试活动，不推荐用于生产部署，因为这不是向Solace PubSub+传输凭证的安全方式。 | ||
| username/<name>/encryptedpassword | Solace CLI用户名<name>的加密密码。 | <encryptedpassword> |
| 支持SHA-512。 | ||
哈希前的盐值，格式应为：$6$salt$hashed-password | ||
| username/<name>/globalaccesslevel | 创建用户名<name>的Solace CLI用户，并分配全局访问权限。 | none, read-only, read-write, admin。 |
默认值为 none。 | ||
| username/<name>/passwordfilepath | 包含用户名\<name\>密码的文件的完整路径。 | <passwordfilepath> |
包含密钥的文件的相对路径是相对于/run/secrets目录的。 | ||
| webmanager/redirecthttp/enable | 启用或禁用在访问Broker Manager时将纯文本HTTP请求重定向到安全的HTTPS连接。 | yes 或 no |
| webmanager/redirecthttp/overridetlsport | 用于覆盖默认SEMP HTTPS端口的HTTPS端口。当访问Broker Manager时，所有HTTP请求将被重定向到指定的HTTPS端口。如果HTTPS端口值指定为零（0），将使用配置的SEMP SSL/TLS端口。 | 0 … 65535 |