Activate Payload 命令详情
更新时间：2025/06/26
在Gitcode上查看源码修订记录
| openUBMC版本号 | 修订日期 | 修订人 | 修订内容 |
|---|---|---|---|
| 25.06 | 2025/06/26 | pengqiang-gs | 初稿，新增命令详情 |
基本信息
功能说明
标准命令，激活或者去激活一个IPMI会话的负载类型。当前命令仅用于 RMCP 会话。 This command is used for activating and deactivating a payload type under a given IPMI session.
权限
KvmMgmt
命令信息
请求信息
| 字节顺序 | 域取值说明 |
|---|---|
| 1 | [7:6] - reserved [5:0] - payload type(See Payload Type Numbers). IPMI Message payloads do not need to be explicitly activated. A payload that is required to be launched over a different port than that used to establish the initial IPMI session is only required to support the IPMI commands needed by the particular payload type. |
| 2 | Payload Instance [7:4] - reserved [3:0] - payload instance. 1-based. 0h = reserved. |
| 3:6 | Auxiliary Request Data. Additional payload-specific parameters to configure behavior of the payload when it becomes activated. Ignored if no auxiliary data is specified for given payload type. For Payload Type = SOL: byte 1 [7] - Encryption Activation Note: the encryption algorithms specified in this document must be used with Authentication. The BMC will return an error completion code if an attempt is made to activate encryption without also activating authentication. 1b: Activate payload with encryption. All SOL payload data from the BMC will be encrypted, if encryption was negotiated at the time of session activation. 0b: Activate payload without encryption. BMC will send all SOL payload data unencrypted, if that option is allowed. (An SOL configuration parameter allows a system to be configured to require encryption for all SOL transfers) [6] - Authentication Activation 1b: Activate payload with authentication. All SOL payload data from the BMC will be authenticated, if authentication was negotiated at the time of session activation. 0b: Activate payload without authentication. BMC will send all SOL payload data unauthenticated, if that option is allowed. (An SOL configuration parameter allows a system to be configured to require authentication for all SOL transfers) [5] - Test Mode (optional). Enables DCD/ and DSR to be manually controlled by the remote console and the reporting of RTS and DTR state via the SOL Operation/Status byte. This can be used to facilitate software testing of the 16550 UART interface. 1b = activate test mode. If test mode is not supported, bit [0] of the auxiliary response data will be returned as 0b. 0b = deactivate test mode [4] - reserved [3:2] - Shared Serial Alert Behavior The following settings are determine what happens to serial alerts if IPMI over Serial and SOL are sharing the same baseboard serial controller. 11b: Reserved 10b: Serial/modem alerts succeed while SOL active. 01b: Serial/modem alerts deferred while SOL active. 00b: Serial/modem alerts fail while SOL active. [1] - SOL startup handshake 0b: BMC asserts CTS and DCD/DSR to baseboard upon activation. 1b: CTS and DCD/DSR remain deasserted after activation. Remote console must send an SOL Payload packet with control field settings to assert CTS and DCD/DSR. (This enables the remote console to first alter volatile configuration settings before hardware handshake is released). [0] - reserved byte 2:4 reserved - write a 00 |
响应信息
| 字节顺序 | 域取值说明 |
|---|---|
| 1 | Completion Code Generic plus the following command-specific completion codes: (An error completion code should be returned if the payload type in the request is set to “IPMI Message” ( 0h ) ). 80h: Payload already active on another session (required). This will be returned any time an attempt is made to activate a payload type when that type is already activated for another session, and when the BMC only supports one instance of that payload type running at a time. 81h: Payload type is disabled (optional). Given payload type is not configured to be enabled for activation. 82h: Payload activation limit reached. Cannot activate given payload type because the maximum number of simultaneous instances of that payload type are already running. 83h: Cannot activate payload with encryption. 84h: Cannot activate payload without encryption. BMC requires encryption for all payloads for given privilege level. |
| 2:5 | Auxiliary Response Data. LS-byte first. For Payload = SOL: [31:1] - reserved. Return as 0s [0] - 0b = test mode not supported / enabled 1b = test mode enabled |
| 6:7 | Inbound Payload Size Maximum size of payload data field from remote console to BMC. Excludes size of confidentiality header and trailer fields, if any. 1-based. |
| 8:9 | Outbound Payload Size Maximum size of payload data field from BMC to remote console. Excludes size of confidentiality header and trailer fields, if any. 1-based. |
| 10:11 | Payload UDP Port Number UDP port number that payload can be transferred over. If the port number is same as the port that was used to establish the IPMI session, then SOL payload transfers are now available under that IPMI session on that port. Otherwise, the remote console will need to establish a separate IPMI Session to the specified Port Number using the same IP Address, username and password/key information that was used to establish the IPMI session. SOL payload transfers will then be available over that session. If the remote console already has an IPMI session established on that port for a different payload type, the SOL payload type will now also be available over that session - provided that the session was established at a privilege level that matches the privilege level and authentication required for SOL. Otherwise, the remote console will need to close that session and reestablish it at the necessary privilege level. |
| 12:13 | Payload VLAN Number - FFFFh if VLAN addressing is not used. |
命令样例
样例1：设置用户2的密码
- 请求：
- 响应：