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

Skip to content

# SecurityMgmt 子类方法

1. ipmi_set_user_name
> 描述：

    1
    2
    3
    4
    5

    方法功能：通过ipmi接口配置用户名的接口

    命令格式：

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

> 参数：

    1
    2

    user_id(str): 用户id
    user_name(str): 用户名

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_user_name(params)

2. ipmi_get_user_name
> 描述：

    1
    2
    3
    4
    5

    方法功能：通过ipmi命令查询用户名的接口

    命令格式：

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

> 参数：

    1

    user_id(str): 用户id

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_user_name(params)

3. ipmi_set_user_password
> 描述：

    1
    2
    3
    4
    5

    方法功能：通过ipmi命令设置用户名的接口

    命令格式：

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

> 参数：

    1
    2

    user_id(str): 用户id
    user_password(str): 用户密钥

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_user_password(params)

4. ipmi_set_user_access
> 描述：

    1
    2
    3
    4
    5

    方法功能：通过ipmi命令设置BMC用户访问权限接口

    命令格式：

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

> 参数：

    1
    2

    user_id(str): 用户id
    user_access(str): 用户密钥

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_user_access(params)

5. ipmi_set_user_access_v3
> 描述：

    1
    2
    3
    4
    5

    方法功能：v3版本通过ipmi命令设置BMC用户访问权限接口

    命令格式：

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

> 参数：

    1
    2

    user_id(str): 用户id
    user_access(str): 用户密钥

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_user_access_v3(params)

6. ipmi_get_user_access
> 描述：

    1
    2
    3
    4
    5

    方法功能：通过ipmi命令查询BMC用户访问权限的接口

    命令格式：

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

> 参数：

    1

    user_id(str): 用户id

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_user_access(params)

7. ipmi_set_user_interface
> 描述：

    1
    2
    3
    4
    5

    方法功能：通过ipmi命令设置BMC用户访问接口

    命令格式：

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

> 参数：

    1
    2
    3
    4
    5

    user_id(str): 用户id
    user_inter(str): 用户接口
    user_pass_true(str): 是否配置用户密码
    user_pass_len(str): 密码长度
    user_pass(str): 用户密码(无后置0x00)

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_user_interface(params)

8. ipmi_get_localuser_complex_check_enable
> 描述：

    1
    2
    3
    4
    5

    方法功能：通过ipmi命令获取口令复杂度配置

    命令格式：

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

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_localuser_complex_check_enable(params)

9. ipmi_set_localuser_complex_check_enable
> 描述：

    1
    2
    3
    4
    5

    方法功能：通过ipmi命令设置口令复杂度配置的接口

    命令格式：

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

> 参数：

    1

    enable (str):用户口令复杂度配置

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_localuser_complex_check_enable(params)

10. ipmi_set_two_factor_state
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：通过ipmi命令设置Two Factor State配置
                  ipmitool raw 0x30 0x93 0xDB 0x52 {param1}

    命令格式：

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

> 参数：

    1
    2

    enable (str):用户口令复杂度配置
    OCSP (str):OCSP使能配置

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_two_factor_state(params)

11. ipmi_get_two_factor_state
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：通过ipmi命令获取Two Factor State配置
                  ipmitool raw 0x30 0x93 0xDB 0x51

    命令格式：

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

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_two_factor_state(params)

12. ipmi_set_snmp_configuration
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：通过ipmi命令进行SNMP配置
                  ipmitool raw 0x30 0x93 0xDB 0x74

    命令格式：

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

> 参数：

    1
    2
    3
    4
    5

    snmp_parameter (str):SNMP参数
    block_selector (str):块选择器
    sub_block_selector (str):子块选择器
    length (str):团体名长度
    group_name (str):团体名

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_snmp_configuration(params)

13. ipmi_get_snmp_configuration
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：通过ipmi命令获取SNMP配置
                  ipmitool raw 0x30 0x93 0xDB 0x75

    命令格式：

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

> 参数：

    1
    2
    3

    SNMP_parameter (str):SNMP参数
    block_selector (str):块选择器
    sub_block_selector (str)

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_snmp_configuration(params)

14. ipmi_set_ipmc_conf
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：IPMI Set IPMC Configuration 设置IPMC配置参数接口
                  ipmitool raw 0x30 0x93 0x05

    命令格式：

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

> 参数：

    1
    2
    3
    4
    5

    selector (str):参数选择
    cascade (str):级联标志, 提示是否还有下一部分
    offset (str):写入数据偏移
    length (str):写入数据长度
    data (str):实际写入数据

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_ipmc_conf(params)

15. ipmi_get_ipmc_conf
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：IPMI Set IPMC Configuration 设置IPMC配置参数接口
                  ipmitool raw 0x30 0x93 0x05

    命令格式：

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

> 参数：

    1
    2
    3

    selector (str):参数选择
    offset (str):写入数据偏移
    length (str):写入数据长度

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_ipmc_conf(params)

16. ipmi_set_ldap_group_configuration
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：IPMI Set LDAP Group 设置LDAP用户组接口
                  ipmitool raw 0x30 0x93 0x0D

    命令格式：

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

> 参数：

    1
    2
    3
    4
    5
    6

    group_id (str):组域id
    config_type (str):参数选择
    cascade (str):级联标志, 提示是否还有下一部分
    offset (str):写入数据偏移
    length (str):写入数据长度
    data (str):实际写入数据

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_ldap_group_configuration(params)

17. ipmi_get_ldap_group_configuration
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：IPMI Set LDAP Group 设置LDAP用户组接口
                  ipmitool raw 0x30 0x93 0x0D

    命令格式：

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

> 参数：

    1
    2
    3
    4

    group_id (str):组域id
    config_type (str):参数选择
    offset (str):写入数据偏移
    length (str):写入数据长度

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_ldap_group_configuration(params)

18. ipmi_set_actual_measure
> 描述：

    1
    2
    3
    4
    5

    方法功能：IPMI Set Actual Measure ipmi设置度量对象实际度量值

    命令格式：ipmitool raw 0x30 0x92 0xdb 0x07 0x00 0x57 {firmware_type} {firmware_detail_type} 0x00 {length}

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

> 参数：

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

    params(dict):{
    firmware_type:0x00: 由BIOS侧发起的度量,0x01: 由SHIM侧发起的度量,0x02: 由GRUB侧发起的度量
    firmware_detail_type:
    Firmware Type:0
    0x00: 由BIOS侧发起的度量
    0x01: reserved1
    0x02: reserved2
    Firmware Type:1
    0x00: 由SHIM侧发起的度量
    0x01: reserved1
    0x02: reserved2
    Firmware Type:2
    0x00: grub.cfg
    0x01: kernel
    0x02: initrd
    length (str):hash值长度（16进制数的位数）
    hash_value (str):hash值
    }

> 返回值：

    1

    result(str): 设置度量对象实际度量值命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.tpcm_obj.ipmi_set_actual_measure(params)

19. ipmi_get_actual_measure
> 描述：

    1
    2
    3
    4
    5

    方法功能：IPMI Get Actual Measure ipmi获取度量对象实际度量值

    命令格式：ipmitool raw 0x30 0x92 0xdb 0x07 0x00 0x58 {firmware_type} {firmware_detail_type}

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

> 参数：

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

    params(dict): {
    firmware_type:0x00: 由BIOS侧发起的度量,0x01: 由SHIM侧发起的度量,0x02: 由GRUB侧发起的度量
    firmware_detail_type:
    Firmware Type:0
    0x00: 由BIOS侧发起的度量
    0x01: reserved1
    0x02: reserved2
    Firmware Type:1
    0x00: 由SHIM侧发起的度量
    0x01: reserved1
    0x02: reserved2
    Firmware Type:2
    0x00: grub.cfg
    0x01: kernel
    0x02: initrd
    }

> 返回值：

    1

    result(str): 获取度量对象实际度量值命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.tpcm_obj.ipmi_get_actual_measure(params)