Skip to main content

IPMI Command Contents

The section provides detailed IPMI command contents.

GET PCS COLLECTED DATA​

NetFn

0x32

CMD

0x90

Request data

Byte 1

Response data

  • Byte 1 - Type
  • Byte [3:2] - Summary of minimum reading
  • Byte [5:4] - Summary of average reading
  • Byte [7:6] - Summary of maximum reading

Comments

[Request data]
Byte 1 - Type
  • 0x01 - AC-In
  • 0x02 - PCS power consumption
Note
The unit is 1 Joule.

GET PCS STATUS​

NetFn

0x32

CMD

0x91

Request data

N/A

Response data

  • Byte [2:1] - PCS EPOW
  • Byte [4:3] - PCS Throttle
  • Byte [6:5] - PCS Present
  • Byte [8:7] - PCS Power Good
  • Byte 9 - EPOW Out
  • Byte 10 - Throttle Out
  • Byte [12:11] - PCS Type
  • Byte [14:13] - Total Power Bank

Comments

[Response data]

Bit [0:3] - For PCS 1 to 4
  • 0b - Not trigger
  • 1b - Trigger

GET CHASSIS MONITORING STATUS​

NetFn

0x32

CMD

0x93

Request data

N/A

Response data

  • Byte 1 - Chassis Leakage Sensor Status
  • Byte 2 - Tray Leakage Sensor Present
  • Byte 3 - Tray Leakage Sensor Health
  • Byte 4 - Tray Leakage Sensor Alert
  • Byte 5 - Tray Spike Alert
  • Byte 6 - Tray PIB Power Fault
  • Byte 7 - PCS Leakage

Comments

[Response data]

Byte 1 - Chassis Leakage Sensor Status
  • Bit 0: Present
    • 0b - Not trigger
    • 1b - Trigger
  • Bit 1: Health
    • 0b - Abnormal
    • 1b - Normal
  • Bit 2: Alert
    • 0b - Normal
    • 1b - Abnormal
Byte 2 - Tray Leakage Sensor Present
  • 0b - Not Present
  • 1b - Present
Byte 3 - Tray Leakage Sensor Health
  • 0b - Abnormal
  • 1b - Normal
Byte 4 - Tray Leakage Sensor Alert
  • 0b - Normal
  • 1b - Leakage
Byte 5 - Tray Spike Alert
  • 0b - Normal
  • 1b - Spike Alert
Byte 6 - Tray PIB Power Fault
  • 0b - Normal
  • 1b - PIB Power Fault
Byte 7 - PCS Leakage
  • 0b - Normal
  • 1b - Leakage

GET SYS LED​

NetFn

0x32

CMD

0x96

Request data

N/A

Response data

  • Byte 1 - ID LED for Enclosure
  • Byte 2 - Check Log LED

Comments

[Response data]

Byte 1 - ID LED for Enclosure
  • 0x00 - Off
  • 0x01 - On
  • 0x02 - Blink
  • 0x03 - Accept mode - Off
  • 0x04 - Accept mode - On
  • 0x05 - Accept mode - Blink
Byte 2 - Check Log LED
  • 0x00 - Off
  • 0x01 - On

SET SYS LED​

NetFn

0x32

CMD

0x97

Request data

  • Byte 1 - LED type
  • Byte 2 - Function

Response data

  • Byte 1 - LED type
  • Byte 2 - Function

Comments

[Request data]

Byte 1 - LED type
  • 0x01 - ID LED for the Enclosure
Byte 2 - Function
  • 0x00 - Off
  • 0x01 - On
  • 0x02 - Blink
Note

  • While the ID LED has been set to Off, SMM3 will enter the accept mode, in which the LED behavior is determined by the node ID LEDs.

  • When SMM3 receives various settings from XCC in the accept mode, the Blink will be given the highest priority over On and Off (Off will be given the lowest priority).

GET NODE POWER READING​

NetFn

0x32

CMD

0x98

Request data

Byte 1 - Node number

Response data

  • Byte 1 - Node number
  • Byte [3:2] - Compute node minimum power reading
  • Byte [5:4] - Compute node average power reading
  • Byte [7:6] - Compute node maximum power reading
  • Byte [9:8] - GPU node minimum power reading
  • Byte [11:10] - GPU node average power reading
  • Byte [13:12] - GPU node maximum power reading

Comments

[Request data]
Byte 1 - Node number
  • For Tray 1 Node A: 0x1A
    • ...
  • For Tray 8 Node B: 0x8B
Note

  • The unit is 1 watt.

  • The chassis power reading is the summary of populated nodes.

GET NODE SIZE​

NetFn

0x32

CMD

0x99

Request data

Byte 1 - Node number

Response data

  • Byte 1 - Node number
  • Byte 2 - Node physical width
  • Byte 3 - Node physical height
  • Byte 4 - Add-on valid
  • Byte 5 - Add-on width
  • Byte 6 - Add-on height

Comments

[Request data]
Byte 1 - Node number
  • For Tray 1 Node A: 0x1A
    • ...
  • For Tray 8 Node B: 0x8B

GET CAP BOUNDARY​

NetFn

0x32

CMD

0x9D

Request data

Byte 1 - Node number

Response data

  • Byte 1 - Node number
  • Byte [3:2] - Minimum capping Value
  • Byte [5:4] - Maximum capping Value
  • Byte [7:6] - Protective Power capping Value
  • Byte [9:8] - User Power capping Value
  • Byte [11:10] - Thermal Power capping Value

Comments

[Request data]
Byte 1 - Node number
  • For Chassis: 0x00
  • For Tray 1 Node A: 0x1A
    • ...
  • For Tray 8 Node B: 0x8B
Note

  • The Power Capping will only be applied in OS-runtime.

  • The unit is 1 watt.

SET CAPPING VALUE​

NetFn

0x32

CMD

0x9E

Request data

  • Byte 1 - Node number
  • Byte [3:2] - Capping value

Response data

  • Byte 1 - Node number
  • Byte [3:2] - Capping value

Comments

[Request data]
Byte 1 - Node number
  • For Chassis: 0x00
  • For Tray 1 Node A: 0x1A
    • ...
  • For Tray 8 Node B: 0x8B
Note
The unit is 1 watt.

SET CAPPING STATE​

NetFn

0x32

CMD

0x9F

Request data

  • Byte 1 - Node number
  • Byte 2 - Capping mode
  • Byte 3 - Saving mode

Response data

  • Byte 1 - Node number
  • Byte 2 - Capping mode
  • Byte 3 - Saving mode

Comments

[Request data]
Byte 1 - Node number
  • For Chassis: 0x00
  • For Tray 1 Node A: 0x1A
    • ...
  • For Tray 8 Node B: 0x8B
Byte 2 - Capping mode
  • 0x00 - Disable
  • 0x01 - Enable
Byte 3 - Saving mode
  • 0x00 - Disable
Note
Byte 3 is reserved for backward compatible.

GET CAPPING STATE​

NetFn

0x32

CMD

0xA0

Request data

  • Byte 1 - Node number

Response data

  • Byte 1 - Node number
  • Byte 2 - Capping mode
  • Byte [4:3] - Capping value
  • Byte 5 - Saving mode

Comments

[Request data]
Byte 1 - Node number
  • For Chassis: 0x00
  • For Tray 1 Node A: 0x1A
    • ...
  • For Tray 8 Node B: 0x8B
[Response data]
Byte 2 - Capping mode
  • 0x00 - Disable
  • 0x01 - Enable
Byte 5 - Saving mode
  • 0x00 - Disable
  • 0x01 - Enable

SET DATE TIME​

NetFn

0x32

CMD

0xA1

Request data

  • Byte [1:2] - Year
  • Byte 3 - Month
  • Byte 4 - Date
  • Byte 5 - Hour
  • Byte 6 - Minute
  • Byte 7 - Second

Response data

  • Byte [1:2] - Year
  • Byte 3 - Month
  • Byte 4 - Date
  • Byte 5 - Hour
  • Byte 6 - Minute
  • Byte 7 - Second

Comments

[Request data]
Example: 2037/12/31 23:59:59
  • Byte 1 - 0x20
  • Byte 2 - 0x37
  • Byte 3 - 0x12
  • Byte 4 - 0x31
  • Byte 5 - 0x23
  • Byte 6 - 0x59
  • Byte 7 - 0x59

GET PCS POLICY OVS​

NetFn

0x32

CMD

0xA2

Request data

N/A

Response data

  • Byte 1 - PCS policy
  • Byte 2 - OVS mode

Comments

[Response data]
Byte 1 - PCS policy
  • 0x00 - No redundant
  • 0x01 - N+1 policy
  • 0x02 - N+N policy
Byte 2 - OVS mode
  • 0x00 - Disable
  • 0x01 - Enable

SET PCS POLICY OVS​

NetFn

0x32

CMD

0xA3

Request data

  • Byte 1 - PCS policy
  • Byte 2 - OVS mode

Response data

  • Byte 1 - PCS policy
  • Byte 2 - OVS mode
Note
 1 PCS2 PCS3 PCS4 PCS
N+0√√√√
N+1××××
N+1 w/ OVS×√√√
N+N××××
N+N w/ OVS×××√

Comments

[Request data]
Byte 1 - System PCS policy
  • 0x00 - No redundant
  • 0x01 - N+1 policy
  • 0x02 - N+N policy
Byte 2 - System OVS mode
  • 0x00 - Disable
  • 0x01 - Enable
Byte 3 - Status
  • 0x00 - OK
  • 0x01 - Present error
  • 0x02 - Insufficient Bank

Byte 4 - User PCS policy

Byte 5 - User OVS mode

SET NODE RESET / RESEAT​

NetFn

0x32

CMD

0xA4

Request data

  • Byte 1 - Node number
  • Byte 2 - Reset mode

Response data

  • Byte 1 - Node number
  • Byte 2 - Reset mode

Comments

[Request data]
Byte 1 - Node number
  • For Tray 1 Node A: 0x1A
    • ...
  • For Tray 8 Node B: 0x8B
Byte 2 - Reset mode

  1. Reset (BMC reset)

  2. Reseat (AC cycle)

Note
The response D5h indicates the node is not present.

BACKUP / RESTORE​

NetFn

0x32

CMD

0xA6

Request data

  • Byte 1 - Action
  • Byte 2 - Password Length
  • Byte [3:N] - Password String

Response data

Byte 1 - Status

Comments

[Request data]
Byte 1 - Action
  • 0x00 - Get backup or restore status
  • 0x01 - Backup to storage device
  • 0x02 - Restore from storage device
Byte 2 - Password length
Note
Support when Action is 0x01 or 0x02
Byte [3:N] - Password string
Note
Support when Action is 0x01 or 0x02
[Response data]
Byte 1 - Status
  • 0x00 - COMMAND OK
  • 0x01 - BACKUP RESTORE RUNNING
  • 0x31 - BACKUP FINISHED
  • 0x32 - BACKUP FAIL
  • 0x41 - RESTORE FINISHED
  • 0x42 - RESTORE FAIL
Note

  • This command is used to backup/restore configuration to/from an external storage device, such as USB dongle. The status will be fault when the storage device is not inserted.

  • When Request Action is 0x01/0x02, Password string must use a minimum of eight (up to 20) printable US-ASCII (Code: 33-126) characters and contain characters from three of the following four categories:

    • English uppercase characters (A through Z)

    • English lowercase characters (a through z)

    • Base 10 digits (0 through 9)

    • Non-alphabetic characters (for example, !, $, #, %)

    Note
    If the password validation fails, the command will reply 0xCC status code.

GET NODE STATUS​

NetFn

0x32

CMD

0xA7

Request data

Byte 1 - Node number

Response data

  • Byte 1 - Node number
  • Byte 2 - Power state
  • Byte 3 - Width
  • Byte 4 - Height
  • Byte 5 - Permission state

Comments

[Request data]
Byte 1 - Node number
  • For Tray 1 Node A: 0x1A
    • ...
  • For Tray 8 Node B: 0x8B
Byte 2 - Power state
  • 0x00 - Permission to standby
  • 0x01 - First permission fail
  • 0x02 - Second permission fail
  • 0x03 - Permission pass
  • 0xFF - Initial not done

GET SMM3 STATUS​

NetFn

0x32

CMD

0xA8

Request data

N/A

Response data

  • Byte 1 - Platform ID
  • Byte 2 - Firmware Major Version
  • Byte 3 - Firmware Minor Version
  • Byte 4 - PSOC Patch Version
  • Byte 5 - FPGA Major Version
  • Byte 6 - FPGA Minor Version
  • Byte 7 - Boot Flash Number
  • Byte [8:14] - Firmware Build ID
  • Byte 15 - Minimum power supplies installed required

Comments

[Response data]
Byte 1 - Platform ID
  • 0x00: For N1380
Byte 7 - Boot Flash Number
  • 0x01 - primary section
  • 0x02 - backup section
Byte [8:14] - Firmware Build ID
  • Plain text in ASCII code.

Byte 15 - Minimum power supplies installed required, 1~4

SET NODE RESTORE POLICY​

NetFn

0x32

CMD

0xA9

Request data

  • Byte 1: Tray 1 Restore Policy
  • Byte 2: Tray 2 Restore Policy
  • Byte 3: Tray 3 Restore Policy
  • Byte 4: Tray 4 Restore Policy
  • Byte 5: Tray 5 Restore Policy
  • Byte 6: Tray 6 Restore Policy
  • Byte 7: Tray 7 Restore Policy
  • Byte 8: Tray 8 Restore Policy

Response data

  • Byte 1: Tray 1 Restore Policy
  • Byte 2: Tray 2 Restore Policy
  • Byte 3: Tray 3 Restore Policy
  • Byte 4: Tray 4 Restore Policy
  • Byte 5: Tray 5 Restore Policy
  • Byte 6: Tray 6 Restore Policy
  • Byte 7: Tray 7 Restore Policy
  • Byte 8: Tray 8 Restore Policy

Comments

[Request data]
Byte N: Tray N Restore Policy

  • Bit [7:6]: Node D

    • 01b: Last state
    • 00b: Off

  • Bit [5:4]: Node C

  • Bit [3:2]: Node B

  • Bit [1:0]: Node A

GET NODE RESTORE POLICY​

NetFn

0x32

CMD

0xAA

Request data

N/A

Response data

  • Byte 1: Tray 1 Restore Policy
  • Byte 2: Tray 2 Restore Policy
  • Byte 3: Tray 3 Restore Policy
  • Byte 4: Tray 4 Restore Policy
  • Byte 5: Tray 5 Restore Policy
  • Byte 6: Tray 6 Restore Policy
  • Byte 7: Tray 7 Restore Policy
  • Byte 8: Tray 8 Restore Policy

Comments

[Response data]
Byte N: Tray N Restore Policy

  • Bit [7:6]: Node D

    • 01b: Last state
    • 00b: Off

  • Bit [5:4]: Node C

  • Bit [3:2]: Node B

  • Bit [1:0]: Node A

SET PCS ZERO OUTPUT MODE​

NetFn

0x32

CMD

0xAB

Request data

Byte 1 - User Output Mode

Response data

N/A

Comments

refer to GET PCS ZERO OUTPUT MODE.

Note
If any power supply is not support or the power supplies are mismatched, the zero output mode will be disabled.

GET PCS ZERO OUTPUT MODE​

NetFn

0x32

CMD

0xAC

Request data

N/A

Response data

  • Byte 1 - User Output Mode
  • Byte 2 - Zero output status

Comments

[Response data]
Byte 1 - User configuration
  • 0x00: Disable
  • 0x01: Update per 10 mins
  • 0x02: Update per 30 mins
  • 0x03: Update per 60 mins
Byte 2 - Status
  • 0x00: Disable
  • 0x01: Zero output is running
  • 0x02: Zero output mode is deactivate

SMM3 RESET TO DEFAULT​

NetFn

0x32

CMD

0xAD

Request data

N/A

Response data

Byte 1 - Status code

Comments

[Response data]
Byte 1 - Status code
  • 0x00 - Running

SET VPD​

NetFn

0x32

CMD

0xAD

Request data

  • Byte 1 - VPD type
  • Byte 2 - Device ID
  • Byte [3:N] - VPD data

Response data

  • Byte 1 - VPD type
  • Byte 2 - Device ID

Comments

[Response data]
Byte 1 - VPD type
  • 0x00 - SMM3
  • 0x05 - Enclosure
  • 0x08 - Interposer
Byte 2 - Device ID
CodeDescriptionBytesEnclosureSMM3Interposer
0x00Machine type Model10 bytes√  
0x01Machine serial Number10 bytes√  
0x02Component part Number12 bytes√√√
0x03Component FRU Number12 bytes√√√
0x04Component Serial Number12 bytes√√√
0x05Manufacture ID4 bytes√√ 
0x06Hardware Revision Level1 byte √√
0x07Manufacture Date4 bytes√√√
0x08UUID16 bytes√√√
0x09IANA Enterprise Number4 bytes√  
0x0AProduct ID2 bytes√  
0x0BComponent Name11 bytes√  
0x0CGLID11 bytes√  
0x0DEC Level10 bytes√√√

GET VPD​

NetFn

0x32

CMD

0xB0

Request data

  • Byte 1 - VPD type
  • Byte 2 - Device ID

Response data

  • Byte 1 - VPD type
  • Byte 2 - Device ID
  • Byte [3:N] - VPD data

Comments

Refer to SET VPD.

FFDC DUMP​

NetFn

0x32

CMD

0xB1

Request data

  • Byte 1 - Function
  • Byte [2:N] - Data (option)

Response data

  • Byte 1 - Status

Comments

[Request data]
Byte 1 - Function
  • 0x00: Query status
  • 0x01: FFDC dump to TFTP Server.
  • 0x02: FFDC dump to USB.
Byte [2:N] - Data (option)
  • For TFTP server only:
    • ASCII string of TFTP server address and path, separated by “/”. The path can be empty.
[Response data]
Byte 1 - Status
  • For Query Status:
    • 0x00: Finished
    • 0x01: Running
    • 0x02: Reserved
    • 0x03: No USB
    • 0x04: Tar fail
    • 0x0E: Upload fail
    • 0x0F: TFTP server not found
  • For FFDC dump to TFTP Server:
    • 0x00 - Done
  • For FFDC dump to USB:
    • 0x00 - Done
Note
The maximum length of the field is 64 characters.
Follow steps illustrate how to dump FFDC over IPMI:

  1. Run FFDC dump to TFTP server: Set TFTP server address where the IP is in HEX, the example below is set TFTP server address as 192.168.1.1.

    • ipmitool -H SMM3_IP -U USERID -P PASSW0RD -I lanplus raw 0x32 0xB1 0x01 0x31 0x39 0x32 0x2E 0x31 0x36 0x38 0x2E 0x31 0x2E 0x31

  2. Query FFDC dump status:

    • ipmitool -H SMM3_IP -U USERID -P PASSW0RD -I lanplus raw 0x32 0xB1 0x00

  3. Run FFDC dump to USB:

    • Ipmitool -H SMM3_IP -U USERID -P PASSW0RD -I lanplus raw 0x32 0xB1 0x02
Note
The FFDC log file name is SMM3-MAC_addr-FFDC-YYYY-MM-DD-HHMMSS.tgz

SET SMTP CONFIG PARAMETERS​

NetFn

0x32

CMD

0xB2

Request data

  • Byte 1 - Parameter selector
  • Byte [2:N] - Data

Response data

  • Byte 1 - Parameter selector
  • Byte [2:N] - Data

Comments

Refer to Table -SMTP Configuration Parameters for Parameter Selector and Data.

GET SMTP CONFIG PARAMETERS​

NetFn

0x32

CMD

0xB3

Request data

  • Byte 1 - Parameter selector
  • Byte 2 - Set selector
  • Byte 3 - Block selector

Response data

  • Byte 1 - Parameter selector
  • Byte [2:N] - Data

Comments

[Request data]
Byte 2 - Set Selector
  • 0x00: Parameter doesn’t require a Set Selector.
Byte 3 - Block Selector
  • 0x00: Parameter doesn’t require a Block Selector.
Note
Refer to Table -SMTP Configuration Parameters for parameter/set/block selectors and data.

GET PCS DATA​

NetFn

0x32

CMD

0xC3

Request data

Byte 1 - PCS number

Response data

  • Byte 1 - PCS number
  • Byte [3:2] - Fan A speed
  • Byte [5:4] - Fan B speed
  • Byte [7:6] - VIN
  • Byte [9:8] - PCS type

Comments

[Request data]
Byte 1 - PCS number
  • For N1380 Enclosure
    • PCS 1 ~ 4: 0x01 ~ 0x04
[Response data]

Byte [3:2] - Reserved

Byte [5:4] - Reserved

Byte [7:6] - VIN
  • The unit is 1 voltage.
Byte [9:8] - PCS type
  • The unit is 1 watt.
Note
Fan B speed will be 0x00 for single fan PCS.

GET WEB STATE​

NetFn

0x32

CMD

0xF0

Request data

N/A

Response data

Byte 1 - State

Comments

[Response data]
Byte 1 - State
  • 0x00 - Disabled
  • 0x01 - Enabled

SET WEB STATE​

NetFn

0x32

CMD

0xF1

Request data

Byte 1 - State

Response data

Byte 1 - State

Comments

[Request data]
Byte 1 - State
  • 0x00 - Disabled
  • 0x01 - Enabled

ENCLOSURE VIRTUAL RESEAT​

NetFn

0x32

CMD

0xF5

Request data

N/A

Response data

Byte 1 - Status

Comments

[Response data]
Byte 1 - Status
  • 0x00 - Proceeding

SET SYSTEM ENCLOSURE LRU​

NetFn

0x32

CMD

0xF6

Request data

  • Byte 1 - Function
  • Byte 2 - LRU

Response data

  • Byte 1 - Function
  • Byte 2 - Current LRU
  • Byte 3 - Previous LRU (Option for Read)

Comments

[Request data]
Byte 1 - Function
  • 0x00 - Write
  • 0x01 - Read
Byte 2 - LRU
  • Enclosure LRU

GET SECURITY OPTION​

NetFn

0x32

CMD

0xFA

Request data

Byte 1 - Type

Response data

  • Byte 1 - Type
  • Byte 2 - Setting
  • Byte 3 - Setting (option)

Comments

[Request data]
Byte 1 - Type
  • 0x00 - Minimum password length
  • 0x01 - Force user to change password on first access
  • 0x02 - Password expiration period (in days)
  • 0x03 - Password expiration warning period (in days)
  • 0x04 - Minimum password change interval (in hours)
  • 0x05 - Minimum password reuse cycle
  • 0x06 - Maximum number of login failures
  • 0x07 - Lockout period after maximum login failures (in minutes)
  • 0x08 - Enable IP address block for 300 seconds after 10 login failures
  • 0x09 - Password Complexity Rule
  • 0x0A - Enable Secure Rollback
Byte 2 - LRU
  • Enclosure LRU
[Response data]
Byte 3 - Configuration setting (option)
  • MSB for two bytes data
Byte 2 - LRU
  • Enclosure LRU
Note
  • Password Complexity Rules: (Rules should be enabled starting with rule 1, and up to the number of rules specified) 0x00: Password Complexity Rules disabled.
    • 0x00 - Password Complexity Rules disabled.
    • 0x01 - contains at least one letter
    • 0x02 - contains at least one number
    • 0x03 - contains at least two of the following:

      • An uppercase letter

      • A lowercase letter

      • A special character: !@#$%^*-_+=().:`|?"\

    • 0x04: Cannot be a repeat or reverse of the corresponding user-name
    • 0x05: May contain at most 2 consecutive occurrences of the same character
  • Password does not allow white-space and the special characters below: ~'&<>/[]{};,

SET SECURITY OPTION​

NetFn

0x32

CMD

0xFB

Request data

  • Byte 1 - Type
  • Byte 2 - Setting
  • Byte 3 - Setting (option)

Response data

  • Byte 1 - Type
  • Byte 2 - Setting
  • Byte 3 - Setting (option)

Comments

Refer to GET SECURITY OPTION.