bmc.kepler.Managers.ActiveStandby.Local ​

==属性==

==方法==

SwitchStatus

主备倒换接口

参数

• Status: U8 - 切换目标状态 0：Standby 1：Active

bmc.kepler.Managers.ActiveStandby.Remote ​

==属性==

bmc.kepler.Managers.ActiveStandby.Status ​

==属性==

bmc.kepler.Managers.ActiveStandby.SwitchRule ​

==属性==

bmc.kepler.Managers.BMC ​

==属性==

bmc.kepler.Managers.BlackBox ​

==方法==

DumpData

黑匣子数据下载接口

参数

• Path: String - 导出路径

返回值

• TaskId: U32 - 创建的任务标识

bmc.kepler.Managers.Chassis.NetConfig ​

==属性==

bmc.kepler.Managers.Configurations ​

==属性==

==方法==

FactoryBackup

设置出厂还原点

返回值

• TaskId: U32 - 创建的任务ID

CustomizationBackup

设置自定义还原点

返回值

• TaskId: U32 - 创建的任务ID

RecoverFactoryRestorePoint

恢复出厂还原点

参数

• PreserveList: Object - 保留日志的列表

返回值

• TaskId: U32 - 创建的任务ID

RecoverCustomRestorePoint

恢复自定义还原点

返回值

• TaskId: U32 - 创建的任务ID

Import

配置导入，用于导入配置文件

参数

• FilePath: String - 远程或本地路径
• Type: String - custom: 定制导入; configuration: 业务导入

返回值

• TaskId: U32 - 创建的任务ID

ImportConfigurationBundle

配置导入，用于导入配置包

参数

• BundleURI: String - 远程或本地路径

返回值

• TaskId: U32 - 创建的任务ID

Export

配置导出，用于导出配置文件

参数

• FilePath: String - 远程或本地路径
• Type: String - custom: 业务导出; configuration: 定制导出

返回值

• TaskId: U32 - 创建的任务ID

ExportConfigurationBundle

配置导出，用于导出配置包

参数

• BundleURI: String - 远程或本地路径

返回值

• TaskId: U32 - 创建的任务ID

Set

配置设置，仅涉及配置数据，仅供WEB使用

参数

• ConfigData: String - 配置数据

Get

配置查询，仅涉及配置数据，仅供WEB使用

返回值

• ConfigData: String - 配置数据

==自定义类型==

Object: 结构体类型

• key: String
• value: String

bmc.kepler.Managers.DataSync ​

==属性==

==方法==

GetProperties

参数

• Identifier: U8 - 需要查询属性的远端节点标识，255表示查询所有节点
• ObjectName: String - 需要查询属性的对象名称
• Interface: String - 需要查询属性的对象接口

返回值

• Properties: Array

==自定义类型==

PropertyAttribute: 结构体类型

• key: String
• value: String

PropertyDetails: 结构体类型

• PropertyName: String - 属性名称
• PropertyItems: PropertyAttribute

SyncProperties: 结构体类型

• Identifier: U8 - 当前查询的同步属性归属的远端节点标识
• PropertyDetails: Array

bmc.kepler.Managers.DiagnosticService.ContaminationDetection ​

==方法==

GetResults

查询脏污检测结果

参数

• DetectorIds: String[] - 检测对象序列号

返回值

• Detections: Array - 脏污检测结果集合

Initiate

配置测试参数

参数

• Configuration: Array - 初始化参数

返回值

• OperationResults: Array - 初始化结果

Start

开始检测

参数

• Detectors: Array - 检测对象集合

返回值

• OperationResults: Array - 开始检测操作操作结果

Shutdown

终止检测

参数

• DetectorIds: String[] - 检测对象序列号

返回值

• OperationResults: Array - 终止检测操作操作结果

==自定义类型==

Detections: 结构体类型

• Detection: Array - 检测对象脏污检测结果

DetectionItem: 结构体类型

• Key: String
• Value: String

OperationResults: 结构体类型

• DetectorId: String - 检测对象序列号
• Result: String - 脏污检测操作结果

Configuration: 结构体类型

• DetectorId: String - 检测对象序列号
• DurationSeconds: U16 - 脏污检测超时时间

Detectors: 结构体类型

• Detector: Array - 检测对象

bmc.kepler.Managers.DiagnosticService.PRBSTest ​

==方法==

QueryInfo

查询测试对象测试信息

参数

• TestObjects: String[] - 测试对象名称

返回值

• TestInfos: String - 测试对象信息

Config

配置测试参数

参数

• Configurations: String - Config参数

返回值

• OperationResults: Array - Config操作结果

ClearStatistics

清除统计

参数

• TestObjects: String[] - 测试对象名称

返回值

• OperationResults: Array - ClearStatistics操作结果

Shutdown

终止测试

参数

• TestObjects: String[] - 测试对象名称

返回值

• OperationResults: Array - Shutdown操作结果

==自定义类型==

OperationResults: 结构体类型

• TestObjectId: String - PRBS压测对象名
• Result: String - PRBS压测操作结果

bmc.kepler.Managers.DiagnosticService.WorkRecord ​

==方法==

Get

查询工作记录

返回值

• Count: U32 - 工作记录数
• NextAvailableId: String - 下一个可用的工作记录标识
• List: Array - 工作记录内容

Add

添加工作记录

参数

• Content: String - 工作记录内容

返回值

• Id: String - 工作记录标识

Delete

删除工作记录

参数

• Id: String - 工作记录标识

Update

修改工作记录

参数

• Id: String - 工作记录标识
• Content: String - 工作记录内容

==自定义类型==

Items: 结构体类型

• Id: String
• UserName: String
• IPAddress: String
• Time: String
• Content: String

bmc.kepler.Managers.Encryption.PublicKey ​

==方法==

GetPubKey

获取对敏感信息加密的公钥

返回值

• PubKey: String - 不对称加密算法公钥，用以加密敏感信息

bmc.kepler.Managers.EthernetInterface.PhyChip ​

==属性==

bmc.kepler.Managers.EthernetInterfaces ​

==属性==

==方法==

GetAllPort

获取所有port

返回值

• Port: Array - port列表

SetNetworkConfig

设置网络配置信息

参数

• NetMode: String - 固定模式，自动选择
• PortId: U8 - 激活端口，对应MgmtPortId对象的Id属性
• VLANEnable: Boolean - NCSI VLAN使能状态：0 - 不使能； 1 - 使能
• VLANId: U16 - 虚拟局域网(Virtual Local Area Network， VLAN)的标识符，用于区分不同的虚拟局域网

AddMgmtPort

添加管理网口

参数

• DeviceId: U8 - 设备ID
• DevicePortId: U8 - 设备端口ID
• Silkscreen: String - 端口丝印信息，用于web显示
• EthId: U8 - 以太坊标识符
• Type: String - 网卡类型:ExternalPCIe/Dedicated
• PortId: U8 - 端口ID

返回值

• PortId: U8 - 端口ID

DeleteMgmtPort

删除管理网口

参数

• PortId: U8 - 端口ID

AddIptablesRule

添加Iptables映射规则

参数

• InterfaceName: String - 接口名称
• IpAddr: String - ipv4地址

返回值

• Result: Boolean - 结果

AddIp6tablesRule

添加IpV6 tables映射规则

参数

• InterfaceName: String - 接口名称
• Ipv6Addr: String - ipv6地址

返回值

• Result: Boolean - 结果

SetVLANConfig

设置端口vlan

参数

• VLANEnabled: Boolean - VLAN使能
• VLANId: U16 - VLAN ID
• PortType: U8 - 端口类型

返回值

• Result: Boolean - 结果

SetEthState

使能/禁用BMC网口

参数

• EthName: String - 网口名，默认为“usb0”
• EthEnabled: Boolean - true/false分别表示up/down网口

返回值

• Result: Boolean - 结果

NetworkFailover

双平面切换外部网络

参数

• From: String - 当前网口
• To: String - 目标网口

返回值

• Result: Boolean - 方法的结果

SetChassisLanSubNet

设置内网网段

参数

• ChassisLanSubNet: String - 机框内网通信网段

==自定义类型==

Port: 结构体类型

• Id: U8 - Id：从1开始，首次注册传入0，表示新增port
• EthId: U8 - Eth的Id
• DeviceId: U8 - 设备ID
• DevicePortId: U8 - 设备端口Id
• Silkscreen: String - 端口丝印信息，用于web显示
• Type: String - 网卡类型:ExternalPCIe/Dedicated
• AdaptiveFlag: Boolean - 是否参与自适应
• LinkStatus: String - link状态，Connected/Disconnected
• Mac: String - 对应Eth网口的Mac地址

ChangedInfoItem: 结构体类型

• Field: String - 变化的信息:ActivePort(网口切换),VLANId,Mac中的一个或多个
• Value: String - 变化后的值

bmc.kepler.Managers.EthernetInterfaces.DNS ​

==属性==

==方法==

SetPrimaryNameServer

设置主选域名服务器地址

参数

• IpAddr: String - 主选域名服务器地址

SetBackupNameServer

设置备选域名服务器地址1

参数

• IpAddr: String - 备选域名服务器地址1

SetTertiaryNameServer

设置备选域名服务器地址2

参数

• IpAddr: String - 备选域名服务器地址2

SetDHCPUseDNSServers

设置是否通过DHCP服务器来获取域名服务器地址

参数

• DHCPVersion: U16 - DHCP版本
• State: U8 - 使能状态

SetDNSAddressOrigin

设置DNS服务器地址的获取源（Static/IPv4/IPv6）

参数

• Origin: String - Static:静态模式；IPv4：自动IPv4模式；IPv6：自动IPv6模式

bmc.kepler.Managers.EthernetInterfaces.EthConfig ​

==方法==

SetSpeed

设置网口自协商使能、速率、全半双工模式

参数

• EthName: String - 网口名称
• SpeedDuplexEnable: Boolean - 网口自协商模式使能
• SpeedSetting: U8 - 网口速率: 0:不涉及 1:10M, 2:100M, 3:1000M
• DuplexSetting: U8 - 网口工作模式： 0:不涉及配置 1:半双工 2:全双工

bmc.kepler.Managers.EthernetInterfaces.EthGroup ​

==属性==

==方法==

SetNetworkConfig

设置网络配置信息

参数

• NetMode: String - 固定模式，自动选择
• PortId: U8 - 激活端口，对应MgmtPortId对象的Id属性
• VLANEnable: Boolean - NCSI VLAN使能状态：0 - 不使能； 1 - 使能
• VLANId: U16 - 虚拟局域网(Virtual Local Area Network， VLAN)的标识符，用于区分不同的虚拟局域网

SetIpMaskGateway

设置Ipv4地址、掩码、网关

参数

• IpAddr: String - Ipv4地址
• SubnetMask: String - Ipv4子网掩码
• DefaultGateway: String - Ipv4默认网关

返回值

• IpAddr: String - 设置完成后的Ipv4地址

SetIpAddr

设置Ipv4地址

参数

• IpAddr: String - Ipv4校验
• SubnetMask: String - Ipv4地址子网掩码

SetDefaultGateway

设置ipv默认网关

参数

• DefaultGateway: String - 默认网关

SetIpv6PrefixGateway

设置Ipv6地址、前缀长度、默认网关

参数

• IpAddr: String - Ipv6地址
• PrefixLength: S32 - Ipv6地址前缀长度
• DefaultGateway: String - 默认网关

返回值

• IpAddr: String - 设置完成后的Ipv6地址

SetIpv6Addr

设置Ipv6地址、前缀长度

参数

• IpAddr: String - Ipv6地址
• PrefixLength: S32 - Ipv6地址子网掩码

SetIpv6DefaultGateway

设置Ipv6默认网关

参数

• DefaultGateway: String - 默认网关

EnableFloatIp

是否使能浮动ip

参数

• Enabled: Boolean - true:使能浮动ip,false:去使能浮动ip

返回值

• Result: Boolean - 设置结果,true:设置成功,false:设置失败

bmc.kepler.Managers.EthernetInterfaces.EthGroup.Status ​

==属性==

bmc.kepler.Managers.EthernetInterfaces.InnerNetwork ​

==属性==

bmc.kepler.Managers.EthernetInterfaces.IpCommands ​

==方法==

AddIpAddress

为一个网络接口添加ip地址

参数

• IfName: String - 网口名称
• Version: String - ip版本
• IfAddr: String - ip地址

DeleteIpAddress

从网络接口中删除ip地址

参数

• IfName: String - 网口名称
• Version: String - ip版本
• IfAddr: String - ip地址

SetLink

管理和修改网络接口的(链路层)属性，比如启用网口

参数

• IfName: String - 网口名称
• Params: Params - 命令参数, 键包括Option(取值范围['up', 'down'])

==自定义类型==

Params: 结构体类型

• key: String
• value: String

bmc.kepler.Managers.EthernetInterfaces.Ipv4 ​

==属性==

==方法==

SetIpMaskGateway

设置Ipv4地址、掩码、网关

参数

• IpAddr: String - Ipv4地址
• SubnetMask: String - Ipv4地址子网掩码
• DefaultGateway: String - 默认网关

返回值

• IpAddr: String - Ipv4校验

SetIpAddr

设置Ipv4地址

参数

• IpAddr: String - Ipv4校验
• SubnetMask: String - Ipv4地址子网掩码

返回值

• Result: Boolean - Ipv4地址设置结果

SetDefaultGateway

设置默认网关

参数

• DefaultGateway: String - 默认网关

返回值

• Result: Boolean - 默认网关设置结果

SetDedicatedMaintIpMask

设置专用运维IP地址和掩码

参数

• IpAddr: String - Ipv4地址
• SubnetMask: String - Ipv4地址子网掩码

返回值

• Result: Boolean - Ipv4地址子网掩码设置结果

==自定义类型==

ChangedInfoItem: 结构体类型

• Field: String - 变化的字段:包括IpAddr、SubnetMask、DefaultGateway
• OldValue: String - 变化前的值
• NewValue: String - 已经变化后的值

bmc.kepler.Managers.EthernetInterfaces.Ipv6 ​

==属性==

==方法==

SetIpv6PrefixGateway

设置Ipv6地址前缀长度默认网关

参数

• IpAddr: String - Ipv6地址
• PrefixLength: S32 - Ipv6地址前缀长度
• DefaultGateway: String - 默认网关

返回值

• IpAddr: String - Ipv6地址

SetIpAddr

设置Ipv6地址、前缀

参数

• IpAddr: String - Ipv6地址
• PrefixLength: S32 - Ipv6地址子网掩码

返回值

• Result: Boolean - 结果

SetDefaultGateway

设置Ipv6默认网关

参数

• DefaultGateway: String - 默认网关

返回值

• Result: Boolean - 结果

==自定义类型==

ChangedInfoItem: 结构体类型

• Field: String - 变化的字段:包括IpAddr、Prefixlength、DefaultGateway
• OldValue: String - 变化前的值
• NewValue: String - 已经变化后的值

bmc.kepler.Managers.EthernetInterfaces.MgmtPort ​

==属性==

bmc.kepler.Managers.FDMService.Memory.Diagnosis ​

==属性==

==方法==

GetMemHardFailureDetectionPolicyIds

获取所有规则的Id编号

返回值

• Ids: U8[] - 所有规则的Id编号

GetMemHardFailureDetectionPolicy

获取指定预测规则的观察周期及观察周期内的阈值

参数

• Id: U8 - 规则的Id编号

返回值

• Rule: Rule - 规则的阈值类型及阈值

SetMemHardFailureDetectionPolicy

设置指定规则的阈值

参数

• Id: U8 - 规则的Id编号
• Rule: Rule - 需设置的阈值类型及设置的阈值

==自定义类型==

Rule: 结构体类型

• key: String
• value: String

bmc.kepler.Managers.FaultPrediction ​

==属性==

bmc.kepler.Managers.FileTransfer ​

==属性==

==方法==

StartTransfer

启动文件传输，成功返回任务id，失败返回错误

参数

• SrcUrl: String - 文件传输的源Url
• TargetUrl: String - 文件传输的目标Url
• MaxLength: U32 - 最大长度
• Uid: U32 - 目标文件用户id
• Gid: U32 - 目标文件组id
• Permission: U32 - 目标文件权限

返回值

• TaskId: U32 - 任务ID

Mount

执行挂载命令

参数

• Src: String - 源文件
• MountPoint: String - 文件挂载点

返回值

• Result: S32 - 文件挂载结果

Umount

执行卸载命令

参数

• MountPoint: String - 文件挂载点

返回值

• Result: S32 - 文件卸载结果

bmc.kepler.Managers.FilterConfig ​

==方法==

AddFilterRule

添加网络Filter规则

参数

• FilterConfigInfo: KeyValueTable - 调用此方法向bmc_network添加filter规则

DeleteFilterRule

删除网络Filter规则

参数

• FilterConfigInfo: KeyValueTable - 调用此方法向bmc_network删除filter规则

==自定义类型==

KeyValueTable: 结构体类型

• key: String - 键值表中的键
• value: String - 键值表中的值

bmc.kepler.Managers.GraphicalConsole ​

==属性==

==方法==

SetPersisUSBConnEnabled

设置虚拟键鼠是否支持连接

参数

• Enabled: Boolean - 是/否

返回值

• Result: S32 - 设置结果

SetVideoEnabled

设置录像使能

参数

• Enabled: Boolean - 是/否

返回值

• Result: S32 - 设置结果

SetScreenshotEnabled

设置最后一屏使能

参数

• Enabled: Boolean - 是/否

返回值

• Result: S32 - 设置结果

CaptureScreenshot

手动截屏

参数

• Mode: U8 - 手动截屏模式（是否唤醒屏幕）
• DstPath: String - 目标路径

返回值

• TaskId: U32 - 创建的任务标识

RemoveScreenshot

删除手动截屏

CreateVideoPlayToken

登录录像播放服务

参数

• WebToken: String - Web端Token
• VideoName: String - 录像名称

返回值

• VideoPlayToken: String - 播放录像Token
• VideoType: U8 - 录像类型

ExitVideoPlay

退出录像播放服务

ExportVideo

导出录像文件

参数

• VideoName: String - 录像名称
• DstPath: String - 导出路径

返回值

• TaskId: U32 - 创建的任务标识

ExportScreenshots

导出截图文件

参数

• DstPath: String - 导出路径

返回值

• TaskId: U32 - 创建的任务标识

Reset

重启Kvm相关服务

参数

• ResetType: String - 重启服务类型

==自定义类型==

VideoItem: 结构体类型

• VideoSizeByte: U32
• CreateTime: String

ScreenshotItem: 结构体类型

• ScreenshotSizeByte: U32
• CreateTime: String

bmc.kepler.Managers.HeartBeat ​

==属性==

==方法==

Beat

心跳检测

bmc.kepler.Managers.HisportUart ​

==方法==

SetHisportUartStatus

配置Hisport UART使能状态

参数

• UartId: U32 - UART的id, 0: UART0 1: UART1
• Enabled: Boolean - Hisport UART使能状态, true: 使能, false: 不使能

bmc.kepler.Managers.IpmbEth ​

==属性==

bmc.kepler.Managers.LLDPInfo ​

==属性==

bmc.kepler.Managers.LLDPReceive ​

==属性==

bmc.kepler.Managers.LldpConfig ​

==属性==

bmc.kepler.Managers.LocalOMService.USB ​

==属性==

==方法==

SetEnabled

设置USB typc-c功能使能状态

参数

• Enabled: Boolean - 使能状态

StopUSBNetwork

关闭usb驱动，停止usb rndis服务

bmc.kepler.Managers.LogService ​

==属性==

==方法==

GetItems

获取日志详细信息

参数

• Skip: U16 - 跳过日志的数目
• Top: U16 - 获取日志的数目

返回值

• Count: U32 - 获取到日志的数目
• Log: Array - 日志内容

ExportLog

导出日志

参数

• FilePath: String - 远程或本地路径
• LogFormat: String - 导出的日志格式(text/json)

返回值

• TaskId: U32 - 创建的任务标识

==自定义类型==

Items: 结构体类型

• Params: Array

LogInfo: 结构体类型

• Key: String
• Value: String

bmc.kepler.Managers.LogServices ​

==属性==

==方法==

Dump

日志一键收集

参数

• DomainUser: U8 - 用户，取值为0
• FilePath: String - 文件路径，分别支持本地路径(/tmp/文件路径)和远程路径(文件传输协议://用户名:密码@ip 地址/目录/文件名)，文件传输协议包括五种：sftp、https、nfs、cifs、scp

返回值

• TaskId: U32 - 创建的任务标识

QuickDump

精简日志收集

参数

• FilePath: String - 文件路径，分别支持本地路径(/tmp/文件路径)和远程路径(文件传输协议://用户名:密码@ip 地址/目录/文件名)，文件传输协议包括五种：sftp、https、nfs、cifs、scp

返回值

• TaskId: U32 - 创建的任务标识

GetLogList

获取日志列表

返回值

• LogList: Array - 日志列表

GetLogInfo

获取日志信息

参数

• FileName: String - 文件名
• LogCnt: String - 日志数目
• Keyword: String - 关键字

返回值

• LogInfo: Array - 日志信息

==自定义类型==

LogName: 结构体类型

• Name: String
• Time: String

Log: 结构体类型

• Item: String

bmc.kepler.Managers.ManagerDiagnosticData.MemoryStatistics ​

==属性==

bmc.kepler.Managers.ManagerDiagnosticData.StorageStatistics ​

==属性==

bmc.kepler.Managers.MgmtPortCapability ​

==属性==

bmc.kepler.Managers.Multihost ​

==属性==

bmc.kepler.Managers.NandFlash ​

==属性==

==方法==

ClearStatistics

清除写入量统计

bmc.kepler.Managers.NatConfig ​

==方法==

AddNatRule

添加网络规则

参数

• ServiceName: String - 服务名称
• ProtocolInfo: Array - 调用此方法向bmc_network添加nat规则

UpdateNatRule

更新网络规则

参数

• ServiceName: String - 服务名称
• ProtocolInfo: Array - 调用此方法向bmc_network更新nat规则

AddExactNatRule

针对IP和端口添加nat规则

参数

• NatConfigInfo: Parameter - 调用此方法向bmc_network添加nat规则

DeleteExactNatRule

针对IP和端口删除nat规则

参数

• NatConfigInfo: Parameter - 调用此方法向bmc_network删除nat规则

==自定义类型==

KeyValueTable: 结构体类型

• Key: String - 键值表中的键
• Value: String - 键值表中的值

Parameter: 结构体类型

• key: String
• value: String

bmc.kepler.Managers.NetworkProtocol ​

==方法==

Register

注册网络协议端口管理

参数

• Protocol: Struct - 协议信息

返回值

• InnerPorts: U16[] - 主、备内部端口号

==自定义类型==

ProtocolStruct: 结构体类型

• Name: String
• ProtocolType: String
• DefaultPorts: U16[]
• PortShareWith: String
• PortShareFrom: String

bmc.kepler.Managers.NetworkProtocol.HTTPS ​

==属性==

bmc.kepler.Managers.NetworkProtocol.PortConfig ​

==属性==

==方法==

SetPorts

设置网络协议的端口号

参数

• Port: U16 - 当前端口号
• SparePort: U16 - 当前备端口号

bmc.kepler.Managers.NetworkProtocol.SNMP ​

==属性==

bmc.kepler.Managers.NetworkProtocol.SSH ​

==属性==

bmc.kepler.Managers.NetworkProtocol.SSH.Algorithm ​

==属性==

bmc.kepler.Managers.NetworkProtocol.SSH.Algorithms ​

==方法==

SetAlgorithmsState

设置算法使能状态

参数

• AlgorithmsState: Array - 算法使能状态

==自定义类型==

AlgorithmsStateItem: 结构体类型

• Name: String
• Enabled: Boolean

bmc.kepler.Managers.NodeLocation ​

==属性==

bmc.kepler.Managers.Ntp ​

==属性==

==方法==

SetPollingInterval

同时设置NTP服务的最大和最小轮训间隔

参数

• MinPoll: U8 - 最小轮询间隔
• MaxPoll: U8 - 最大轮询间隔

SetNtpExtraServers

同时设置Ntp服务备份域个数和备份域地址

参数

• NTPServerCount: U8 - 支持的NTPserver 的个数，仅支持3个或者6个，默认为3个
• ExtraServers: String[] - 备用服务器地址

bmc.kepler.Managers.Ntp.Auth ​

==属性==

==方法==

ImportGroupKey

导入NTP组密钥

参数

• FilePath: String - 上传密钥的路径

ImportGroupKeyWithContent

导入NTP组密钥

参数

• Content: String - 上传密钥内容

ImportGroupKeyAsync

导入NTP组密钥

参数

• FilePath: String - 上传密钥的路径

返回值

• TaskId: U32 - 任务Id

bmc.kepler.Managers.Package ​

==属性==

bmc.kepler.Managers.RMCPCipherSuites ​

==属性==

bmc.kepler.Managers.Rmcp.SessionService ​

==属性==

bmc.kepler.Managers.Rtc ​

==属性==

bmc.kepler.Managers.SOC ​

==属性==

bmc.kepler.Managers.SOC.BlackBox ​

==方法==

Dump

黑匣子信息转储

参数

• Length: U32 - 读取数据长度，单位Byte
• Filename: String - 指定数据输出文件名

bmc.kepler.Managers.SOC.Coprocessor ​

==属性==

bmc.kepler.Managers.SOC.DDR ​

==方法==

SetTestParameters

设置DDR测试参数

参数

• TestParams: Object - DDR测试参数

GetTestParameters

查询DDR测试参数

返回值

• TestParams: Object - DDR测试参数

GetNonIsolatedUCEAddress

查询当前未隔离的内存UCE地址

返回值

• Addresses: U64[] - 未隔离的内存UCE地址

GetIsolatedUCEPage

查询已隔离的UCE故障页的起始地址和隔离页的长度

返回值

• Pages: Array - 已隔离的UCE故障页信息

==自定义类型==

Object: 结构体类型

• key: String - DDR测试参数名称, 参数名称有效范围包括:RefreshCycleTimeForAllBanks, RefreshCycleTimeForPerBank, RowPrechargeTimeForAllBanks, RowPrechargeTimeForPerBank, MarginSwitch, EyeDiagramSwitch, EyeDiagramDirection, EyeDiagramPattern, ExmbistBitmap
• value: U32

PageItem: 结构体类型

• StartingAddress: U64 - UCE故障隔离页的起始地址
• Length: U64 - UCE故障隔离页的长度

bmc.kepler.Managers.SOC.EfuseUpgrade ​

==方法==

Write

efuse升级数据写入接口

参数

• Data: U8[] - efuse升级数据

bmc.kepler.Managers.SOC.Env ​

==属性==

==自定义类型==

EnvActiveModes: 枚举类型

• 0: None
• 1: ResetBMC
• 2: ResetBMCAndSecureCore
• 3: ResetBMCAndSecureCoreOnPowerDown
• 4: ACCycle

bmc.kepler.Managers.SOC.GMAC ​

==方法==

SetMacAddr

设置GMAC控制器的网口MAC地址

参数

• GMacId: U8 - GMAC控制器的Id
• MacAddr: U8[] - GMAC控制器的网口MAC地址

GetMacAddr

查询GMAC控制器的网口MAC地址

参数

• GMacId: U8 - GMAC控制器的Id

返回值

• MacAddr: U8[] - GMAC控制器的网口MAC地址

bmc.kepler.Managers.SOC.GPIO ​

==方法==

Read

设置对应gpio管脚复用为gpio关系，并读取指定的GPIO管脚电平状态

参数

• ID: U32 - 表示gpio管脚编号，用于指定配置的GPIO管脚
• Direction: U8 - 表示获取方式，0: 获取GPIO管脚的电平状态，1：获取输出模式时的管脚状态

返回值

• Result: U8 - 表示电平高低状态，0：表示低电平；1：表示高电平

bmc.kepler.Managers.SOC.GPUTool ​

==方法==

Import

支持VGA功能测试，提供接口实现导入测试图片到显卡中

参数

• Path: String - 导入测试文件路径
• Resolution: String - 支持分辨率:640x480, 800x600, 1024x768,1440x900,1680x1050,1920x1080,1920x1200
• BBP: U8 - 像素深度(取值:8，16，32)

返回值

• Result: Boolean - 导入测试图片成功或失败

bmc.kepler.Managers.SOC.GraphicDisplay ​

==方法==

SetSystemId

设置图像显示的系统ID

参数

• SystemId: U32 - 系统ID

GetSystemId

查询当前图像显示的系统ID

返回值

• SystemId: U32 - 系统ID

bmc.kepler.Managers.SOC.NandFlashCtrl ​

==属性==

bmc.kepler.Managers.SOC.PCIeController ​

==方法==

GetState

获取PCIe控制器使能状态

参数

• Id: U8 - PCIe控制器id

返回值

• State: Boolean - PCIe控制器使能状态，True 打开/False 关闭

SetState

设置PCIe控制器使能状态

参数

• Id: U8 - PCIe控制器id
• State: Boolean - 设置PCIe控制器参数，True 打开/False 关闭

bmc.kepler.Managers.SOC.PECI ​

==方法==

WriteRead

通过PECI接口获取CPU动态信息

参数

• Input: U8[] - 写入数据, 二进制字符串格式, 长度范围(0 - 32]
• InputLength: U32 - 写入长度, 范围为(0 - 32]
• OutputLength: U32 - 读取长度, 范围为(0 - 32]

返回值

• Output: U8[] - 返回数据, 二进制字符串格式

bmc.kepler.Managers.SOC.SecureCore.Efuse ​

==方法==

VerifyPartnerH2pInfo

校验h2p秘钥：0 - h2p秘钥校验成功，1 - 获取h2p秘钥信息失败，2 - h2p秘钥信息校验失败

返回值

• VerifyResult: U8 - h2p秘钥校验结果

GetEfuseType

获取efuse模式：0 - 不支持伙伴模式efuse，1 - 支持伙伴模式efuse

返回值

• EfuseType: U8 - 获取efuse模式结果

GetEfuseState

获取efuse状态：0 - 未使能安全启动，1 - 使能安全启动

返回值

• EfuseState: U8 - 获取efuse状态结果

bmc.kepler.Managers.SOC.SecureCore.FirmwareVerification ​

==方法==

StartBiosVerify

请求M3对BIOS进行校验

参数

• BiosType: U8 - BiosType参数暂未使用，预留

GetBiosVerifyResult

通过M3查询BIOS安全校验状态: 0表示校验通过，1表示校验失败，2表示校验中，3表示未校验

返回值

• VerifyResult: U8 - 校验结果: 0表示校验通过，1表示校验失败，2表示校验中，3表示未校验

SetSpiMuxChannel

设置Bios Mux方向: 0表示切到host cpu，1表示切到bmc

参数

• Channel: U8 - 设置Bios Mux方向参数: 0表示切到host cpu，1表示切到bmc

GetSpiMuxChannel

获取Bios Mux方向: 0表示切到host cpu，1表示切到bmc

返回值

• Channel: U8 - 获取Bios Mux方向的结果: 0表示切到host cpu，1表示切到bmc

bmc.kepler.Managers.SOC.SecureCore.SecureBoot ​

==方法==

ImportCustomCertificateHash

导入伙伴模式下硬件根证书的hash

参数

• CustomCertificateHash: U8[] - CustomCertificateHash(伙伴根信息)

ExportCustomCertificateHash

获取伙伴模式下硬件根证书的hash

参数

• SignMode: Enum - SignMode(哈希填充算法，enum，0：pkcs，1：pss)

返回值

• CustomCertificateHash: U8[] - 伙伴模式下硬件根证书的hash

DisableBootVerification

禁用对安全启动证书的校验功能

ImportRepairCredentials

导入维修凭证（仅维修包提供）

参数

• RepairCredentials: U8[] - 维修凭证（仅维修包提供）

ExportRepairCredentials

导出维修凭证（仅维修包提供）

返回值

• RepairCredentials: U8[] - 维修凭证（仅维修包提供）

ResetOnNextBMCReset

通知安全核在下次跟随BMC复位

返回值

• Result: Boolean - 通知安全核在下次跟随BMC复位的结果

EnableEndUserRoTVerify

最终客户根信息导入EFUSE

返回值

• Result: Boolean - 最终客户的根信息导入EFUSE使能结果

SetCoprocessorUpgradeFlag

设置协处理器升级标志, 在复位后执行协处理器的升级流程

返回值

• Result: Boolean - 设置协处理器升级标志的结果

GetBMCFirmwareEncryptRSAPublicKey

获取BMC估计非对称RSA公钥

参数

• RSAMode: U8 - 0: RSA2048模式, 1: RSA4096模式

返回值

• Key: U8[] - BMC固件非对称RSA公钥

ImportBMCFirmwareEncryptKey

导入IRK/IPK对称密钥密文, 完成解密校验后烧录EFUSE

参数

• Key: U8[] - BMC固件对称密钥

返回值

• Result: Boolean - 导入对称密钥是否成功的结果

GetSecureBootParameters

查询安全启动状态信息

返回值

• SecureBootParameters: U8[] - 安全启动状态信息(EFUSE烧录、密钥导入等)

==自定义类型==

CertificateHashSignMode: 枚举类型

• 0: PKCSSignMode
• 1: PSSSignMode

bmc.kepler.Managers.SOC.SecureCore.TPCM ​

==属性==

==方法==

GetLog

从TPCM获取日志

返回值

• OutData: U8[] - 获取到的日志

GetPCR

从TPCM获取PCR内容

参数

• PCRIndex: U16 - 要获取的PCR内容的索引

返回值

• OutData: U8[] - 获取到的PCR索引的内容

GetRandom

从TPCM获取随机数

参数

• RandomLen: U16 - 要获取的随机数长度

返回值

• OutData: U8[] - 获取到的随机数

GetSM3Hash

从TPCM获取SM3 HASH

参数

• InData: U8[] - 要获取HASH的SM3数据

返回值

• OutData: U8[] - 获取到的SM3 HASH

bmc.kepler.Managers.SOC.Serdes.EyeDiagram ​

==方法==

StartTest

启动眼图测试，导出眼图数据

参数

• Type: Enum - 接口类型
• ScopeSel: Enum - 采样范围选择

返回值

• Row: S32 - 行宽
• Cols: S32 - 列宽

GetResult

绘图计算，返回眼图结果

参数

• Row: S32 - 行宽
• Cols: S32 - 列宽
• CompareValue: S32 - 去除噪点, 值越大去除越多

返回值

• Result: String - 眼图测试结果

GetFourEyeDiagram

获取四点眼图结果

参数

• SerdesEyeArgs: Struct - 指定眼图采样参数

返回值

• FourEyeDiagram: Struct - 四点眼图采样点位置

==自定义类型==

PortType: 枚举类型

• 0: PCIe0
• 1: PCIe1
• 2: GMAC2
• 3: GMAC3
• 4: USB

ScopeSel: 枚举类型

• 0: BeforeAFESampling
• 1: AfterAFESampling

SerdesEyeArgsStruct: 结构体类型

• ChipID: U16 - 表示芯片标识符，用于区分不同物理芯片
• MacroID: U16 - 表示宏模块ID，用于标识当前操作的SerDes宏单元（如lane0、lane1等）
• LaneID: U16 - 表示起始SerDes通道（Lane）ID，用于指定从某一路开始扫描（如从lane3开始测试）
• ScanMode: U8 - 表示扫描模式，用于指定扫描模式 0：固定点扫描，1：ISI（符号间干扰）扫描，2：仅测量眼图宽度，3：仅测量眼图高度
• PreTap: U8 - 表示前置码型，评估信号在不同前导模式下的眼图开放度 0：无效值，用于初始化或校验，表示未设置预加重模式，1：前 1 bit 为 0 的码型， 2：前 1 bit 为 1 的码型，3：组合扫描模式
• PatternType: U8 - 表示测试码型，用于测试信号在不同状态下的稳定性，眼图开放度，0：全零码型，1：全一码型
• EyeDiagramType: U8 - 表示眼图类型，用于指定眼图分析的模式，0：基本眼图，1：TAP1响应眼图，2：TAP2响应眼图
• PathType: U8 - 表示信号路径选择，用于区分不同信号通道（I/Q、同相/反相、合成路径）0x1：Q路信号，0x2：I路信号，0x4：Q反相路径，0x5：Q与QB组合路径，0x8：I与IB组合路径，0xF：复合路径（I+IB与Q+QB的组合）
• WindowSize: U32 - 眼图窗口大小，用于控制扫描范围
• Threshold: U32 - 眼图判决门限，用于判断高/低电平的分界点
• AvgSamplingCount: U32 - 表示眼图平均采样次数，用于提高信噪比

FourEyeDiagramStruct: 结构体类型

• Bottom: S32 - 眼图底部边界的采样点位置
• Top: S32 - 眼图顶部边界的采样点位置
• Left: S32 - 眼图左侧边界的采样点位置
• Right: S32 - 眼图右侧边界的采样点位置

bmc.kepler.Managers.SOC.UsbDrd ​

==方法==

GetRole

查询USB两用设备的具体角色类型（Host还是Device）（1711 0和1只能作为Device，2和3可以选择Host或Device）

参数

• UsbId: U8 - 复合设备USB口

返回值

• Role: Enum - 具体角色类型：Role（enum，0:Device，1:Host）

SetRole

设置USB两用设备的具体角色类型（Host还是Device）（1711 0和1只能作为Device，2和3可以选择Host或Device）

参数

• UsbId: U8 - 复合设备USB口
• Role: Enum - 具体角色类型：Role（enum，0:Device，1:Host）

==自定义类型==

Role: 枚举类型

• 0: Device
• 1: Host

bmc.kepler.Managers.SOL ​

==属性==

==方法==

InitSession

初始化会话

参数

• Mode: U8 - 会话模式

返回值

• Result: S8 - 初始化结果, 0:初始化成功;1:会话模式不合法;2:会话已被ipmi sol占用;3:sol处于独占模式;4:模式于已有会话不匹配;5:会话数已满;6:sol会话不可用;7:与已有会话的os不匹配.

SetTimeout

设置超时时间

参数

• Minutes: U16 - 超时时间,单位: minutes

返回值

• Result: S8 - 设置成功 0 /失败 1

bmc.kepler.Managers.SOL.Session ​

==属性==

==方法==

Deactivate

停用SOL会话

返回值

• Result: S8 - 结果：0，成功；1，会话ID超出范围；2，RMCP_SOL已激活；3，会话已关闭

bmc.kepler.Managers.SSDPConfig ​

==属性==

==方法==

SetNotifyIPv6Scope

设置ipv6 scope

参数

• Scopy: String - 可选值（地址）为Link（FF02::C）、Site（FF05::C）、Organization(FF08::C),其它是非法值

bmc.kepler.Managers.SecureBoot ​

==属性==

==方法==

SetBiosSignature

设置Bios安全启动签名值

参数

• SystemId: U8 - 系统id
• Signature: String - 签名数据字符串

bmc.kepler.Managers.SecureBoot.Signature ​

==属性==

bmc.kepler.Managers.Security.Asset ​

==属性==

bmc.kepler.Managers.Security.Assets ​

==属性==

==方法==

SignComponents

参数

• ComponentsContent: Array - 签名设备融合身份，刷新所有设备的基准值。

GetComponentsDigest

参数

• ComponentsContent: Array - 获取多个部件的实际度量值

返回值

• AssetsDigest: Array - 获取多个部件的实际度量值

GenerateServerConfigDigest

基于文件路径,计算供应链配置检查摘要,并保存为基准值

参数

• ConfigPath: String - 配置信息文件路径
• IsBase: Boolean - 是否为基准值

返回值

• Digest: String - 计算出来的摘要结果

ClearServerConfigDigest

清除供应链配置检查基准值

==自定义类型==

ComponentContent: 结构体类型

• Name: String - 部件名称
• StandardDescription: String - 部件签名信息

AssetDigest: 结构体类型

• Name: String - 部件名称
• ActualDigest: String - 部件度量值

bmc.kepler.Managers.Security.Banner ​

==属性==

bmc.kepler.Managers.Security.DICE ​

==属性==

==方法==

ExportCSR

导出DICE CSR

参数

• Path: String - CSR文件导出路径

返回值

• TaskId: U32 - ExportCSR Task Id

GenerateCSR

生成并返回DICE CSR

返回值

• CSRString: String - DICE CSR

ImportCertificate

导入DICE CERT0证书

参数

• Path: String - 证书路径

返回值

• TaskId: U32 - ImportCertificate Task Id

ImportDICECertificate

导入DICE CERT0证书

参数

• Certificate: String - DICE证书内容

ExportCertificateChain

导出DICE证书链

参数

• Path: String - 导出DICE证书链目录
• Nonce: String - 挑战随机数字符串，如0F12082A11121314

返回值

• TaskId: U32 - ExportCertificateChain Task Id

GenerateDICECertificates

生成DICE挑战相应证书链

参数

• Nonce: String - 挑战随机数字符串(最大128字符)

返回值

• CertificateChain: String[] - DICE Certificate Chain

ExportHardwareComponentsCertficateChain

导出硬件身份(融合身份)证书链

参数

• Type: String - 导出类型，只支持 URI。
• Path: String - 导出硬件身份（融合身份认证）证书链目录
• Nonce: String - 挑战随机数字符串，如0F12082A11121314

返回值

• TaskId: U32 - ExportCertificateChain Task Id

GenerateHardwareComponentsCertificates

导出硬件身份(融合身份)证书链

参数

• Nonce: String - 挑战随机数字符串(最大128字符)

返回值

• CertificateChain: String[] - Hardware Components Certificate Chain

bmc.kepler.Managers.Security.File ​

==方法==

Copy

文件复制,对应cp

参数

• SrcFile: String - 源文件路径
• DstFile: String - 目标文件路径
• Uid: U32 - 目标文件属主
• Gid: U32 - 目标文件属组

Move

文件移动,对应mv

参数

• SrcFile: String - 源文件路径
• DstFile: String - 目标文件路径
• Uid: U32 - 目标文件属主
• Gid: U32 - 目标文件属组

Chmod

修改文件权限,对应chmod

参数

• DstFile: String - 目标文件路径
• FileMode: U32 - 目标文件权限

Chown

修改文件属主、属组,对应chown

参数

• DstFile: String - 目标文件路径
• Uid: U32 - 目标文件属主
• Gid: U32 - 目标文件属组

Delete

删除文件,对应rm

参数

• DstFile: String - 目标文件路径

Create

使用fopen创建文件

参数

• DstFile: String - 目标文件路径
• OpenMode: String - 文件打开模式
• FileMode: U32 - 目标文件权限
• Uid: U32 - 目标文件属主
• Gid: U32 - 目标文件属组

ChangeOwner

文件操作公共接口,设置文件属组属主

参数

• DstFile: String - 目标文件路径

返回值

• Result: Boolean - 操作成功或失败

IsPermitted

文件操作公共接口,检查当前用户是否对文件有操作权限

参数

• DstFile: String - 目标文件路径
• Permission: String - 权限,r/w/rw

返回值

• Result: Boolean - 校验成功或失败

Access

文件操作公共接口,校验当前用户是否对文件有相应的操作权限

参数

• Path: String - 目标文件路径
• Mode: U8 - 文件的权限, Mode的取值范围为[0, 7], 含义:0 - 判断文件是否存在;1 - 判断文件是否存在且具有可执行权限;2 - 判断文件是否存在且具有可写权限;3 - 判断文件是否存在且具有可写、可执行权限;4 - 判断文件是否存在且具有可读权限;5 - 判断文件是否存在且具有可读、可执行权限;6 - 判断文件是否存在且具有可读、可写权限;7 - 判断文件是否存在且具有可读、可写、可执行权限

返回值

• Result: Boolean - 校验成功或失败

Mkdir

创建目录

参数

• DstDir: String - 新建路径
• DirMode: U32 - 目标目录权限
• Uid: U32 - 目标目录属主
• Gid: U32 - 目标目录属组
• Parents: Boolean - 是否递归创建父目录, 当前仅支持取值false

Tar

压缩、解压缩文件

参数

• Mode: String - 压缩、解压缩
• Options: String - 压缩、解压缩参数
• Archive: String - 压缩文件路径
• WorkDir: String - 压缩时代表工作路径，解压缩时代表文件输出路径
• Files: String[] - 操作文件或目录

bmc.kepler.Managers.Security.File.DeviceMapper ​

==方法==

Create

创建逻辑卷

参数

• Name: String - 逻辑卷名
• FlashDev: String - 设备名

返回值

• Result: Boolean - 处理结果

Remove

删除逻辑卷

参数

• Name: String - 逻辑卷名

返回值

• Result: Boolean - 处理结果

bmc.kepler.Managers.Security.File.Mount ​

==方法==

MountLocal

本地文件系统挂载,属主、属组、路径权限固定配置在白名单中,不通过参数控制

参数

• SrcPath: String - 源路径
• DstPath: String - 待挂载路径
• FileSystem: String - 文件系统类型
• ErrorContinue: Boolean - 错误处理机制

返回值

• Result: Boolean - 处理结果

MountRemote

网络文件系统挂载,属主、属组、路径权限固定配置在白名单中,不通过参数控制

参数

• SrcPath: String - 源路径
• DstPath: String - 待挂载路径
• Protocol: String - 文件系统类型, nfs、cifs
• Port: U32 - 连接端口
• UserName: String - 远程服务用户名
• Password: String - 远程服务用户密码

返回值

• Result: Boolean - 处理结果

Umount

挂载路径卸载

参数

• DstPath: String - 挂载路径

返回值

• Result: Boolean - 处理结果

GetMountStatus

获取挂载信息

参数

• DstPath: String - 挂载路径

返回值

• MountStatus: Struct - 挂载信息

==自定义类型==

MountStatus: 结构体类型

• MountFsName: String - 挂载的文件系统的名字
• MountDir: String - 挂载点
• MountType: String - 文件系统类型：cifs、nfs 等
• MountOpts: String - 挂载选项，以逗号为分隔符

bmc.kepler.Managers.Security.Proxy ​

==方法==

GetPid

参数

• Component: String - 待查询组件名

返回值

• Pid: U32 - 子系统进程PID

bmc.kepler.Managers.Security.Proxy.Driver ​

==方法==

Insmod

加载驱动,驱动名、扩展参数、调用者均受白名单管控

参数

• ModulePath: String - 驱动名
• ExtendParams: ExtendParams - 扩展参数

返回值

• Result: Boolean - 处理结果

Rmmod

卸载驱动,驱动名、扩展参数、调用者均受白名单管控

参数

• ModulePath: String - 驱动名
• ExtendParams: ExtendParams - 扩展参数

返回值

• Result: Boolean - 处理结果

==自定义类型==

ExtendParams: 结构体类型

• key: String
• value: String

bmc.kepler.Managers.Security.Resilience ​

==属性==

==方法==

EnterRecoveryMode

进入最小系统接口

返回值

• Result: Boolean - 进入最小系统成功或失败

SetIDSConfig

从网管透传入侵检测配置信息到安全模块

参数

• Config: String - 入侵检测配置信息

==自定义类型==

Items: 结构体类型

• FileName: String - 被修改的文件名
• ChangeType: String - 文件被修改的类型, 取值为： Permission 表示文件权限被修改、Group 表示文件所属的群组被修改、Owner 表示文件属主被修改、Delete 表示文件被删除

bmc.kepler.Managers.Security.TlsConfig.CipherSuit ​

==属性==

bmc.kepler.Managers.Security.TlsConfig.CipherSuits ​

==方法==

SetSslCipherSuit

设置SSL加密套件

参数

• SuitArray: Array
• EnableArray: Boolean[]

==自定义类型==

SslCipherSuit: 枚举类型

• 0: ECDHE_RSA_AES256_GCM_SHA384
• 1: ECDHE_ECDSA_AES256_GCM_SHA384
• 2: DHE_DSS_AES256_GCM_SHA384
• 3: DHE_RSA_AES256_GCM_SHA384
• 4: ECDHE_RSA_AES128_GCM_SHA256
• 5: ECDHE_ECDSA_AES128_GCM_SHA256
• 6: DHE_DSS_AES128_GCM_SHA256
• 7: DHE_RSA_AES128_GCM_SHA256
• 8: DHE_PSK_AES128_GCM_SHA256
• 9: DHE_PSK_AES256_GCM_SHA384
• 10: DHE_PSK_CHACHA20_POLY1305
• 11: ECDHE_RSA_CHACHA20_POLY1305
• 12: ECDHE_PSK_CHACHA20_POLY1305
• 13: DHE_RSA_AES128_CCM
• 14: DHE_RSA_AES256_CCM
• 15: DHE_RSA_CHACHA20_POLY1305
• 16: DHE_PSK_AES128_CCM
• 17: DHE_PSK_AES256_CCM
• 18: ECDHE_ECDSA_AES128_CCM
• 19: ECDHE_ECDSA_AES256_CCM
• 20: ECDHE_ECDSA_CHACHA20_POLY1305
• 21: TLS_CHACHA20_POLY1305_SHA256
• 22: TLS_AES_256_GCM_SHA384
• 23: TLS_AES_128_GCM_SHA256
• 24: TLS_DHE_RSA_WITH_AES_256_CBC_SHA
• 25: TLS_DHE_RSA_WITH_AES_128_CBC_SHA
• 26: TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
• 27: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
• 28: ECDHE_SM4_SM3
• 29: ECC_SM4_SM3
• 30: ECDHE_SM4_GCM_SM3
• 31: ECC_SM4_GCM_SM3

bmc.kepler.Managers.Security.TlsConfig.TlsVersion ​

==属性==

==方法==

GetTlsCapabilities

获取TLS各版本支持情况

返回值

• TlsCapabilities: Array - TLS支持能力,格式[TLS版本名:支持状态]

==自定义类型==

SslVersion: 枚举类型

• 0: TLS_1_2
• 1: TLS_1_3
• 2: GMTLS

TlsObject: 结构体类型

• TlsName: String - TLS版本名, 包括TLS1_0, TLS1_1, TLS1_2, TLS1_3, GMTLS
• IsSupported: Boolean - 支持状态

bmc.kepler.Managers.SerialManagement ​

==属性==

==方法==

SetConnectStatus

设置串口链路状态

参数

• NeedSaved: Boolean - 此次串口连接方向是否持久化

bmc.kepler.Managers.SerialManagement.Config ​

==方法==

Reset

恢复串口管理配置

bmc.kepler.Managers.SnmpService.SnmpCommunity ​

==属性==

==方法==

SetRwCommunity

设置rw snmp团体名

参数

• RwCommunity: String

SetRoCommunity

设置ro snmp团体名

参数

• RwCommunity: String

GetSnmpCommunity

获取snmp团体名

返回值

• RwCommunity: String
• RoCommunity: String

SetSnmpCommunityLoginRule

设置snmp团体名登录规则

参数

• LoginRuleIds: String[]

bmc.kepler.Managers.SwitchConnections ​

==方法==

GetSwitchConnections

获取交换机连接信息

返回值

• Connections: String - 交换机信息

bmc.kepler.Managers.Syslog ​

==属性==

bmc.kepler.Managers.Syslog.Report ​

==方法==

ReportControl

通知组件syslog日志上报

参数

• Type: TypeData
• Priority: U8

==自定义类型==

TypeData: 结构体类型

• key: String
• value: String

bmc.kepler.Managers.Syslog.Server ​

==属性==

bmc.kepler.Managers.Syslog.Servers ​

==方法==

SubmitTestEvent

发送测试事件

参数

• MemberId: U8 - 发送测试事件到的syslog服务器编号

bmc.kepler.Managers.SystemManager ​

==属性==

bmc.kepler.Managers.TPCM.BaseInfo ​

==属性==

==方法==

TCMSelfTest

TCM芯片自检

参数

• FullTest: Boolean - 是否全量测试,是则会重新测试所有自检项，否则只测试未测试过的自检项

返回值

• TestRsult: U32 - 测试结果

bmc.kepler.Managers.TPCM.Config ​

==属性==

==方法==

RefreshBIOSDigest

bios升级时刷新基准值

返回值

• TaskId: U8 - 任务Id

GetTsbLicense

供用户通查询tsb的license,数据从tsb处实时获取,BMC不存储。返回值描述:LicenseType:1-测试版本,3-正式版本。expired_time:以YYYY-mm-dd HH:MM:SS格式返回。

返回值

• LicenseType: U32 - 激活类型：1-测试版本,3-正式版本
• ExpiredTime: String - 过期时间，以YYYY-mm-dd HH:MM:SS格式返回

RefreshComponentStandardDigest

用于部件发生变更后，刷新各部件的身份度量基准值

参数

• SystemId: U8 - OS id,当取值255时，代表刷新所有System下的部件基准值，其他值代表刷新指定System的部件基准值

SetStandardDigest

设置度量对象基准值

参数

• HostingSystemId: U8 - 宿主机Id
• VMIds: String[] - 虚拟机Id列表
• MeasureObject: String - 度量对象名称, 具体名称见枚举值
• StandardDigest: String - 度量对象基准值，长度64

bmc.kepler.Managers.TPCM.Measured ​

==属性==

bmc.kepler.Managers.Time ​

==属性==

==方法==

SetDateTime

设置BMC时间相关属性

参数

• TimeParams: KeyValueTable - TimeZone：设置的时区，TimeStamp：时间戳，DSTEnable：夏令时使能状态（true、false）

SetRtcTime

设置RTC时间

参数

• TimeStamp: U64 - 时间戳

==自定义类型==

KeyValueTable: 结构体类型

• key: String
• value: String

bmc.kepler.Managers.USBAuthentication ​

==方法==

SetDecryptPassword

设置usb解压密码

参数

• USBDecryptPassword: String

DecryptFile

解压usb文件源路径与目标路径,仅支持白名单文件路径

参数

• SourcePath: String
• TargetPath: String

返回值

• TaskId: U32 - 解压缩文件的任务id

bmc.kepler.Managers.Uart ​

==方法==

UartConnectUart

设置uart与uart互联状态

参数

• SrcUart: U32 - 源uart控制器
• DestUart: U32 - 目的uart控制器

UartConnectPort

设置uart和uart port互联状态

参数

• SrcUart: U32 - 源uart控制器
• DestPort: U32 - 目的port

PortConnectPort

设置uart port之间的互联关系

参数

• SrcPort: U32 - 源port
• DestPort: U32 - 目的port

QueryConnection

查询uart和port互联关系

返回值

• UartConnection: U32 - uart控制器连接状态
• PortConnection: U32 - port连接状态
• UartPortEnable: U32 - uart控制器和port的使能状态

UartOpen

打开对应uart控制器并设置波特率

参数

• UartId: U8 - uart控制器id
• BaudRate: U32 - uart控制器波特率

UartClose

关闭uart控制器

参数

• UartId: U8 - uart控制器id

SetBaudRate

设置uart控制器波特率

参数

• UartId: U8 - uart控制器id
• BaudRate: U32 - uart控制器波特率

SetDataBit

设置uart控制器数据传输数据位

参数

• UartId: U8 - uart控制器id
• DataBit: U8 - uart控制器数据传输数据位

SetStopBit

设置uart控制器数据传输停止位

参数

• UartId: U8 - uart控制器id
• StopBit: U8 - uart控制器数据传输停止位

SetParityBit

设置uart控制器数据传输校验位

参数

• UartId: U8 - uart控制器id
• ParityBit: U8 - uart控制器数据传输校验位

UartRxConnectUartTx

设置源UART控制器的Rx和目的UART控制器的Tx的互联状态

参数

• SrcUart: U32 - 源UART控制器
• DestUart: U32 - 目的UART控制器

UartRxConnectPortRx

设置源UART控制器的Rx和目的port的Rx的互联状态

参数

• SrcUart: U32 - 源UART控制器
• DestPort: U32 - 目的port

PortTxConnectPortRx

设置源port的Tx和目的port的Rx的互联状态

参数

• SrcPort: U32 - 源port
• DestPort: U32 - 目的port

PortTxConnectUartTx

设置源port的Tx和目的UART控制器Tx的互联状态

参数

• SrcPort: U32 - 源port
• DestUart: U32 - 目的UART控制器

bmc.kepler.Managers.UartCircularLog ​

==方法==

Enable

设置sol日志转储使能，0: 表示去使能; 1: 使能

参数

• UartId: U32 - sol index, 取值范围0~3
• Enable: U32 - SOL使能或去使能, 0: 表示去使能; 1: 使能

SetLogSize

设置控制器sol内存大小

参数

• UartId: U32 - sol index, 取值范围0~3
• Ah: U32 - 起始地址高32位
• RxBase: U32 - RX起始地址低32位，必须32字节对齐
• TxBase: U32 - TX起始地址低32位，必须32字节对齐
• RxSize: U32 - RX大小，范围0~7，分别对应0.25M/0.5M/1M/2M/4M/8M/16M/32M
• TxSize: U32 - TX大小，范围0~7，分别对应0.25M/0.5M/1M/2M/4M/8M/16M/32M

GetPosition

获取sol的起始地址、相对起始地址偏移、物理地址

参数

• UartId: U32 - sol index, 取值范围0~3

返回值

• Ah: U32 - 起始地址高32位
• PosBase: U32 - 物理起始地址
• PosOffset: U32 - 相对起始地址的偏移

Dump

sol日志转储

参数

• UartId: U32 - sol index, 取值范围0~3
• Direction: U32 - sol日志转储目录
• Length: U32 - sol日志转储长度
• FileName: String - sol日志转储文件名

bmc.kepler.Managers.UartData ​

==属性==

==方法==

Export

导出串口日志

参数

• Type: String - 导出数据的类型，可选值：SYS COM/ALL
• FilePath: String - 导出数据的文件路径

返回值

• TaskId: U32 - 任务标识

bmc.kepler.Managers.UartPort ​

==属性==

==方法==

Reset

打开启动Uart设备, 并对设备进行参数设置等初始化

bmc.kepler.Managers.Ums ​

==属性==

==方法==

ReadFile

读取U盘内某个文件的内容

参数

• PathId: U8 - 目录Id, 取值：[1, 12]
• FileName: String - 文件名

返回值

• Content: String - 文件内容

WriteFile

往U盘内某个文件写入内容

参数

• PathId: U8 - 目录Id
• FileName: String - 文件名
• Content: String - 写入内容

GetFileList

获取U盘内某个目录的文件名列表，不包括路径

参数

• PathId: U8 - 目录Id

返回值

• Files: String[] - 文件名列表

CheckFileExist

判断U盘内某个文件是否存在

参数

• PathId: U8 - 目录Id
• FileName: String - 文件名

返回值

• Result: Boolean - 是否存在

ClearDirectory

清空U盘内某个目录下的所有内容

参数

• PathId: U8 - 目录Id

CreateUms

创建虚拟U盘

参数

• Loc: U8 - 0:本地U盘, 1:远程U盘
• Type: U8 - 0:临时挂载, 1:正式挂载

返回值

• TaskId: U32 - 创建的任务标识

CloseUms

关闭虚拟U盘

返回值

• TaskId: U32 - 创建的任务标识

bmc.kepler.Managers.Ums.BMA ​

==属性==

==方法==

UpgradePackage

升级iBMA安装包

参数

• ImageURI: String - 升级包地址
• SignatureURI: String - 升级包地址
• CrlURI: String - 升级包CRL文件地址

返回值

• TaskId: U32 - 创建的任务标识

DeletePackage

删除固定路径的板载BMA安装包

==自定义类型==

Object: 结构体类型

• key: String
• value: String

bmc.kepler.Managers.Ums.SP ​

==属性==