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

Skip to content

# Syslog 子类方法

1. cli_query_set_syslog
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d state命令用于查询和设置iBMC的syslog上报功能的使能状态。

    命令格式：ipmcget -t syslog -d state [-v destination]

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

> 参数：

    1
    2
    3
    4
    5

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    destination(str): 表示syslog上报通道的编号。
    value(str):
    disabled: 表示禁用syslog上报功能。
    enabled: 表示启用syslog上报功能。

> 返回值：

    1

    result(str): iBMC的syslog上报功能的使能状态，或者设置iBMC的syslog上报功能的使能状态是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_syslog(params["method"], params["value"])

2. cli_query_set_certificate_authentication_mode
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d auth命令用于查询和设置证书认证方式。

    命令格式：ipmcget -t syslog -d auth

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

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    option(str): 表示证书认证方式。

> 返回值：

    1

    result(str): 证书认证方式，或者设置证书认证方式是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_certificate_authentication_mode(params["method"])

3. cli_query_set_syslog_host_identifier
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d identity命令用于查询和设置syslog日志上报时使用的主机标识。

    命令格式：ipmcget -t syslog -d identity

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

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    option(str): 表示要设置的主机标识

> 返回值：

    1

    result(str): syslog日志上报时使用的主机标识，或者设置syslog日志上报时使用的主机标识是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_syslog_host_identifier(params["method"])

4. cli_query_set_protocol_type
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d protocol命令用于查询和设置上报syslog日志时采用的传输协议类型。

    命令格式：ipmcget -t syslog -d protocol

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

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    option(str): 表示采用的协议类型。

> 返回值：

    1

    result(str): 上报syslog日志时采用的传输协议类型，或者设置上报syslog日志时采用的传输协议类型是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_protocol_type(params["method"])

5. cli_query_set_log_levels
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d severity命令用于查询和设置通过syslog上报的日志的级别。

    命令格式：ipmcget -t syslog -d severity

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

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    level(str): 表示上报日志的级别。

> 返回值：

    1

    result(str): 通过syslog上报的日志的级别，或者设置通过syslog上报的日志的级别是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_log_levels(params["method"])

6. cli_query_upload_server_root_certificate
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d rootcertificate命令可将syslog服务器的根证书上传到iBMC，或查询当前根证书信息。

    命令格式：ipmcget -t syslog -d rootcertificate

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

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    filepath(str): 表示待上传的根证书在iBMC上的绝对路径。

> 返回值：

    1

    result(str): 当前根证书信息，或者设置当前根证书信息是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_upload_server_root_certificate(params["method"], params["filepath"])

7. cli_query_upload_local_certificate
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d clientcertificate命令可将syslog客户端证书上传到iBMC，或查询本地证书信息。

    命令格式：ipmcget -t syslog -d clientcertificate

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

> 参数：

    1
    2
    3

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    filepath(str): 表示待上传的本地证书在iBMC上的绝对路径。
    password(str): 表示用于解密本地证书的密码。

> 返回值：

    1

    result(str): 当前根证书信息，或者设置当前根证书信息是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_upload_local_certificate(params["method"])

8. cli_set_syslog_server_address
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d address命令用于设置syslog服务器地址。

    命令格式：ipmcset -t syslog -d address -v <destination> <ipaddr>

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

> 参数：

    1
    2
    3

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    destination(str): 表示syslog上报通道的编号。
    ipaddr(str): 表示syslog服务器地址。

> 返回值：

    1

    result(str): 设置syslog服务器地址是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_set_syslog_server_address(params["method"])

9. cli_set_syslog_server_port_number
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d port命令用于设置syslog服务器端口号。

    命令格式：ipmcset -t syslog -d port -v <destination> <portvalue>

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

> 参数：

    1
    2
    3

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    destination(str): 表示syslog上报通道的编号。
    portvalue(str): 表示syslog服务器端口号。

> 返回值：

    1

    result(str): 设置syslog服务器地址是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_set_syslog_server_port_number(params["method"])

10. cli_set_logs_types_report
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d logtype命令用于设置通过syslog报文上报的日志的类型。

    命令格式：ipmcset -t syslog -d logtype -v <destination> <type>

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

> 参数：

    1
    2
    3

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    destination(str): 表示syslog上报通道的编号。
    type(str): 表示上报日志类型。

> 返回值：

    1

    result(str): 设置syslog服务器地址是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_set_logs_types_report(params["method"])

11. cli_test_reachability_syslog_server
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d test命令用于测试配置的syslog服务器是否可连接。

    命令格式：ipmcset -t syslog -d test -v <destination>

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

> 参数：

    1

    destination(str): 表示syslog上报通道的编号。

> 返回值：

    1

    result(str): 配置的syslog服务器连接是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_test_reachability_syslog_server(params["destination"])

12. cli_query_configuration_syslog_report_channels
> 描述：

    1
    2
    3
    4
    5

    方法功能：syslog -d iteminfo命令用于查询4条syslog日志上报通道的配置情况。

    命令格式：ipmcget -t syslog -d iteminfo

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

> 参数：

    1

    None

> 返回值：

    1

    result(list): syslog日志上报通道的配置信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_configuration_syslog_report_channels()