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

Skip to content

# BmcRedFish 子类方法

1. refresh_cache
> 描述：

    1
    2
    3
    4
    5

    方法功能：清除所有缓存

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('refresh_cache', params=params)

2. get_np_mgtp_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：np mgtp对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_np_mgtp_property', params=params)

3. get_network_interface_proper
> 描述：

    1
    2
    3
    4
    5

    方法功能：网络接口对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_network_interface_proper', params=params)

4. get_fc_interface_proper
> 描述：

    1
    2
    3
    4
    5

    方法功能：fc接口对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_fc_interface_proper', params=params)

5. get_bios_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：BIOS 对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_bios_property', params=params)

6. get_controller_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：controller对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_controller_property', params=params)

7. get_raid_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：raid对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_raid_property', params=params)

8. get_disk_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：disk对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_disk_property', params=params)

9. get_fan_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：fan对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_fan_property', params=params)

10. get_network_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：NetworkMgt(带外网络设备管理) 对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_network_mgt_property', params=params)

11. get_host_os_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：host os对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_host_os_property', params=params)

12. get_kvm_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：kvm对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_kvm_property', params=params)

13. get_plug_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：plug对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_plug_property', params=params)

14. get_power_control_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：power control对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_power_control_property', params=params)

15. get_power_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：power mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_power_mgt_property', params=params)

16. get_virtual_console_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：virtual console对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_virtual_console_property', params=params)

17. get_user_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：user mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_user_mgt_property', params=params)

18. get_snmp_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：snmp mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_snmp_mgt_property', params=params)

19. get_system_test_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：system test对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_system_test_property', params=params)

20. get_ipmi_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：ipmi mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_ipmi_mgt_property', params=params)

21. get_ast_mnts_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：ast mnts对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_ast_mnts_property', params=params)

22. get_alarm_event_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：alarm event对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_alarm_event_property', params=params)

23. get_sensor_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：sensor mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sensor_mgt_property', params=params)

24. get_system_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：system mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_system_mgt_property', params=params)

25. get_busctl_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：busctl mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_busctl_mgt_property', params=params)

26. get_sqlite_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：sqlite mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sqlite_mgt_property', params=params)

27. get_storage_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：storage mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_storage_mgt_property', params=params)

28. get_thermal_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：thermal mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_thermal_mgt_property', params=params)

29. get_intelligent_diagnosis_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：intelligent diagnosis对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_intelligent_diagnosis_property', params=params)

30. get_file_transfer_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：file transfer对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_file_transfer_property', params=params)

31. get_ibma_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取创建iBMA对象所需要的静态属性。

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    ipMode(dict): 该命令的请求值:网口的IPv4模式

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_ibma_property', params=params)

32. get_frame_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：frame mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_frame_mgt_property', params=params)

33. get_log_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：LogMgt(带外日志管理) 对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_log_mgt_property', params=params)

34. get_switch_network_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：交换网络 对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_switch_network_mgt_property', params=params)

35. get_sp_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：sp property对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sp_property', params=params)

36. get_redfish_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：redfish对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_redfish_property', params=params)

37. get_firmware_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：firmware mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_firmware_mgt_property', params=params)

38. get_pc_ie_card_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取PCIe卡属性对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_pc_ie_card_mgt_property', params=params)

39. get_secure_scan_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：secure scan对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_secure_scan_property', params=params)

40. get_raid_controller_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：raid对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_raid_controller_info', params=params)

41. get_memory_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取内存的静态属性

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_memory_property', params=params)

42. get_bench_mark
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取指定配置文件的静态信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    cpuBench = self.get_bench_mark('CPU')

43. inject_redfish_error
> 描述：

    1
    2
    3
    4
    5

    方法功能：BMC RedFish故障注入接口

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params(dict): params = {'func': '',
    'kwargs': {},
    'headers': '',
    }

> 返回值：

    1

    response(str): 故障注入接口命令回显。

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    self.dispatch('inject_redfish_error',
    params={'func': 'modify_systems_specific_info_redfish',
    'kwargs': {'resourceAttri': {"UUID": "345678-0000-FFF", 'If-Match': 'yyy'}},
    }
    )

44. request_redfish_with_changed_headers
> 描述：

    1
    2
    3
    4
    5

    方法功能：发送redfish命令,但是可以改变请求头

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    params(dict): params = {
    "dev" : {"types": None, "optional": False}  执行命令的对象
    "func": {"types": str, "optional": False},  要执行命令的函数名
    "kwargs": {"types": None, "optinoal": False}, 函数的参数
    "headers": {"types": dict, "optional": True}, 要设置的新的header
    "From": {"types": str, "optional": True},     要设置的From
    "token": {"types": str, "optional": True},    要设置的token
    "sessionid": {"types": str, "optional": True}, 要设置的sessionid
    "auth_token": {"types": str, "optional": True}, 要设置的auth_token
    }

> 返回值：

    1

    response(str): url的响应值

> 异常：

    1

    None

> 举例：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14

    self.dispatch('request_redfish_with_changed_headers',
    params={
    'dev': dev
    'func': 'modify_systems_specific_info_redfish',
    'kwargs': {'resourceAttri': {"UUID": "345678-0000-FFF", 'If-Match': 'yyy'}},
    }
    )
    self.dispatch('request_redfish_with_changed_headers',
    params={
    'dev': dev
    'func': 'post_action_response',
    'kwargs': [action, body],
    }
    )

45. get_enclosure_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定的服务器机箱资源信息（管理板）

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_enclosure_info_redfish')

46. set_manager_reset_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：重启管理板

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    hmm_id(str): 指定管理资源(HMM1或者HMM2)

> 返回值：

    1

    response(dict): 响应body体,重启结果

> 异常：

    1

    None

> 举例：

    1
    2

    hmm_id = "HMM1"
    HmmController.dispatch('set_manager_reset_redfish', hmm_id=hmm_id)

47. get_hmm_by_power_attributes_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定服务器机箱的电压、功率和电源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    hmmController.dispatch('get_hmm_by_power_attributes_redfish')

48. modify_hmm_power_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改服务器指定电源属性

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    powerAttributesInfo(dict): 请求消息体,电源属性参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    powerAttributesInfo = {"PowerControl":[{"PowerLimit":{"LimitInWatts":1000}}]
    bmcController.dispatch('modify_hmm_power_info_redfish', params=powerAttributesInfo)

49. get_hmm_by_digital_warranty_attributes_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询机框电子保单信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    hmmController.dispatch('getHmmByPDigitalWarrantyAttributesRedfish')

50. modify_hmm_digital_warranty_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改机框电子保单信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    DigitalWarrantyAttributesInfo(dict): 请求消息体,电子保单属性参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    DigitalWarrantyAttributesInfo = {"StartPoint": "2010-04-11", "Lifespan": 100}
    bmcController.dispatch('modify_hmm_digital_warranty_info_redfish',
    params=DigitalWarrantyAttributesInfo)

51. get_hmm_syslog_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询管理板Syslog资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    hmm_id(str): 指定管理资源(HMM1或者HMM2)

> 返回值：

    1

    response(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2

    hmm_id = "HMM1"
    HmmController.dispatch('get_hmm_syslog_info_redfish', hmm_id=hmm_id)

52. set_manager_force_failover_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：管理板主备倒换

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    hmm_id(str): 指定管理资源(HMM1或者HMM2)

> 返回值：

    1

    response(dict): 响应body体,倒换结果

> 异常：

    1

    None

> 举例：

    1
    2

    hmm_id = "HMM1"
    HmmController.dispatch('set_manager_force_failover_redfish', hmmId=hmmId)

53. get_action_response_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：按操作名称获取操作响应

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): params = {
    'action':   (str): action name
    }

> 返回值：

    1

    response(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2
    3

    rsp = redfish.getActionResponseRedfish('#ComputerSystem.Reset')
    rsp = redfish.getActionResponseRedfish('#ComputerSystem.FruControl')
    rsp = redfish.getActionResponseRedfish('#Manager.Reset')

54. get_switches_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询交换集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_switches_redfish', params=params)

55. get_switch_status_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定交换资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): serverId: 待查询的资源ID,必选

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params={'serverId':'Mesh0'}
    bmcController.dispatch('get_switch_status_redfish', params=params)

56. get_switches_port_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询交换端口集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): serverId: 待查询的资源ID,必选

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params={'serverId':'Mesh0'}
    bmcController.dispatch('get_switches_port_info_redfish', params=params)

57. get_switches_port_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询交换端口指定端口资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): serverId: 待查询的资源ID,必选
    portsId: 待查询的端口ID,必选

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params={'serverId':'Mesh0', 'portsId':'dport_0'}
    bmcController.dispatch('get_switches_port_info_redfish', params=params)

58. set_switches_port_enable_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置交换端口使能状态

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): serverId: 待查询的资源ID,必选
    portsId(str): 待查询的端口ID,必选
    body(dict): 请求消息体，必选

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    params={'serverId':'bmc',
    'portsId':'1',
    'body':{"PortEnable" : "Enable"}
    }
    bmcController.dispatch('set_switches_port_enable_redfish', params=params)

59. post_action_response_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：post action response by action name.

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    params(dict): params = {
    'action':   (str): action name
    'body':     (dict): {},需要修改的内容
    "token": {"types": str, "optional": True},可选参数,创建session后返回值headers中Token值,一般用于二次
    认证,和From、sessionid需要一起使用
    "From": {"types": str, "optional": True},可选参数,取值为WebUI,可用于redfish模拟web登录
    'Cookie': {"types": str, "optional": True},可选参数,创建会话时的cookie值
    "sessionid": {"types": str, "optional": True},可选参数,创建session后返回值body中的Id
    "reauth_key":{"types": str, "optional": True},可选参数，二次认证密码
    }

> 返回值：

    1

    response(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2

    rsp = redfish.postActionResponseRedfish(params={
    "action": "#Thermal.ClearInletHistoryTemperature","body": {}})

60. get_board_mgt_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：board mgt对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.get_board_mgt_property(params)

61. get_sdi_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取SDI的静态属性

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sdi_property', params=params)

62. set_cpu_power
> 描述：

    1
    2
    3
    4
    5

    方法功能：调节CPU功率

    命令格式：https://redfish/v1/Sms/1/Systems/1/Power/1/Actions/PowerCapping.Configure

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体

> 返回值：

    1
    2
    3

    response(str): 返回NPU卡资源信息列表
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_npus')

63. get_net_work_port_set_resource
> 描述：

    1
    2
    3
    4
    5
    6
    7
    8

    方法功能：查询网络端口集合资源
        1. 获取networkAdapter_id_list
        2. 获取slotID
        3. 获取网络端口集合资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体

> 返回值：

    1
    2
    3

    response(str): 返回网络端口集合资源
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_net_work_port_set_resource')

64. get_net_work_port_single_resource
> 描述：

    1
    2
    3
    4
    5

    方法功能：network port对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_net_work_port_single_resource', params=params)

65. get_specified_ethernetinterfaceresources
> 描述：

    1
    2
    3
    4
    5

    方法功能：specified ethernetinterfaceresources对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_specified_ethernetinterfaceresources', params=params)

66. get_network_interfacesinfos
> 描述：

    1
    2
    3
    4
    5

    方法功能：network interfacesinfos对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_network_interfacesinfos', params=params)

67. get_specified_cpu_infos_sets
> 描述：

    1
    2
    3
    4
    5

    方法功能：specified cpu infos对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_specified_cpu_infos_sets', params=params)

68. get_single_network_portinfo_sets
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取单个网络端口资源信息的集合

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(str): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcCli.dispatch("get_single_network_portinfo_sets")

69. get_system_memory_info_sets
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定内存信息的集合

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(str): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcCli.dispatch("get_system_memory_info_sets")

70. getsingle_ethernet_interfaces_info_set
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取单个以太网接口资源信息的集合

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcCli.dispatch("getsingle_ethernet_interfaces_info_set")

71. get_network_interfaces_set
> 描述：

    1
    2
    3
    4
    5

    方法功能：redfish获取network接口资源集合

    命令格式：https://device_ip/redfish/v1/Systems/system_id/NetworkInterfaces

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 返回网络接口资源集合

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_network_interfaces_set')

72. get_all_network_port_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：redfish获取所有的网络端口信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/NetworkInterfaces/networkinterface_id/NetworkPorts

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1
    2
    3

    response(dict): 返回网络端口集合资源
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_net_work_port_set_resource')

73. get_memory_collection
> 描述：

    1
    2
    3
    4
    5

    方法功能：redfish获取内存集合资源信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Memory

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1
    2
    3

    response(dict): 命令返回体
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch("get_memory_collection")

74. get_all_disks_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：redfish获取所有的驱动器资源信息

    命令格式：https://device_ip/redfish/v1/Chassis/chassis_id/drives/drive_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1
    2
    3

    response(dict): 命令返回体
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch("get_all_disks_info")

75. get_all_pcie_function
> 描述：

    1
    2
    3
    4
    5

    方法功能：redfish获取所有PCIE功能资源信息

    命令格式：https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id/Functions/functions_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1
    2
    3

    response(dict): 命令返回体
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch("get_all_pcie_function")

76. get_account_tls_version
> 描述：

    1
    2
    3
    4
    5

    方法功能：account tls对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_account_tls_version', params=params)

77. set_account_tls_version
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置account tls version版本

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_account_tls_version', params=params)

78. set_account_lockout_threshold
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置ccount lockout threshold临界点

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_account_lockout_threshold', params=params)

79. set_os_user_management_enabled
> 描述：

    1
    2
    3
    4
    5

    方法功能：os user management使能

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_os_user_management_enabled', params=params)

80. set_previous_passwords_disallowed_count
> 描述：

    1
    2
    3
    4
    5

    方法功能：先前密码不允许数量

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_previous_passwords_disallowed_count', params=params)

81. set_password_validity_days
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置密码有效性天数

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_password_validity_days', params=params)

82. get_account_services_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询当前Account Service资源信息

    命令格式：https://device_ip/redfish/v1/AccountService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18

    response(dict): 用户信息集合,redfish的响应消息体
    {      "Id": "AccountService",
    "Name": "Account Service",
    "MinPasswordLength": 8,
    "MaxPasswordLength": 20,
    "AccountLockoutThreshold": 5,
    "AccountLockoutDuration": 300,
    "Oem": {
    "Huawei": {
    "PasswordComplexityCheckEnabled": false,
    "AccountInactiveTimelimit": 0,
    "SSHPasswordAuthenticationEnabled": true,
    "OSUserManagementEnabled": true,
    "PasswordValidityDays": null,
    "MinimumPasswordAgeDays": null,
    "PreviousPasswordsDisallowedCount": null,
    ......}}
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_account_services_info_redfish')

83. getaccount_info_collections_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询当前用户集合资源信息

    命令格式：https://redfish/v1/AccountService/Accounts

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 用户信息集合,redfish的响应消息体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('getaccount_info_collections_redfish')

84. creat_new_account_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：创建新账户

    命令格式：post方法https://redfish/v1/AccountService/Accounts

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 该redfish请求的消息体:待创建的账号的用户名、密码、规则信息，字典形式

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('creat_new_account_redfish', params=accountInfo)

85. del_account_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：删除指定账户

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    params(dict):  此函数入参,包含以下信息
    params = {
    "memberId": {"types": str, "optional": True},待删除账户的id,必选参数,由于以前获取参数的方式
    不太规范，暂时在参数检查中置为可选参数
    "token": {"types": str, "optional": True}, 可选参数,创建session后返回值headers中Token值,一般用于二次
    认证,和From、sessionid需要一起使用
    "From": {"types": str, "optional": True}, 可选参数,取值为WebUI,可用于redfish模拟web登录
    "sessionid": {"types": str, "optional": True}  可选参数,创建session后返回值中heasers中set-cookie的
    sessionid=后面的值
    "reauth_key": {"types": str, "optional": True}  可选参数,二次认证密码

> 返回值：

    1

    response(dict):  命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6
    7
    8

    params = {
    "Id": "3",
    "token": token,
    "From": "WebUI",
    "sessionid": sessionid,
    "reauth_key": "xxxxxx"
    }
    bmcController.dispatch('del_account_redfish', params=params)

86. get_accout_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询所有账户信息

    命令格式：https://device_ip/redfish/v1/AccountService/Accounts/member_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1
    2
    3
    4

    account_info(list): 包含多组账户信息的列表
    [{u'2': {u'UserName': u'Administrator', u'Locked': False, u'Name': u'User Account', u'Links': {
    u'Role': {}},
    u'RoleId': u'Administrator', u'Enabled': True, ...}]

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_accout_info_redfish')

87. get_specific_accouinfo_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询账户信息

    命令格式：https://redfish/v1/accountservice/accounts/memberid

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    params(dict):  此函数入参,包含以下信息
    params = {
    "Id": {"types": str, "optional": True},需要查询的账户的member id信息,必选参数,由于以前获取参数的方式
    不太规范，暂时在参数检查中置为可选参数
    "token": {"types": str, "optional": True}, 可选参数,创建session后返回值headers中Token值,一般用于二次
    认证,和From、sessionid需要一起使用
    "From": {"types": str, "optional": True}, 可选参数,取值为WebUI,可用于redfish模拟web登录
    "sessionid": {"types": str, "optional": True}  可选参数,创建session后返回值中heasers中set-cookie的
    sessionid=后面的值
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    params = {"Id": "2"}
    rsp = bmcController.dispatch('get_specific_accouinfo_redfish',params=params)
    params = {
    "Id": "3",
    "token": token,
    "From": "WebUI",
    "sessionid": sessionid,
    }
    rsp = bmcController.dispatch("get_specific_accouinfo_redfish", params=params)

88. set_specific_accouinfo_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改指定用户的用户名、密码、权限、锁定状态、使能状态、登录接口等信息。

    命令格式：patch方法https://redfish/v1/AccountService/Accounts/account_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     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):  该redfish请求的消息体:
    params = {
    "memberId": {"types": dict, "optional": False},
    需要查询的账户的member id信息,必选参数
    "accountInfo": {"types": None, "optional": False},
    发送patch请求的body体
    "token": {"types": str, "optional": True},
    可选参数,创建session后返回值headers中Token值,
    一般用于二次认证,和From、sessionid需要一起使用
    "From": {"types": str, "optional": True},
    可选参数,取值为WebUI,可用于redfish模拟web登录
    "sessionid": {"types": str, "optional": True},
    可选参数,创建session后返回值中heasers中
    set-cookie的sessionid=后面的值
    "reauth_key": {"types": str, "optional": True},
    可选参数 二次认证的密码,session的密码
    "v3_special_inject": {"types": bool, "optional": "True"}
    可选参数 如果为v3版本且为无权限异常patch,此参数是必须的
    }
    参数示例: params = {
    "memberid": "3",
    "token": token,
    "From": "WebUI",
    "sessionid": sessionid,
    "reauth_key": "xxxxxx",
    "memberId": {"account_id": "3"},
    "accountInfo": {"UserName": "comuser",
    "If-Match": "DEL"}
    }

> 返回值：

    1

    response(dict): 命令的返回值:修改后的最新账号信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_specific_accouinfo_redfish',params=params)

89. set_account_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改账户信息。

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    accountInfo(dict): 该redfish请求的消息体: 需要修改的账户信息

> 返回值：

    1

    response(dict): 命令的返回值: 修改后的最新账号信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_account_service_info_redfish', params=accountInfo)

90. get_account_roles_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询角色集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_account_roles_info_redfish')

91. get_specific_account_roles_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定角色信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    roleName(dict): 该redfish请求的消息体:待查询的角色名称

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    self.serverDevice = self.resource.getDevice(deviceType="server", deviceId='1')
    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_specific_account_roles_info_redfish', params=roleName)

92. set_specific_account_roles_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改指定角色信息

    命令格式：patch方法https://redfish/v1/AccountService/Roles/role_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     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
    30
    31
    32
    33
    34
    35

    params(dict): 该redfish请求的消息体:
    params = {
    "memberId": {"types": dict, "optional": False},
    需要查询的账户的member id信息,必选参数
    "accountInfo": {"types": None, "optional": False},
    发送patch请求的body体
    "token": {"types": str, "optional": True},
    可选参数,创建session后返回值headers中Token值,
    一般用于二次认证,和From、sessionid需要一起使用
    "From": {"types": str, "optional": True},
    可选参数,取值为WebUI,可用于redfish模拟web登录
    "sessionid": {"types": str, "optional": True},
    可选参数,创建session后返回值中heasers中
    set-cookie的sessionid=后面的值
    "reauth_key": {"types": str, "optional": True}
    可选参数 二次认证的密码,session的密码
    }
    参数示例: params = {
    "memberid": "3",
    "token": token,
    "From": "WebUI",
    "sessionid": sessionid,
    "reauth_key": "xxxxxx",
    "memberId": {"account_id": "3"},
    "roleInfo" = {'roleName': 'CustomRole1',
    'privileges': {"AssignedPrivileges": [
    "Login"
    ],
    "OemPrivileges": [
    "OemKvm",
    "OemVmm"
    ]
    }
    }
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController.dispatch('set_specific_account_roles_info_redfish',
    params=params)

93. import_root_certificate_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：根证书导入

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    certiContent(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('import_root_certificate_redfish', params=certiContent)

94. import_crl_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：双因素吊销列表证书导入

    命令格式：https://device_ip/redfish/v1/Managers/1/AccountService/oem/huawei

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('import_crl_redfish', params=params)

95. delete_root_certificate_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：根证书删除

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    certid(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('delete_root_certificate_redfish', params=certid)

96. import_mutual_auth_client_cert_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：双因素认证的用户的客户端证书导入

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    accountInfo(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6

    accountInfo: {'memberId': '2',
    'certinfo': {
    "Type": value,
    "Content":content_value
    }}
    bmcController.dispatch('import_mutual_auth_client_cert_redfish', params=accountInfo)

97. delete_mutual_auth_client_cert_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：双因素认证的用户的客户端证书删除

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    accountInfo(dict): 待删除客户端证书的账号ID, 以及请求消息体的内容

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    accountInfo= {'memberId':'2', 'certinfo': { }}
    bmcController.dispatch('mock_precise_alarm_redfish', params=accountInfo)

98. import_ssh_account_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：SSH公钥导入

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    submitEvent(dict): 待导入SSH公钥的账号ID,以及请求消息体的内容

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    accountInfo = {'memberId':'2', 'keyinfo': { }}
    bmcController.dispatch('import_ssh_account_redfish', params=accountInfo)

99. del_ssh_account_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：SSH公钥删除

    命令格式：patch方法https://redfish/v1/AccountService/Accounts/4/Oem/Huawei/Actions

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

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

    params(dict):  待导入SSH公钥的账号ID,以及请求消息体的内容
    params = {
    "memberId": {"types": str, "optional": False},
    需要查询的账户的member id信息,必选参数
    "accountInfo": {"types": None, "optional": False},
    发送patch请求的body体
    "token": {"types": str, "optional": True},
    可选参数,创建session后返回值headers中Token值,
    一般用于二次认证,和From、sessionid需要一起使用
    "From": {"types": str, "optional": True},
    可选参数,取值为WebUI,可用于redfish模拟web登录
    "sessionid": {"types": str, "optional": True},
    可选参数,创建session后返回值中heasers中
    set-cookie的sessionid=后面的值
    "reauth_key": {"types": str, "optional": True}
    可选参数 二次认证的密码,session的密码
    }
    参数示例: params = {
    "token": token,
    "From": "WebUI",
    "sessionid": sessionid,
    "reauth_key": "xxxxxx",
    accountInfo = {'memberId':'2', 'keyinfo': { }}
    }

> 返回值：

    1

    response(dict): 命令的返回值:修改后的最新账号信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('del_ssh_account_redfish',params=params)

100. get_ldap_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询LdapService信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 包含ldapService信息的键值对

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_accout_info_redfish')

101. get_kerberos_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询KerberosService信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 包含KerberosService信息的键值对

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_kerberos_service_info_redfish')

102. set_kerberos_service_enable_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改KerberosService信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    modify_info(dict):{
    "KerberosEnabled": True
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15

    response(dict): 包含KerberosService信息的键值对
    {
    '@odata.context': u'/redfish/v1/$metadata#AccountService/KerberosService',
    '@odata.id': u'/redfish/v1/AccountService/KerberosService',
    '@odata.type': u'#HwKerberosService.v1_0_0.HwKerberosService',
    'Id': u'KerberosService',
    'KerberosControllers':
    {
    '@odata.id':
    '/redfish/v1/AccountService/KerberosService/KerberosControllers'
    },
    'KerberosEnabled': True,
    'Name': u'Kerberos Service',
    'status_code': 200
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_kerberos_service_enable_redfish', modify_info)

103. set_ldap_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改LdapService信息,如:Ldap功能开启使能

    命令格式：https://device_ip/redfish/v1/AccountService/LdapService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    modify_info(dict):
    {
    "LdapServiceEnabled": "false"
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    response(dict): 响应体
    {
    "@odata.context": "/redfish/v1/$metadata#AccountService/LdapService",
    "@odata.id": "/redfish/v1/AccountService/LdapService",
    "@odata.type": "#HwLdapService.v1_0_0.HwLdapService",
    "Id": "LdapService",
    "Name": "Ldap Service",
    "LdapServiceEnabled": false,
    "LdapControllers": {
    "@odata.id": "/redfish/v1/AccountService/LdapService/LdapControllers"
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_ldap_service_info_redfish', params=modify)

104. get_ldap_controllers_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询所有Ldap Controllers信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11

    ldap_info(dict): 包含多组ldapController信息的键值对
    [{ u'6': {u'Actions': {u'#HwLdapController.ImportCert': {u'target':
    u'/redfish/v1/AccountService/LdapService/LdapControllers/6/Actions/HwLdapController.ImportCert'}},
    u'BindDN': u'',
    u'BindPassword': None,
    u'CertificateChainInformation': None,
    u'CertificateInformation': None,
    u'CertificateVerificationEnabled': False,
    ...
    }
    ]

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_ldap_controllers_info_redfish')

105. get_ldap_specific_controllers_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定Ldap Controllers信息

    命令格式：https://device_ip/redfish/v1/AccountService/LdapService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

     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
    30

    ldap_info(dict): 具体LdapController信息的键值对
    {u'1': { u'@odata.id': u'/redfish/v1/AccountService/LdapService
    /LdapControllers/1',
    u'Actions': {
    u'#HwLdapController.ImportCert': {
    u'@Redfish.ActionInfo': '/redfish/v1/AccountService
    /LdapService/LdapControllers/
    1/ImportCertActionInfo',
    u'target': u'/redfish/v1/AccountService/LdapService
    /LdapControllers/1/Actions/
    HwLdapController.ImportCert'
    }},
    u'Id': u'1',
    u'LdapGroups': [{
    u'GroupDomain': "CN=,OU=,DC=",,
    u'GroupLoginInterface': [u'Web', "SSH", "Redfish"],
    u'GroupLoginRule': [],
    u'GroupName': None,
    u'GroupFolder': None',
    u'GroupRole': "No Access",
    u'MemberId': 0 },
    ......
    ],
    'headers': {
    'Content-Type': 'application/json;charset=utf-8',
    'ETag': 'W/"857722d9"',
    ......
    },
    'status_code': 200
    }}

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_ldap_specific_controllers_info_redfish')

106. set_specific_ldap_controller_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：PATCH方法修改指定Ldap Controller的信息

    命令格式：https://device_ip/redfish/v1/AccountService/LdapService/LdapControllers/member_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14

    modify_info(dict)
    {
    "ldapId"  :  '1'                str  指定Ldap控制器ID
    "body":{                        dict 请求体
    "LdapServerAddress": "xx.xx.xx.xx",
    "CertificateVerificationEnabled ": "false"
    }
    "token": {"types": str, "optional": True},可选参数,创建session后返回值headers中Token值,
    一般用于二次认证,和From、sessionid需要一起使用
    "From": {"types": str, "optional": True},可选参数,取值为WebUI,可用于redfish模拟web登录
    "sessionid": {"types": str, "optional": True},可选参数,创建session后返回值中heasers中
    set-cookie的sessionid=后面的值
    "reauth_key": {"types": str, "optional": True} 可选参数 二次认证的密码,session的密码
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    response(dict): 响应体
    {
    "Id": "1",
    "Name": "Ldap Controller",
    "LdapServerAddress": "device_ip",
    "LdapPort": 635,
    "UserDomain": "CN=test,,DC=huawei,DC=com",
    "BindDN": "testname",
    "BindPassword": null,
    "CertificateVerificationEnabled": false,
    .......
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_specific_ldap_controller_info', params=modify)

107. import_specific_ldap_controller_cert
> 描述：

    1
    2
    3
    4
    5

    方法功能：PATCH方法导入指定Ldap Controller的证书

    命令格式：https://device_ip/redfish/v1/AccountService/LdapService/LdapControllers/member_id/Actions

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8

    cert_info  (dict)
    {
    "ldapId"  :  '1'  str 指定Ldap控制器ID
    "body":{                        dict 请求体，分为文本导入/本地导入/远程导入三种方式
    "Type":"text",
    "Content":"/home/aaa.json"
    }
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16

    response(dict):   响应体
    {
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id": "/redfish/v1/TaskService/Tasks/1",
    "Id": "1",
    "Name": "ldap root cert import",
    "TaskState": "Running",
    "StartTime": "2018-11-01T07:35:15+09:00",
    "Messages": [],
    "Oem": {
    "Huawei": {
    "TaskPercentage": null
    }
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('import_specific_ldap_controller_cert', params=cert_info)

108. import_specific_ldap_controller_crl_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入LDAP证书吊销列表,根据请求体信息,可本地导入也可远程导入

    命令格式：https://device_ip/redfish/v1/AccountService/LdapService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8

    cert_info(dict):
    {
    "ldapId"  :  '1'      str  指定Ldap控制器ID
    "body":{              dict 请求体，分为文本导入/本地导入/远程导入三种方式
    "Type":"text",
    "Content":"/home/aaa.json"
    }
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17

    {
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id": "/redfish/v1/TaskService/Tasks/1",
    "Id": "1",
    "Name": "Update Master Key Task",
    "TaskState": "Completed",
    "StartTime": "2020-06-10T09:35:12+08:00",
    "EndTime": "2020-06-10T09:35:38+08:00",
    "TaskStatus": "OK",
    "Messages": [],
    "Oem": {
    "Huawei": {
    "TaskPercentage": "100%"
    }
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('import_specific_ldap_controller_crl_redfish', params=cert_info)

109. del_specific_ldap_controller_crl_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：删除LDAP证书吊销列表

    命令格式：redfish/v1/AccountService/LdapService/LdapControllers/member_id/Actions/LdapController.DeleteCrl

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    cert_info(dict)
    {
    "ldapId": '1' str 指定Ldap控制器ID
    }

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('del_specific_ldap_controller_crl_redfish', params=cert_info)

110. get_kerberos_controllers_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询Kerberos Controllers集合信息

    命令格式：https://device_ip/redfish/v1/AccountService/KerberosService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20

    kerberos_info(dict): 包含Kerberos Controllers集合信息的键值对
    {
    u'@odata.context': u'/redfish/v1/$metadata#AccountService/
    KerberosService/KerberosControllers/$entity',
    u'@odata.id': u'/redfish/v1/AccountService/KerberosService/
    KerberosControllers',
    u'@odata.type': u'#HwKerberosControllerCollection.HwKerberos
    ControllerCollection',
    u'Members': [{
    u'@odata.id': u'/redfish/v1/AccountService/KerberosService
    /KerberosControllers/1'
    }],
    u'Members@odata.count': 1,
    u'Name': u'KerberosControllerCollection',
    'headers': {
    'ETag': 'W/"5424984f"',
    ......
    },
    'status_code': 200
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_kerberos_controllers_info_redfish')

111. get_kerberos_specific_controllers_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定Kerberos Controllers信息

    命令格式：https://device_ip/redfish/v1/AccountService/KerberosService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

     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
    30
    31
    32
    33
    34

    kerberos_info(dict): 具体KerberosController信息的键值对
    {u'1': { u'@odata.id': u'/redfish/v1/AccountService/KerberosService
    /KerberosControllers/1',
    u'Actions': {
    u'#HwKerberosController.ImportKeyTable': {
    u'@Redfish.ActionInfo': '/redfish/v1/AccountService
    /KerberosService/KerberosControllers/
    1/ImportKeyTableActionInfo',
    u'target': u'/redfish/v1/AccountService/Kerberos
    Service/KerberosControllers/1/Actions/
    HwKerberosController.ImportKeyTable'
    }},
    u'Id': u'1',
    u'KerberosGroups': [{
    u'GroupDomain': None,
    u'GroupLoginInterface': [u'Web'],
    u'GroupLoginRule': [],
    u'GroupName': None,
    u'GroupRole': u'NoAccess',
    u'GroupSID': None,
    u'MemberId': 0 },
    ......
    ],
    u'KerberosPort': 88,
    u'KerberosServerAddress': None,
    u'Name': u'KerberosController',
    u'Realm': None,
    'headers': {
    'Content-Type': 'application/json;charset=utf-8',
    'ETag': 'W/"857722d9"',
    ......
    },
    'status_code': 200
    }}

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('getKerberosControllersIDInfo')

112. set_kerberos_specific_controllers_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定Kerberos Controllers信息

    命令格式：https://device_ip/redfish/v1/AccountService/KerberosService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13

    modify_info(dict)
    {
    "kerberos_id"  :  '1'           str  指定kerberos_id控制器ID
    "body":{                        dict 请求体
    "MemberId": 2,
    "GroupName": null,
    "GroupDomain": null,
    "GroupSID": null,
    "GroupRole": "No Access",
    "GroupLoginRule": [],
    "GroupLoginInterface": ["Web"]
    }
    }

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('setKerberosControllersIDInfo')

113. import_kerberos_setting_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入kerberos秘钥表

    命令格式：https://device_ip/redfish/v1/AccountService/KerberosService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7

    modify_info(dict):
    {
    "kerberos_id":  '1'                str  指定kerberos_id控制器ID
    "body":{
    "Content": "tmp_uri"
    }                                  dict 请求体
    }

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('importKerberosSettingInfo')

114. getprivilegemap_info_collections_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询权限注册表资源信息

    命令格式：https://redfish/v1/AccountService/PrivilegeMap

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 用户信息集合, redfish的响应消息体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('getprivilegemap_info_collections_redfish')

115. get_network_adapters
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

> 返回值：

    1

> 异常：

    1

> 举例：

    1

116. get_optical_module_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询NP网卡光模块信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 接口的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('getNpOpticalModuleInfo')

117. get_network_ports_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器机箱的网络端口单个资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 接口的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_network_ports_info')

118. get_boards_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器系统内的扩展卡信息

    命令格式：https://redfish/v1/Chassis/chassis_id/Boards

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    chassisId(str): 指定机箱资源的ID, 为机箱在机箱集合中的唯一标识

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_boards_collection_redfish')

119. get_all_boards_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器系统内所有的扩展卡集合

    命令格式：https://redfish/v1/Chassis/chassis_id/Boards/board_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    chassisId(str): 指定机箱资源的ID, 为机箱在机箱集合中的唯一标识

> 返回值：

    1

    response(list):数据的列表

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_boards_collection_redfish')

120. get_led_group_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器系统内的定位灯状态信息

    命令格式：https://redfish/v1/Chassis/chassis_id/Enc/LedGroup

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    chassisId(str): 指定机箱资源的ID, 为机箱在机箱集合中的唯一标识

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_led_group_collection_redfish')

121. set_led_group_info_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置指定的服务器机箱定位灯状态信息

    命令格式：https://redfish/v1/Chassis/chassis_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    chassisId(str): 机箱资源的ID
    pyload(dict): 要修改的资源信息

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    None

122. get_specific_board_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器系统内的指定扩展卡信息

    命令格式：https://redfish/v1/Chassis/chassis_id/Boards/mainboardConvergedInterfaceCard1

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params = {"chassis_id": chassis_id, "type": "mainboardConvergedInterfaceCard1"}
    chassis_id(str): 指定机箱资源的ID, 为机箱在机箱集合中的唯一标识
    type(str): 指定扩展卡的名称

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_specific_board_collection_redfish')

123. get_boards_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 'keyRegex'(re.I): 'raid', 'diskbp', 'nic', 'pcieriser', 'pciecard',
    'lom'..

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_boards_info', params=params)

124. get_disk_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

> 返回值：

    1

> 异常：

    1

> 举例：

    1

125. get_drives_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    driveID(str): 硬盘名称"HDDPlaneDisk1"

> 返回值：

    1

    response(list): diskinfo

> 异常：

    1
    2
    3

    None
    RedfishURL:
    https://device_ip/redfish/v1/Chassis/chassis_id/Drives

> 举例：

    1
    2

    self.bmcController.dispatch('modifySpecificDiskRedfish',
    "HDDPlaneDisk1")

126. get_specific_drive_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(str): 硬盘名称"HDDPlaneDisk1",
    若传参，查询的为指定驱动器信息；若不传参，查询的为驱动器集合资源信息

> 返回值：

    1

    response(list): diskinfo

> 异常：

    1
    2
    3
    4

    None
    RedfishURL:
    https://device_ip/redfish/v1/Chassis/chassis_id/Drives
    https://device_ip/redfish/v1/Chassis/chassis_id/Drives/drives_id

> 举例：

    1
    2

    self.bmcController.dispatch('get_specific_drive_redfish',
    "HDDPlaneDisk1")

127. modify_specific_drive_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8

    modify_info  (dict):请求参数
    modify_info: {
    "Oem": {
    "Huawei": {
    "FirmwareStatus": diskstate
    }
    }
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13

    response(dict): 返回体
    response={
    ......
    "Protocol": "SAS",
    "MediaType": "HDD",
    "Manufacturer": "TOSHIBA",
    "SerialNumber": "EB72PC600G1C",
    "CapableSpeedGbs": 6,
    "NegotiatedSpeedGbs": 6,
    "PredictedMediaLifeLeftPercent": null,
    "IndicatorLED": "Off",
    ......
    }

> 异常：

    1
    2
    3

    None
    RedfishURL:
    https://device_ip/redfish/v1/Chassis/chassis_id/Drives/drives_id

> 举例：

    1
    2

    self.bmcController.dispatch('modifySpecificDiskRedfish', params={'diskId':'HDDPlaneDisk0',
    'body':{}})

128. get_power_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dicy): 指定机框资源id
    eg: params={'id': 'Enc'}

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('get_fan_info')

129. get_pcie_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

> 返回值：

    1

> 异常：

    1

> 举例：

    1

130. get_fan_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 指定机框资源id
    eg: params={'id': 'Enc'}

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('get_fan_info')

131. get_frame_mgt_shelf_number_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：从redfish获取设备的机框条形码

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(str): 机框号

> 异常：

    1

    None

> 举例：

    1
    2

    host = self.getDispatcher()
    shelfNumber = host.dispatch('get_frame_mgt_shelf_number_redfish')

132. get_all_temp_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 指定机框资源id
    eg: params={'id': 'Enc'}

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('get_all_temp_info')

133. get_fanmode_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 指定机框资源id
    eg: params={'id': 'Enc'}

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('get_fanmode_info_redfish')

134. get_fan_info_web
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 指定机框资源id
    eg: params={'id': 'Enc'}

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('get_fan_info_web')

135. get_pcie_id_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：pcie id对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_pcie_id_info', params=params)

136. get_pcie_port_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): {"pcie_id": "PCIeCard1"}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_pcie_port_info', params=params)

137. get_thermal_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 指定机框资源id
    eg: params={'id': 'Enc'}

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('get_thermal_info')

138. get_thermal_subsystem_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 指定机框资源id
    eg: params={'id': 'Enc'}

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('get_thermal_subsystem_info')

139. modify_thermal_subsystem_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 指定机框资源id
    eg: params={'id': 'Enc'}

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('modify_thermal_subsystem_info')

140. modify_thermal_subsystem_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 指定机框资源id
    eg: params={'id': 'Enc'}

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('modify_thermal_subsystem_info')

141. modify_indicator_led_state_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    ledStatus(dict): 该redfish请求的消息体:指示灯状态,字典形式

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('mock_precise_alarm_redfish', params=ledStatus)

142. get_chassis_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_chassis_collection_redfish')

143. get_by_chassis_info_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    chassisId(dict): 机箱资源的ID

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    chassisId = {'id':'1'}
    bmcController.dispatch('get_by_chassis_info_by_id_redfish' ,params=chassisId)

144. set_unit_rfid_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8

    body(dict):
    uid = "Uxx"
    { patch_body = {"UHeight": chassis_id_info["Oem"]["Huawei"]["UHeight"],
    "DeviceType": chassis_id_info["Oem"]["Huawei"]["DeviceType"],
    "Manufacturer": chassis_id_info["Manufacturer"],
    "Model": chassis_id_info["Model"],
    "SerialNumber": chassis_id_info["SerialNumber"]}
    kwargs = {"body": patch_body, "id": uid}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1
    2
    3

    None
    RedfishURL:
    redfish/v1/Chassis/U26/Oem/Huawei/Actions/Chassis.SetUnitRFIDInfo

> 举例：

    1
    2

    self.redfish.getResponse("set_unit_rfid_info_redfish",
    params=kwargs)[0]

145. set_chassis_info_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    chassisId(str):  机箱资源的ID
    pyload(dict):    要修改的资源信息

> 返回值：

    1

    None

> 异常：

    1

    None

> 举例：

    1

    None

146. get_network_ports_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): id:机箱资源的ID
    networkAdaptersId: 待导入网络适配器资源的ID

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params={'id':'1', 'networkAdaptersId':'mainboardPCIeCard4'}
    bmcController.dispatch('get_network_ports_redfish', params=params)

147. get_network_ports_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): id:机箱资源的ID
    networkAdaptersId:网络适配器资源的ID;
    portsId:网络端口资源的ID

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params = {'id':'1','networkAdaptersId':'mainboardPCIeCard4', 'portsId': '2'}
    bmcController.dispatch('get_network_ports_by_id_redfish', params=params)

148. set_network_ports_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params(dict): id:机箱资源的ID
    networkAdaptersId:网络适配器资源的ID;
    portsId:网络端口资源的ID
    "body":要设置的请求体信息

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11

    params={
    'id': '1',
    'networkAdaptersId': 'mainboardPCIeCard4',
    'portsId': '2',
    'body': {
    'Oem': {
    'Huawei': {
    'LldpService': {
    'LldpEnabled': LldpEnabled
    }}}}}
    bmcController.dispatch('set_network_ports_by_id_redfish', params=params)

149. get_discrete_sensors_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    chassisId(dict): 机箱资源的ID

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    chassisId = {'id':'1'}
    bmcController.dispatch('get_discrete_sensors_by_id_redfish', params=chassisId)

150. get_threshold_sensors_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    chassisId(dict): 机箱资源的ID

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    chassisId = {'id':'1'}
    bmcController.dispatch('get_threshold_sensors_by_id_redfish', params=chassisId)

151. modify_thermal_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): id:机箱资源的ID
    body: 待导入的机箱散热资源信息

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    params = {'id':'1','body':{"Oem":{"Huawei":{
    "FanSpeedAdjustmentMode":"Automatic",
    "FanSmartCoolingMode":"Custom","FanSpeedCustom":{
    "CPUTargetTemperatureCelsius":51,
    "OutletTargetTemperatureCelsius":50,
    "InletTemperature":{"
    TemperatureRangeCelsius":[20,30,40,
    50],"FanSpeedPercents":[20,30,40,50,90]}}}}}}
    bmcController.dispatch('modify_thermal_info_redfish', params=params)

152. get_power_attributes_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): id:机箱资源的ID

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params = {'id':'1'}
    bmcController.dispatch('get_power_attributes_redfish', params=params)

153. modify_power_attributes_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): id:机箱资源的ID
    body:电源属性，包括设置功率封顶参数，
    设置期望电源冗余模式，设置深度休眠使能状态

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    params = {'id':'1','body':{"PowerControl":[{
    "PowerLimit":{"LimitInWatts":700,"LimitException":"NoAction"}}]}}
    bmcController.dispatch('modify_power_attributes_redfish', params=params)

154. get_power_history_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_power_history_data', params=params)

155. set_control_indicator_led_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): id:机箱资源的ID
    body:控制类型和闪烁时间

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params = {'id':'1','body':{"IndicatorLED":"Lit"}}
    bmcController.dispatch('set_control_indicator_led_redfish', params=ledStateInfo)

156. get_inlet_history_temperature_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_inlet_history_temperature_data', params=params)

157. collect_history_data_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    body(dict): {"Type":"URI",
    "Content":"/tmp/web/kvm.jnlp", "Mode":"Shared"}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1
    2
    3

    None
    RedfishURL:
    Chassis/1/power/Oem/Huawei/Actions/Power.CollectHistoryData

> 举例：

    1

    self.server.dispatch('collect_history_data_redfish')

158. reset_history_data_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): {"body":{}}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1
    2
    3

    None
    RedfishURL:
    /redfish/v1/Chassis/Enc/Power/Oem/Huawei/Actions/Power.ResetHistoryData

> 举例：

    1

    self.server.dispatch('reset_history_data_redfish')

159. reset_statistics_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：对象property生成器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('reset_statistics_redfish', params=params)

160. get_bmc_s_wcard_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    managerId(dict): 计算板槽位

> 返回值：

    1

    response(Bunch): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_bmc_s_wcard_info', params=managerId)

161. get_bmc_risercard_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    managerId(dict): riser卡编号

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    managerId = {'id': '2'}
    bmcController.dispatch('get_bmc_risercard_info', params=managerId)

162. get_bmc_s_pcard_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    managerId(dict): SP卡编号

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    managerId = {'id': '8'}
    bmcController.dispatch('get_bmc_s_pcard_info', params=managerId)

163. get_bmc_board_id_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    boardId(dict): 扩展板资源的ID

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    boardId = {'id': 'mainboardRAIDCard1'}
    bmcController.dispatch('get_bmc_s_pcard_info', boardId)

164. get_npu_board_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(list): NPU编号 eg: ["0", "1"]

> 异常：

    1

    None

> 举例：

    1
    2
    3

    self.bmc_controller = self.server_device.getController("B1")
    self.redfish = self.bmc_controller.find("Redfish")[0]
    npu_info = self.redfish.getNPUId()

165. get_npu_board_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): npu资源编号

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params = {'npu_board_id': '2'}
    bmcController.dispatch('getNPUInfoRedfish', params=params)

166. set_npu_board_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): {'npu_board_id': npu_board_id, 'body': body}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params = {'npu_board_id': '2', "body": {"WorkMode": "AMP"}}
    bmcController.dispatch('getNPUInfoRedfish', params=params)

167. get_backup_battery_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 接口的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    redfish = self.bmcController.find('RedFish')[0]
    info = redfish.getResponse('get_backup_battery_info')

168. get_backup_battery_units_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(Bunch): 接口的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    redfish = self.bmcController.find('RedFish')[0]
    info = redfish.getResponse('get_backup_battery_units_info')

169. get_network_adapter_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_network_adapter_redfish')

170. get_network_adapter_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): id:机箱资源的ID
    networkAdaptersId:网络适配器资源的ID

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params={'id':'1', 'networkAdaptersId':'mainboardPCIeCard4'}
    bmcController.dispatch('get_network_ports_redfish', params=params)

171. modify_network_adapter_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): networkAdaptersId:网卡NetworkAdapter的id,
    例如: mainboardMEZZ1
    body:网络适配器资源的参数内容

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params= {"body": payload, "networkAdaptersId": "mainboardMEZZ1"}
    bmcController.dispatch('modify_network_adapter_by_id_redfish', params)

172. get_chassis_slot_id
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回单板槽位号
    Args:
    params(dict): 输入参数

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_chassis_slot_id')

173. modify_chassis_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8

    params(dict): 请求参数
    params: {
    "Oem": {
    "Huawei": {
    "ChassisID": "0"
    }
    }
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    response(dict): 返回体
    response={
    ......
    "Oem": {
    "Huawei": {
    "ChassisID": "0"
    }
    }
    ......
    }

> 异常：

    1

    None

> 举例：

    1
    2

    params = {'id':'Enclosure','body':{"Oem": {"Huawei": {"ChassisID": "0"}}}}
    self.bmcController.dispatch('modify_chassis_id_redfish', params=params)

174. get_chassis_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    host = self.getDispatcher()
    ChassisID = host.dispatch('get_chassis_id_redfish')

175. modify_crypto_erase_drive_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params(dict): 请求参数
    params: {drivesId: 硬盘Location+Devicename
    body: body体
    }

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1
    2

    self.bmcController.dispatch('modify_crypto_erase_drive_redfish', params={'diskId':'HDDPlaneDisk0',
    'body':{}})

176. modify_pc_ie_alarm_led_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    host = self.getDispatcher()
    ChassisID = host.dispatch('modify_pc_ie_alarm_led_redfish')

177. set_psu_supply_source_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): {"body": patch_body, "id": Rack}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('set_psu_supply_source_redfish')

178. get_ar_card_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): AR卡槽位编号

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params = {'Slot': '0'}
    self.bmcController.dispatch('get_ar_card_redfish', params=params)

179. set_ar_card_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7

    params(dict): AR卡上下电或重启状态和槽位号
    params={"ARCardControlType": "Reset", "Slot":0}
    上电: On
    下电: Off
    重启: Reset
    恢复出厂设置: RestoreFactory
    槽位号: 0/1(int)

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    params={"ARCardControlType": "Reset", "Slot":0}
    res = self.bmcController.dispatch("set_ar_card_redfish",
    params=params)

180. set_device_installed_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): {"body": patch_body, "u_id": U1}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('set_psu_supply_source_redfish')

181. set_cabinet_size_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): {"body": patch_body, "chassis_id": ID}
    chassisId(str): 机箱资源的ID
    body(dict): 要修改的资源信息

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1
    2
    3

    None
    RedfishURL:
    /redfish/v1/Chassis/Rack/Oem/Huawei/Actions/Chassis.SetDimensions

> 举例：

    1

    self.server.dispatch('set_cabinet_size_redfish')

182. get_asset_bar_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 资源编号

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    params = {"chassis_id": "rack",
    "board_id": 1}
    bmcController.dispatch('get_asset_bar_info_redfish', params=params)

183. set_cabinet_led_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): {"body": patch_body, "chassis_id": ID}
    chassisId(str): 机箱资源的ID
    body(dict): 要修改的资源信息

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('set_cabinet_led_redfish')

184. import_config_file_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口上导入标签模板

    命令格式：https://IP/redfish/v1/Chassis/Rack/Oem/Huawei/Actions/Chassis.ImportConfigFile

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): {"body": post_body, "chassis_id": ID}
    chassis_id(str): 机箱资源ID

> 返回值：

    1

    response(dict): 返回响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('ImportConfigFileRedfish')

185. get_import_file_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询导入标签模板文件信息

    命令格式：https://redfish/v1/Chassis/Rack/ImportConfigFileActionInfo

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    chassisId(str): 指定机箱资源的ID,为机箱在机箱集合中的唯一标识

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('getImportFilenfoRedfish')

186. export_config_file_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口导出标签模板

    命令格式：https://IP/redfish/v1/Chassis/Rack/Oem/Huawei/Actions/Chassis.ExportUMarkLabelTemplate

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): {"body": post_body, "chassis_id": ID}
    chassis_id(str): 机箱资源ID

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('export_config_file_redfish')

187. get_export_file_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询导出标签模板文件信息

    命令格式：https://redfish/v1/Chassis/Rack/ExportUMarkLabelTemplateActionInfo

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    chassisId(str): 指定机箱资源的ID,为机箱在机箱集合中的唯一标识

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('getExportFilenfoRedfish')

188. get_pcie_card_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取指定接口卡或所有卡的信息

    命令格式：https://redfish/v1/Chassis/Blade2/PCIeDevices/PCIeCard1

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): {"pcie_id": card_id}
    pcie_id(str): PCIeCard1Returns

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    device_info = self.redfish.getResponse(function="get_pcie_card_info", params={"pcie_id": card_id})[0]

189. get_units_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器组件集合资源信息

    命令格式：https://redfish/v1/Chassis/chassis_id/Units

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): params = {"chassis_id": chassis_id}
    chassis_id(str): 指定机箱资源的ID,为机箱在机箱集合中的唯一标识

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_units_collection_redfish')

190. get_specific_units_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定组件信息

    命令格式：https://redfish/v1/Chassis/chassis_id/Units/BasicComputingUnit1

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params(dict): params = {"chassis_id": chassis_id, "type": "BasicComputingUnit1"}
    chassis_id(str): 指定机箱资源的ID,为机箱在机箱集合中的唯一标识
    type(str)指定组件的名称(eg: BasicComputingUnit1/StorageExtensionUnit1
    /CoolingUnit1/ExtensionUnit1/IOExtensionUnit1)

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_specific_units_info_redfish')

191. get_pcie_function_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params: {"pcie_id": "PCIeCard1"}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    device_info = self.redfish.getResponse(function="get_pcie_function_info", params={"pcie_id":
    card_id})[0]

192. set_output_enabled_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口进行电源的休眠和唤醒

    命令格式：https://redfish/v1/Chassis/Enc/Power/Oem/Huawei/Actions/Power.SetOutputEnabled

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): {“PsuId": 1, “OutputEnabled” :true}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('set_output_enabled_redfish')

193. post_power_history_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params = None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    rsp = redfish.dispatch('get_power_history_data', params=params)

194. get_optical_module_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): {'chassis_id': 'HMM1', 'port_id': '0'}
    chassis_id(str): 指定机箱资源的id
    port_id(str): 端口id

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    params = {'chassis_id': 'HMM1', 'port_id': '0'}
    res = self.hmmController.dispatch('get_optical_module_redfish', params=params)

195. get_all_adapters_netports_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

> 返回值：

    1

> 异常：

    1

> 举例：

    1

196. export_acquisition_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 函数入参,包含以下键
    table_name(str): 要导出的表的名字,可选Tag;Metric;DataPoint

> 返回值：

    1

    url响应值

> 异常：

    1

    None

> 举例：

    1

    None

197. get_acquisition_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_acquisition_data', params=params)

198. set_acquisition_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_acquisition_data', params=params)

199. get_acquisition_report_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    param(dict): {"MetricType": "Health", "ComponentType": None, "StartTime": None,
    "EndTime": None}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_acquisition_report_data', params=params)

200. data_filtering_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    body(dict): post操作的传的body体
    示例: body={"AcquisitionItems": [{"ComponentType": "CPU",
    "MetricType": ["Voltage", "Performance"]]}
    ComponentType   ：需要查询的部件名
    MetricType      ：需要查询的指标类型
    actionname:

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1
    2
    3

    None
    RedfishURL:
    DataAcquisitionService/Actions/HwDataAcquisitionService.DataFiltering

> 举例：

    1
    2
    3

    self.server.dispatch('data_filtering_redfish')
    Modify:
    增加actionName参数,区分各个action资源 * 2020-04-02

201. clear_history_data_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): post操作的传的body体{}
    RedfishURL:
    DataAcquisitionService/Actions/HwDataAcquisitionService.ClearHistoryData

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('clear_history_data_redfish')

202. get_acquisition_configuration_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_acquisition_configuration_info', params=params)

203. set_acquisition_configuration_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_acquisition_configuration_info', params=params)

204. get_power_agent_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    由于机柜加上节点板后，查询机柜能效配置信息的时候，经常请求超时，需要添加参数，延长请求时间来提升脚本健壮性

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_power_agent_info', params=params)

205. set_power_agent_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_power_agent_info', params=params)

206. get_rack_management_service_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询RackManagementService资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): RackManagementService下的资源信息

> 异常：

    1

    None

> 举例：

    1

    response = self.RackManagementService.get_rack_management_service_info()

207. get_network_agent_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    RackManagementService下的网络信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_network_agent_info', params=params)

208. get_session_agent_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 响应body体,机柜设备会话代理集合资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_session_agent_info')

209. set_rack_power_capping_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): post操作的传的body体params

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('set_rack_power_capping_redfish')

210. get_rack_management_ecu_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询RackManagementEcu资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): RackManagementService下的资源信息

> 异常：

    1

    None

> 举例：

    1

    self.dispatch('get_rack_management_ecu_info', params)

211. get_rack_management_ecu_other_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询RackManagementEcu传感器、版本、运行状态等信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): RackManagementService下的资源信息

> 异常：

    1

    None

> 举例：

    1

    self.dispatch('get_rack_management_ecu_other_info', params)

212. set_rack_management_ecu_other_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：PATCH方法设置RackManagementEcu参数信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): patch操作的传的body体params

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.dispatch('set_rack_management_ecu_other_info', body)

213. set_rack_management_ecu_restore
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口恢复ECU出厂设置

    命令格式：https://RackManagementService/EcuDevices/{slot_id}/Actions/EcuDevices.RestoreEcu

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): post操作的传的body体params

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('set_rack_management_ecu_restore')

214. get_event_service_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器事件服务资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): 传入的body体params

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('getEventServiceRedfish)

215. set_event_service_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改事件服务资源，包括修改事件上报开关状态和修改事件主机标识源。

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    event(dict): 请求资源消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_event_service_redfish')

216. submit_test_event_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：模拟测试事件

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    submitEvent(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('submit_test_event_redfish', params=submitEvent)

217. rearm_event_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：对未恢复的事件重新上报

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): 传入的body体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    bmcController.dispatch('rearm_event_redfish')

> 举例：

    1

    bmcController.dispatch('rearm_event_redfish', params=params)

218. mock_precise_alarm_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：模拟精准的告警

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    alarm(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('mock_precise_alarm_redfish', params=alarm)

219. set_event_severity_level_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置事件告警级别

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    eventlevel(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_event_severity_level_redfish', params=eventlevel)

220. get_event_book_set_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询事件订阅集合资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 传入的body体params

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_event_book_set_info_redfish')

221. creat_event_book_set_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：创建事件订阅资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    eventMsg(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('creat_event_book_set_info_redfish', params=eventMsg)

222. get_specific_subscriptions_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询事件订阅资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    subId(dict): 该redfish请求的消息体:待查询的id

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    subId = {'Id': '1'}
    bmcController.dispatch('get_specific_subscriptions_redfish', params=subId)

223. set_specific_subscriptions_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改事件订阅资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    subIdContent(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6

    subcontent = {'subId': '1',
    'subcontent': {"HttpHeaders": http_headers,
    "Context": context
    }
    }
    bmcController.dispatch('set_specific_subscriptions_redfish', params=subIdContent)

224. delete_subscriptions_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：删除事件订阅资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    subId(dict): 待删除的事件订阅资源ID:{'subId': '1'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    subId = {'subId': '1'}
    bmcController.dispatch('delete_subscriptions_redfish', params= subId)

225. restore_subscriptions
> 描述：

    1
    2
    3
    4
    5

    方法功能：对未恢复的事件重新上报

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    subId(dict): 待恢复的事件订阅资源ID:{'subId': '1'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    subId = {'subId': '1'}
    bmcController.dispatch('restore_subscriptions', params= subIdContent)

226. shield_system_alert_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置告警屏蔽

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    alarm(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('shield_system_alert_redfish', params=alarm)

227. set_managers_bmc_reset_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：BMC复位

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): ForceRestart

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    body = {"ResetType": "ForceRestart"}
    bmcController.dispatch("set_managers_bmc_reset_redfish", params= body)

228. set_bmc_smtp_submit_test_event_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：SMTP发送测试事件

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    importInfo(dict): 请求消息体

> 返回值：

    1

    syslogInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2
    3

    importInfo = {"MemberId":"0"}
    bmcController.dispatch('set_bmc_syslog_submit_test_event_redfish',
    params=importInfo)

229. set_snmp_service_submit_test_event_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：snmp服务发送测试事件

    命令格式：用post执行https://Managers/manager_id/SnmpService/Actions/SnmpService.SubmitTestEvent

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    params(dict): params = {
    "MemberId":  value
    }
    "MemberId":  (str)  Trap服务器编号 必选参数
    "flag" : 默认值为true,可选参数,请求体为空时flag为false

> 返回值：

    1

    response(dict): url发送post请求后的响应值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("set_snmp_service_submit_test_event_redfish", {"MemberId": ""0})

230. get_log_services_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询日志服务集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    blade(dict): 指定管理资源(HMM1或者HMM2)

> 返回值：

    1

    logInfo(dict): 响应body体,日志服务集合资源信息

> 异常：

    1

    None

> 举例：

    1
    2

    hmmId = {"bladeId":"HMM1"}
    HmmController.dispatch('get_log_services_info_redfish', params=hmmId)

231. get_log_services_id_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定日志服务资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    logtype(dict): 指定管理资源(HMM1或者HMM2)
    日志服务资源的ID(OperateLog/RunLog/SecurityLog)

> 返回值：

    1

    response(dict): 响应body体,指定日志服务资源信息

> 异常：

    1

    None

> 举例：

    1
    2

    logtype = {"id":"HMM1", "type":"OperateLog"}
    HmmController.dispatch('get_log_services_id_info_redfish', params=logtype)

232. set_log_services_id_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导出日志信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    exportInfo(dict): id: 指定管理资源(HMM1或者HMM2)
    logid: 日志服务资源的ID(OperateLog/RunLog/SecurityLog)
    body: 请求消息体

> 返回值：

    1

    csrInfo(dict): 响应body体,创建导出日志任务

> 异常：

    1

    None

> 举例：

    1
    2
    3

    exportInfo = {"id":"HMM1", "body":{"Type":"URI", "Content":"/tmp/web/operate_log"},
    "logid":"OperateLog"}
    HmmController.dispatch('set_log_services_id_info_redfish', params=exportInfo)

233. get_specific_log_entries_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询日志集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 指定管理资源(HMM1或者HMM2)
    日志服务资源的ID(OperateLog/RunLog/SecurityLog)

> 返回值：

    1

    response(dict): 响应body体,日志集合资源信息

> 异常：

    1

    None

> 举例：

    1
    2

    logType = {"id":"HMM1", "type":"OperateLog"}
    HmmController.dispatch('get_specific_log_entries_info_redfish', params=logType)

234. getlast_n_log_entries_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取最后N条日志集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 指定管理资源(HMM1或者HMM2)
    日志服务资源的ID(OperateLog/RunLog/SecurityLog)

> 返回值：

    1

    response(dict): 响应body体,日志集合资源信息

> 异常：

    1

    None

> 举例：

    1
    2

    logType = {"id":"HMM1", "type":"OperateLog"}
    HmmController.dispatch('getlastLogEntriesInfoRedFish', params=logType)

235. get_log_entries_id_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询日志资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    logtype(dict): 指定管理资源(HMM1或者HMM2)
    日志服务资源的ID(OperateLog/RunLog/SecurityLog)
    指定日志资源的ID(1、2、3......)

> 返回值：

    1

    response(dict): 响应body体,日志集合资源信息

> 异常：

    1

    None

> 举例：

    1
    2

    logtype = {"id":"HMM1", "type":"OperateLog", "entriesid":"1"}
    HmmController.dispatch('get_log_entries_id_info_redfish', params=logtype)

236. get_fpc_service_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：FPC资源属性查询

    命令格式：https://redfish/v1/Managers/1/FPCService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): fpc资源属性信息

> 异常：

    1

    None

> 举例：

    1

    self.dispatch('get_fpc_service_redfish', params)

237. get_fpc_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：FPC指定类型资源详细信息查询

    命令格式：https://redfish/v1/Managers/1/FPCService/Memory

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    fpctype(dict): param = {"type":"Memory"}

> 返回值：

    1

    response(dict): FPC资源详细信息

> 异常：

    1

    None

> 举例：

    1

    self.dispatch('get_fpc_service_info_redfish', fpctype)

238. get_frame_mgt_guid_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：从redfish获取设备的uuid

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): param = {"bladeId":"HMM1"}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    host = self.getDispatcher()
    idValue = host.dispatch('get_frame_mgt_guid_info_redfish',param)

239. get_fdm_service_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController.dispatch('get_fdm_service_info', params=params)
    modified: 20190722

240. get_sp_service_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取SP信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): SP信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_sp_service_info")

241. set_fdm_generate_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    host = self.getDispatcher()
    host.dispatch('set_fdm_generate_redfish',param)

242. get_system_erase_para
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定SP系统擦除配置信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    response(dict):
    {
    "@odata.context": "/redfish/v1/$metadata#HwSystemErase.HwSystemErase",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SystemErase/1",
    "@odata.type": "#HwSystemErase.v1_0_0.HwSystemErase",
    "Components": ["Name": "Disks"],
    "Id": "1",
    "Name": "SP System Erase"
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_system_erase_para")

243. get_system_erase_para_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询SP系统擦除配置集合资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14

    response(dict):
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SystemErase
    /Members/$entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SystemErase",
    "@odata.type": "#HwSystemEraseCollection.HwSystemEraseCollection",
    "Name": "SP System Erase Collection",
    "Members@odata.count": 1,
    "Members": [
    {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SystemErase/1"
    }
    ]
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_system_erase_para_info")

244. create_system_erase_task
> 描述：

    1
    2
    3
    4
    5

    方法功能：创建SP系统擦除配置文件

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    body(dict): 创建SP系统擦除配置文件
    eg:
    body = {"Components": [{"Name": "Disks"}]}

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    response(dict):
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SystemErase/Members
    /$entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SystemErase/1",
    "@odata.type": "#HwSystemErase.v1_0_0.HwSystemErase",
    "Components": [
    {
    "Name": "Disks"
    }
    ]
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("create_system_erase_task",params = body)

245. set_fdm_remove_alarm_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    host = self.getDispatcher()
    host.dispatch('set_fdm_remove_alarm_redfish', param)

246. get_managers_ntp_service_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): NTPService接口信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_managers_ntp_service_info', params=params)

247. modify_manager_ntp_service_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8

    modifyInfo(dict): 请求消息体，修改内容
    eg:
    modifyInfo={
    "ServiceEnabled": False
    "MinPollingInterval": 4,
    "MaxPollingInterval": 10,
    ...
    }

> 返回值：

    1

    result(dict): 响应body体,NTP资源属性设置后信息

> 异常：

    1
    2
    3

    None
    RedfishURL:
    https://device_ip/redfish/v1/Managers/manager_id/NtpService

> 举例：

    1
    2

    modifyInfo = {"ServiceEnabled": False}
    bmcController.dispatch('modify_manager_ntp_service_info', params=modifyInfo)

248. import_managers_ntp_key_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    NtpKey(dict): 请求消息体,密钥信息
    eg:
    NtpKey={
    "Type":"URI",
    "Content":"/tmp/ntp.keys"
    }

> 返回值：

    1

    result(Bunch): 响应body体,上传结果

> 异常：

    1
    2
    3

    None
    RedfishURL:
    https://device_ip/redfish/v1/Managers/manager_id/NtpService/Actions/NtpService.ImportNtpKey

> 举例：

    1
    2

    NtpKey = {"Type":"URI", "Content":"/tmp/ntp.keys"}
    bmcController.dispatch('import_managers_ntp_key_info', params=NtpKey)

249. get_managers_snmp_service_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：redfish获取SNMPService信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): 输入的body体
    return:
    response(dict): SNMPService接口信息

> 返回值：

    1

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_managers_snmp_service_info",params = body)

250. reset_ibmc_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：复位iBMC系统

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('rearm_event_redfish')

251. get_managers_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询管理集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    info(dict): 响应body体,管理集合资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_managers_info_redfish')

252. get_slot_id
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询单板槽位号信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 返回单板槽位号

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_slot_id')

253. get_specific_managers_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    blade(dict): 可选'HMM1'/'HMM2'/'BladeN'
    eg: blade = {"bladeId": 'Blade1'} or blade = None

> 返回值：

    1

    info(dict): 响应body体,指定管理资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_specific_managers_info_redfish', blade)

254. get_redundency_blade
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1
    2
    3

    response(dict):
    example:
    {'active': 'HMM1', 'stand_by': 'HMM2'}

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_redundency_blade', params=params)

255. get_redundency_status
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(str): 当前登录单板的主备状态。 Standby or Active

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_redundency_status', params=params)

256. modify_specific_managers_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    modifyInfo(dict|str): {请求消息体,需要修改的指定管理资源的信息
    "bladeId":选填,添加管理板(HMM1,HMM2)}

> 返回值：

    1

    info(dict): 响应body体,修改后的指定管理资源信息

> 异常：

    1

    None

> 举例：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15

    modifyInfo = {
    "Oem": {
    "Huawei": {
    "LoginRule": [
    {
    "MemberId": "Rule1",
    "RuleEnabled": True,
    "StartTime": "",
    "EndTime": "",
    "IP": "",
    "Mac": ""
    }
    ]
    }}}
    bmcController.dispatch('modify_specific_managers_info_redfish', params=manager)

257. set_bmc_manager_dump_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    exportInfo(dict): 请求消息体

> 返回值：

    1

    result(dict): 响应body体,一键收集任务创建信息

> 异常：

    1

    None

> 举例：

    1
    2

    exportInfo = {"Type":"URI", "Content": "/tmp/dump.tar.gz"}
    bmcController.dispatch('set_bmc_manager_dump_redfish', params=exportInfo)

258. set_hmm_manager_dump_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体

> 返回值：

    1

    result(dict): 响应body体,一键收集任务创建信息

> 异常：

    1

    None

> 举例：

    1
    2
    3

    params = {'hmmId': 'HMM1',
    'Info': {"Type": "URI", "Content": "/tmp/dump.tar.gz"}}
    bmcController.dispatch('set_hmm_manager_dump_redfish', params=exportInfo)

259. get_bmc_syslog_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询Syslog资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    info(dict): 响应body体,Syslog资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_bmc_syslog_info_redfish')

260. modify_syslog_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：Syslog资源属性设置,如Syslog服务使能,主机标志,传输协议,Syslog认证方式,日志类型等

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 需修改的信息，请求消息体

> 返回值：

    1

    syslogInfo(dict): 响应body体,修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2

    modifyInfo = {"ServiceEnabled": True}
    bmcController.dispatch('modify_syslog_info_redfish', params=modifyInfo)

261. modify_byte_dance_syslog_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：字节定制的url进行Syslog资源属性设置,如Syslog服务使能,主机标志,传输协议,Syslog认证方式,日志类型等

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 需修改的信息，请求消息体

> 返回值：

    1

    syslogInfo(dict):  响应body体,修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2

    modifyInfo = {"ServiceEnabled": True}
    bmcController.dispatch('modify_byte_dance_syslog_redfish', params=modifyInfo)

262. get_byte_dance_syslog_test_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询字节定制Syslogtest资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体

> 返回值：

    1

    info(dict): 响应body体, Syslog资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_byte_dance_syslog_test_info_redfish')

263. get_byte_dance_syslog_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询字节定制Syslog资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体

> 返回值：

    1

    info(dict): 响应body体, Syslog资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_byte_dance_syslog_info_redfish')

264. set_byte_dance_syslog_submit_test_event_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：字节定制Syslog url进行submit测试

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): {"LogType": "SELLog", "MemberId": "1"}

> 返回值：

    1

    info(dict): 响应body体, Syslog submit测试结果

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_byte_dance_syslog_submit_test_event_redfish')

265. modify_smtp_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：Smtp资源属性设置

    命令格式：https://redfish/v1/Managers/1/SmtpService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 需修改的信息，请求消息体

> 返回值：

    1

    smtpInfo(dict): 响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2

    modifyInfo = {"ServiceEnabled": True}
    bmcController.dispatch('modify_smtp_info_redfish', params=modifyInfo)

266. modify_fdm_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 需修改的信息, 请求消息体

> 返回值：

    1

    smtpInfo(dict): 响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2

    modifyInfo = {"RefreshIntervalHours": 24}
    bmcController.dispatch('modifyFDMRedfish', params=modifyInfo)

267. get_fdm_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

> 返回值：

    1

> 异常：

    1

> 举例：

    1

268. get_smtp_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取smtp服务信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体

> 返回值：

    1

    smtpInfo(dict): 响应body体, smtp服务信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_smtp_service_info_redfish', params=smtpInfo)

269. get_smnp_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：Snmp资源属性查询

    命令格式：https://redfish/v1/Managers/1/SnmpService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体

> 返回值：

    1

    snmpinfo(dict): 响应body体, snmp服务信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_smtp_service_info_redfish', params=smtpInfo)

270. modify_snmp_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：Snmp资源属性设置

    命令格式：https://redfish/v1/Managers/1/SnmpService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 需修改的信息，请求消息体

> 返回值：

    1

    syslogInfo(dict): 响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2

    modifyInfo = {"ServiceEnabled": True}
    bmcController.dispatch('modify_syslog_info_redfish', params=modifyInfo)

271. set_bmc_syslog_root_certificate_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    importInfo(dict): 请求消息体，根证书的导入方式及内容

> 返回值：

    1

    syslogInfo(dict): 响应body体, 导入结果

> 异常：

    1

    None

> 举例：

    1
    2

    importInfo = {"Type":"text", "Content": "content"}
    bmcController.dispatch('set_bmc_syslog_root_certificate_redfish', params=importInfo)

272. set_bmc_syslog_client_certificate_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    importInfo(dict): 请求消息体，根证书的导入方式、内容、解密证书的密码

> 返回值：

    1

    syslogInfo(dict): 响应body体, 导入结果

> 异常：

    1

    None

> 举例：

    1
    2

    importInfo = {"Type":"text", "Content": "content", "Password":"123"}
    bmcController.dispatch('set_bmc_syslog_client_certificate_redfish', params=importInfo)

273. set_bmc_syslog_import_crl_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    importInfo(dict): 请求消息体，根证书的导入方式、内容

> 返回值：

    1

    syslogInfo(Bunch): 响应body体, 导入结果

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4

    importInfo = {"Type":"text", "Content": "content"}
    bmcController.dispatch('set_bmc_syslog_import_crl_redfish', params=importInfo)
    RedfishURL:
    https://device_ip/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportCrl,

274. del_bmc_syslog_root_certificate_crl_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('del_bmc_syslog_root_certificate_crl_redfish', importInfo=modify_info)

275. set_bmc_syslog_submit_test_event_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    importInfo(dict): 请求消息体

> 返回值：

    1

    syslogInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2

    importInfo = {"MemberId":"0"}
    bmcController.dispatch('set_bmc_syslog_submit_test_event_redfish', params=importInfo)

276. get_kvm_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询KVM资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体

> 返回值：

    1

    kvmInfo(dict): 响应body体, KVM资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_kvm_info_redfish')

277. modify_kvm_info_redfish
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：修改KVM资源属性,如: KVM加密使能, 虚拟键盘、鼠标持续连接使能, 会话超时时间;
                 可同时设置多个服务的参数

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 需修改的信息, 请求消息体

> 返回值：

    1

    kvmInfo(dict): 响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2

    modifyInfo = {"EncryptionEnabled": True}
    bmcController.dispatch('modify_kvm_info_redfish', params=modifyInfo)

278. get_vmm_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询VMM资源属性

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体

> 返回值：

    1

    vmm_info(dict): 响应body体, VMM资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_vmm_info_redfish')

279. modify_vmm_info_redfish
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：修改VMM资源属性, 如: VMM加密使能, 虚拟键盘、鼠标持续连接使能, 会话超时时间;
                 可同时设置多个服务的参数

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 需修改的信息，请求消息体

> 返回值：

    1

    kvmInfo(dict): 响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2

    modifyInfo = {"Oem":{"Huawei":{"EncryptionEnabled": True}}}
    bmcController.dispatch('modify_vmm_info_redfish', params=modifyInfo)

280. set_kvm_key_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置KVM Key, 设置内容: Key标识符、Key标识符扩展、加密Key值、Key模式

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    setInfo(dict): 设置的信息, 请求消息体

> 返回值：

    1

    response(dict): 响应body体, 设置后结果

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    setInfo = {"Id": 1,
    "IdExt":"674aefdf7210bd0d877cb13d6ff9e512" ,
    "SecretKey": "0c6302198bd4cdf5db54a4383ae28f30da1ae1f6bfd8735c4c017d668cd27162",
    "Mode":"Shared"}
    bmcController.dispatch('set_kvm_key_redfish', params=setInfo)

281. get_ethernet_interfaces_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    blade(dict): 需要查询的板子, 比如HMM1,
    example: blade = {'bladeId': 'HMM1'}

> 返回值：

    1

    ethernetInfo(dict): 响应body体, iBMC网口集合资源信息

> 异常：

    1

    None

> 举例：

    1
    2

    blade = {'bladeId': 'HMM1'}
    bmcController.dispatch('get_ethernet_interfaces_info_redfish', blade)

282. get_bmc_specific_ethernet_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    ethernetInfo(dict): 响应body体, 指定iBMC网口资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_bmc_specific_ethernet_info_redfish')

283. get_hmm_specific_ethernet_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 需要查询的信息，请求消息体

> 返回值：

    1

    ethernetInfo(dict): 响应body体, 指定iBMC网口资源信息

> 异常：

    1

    None

> 举例：

    1
    2
    3

    params = {'bladeId': 'HMM1',
    'portType':'Plane1.4092'}
    bmcController.dispatch('get_hmm_specific_ethernet_info_redfish')

284. modify_specific_ethernet_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 需修改的信息, 请求消息体

> 返回值：

    1

    ethernetInfo(Bunch): 响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2

    modifyInfo = {"HostName": "test"}
    bmcController.dispatch('modify_specific_ethernet_info_redfish', params=modifyInfo)

285. modify_hmm_specific_ethernet_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 指定修改的板子，网口以及需修改的信息，请求消息体

> 返回值：

    1

    ethernetInfo(dict): 响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4

    modifyInfo = {'bladeId': 'HMM1',
    'portType':'Plane1.4092'
    'modifyBody':{"HostName": "test"}}
    bmcController.dispatch('modify_hmm_specific_ethernet_info_redfish', modifyInfo)

286. get_bmc_network_protocol_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    networkInfo(dict): 响应body体, iBMC服务信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_bmc_network_protocol_info_redfish')

287. get_ethernet_interfaces_nics_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    ethernetInfo(dict): 响应body体, 网口资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_ethernet_interfaces_nics_info_redfish')

288. get_ethernet_interfaces_dedicated_port_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    nicsid(dict): 需查询的网口资源, 例如DedicatedPort1
    PCIePort

> 返回值：

    1

    ethernetInfo(dict): 响应body体, 网口资源信息

> 异常：

    1

    None

> 举例：

    1
    2
    3

    nicsid = {"nicsid": "DedicatedPort1"}
    RedfishURL:
    https://device_ip/redfish/v1/Managers/manager_id/NICs/DedicatedPort1

289. modify_ethernet_interfaces_dedicated_port_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 需修改的信息，请求消息体

> 返回值：

    1

    ethernetInfo(dict): 响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1

    modifyInfo = {"body": {"HostName": "test"},"nicsid": "DedicatedPort1"}

290. modify_bmc_network_protocol_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 需修改的信息，请求消息体

> 返回值：

    1

    networkInfo(dict): 响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    modifyInfo = {"SSH":
    { "ProtocolEnabled": False,
    "Port": 1022 }
    }
    bmcController.dispatch('modify_bmc_network_protocol_info_redfish', params=modifyInfo)

291. switch_image_bmc_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 响应body体, 切换镜像结果

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('switch_image_bmc_redfish')

292. restore_factorys_bmc_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): 请求消息体，一般为{}

> 返回值：

    1

    response(dict): 响应body体, 恢复出厂结果

> 异常：

    1

    None

> 举例：

    1
    2

    body = "{}"
    bmcController.dispatch('restore_factorys_bmc_redfish', params=body)

293. get_trusted_compute_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    info(Bunch): 响应body体, 可信计算信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_trusted_compute_info_redfish')

294. set_trusted_compute_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modify_info(dict): params={"TrustedCenterServerAddr": self.bmc.local_ip}

> 返回值：

    1

    info(dict): 响应body体, 可信计算信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_trusted_compute_info_redfish', params=modify_info)

295. get_bmc_security_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询安全服务集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体

> 返回值：

    1

    info(dict): 响应body体, 安全服务集合资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_bmc_security_service_info_redfish')

296. set_bmc_security_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改安全服务集合资源信息

    命令格式：https://device_ip/redfish/v1/Managers/managers_id/SecurityService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modify_info(dict): 请求消息体

> 返回值：

    1

    info(dict): 响应body体, 安全服务集合资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_bmc_security_service_info_redfish', params=modify_info)

297. set_bmc_security_service_update_master_key_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：更新MasterKey

    命令格式：https://device_ip/redfish/v1/Managers/managers_id/SecurityService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(Bunch): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_bmc_security_service_update_master_key_redfish', params=modify_info)

298. import_configuration_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入BIOS或BMC配置(注：下次重启生效)

    命令格式：https://device_ip/redfish/v1/Managers/managers_id/Actions/Oem/Huawei/Manager.ImportConfiguration

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    config(dict)
    eg:
    本地导入：
    { "Type":"URI", "Content": "/tmp/config.xml" }
    远程导入：
    { "Type":"URI", "Content": "sftp://username:password@xx.xx.xx.xx/usr/config.xml"}

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    response(dict): 返回体
    {"Id": "1",
    "Name": "Import Config File Task",
    "TaskState": "Running",
    "StartTime": "2017-05-10T22:50:14+08:00",
    "Messages": [],
    "Oem": {
    "Huawei": {
    "TaskPercentage": null
    }
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('import_configuration_redfish',params=config_dict)

299. import_smm_configuration_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入交换板/管理板配置(注：下次重启生效)

    命令格式：https://device_ip/redfish/v1/Managers/HMM1/Actions/Oem/Huawei/Manager.ImportSwitchProfile

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    config(dict): 导入配置文件参数
    eg:
    本地导入：
    { "Type":"URI", "Content": "/tmp/config.cfg",  "SwiN":swi_n_value,
    "BladeType":blade_type _value,"PlaneNum":plane_num_value}
    远程导入：
    { "Type":"URI", "Content": "sftp://username:password@xx.xx.xx.xx/usr/config.xml",
    "SwiN":swi_n_value,
    "BladeType":blade_type _value,"PlaneNum":plane_num_value}

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    response(dict): 返回体
    {"Id": "1",
    "Name": "Import Config File Task",
    "TaskState": "Running",
    "StartTime": "2017-05-10T22:50:14+08:00",
    "Messages": [],
    "Oem": {
    "Huawei": {
    "TaskPercentage": null
    }
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('import_smm_configuration_redfish',params=config_dict)

300. export_configuration_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导出BIOS或BMC配置

    命令格式：https://device_ip/redfish/v1/Managers/managers_id/Actions/Oem/Huawei/Manager.ExportConfiguration

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    config(dict)
    eg:
    本地导出：
    { "Type":"URI", "Content": "/tmp/config.xml" }
    远程导出：
    { "Type":"URI", "Content": "sftp://username:password@xx.xx.xx.xx/usr/config.xml"}

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    response(dict): 返回体
    {"Id": "1",
    "Name": "Import Config File Task",
    "TaskState": "Running",
    "StartTime": "2017-05-10T22:50:14+08:00",
    "Messages": [],
    "Oem": {
    "Huawei": {
    "TaskPercentage": null
    }
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('export_configuration_redfish',params=config_dict)

301. export_smm_configuration_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导出交换板/管理板配置

    命令格式：https://device_ip/redfish/v1/Managers/managers_id/Actions/Oem/Huawei/Manager.ExportConfiguration

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7

    config(dict): 导出配置文件参数
    eg:
    本地导出：
    { "Type":"URI", "Content": "/tmp/config.tar.gz", "SwiN": "swi1"}
    远程导出：
    { "Type":"URI", "Content": "sftp://username:password@xx.xx.xx.xx/usr/config.tar.gz",
    "SwiN": "swi1"}

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    response(dict):  返回体
    {"Id": "1",
    "Name": "Import Config File Task",
    "TaskState": "Running",
    "StartTime": "2017-05-10T22:50:14+08:00",
    "Messages": [],
    "Oem": {
    "Huawei": {
    "TaskPercentage": null
    }
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('export_smm_configuration_redfish',params=config_dict)

302. get_bmc_ssl_security_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    sslInfo(dict):   响应body体, SSL证书资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_bmc_ssl_security_info_redfish')

303. get_bmc_server_cert_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body = {"action": "#HttpsCert.ImportServerCertificate"}

> 返回值：

    1

    sslInfo(dict): 响应body体, 服务器证书资源信息

> 异常：

    1

    None

> 举例：

    1
    2

    body = {"action": "#HttpsCert.ImportServerCertificate"}
    bmcController.dispatch('get_bmc_server_cert_redfish')

304. set_bmc_ssl_generate_csr_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): 请求消息体，必须填使用者的国家、名称

> 返回值：

    1

    csrInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    body = {
    "Country":"CN",
    "CommonName":"iBMC",
    "City":"Shenzhen",
    "State":"Guangdong",
    "OrgName":"Huawei",
    "OrgUnit":"IT"
    }
    bmcController.dispatch('set_bmc_ssl_generate_csr_redfish', params=body)

305. set_bmc_ssl_export_csr_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): 请求消息体

> 返回值：

    1

    csrInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    body = {
    "Type":"URI",
    "Content":"/tmp/c.csr"
    }
    bmcController.dispatch('set_bmc_ssl_export_csr_redfish', params=body)

306. set_bmc_import_server_cert_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): 请求消息体

> 返回值：

    1

    certInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2

    body = {"Certificate":  ""}
    bmcController.dispatch('set_bmc_import_server_cert_redfish', params=body)

307. get_cert_update_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    cerInfo(dict): 响应body体, 证书更新服务器资源信息

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController.dispatch('get_cert_update_service_info_redfish')
    URL:
    https://device_ip/redfish/v1/Managers/managers_id/SecurityService/CertUpdateService

308. set_cert_update_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modifyInfo(dict): 要修改的证书更新服务器资源信息

> 返回值：

    1

    info(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_cert_update_service_info_redfish', params=modifyInfo)

309. cert_update_service_import_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    params(dict): 导入的证书地址
    {
    "Type":"URI",
    "Content":"/tmp/HUAWEICA2.crt"
    }

> 返回值：

    1

    info(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('cert_update_service_import_redfish', params=params)

310. cert_update_service_import_crl_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    params(dict): 导入的吊销列表地址
    {
    "Type":"URI",
    "Content":"/tmp/CATest_notOverdue.crl"
    }

> 返回值：

    1

    info(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('cert_update_service_import_crl_redfish', params=params)

311. cert_update_service_delete_crl_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params: None None默认body为{}，否则传入{"RootCertId": 1}

> 返回值：

    1

    deleteCrl响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('deleteCrlRedfish')

312. cert_update_service_import_client_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    params(dict): 导入的证书地址
    {
    "Type":"URI",
    "Password":"123456",
    "Content":"/tmp/HuaweiBMCClientCert.pfx"
    }

> 返回值：

    1

    info(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4

    bmcController.dispatch('cert_update_service_import_client_redfish', params=params)
    URL:
    https://device_ip/redfish/v1/Managers/managers_id/SecurityService/CertUpdateService/
    Actions/CertUpdateService.ImportClientCert

313. excecute_sp_update
> 描述：

    1
    2
    3
    4
    5

    方法功能：执行SP升级任务

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 执行SP升级post命令的请求体

> 返回值：

    1

    response(dict): post命令返回体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    body = {
    "ImageURI": "nfs://xx.xx.xx.xx/home/sp/sp-116.iso",
    "SignalURI": "NULL",
    "ImageType": "SP",
    "Parameter": "all",
    "UpgradeMode": "Recover",
    "ActiveMethod": "OSRestart"
    }
    bmcController.dispatch("excecute_sp_update",params=body)

314. get_sp_update_progress
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询升级任务进度

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict):升级任务查询的全部返回体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_sp_update_progress",params=None)

315. modify_sp_service_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改SP服务资源属性, 例如从SP启动使能

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7

    params(dict): 修改SP服务资源属性
    eg: body ={
    "SPStartEnabled": "false",
    "SysRestartDelaySeconds": 30,
    "SPTimeout": 300,
    "SPFinished": "true"
    }

> 返回值：

    1

    response(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("modify_sp_service_property", params=body)

316. get_sp_result
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询SP的配置结果资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_sp_result")

317. delete_sp_file
> 描述：

    1
    2
    3
    4
    5

    方法功能：删除SP的升级文件或配置文件

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/SPService/Actions/SPService.DeleteFile

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8

    deleteFile(dict): 该redfish请求的消息体: 字典形式
    eg:
    deletefile ={
    "Type": "RAIDCfg",
    "Type": "NetDevCfg",
    "Type": "FWUpdateCfg",
    ...
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("delete_sp_file")

318. create_raid
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    body(dict): 组raid参数
    eg: body = {
    "InstallMode":"Recommended",
    "OSType":"ESXi6.5",
    "BootType":"UEFIBoot",
    "CDKey":"NG498-D6H4J-08549-DJA7K-ALUP4",
    "RootPwd":"huawei12",
    "HostName":"huawei",
    "NetCfg":[]
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("create_raid", params=body)

319. get_raid_cfg_para
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22

    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPRAID/Members
    /$entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPRAID/mainboardraidcard1",
    "@odata.type": "#HwSPRAID.v1_0_0.HwSPRAID",
    "Id": "mainboardraidcard1",
    "Name": "mainboardraidcard1",
    "CardModel": "LSI3008",
    "Location": "mainboard",
    "DeviceName": "RAIDCard1",
    "GlobalHotSpare": [4,5
    ],
    "DriveGroupList": [
    {"VolumeList": [{
    "CapacityBytes": 107374182400,
    "VolumeName": "RAID1",
    "BootEnable": true}],
    "VolumeRaidLevel": "RAID1",
    "Drives": [0,1]}
    ],
    "ClearConfig": true
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_raid_cfg_para")

320. get_sp_cfg_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询SP服务的配置资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     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

    response(dict): post命令返回体
    eg:
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPCfg/Members/$entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPCfg/1",
    "@odata.type": "#HwSPCfg.v1_0_0.HwSPCfg",
    "Id": "1",
    "Name": "SP Config",
    "OS": {
    "RedHat": [
    {
    "Ver": [
    {
    "Bit": 64,
    "Legacy": true,
    "Name": "Red Hat Enterprise Linux 7.5  x86-64",
    "UEFI": true,
    "Secure": false
    }
    ],
    "Type": "Red Hat 7U5",
    "Description": "RHEL7U5"
    }
    ]
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_sp_cfg_redfish")

321. get_sp_cfg_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询SPCfg的配置集合资源的信息

    命令格式：https://xx.xx.xx.xx/redfish/v1/Managers/1/SPService/SPCfg

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15

    response(dict): post命令返回体
    eg:
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/
    SPService/SPCfg/$entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPCfg",
    "@odata.type": "#HwSPCfgCollection.HwSPCfgCollection",
    "Name": "SP Config Collection",
    "Members@odata.count": 1,
    "Members": [
    {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPCfg/1"
    }
    ]
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_sp_cfg_collection_redfish")

322. get_certificate_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14

    'CMPConfig': {'AutoUpdateEnabled': False,
    'CAServerAddr': 'xx.xx.xx.xx',
    'CAServerPort': 33,
    'SubjectInfo': {'CommonName': 'IBMC',
    'Country': 'CN',
    'Email': ' 447234148@163.COM',
    'InternalName': 'BMC',
    'Location': 'XIAN',
    'OrgName': uHUAWEI',
    'OrgUnit': 'IT',
    'State': 'SHANXI'},
    'TLSAuthType': 'one-way'},
    'Description': 'Cert Update Service',
    'Id': 'CertUpdateService',

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_certificate_info_redfish")

323. export_raid_cfg
> 描述：

    1
    2
    3
    4
    5

    方法功能：触发导出raid配置

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('export_raid_cfg', params=params)

324. get_spraid_current_configurations_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): url对应的get响应值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_spraid_current_configurations_redfish", {"manager_id": "1"})

325. get_current_raid_config
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13

    response(dict): 查询当前raid配置资源的返回体
    eg:
    "Id": "mainboardRaidCard1",
    "Name": "SP RAID Current Configuration",
    "CardModel": "LSI3008",
    "DeviceName": "RAIDCard1",
    "GlobalHotSpare": [],
    "Location": "mainboard",
    "DriveGroupList": [{"VolumeList": [{"CapacityBytes": 298999349248,
    "VolumeName": "RAID1",
    "BootEnable": true}],
    "VolumeRaidLevel": "RAID1",
    "Drives": [0,1]}]

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_current_raid_config")

326. create_os_install_task
> 描述：

    1
    2
    3
    4
    5

    方法功能：创建SP 服务的OS 安装配置

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    body(dict): 部署OS请求体
    eg:  body ={
    "Id": "mainboardRAIDCard1",
    "CardModel": "LSI3008",
    "Location": "mainboard",
    "DeviceName": "RAIDCard1",
    "GlobalHotSpare": [  ],
    "DriveGroupList": [  ],
    "ClearConfig": true
    }

> 返回值：

    1

    response(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("create_os_install_task", params=body)

327. get_os_install_para
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询OS安装配置资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 部署OS请求体

> 返回值：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    response(dict): 获取OS安装资源信息
    "InstallMode": "Recommended",
    "OSType": "Win2016",
    "BootType": "UEFIBoot"
    "CDKey": "*****-*****-*****-*****-*****",
    "RootPwd": "******",
    "HostName": "huawei",
    "Language": "en-US",
    ...

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_os_install_para", params=body)

328. quick_deploy_clone
> 描述：

    1
    2
    3
    4
    5

    方法功能：创建SP服务的快速部署克隆配置。

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     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
    30
    31
    32
    33
    34
    35
    36

    body(dict): 请求体
    eg:
    body = {
    "GroupId": "group_id",
    "GroupEncAlgo": "enc_algo",
    "GroupToken": "group_token",
    "Image": {
    "Mode": "mount_mode",
    "DownUser": "username",
    "DownPwd": "password",
    "ImageDecAlgo": "dec_algo",
    "ImageKey": "image_key",
    "ServiceSideUrl": "ser_src_path",
    "ManageSideUrl": "mgr_src_path"
    },
    "TransNetwork": {
    "Addresses": [
    {
    "Mode": "ip_mode",
    "Version": "ip_version",
    "IP": "ip_addr",
    "Mask": "ipv4_mask",
    "Prefix": "ipv6_prefix",
    "Gateway": "gateway"
    }
    ]
    },
    "OSData": {
    "HostName": "hostname"
    },
    "SystemData": {
    "SyncBios": "sync_bios",
    "SyncIBmc": "sync_ibmc",
    "SyncRaid": "sync_raid"
    }
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    response(dict): 命令返回体
    eg:
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPClonePara
    /Members/$entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPClonePara/1",
    "@odata.type": "#HwSPClonePara.v1_0_0.HwSPClonePara",
    "Id": "1",
    "Name": "SP Clone Parameter"
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("quick_deploy_clone", params=body)

329. get_quick_deploy_clone_para
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询SP的快速部署克隆配置资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    response(dict): 命令返回体
    eg:
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPRecoverPara/Members/
    $entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPRecoverPara/1",
    "@odata.type": "#HwSPRecoverPara.v1_0_0.HwSPRecoverPara",
    "Id": "1",
    "Name": "SP Recover Parameter"
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_quick_deploy_clone_para")

330. quick_deploy_recover
> 描述：

    1
    2
    3
    4
    5

    方法功能：创建SP服务的快速部署还原配置。

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20

    body(dict): 请求体
    eg:
    body = {
    "UploadUser": "username",
    "UploadPwd": "password",
    "ImageEncAlgo": "enc_algo",
    "ImageKey": "image_key",
    "Destination": "dest_path",
    "MaxFileSize": "max_size",
    "Network": {
    "Addresses": [{"Mode": "ip_mode",
    "Version": "ip_version",
    "IP": "ip_addr",
    "Mask": "ipv4_mask",
    "Prefix": "ipv6_prefix",
    "Gateway": "gateway"}]},
    "Tools": {
    "ToolsUser": "tools_user",
    "ToolsPwd": "tools_pass",
    "ToolsUrl": "tools_path"}}

> 返回值：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    response(dict): 返回体
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPClonePara
    /Members/$entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPClonePara/1",
    "@odata.type": "#HwSPClonePara.v1_0_0.HwSPClonePara",
    "Id": "1",
    "Name": "SP Clone Parameter"
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_quick_deploy_clone_para", params=body)

331. get_quick_deploy_recover_para
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询SP的快速部署还原配置资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18

    response(dict): 返回体
    eg:
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPRecoverPara/Members/
    $entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPRecoverPara/1",
    "@odata.type": "#HwSPRecoverPara.v1_0_0.HwSPRecoverPara",
    "Id": "1",
    "Name": "SP Recover Parameter",
    "GroupId": "0dbaf4d4-0939-4339-b08d-a9e695e1d8ff",
    "GroupEncAlgo": null,
    "GroupToken": null,
    "Image": {
    "Mode": "sp",
    "DownUser": "user",
    "ServiceSideUrl": "sftp://xx.xx.xx.xx:1000/image/redhat_xh321_v5.iso"
    }
    ... }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("getQuickRecoverClonePara")

332. create_diagnose_task
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8

    body            (dict):   包含硬件诊断参数的请求体
    eg:
    body = {"Diagnose": [{
    "DeviceType": "CPU",
    "Mode": "Full",
    "DurationMinutes": 2  },
    {"DeviceType": "Memory",
    "Mode": "Full"}]}

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15

    创建诊断任务返回体
    eg:
    {"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPDiagnose/Members
    /$entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPDiagnose/1",
    "@odata.type": "#HwSPDiagnose.v1_0_0.HwSPDiagnose",
    "Id": "1",
    "Name": "SP Diagnose",
    "Diagnose": [
    {"Mode": "Full",
    "DeviceType": "CPU",
    "DurationMinutes": 2
    },{"Mode": "Full",
    "DeviceType": "Memory"}]
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("create_diagnose_task",params = body)

333. get_hardware_diagnose_para
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14

    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPDiagnose/Members/
    $entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPDiagnose/1",
    "@odata.type": "#HwSPDiagnose.v1_0_0.HwSPDiagnose",
    "Diagnose":
    [
    {
    "DeviceType":"CPU",
    "Mode":"Quick",
    "DurationMinutes":100
    }
    ]
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_hardware_diagnose_para")

334. get_sp_diagnose_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): url对应的get响应值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_sp_diagnose_redfish", {"manager_id": "1"})

335. create_drive_erase_task
> 描述：

    1
    2
    3
    4
    5

    方法功能：创建SP服务的硬盘擦除配置

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8

    body(dict): 硬盘擦除请求体
    eg:
    body = {
    "DriveErase":
    {
    "EraseMode":"Quick"
    }
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    response(dict): 命令返回体
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPDiagnose/Members/
    $entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPDiagnose/1",
    "@odata.type": "#HwSPDiagnose.v1_0_0.HwSPDiagnose",
    "DriveErase":
    {
    "EraseMode":"Secure",
    "EraseStrategy":"Normal"
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("create_drive_erase_task",params = body)

336. get_drive_erase_para
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询SP服务的硬盘擦除配置资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13

    response(dict): 命令返回体
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPDriveErase
    /Members/
    $entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPDriveErase/1",
    "@odata.type": "#HwSPDriveErase.v1_0_0.HwSPDriveErase",
    "DriveErase":
    {
    "EraseMode":"Secure",
    "EraseStrategy":"Normal"
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("get_drive_erase_para")

337. get_sp_device_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询SP服务的硬件信息资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     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
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39

    response(dict): 查询硬件信息资源返回体
    eg:
    {
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/DeviceInfo/$entity",
    "@odata.id": "/redfish/v1/Managers/1/SPService/DeviceInfo",
    "@odata.type": "#HwDeviceInfo.v1_0_0.HwDeviceInfo",
    "Id": "Device Info",
    "Name": "Device Info",
    "PCIeCards": [
    {
    "DeviceName": "SR150-M",
    "SerialNumber": "024JNFCNJA003298",
    "ProductName": "SAS3408",
    "Controllers": [
    {
    "Model": "SAS3408",
    "Functions": [
    {
    "VendorId": "0x1000",
    "BDFNumber": {
    "BDF": "0000:1c:00.0",
    "RootBDF": "0000:17:02.0"
    },
    "Description": "Storage Controller Collection",
    "CardType": "StorageControllers",
    "DeviceId": "0x0017",
    "SubsystemId": "0xd213",
    "SubsystemVendorId": "0x19e5"
    }
    ],
    "FirmwareVersion": "5.060.01-2139",
    "Manufacturer": "LSI"
    }
    ],
    "Position": "RAID Card1",
    "DeviceLocator": "mainboard"
    }
    ...
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sp_device_info', params=params)

338. connect_virtual_media_cd
> 描述：

    1
    2
    3
    4
    5

    方法功能：连接虚拟媒体操作

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(str): 连接虚拟媒体请求体

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    body = {
    "VmmControlType":"Connect",
    "Image":"nfs://xx.xx.xx.xx/home/sp/sp-116.iso"
    }
    bmcController.dispatch("connect_virtual_media_cd", params=body)

339. disconnect_virtual_media_cd
> 描述：

    1
    2
    3
    4
    5

    方法功能：断开虚拟媒体操作

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 返回体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("disconnect_virtual_media_cd")

340. get_virtual_media_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询挂载的虚拟媒体信息,默认查询CD信息

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/USBStick

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str): 虚拟设备类型

> 返回值：

    1
    2
    3
    4
    5
    6
    7

    response(dict): 响应体
    response={
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id":"/redfish/v1/TaskService/Tasks/1",
    ...
    }

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('get_virtual_media_info',params='USBStick')

341. connect_virtual_usb_stick
> 描述：

    1
    2
    3
    4
    5

    方法功能：连接虚拟USB操作

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/USBStick

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(str): 连接虚拟USB请求体

> 返回值：

    1
    2
    3
    4
    5
    6
    7

    response(dict):  响应体
    response={
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id":"/redfish/v1/TaskService/Tasks/1",
    ...
    }

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    body = {
    "USBStickControlType":"Connect",
    "ConnectType":"Formal"
    }
    bmcController.dispatch("connect_virtual_usb_stick", params=body)

342. disconnect_virtual_usb_stick
> 描述：

    1
    2
    3
    4
    5

    方法功能：断开连接虚拟USB操作

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/USBStick

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1
    2
    3
    4
    5
    6
    7

    response(dict):  响应体
    response={
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id":"/redfish/v1/TaskService/Tasks/1",
    ...
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch("disconnect_virtual_usb_stick")

343. get_vnc_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询VNC资源

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/VncService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1
    2
    3
    4
    5
    6
    7

    response(dict): 响应体
    response={
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id":"/redfish/v1/TaskService/Tasks/1",
    ...
    }

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('get_vnc_info')

344. modify_vnc_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改VNC资源

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/VncService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15

    ModifyInfo(dict): 响应体
    eg:
    ModifyInfo={
    "SSLEncryptionEnabled": True,
    "Password": "123",
    "SessionTimeoutMinutes": 5,
    "sessionId":会话的sessionid
    "token": {"types": str, "optional": True},可选参数,创建session后
    返回值headers中Token值,一般用于二次认证,和From、sessionid需要一起使用
    "From": {"types": str, "optional": True},可选参数,取值为WebUI,
    可用于redfish模拟web登录
    "cookie": {"types": str, "optional": True},可选参数,创建session后返回值中
    heasers中set-cookie的sessionid=后面的值
    "reauth_key": {"types": str, "optional": True} 可选参数 二次认证的密码,session的密码
    }

> 返回值：

    1
    2
    3
    4
    5
    6
    7

    response(dict): 返回体
    response={
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id":"/redfish/v1/TaskService/Tasks/1",
    ...
    }

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4

    ModifyInfo={
    "SSLEncryptionEnabled": True
    }
    self.bmcController.dispatch('modify_vnc_info',params=ModifyInfo)

345. get_license_service_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：get方法获取iBMC License资源信息

    命令格式：https://device_ip/redfish/v1/Managers/1/LicenseService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1
    2
    3
    4
    5
    6
    7
    8

    response(bunch): 响应体
    { "DeviceESN": "1FB811FE20CA8B952718A5CE66C28790CA41A2F6",
    "InstalledStatus": "Installed",
    "RevokeTicket": "",
    "LicenseClass": "Advanced",
    "LicenseStatus": "Normal",
    ......
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_license_service_redfish')

346. install_license_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：post方法安装iBMC License

    命令格式：https://device_ip/redfish/v1/Managers/1/LicenseService/Actions/LicenseService.InstallLicense

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7

    params(dict): 输入的body体
    eg:
    {
    "FileSource": "iBMC",            未配置时默认为iBMC
    "Type": "URI",
    "Content": "/tmp/license.xml"
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18

    response(dict): 响应体
    {
    "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
    {
    "@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",
    "MessageId": "iBMC.1.0.LicenseInstallSuccess",
    "RelatedProperties": [],
    "Message": "The license has been installed successfully.",
    "MessageArgs": [],
    "Severity": "OK",
    "Resolution": "None"
    }
    ]
    }
    }

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6

    body = {
    "FileSource": "iBMC",            未配置时默认为iBMC
    "Type": "URI",
    "Content": "/tmp/license.xml"
    }
    bmcController.dispatch('install_license_redfish',params=body)

347. get_lldp_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：Lldp资源属性查询

    命令格式：: https://redfish/v1/Managers/1/LldpService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    param(dict): 需要查询的单板如 HMM1\HMM2lade1
    {
    "bladeId": "blade1"
    }

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_lldp_service_info_redfish',params=body)

348. modify_lldp_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：Lldp资源属性设置,如设置Lldp使能打开

    命令格式：https://redfish/v1/Managers/1/LldpService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    modifyInfo(dict): 需修改的信息，请求消息体
    {
    "LldpEnabled": true,
    "TxHold": 5
    }

> 返回值：

    1

    LldpInfo(dict):  响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2

    modifyInfo = {"LLDPEnabled": true}
    bmcController.dispatch('modify_lldp_info_redfish', params=modifyInfo)

349. get_energy_saving_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：redfish获取能源保存服务信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_energy_saving_service_info_redfish', params=params)

350. modify_energy_saving_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    modifyInfo(dict): 需修改的信息，请求消息体
    {
    "DeactiveThreshold": {
    "LogicalCoreCpuUtilisePercents": null
    }
    }

> 返回值：

    1

    EnergySavingServiceInfo(dict): 响应body体, 修改后的信息

> 异常：

    1

    None

> 举例：

    1
    2

    modifyInfo = {"ServiceEnabled": true}
    bmcController.dispatch('modify_energy_saving_service_info_redfish', params=modifyInfo)

351. get_sms_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    SmsInfo(dict): SMS资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sms_info_redfish')

352. import_bmc_custom_cert_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): 请求消息体

> 返回值：

    1

    certInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2
    3

    body = {"Password": pwd,"Certificate":"base64 encoded certificate"}
    body = {"Type": type, "Password": pwd,"Certificate":""}
    bmcController.dispatch('import_bmc_custom_cert_redfish', params=body)

353. get_install_license_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询安装License信息服务资源信息

    命令格式：https://device_ip/redfish/v1/Managers/1/LicenseService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     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
    30
    31
    32
    33
    34
    35
    36

    response(dict): 响应body体
    {
    "@odata.context": "/redfish/v1/$metadata#ActionInfo.ActionInfo",
    "@odata.id": "/redfish/v1/Managers/1/LicenseService/
    InstallLicenseActionInfo",
    "@odata.type": "#ActionInfo.v1_0_0.ActionInfo",
    "Id": "InstallLicenseActionInfo",
    "Name": "Install License Action Info",
    "Parameters": [
    {
    "Name": "FileSource",
    "Required": false,
    "DataType": "String",
    "AllowableValues": [
    "iBMC",
    "FusionDirector",
    "eSight"
    ]
    },
    {
    "Name": "Content",
    "Required": true,
    "DataType": "String"
    },
    {
    "Name": "Type",
    "Required": true,
    "DataType": "String",
    "AllowableValues": [
    "URI",
    "text"
    ]
    }
    ],
    "Oem": {}
    }

> 异常：

    1

    None

> 举例：

    1
    2

    self.RedfishTeam.compareBodyValue(200, expected_user_info,
    "get_install_license_info")

354. export_license_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：post方法导出iBMC License

    命令格式：https://device_ip/redfish/v1/Managers/1/LicenseService/Actions/LicenseService.exportLicense

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    body(dict):{
    "Type": "URI",
    "Content": "/tmp/license.xml"
    }

> 返回值：

    1

    response(dict): exportlicense响应体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    body = {
    "Type": "URI",
    "Content": "/tmp/license.xml"
    }
    bmcController.dispatch('export_license_redfish',params=body)

355. get_export_license_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询导出License服务资源信息

    命令格式：https://device_ip/redfish/v1/Managers/1/LicenseService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     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

    response(dict): 响应body体
    {
    "@odata.context": "/redfish/v1/$metadata#ActionInfo.ActionInfo",
    "@odata.id": "/redfish/v1/Managers/1/LicenseService/
    ExportLicenseActionInfo",
    "@odata.type": "#ActionInfo.v1_0_0.ActionInfo",
    "Id": "ExportLicenseActionInfo",
    "Name": "Export License Action Info",
    "Parameters": [
    {
    "Name": "Content",
    "Required": true,
    "DataType": "String"
    },
    {
    "Name": "Type",
    "Required": true,
    "DataType": "String",
    "AllowableValues": [
    "URI"
    ]
    }
    ],
    "Oem": {}
    }

> 异常：

    1

    None

> 举例：

    1

    self.RedfishTeam.getResponse("get_export_license_info")

356. delete_license_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：询导出License服务资源信息

    命令格式：https://device_ip/redfish/v1/Managers/1/LicenseService/Actions/LicenseService.DeleteLicense

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): deleteLicense响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('delete_license_redfish')

357. get_delete_license_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询删除License资源信息

    命令格式：https://device_ip/redfish/v1/Managers/1/LicenseService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    response  (dict):  响应body体
    Body信息:
    {
    "@odata.context": "/redfish/v1/$metadata#ActionInfo.ActionInfo",
    "@odata.id": "/redfish/v1/Managers/1/LicenseService/
    DeleteLicenseActionInfo",
    "@odata.type": "#ActionInfo.v1_0_0.ActionInfo",
    "Id": "DeleteLicenseActionInfo",
    "Name": "Delete License Action Info",
    "Parameters": [],
    "Oem": {}
    }

> 异常：

    1

    None

> 举例：

    1

    self.RedfishTeam.getResponse("get_delete_license_info")

358. get_revoke_license_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询失效License资源信息

    命令格式：https://device_ip/redfish/v1/Managers/1/LicenseService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11

    response(Bunch):  响应body体
    {
    "@odata.context": "/redfish/v1/$metadata#ActionInfo.ActionInfo",
    "@odata.id": "/redfish/v1/Managers/Blade2/LicenseService/
    RevokeLicenseActionInfo",
    "@odata.type": "#ActionInfo.v1_0_1.ActionInfo",
    "Id": "RevokeLicenseActionInfo",
    "Name": "Revoke License Action Info",
    "Parameters": [],
    "Oem": {}
    }

> 异常：

    1

    None

> 举例：

    1

    self.RedfishTeam.getResponse("get_revoke_license_info")

359. export_sp_raid_configuration_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18

    response(dict): 返回体
    response={
    "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
    {
    "@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",
    "MessageId": "Base.1.0.Success",
    "RelatedProperties": [],
    "Message": "Successfully Completed Request",
    "MessageArgs": [],
    "Severity": "OK",
    "Resolution": "None"
    }
    ]
    }
    }

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('export_sp_raid_configuration_redfish')

360. get_diagnostic_work_record
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    DiagnosticInfo(dict): 响应body体,诊断资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_diagnostic_work_record')

361. modify_diagnostic_work_record
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    param

> 返回值：

    1

    DiagnosticInfo(dict): 响应body体,诊断资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('modify_diagnostic_work_record')

362. get_diagnostic_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    DiagnosticInfo(dict): 响应body体,诊断资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_diagnostic_info')

363. set_diagnostic_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    param(dict): body体

> 返回值：

    1

    DiagnosticInfo(dict): 响应body体,诊断资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_diagnostic_info')

364. export_diagnostic_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：导出诊断相关文件

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    param(dict): serviceid 为导出节点url末尾信息【ExportBlackBox, ExportSerialPortData, DeleteScreenShot等】
    seviceInfo为body信息

> 返回值：

    1

    DiagnosticInfo(dict): 响应body体, 诊断资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('export_diagnostic_info')

365. refresh_bma_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：刷新可安装的BMA

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('refresh_bma_redfish', params=alarm)

366. set_sms_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：Sms资源属性设置

    命令格式：/redfish/v1/Managers/1/SmsService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    body(dict): 传入的请求体参数
    {
    "CdevChannelEnabled":False,
    }

> 返回值：

    1

    SmsInfo(dict): SMS资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sms_info_redfish',params=body)

367. delete_language_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口卸载语言

    命令格式：https://Managers/managers_id/Actions/Oem/Huawei/Manager.DeleteLanguage

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): {"Language":"fr"}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('delete_language_redfish')

368. set_retire_system
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口报废处置

    命令格式：Managers/managers_id/Actions/Oem/Huawei/Manager.RetireSystem

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    body(dict): {"PreserveLog": True}
    true: 保存报警、维护和故障诊断日志以供故障排除
    false: 清除所有日志文件

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('set_retire_system')

369. memory_execute_isolation
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口执行内存隔离

    命令格式：/redfish/v1/Managers/1/FPCService/Memory/Actions/Memory.ExecuteIsolation

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): {"SeuenceNums": [1,2]}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('memory_execute_isolation')

370. export_kvm_startup_file_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口导出KVM启动文件

    命令格式：https://Managers/1/KvmService/Actions/KvmService.ExportKvmStartupFile

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    body(dict): {"Type":"URI",
    "Content":"/tmp/web/kvm.jnlp", "Mode":"Shared" }

> 返回值：

    1

    response(dict):  响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('export_kvm_startup_file_redfish')

371. general_download_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口下载BMC文件

    命令格式：Managers/1/KvmService/Actions/Oem/Huawei/Manager.GeneralDownload

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    body(dict): {"Type":"URI",
    "Content":"/tmp/web/kvm.jnlp", "Mode":"Shared" }

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('general_download_redfish')

372. general_download_redfish_actions
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口下载BMC文件

    命令格式：https:///redfish/v1/Managers/{slot}/Actions/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    body(dict): {"Type":"URI",
    "Content":"/tmp/web/kvm.jnlp", "Mode":"Shared" }

> 返回值：

    1

    response(bunch):  响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('general_download_redfish')

373. power_on_permit_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口设置受控上电

    命令格式：https://Managers/1/Actions/Oem/Huawei/Manager.PowerOnPermit

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): {"PowerOnPermit":"On"}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('power_on_permit_redfish')

374. config_snmp_v3_priv_password_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：Managers/1/SnmpService/Actions/SnmpService.ConfigSnmpV3PrivPasswd

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    body(dict): {"SnmpV3AuthUser": "Administrator",
    "SnmpV3PrivPasswd": "xxxxxx"}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('config_snmp_v3_priv_password_redfish')

375. capture_screen_shot_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish进行截屏

    命令格式：https://https://device_ip/redfish/v1/Managers/managers_id/DiagnosticService/Actions/DiagnosticService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18

    response(dict): 返回体
    {
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type":
    "#Task.v1_0_2.Task",
    "@odata.id": "/redfish/v1/TaskService/Tasks/1",
    "Id": "1",
    "Name": "",
    "TaskState": "Running",
    "StartTime": "2017-05-09T16:57:14+00:00",
    "Messages": [],
    "Oem": {
    "Huawei":
    {
    "TaskPercentage": null
    }
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('capture_screen_shot_redfish')

376. revoke_license_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：post方法失效iBMC License

    命令格式：https://device_ip/redfish/v1/Managers/1/LicenseService/Actions/LicenseService.RevokeLicense

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict):要传入的参数, 正常情况下都为空。eg:{}

> 返回值：

    1

    responsebunch): revokeLicense响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('revoke_license_redfish')

377. get_bmc_dice_cert_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询SSL证书资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    sslInfo(dict): 响应body体, SSL证书资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_bmc_ssl_security_info_redfish')

378. import_bmc_dice_cert_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入DICE证书

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    body(dict): 请求消息体
    {
    "Type":"URI",
    "Certificate":  "/tmp/cert0.cer"
    }

> 返回值：

    1

    csrInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('import_bmc_dice_cert_redfish', params=body)

379. export_bmc_dice_csr_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导出DICE CSR

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    body(dict): 请求消息体
    {
    "Type":"URI",
    "Content":"/tmp/DIEC.csr"
    }

> 返回值：

    1

    csrInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('export_bmc_dice_csr_redfish', params=body)

380. export_bmc_dice_cert_chain_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导出DICE证书链

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/SecurityService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    body(dict): 请求消息体
    {
    "Type":"URI",
    "Content":"/tmp/"
    "Nonce": “0F12082A11121314”
    }

> 返回值：

    1

    csrInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('export_bmc_dice_cert_chain_redfish', params=body)

381. get_bmc_dice_cert_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取DICE证书资源信息

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/SecurityService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

> 返回值：

    1

    csrInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_bmc_dice_cert_redfish', params=body)

382. get_ibma_virtual_media_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询挂载的板载BMA分区信息

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/iBMAUSBStick

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    custom_filter(str): 虚拟设备类型

> 返回值：

    1
    2
    3
    4
    5
    6
    7

    response(dict):   响应体
    response={
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id":"/redfish/v1/TaskService/Tasks/1",
    ...
    }

> 异常：

    1

    None

> 举例：

    1

    self.bmcController.dispatch('get_virtual_media_info',params='iBMAUSBStick')

383. set_virtual_ibmausb_stick
> 描述：

    1
    2
    3
    4
    5

    方法功能：挂载或卸载板载BMA分区操作

    命令格式：https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/iBMAUSBStick

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str): 连接虚拟USB请求体

> 返回值：

    1
    2
    3
    4
    5
    6
    7

    response(dict): 响应体
    response={
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id":"/redfish/v1/TaskService/Tasks/1",
    ...
    }

> 异常：

    1

    None

> 举例：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    body = {
    "USBStickControlType":"Connect",
    "ConnectType":"Formal"
    }
    或者
    body = {
    "USBStickControlType":"Disconnect",
    "ConnectType":"Formal"
    }
    bmcController.dispatch("set_virtual_ibmausb_stick", params=body)

384. get_spu_pdateinfo
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取sp固件升级信息

    命令格式：https://redfish/v1/Managers/1/SPService/SPFWUpdate

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str): 输入的body体

> 返回值：

    1

    spupdateInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_spu_pdateinfo')

385. get_sp_os_install_parainfo
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取spos安装部署信息

    命令格式：https://redfish/v1/Managers/1/SPService/SPOSInstallPara

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str): 输入的body体

> 返回值：

    1

    spupdateInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sp_os_install_parainfo')

386. set_bmc_security_service_https_server_root_ca
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入远程HTTPS传输服务器根证书

    命令格式：https://device_ip/redfish/v1/Managers/managers_id/SecurityService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modify_info(dict): 输入的body体

> 返回值：

    1

    response(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_bmc_security_service_https_server_root_ca', importInfo=modify_info)

387. del_bmc_security_service_https_server_root_ca
> 描述：

    1
    2
    3
    4
    5

    方法功能：删除远程HTTPS传输服务器根证书

    命令格式：https://device_ip/redfish/v1/Managers/managers_id/SecurityService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modify_info(dict): 输入的body体

> 返回值：

    1

    response(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('del_bmc_security_service_https_server_root_ca', importInfo=modify_info)

388. del_bmc_https_server_certificate_crl_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：删除https证书吊销列表

    命令格式：https://device_ip/redfish/v1/Managers/managers_id/SecurityService/Actions/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modify_info(dict): 输入的body体

> 返回值：

    1

    response(Bunch): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('del_bmc_https_server_certificate_crl_redfish', importInfo=body)

389. import_bmc_security_service_https_server_crl
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入远程HTTPS传输服务器根证书的吊销列表

    命令格式：https://device_ip/redfish/v1/Managers/managers_id/SecurityService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modify_info(dict): 输入的body体

> 返回值：

    1

    response(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('import_bmc_security_service_https_server_crl', importInfo=modify_info)

390. get_specific_ethernet_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取IRM网络通道信息

    命令格式：/redfish/v1/Managers/Rack/EthernetInterfaces

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

> 返回值：

    1

    spupdateInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_specific_ethernet_info_redfish')

391. get_usb_status_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取USB设备管理信息

    命令格式：https://redfish/v1/Managers/1/USBMgmtService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_usb_status_redfish')

392. set_usb_status_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置USB设备管理信息

    命令格式：https://redfish/v1/Managers/1/USBMgmtService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    modify_info(dict): {"ServiceEnabled": true}

> 返回值：

    1

    response(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_usb_status_redfish',body=info)

393. set_update_smservice_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：升级板载BMA

    命令格式：https://xx.xx.xx.xx/redfish/redfish/v1/Managers/1/SmsService/Actions

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(str): 升级板载BMA请求的文件

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19

    response(dict): 响应体
    response={u'@odata.context': u'/redfish/v1/$metadata#TaskService/Tasks
    /Members/$entity',
    u'@odata.id': u'/redfish/v1/TaskService/Tasks/1',
    u'@odata.type': u'#Task.v1_0_2.Task',
    u'Id': u'1',
    u'Messages': [],
    u'Name': u'Upgrade Installable IBMA Task',
    u'Oem': {u'Huawei': {u'TaskPercentage': None}},
    u'StartTime': u'2021-06-15T18:36:11+00:00',
    u'TaskState': u'Running',
    'headers': {'Content-Length': '321', 'Server':
    'WebServer/1.0.0', 'Connection': 'keep-alive', 'Location':
    '/redfish/v1/TaskService/Tasks/1/Monitor', 'Cache-Control':
    'max-age=0, no-cache, no-store, must-revalidate',
    'Date': 'Tue, 15 Jun 2021 18:36:11 GMT',
    'OData-Version': '4.0', 'Content-Type':
    'application/json;charset=utf-8'},
    'status_code': 202}

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6
    7
    8

    body = {'CrlURI': 'sftp://huawei:huawei@xx.xx.xx.xx//mnt/dev_sdb/share/
    Tools/ibma/latestBMA/iBMA-Linux-xx.xx.xx.xx.tar.gz.crl',
    'ImageURI': 'sftp://huawei:huawei@xx.xx.xx.xx//mnt/dev_sdb/
    share/Tools/ibma/latestBMA/iBMA-Linux-xx.xx.xx.xx.tar.gz',
    'Mode': 'Upgrade',
    'SignatureURI': 'sftp://huawei:huawei@xx.xx.xx.xx//mnt/dev_sdb
    /share/Tools/ibma/latestBMA/iBMA-Linux-xx.xx.xx.xx.tar.gz.cms'}
    bmcController.dispatch("set_update_smservice_redfish", params=body)

394. get_import_switch_profile_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：get方法得到ImportSwitchProfileActionInfo

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params(dict): 需要查询的单板如 HMM1\HMM2lade1
    {
    "bladeId": "blade1"
    }

> 返回值：

    1

    info(dict): 响应body体, ImportSwitchProfile信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_import_switch_profile_redfish')

395. get_export_switch_profile_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：get方法得到ExportSwitchProfileActionInfo

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params(dict): 需要查询的单板如 HMM1\HMM2lade1
    {
    "bladeId": "blade1"
    }

> 返回值：

    1

    info(dict): 响应body体, ImportSwitchProfile信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_export_switch_profile_redfish')

396. get_import_configuration_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：get方法得到ImportConfigurationActionInfo

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params(dict): 需要查询的单板如 HMM1\HMM2lade1
    {
    "bladeId": "blade1"
    }

> 返回值：

    1

    info(Bunch): 响应body体, ImportConfiguration信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_import_configuration_redfish')

397. get_export_configuration_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：get方法得到ExportConfigurationActionInfo

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params(dict): 需要查询的单板如 HMM1\HMM2lade1
    {
    "bladeId": "blade1"
    }

> 返回值：

    1

    info(Bunch): 响应body体, ExportConfiguration信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_export_configuration_redfish')

398. set_bmc_smtp_root_certificate_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入smtp证书

    命令格式：https://device_ip/redfish/v1/Managers/managers_id/SmtpService/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    importinfo(dict): 输入的body体

> 返回值：

    1

    response(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1

    dispatch('set_bmc_smtp_root_certificate_redfish', params=importinfo)

399. enter_recovery_mode_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：进入最小系统

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 响应body体, 进入最小系统结果

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('enter_recovery_mode_redfish')

400. delete_ca_crl_certificate_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：删除CA证书配套的CRL吊销证书

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params: {certId: RootCertId
    body: {} body为空
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('delete_ca_crl_certificate_redfish', params=params)

401. get_redfish_version
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询当前使用的Redfish协议的版本号

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    redfishVersion(dict): 响应body体,Redfish协议的版本号

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_redfish_version')

402. get_redfish_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询当前根服务资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    info(dict):   响应body体,根服务资源

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_redfish_info')

403. get_metadata_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询Metadata文档

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    info(dict): 响应body体,Metadata文档

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_metadata_redfish')

404. get_odata_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询OData服务文档

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    info(dict): 响应body体,OData服务文档

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_odata_redfish')

405. get_registries_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询所有归档资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    info(dict): 响应body体,所有归档资源

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_registries_redfish')

406. get_one_registries_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询单个归档资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    registriesid(dict): 具体的消息归档文件id
    registriesid: 如: Base.v1_0_0(Base.v1_0_0)、iBMC.v1_0_0(iBMC.v1_0_0)、iBMCEvents.v2_8_2(iBMCEvents
    .v2_8_2)

> 返回值：

    1

    info(dict): 响应body体,单个归档资源

> 异常：

    1

    None

> 举例：

    1
    2

    id = {"Base":"Base.v1_0_0"}
    data = bmcController.dispatch('get_one_registries_redfish', params=id)

407. get_json_schemas_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询所有资源的Schema文件

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): params={"get_all": True} 是否获取所有的schema信息, 包括翻页的数据

> 返回值：

    1

    info(dict): 响应body体,所有资源的Schema文件

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_json_schemas_redfish')

408. get_system_overview_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询当前系统概览信息

    命令格式：https://device_ip/redfish/v1/SystemOverview

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    info(dict): 响应body体,根服务资源
    {
    "@odata.context": "/redfish/v1/$metadata#SystemOverview",
    "@odata.id": "/redfish/v1/SystemOverview",
    "@odata.type": "#SystemOverview.SystemOverview",
    "Managers": [
    {
    "Id": "1",
    "HostName": "huawei",
    "FirmwareVersion": "3.70",
    "UUID": "AC210476-0018-8239-B211-D21DEA377B41"
    }}

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_system_overview_info')

409. modify_public_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：PATCH方法通过redfish接口修改当前根服务资源

    命令格式：redfish/v1

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    public_info(dict): {"body": {"UUID": "ddddd1111"}}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('modify_public_info_redfish')

410. getchassisoverview_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器机箱概览信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('getchassisoverview_redfish')

411. get_ipv4_config_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：集中化查询机框IPV4信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_ipv4_config_redfish')

412. get_node_ipconfig_v4_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询机框指定单板IPV4信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    param = {'id': '1'}
    bmcController.dispatch('get_node_ipconfig_v4_redfish')

413. get_node_ipconfig_v6_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询机框指定单板IPV6信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    param = {'id': '1'}
    bmcController.dispatch('get_node_ipconfig_v6_redfish')

414. get_ipv6_config_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：集中化查询机框IPV6信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_ipv6_config_redfish')

415. get_schemas_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取shcemas信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    schema_name(str): schema的名字;, version(bool): schema版本

> 返回值：

    1
    2

    不返回版本信息-> [schemaInfo(Dir)]
    返回版本信息则-> [schemaInfo(Dir), "version"]

> 异常：

    1

    None

> 举例：

    1
    2

    {"schema_name": "NetworkAdapter"}
    {"schema_name": "NetworkAdapter", "version":True}

416. get_session_service_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前会话服务的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_session_service_redfish')

417. get_sessions_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前会话集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sessions_redfish')

418. get_session_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定会话资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    sessionId(dict): 指定会话的ID

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    sessionId = {'id':'49f627e3027fc492'}
    bmcController.dispatch('get_session_by_id_redfish', params=sessionId)

419. modify_session_service_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改会话服务信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 请求消息体的内容:设置Web会话超时时间和Web会话模式

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    params = {"SessionTimeout": 1800,"Oem": {"Huawei": {"WebSessionTimeoutMinutes": 400,
    "WebSessionMode": "Shared"}}}
    bmcController.dispatch('modify_session_service_redfish', params=params)

420. create_sessions_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：创建新会话

    命令格式：redfish/v1/SessionService/Sessions port请求

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    params(dict): 函数入参
    params = {
    "UserName": {"types": str, "optional": False}, 创建会话的用户名
    "Password": {"types": str, "optional": False}, 创建会话的密码
    "From": {"types": str, "optional": True} 可选项,值为WebUI表示创建会话时模拟web登录
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    params = { "UserName": "Administrator", "Password": "xxxxxx" }
    bmcController.dispatch('create_sessions_redfish', params=params)
    modify: /2020-12-28 补充修改测试重复属性的问题，
    重复属性需要用'''x'''，如果直接用字典检测会导致脚本失败，需加判断
    Examples:
    body =  '''{
    "UserName": "admintest",
    "Password": "xxxxxx",
    "Oem": {"Huawei":{"Domain":"it.bmctest.com","Domain":"it.bmc.com"}}}'''

421. del_session_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：删除指定会话

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    sessionId(dict): 待删除的会话ID

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    sessionId = {'id':'a818c77540e42f72'}
    bmcController.dispatch('del_session_by_id_redfish',params=sessionId)
    Modify: 适配body参数增加

422. del_all_session_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：删除所有会话

    命令格式：/redfish/v1/SessionService/Sessions

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    KPTestException("Delete session failed.")

> 举例：

    1

    bmcController.dispatch('del_all_session_redfish')

423. get_sms_update_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询iBMA升级服务相关资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 返回redfish/v1/Sms/1/UpdateService资源响应体

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    data = bmcController.dispatch('get_sms_update_info_redfish')

424. set_update_service_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：带内升级软件/固件

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    upgradeParam(dict): 指定升级URL、类型、用户名、密码、生效方式等

> 返回值：

    1

    response(dict): 返回带内升级响应体(dict)

> 异常：

    1

    None

> 举例：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    upgradeParam = {
    "ImageURI": "xx.xx.xx.xx:22/root/iBMA-Linux-xx.xx.xx.xx.tar.gz",
    "SignalURI": "xx.xx.xx.xx:22/root/iBMA-Linux-xx.xx.xx.xx.tar.gz.cms",
    "CrlURI": "xx.xx.xx.xx:22/root/iBMA-Linux-xx.xx.xx.xx.tar.gz.crl",
    "ImageType": "iBMA",
    "TransferProtocol": "SFTP",
    "User": "root",
    "Password": "xxxxxx",
    "Parameter":"-f",
    "ActiveMethod":"Immediately"
    }
    bmcController.dispatch('set_update_service_redfish', params=upgrade)

425. get_upgrade_progress_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询升级进度

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 返回升级进度响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_upgrade_progress_redfish')

426. get_software_inventory_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询iBMA升级服务软件清单相关资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1
    2
    3

    response(dict): 返回iBMA升级服务软件清单相关资源响应体
    Args:
    params(dict): 输入的body体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_software_inventory_info_redfish')

427. get_specific_software_inventory_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定iBMA升级服务软件清单相关资源实例

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    itemId(dict): 指定资源名

> 返回值：

    1

    response(dict): 返回指定iBMA升级服务软件清单相关资源

> 异常：

    1

    None

> 举例：

    1
    2

    itemId = {"name": "iBMA_Driver"}
    bmcController.dispatch('get_specific_software_inventory_info_redfish', params=itemId)

428. get_firmware_inventory_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询iBMA升级服务固件清单相关资源

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 返回升级服务固件清单相关资源

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_firmware_inventory_info_redfish')

429. get_specific_firmware_inventorys_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询指定带内升级固件资源信息

    命令格式：/redfish/v1/Sms/1/UpdateService/FirmwareInventory/Nic_0000:18:03.0_0000:19:00.0

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    itemId(dict): 指定资源名

> 返回值：

    1

    response(dict): 返回指定带内升级固件资源信息(dict)

> 异常：

    1

    None

> 举例：

    1
    2

    itemId = {"name": "Nic_0000"}
    bmcController.dispatch('get_specific_firmware_inventorys_info_redfish', params=itemId)

430. set_asynchronous_update_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：异步升级操作

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    AsynchronousUpdateBody(dict):   请求body体

> 返回值：

    1
    2
    3
    4
    5
    6

    response(dict): 异步升级响应体
    {
    "status": 200,
    "message": "A task is created.",
    "TaskId": "1001"
    }

> 异常：

    1

    None

> 举例：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15

    AsynchronousUpdateBody = {
    "Name":"",
    "ImageURI": "xx.xx.xx.xx:22/root/iBMA-Linux-xx.xx.xx.xx.tar.gz",
    "SignalURI": "xx.xx.xx.xx:22/root/iBMA-Linux-xx.xx.xx.xx.tar.gz.cms",
    "CrlURI": "xx.xx.xx.xx:22/root/iBMA-Linux-xx.xx.xx.xx.tar.gz.crl",
    "ImageType": "iBMA",
    "TransferProtocol": "SFTP",
    "User": "root",
    "Password": "xxxxxx",
    "Parameter": "NA",
    "ActiveMethod": "Immediately",
    "DownloadViaiBMC": False,
    "AllowStop": False
    }
    bmcController.dispatch('set_asynchronous_update_redfish',params=AsynchronousUpdateBody)

431. set_effective_update_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：异步生效

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    effectBody(dict): 请求body体, 指定文件路径、用户名、密码等

> 返回值：

    1

    response(dict): 异步生效响应body体, 返回任务id和messages

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6

    effectBody = {
    "ImageType":"Driver",
    "ActiveMethod":"OSRestart",
    "Parameter":"NA"
    }
    bmcController.dispatch('set_effective_update_redfish',params=effectBody)

432. set_upload_file_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：文件上传操作

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    uploadFileBody(dict): 请求body体, 指定文件路径、用户名、密码等

> 返回值：

    1
    2
    3
    4

    response(dict): 文件上传响应体, 返回任务id
    [{u'TaskId': u'7007',
    u'message': u'Upload file has started, please wait.',
    u'status': 200}]

> 异常：

    1

    None

> 举例：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    uploadFileBody = {
    "ImageURI": "xx.xx.xx.xx:22/opt/huawei/ibma/bin/base_library.zip",
    "ChecksumType": "SHA256",
    "ChecksumData": "e5b844cc57f57094ea4585e235f36c78c1cd222262bb89d53c94dcb4d6b3e55d",
    "TransferProtocol": "SFTP",
    "User": "Administrator",
    "Password": "xxxxxx",
    "DownloadViaiBMC": False
    }
    bmcController.dispatch('set_upload_file_redfish', params=uploadFileBody)

433. get_sms_task_serivice_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前任务服务资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

> 返回值：

    1

    response(dict): 返回当前任务服务资源的信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sms_task_serivice_redfish')

434. get_sms_tasks_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前任务集合资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 返回当前任务集合资源的信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sms_tasks_redfish')

435. get_sms_specific_task_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定任务资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    taskId(dict): 指定的任务id

> 返回值：

    1

    response(dict): 指定任务资源的信息

> 异常：

    1

    None

> 举例：

    1
    2

    taskId={'task_id':'7005'}
    bmcController.dispatch('get_sms_specific_task_redfish', params=taskId)

436. get_software_inventory_ibma_driver_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询/redfish/v1/Sms/1/UpdateService/SoftwareInventory/iBMA_Driver资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict):返回iBMA_Driver资源信息响应体

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('getBMASoftwareInfoRedfish')

437. get_software_inventory_ibma_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询/redfish/v1/Sms/1/UpdateService/SoftwareInventory/iBMA资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回iBMA资源信息响应体
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('getBMASoftwareInfoRedfish')

438. get_managers_bma_service_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器管理资源iBMA资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_managers_bma_service_info')

439. get_bma_systems_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取Systems资源。

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    result = bmcController.dispatch('get_bma_systems_info')

440. get_sms_storage_controllers_info
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：查询/redfish/v1/Sms/1/Systems/1/Storage/1/StorageControllers/bdf资源信息
        命令功能: /redfish/v1/Sms/1/Systems/1/Storage/1/StorageControllers/bdf

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回iBMA资源信息响应体
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_sms_storage_controllers_info')

441. get_sms_drives_info
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：查询/redfish/v1/Sms/1/Systems/1/Storage/1/Drives/RAID_0000:17:02.0_0000:1c:00.0-Enclosure1_Slot0资源信息
        命令功能: /redfish/v1/Sms/1/Systems/1/Storage/1/Drives/RAID_0000:17:02.0_0000:1c:00.0-Enclosure1_Slot0

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回iBMA资源信息响应体
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_sms_drives_info')

442. set_sms_collect_log
> 描述：

    1
    2
    3
    4
    5

    方法功能：BMA日志收集

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): 请求消息体

> 返回值：

    1

    certInfo(dict): 响应body体

> 异常：

    1

    None

> 举例：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11

    params = {
    "Type":"iBMA",
    "TargetDevice":"xx.xx.xx.xx",
    "MaxLogSizeMib": -1,
    "Protocol": "SFTP",
    "Port": 40443,
    "User":root,
    "Password":xxxxxx,
    "LogPath": null
    }
    bmcController.dispatch('set_sms_collect_log', params=body)

443. get_sms_summary_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查看Summary资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    body(dict): 请求消息体

> 返回值：

    1

> 异常：

    1

    None

> 举例：

    1
    2

    params = None
    bmcController.dispatch('get_sms_summary_info')

444. get_gpus
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询GPU卡资源信息列表: /redfish/v1/Sms/1/Systems/1/GPUs

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回资源利用率信息响应体
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_gpus')

445. get_npus
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询NPU卡资源信息列表: /redfish/v1/Sms/1/Systems/1/NPUs

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回NPU卡资源信息列表
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_npus')

446. get_sms_volumes_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询/redfish/v1/Sms/1/Systems/1/Storage/1//Volumes/RAID_0000:17:02.0_0000:1b:00.0_Volume**资源信息

    命令格式：/redfish/v1/Sms/1/Systems/1/Storage/1//Volumes/RAID_0000:17:02.0_0000:1b:00.0_Volume**

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回sms逻辑盘资源信息响应体
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_sms_drives_info')

447. get_sms_ethernet_interfaces_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询/redfish/v1/Sms/1/Systems/1/EthernetInterfaces资源信息

    命令格式：/redfish/v1/Sms/1/Systems/1/EthernetInterfaces

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回sms以太网资源信息
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_sms_ethernet_interfaces_info')

448. get_sms_infini_bands_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询/redfish/v1/Sms/1/Systems/1/InfiniBands资源信息

    命令格式：/redfish/v1/Sms/1/Systems/1/InfiniBands

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回sms IB资源信息
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_sms_infini_bands_info')

449. get_sms_storage_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询/redfish/v1/Sms/1/Systems/1/Storage/1/资源信息

    命令格式：/redfish/v1/Sms/1/Systems/1/Storage/1/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回iBMA资源信息响应体
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_sms_storage_info')

450. get_sms_fc_controllers_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询/redfish/v1/Sms/1/Systems/1/Storage/1/FC/bdf资源信息

    命令格式：/redfish/v1/Sms/1/Systems/1/Storage/1/FC/bdf

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1
    2
    3

    response(dict): 返回iBMA资源信息响应体
    Raises
    None

> 异常：

    1

> 举例：

    1

    bmcController.dispatch('get_sms_fc_controllers_info')

451. get_asynchronous_upgrade_specific_task_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：根据任务ID查询异步升级任务信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params={'Id':'4003'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4

    self.serverDevice = self.resource.getDevice(deviceType="server", deviceId='1')
    bmcController = self.serverDevice.getController("B1")
    params={'Id':'4003'}
    bmcController.dispatch('get_asynchronous_upgrade_specific_task_info', params)

452. get_asynchronous_upgrade_task_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取所有任务信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 返回所有任务信息列表

> 异常：

    1

    None

> 举例：

    1
    2
    3

    self.serverDevice = self.resource.getDevice(deviceType="server", deviceId='1')
    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_asynchronous_upgrade_task_info')

453. get_boot_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取Boot信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_boot_info', params=params)

454. get_sys_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取sys信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_sys_info', params=params)

455. get_trust_module_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取trust模块信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_trust_module_info', params=params)

456. get_systems_info_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前系统集合资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    system(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch("get_systems_info_collection_redfish")

457. get_specific_systems_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前系统指定资源的信息

    命令格式：https://xx.xx.xx.xx/redfish/v1/Systems/1

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    param(Dict): 待查询的bladeId。eg:
    param = {'bladeId': 'HMM1'}   param = {'bladeId': '1'}   param = {'bladeId':
    'blade1'}

> 返回值：

    1
    2
    3
    4
    5

    info(list): 返回体
    eg: info = [{u'@odata.context': u'/redfish/v1/$metadata#Systems/Members/$entity',
    u'@odata.id': u'/redfish/v1/Systems/1',
    u'@odata.type': u'#ComputerSystem.v1_2_0.ComputerSystem',
    ......}]

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch("get_specific_systems_info_redfish")
    eg:
    param = {"bladeId": 'HMM1'}
    hmmController.dispatch("get_specific_systems_info_redfish", params)

458. modify_systems_specific_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改指定系统资源属性

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    resourceAttri(Dict): resourceAttri: 要修改的系统资源属性。eg: resourceAttri = {"AssetTag": "my test"}
    bladeId : 系统资源的ID.eg:{'bladeId':'hmm1'}or{'bladeId':'1'}or{
    'bladeId': 'blade1'}

> 返回值：

    1

    response(list): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    bmcController = self.serverDevice.getController("B1")
    body = {'bladeId':'hmm1',
    'resourceAttri':{"AssetTag": "my test"}}
    or body = {"AssetTag": "my test"}
    bmcController.dispatch("modify_systems_specific_info_redfish",params=body)

459. set_systems_reset_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：重启服务器

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    rstType          (Dict):   上下电的类型。eg: rsttype = {"ResetType":"On" }

> 返回值：

    1

    response        (Bunch):   命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    body = {"ResetType": "On"}
    bmcController.dispatch("set_systems_reset_redfish", params= body)

460. set_systems_fru_control_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：控制FRU上下电状态

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    body(dict):请求的消息体, 包括下面两部分。eg: body = {"FruControlType": 'On',
    "fruID": 0
    }
    ischeck(bool): 是否检验，不校验则返回原始信息

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    bmcController = self.serverDevice.getController("B1")
    body = {"fruControlType": 'On',
    "fruID": 0
    }
    bmcController.dispatch("postSystemsFruControlRedFish", params= body)

461. get_systems_ethernet_interfaces_collection_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器主机以太网集合资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_systems_ethernet_interfaces_collection_info_redfish')

462. get_systems_ethernet_interfaces_info_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定主机以太网接口资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    ethernetInfo(dict): 待查询的ethernetInterfacesId。eg:
    ethernetInfo = {'ethernetId':
    'mainboardLOMPort1'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    ethernetInfo = {'ethernetId': 'mainboardLOMPort1'}
    bmcController.dispatch("get_systems_ethernet_interfaces_info_by_id_redfish", params=ethernetInfo)

463. get_systems_vlans_info_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询VLANs集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    resourceAttribute(dict): 待查询的ethernetInterfacesId。eg:
    resourceAttribute = {'ethernetId':
    'mainboardLOMPort1'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    ethernetInfo = {'ethernetId': 'mainboardLOMPort1'}
    bmcController.dispatch("get_systems_vlans_info_collection_redfish",params= ethernetInfo)

464. get_systems_vlans_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询VLAN资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    resourceAttribute(dict): 待查询的ethernetInterfacesId。eg:
    resourceAttribute = {'ethernetId':
    'mainboardLOMPort1'
    'vlansId': '20'
    }

> 返回值：

    1

    res(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5

    bmcController = self.serverDevice.getController("B1")
    logAttInfo = {'ethernetId': 'mainboardLOMPort1',
    'vlansId': '20'
    }
    bmcController.dispatch("get_systems_vlans_info_redfish", params=logAttInfo)

465. delete_specific_vlan_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：DELETE方法通过redfish接口删除指定Vlans资源信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/EthernetInterfaces/ethernetinterface_id/VLANs

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 待查询的 vlanId。eg:
    params = {'ethernetId': 'mainboardLOMPort1', 'vlansId': '20'}

> 返回值：

    1

    response(dict): VLANs 信息

> 异常：

    1

    None

> 举例：

    1
    2

    vlanInfo = {'ethernetId': 'mainboardLOMPort1', 'vlansId': '20'}
    bmcController.dispatch('deleteSpecificVlansInfo', params=vlanInfo)

466. get_systems_network_interfaces_info_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前网络接口集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_systems_network_interfaces_info_collection_redfish')

467. get_systems_network_interfaces_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定网络接口资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    resourceAttribute(dict): 待查询的 networkInterfaceId。eg:
    resourceAttribute = {'networkInterfaceId': 'mainboardLOM'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    logAttInfo = {'NetworkInterfaceid': 'mainboardLOM'}
    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_systems_network_interfaces_info_redfish', params=logAttInfo)

468. get_systems_network_port_info_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前网络端口集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    resourceAttribute(dict): 待查询的 networkInterfaceId。eg:
    resourceAttribute = {'networkInterfaceId': 'mainboardLOM'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    logAttInfo = {'networkInterfaceId': 'mainboardLOM'}
    bmcController.dispatch("get_systems_network_port_info_collection_redfish", params=logAttInfo)

469. get_ethernet_interfaces
> 描述：

    1
    2
    3
    4
    5

    方法功能：从systems获取所有的网络端口数

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_ethernet_interfaces', params=params)

470. get_ib_ethernet_interfaces
> 描述：

    1
    2
    3
    4
    5

    方法功能：从systems获取ib卡的信息

    命令格式：redfish/v1/Systems/1/InfiniBandInterfaces

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    命令返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch("get_systems_network_port_info_collection_redfish"}

471. get_memory_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前内存集合资源中內存資源節點。

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Memory

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    systemsId(dict): {"id":systemsId, "isList": False}
    isList:返回是否是集合資源ID列表
    值为False时返回response

> 返回值：

    1
    2

    mainboareIdList(list): 內存集合資源ID列表
    response内存集合资源响应体

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController.dispatch('get_memory_collection_redfish',
    {"id":systemsId})

472. get_memory_view_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：批量查询内存资源信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/MemoryView

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    systemsId(dict): {"id":systemsId}

> 返回值：

    1

    MemoryViewInfo(dict): 内存资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_memory_view_info_redfish', {"id":systemsId})

473. get_storages_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取存储信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_storages_info', params=params)

474. get_bios_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前BIOS资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_bios_info', params={"timeout":120})

475. unify_para
> 描述：

    1
    2
    3
    4
    5

    方法功能：BIOS参数大小写修正

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): 要修改的BiosSettings属性。eg: params = {"BootType": "UEFIBoot",
    "PXEBootToLanUEFI": "Enabled"
    }

> 返回值：

    1

    uparams(dict): 修正后的参数字典

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('unify_para', params={'QuickBoot': 'Enabled'})

476. set_bios_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改Bios设置资源的属性

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    params(dict): 要修改的BiosSettings属性。eg: params = {"BootType": "UEFIBoot",
    "PXEBootToLanUEFI": "Enabled"
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('set_bios_info', params={'QuickBoot': 'Enabled'})

477. get_bios_strategy_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询bios策略重配文件当前状态

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_bios_strategy_redfish')

478. get_bios_strategy_reconfigure_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询bios策略重配文件设置属性内容

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_bios_strategy_reconfigure_redfish')

479. set_bios_strategy_reconfigure_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置bios策略重配文件属性

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14

    body(dict): 要传入的参数。eg:
    {
    "Attributes":{
    "RefreshRate":0,
    "PdEn":0,
    "PdPrd":256,
    "Demt":1,
    "Funnel":1,
    "PsFunnel":1,
    "CEth":6000,
    "PSEn":1,
    "UnitTime": 43
    }
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('set_bios_strategy_reconfigure_redfish')

480. get_bios_boot_certificate_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前BIOS证书信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_bios_boot_certificate_info')

481. import_bios_http_boot_cert
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入BIOS HTTP启动证书

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    body(dict):要传入的参数。eg:
    {
    "CertificateString":"-----BEGIN CERTIFICATE-----XXXXXX-----END CERTIFICATE-----",
    "CertificateType":"PEM"
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('import_bios_http_boot_cert')

482. import_bios_secure_boot_cert
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入BIOS安全启动证书

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    params(dict): 要传入的参数。eg:
    {
    "Database":"db",
    "CertificateString":"-----BEGIN CERTIFICATE-----XXXXXX-----END CERTIFICATE-----",
    "CertificateType":"PEM"
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('importBootCert')

483. import_bios_boot_crl
> 描述：

    1
    2
    3
    4
    5

    方法功能：导入BIOS证书吊销列表

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    body(dict): 要传入的参数。eg:
    {
    "CertificateString":"-----BEGIN X509 CRL -----XXXXXX-----END X509 CRL -----"
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('import_bios_boot_crl')

484. reset_bios_http_boot_cert
> 描述：

    1
    2
    3
    4
    5

    方法功能：重置BIOS HTTP启动证书

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    body(dict): 要传入的参数。eg:
    {
    "ResetKeysType":"DeleteAllKeys"
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('reset_bios_http_boot_cert')

485. reset_bios_secure_boot_cert
> 描述：

    1
    2
    3
    4
    5

    方法功能：重置BIOS 安全启动证书

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    body(dict): 要传入的参数。eg:
    {
    "Database":"dbx",
    "ResetKeysType":"DeleteAllKeys"
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('reset_bios_secure_boot_cert')

486. delete_bios_boot_crl
> 描述：

    1
    2
    3
    4
    5

    方法功能：重置BIOS证书吊销列表

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    body(dict): 要传入的参数。eg:
    {
    "ResetKeysType":"DeleteAllKeys"
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('delete_bios_boot_crl')

487. get_systems_bios_settings_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前Bios设置资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_systems_bios_settings_info_redfish')

488. restore_bios_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：恢复BIOS属性默认值

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    ischeck(bool): 是否检验,不校验则返回原始信息。eg:False
    body(dict): 要传入的参数,正常情况下都为空。eg:params
    system_id(str): 适配HPC机型

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('restore_bios_info_redfish')

489. reset_bios_password_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：重置bios的密码

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    body(dict): 要传入的参数。eg:{
    "NewPassword":"NewPasswordText",
    "OldPassword":"OldPasswordText",
    "PasswordName":"Supervisor"
    }

> 返回值：

    1

    response        (Bunch):   命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('reset_bios_password_redfish')

490. clear_systems_unenforced_bios_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：清除未生效的Bios配置

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    ischeck(boolean): 是否检验，不校验则返回原始信息 eg: False
    body(dict): 要传入的参数，正常情况下都为空

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('clear_systems_unenforced_bios_info_redfish')

491. get_mem_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取内存信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_mem_info', params=params)

492. get_memory_info_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定内存资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    memoryId(dict): 要修改内存的memoryId。eg:{'memoryId':'DIMM000'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    body = {"memoryId": "DIMM030"}
    bmcController.dispatch("get_memory_info_by_id_redfish", params = body)

493. get_memory_metrics_info_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定内存下风暴抑制FRU统计

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    memoryId(dict): 要查询内存的memoryId。eg:{'memoryId':'DIMM000'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    self.bmc_controller = self.server_device.getActiveBmcController()
    body = {"memoryId": "DIMM030"}
    bmcController.dispatch("get_memory_metrics_info_by_id_redfish", params = body)

494. get_systems_log_services_info_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前日志服务集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_systems_log_services_info_collection_redfish')

495. get_log_services_info_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前日志服务资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    resourceAttribute(dict): 待查询的logId。eg: resourceAttribute = {'logId': 'Log1'}

> 返回值：

    1

    response(dict): 命令的返回值。

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    logAttInfo = {'logId': 'Log1'}
    bmcController.dispatch("get_log_services_info_by_id_redfish", params=logAttInfo)

496. modify_systems_log_services_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改服务器指定日志服务资源的属性

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    resourceAttribute(dict): 待查询的logId。eg: resourceAttribute = {{'logId': 'Log1'},
    'logAttr': {
    "DateTimeLocalOffset": "+00:00"}
    }

> 返回值：

    1

    response(dict): 命令的返回值。

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    logAttInfo = {'logId': 'Log1','logAttr': {"DateTimeLocalOffset": "+00:00"}}
    bmcController.dispatch("modify_systems_log_services_redfish", params=logAttInfo)

497. clear_systems_log_services_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：清空日志信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    resourceAttribute(dict): 待查询的logId。resourceAttribute = {"logId": "Log1",
    "logbody":params}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    logAttInfo = {'logId': 'Log1'}
    bmcController.dispatch("clear_systems_log_services_info_redfish", params=logAttInfo)

498. get_systems_log_service_entry_info_collection_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前日志集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    resourceAttribute(dict): 待查询的logId。eg: resourceAttribute = {'logId': 'Log1'}

> 返回值：

    1

    response(dict):  命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    logAttInfo = {'logId': 'Log1'}
    bmcController.dispatch("get_systems_log_service_entry_info_collection_redfish", params=logAttInfo)

499. get_systems_log_service_entry_info_dict_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前日志集合资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    resourceAttribute(dict): 待查询的logId。eg: resourceAttribute = {'logId': 'Log1'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    logAttInfo = {'logId': 'Log1'}
    bmcController.dispatch("get_systems_log_service_entry_info_dict_redfish", params=logAttInfo)

500. get_processors_history_usage_rate
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询CPU历史占用率

    命令格式：redfish/v1/Systems/system_id/ProcessorsHistoryUsageRate

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19

    response(dict): dict
    { 0 : resdict(dict)}
    resdict :
    {
    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/ProcessorsHistoryUsageRate
    /$entity",
    "@odata.id": "/redfish/v1/Systems/1/ProcessorsHistoryUsageRate",
    ...
    "Data": [
    {
    "Time": "2018/07/23 15:38:06",
    "CpuUtilisePercents": 66
    },
    {
    "Time": "2018/07/23 15:39:07",
    "CpuUtilisePercents": 84
    }
    ]
    }

> 异常：

    1

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch("get_processors_history_usage_rate")

501. get_memory_history_usage_rate
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询内存历史占用率

    命令格式：redfish/v1/Systems/system_id/MemoryHistoryUsageRate

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18

    response(dict): dict
    { 0 : resdict(dict)}
    resdict :
    {
    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/MemoryHistoryUsageRate/$entity",
    "@odata.id": "/redfish/v1/Systems/1/MemoryHistoryUsageRate",
    ...
    "Data": [
    {
    "Time": "2018/07/23 15:38:06",
    "MemOSUtilisePercents": 7
    },
    {
    "Time": "2018/07/23 15:39:06",
    "MemOSUtilisePercents": 7
    }
    ]
    }

> 异常：

    1

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch("get_memory_history_usage_rate")

502. get_network_history_usage_rate
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询网络历史占用率

    命令格式：redfish/v1/Systems/system_id/NetworkHistoryUsageRate

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

     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

    response(dict): dict
    { 0 : resdict(dict)}
    resdict :
    {
    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/NetworkHistoryUsageRate/$entity",
    "@odata.id": "/redfish/v1/Systems/1/NetworkHistoryUsageRate",
    ...
    "Data": [
    {
    "BWUWaveTitle": "NIC1 - SM210(4*GE)",
    "UtilisePercents": [
    {
    "Time": "2018/07/23 15:38:06",
    "Port1UtilisePercents": 0,
    "Port2UtilisePercents": 0,
    "Port3UtilisePercents": 0,
    "Port4UtilisePercents": 0
    },
    {
    "Time": "2018/07/23 15:39:07",
    "Port1UtilisePercents": 0,
    "Port2UtilisePercents": 0,
    "Port3UtilisePercents": 0,
    "Port4UtilisePercents": 0
    }
    ]
    }
    ]
    }

> 异常：

    1

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch("get_network_history_usage_rate")

503. get_log_service_entry_info_by_id_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前日志资源信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    resourceAttribute(dict): 待查询的logId以及entryId。eg: resourceAttribute = {'logId': 'Log1',
    'entryId': '1'
    }

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    bmcController = self.serverDevice.getController("B1")
    logAttInfo = {'logId': 'Log1','entryId': '1'}
    bmcController.dispatch("get_log_service_entry_info_by_id_redfish", params=logAttInfo)

504. get_cpu_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取cpu信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_cpu_info', params=params)

505. get_product_alias
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取产品别名

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_product_alias', params=params)

506. get_power_on_strategy_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取通电开机策略

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(str): TurnOn,StayOff,RestorePreviousState

> 异常：

    1

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("get_power_on_strategy_redfish")

507. set_power_on_strategy_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置通电开机策略

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入参数

> 返回值：

    1

    response(list): response of patch method

> 异常：

    1

> 举例：

    1
    2
    3

    params={"Oem": {"Huawei": {"PowerOnStrategy": "TurnOn"}}}
    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("get_power_on_strategy_redfish",params)

508. get_panel_power_staus_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取屏蔽面板电源状态

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入参数

> 返回值：

    1

    response(bool): true/false

> 异常：

    1

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("get_panel_power_staus_redfish")

509. set_panel_power_staus_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置屏蔽面板电源状态

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入参数

> 返回值：

    1

    response(list): response of patch method

> 异常：

    1

> 举例：

    1
    2
    3

    params={"Oem": {"Huawei": {"PanelPowerButtonEnabled ": "Enabled"}}}
    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("set_panel_power_staus_redfish",params)

510. get_kvm_enabled_status_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取本地KVM使能状态

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(bool): true/false

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("get_kvm_enabled_status_redfish")

511. set_kvm_enabled_status_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置本地KVM使能状态

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入的body体

> 返回值：

    1

    response(dict): response of patch method

> 异常：

    1

> 举例：

    1
    2
    3

    params={"Oem": {"Huawei": {"LocalKvmEnabled ": true}}}
    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("set_kvm_enabled_status_redfish",params)

512. get_cpu_threshold_percent_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取CPU使用率门限

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入的body体

> 返回值：

    1

    response(int): 0~100

> 异常：

    1

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("get_cpu_threshold_percent_redfish")

513. set_cpu_threshold_percent_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置CPU使用率门限

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入的body体

> 返回值：

    1

    response(list): response of patch method

> 异常：

    1

> 举例：

    1
    2
    3

    params={"Oem": {"Huawei": {"CPUThresholdPercent ": 80}}}
    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("set_cpu_threshold_percent",params)

514. get_memory_threshold_percent_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取内存使用率门限

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入的body体

> 返回值：

    1

    response(int): 0~100

> 异常：

    1

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("get_memory_threshold_percent_redfish")

515. set_memory_threshold_percent_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置内存使用率门限

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入的body体

> 返回值：

    1

    response(list): response of patch method

> 异常：

    1

> 举例：

    1
    2
    3

    params={"Oem": {"Huawei": {"MemoryThresholdPercent ": 80}}}
    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("set_memory_threshold_percent_redfish",params)

516. set_hard_disk_threshold_percent_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置磁盘使用率门限

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入的body体

> 返回值：

    1

    response(list): response of patch method

> 异常：

    1

> 举例：

    1
    2
    3

    params={"Oem": {"Huawei": {"HardDiskThresholdPercent ": 80}}}
    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("set_hard_disk_threshold_percent_redfish",params)

517. get_hard_disk_threshold_percent_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取磁盘使用率门限

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入的body体

> 返回值：

    1

    response(int): 0~100

> 异常：

    1

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("get_hard_disk_threshold_percent_redfish")

518. set_os_reset_type_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置OS上下电类型

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入的body体

> 返回值：

    1

    response(list): response of patch method

> 异常：

    1

> 举例：

    1
    2

    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("get_cpu_threshold_percent_redfish")

519. set_system_root_directory_attribute_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置系统根目录属性

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(str or dict): 输入的body体

> 返回值：

    1

    response(list): response of patch method

> 异常：

    1

> 举例：

    1
    2
    3

    params={"Oem": {"Huawei": {"MemoryThresholdPercent ": 80}}}
    bmcController = self.serverDevice.getController("B1")
    rsp = bmcController.dispatch("set_system_root_directory_attribute_redfish",params)

520. get_frame_mgt_slot_number_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：从redfish获取设备的slotNumber

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): slotNumber

> 异常：

    1

    None

> 举例：

    1
    2

    host = self.getDispatcher()
    slotNumber = host.dispatch('get_frame_mgt_slot_number_redfish')

521. get_frame_mgt_slot_width_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：从redfish获取设备的slotWidth

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): slotWidth

> 异常：

    1

    None

> 举例：

    1
    2

    host = self.getDispatcher()
    slotWidth = host.dispatch('get_frame_mgt_slot_width_redfish', params)

522. get_pch_model
> 描述：

    1
    2
    3
    4
    5

    方法功能：从redfish获取PCH规格

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入的body体

> 返回值：

    1

    response(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    pchmodel = host.dispatch('get_pch_model', params)

523. get_mainboard_raid_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取mainboard RAID Card信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_mainboard_raid_info', params=params)

524. get_storages_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：GET方法通过redfish获取存储控制器信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Storages

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    None: 获取所有存储控制器信息
    params = {"storage_id": "all"}    获取存储控制器集合资源信息
    params = {"storage_id": "RAIDStorage0"}   获取指定存储控制器信息

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13

    获取所有存储控制器信息时返回一个字典
    storage_info           (dict):   存储控制器信息
    {u'RAIDStorage0': {u'@odata.context':
    u'/redfish/v1/$metadata#Systems/Members/1/Storages/Members/$entity',
    u'@odata.id': u'/redfish/v1/Systems/1/Storages/RAIDStorage0',
    u'@odata.type': u'#Storage.v1_7_0.Storage',
    u'Actions': {u'Oem': {u'Huawei':
    {u'#Storage.RestoreStorageControllerDefaultSettings':
    '......'}
    }
    }
    }
    获取指定存储控制器信息和获取存储控制器集合资源信息时直接返回响应值

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('get_storages_info_redfish', params=params)

525. modify_specific_storage
> 描述：

    1
    2
    3
    4
    5

    方法功能：PATCH方法通过redfish接口修改指定存储控制器信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16

    modify_info(dict): 请求参数
    {
    'storage_id' : 'RAIDStorage1'           (str) 指定控制器ID
    'body': {                               (dict)请求体
    "StorageControllers":[
    {
    "Oem": {
    "Huawei": {
    "CopyBackState": false,
    "SmarterCopyBackState": false,
    "JBODState": false
    }
    }
    }
    ]
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    response(dict): 返回体
    response={
    ......
    "SpeedGbps": 12,
    "FirmwareVersion": "4.270.00-4382",
    "SupportedDeviceProtocols": [
    "SAS"
    ],
    "Manufacturer":"Huawei",
    "Model": "SAS3108",
    ......
    }

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('modify_specific_storage',params=modify_info)

526. restore_specific_storage
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口恢复指定存储控制器的默认配置

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    modify_info(dict):请求参数
    {
    'storage_id' : 'RAIDStorage1'           (str) 指定控制器ID
    'body': {}                               (dict)请求体
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14

    response(dict): 返回体
    response={
    "@Message.ExtendedInfo": [
    {
    "@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",
    "MessageId": "Base.1.0.Success",
    "RelatedProperties": [],
    "Message": "Successfully Completed Request",
    "MessageArgs": [],
    "Severity": "OK",
    "Resolution": "None"
    }
    ]
    }

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('restore_specific_storage',params=modify_info)

527. get_system_ethernet_interfaces
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取业务系统网口信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): {'card_name': 'mainboardLOM'}

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_system_ethernet_interfaces', params=params)

528. get_logical_drives
> 描述：

    1
    2
    3
    4
    5

    方法功能：通过redfish接口获取逻辑磁盘信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    logical_drives(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('get_logical_drives')

529. create_logical_drive_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口创建逻辑磁盘

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    params(dict): 请求参数
    {
    'storage_id' : 'RAIDStorage1'           (str) 指定控制器ID
    'body': {                               (dict)请求体
    "Oem":{
    "Huawei":{
    "Drives":[1,2],
    "VolumeRaidLevel":"RAID0"
    }
    }
    }
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16

    response(dict): 返回体
    response={
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id": "/redfish/v1/TaskService/Tasks/1",
    "Id": "1",
    "Name": "volume creation task",
    "TaskState": "Running",
    "StartTime": "2017-01-06T12:57+00:00",
    "Messages": [],
    "Oem": {
    "Huawei": {
    "TaskPercentage": null
    }
    }
    }

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('create_logical_drive_redfish',params=create_info)

530. modify_specific_logical_drive
> 描述：

    1
    2
    3
    4
    5

    方法功能：PATCH方法通过redfish接口修改指定逻辑磁盘信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13

    modify_info(dict): 请求参数
    {
    'storage_id' : 'RAIDStorage1'           (str) 指定控制器ID
    'drive_id'   : 'LogicalDrive1'          (str) 指定逻辑磁盘ID
    'body': {
    "Oem": {
    "Huawei": {
    "BootEnable": true,
    "BGIEnable": false
    }
    }
    }
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16

    response(dict): 返回体
    response={
    ......
    "CurrentReadPolicy": "ReadAhead",
    "CurrentWritePolicy": "WriteBackWithBBU",
    "CurrentCachePolicy": "DirectIO",
    "AccessPolicy": "ReadWrite",
    "BootEnable": true,
    "BGIEnable": false,
    "SSDCachecadeVolume": false,
    "SSDCachingEnable": null,
    "AssociatedCacheCadeVolume": [],
    "DriveCachePolicy": "Unchanged",
    "OSDriveName": "/dev/sdb"
    ......
    }

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('modify_specific_logical_drive',params=modify_info)

531. delete_specific_logical_drive
> 描述：

    1
    2
    3
    4
    5

    方法功能：DELETE方法通过redfish接口删除指定逻辑磁盘

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    delete_info(dict): 请求参数
    {
    'storage_id' : 'RAIDStorage1'           (str) 指定控制器ID
    'drive_id'   : 'LogicalDrive1'          (str) 指定逻辑磁盘ID
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16

    response             (bunch):   返回体
    response={
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id": "/redfish/v1/TaskService/Tasks/1",
    "Id": "1",
    "Name": "volume deletion task",
    "TaskState": "Running",
    "StartTime": "2016-07-08T14:52+00:00",
    "Messages": [],
    "Oem": {
    "Huawei": {
    "TaskPercentage": null
    }
    }
    }

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('delete_specific_logical_drive',params=delete_info)

532. initialize_specific_logical_drive_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口初始化指定逻辑磁盘

    命令格式：https://device_ip/redfish/v1/systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0/Actions

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    init_info  (dict):请求参数
    {
    'storage_id' : 'RAIDStorage1'           (str) 指定控制器ID
    'drive_id'   : 'LogicalDrive1'          (str) 指定逻辑磁盘ID
    'body'       : { 'Type': init_type}
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18

    response             (bunch):   返回体
    response={
    "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
    {
    "@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",
    "MessageId": "Base.1.0.Success",
    "RelatedProperties": [],
    "Message": "Successfully Completed Request",
    "MessageArgs": [],
    "Severity": "OK",
    "Resolution": "None"
    }
    ]
    }
    }

> 异常：

    1

    None

> 举例：

    1
    2

    info={'storage_id': 'RAIDStorage0','drive_id': 'LogicalDrive1','body': {'Type': 'QuickInit'}}
    self.server.dispatch('initializeSpecificLogicalDrive',params=init_info)

533. get_specific_logical_drive_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：GET方法通过redfish接口获取指定逻辑磁盘信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    ld_info(dict): 请求参数
    {
    'storage_id' : 'RAIDStorage1'           (str) 指定控制器ID
    'drive_id'   : 'LogicalDrive1'          (str) 指定逻辑磁盘ID
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14

    response(dict): 返回体
    response={ "Oem": {
    "Huawei": {
    "State":"Optimal",
    "VolumeName": "N/A",
    "RaidControllerID": 0,
    "VolumeRaidLevel": "RAID1",
    "DefaultReadPolicy": "ReadAhead",
    "DefaultWritePolicy": "WriteBackWithBBU",
    "DefaultCachePolicy": "DirectIO",
    "ConsistencyCheck": false,
    "SpanNumber": 1,
    "NumDrivePerSpan": 2,
    }

> 异常：

    1

    None

> 举例：

    1
    2

    ld_info={'storage_id': 'RAIDStorage0','drive_id': 'LogicalDrive1'}
    self.server.dispatch('get_specific_logical_drive_redfish',params=ld_info)

534. get_logical_drive_volumes_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：GET方法通过redfish接口获取逻辑磁盘集合信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params(dict): 请求参数
    {
    'storage_id' : 'RAIDStorage1'           (str) 指定控制器ID
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14

    response(dict): 返回体
    response={
    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Storages/Members/RAIDStorage0
    /Volumes/$entity",
    "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes",
    "@odata.type": "#VolumeCollection.VolumeCollection",
    "Name": "Volume Collection",
    "Members@odata.count": 1,
    "Members": [
    {
    "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0"
    }
    ]
    }

> 异常：

    1

    None

> 举例：

    1
    2

    ld_info={'storage_id': 'RAIDStorage0'}
    self.server.dispatch('get_logical_drive_volumes_redfish',params=ld_info)

535. get_cpu_colletion_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：GET方法通过redfish接口查询CPU集合资源信息

    命令格式：Systems/1/Processors

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('get_cpu_colletion_info_redfish')

536. get_specific_cpu_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：GET方法通过redfish接口查询指定CPU资源属性

    命令格式：Systems/1/Processors

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    cpuInfo(dict): {"cpu_id": "1"}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('get_specific_cpu_info_redfish')

537. modify_specific_cpu_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：PATCH方法通过redfish接口设置指定CPU资源属性

    命令格式：Systems/1/Processors

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    cpu_info(dict): {"cpu_id": "1",
    "body": {"Oem": {"Huawei":
    {"EnabledSetting":state}}}
    }

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('modify_specific_cpu_info_redfish')

538. query_sel_log_entries_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口查询SEL日志

    命令格式：https://Systems/1/LogServices/Log1/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    log_info(dict): { "log_id": "log1","log_body":{
    "StartEntryId" : 21,
    "EntriesCount": 20,
    "SelLevel": "Informational",
    "SelObjectType": "BMC",
    "SelBeginTime": "2018-08-01 00:00:00",
    "SelEndTime": "2018-08-31 00:00:00",
    "SelSearchString": "started"
    }}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('query_sel_log_entries_redfish')

539. collect_sel_log_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口收集SEL日志

    命令格式：https://Systems/1/LogServices/log1/Actions/Oem/Huawei/LogService.CollectSel

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    log_info(dict): { "log_id": "log1",
    "log_body":{
    "Type":"URI", "Content":"/tmp/aaa.tar.gz"}}

> 返回值：

    1

    response(bunch): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('collect_sel_log_redfish')

540. clear_network_history_usage_rate_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口清空网卡历史带宽占用率

    命令格式：Systems/1/Actions/Oem/Huawei/

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    clear_info(dict): {"BWUWaveTitle": "LOM-LOM(2*10GE+2*GE)"}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('clear_network_history_usage_rate_redfish')

541. get_health_events_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：GET方法通过redfish获取BMC系统告警信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/LogServices/Log1

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params(dict):请求参数
    {
    'event_id' : '0x100F0013'  (str) 指定告警事件码
    }

> 返回值：

    1
    2
    3

    result(list): 告警信息
    result=[
    ]

> 异常：

    1

    None

> 举例：

    1
    2

    event_id={'event_id': '0x100F0013'}
    self.server.dispatch('get_health_events_redfish',params=event_id)

542. add_swi_ipv6_addr_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口增加交换板Base/Fabric平面的IPv6地址

    命令格式：Systems/1/Actions/Oem/Huawei/ComputerSystem.AddSwiIpv6Addr

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    params(dict):请求参数
    {
    'FruType':frutype,(str)FRU类型
    'Address':address,(str)IPV6地址
    'PrefixLength":prefixlength(int)IPV6前缀长度
    }

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6

    {
    "FruType":"Base",
    "Address":"2001::10:10",
    "PrefixLength":64
    }
    self.server.dispatch('add_swi_ipv6_addr_redfish',params=params)

543. add_swi_ipv6_route_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口增加交换板Base/Fabric平面的IPv6路由

    命令格式：Systems/1/Actions/Oem/Huawei/ComputerSystem.AddSwiIpv6Route

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7

    params(dict): 请求参数
    {
    'FruType':frutype,(str)FRU类型
    'Address':address,(str)IPV6地址
    'PrefixLength':prefixlength, (int)IPV6前缀长度
    'Gateway': gateway  (str)IPv6网关
    }

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6
    7

    {
    "FruType":"Base",
    "Address":"2001::10:10",
    "PrefixLength":64
    "Gateway": "2002::2202"
    }
    self.server.dispatch('add_swi_ipv6_route_redfish',params=params)

544. del_swi_ipv6_route_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口删除交换板Base/Fabric平面的IPv6路由

    命令格式：Systems/1/Actions/Oem/Huawei/ComputerSystem.DelSwiIpv6Route

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6
    7

    params(dict): 请求参数
    {
    'FruType':frutype,(str)FRU类型
    'Address':address,(str)IPV6地址
    'PrefixLength':prefixlength, (int)IPV6前缀长度
    'Gateway': gateway  (str)IPv6网关
    }

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6
    7

    {
    "FruType":"Base",
    "Address":"2001::10:10",
    "PrefixLength":64
    "Gateway": "2002::2202"
    }
    self.server.dispatch('del_swi_ipv6_route_redfish',params=params)

545. del_swi_ipv6_addr_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口删除交换板Base/Fabric平面的IPv6地址

    命令格式：Systems/1/Actions/Oem/Huawei/ComputerSystem.DelSwiIpv6Addr

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5
    6

    params(dict): 请求参数
    {
    'FruType':frutype,(str)FRU类型
    'Address':address,(str)IPV6地址
    'PrefixLength':prefixlength, (int)IPV6前缀长度
    }

> 返回值：

    1

    response(dict):响应体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6

    {
    "FruType":"Base",
    "Address":"2001::10:10",
    "PrefixLength":64
    }
    self.server.dispatch('del_swi_ipv6_addr_redfish',params=params)

546. get_processor_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询处理器资源信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Processorview

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    Processorview(dict): 处理器资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('Processorview')

547. get_network_bondings
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询 NetworkBondings 资源信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/NetworkBondings

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    response(dict): NetworkBondings 资源信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_network_bondings')

548. get_network_bonding_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询Bond资源信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/NetworkBondings/bond_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 待查询的 bondId。eg:
    params = {'bondId': 'team00'}

> 返回值：

    1

    response(dict): NetworkBonding 信息

> 异常：

    1

    None

> 举例：

    1
    2

    bondInfo = {'bondId': 'team00'}
    bmcController.dispatch('getNetworkBondingsCollection', params=bondInfo)

549. delete_specific_network_bonding_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：DELETE方法通过redfish接口删除指定Bond资源信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/NetworkBondings/bond_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 待查询的 bondId。eg:
    params = {'bondId': 'team00'}

> 返回值：

    1

    response(dict): NetworkBonding 信息

> 异常：

    1

    None

> 举例：

    1
    2

    bondInfo = {'bondId': 'team00'}
    bmcController.dispatch('delete_specific_network_bonding_info', params=bondInfo)

550. get_digital_warranty_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询电子保单信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/DigitalWarranty

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3

    param(dict): 待查询的bladeId。eg:
    param = {'bladeId': 'HMM1'}   param = {'bladeId': '1'}   param = {'bladeId':
    'blade1'}

> 返回值：

    1

    DigitalWarranty(dict): 电子保单信息

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4

    bmcController.dispatch('get_digital_warranty_info')
    eg:
    param = {"bladeId": 'HMM1'}
    hmmController.dispatch("set_digital_warranty_info", param

551. set_digital_warranty_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：redfish设置电子保单信息

    命令格式：https://device_ip/redfish/v1/Systems/system_id/DigitalWarranty

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    param(dict): param,要修改的电子保单属性。
    eg:
    params = {'bladeId':'hmm1',
    dwAttr = {
    'StartPoint': '2012-12-14',
    'Lifespan': 123
    }}
    or params = {
    'StartPoint': '2012-12-14',
    'Lifespan': 123
    }
    bladeId: 系统资源的ID.eg:{'bladeId':'hmm1'}or{'bladeId':'1'}or{'bladeId':'blade1'}

> 返回值：

    1

    response(dict): 响应体

> 异常：

    1

    None

> 举例：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12

    bmcController.dispatch('set_digital_warranty_info', params=data)
    eg:d
    params = {'blaeId':'hmm1',
    "params":{
    'StartPoint': '2012-12-14',
    'Lifespan': 123
    }}
    or params = {
    'StartPoint': '2012-12-14',
    'Lifespan': 123
    }
    hmmController.dispatch("set_digital_warranty_info", param=body)

552. import_foreign_config
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口恢复指定存储控制器的默认配置

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    modify_info(dict): 请求参数
    {
    'storage_id' : 'RAIDStorage1'           (str) 指定控制器ID
    'body': {}                               (dict)请求体
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18

    response(dict): 返回体
    response={{
    "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
    {
    "@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",
    "MessageId": "Base.1.0.Success",
    "RelatedProperties": [],
    "Message": "Successfully Completed Request",
    "MessageArgs": [],
    "Severity": "OK",
    "Resolution": "None"
    }
    ]
    }
    }

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('restore_specific_storage',params=modify_info)

553. clear_foreign_config_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：POST方法通过redfish接口清除foreign配置

    命令格式：https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    modify_info(dict): 请求参数
    {
    'storage_id' : 'RAIDStorage1'           (str) 指定控制器ID
    'body': {}                               (dict)请求体
    }

> 返回值：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18

    response(dict): 返回体
    response={{
    "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
    {
    "@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",
    "MessageId": "Base.1.0.Success",
    "RelatedProperties": [],
    "Message": "Successfully Completed Request",
    "MessageArgs": [],
    "Severity": "OK",
    "Resolution": "None"
    }
    ]
    }
    }

> 异常：

    1

    None

> 举例：

    1

    self.server.dispatch('clear_foreign_config_redfish',params=modify_info)

554. get_task_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前任务服务资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    self.serverDevice = self.resource.getDevice(deviceType="server", deviceId='1')
    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_task_service_info_redfish')

555. get_task_service_tasks_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前任务集合资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    self.serverDevice = self.resource.getDevice(deviceType="server", deviceId='1')
    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_task_service_tasks_info_redfish')

556. get_specific_task_service_task_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定任务资源的信息(说明:调用该接口查询指定任务资源信息时,需要保证环境中有对应的task存在)

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    taskId(dict): 待查询的任务id

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    self.serverDevice = self.resource.getDevice(deviceType="server", deviceId='1')
    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_specific_task_service_task_info_redfish', params={"taskid":"1"})

557. get_specific_monitor_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定Monitor的信息(说明:调用该接口查询服务器指定Monitor的信息时,需要保证环境中有对应的task存在)

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    taskId(dict): 待查询的任务id

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    self.serverDevice = self.resource.getDevice(deviceType="server", deviceId='1')
    bmcController = self.serverDevice.getController("B1")
    bmcController.dispatch('get_specific_monitor_info_redfish', params={"taskid":"1"})

558. get_update_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前升级服务资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    info(dict): 响应body体,升级服务资源的信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_update_service_info_redfish')

559. get_update_firmware_inventory_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器当前可升级的固件集合资源的信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    info(Bunch): 响应body体,可升级的固件集合资源的信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_update_firmware_inventory_info_redfish')

560. get_specific_firmware_inventory_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器指定的可升级固件资源的信息

    命令格式：UpdateService/FirmwareInventory/softid

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4

    params = {
    "softid": (str) 指定的可升级固件 必选参数
    "relateditem": (str) 从响应体中获取url并得到url的响应
    }

> 返回值：

    1
    2

    info(dict): 响应body体,
    [info](list): 如果需要获取得到的url的响应,则返回url响应列表,可能有多个url的响应

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4

    softId = {"softid": "Bios"}
    bmcController.dispatch('get_specific_firmware_inventory_info_redfish', params=softId)
    params = {"softid": "chassisPS1", "relateditem": "RelatedItem"}
    bmcController.dispatch('get_specific_firmware_inventory_info_redfish', params=params)

561. activate_bios_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：复位bios固件

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    updateInfo(dict): 请求消息体，激活的部件

> 返回值：

    1

    info(dict): 响应body体

> 异常：

    1

    None

> 举例：

    1
    2

    updateInfo = {"ActivateBios": "IMU"}(IMU、M7、All)
    bmcController.dispatch('activate_bios_redfish', params=updateInfo)

562. upgrade_firmware_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：升级固件

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    updateInfo(dict): 请求消息体，升级包的路径及下载包时使用的协议

> 返回值：

    1

    info(dict): 响应body体,创建升级任务

> 异常：

    1

    None

> 举例：

    1
    2
    3

    updateInfo = {"ImageURI": "sftp://username:password@xx.xx.xx.xx/tmp/package/cpldimage.hpm",
    "TransferProtocol": "SFTP"}
    bmcController.dispatch('upgrade_firmware_redfish', params=updateInfo)

563. upgrade_bmc_and_synchronize_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：升级bmc并同步备用

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    updateInfo(dict): 请求消息体，升级包的路径及下载包时使用的协议

> 返回值：

    1

    info(dict): 响应body体,创建升级任务

> 异常：

    1

    None

> 举例：

    1
    2
    3

    updateInfo = {"ImageURI": "sftp://username:password@xx.xx.xx.xx/tmp/package/cpldimage.hpm",
    "TransferProtocol": "SFTP"}
    bmcController.dispatch('upgrade_bmc_and_synchronize_redfish', params=updateInfo)

564. upgrade_bmc_and_synchronize_action_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：升级bmc并同步备用ActionInfo

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

    1

    info(dict): 响应body体,ActionInfo信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('upgrade_bmc_and_synchronize_action_info')

565. trans_firmware_inventory_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：redfish传输文件

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    file(str): 请求消息体，文件路径

> 返回值：

    1

    info(dict): 响应body体,上传文件

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('trans_firmware_inventory_redfish', params=files)

566. modify_update_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改UpdateService信息,如:防回滚功能开启使能,DowngradeDisabled

    命令格式：https://device_ip/redfish/v1/UpdateService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    params(dict): 请求消息体
    {"Oem": {"Huawei": {"DowngradeDisabled": false}}}

> 返回值：

    1
    2
    3
    4
    5
    6
    7
    8

    response(dict): 响应体
    {
    "@odata.context": "/redfish/v1/$metadata#UpdateService",
    "@odata.id": "/redfish/v1/UpdateService",
    "@odata.type": "#UpdateService.v1_0_0.UpdateService",
    "Id": "UpdateService",
    "Name": "Update Service",
    "Oem": {"Huawei": {"DowngradeDisabled": false}}}

> 异常：

    1

    None

> 举例：

    1
    2

    bmcController.dispatch('modify_update_service_info_redfish',
    params=modify)

567. get_certificate_service_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询当前CertificateService资源信息

    命令格式：https://device_ip/redfish/v1/CertificateService

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    params(dict): 输入参数

> 返回值：

     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
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41

    response(dict): 用户信息集合,redfish的响应消息体
    {
    "@odata.context": "/redfish/v1/$metadata#CertificateService",
    "@odata.id": "/redfish/v1/CertificateService",
    "@odata.type": "#CertificateService.v1_0_0.CertificateService",
    "Id": "CertificateService",
    "Name": "Certificate Service",
    "Oem": {
    "Huawei": {
    "CertificateOverdueWarnDays": 100,
    "CRLEnabled": true,
    "SSLCertificateCSRAlgorithm": "RSA",
    "IsDefaultSSLCertificate": false,
    "Actions": {
    "#CertificateService.ImportCACertificate": {
    "target": "/redfish/v1/CertificateService/Actions/CertificateService
    .ImportCACertificate",
    "@Redfish.ActionInfo":
    "/redfish/v1/CertificateService/ImportCACertificateActionInfo"
    },
    "#CertificateService.DeleteCACertificate": {
    "target": "/redfish/v1/CertificateService/Actions/CertificateService
    .DeleteCACertificate",
    "@Redfish.ActionInfo":
    "/redfish/v1/CertificateService/DeleteCACertificateActionInfo"
    },
    "#CertificateService.ImportCACertificateCRL": {
    "target": "/redfish/v1/CertificateService/Actions/CertificateService
    .ImportCACertificateCRL",
    "@Redfish.ActionInfo":
    "/redfish/v1/CertificateService/ImportCACertificateCRLActionInfo"
    }
    }
    }
    },
    "Links": {
    "CertificateLocations": {
    "@odata.id": "/redfish/v1/CertificateService/CertificateLocations"
    }
    }
    }

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('get_certificate_service_redfish')

568. set_certificate_service_info_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改证书服务信息

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    certificateinfo(dict): 该redfish请求的消息体, 需要修改的信息

> 返回值：

    1

    response(dict): 命令的返回值: 修改后的最新信息

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('set_certificate_service_info_redfish', params=certificateinfo)

569. import_ca_certificate_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：CA证书导入

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    certiContent(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('import_ca_certificate_redfish', params=certiContent)

570. import_cacrl_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：CRL导入

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    certiContent(dict): 该redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('import_cacrl_redfish', params=certiContent)

571. delete_ca_certificate_redfish
> 描述：

    1
    2
    3
    4
    5

    方法功能：CA统一删除

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    certiContent(dict): 该Redfish请求的消息体

> 返回值：

    1

    response(dict): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    bmcController.dispatch('delete_ca_certificate_redfish',params=certificate_Id)