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

Skip to content

# AccountService 子类方法

1. redfish_account_query_service
> 描述：

    1
    2
    3
    4
    5
    6
    7

    方法功能：3.6.1 查询用户服务信息
        操作类型: GET
        URL:https://device_ip/redfish/v1/AccountService

    命令格式：

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

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 服务器当前用户服务信息，包括密码长度、允许错误密码次数、锁定时长等

> 异常：

    1

    None

> 举例：

    1

    redfish_get_right = self.redfish_api.redfish_account_query_service()

2. redfish_account_modify_service
> 描述：

    1
    2
    3
    4
    5
    6
    7

    方法功能：3.6.2 修改用户服务信息
        操作类型:PATCH
        URL:https://device_ip/redfish/v1/AccountService

    命令格式：

    支持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

    count(int): 允许输入错误密码次数,0~6的整数,0表示不锁定
    time(int): 用户登录失败被锁定后，自动解锁的时间间隔, 60~1800的整数,单位为秒,默认为300,取值必须为60的整数倍
    minlen(int): 最短密码长度
    account_detail(dict): {
    "TlsVersion": [tls_value],
    "PasswordComplexityCheckEnabled": PasswordComplexityCheckEnabled_value,
    "AccountInactiveTimelimit": AccountInactiveTimelimit_value,
    "SSHPasswordAuthenticationEnabled": SSHPasswordAuthenticationEnabled_value,
    "CertificateOverdueWarningTime:" CertificateOverdueWarningTime_value,
    "OSUserManagementEnabled": OSUserManagementEnabled_value,
    "PasswordValidityDays": PasswordValidityDays_value,
    "MinimumPasswordAgeDays": MinimumPasswordAgeDays_value,
    "PreviousPasswordsDisallowedCount": PreviousPasswordsDisallowedCount_value,
    "SecurityBannerEnabled": SecurityBannerEnabled_value,
    "SecurityBanner": SecurityBanner_value,
    "EmergencyLoginUser": EmergencyLoginUser_value,
    "SystemLockDownEnabled": SystemLockDownEnabled_value,
    "TwoFactorAuthenticationInformation": {
    "CrlVerificationEnabled": Crl_enabled_value
    }
    }

> 返回值：

    1

    response(dict): 修改服务器当前用户服务信息，包括允许错误密码次数、锁定时长等

> 异常：

    1

    None

> 举例：

    1
    2

    self.redfish_api.redfish_account_modify_service(account_detail={"EmergencyLoginUser": ""},
    count=0, time=300, minlen=8)

3. redfish_account_query_user_collection
> 描述：

    1
    2
    3
    4
    5
    6
    7
    8

    方法功能：3.6.3 查询用户集合资源信息
                查询服务器当前用户集合资源信息。
        操作类型:GET
        URL:https://device_ip/redfish/v1/AccountService/Accounts

    命令格式：

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

> 参数：

    1

    None

> 返回值：

    1

    response(dict): 当前用户集合资源信息

> 异常：

    1

    None

> 举例：

    1

    redfish_get_user = self.redfish_api.redfish_account_query_user_collection()

4. redfish_account_query_user
> 描述：

    1
    2
    3
    4
    5
    6
    7
    8

    方法功能：3.6.4 查询指定用户资源信息
                查询指定用户资源信息。
        操作类型:GET
        URL:https://device_ip/redfish/v1/AccountService/Accounts/account_id

    命令格式：

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

> 参数：

    1

    account_id(str): 用户ID

> 返回值：

    1

    response(dict): 指定用户资源信息

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_query_user("2")

5. redfish_account_create_user
> 描述：

    1
    2
    3
    4
    5
    6
    7
    8

    方法功能：3.6.5 创建新用户
                创建新用户。
        操作类型:POST
        URL:https://device_ip/redfish/v1/AccountService/Accounts

    命令格式：

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

> 参数：

    1
    2
    3
    4

    user_id(str): 新建用户的Id
    username(str): 新建用户的用户名
    password(str): 新建用户的密码
    role(str): 新建用户的角色

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_create_user("4", "username", "password@90000@8000", "Administrator")

6. redfish_account_delete_user
> 描述：

    1
    2
    3
    4
    5
    6
    7
    8

    方法功能：3.6.6 删除用户
                删除指定用户。
        操作类型:DELETE
        URL:https://device_ip/redfish/v1/AccountService/Accounts/account_id

    命令格式：

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

> 参数：

    1

    account_id(str): 用户ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_delete_user("4")

7. redfish_account_modify_user
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

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

    account_id: 待修改的用户的Id
    username: 修改后的用户名
    password: 修改后的用户密码
    role: 修改后的用户角色
    state1: 修改后的用户锁定状态
    state2: 修改后的用户使能状态
    account_insecure_prompt_enabled_value: 修改后的用户不安全提示状态
    login_interface_value: 用户登录接口
    snmp_v3_auth_protocol: V3鉴权算法
    snmp_v3_priv_protocol: V3加密算法
    password_value: 被用于SNMPv3鉴权的用户的加密密码
    loginrule_value: 用户登录规则

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_modify_user(account_id, username_detail)

8. redfish_account_import_root_twofactor_authentication
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2

    type_value: 双因素证书导入的方法
    content_value: 双因素证书导入的路径

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_import_root_twofactor_authentication(type_value, content_value)

9. redfish_account_delete_root_twofactor_authentication
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    cerid_value: 双因素认证的根证书ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_delete_root_twofactor_authentication(cerid_value)

10. redfish_account_import_user_client_twofactor_authentication
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3

    account_id: 用户的ID
    type_value: 双因素证书导入的方法
    content_value: 双因素证书导入的路径

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    self.redfish_api.redfish_account_import_user_client_twofactor_authentication(account_id,
    type_value, content_value)

11. redfish_account_delete_user_client_twofactor_authentication
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    account_id: 待修改的用户的ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_delete_user_client_twofactor_authentication(account_id)

12. redfish_account_import_twofactor_authentication_client_crl
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3
    4

    crl_text: 证书吊销列表文本
    tmp_uri: 证书吊销列表的本地路径
    remote_uri: 证书吊销列表的远程路径
    root_cert_id: 签发吊销列表的根证书对象ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_import_twofactor_authentication_client_crl(params)

13. redfish_account_import_ssh_public_key
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3

    account_id: 用户的ID
    type_value: SSH公钥导入的方法
    content_value: SSH公钥导入的路径

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_import_ssh_public_key(account_id, type_value, content_value)

14. redfish_account_delete_ssh_public_key
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    account_id: 待修改的用户的ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_delete_ssh_public_key(account_id)

15. redfish_account_query_role_collection
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    None

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_query_role_collection()

16. redfish_account_query_role
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    role_id: 角色ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_query_role(role_id)

17. redfish_account_modify_customized_role
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3

    role_id: 角色ID
    privilegelist1: Redfish定义的权限
    privilegelist2: 华为服务器定义的权限

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    self.redfish_api.redfish_account_modify_customized_role(role_id,
    privilegelist1, privilegelist2)

18. redfish_account_query_ldap_service
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    None

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_query_ldap_service()

19. redfish_account_set_ldap_function
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    enabled: Ldap功能是否开启,控制所有域控制器的使能

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_set_ldap_function(enabled)

20. redfish_account_query_ldap_domain_collection
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    None

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_query_ldap_domain_collection()

21. redfish_account_query_domain_controller
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    account_id: 域控制器Id

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_query_domain_controller(account_id)

22. redfish_account_modify_domain_controller
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

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

    account_id: 域控制器id。
    server_addr: 域控制器地址
    port: 域控制器端口号
    domain: 域控制器的用户域
    binddn: Ldap代理用户标识名
    bindpwd: Ldap代理用户的认证密码
    enabled: 证书开启使能
    demand: 证书校验级别
    group_name: Ldap用户组的组名
    group_folder: Ldap用户组的组文件夹
    group_domain: Ldap用户组的组域
    group_role: Ldap用户组的组角色
    rule_id: Ldap用户组的登录规则
    inter_id: Ldap用户组的登录接口

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_modify_domain_controller(account_id, ldap_detail)

23. redfish_account_import_domain_ldap_certificate
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3
    4

    account_id: 域控制器Id
    cert_text: 证书文本
    tmp_uri: 证书本地路径
    remote_uri: 证书远程路径

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_import_domain_ldap_certificate(account_id, cert_text, tmp_uri)

24. redfish_account_import_ldap_server_crl_domain_controller
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3
    4

    account_id: 域控制器Id
    crl_text: 证书吊销列表文本
    tmp_uri: 证书吊销列表的本地路径
    remote_uri: 证书吊销列表的远程路径

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_import_ldap_server_crl_domain_controller(account_id, crl_text, tmp_uri)

25. redfish_account_query_kerberos_service
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    None

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_query_kerberos_service()

26. redfish_account_set_kerberos_function
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    enabled: Kerberos功能是否开启,控制所有域控制器的使能

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_set_kerberos_function(enabled)

27. redfish_account_query_kerberos_domain_collection
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    None

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_query_kerberos_domain_collection()

28. redfish_account_query_kerberos_domain_controller
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    account_id: 域控制器Id

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_query_kerberos_domain_controller(account_id)

29. redfish_account_modify_kerberos_domain_controller
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    account_id: 域控制器id。
    server_addr: 域控制器地址
    port: 域控制器端口号
    realm: 域控制器的领域
    group_name: Kerberos用户组的组名
    group_domain: Kerberos用户组的组域
    group__s_i_d: Kerberos用户组的SID
    group_role: Kerberos用户组的组角色
    rule_id: Kerberos用户组的登录规则
    inter_id: Kerberos用户组的登录接口

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_modify_kerberos_domain_controller(account_id, kerberos_detail)

30. redfish_account_import_kerberos_domain_keytable
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2

    account_id: 域控制器Id
    tmp_uri: 秘钥表本地路径

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_import_kerberos_domain_keytable(account_id, tmp_uri)

31. redfish_account_query_rights_map
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    None

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_account_query_rights_map()