BMCDeviceMessaging 子类方法 - KPTest框架开放资料

Skip to content

# BMCDeviceMessaging 子类方法

1. ipmi_set_bmc_global_enables
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.1 设置BMC全局启用应用程序06h 2Eh管理员
                  Set BMC Global Enables App 06h 2Eh Administrator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_bmc_global_enables(params)

2. ipmi_get_bmc_global_enables
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.2 获取BMC全局启用应用程序06h 2Fh用户
                  Get BMC Global Enables App 06h 2Fh User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_bmc_global_enables(params)

3. ipmi_clear_message_flags
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.3 清除消息标志应用06h 30h用户
                  Clear Message Flags App 06h 30h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_clear_message_flags(params)

4. ipmi_get_message_flags
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.4 获取消息标志应用程序06h 31h用户
                  Get Message Flags App 06h 31h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_message_flags(params)

5. ipmi_get_message
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.5 获取消息应用程序06h 33h用户
                  Get Message App 06h 33h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_message(params)

6. ipmi_send_message
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.6 发送消息应用程序06h 34h用户
                  Send Message App 06h 34h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_send_message(params)

7. ipmi_read_message
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.7 阅读消息应用程序06h 35h用户
                  Read Message App 06h 35h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_read_message(params)

8. ipmi_get_system_guid
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.8 获取系统GUID应用程序06h 37h保留
                  Get System GUID App 06h 37h RESERVED

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_system_guid(params)

9. ipmi_get_channel_authentication_capabilities
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.9 获取通道身份验证功能应用程序06h 38h保留
                  Get Channel Authentication Capabilities App 06h 38h RESERVED

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_channel_authentication_capabilities(params)

10. ipmi_get_session_challenge
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.10 获取会话挑战应用程序06h 39h保留
                  Get Session Challenge App 06h 39h RESERVED

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_session_challenge(params)

11. ipmi_activate_session
> 描述：

    1
    2
    3
    4
    5
    6
    7

    方法功能：3.11 激活会话应用程序06h 3Ah用户
                  Activate Session App 06h 3Ah User
                  IPMI方式:SOL(去)激活命令

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    None

> 返回值：

    1

    None

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_activate_session(params)

12. ipmi_set_session_privilege_level
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.12 设置会话权限级别应用06h 3Bh用户
                  Set Session Privilege Level App 06h 3Bh User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_session_privilege_level(params)

13. ipmi_close_session
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.13 关闭会话应用程序06h 3Ch用户
                  Close Session App 06h 3Ch User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_close_session(params)

14. ipmi_get_session_info
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.14 获取会话信息应用程序06h 3Dh用户
                  Get Session Info App 06h 3Dh User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_session_info(params)

15. ipmi_set_channel_access
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.15 设置通道访问应用程序06h 40h管理员
                  Set Channel Access App 06h 40h Administrator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_channel_access(params)

16. ipmi_get_channel_access
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.16 获取频道访问应用程序06h 41h用户
                  Get Channel Access App 06h 41h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_channel_access(params)

17. ipmi_get_channel_info
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.17 获取频道信息应用06h 42h用户
                  Get Channel Info App 06h 42h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_channel_info(params)

18. ipmi_set_user_access_command
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.18 设置用户访问命令应用06h 43h管理员
                  Set User Access Command App 06h 43h Administrator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_user_access_command(params)

19. ipmi_get_user_access_command
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.19 获取用户访问命令应用程序06h 44h管理员
                  Get User Access Command App 06h 44h Administrator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_user_access_command(params)

20. ipmi_set_user_name_command
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.20 设置用户名命令应用06h 45h管理员
                  Set User Name Command App 06h 45h Administrator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_user_name_command(params)

21. ipmi_get_user_name_command
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.21 获取用户名命令应用程序06h 46h管理员
                  Get User Name Command App 06h 46h Administrator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_user_name_command(params)

22. ipmi_set_user_password_command
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.22 设置用户密码命令应用06h 47h管理员
                  Set User Password Command App 06h 47h Administrator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_user_password_command(params)

23. ipmi_activate_payload
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.23 激活有效负载应用程序06h 48h操作员
                  Activate Payload App 06h 48h Operator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_activate_payload(params)

24. ipmi_deactivate_payload
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.24 停用有效负载应用06h 49h操作员
                  Deactivate Payload App 06h 49h Operator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_deactivate_payload(params)

25. ipmi_get_payload_activation_status
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.25 获取有效负载激活状态应用06h 4Ah用户
                  Get Payload Activation Status App 06h 4Ah User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_payload_activation_status(params)

26. ipmi_get_payload_instance_info
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.26 获取有效负载实例信息应用06h 4Bh用户
                  Get Payload Instance Info App 06h 4Bh User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_payload_instance_info(params)

27. ipmi_set_user_payload_access
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.27 设置用户有效负载访问应用程序06h 4Ch管理员
                  Set User Payload Access App 06h 4Ch Administrator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_user_payload_access(params)

28. ipmi_get_user_payload_access
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.28 获取用户有效负载访问应用程序06h 4Dh用户
                  Get User Payload Access App 06h 4Dh User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_user_payload_access(params)

29. ipmi_get_channel_payload_support
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.29 获取频道有效负载支持应用程序06h 4Eh用户
                  Get Channel Payload Support App 06h 4Eh User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_channel_payload_support(params)

30. ipmi_get_channel_payload_version
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.30 获取频道有效负载版本应用程序06h 4Fh用户
                  Get Channel Payload Version App 06h 4Fh User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_channel_payload_version(params)

31. ipmi_get_channel_cipher_suites
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.31 获取通道密码套件应用程序06h 54h用户
                  Get Channel Cipher Suites App 06h 54h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_channel_cipher_suites(params)

32. ipmi_suspend_resume_payload_encryption
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.32 暂停/恢复有效负载加密应用06h 55h用户
                  Suspend/Resume Payload Encryption App 06h 55h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_suspend_resume_payload_encryption(params)

33. ipmi_set_channel_security_keys
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.33 设置通道安全密钥应用程序06h 56h管理员
                  Set Channel Security Keys App 06h 56h Administrator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_channel_security_keys(params)

34. ipmi_get_system_interface_capabilities
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：3.34 获取系统接口功能应用程序06h 57h用户
                  Get System Interface Capabilities App 06h 57h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_system_interface_capabilities(params)

35. ipmi_set_system_info_parameters_block_data
> 描述：

    1
    2
    3
    4
    5
    6
    7

    方法功能：3.35.1 设置系统信息参数App 06h 58h操作员
            Set System Info Parameters App 06h 58h Operator
            IPMI方式:block写入数据

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1
    2
    3
    4

    params(dict):
    {'number':为第number个block,取值范围0-255
    'data':写入的数据
    }

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_system_info_parameters_block_data(params)

36. ipmi_set_system_info_parameters_report_pcie_spec_info
> 描述：

    1
    2
    3
    4
    5
    6
    7

    方法功能：3.35.2 设置系统信息参数App 06h 58h操作员
                Set System Info Parameters App 06h 58h Operator
                上报芯片故障状态或芯片温度

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29

    params    (dict):{'cpu_num':str, 'bus_num':str,
    'device_num':str, 'function_num':str,
    'info_type':str, 'chip_amount':str,
    'data_detail':str}
    cpu_num PCIe卡所属CPU编号，例如‘0’
    bus_num PCIe卡的BusNum
    device_num PCIe卡的DeviceNum
    function_num PCIe卡的FunctionNum
    info_type 上报芯片温度：'0'
    上报芯片故障状态：'1'
    chip_amount PCIe卡芯片个数，与后面的data_detail对应
    data_detail：
    当info_type为0时：
    data10       芯片个数
    data11:12  芯片0的温度，其中0x7fff表示温度读取失败，
    0x7fffd表示当前温度不可读（此处是为了
    与PCIe设备带外管理接口规范保持统一）；
    data13:14  芯片1的温度，参考data11:12定义
    data15:16  芯片2的温度，参考data11:12定义
    data16:N    按照上述定义类推
    当info_type为1时：
    data10     芯片个数
    data11     芯片0的故障状态，
    0：表示芯片状态正常
    1：表示芯片出现故障（BMC统一处理为严重告警事件）
    其它：保留
    data12     芯片1的故障状态，参考data11定义
    data13     芯片2的故障状态，参考data11定义
    data14:N  按照上述定义类推

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_system_info_parameters_report_pcie_spec_info(params)

37. ipmi_set_system_info_parameters_sys_info_param
> 描述：

    1
    2
    3
    4
    5
    6
    7

    方法功能：3.35.3 设置系统信息参数App 06h 58h操作员
                    Set System Info Parameters App 06h 58h Operator
                    发送Set System Info Parameters命令

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1
    2

    region(str):区号
    Data(str): 数据

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_system_info_parameters_sys_info_param(params)

38. ipmi_get_system_info_parameters_block_data
> 描述：

    1
    2
    3
    4
    5
    6
    7

    方法功能：3.36.1 获取系统信息参数App 06h 59h用户
                Get System Info Parameters App 06h 59h User
    IPMI方式:block读取数据

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    opt(str): 为第opt个block,取值范围0-255

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_system_info_parameters_block_data(params)

39. ipmi_get_system_info_parameters_sys_info_param
> 描述：

    1
    2
    3
    4
    5
    6
    7

    方法功能：3.36.2 获取系统信息参数App 06h 59h用户
                  Get System Info Parameters App 06h 59h User
                  发送Get System Info Parameters命令

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    region(str): 区号

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_system_info_parameters_sys_info_param(params)