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

Skip to content

# Busctl 子类方法

1. busctl_get_user_tree
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询user 信息树

    命令格式：busctl --user tree

    支持Host类型：HostType.BMC

> 参数：

    1

    None

> 返回值：

    1

    response(dict):资源树信息

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.busctl_get_user_tree(service_name=None, key_word='')

2. busctl_get_user_list
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询组件信息

    命令格式：busctl --user list

    支持Host类型：HostType.BMC

> 参数：

    1

    None

> 返回值：

    1

    response(list): 返回组件信息

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.busctl_get_user_list()

3. busctl_get_user_status
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务状态

    命令格式：busctl --user status service_name

    支持Host类型：HostType.BMC

> 参数：

    1

    service_name (str): 服务

> 返回值：

    1

    response(list): 返回服务信息

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.busctl_get_user_status()

4. busctl_introspect_service_object
> 描述：

    1
    2
    3
    4
    5

    方法功能：显示SERVICE服务上OBJECT对象(以路径表示)的信息

    命令格式：busctl --user introspect SERVICE OBJECT [INTERFACE]

    支持Host类型：HostType.BMC

> 参数：

    1
    2
    3
    4

    service_name(str): 服务
    object_node(str): 对象
    interface(str): 接口
    key_word (str): 过滤条件

> 返回值：

    1

    response(dict): OBJECT对象的信息

> 异常：

    1

    None

> 举例：

    1
    2
    3

    self.cli_api.busctl_introspect_service_object(
    busctl_params.get("name"), busctl_params.get("kepler_systems_id_bootoptions"),
    busctl_params.get("interface"))

5. busctl_call_service_object
> 描述：

    1
    2
    3
    4
    5

    方法功能：调用SERVICE服务上OBJECT对象方法设置属性值

    命令格式：busctl --user call [service_name] [object_node] [interface] [method_name] [value]

    支持Host类型：HostType.BMC

> 参数：

    1
    2
    3
    4
    5
    6
    7

    service_name(str): 服务
    object_node(str): 对象
    interface(str): 接口
    method(str): 方法名
    value(str): 设置参数
    Return:
    response(dict): 命令的返回值

> 返回值：

    1

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.busctl_call_service_object(**busctl_params, value="0")

6. busctl_get_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：调用SERVICE服务上OBJECT对象方法获取属性值

    命令格式：busctl --user get-property [service_name] [object_node] [interface] [property_name]

    支持Host类型：HostType.BMC

> 参数：

    1
    2
    3
    4
    5
    6

    service_name(str):  服务
    object_node(str):  对象
    interface(str): 接口
    property_name(str): 查询的属性
    Return:
    response(dict): 命令的返回值

> 返回值：

    1

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.busctl_get_property(**busctl_params)

7. busctl_set_property
> 描述：

    1
    2
    3
    4
    5

    方法功能：调用SERVICE服务上OBJECT对象方法设置属性值

    命令格式：busctl --user set-property [service_name] [object_node] [interface] [property_name] [value]

    支持Host类型：HostType.BMC

> 参数：

    1
    2
    3
    4
    5
    6
    7

    service_name(str): 服务
    object_node(str): 对象
    interface(str): 接口
    property_name(str): 属性
    value(str): 设置参数
    Return:
    response(dict): 命令的返回值

> 返回值：

    1

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.busctl_set_property(**busctl_params, value="0")